Koha/Patrons/Import.pm

   1 package Koha::Patrons::Import;
   2
   3 # This file is part of Koha.
   4 #
   5 # Koha is free software; you can redistribute it and/or modify it under the
   6 # terms of the GNU General Public License as published by the Free Software
   7 # Foundation; either version 3 of the License, or (at your option) any later
   8 # version.
   9 #
  10 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  11 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  12 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU General Public License along
  15 # with Koha; if not, write to the Free Software Foundation, Inc.,
  16 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  17
  18 use Modern::Perl;
  19 use Moo;
  20 use namespace::clean;
  21
  22 use Carp;
  23 use Text::CSV;
  24
  25 use C4::Members;
  26 use C4::Members::Attributes qw(:all);
  27 use C4::Members::AttributeTypes;
  28
  29 use Koha::Libraries;
  30 use Koha::Patrons;
  31 use Koha::Patron::Categories;
  32 use Koha::Patron::Debarments;
  33 use Koha::DateUtils;
  34
  35 =head1 NAME
  36
  37 Koha::Patrons::Import - Perl Module containing import_patrons method exported from import_borrowers script.
  38
  39 =head1 SYNOPSIS
  40
  41 use Koha::Patrons::Import;
  42
  43 =head1 DESCRIPTION
  44
  45 This module contains one method for importing patrons in bulk.
  46
  47 =head1 FUNCTIONS
  48
  49 =head2 import_patrons
  50
  51  my $return = Koha::Patrons::Import::import_patrons($params);
  52
  53 Applies various checks and imports patrons in bulk from a csv file.
  54
  55 Further pod documentation needed here.
  56
  57 =cut
  58
  59 has 'today_iso' => ( is => 'ro', lazy => 1,
  60     default => sub { output_pref( { dt => dt_from_string(), dateonly => 1, dateformat => 'iso' } ); }, );
  61
  62 has 'text_csv' => ( is => 'rw', lazy => 1,
  63     default => sub { Text::CSV->new( { binary => 1, } ); },  );
  64
  65 sub import_patrons {
  66     my ($self, $params) = @_;
  67
  68     my $handle = $params->{file};
  69     unless( $handle ) { carp('No file handle passed in!'); return; }
  70
  71     my $matchpoint           = $params->{matchpoint};
  72     my $defaults             = $params->{defaults};
  73     my $ext_preserve         = $params->{preserve_extended_attributes};
  74     my $overwrite_cardnumber = $params->{overwrite_cardnumber};
  75     my $extended             = C4::Context->preference('ExtendedPatronAttributes');
  76     my $set_messaging_prefs  = C4::Context->preference('EnhancedMessagingPreferences');
  77
  78     my @columnkeys = $self->set_column_keys($extended);
  79     my @feedback;
  80     my @errors;
  81
  82     my $imported    = 0;
  83     my $alreadyindb = 0;
  84     my $overwritten = 0;
  85     my $invalid     = 0;
  86     my @imported_borrowers;
  87     my $matchpoint_attr_type = $self->set_attribute_types({ extended => $extended, matchpoint => $matchpoint, });
  88
  89     # Use header line to construct key to column map
  90     my %csvkeycol;
  91     my $borrowerline = <$handle>;
  92     my @csvcolumns   = $self->prepare_columns({headerrow => $borrowerline, keycol => \%csvkeycol, errors => \@errors, });
  93     push(@feedback, { feedback => 1, name => 'headerrow', value => join( ', ', @csvcolumns ) });
  94
  95     my @criticals = qw( surname );    # there probably should be others - rm branchcode && categorycode
  96   LINE: while ( my $borrowerline = <$handle> ) {
  97         my $line_number = $.;
  98         my %borrower;
  99         my @missing_criticals;
 100
 101         my $status  = $self->text_csv->parse($borrowerline);
 102         my @columns = $self->text_csv->fields();
 103         if ( !$status ) {
 104             push @missing_criticals, { badparse => 1, line => $line_number, lineraw => $borrowerline };
 105         }
 106         elsif ( @columns == @columnkeys ) {
 107             @borrower{@columnkeys} = @columns;
 108
 109             # MJR: try to fill blanks gracefully by using default values
 110             foreach my $key (@columnkeys) {
 111                 if ( $borrower{$key} !~ /\S/ ) {
 112                     $borrower{$key} = $defaults->{$key};
 113                 }
 114             }
 115         }
 116         else {
 117             # MJR: try to recover gracefully by using default values
 118             foreach my $key (@columnkeys) {
 119                 if ( defined( $csvkeycol{$key} ) and $columns[ $csvkeycol{$key} ] =~ /\S/ ) {
 120                     $borrower{$key} = $columns[ $csvkeycol{$key} ];
 121                 }
 122                 elsif ( $defaults->{$key} ) {
 123                     $borrower{$key} = $defaults->{$key};
 124                 }
 125                 elsif ( scalar grep { $key eq $_ } @criticals ) {
 126
 127                     # a critical field is undefined
 128                     push @missing_criticals, { key => $key, line => $., lineraw => $borrowerline };
 129                 }
 130                 else {
 131                     $borrower{$key} = '';
 132                 }
 133             }
 134         }
 135
 136         # Check if borrower category code exists and if it matches to a known category. Pushing error to missing_criticals otherwise.
 137         $self->check_borrower_category($borrower{categorycode}, $borrowerline, $line_number, \@missing_criticals);
 138
 139         # Check if branch code exists and if it matches to a branch name. Pushing error to missing_criticals otherwise.
 140         $self->check_branch_code($borrower{branchcode}, $borrowerline, $line_number, \@missing_criticals);
 141
 142         # Popular spreadsheet applications make it difficult to force date outputs to be zero-padded, but we require it.
 143         $self->format_dates({borrower => \%borrower, lineraw => $borrowerline, line => $line_number, missing_criticals => \@missing_criticals, });
 144
 145         if (@missing_criticals) {
 146             foreach (@missing_criticals) {
 147                 $_->{borrowernumber} = $borrower{borrowernumber} || 'UNDEF';
 148                 $_->{surname}        = $borrower{surname}        || 'UNDEF';
 149             }
 150             $invalid++;
 151             ( 25 > scalar @errors ) and push @errors, { missing_criticals => \@missing_criticals };
 152
 153             # The first 25 errors are enough.  Keeping track of 30,000+ would destroy performance.
 154             next LINE;
 155         }
 156
 157         # Set patron attributes if extended.
 158         my $patron_attributes = $self->set_patron_attributes($extended, $borrower{patron_attributes}, \@feedback);
 159         if( $extended ) { delete $borrower{patron_attributes}; } # Not really a field in borrowers.
 160
 161         # Default date enrolled and date expiry if not already set.
 162         $borrower{dateenrolled} = $self->today_iso() unless $borrower{dateenrolled};
 163         $borrower{dateexpiry} = Koha::Patron::Categories->find( $borrower{categorycode} )->get_expiry_date( $borrower{dateenrolled} ) unless $borrower{dateexpiry};
 164
 165         my $borrowernumber;
 166         my ( $member, $patron );
 167         if ( defined($matchpoint) && ( $matchpoint eq 'cardnumber' ) && ( $borrower{'cardnumber'} ) ) {
 168             $patron = Koha::Patrons->find( { cardnumber => $borrower{'cardnumber'} } );
 169         }
 170         elsif ( defined($matchpoint) && ($matchpoint eq 'userid') && ($borrower{'userid'}) ) {
 171             $patron = Koha::Patrons->find( { userid => $borrower{userid} } );
 172         }
 173         elsif ($extended) {
 174             if ( defined($matchpoint_attr_type) ) {
 175                 foreach my $attr (@$patron_attributes) {
 176                     if ( $attr->{code} eq $matchpoint and $attr->{value} ne '' ) {
 177                         my @borrowernumbers = $matchpoint_attr_type->get_patrons( $attr->{value} );
 178                         $borrowernumber = $borrowernumbers[0] if scalar(@borrowernumbers) == 1;
 179                         $patron = Koha::Patrons->find( $borrowernumber );
 180                         last;
 181                     }
 182                 }
 183             }
 184         }
 185
 186         if ($patron) {
 187             $member = $patron->unblessed;
 188             $borrowernumber = $member->{'borrowernumber'};
 189         } else {
 190             $member = {};
 191         }
 192
 193         if ( C4::Members::checkcardnumber( $borrower{cardnumber}, $borrowernumber ) ) {
 194             push @errors,
 195               {
 196                 invalid_cardnumber => 1,
 197                 borrowernumber     => $borrowernumber,
 198                 cardnumber         => $borrower{cardnumber}
 199               };
 200             $invalid++;
 201             next;
 202         }
 203
 204
 205         # Check if the userid provided does not exist yet
 206         if (    defined($matchpoint)
 207             and $matchpoint ne 'userid'
 208             and exists $borrower{userid}
 209             and $borrower{userid}
 210             and not ( $borrowernumber ? $patron->userid( $borrower{userid} )->has_valid_userid : Koha::Patron->new( { userid => $borrower{userid} } )->has_valid_userid )
 211         ) {
 212             push @errors, { duplicate_userid => 1, userid => $borrower{userid} };
 213             $invalid++;
 214             next LINE;
 215         }
 216
 217         if ($borrowernumber) {
 218
 219             # borrower exists
 220             unless ($overwrite_cardnumber) {
 221                 $alreadyindb++;
 222                 push(
 223                     @feedback,
 224                     {
 225                         already_in_db => 1,
 226                         value         => $borrower{'surname'} . ' / ' . $borrowernumber
 227                     }
 228                 );
 229                 next LINE;
 230             }
 231             $borrower{'borrowernumber'} = $borrowernumber;
 232             for my $col ( keys %borrower ) {
 233
 234                 # use values from extant patron unless our csv file includes this column or we provided a default.
 235                 # FIXME : You cannot update a field with a  perl-evaluated false value using the defaults.
 236
 237                 # The password is always encrypted, skip it!
 238                 next if $col eq 'password';
 239
 240                 unless ( exists( $csvkeycol{$col} ) || $defaults->{$col} ) {
 241                     $borrower{$col} = $member->{$col} if ( $member->{$col} );
 242                 }
 243             }
 244
 245             my $patron = Koha::Patrons->find( $borrowernumber );
 246             eval { $patron->set(\%borrower)->store };
 247             if ( $@ ) {
 248                 $invalid++;
 249
 250                 push(
 251                     @errors,
 252                     {
 253                         # TODO We can raise a better error
 254                         name  => 'lastinvalid',
 255                         value => $borrower{'surname'} . ' / ' . $borrowernumber
 256                     }
 257                 );
 258                 next LINE;
 259             }
 260             # Don't add a new restriction if the existing 'combined' restriction matches this one
 261             if ( $borrower{debarred} && ( ( $borrower{debarred} ne $member->{debarred} ) || ( $borrower{debarredcomment} ne $member->{debarredcomment} ) ) ) {
 262
 263                 # Check to see if this debarment already exists
 264                 my $debarrments = GetDebarments(
 265                     {
 266                         borrowernumber => $borrowernumber,
 267                         expiration     => $borrower{debarred},
 268                         comment        => $borrower{debarredcomment}
 269                     }
 270                 );
 271
 272                 # If it doesn't, then add it!
 273                 unless (@$debarrments) {
 274                     AddDebarment(
 275                         {
 276                             borrowernumber => $borrowernumber,
 277                             expiration     => $borrower{debarred},
 278                             comment        => $borrower{debarredcomment}
 279                         }
 280                     );
 281                 }
 282             }
 283             if ($extended) {
 284                 if ($ext_preserve) {
 285                     my $old_attributes = GetBorrowerAttributes($borrowernumber);
 286                     $patron_attributes = extended_attributes_merge( $old_attributes, $patron_attributes );
 287                 }
 288                 push @errors, { unknown_error => 1 }
 289                   unless SetBorrowerAttributes( $borrower{'borrowernumber'}, $patron_attributes, 'no_branch_limit' );
 290             }
 291             $overwritten++;
 292             push(
 293                 @feedback,
 294                 {
 295                     feedback => 1,
 296                     name     => 'lastoverwritten',
 297                     value    => $borrower{'surname'} . ' / ' . $borrowernumber
 298                 }
 299             );
 300         }
 301         else {
 302             my $patron = eval {
 303                 Koha::Patron->new(\%borrower)->store;
 304             };
 305             unless ( $@ ) {
 306
 307                 if ( $patron->is_debarred ) {
 308                     AddDebarment(
 309                         {
 310                             borrowernumber => $patron->borrowernumber,
 311                             expiration     => $patron->debarred,
 312                             comment        => $patron->debarredcomment,
 313                         }
 314                     );
 315                 }
 316
 317                 if ($extended) {
 318                     SetBorrowerAttributes( $patron->borrowernumber, $patron_attributes );
 319                 }
 320
 321                 if ($set_messaging_prefs) {
 322                     C4::Members::Messaging::SetMessagingPreferencesFromDefaults(
 323                         {
 324                             borrowernumber => $patron->borrowernumber,
 325                             categorycode   => $patron->categorycode,
 326                         }
 327                     );
 328                 }
 329
 330                 $imported++;
 331                 push @imported_borrowers, $patron->borrowernumber; #for patronlist
 332                 push(
 333                     @feedback,
 334                     {
 335                         feedback => 1,
 336                         name     => 'lastimported',
 337                         value    => $patron->surname . ' / ' . $patron->borrowernumber,
 338                     }
 339                 );
 340             }
 341             else {
 342                 $invalid++;
 343                 push @errors, { unknown_error => 1 };
 344                 push(
 345                     @errors,
 346                     {
 347                         name  => 'lastinvalid',
 348                         value => $borrower{'surname'} . ' / Create patron',
 349                     }
 350                 );
 351             }
 352         }
 353     }
 354
 355     return {
 356         feedback      => \@feedback,
 357         errors        => \@errors,
 358         imported      => $imported,
 359         overwritten   => $overwritten,
 360         already_in_db => $alreadyindb,
 361         invalid       => $invalid,
 362         imported_borrowers => \@imported_borrowers,
 363     };
 364 }
 365
 366 =head2 prepare_columns
 367
 368  my @csvcolumns = $self->prepare_columns({headerrow => $borrowerline, keycol => \%csvkeycol, errors => \@errors, });
 369
 370 Returns an array of all column key and populates a hash of colunm key positions.
 371
 372 =cut
 373
 374 sub prepare_columns {
 375     my ($self, $params) = @_;
 376
 377     my $status = $self->text_csv->parse($params->{headerrow});
 378     unless( $status ) {
 379         push( @{$params->{errors}}, { badheader => 1, line => 1, lineraw => $params->{headerrow} });
 380         return;
 381     }
 382
 383     my @csvcolumns = $self->text_csv->fields();
 384     my $col = 0;
 385     foreach my $keycol (@csvcolumns) {
 386         # columnkeys don't contain whitespace, but some stupid tools add it
 387         $keycol =~ s/ +//g;
 388         $params->{keycol}->{$keycol} = $col++;
 389     }
 390
 391     return @csvcolumns;
 392 }
 393
 394 =head2 set_attribute_types
 395
 396  my $matchpoint_attr_type = $self->set_attribute_types({ extended => $extended, matchpoint => $matchpoint, });
 397
 398 Returns an attribute type based on matchpoint parameter.
 399
 400 =cut
 401
 402 sub set_attribute_types {
 403     my ($self, $params) = @_;
 404
 405     my $attribute_types;
 406     if( $params->{extended} ) {
 407         $attribute_types = C4::Members::AttributeTypes->fetch($params->{matchpoint});
 408     }
 409
 410     return $attribute_types;
 411 }
 412
 413 =head2 set_column_keys
 414
 415  my @columnkeys = set_column_keys($extended);
 416
 417 Returns an array of borrowers' table columns.
 418
 419 =cut
 420
 421 sub set_column_keys {
 422     my ($self, $extended) = @_;
 423
 424     my @columnkeys = map { $_ ne 'borrowernumber' ? $_ : () } Koha::Patrons->columns();
 425     push( @columnkeys, 'patron_attributes' ) if $extended;
 426
 427     return @columnkeys;
 428 }
 429
 430 =head2 set_patron_attributes
 431
 432  my $patron_attributes = set_patron_attributes($extended, $borrower{patron_attributes}, $feedback);
 433
 434 Returns a reference to array of hashrefs data structure as expected by SetBorrowerAttributes.
 435
 436 =cut
 437
 438 sub set_patron_attributes {
 439     my ($self, $extended, $patron_attributes, $feedback) = @_;
 440
 441     unless( $extended ) { return; }
 442     unless( defined($patron_attributes) ) { return; }
 443
 444     # Fixup double quotes in case we are passed smart quotes
 445     $patron_attributes =~ s/\xe2\x80\x9c/"/g;
 446     $patron_attributes =~ s/\xe2\x80\x9d/"/g;
 447
 448     push (@$feedback, { feedback => 1, name => 'attribute string', value => $patron_attributes });
 449
 450     my $result = extended_attributes_code_value_arrayref($patron_attributes);
 451
 452     return $result;
 453 }
 454
 455 =head2 check_branch_code
 456
 457  check_branch_code($borrower{branchcode}, $borrowerline, $line_number, \@missing_criticals);
 458
 459 Pushes a 'missing_criticals' error entry if no branch code or branch code does not map to a branch name.
 460
 461 =cut
 462
 463 sub check_branch_code {
 464     my ($self, $branchcode, $borrowerline, $line_number, $missing_criticals) = @_;
 465
 466     # No branch code
 467     unless( $branchcode ) {
 468         push (@$missing_criticals, { key => 'branchcode', line => $line_number, lineraw => $borrowerline, });
 469         return;
 470     }
 471
 472     # look for branch code
 473     my $library = Koha::Libraries->find( $branchcode );
 474     unless( $library ) {
 475         push (@$missing_criticals, { key => 'branchcode', line => $line_number, lineraw => $borrowerline,
 476                                      value => $branchcode, branch_map => 1, });
 477     }
 478 }
 479
 480 =head2 check_borrower_category
 481
 482  check_borrower_category($borrower{categorycode}, $borrowerline, $line_number, \@missing_criticals);
 483
 484 Pushes a 'missing_criticals' error entry if no category code or category code does not map to a known category.
 485
 486 =cut
 487
 488 sub check_borrower_category {
 489     my ($self, $categorycode, $borrowerline, $line_number, $missing_criticals) = @_;
 490
 491     # No branch code
 492     unless( $categorycode ) {
 493         push (@$missing_criticals, { key => 'categorycode', line => $line_number, lineraw => $borrowerline, });
 494         return;
 495     }
 496
 497     # Looking for borrower category
 498     my $category = Koha::Patron::Categories->find($categorycode);
 499     unless( $category ) {
 500         push (@$missing_criticals, { key => 'categorycode', line => $line_number, lineraw => $borrowerline,
 501                                      value => $categorycode, category_map => 1, });
 502     }
 503 }
 504
 505 =head2 format_dates
 506
 507  format_dates({borrower => \%borrower, lineraw => $lineraw, line => $line_number, missing_criticals => \@missing_criticals, });
 508
 509 Pushes a 'missing_criticals' error entry for each of the 3 date types dateofbirth, dateenrolled and dateexpiry if it can not
 510 be formatted to the chosen date format. Populates the correctly formatted date otherwise.
 511
 512 =cut
 513
 514 sub format_dates {
 515     my ($self, $params) = @_;
 516
 517     foreach my $date_type (qw(dateofbirth dateenrolled dateexpiry date_renewed)) {
 518         my $tempdate = $params->{borrower}->{$date_type} or next();
 519         my $formatted_date = eval { output_pref( { dt => dt_from_string( $tempdate ), dateonly => 1, dateformat => 'iso' } ); };
 520
 521         if ($formatted_date) {
 522             $params->{borrower}->{$date_type} = $formatted_date;
 523         } else {
 524             $params->{borrower}->{$date_type} = '';
 525             push (@{$params->{missing_criticals}}, { key => $date_type, line => $params->{line}, lineraw => $params->{lineraw}, bad_date => 1 });
 526         }
 527     }
 528 }
 529
 530 1;
 531
 532 =head1 AUTHOR
 533
 534 Koha Team
 535
 536 =cut