# dates should be in the format you have set up Koha to expect
# branchcode and categorycode need to be valid
-use strict;
-use warnings;
+use Modern::Perl;
use C4::Auth;
use C4::Output;
-use C4::Context;
-use C4::Branch qw/GetBranchesLoop GetBranchName/;
-use C4::Members;
-use C4::Members::Attributes qw(:all);
-use C4::Members::AttributeTypes;
-use C4::Members::Messaging;
-use C4::Reports::Guided;
use C4::Templates;
-use Koha::Borrower::Debarments;
+use Koha::Patrons;
use Koha::DateUtils;
+use Koha::Token;
+use Koha::Libraries;
+use Koha::Patron::Categories;
+use Koha::List::Patron;
+
+use Koha::Patrons::Import;
+my $Import = Koha::Patrons::Import->new();
use Text::CSV;
+
# Text::CSV::Unicode, even in binary mode, fails to parse lines with these diacriticals:
# ė
# č
use CGI qw ( -utf8 );
-# use encoding 'utf8'; # don't do this
-my (@errors, @feedback);
+my ( @errors, @feedback );
my $extended = C4::Context->preference('ExtendedPatronAttributes');
-my $set_messaging_prefs = C4::Context->preference('EnhancedMessagingPreferences');
-my @columnkeys = C4::Members::columns();
-@columnkeys = map { $_ ne 'borrowernumber' ? $_ : () } @columnkeys;
-if ($extended) {
- push @columnkeys, 'patron_attributes';
-}
+
+my @columnkeys = map { $_ ne 'borrowernumber' ? $_ : () } Koha::Patrons->columns();
+push( @columnkeys, 'patron_attributes' ) if $extended;
my $input = CGI->new();
-our $csv = Text::CSV->new({binary => 1}); # binary needed for non-ASCII Unicode
+
#push @feedback, {feedback=>1, name=>'backend', value=>$csv->backend, backend=>$csv->backend}; #XXX
-my ( $template, $loggedinuser, $cookie ) = get_template_and_user({
+my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
+ {
template_name => "tools/import_borrowers.tt",
query => $input,
type => "intranet",
authnotrequired => 0,
flagsrequired => { tools => 'import_patrons' },
debug => 1,
-});
+ }
+);
-# get the branches and pass them to the template
-my $branches = GetBranchesLoop();
-$template->param( branches => $branches ) if ( $branches );
# get the patron categories and pass them to the template
-my $categories = GetBorrowercategoryList();
-$template->param( categories => $categories ) if ( $categories );
+my @patron_categories = Koha::Patron::Categories->search_limited({}, {order_by => ['description']});
+$template->param( categories => \@patron_categories );
my $columns = C4::Templates::GetColumnDefs( $input )->{borrowers};
$columns = [ grep { $_->{field} ne 'borrowernumber' ? $_ : () } @$columns ];
$template->param( borrower_fields => $columns );
-if ($input->param('sample')) {
+if ( $input->param('sample') ) {
+ our $csv = Text::CSV->new( { binary => 1 } ); # binary needed for non-ASCII Unicode
print $input->header(
- -type => 'application/vnd.sun.xml.calc', # 'application/vnd.ms-excel' ?
+ -type => 'application/vnd.sun.xml.calc', # 'application/vnd.ms-excel' ?
-attachment => 'patron_import.csv',
);
$csv->combine(@columnkeys);
print $csv->string, "\n";
exit 0;
}
+
my $uploadborrowers = $input->param('uploadborrowers');
my $matchpoint = $input->param('matchpoint');
if ($matchpoint) {
$matchpoint =~ s/^patron_attribute_//;
}
-my $overwrite_cardnumber = $input->param('overwrite_cardnumber');
+
+#create a patronlist
+my $createpatronlist = $input->param('createpatronlist') || 0;
+my $dt = dt_from_string();
+my $timestamp = $dt->ymd('-').' '.$dt->hms(':');
+my $patronlistname = $uploadborrowers . ' (' . $timestamp .')';
$template->param( SCRIPT_NAME => '/cgi-bin/koha/tools/import_borrowers.pl' );
if ( $uploadborrowers && length($uploadborrowers) > 0 ) {
- push @feedback, {feedback=>1, name=>'filename', value=>$uploadborrowers, filename=>$uploadborrowers};
- my $handle = $input->upload('uploadborrowers');
- my $uploadinfo = $input->uploadInfo($uploadborrowers);
- foreach (keys %$uploadinfo) {
- push @feedback, {feedback=>1, name=>$_, value=>$uploadinfo->{$_}, $_=>$uploadinfo->{$_}};
- }
- my $imported = 0;
- my $alreadyindb = 0;
- my $overwritten = 0;
- my $invalid = 0;
- my $matchpoint_attr_type;
- my %defaults = $input->Vars;
+ die "Wrong CSRF token"
+ unless Koha::Token->new->check_csrf({
+ session_id => scalar $input->cookie('CGISESSID'),
+ token => scalar $input->param('csrf_token'),
+ });
- # use header line to construct key to column map
- my $borrowerline = <$handle>;
- my $status = $csv->parse($borrowerline);
- ($status) or push @errors, {badheader=>1,line=>$., lineraw=>$borrowerline};
- my @csvcolumns = $csv->fields();
- my %csvkeycol;
- my $col = 0;
- foreach my $keycol (@csvcolumns) {
- # columnkeys don't contain whitespace, but some stupid tools add it
- $keycol =~ s/ +//g;
- $csvkeycol{$keycol} = $col++;
- }
- #warn($borrowerline);
- my $ext_preserve = $input->param('ext_preserve') || 0;
- if ($extended) {
- $matchpoint_attr_type = C4::Members::AttributeTypes->fetch($matchpoint);
- }
-
- push @feedback, {feedback=>1, name=>'headerrow', value=>join(', ', @csvcolumns)};
- my $today_iso = output_pref( { dt => dt_from_string, dateonly => 1, dateformat => 'iso' });
- my @criticals = qw(surname branchcode categorycode); # there probably should be others
- my @bad_dates; # I've had a few.
- LINE: while ( my $borrowerline = <$handle> ) {
- my %borrower;
- my @missing_criticals;
- my $patron_attributes;
- my $status = $csv->parse($borrowerline);
- my @columns = $csv->fields();
- if (! $status) {
- push @missing_criticals, {badparse=>1, line=>$., lineraw=>$borrowerline};
- } elsif (@columns == @columnkeys) {
- @borrower{@columnkeys} = @columns;
- # MJR: try to fill blanks gracefully by using default values
- foreach my $key (@columnkeys) {
- if ($borrower{$key} !~ /\S/) {
- $borrower{$key} = $defaults{$key};
- }
- }
- } else {
- # MJR: try to recover gracefully by using default values
- foreach my $key (@columnkeys) {
- if (defined($csvkeycol{$key}) and $columns[$csvkeycol{$key}] =~ /\S/) {
- $borrower{$key} = $columns[$csvkeycol{$key}];
- } elsif ( $defaults{$key} ) {
- $borrower{$key} = $defaults{$key};
- } elsif ( scalar grep {$key eq $_} @criticals ) {
- # a critical field is undefined
- push @missing_criticals, {key=>$key, line=>$., lineraw=>$borrowerline};
- } else {
- $borrower{$key} = '';
- }
- }
- }
- #warn join(':',%borrower);
- if ($borrower{categorycode}) {
- push @missing_criticals, {key=>'categorycode', line=>$. , lineraw=>$borrowerline, value=>$borrower{categorycode}, category_map=>1}
- unless GetBorrowercategory($borrower{categorycode});
- } else {
- push @missing_criticals, {key=>'categorycode', line=>$. , lineraw=>$borrowerline};
- }
- if ($borrower{branchcode}) {
- push @missing_criticals, {key=>'branchcode', line=>$. , lineraw=>$borrowerline, value=>$borrower{branchcode}, branch_map=>1}
- unless GetBranchName($borrower{branchcode});
- } else {
- push @missing_criticals, {key=>'branchcode', line=>$. , lineraw=>$borrowerline};
- }
- if (@missing_criticals) {
- foreach (@missing_criticals) {
- $_->{borrowernumber} = $borrower{borrowernumber} || 'UNDEF';
- $_->{surname} = $borrower{surname} || 'UNDEF';
- }
- $invalid++;
- (25 > scalar @errors) and push @errors, {missing_criticals=>\@missing_criticals};
- # The first 25 errors are enough. Keeping track of 30,000+ would destroy performance.
- next LINE;
- }
- if ($extended) {
- my $attr_str = $borrower{patron_attributes};
- $attr_str =~ s/\xe2\x80\x9c/"/g; # fixup double quotes in case we are passed smart quotes
- $attr_str =~ s/\xe2\x80\x9d/"/g;
- push @feedback, {feedback=>1, name=>'attribute string', value=>$attr_str, filename=>$uploadborrowers};
- delete $borrower{patron_attributes}; # not really a field in borrowers, so we don't want to pass it to ModMember.
- $patron_attributes = extended_attributes_code_value_arrayref($attr_str);
- }
- # Popular spreadsheet applications make it difficult to force date outputs to be zero-padded, but we require it.
- foreach (qw(dateofbirth dateenrolled dateexpiry)) {
- my $tempdate = $borrower{$_} or next;
- $tempdate = eval { output_pref( { dt => dt_from_string( $tempdate ), dateonly => 1, dateformat => 'iso' } ); };
- if ($tempdate) {
- $borrower{$_} = $tempdate;
- } else {
- $borrower{$_} = '';
- push @missing_criticals, {key=>$_, line=>$. , lineraw=>$borrowerline, bad_date=>1};
- }
- }
- $borrower{dateenrolled} = $today_iso unless $borrower{dateenrolled};
- $borrower{dateexpiry} = GetExpiryDate($borrower{categorycode},$borrower{dateenrolled}) unless $borrower{dateexpiry};
- my $borrowernumber;
- my $member;
- if ( ($matchpoint eq 'cardnumber') && ($borrower{'cardnumber'}) ) {
- $member = GetMember( 'cardnumber' => $borrower{'cardnumber'} );
- if ($member) {
- $borrowernumber = $member->{'borrowernumber'};
- }
- } elsif ( ($matchpoint eq 'userid') && ($borrower{'userid'}) ) {
- $member = GetMember( 'userid' => $borrower{'userid'} );
- if ($member) {
- $borrowernumber = $member->{'borrowernumber'};
- }
- } elsif ($extended) {
- if (defined($matchpoint_attr_type)) {
- foreach my $attr (@$patron_attributes) {
- if ($attr->{code} eq $matchpoint and $attr->{value} ne '') {
- my @borrowernumbers = $matchpoint_attr_type->get_patrons($attr->{value});
- $borrowernumber = $borrowernumbers[0] if scalar(@borrowernumbers) == 1;
- last;
- }
- }
- }
- }
+ my $handle = $input->upload('uploadborrowers');
+ my %defaults = $input->Vars;
- if ( C4::Members::checkcardnumber( $borrower{cardnumber}, $borrowernumber ) ) {
- push @errors, {
- invalid_cardnumber => 1,
- borrowernumber => $borrowernumber,
- cardnumber => $borrower{cardnumber}
- };
- $invalid++;
- next;
+ my $return = $Import->import_patrons(
+ {
+ file => $handle,
+ defaults => \%defaults,
+ matchpoint => $matchpoint,
+ overwrite_cardnumber => $input->param('overwrite_cardnumber'),
+ preserve_extended_attributes => $input->param('ext_preserve') || 0,
}
+ );
+ my $feedback = $return->{feedback};
+ my $errors = $return->{errors};
+ my $imported = $return->{imported};
+ my $overwritten = $return->{overwritten};
+ my $alreadyindb = $return->{already_in_db};
+ my $invalid = $return->{invalid};
+ my $imported_borrowers = $return->{imported_borrowers};
+
+ if ( $imported && $createpatronlist ) {
+ my $patronlist = AddPatronList({ name => $patronlistname });
+ AddPatronsToList({ list => $patronlist, borrowernumbers => $imported_borrowers });
+ $template->param('patronlistname' => $patronlistname);
+ }
- if ($borrowernumber) {
- # borrower exists
- unless ($overwrite_cardnumber) {
- $alreadyindb++;
- $template->param('lastalreadyindb'=>$borrower{'surname'}.' / '.$borrowernumber);
- next LINE;
- }
- $borrower{'borrowernumber'} = $borrowernumber;
- for my $col (keys %borrower) {
- # use values from extant patron unless our csv file includes this column or we provided a default.
- # FIXME : You cannot update a field with a perl-evaluated false value using the defaults.
-
- # The password is always encrypted, skip it!
- next if $col eq 'password';
-
- unless(exists($csvkeycol{$col}) || $defaults{$col}) {
- $borrower{$col} = $member->{$col} if($member->{$col}) ;
- }
- }
- unless (ModMember(%borrower)) {
- $invalid++;
- # until we have better error trapping, we have no way of knowing why ModMember errored out...
- push @errors, {unknown_error => 1};
- $template->param('lastinvalid'=>$borrower{'surname'}.' / '.$borrowernumber);
- next LINE;
- }
-
- # Don't add a new restriction if the existing 'combined' restriction matches this one
- if ( $borrower{debarred} && ( ( $borrower{debarred} ne $member->{debarred} ) || ( $borrower{debarredcomment} ne $member->{debarredcomment} ) ) ) {
- # Check to see if this debarment already exists
- my $debarrments = GetDebarments(
- {
- borrowernumber => $borrowernumber,
- expiration => $borrower{debarred},
- comment => $borrower{debarredcomment}
- }
- );
- # If it doesn't, then add it!
- unless (@$debarrments) {
- AddDebarment(
- {
- borrowernumber => $borrowernumber,
- expiration => $borrower{debarred},
- comment => $borrower{debarredcomment}
- }
- );
- }
- }
-
- if ($extended) {
- if ($ext_preserve) {
- my $old_attributes = GetBorrowerAttributes($borrowernumber);
- $patron_attributes = extended_attributes_merge($old_attributes, $patron_attributes); #TODO: expose repeatable options in template
- }
- push @errors, {unknown_error => 1} unless SetBorrowerAttributes($borrower{'borrowernumber'}, $patron_attributes);
- }
- $overwritten++;
- $template->param('lastoverwritten'=>$borrower{'surname'}.' / '.$borrowernumber);
- } else {
- # FIXME: fixup_cardnumber says to lock table, but the web interface doesn't so this doesn't either.
- # At least this is closer to AddMember than in members/memberentry.pl
- if (!$borrower{'cardnumber'}) {
- $borrower{'cardnumber'} = fixup_cardnumber(undef);
- }
- if ($borrowernumber = AddMember(%borrower)) {
-
- if ( $borrower{debarred} ) {
- AddDebarment(
- {
- borrowernumber => $borrowernumber,
- expiration => $borrower{debarred},
- comment => $borrower{debarredcomment}
- }
- );
- }
-
- if ($extended) {
- SetBorrowerAttributes($borrowernumber, $patron_attributes);
- }
+ my $uploadinfo = $input->uploadInfo($uploadborrowers);
+ foreach ( keys %$uploadinfo ) {
+ push @$feedback, { feedback => 1, name => $_, value => $uploadinfo->{$_}, $_ => $uploadinfo->{$_} };
+ }
- if ($set_messaging_prefs) {
- C4::Members::Messaging::SetMessagingPreferencesFromDefaults({ borrowernumber => $borrowernumber,
- categorycode => $borrower{categorycode} });
- }
+ push @$feedback, { feedback => 1, name => 'filename', value => $uploadborrowers, filename => $uploadborrowers };
- $imported++;
- $template->param('lastimported'=>$borrower{'surname'}.' / '.$borrowernumber);
- } else {
- $invalid++;
- push @errors, {unknown_error => 1};
- $template->param('lastinvalid'=>$borrower{'surname'}.' / AddMember');
- }
- }
- }
- (@errors ) and $template->param( ERRORS=>\@errors );
- (@feedback) and $template->param(FEEDBACK=>\@feedback);
$template->param(
- 'uploadborrowers' => 1,
- 'imported' => $imported,
- 'overwritten' => $overwritten,
- 'alreadyindb' => $alreadyindb,
- 'invalid' => $invalid,
- 'total' => $imported + $alreadyindb + $invalid + $overwritten,
+ uploadborrowers => 1,
+ errors => $errors,
+ feedback => $feedback,
+ imported => $imported,
+ overwritten => $overwritten,
+ alreadyindb => $alreadyindb,
+ invalid => $invalid,
+ total => $imported + $alreadyindb + $invalid + $overwritten,
);
-} else {
+}
+else {
if ($extended) {
my @matchpoints = ();
- my @attr_types = C4::Members::AttributeTypes::GetAttributeTypes(undef, 1);
+ my @attr_types = C4::Members::AttributeTypes::GetAttributeTypes( undef, 1 );
foreach my $type (@attr_types) {
- my $attr_type = C4::Members::AttributeTypes->fetch($type->{code});
- if ($attr_type->unique_id()) {
- push @matchpoints, { code => "patron_attribute_" . $attr_type->code(), description => $attr_type->description() };
+ my $attr_type = C4::Members::AttributeTypes->fetch( $type->{code} );
+ if ( $attr_type->unique_id() ) {
+ push @matchpoints,
+ { code => "patron_attribute_" . $attr_type->code(), description => $attr_type->description() };
}
}
- $template->param(matchpoints => \@matchpoints);
+ $template->param( matchpoints => \@matchpoints );
}
+
+ $template->param(
+ csrf_token => Koha::Token->new->generate_csrf(
+ { session_id => scalar $input->cookie('CGISESSID'), }
+ ),
+ );
+
}
output_html_with_http_headers $input, $cookie, $template->output;
projects / koha.git / blobdiff