tools/import_borrowers.pl

   1 #!/usr/bin/perl
   2
   3 # Copyright 2007 Liblime
   4 # Parts copyright 2010 BibLibre
   5 #
   6 # This file is part of Koha.
   7 #
   8 # Koha is free software; you can redistribute it and/or modify it
   9 # under the terms of the GNU General Public License as published by
  10 # the Free Software Foundation; either version 3 of the License, or
  11 # (at your option) any later version.
  12 #
  13 # Koha is distributed in the hope that it will be useful, but
  14 # WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16 # GNU General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU General Public License
  19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  20
  21 # Script to take some borrowers data in a known format and load it into Koha
  22 #
  23 # File format
  24 #
  25 # cardnumber,surname,firstname,title,othernames,initials,streetnumber,streettype,
  26 # address line , address line 2, city, zipcode, contry, email, phone, mobile, fax, work email, work phone,
  27 # alternate streetnumber, alternate streettype, alternate address line 1, alternate city,
  28 # alternate zipcode, alternate country, alternate email, alternate phone, date of birth, branchcode,
  29 # categorycode, enrollment date, expiry date, noaddress, lost, debarred, contact surname,
  30 # contact firstname, contact title, borrower notes, contact relationship
  31 # gender, username, opac note, contact note, password, sort one, sort two
  32 #
  33 # any fields except cardnumber can be blank but the number of fields must match
  34 # dates should be in the format you have set up Koha to expect
  35 # branchcode and categorycode need to be valid
  36
  37 use strict;
  38 use warnings;
  39
  40 use C4::Auth;
  41 use C4::Output;
  42 use C4::Context;
  43 use C4::Members;
  44 use C4::Members::Attributes qw(:all);
  45 use C4::Members::AttributeTypes;
  46 use C4::Members::Messaging;
  47 use C4::Reports::Guided;
  48 use C4::Templates;
  49 use Koha::Patron::Debarments;
  50 use Koha::Patrons;
  51 use Koha::DateUtils;
  52 use Koha::Token;
  53 use Koha::Libraries;
  54 use Koha::Patron::Categories;
  55 use Koha::List::Patron;
  56
  57 use Text::CSV;
  58 # Text::CSV::Unicode, even in binary mode, fails to parse lines with these diacriticals:
  59 # ė
  60 # č
  61
  62 use CGI qw ( -utf8 );
  63
  64 my (@errors, @feedback);
  65 my $extended = C4::Context->preference('ExtendedPatronAttributes');
  66 my $set_messaging_prefs = C4::Context->preference('EnhancedMessagingPreferences');
  67 my @columnkeys = Koha::Patrons->columns();
  68 @columnkeys = map { $_ ne 'borrowernumber' ? $_ : () } @columnkeys;
  69 if ($extended) {
  70     push @columnkeys, 'patron_attributes';
  71 }
  72
  73 my $input = CGI->new();
  74 our $csv  = Text::CSV->new({binary => 1});  # binary needed for non-ASCII Unicode
  75 #push @feedback, {feedback=>1, name=>'backend', value=>$csv->backend, backend=>$csv->backend}; #XXX
  76
  77 my ( $template, $loggedinuser, $cookie ) = get_template_and_user({
  78         template_name   => "tools/import_borrowers.tt",
  79         query           => $input,
  80         type            => "intranet",
  81         authnotrequired => 0,
  82         flagsrequired   => { tools => 'import_patrons' },
  83         debug           => 1,
  84 });
  85
  86 # get the patron categories and pass them to the template
  87 my @patron_categories = Koha::Patron::Categories->search_limited({}, {order_by => ['description']});
  88 $template->param( categories => \@patron_categories );
  89 my $columns = C4::Templates::GetColumnDefs( $input )->{borrowers};
  90 $columns = [ grep { $_->{field} ne 'borrowernumber' ? $_ : () } @$columns ];
  91 $template->param( borrower_fields => $columns );
  92
  93 if ($input->param('sample')) {
  94     print $input->header(
  95         -type       => 'application/vnd.sun.xml.calc', # 'application/vnd.ms-excel' ?
  96         -attachment => 'patron_import.csv',
  97     );
  98     $csv->combine(@columnkeys);
  99     print $csv->string, "\n";
 100     exit 0;
 101 }
 102 my $uploadborrowers = $input->param('uploadborrowers');
 103 my $matchpoint      = $input->param('matchpoint');
 104 if ($matchpoint) {
 105     $matchpoint =~ s/^patron_attribute_//;
 106 }
 107 my $overwrite_cardnumber = $input->param('overwrite_cardnumber');
 108
 109 #create a patronlist
 110 my $createpatronlist = $input->param('createpatronlist') || 0;
 111 my $dt = dt_from_string();
 112 my $timestamp = $dt->ymd('-').' '.$dt->hms(':');
 113 my $patronlistname = $uploadborrowers . ' (' . $timestamp .')';
 114
 115 $template->param( SCRIPT_NAME => '/cgi-bin/koha/tools/import_borrowers.pl' );
 116
 117 if ( $uploadborrowers && length($uploadborrowers) > 0 ) {
 118     die "Wrong CSRF token"
 119         unless Koha::Token->new->check_csrf({
 120             session_id => scalar $input->cookie('CGISESSID'),
 121             token  => scalar $input->param('csrf_token'),
 122         });
 123
 124     push @feedback, {feedback=>1, name=>'filename', value=>$uploadborrowers, filename=>$uploadborrowers};
 125     my $handle = $input->upload('uploadborrowers');
 126     my $uploadinfo = $input->uploadInfo($uploadborrowers);
 127     foreach (keys %$uploadinfo) {
 128         push @feedback, {feedback=>1, name=>$_, value=>$uploadinfo->{$_}, $_=>$uploadinfo->{$_}};
 129     }
 130
 131     my $imported    = 0;
 132     my @imported_borrowers;
 133     my $alreadyindb = 0;
 134     my $overwritten = 0;
 135     my $invalid     = 0;
 136     my $matchpoint_attr_type;
 137     my %defaults = $input->Vars;
 138
 139     # use header line to construct key to column map
 140     my $borrowerline = <$handle>;
 141     my $status = $csv->parse($borrowerline);
 142     ($status) or push @errors, {badheader=>1,line=>$., lineraw=>$borrowerline};
 143     my @csvcolumns = $csv->fields();
 144     my %csvkeycol;
 145     my $col = 0;
 146     foreach my $keycol (@csvcolumns) {
 147         # columnkeys don't contain whitespace, but some stupid tools add it
 148         $keycol =~ s/ +//g;
 149         $csvkeycol{$keycol} = $col++;
 150     }
 151     #warn($borrowerline);
 152     my $ext_preserve = $input->param('ext_preserve') || 0;
 153     if ($extended) {
 154         $matchpoint_attr_type = C4::Members::AttributeTypes->fetch($matchpoint);
 155     }
 156
 157     push @feedback, {feedback=>1, name=>'headerrow', value=>join(', ', @csvcolumns)};
 158     my $today = output_pref;
 159     my @criticals = qw(surname branchcode categorycode);    # there probably should be others
 160     my @bad_dates;  # I've had a few.
 161     LINE: while ( my $borrowerline = <$handle> ) {
 162         my %borrower;
 163         my @missing_criticals;
 164         my $patron_attributes;
 165         my $status  = $csv->parse($borrowerline);
 166         my @columns = $csv->fields();
 167         if (! $status) {
 168             push @missing_criticals, {badparse=>1, line=>$., lineraw=>$borrowerline};
 169         } elsif (@columns == @columnkeys) {
 170             @borrower{@columnkeys} = @columns;
 171             # MJR: try to fill blanks gracefully by using default values
 172             foreach my $key (@columnkeys) {
 173                 if ($borrower{$key} !~ /\S/) {
 174                     $borrower{$key} = $defaults{$key};
 175                 }
 176             }
 177         } else {
 178             # MJR: try to recover gracefully by using default values
 179             foreach my $key (@columnkeys) {
 180                 if (defined($csvkeycol{$key}) and $columns[$csvkeycol{$key}] =~ /\S/) {
 181                     $borrower{$key} = $columns[$csvkeycol{$key}];
 182                 } elsif ( $defaults{$key} ) {
 183                     $borrower{$key} = $defaults{$key};
 184                 } elsif ( scalar grep {$key eq $_} @criticals ) {
 185                     # a critical field is undefined
 186                     push @missing_criticals, {key=>$key, line=>$., lineraw=>$borrowerline};
 187                 } else {
 188                         $borrower{$key} = '';
 189                 }
 190             }
 191         }
 192         #warn join(':',%borrower);
 193         if ($borrower{categorycode}) {
 194             push @missing_criticals, {key=>'categorycode', line=>$. , lineraw=>$borrowerline, value=>$borrower{categorycode}, category_map=>1}
 195                 unless Koha::Patron::Categories->find($borrower{categorycode});
 196         } else {
 197             push @missing_criticals, {key=>'categorycode', line=>$. , lineraw=>$borrowerline};
 198         }
 199         if ($borrower{branchcode}) {
 200             push @missing_criticals, {key=>'branchcode', line=>$. , lineraw=>$borrowerline, value=>$borrower{branchcode}, branch_map=>1}
 201                 unless Koha::Libraries->find($borrower{branchcode});
 202         } else {
 203             push @missing_criticals, {key=>'branchcode', line=>$. , lineraw=>$borrowerline};
 204         }
 205         if (@missing_criticals) {
 206             foreach (@missing_criticals) {
 207                 $_->{borrowernumber} = $borrower{borrowernumber} || 'UNDEF';
 208                 $_->{surname}        = $borrower{surname} || 'UNDEF';
 209             }
 210             $invalid++;
 211             (25 > scalar @errors) and push @errors, {missing_criticals=>\@missing_criticals};
 212             # The first 25 errors are enough.  Keeping track of 30,000+ would destroy performance.
 213             next LINE;
 214         }
 215         if ($extended) {
 216             my $attr_str = $borrower{patron_attributes};
 217             $attr_str =~ s/\xe2\x80\x9c/"/g; # fixup double quotes in case we are passed smart quotes
 218             $attr_str =~ s/\xe2\x80\x9d/"/g;
 219             push @feedback, {feedback=>1, name=>'attribute string', value=>$attr_str, filename=>$uploadborrowers};
 220             delete $borrower{patron_attributes};    # not really a field in borrowers, so we don't want to pass it to ModMember.
 221             $patron_attributes = extended_attributes_code_value_arrayref($attr_str);
 222         }
 223         # Popular spreadsheet applications make it difficult to force date outputs to be zero-padded, but we require it.
 224         foreach (qw(dateofbirth dateenrolled dateexpiry)) {
 225             my $tempdate = $borrower{$_} or next;
 226             $tempdate = eval { output_pref( { dt => dt_from_string( $tempdate ), dateonly => 1, dateformat => 'iso' } ); };
 227             if ($tempdate) {
 228                 $borrower{$_} = $tempdate;
 229             } else {
 230                 $borrower{$_} = '';
 231                 push @missing_criticals, {key=>$_, line=>$. , lineraw=>$borrowerline, bad_date=>1};
 232             }
 233         }
 234         $borrower{dateenrolled} ||= $today;
 235         $borrower{dateexpiry}   ||= Koha::Patron::Categories->find( $borrower{categorycode} )->get_expiry_date( $borrower{dateenrolled} );
 236         my $borrowernumber;
 237         my $member;
 238         if ( ($matchpoint eq 'cardnumber') && ($borrower{'cardnumber'}) ) {
 239             $member = Koha::Patrons->find( { cardnumber => $borrower{'cardnumber'} } );
 240         } elsif ( ($matchpoint eq 'userid') && ($borrower{'userid'}) ) {
 241             $member = Koha::Patrons->find( { userid => $borrower{'userid'} } );
 242         } elsif ($extended) {
 243             if (defined($matchpoint_attr_type)) {
 244                 foreach my $attr (@$patron_attributes) {
 245                     if ($attr->{code} eq $matchpoint and $attr->{value} ne '') {
 246                         my @borrowernumbers = $matchpoint_attr_type->get_patrons($attr->{value});
 247                         $borrowernumber = $borrowernumbers[0] if scalar(@borrowernumbers) == 1;
 248                         last;
 249                     }
 250                 }
 251             }
 252         }
 253
 254         if ($member) {
 255             $member = $member->unblessed;
 256             $borrowernumber = $member->{'borrowernumber'};
 257         } else {
 258             $member = {};
 259         }
 260
 261         if ( C4::Members::checkcardnumber( $borrower{cardnumber}, $borrowernumber ) ) {
 262             push @errors, {
 263                 invalid_cardnumber => 1,
 264                 borrowernumber => $borrowernumber,
 265                 cardnumber => $borrower{cardnumber}
 266             };
 267             $invalid++;
 268             next;
 269         }
 270
 271         if ($borrowernumber) {
 272             # borrower exists
 273             unless ($overwrite_cardnumber) {
 274                 $alreadyindb++;
 275                 $template->param('lastalreadyindb'=>$borrower{'surname'}.' / '.$borrowernumber);
 276                 next LINE;
 277             }
 278             $borrower{'borrowernumber'} = $borrowernumber;
 279             for my $col (keys %borrower) {
 280                 # use values from extant patron unless our csv file includes this column or we provided a default.
 281                 # FIXME : You cannot update a field with a  perl-evaluated false value using the defaults.
 282
 283                 # The password is always encrypted, skip it!
 284                 next if $col eq 'password';
 285
 286                 unless(exists($csvkeycol{$col}) || $defaults{$col}) {
 287                     $borrower{$col} = $member->{$col} if($member->{$col}) ;
 288                 }
 289             }
 290
 291             # Check if the userid provided does not exist yet
 292             if (  exists $borrower{userid}
 293                      and $borrower{userid}
 294                  and not Check_Userid( $borrower{userid}, $borrower{borrowernumber} ) ) {
 295                 push @errors, { duplicate_userid => 1, userid => $borrower{userid} };
 296                 $invalid++;
 297                 next LINE;
 298             }
 299
 300             unless (ModMember(%borrower)) {
 301                 $invalid++;
 302                 # until we have better error trapping, we have no way of knowing why ModMember errored out...
 303                 push @errors, {unknown_error => 1};
 304                 $template->param('lastinvalid'=>$borrower{'surname'}.' / '.$borrowernumber);
 305                 next LINE;
 306             }
 307
 308             # Don't add a new restriction if the existing 'combined' restriction matches this one
 309             if ( $borrower{debarred} && ( ( $borrower{debarred} ne $member->{debarred} ) || ( $borrower{debarredcomment} ne $member->{debarredcomment} ) ) ) {
 310                 # Check to see if this debarment already exists
 311                 my $debarrments = GetDebarments(
 312                     {
 313                         borrowernumber => $borrowernumber,
 314                         expiration     => $borrower{debarred},
 315                         comment        => $borrower{debarredcomment}
 316                     }
 317                 );
 318                 # If it doesn't, then add it!
 319                 unless (@$debarrments) {
 320                     AddDebarment(
 321                         {
 322                             borrowernumber => $borrowernumber,
 323                             expiration     => $borrower{debarred},
 324                             comment        => $borrower{debarredcomment}
 325                         }
 326                     );
 327                 }
 328             }
 329
 330             if ($extended) {
 331                 if ($ext_preserve) {
 332                     my $old_attributes = GetBorrowerAttributes($borrowernumber);
 333                     $patron_attributes = extended_attributes_merge($old_attributes, $patron_attributes);  #TODO: expose repeatable options in template
 334                 }
 335                 push @errors, {unknown_error => 1} unless SetBorrowerAttributes($borrower{'borrowernumber'}, $patron_attributes, 'no_branch_limit' );
 336             }
 337             $overwritten++;
 338             $template->param('lastoverwritten'=>$borrower{'surname'}.' / '.$borrowernumber);
 339         } else {
 340             # FIXME: fixup_cardnumber says to lock table, but the web interface doesn't so this doesn't either.
 341             # At least this is closer to AddMember than in members/memberentry.pl
 342             if (!$borrower{'cardnumber'}) {
 343                 $borrower{'cardnumber'} = fixup_cardnumber(undef);
 344             }
 345             if ($borrowernumber = AddMember(%borrower)) {
 346
 347                 if ( $borrower{debarred} ) {
 348                     AddDebarment(
 349                         {
 350                             borrowernumber => $borrowernumber,
 351                             expiration     => $borrower{debarred},
 352                             comment        => $borrower{debarredcomment}
 353                         }
 354                     );
 355                 }
 356
 357                 if ($extended) {
 358                     SetBorrowerAttributes($borrowernumber, $patron_attributes);
 359                 }
 360
 361                 if ($set_messaging_prefs) {
 362                     C4::Members::Messaging::SetMessagingPreferencesFromDefaults({ borrowernumber => $borrowernumber,
 363                                                                                   categorycode => $borrower{categorycode} });
 364                 }
 365
 366                 $imported++;
 367                 $template->param('lastimported'=>$borrower{'surname'}.' / '.$borrowernumber);
 368                 push @imported_borrowers, $borrowernumber; #for patronlist
 369             } else {
 370                 $invalid++;
 371                 push @errors, {unknown_error => 1};
 372                 $template->param('lastinvalid'=>$borrower{'surname'}.' / AddMember');
 373             }
 374         }
 375     }
 376
 377     if ( $imported && $createpatronlist ) {
 378         my $patronlist = AddPatronList({ name => $patronlistname });
 379         AddPatronsToList({ list => $patronlist, borrowernumbers => \@imported_borrowers });
 380         $template->param('patronlistname' => $patronlistname);
 381     }
 382
 383     (@errors  ) and $template->param(  ERRORS=>\@errors  );
 384     (@feedback) and $template->param(FEEDBACK=>\@feedback);
 385     $template->param(
 386         'uploadborrowers' => 1,
 387         'imported'        => $imported,
 388         'overwritten'     => $overwritten,
 389         'alreadyindb'     => $alreadyindb,
 390         'invalid'         => $invalid,
 391         'total'           => $imported + $alreadyindb + $invalid + $overwritten,
 392     );
 393
 394 } else {
 395     if ($extended) {
 396         my @matchpoints = ();
 397         my @attr_types = C4::Members::AttributeTypes::GetAttributeTypes(undef, 1);
 398         foreach my $type (@attr_types) {
 399             my $attr_type = C4::Members::AttributeTypes->fetch($type->{code});
 400             if ($attr_type->unique_id()) {
 401             push @matchpoints, { code =>  "patron_attribute_" . $attr_type->code(), description => $attr_type->description() };
 402             }
 403         }
 404         $template->param(matchpoints => \@matchpoints);
 405     }
 406
 407     $template->param(
 408         csrf_token => Koha::Token->new->generate_csrf(
 409             { session_id => scalar $input->cookie('CGISESSID'), }
 410         ),
 411     );
 412
 413 }
 414
 415 output_html_with_http_headers $input, $cookie, $template->output;
 416