1 package Koha::Patrons::Import;
3 # This file is part of Koha.
5 # Koha is free software; you can redistribute it and/or modify it
6 # under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 3 of the License, or
8 # (at your option) any later version.
10 # Koha is distributed in the hope that it will be useful, but
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
23 use Encode qw( decode_utf8 );
24 use Try::Tiny qw( catch try );
26 use C4::Members qw( checkcardnumber );
27 use C4::Letters qw( GetPreparedLetter EnqueueLetter );
31 use Koha::Patron::Categories;
32 use Koha::Patron::Debarments qw( AddDebarment );
33 use Koha::DateUtils qw( dt_from_string output_pref );
37 Koha::Patrons::Import - Perl Module containing import_patrons method exported from import_borrowers script.
41 use Koha::Patrons::Import;
45 This module contains one method for importing patrons in bulk.
51 my $return = Koha::Patrons::Import::import_patrons($params);
53 Applies various checks and imports patrons in bulk from a csv file.
55 Further pod documentation needed here.
59 has 'today_iso' => ( is => 'ro', lazy => 1,
60 # FIXME We shouldn't need to call output_pref here, passing a DateTime object should work
61 default => sub { output_pref( { dt => dt_from_string(), dateonly => 1, dateformat => 'iso' } ); }, );
63 has 'text_csv' => ( is => 'rw', lazy => 1,
64 default => sub { Text::CSV->new( { binary => 1, } ); }, );
67 my ($self, $params) = @_;
69 my $handle = $params->{file};
70 unless( $handle ) { carp('No file handle passed in!'); return; }
72 my $matchpoint = $params->{matchpoint};
73 my $defaults = $params->{defaults};
74 my $preserve_fields = $params->{preserve_fields};
75 my $ext_preserve = $params->{preserve_extended_attributes};
76 my $overwrite_cardnumber = $params->{overwrite_cardnumber};
77 my $overwrite_passwords = $params->{overwrite_passwords};
78 my $dry_run = $params->{dry_run};
79 my $send_welcome = $params->{send_welcome};
80 my $extended = C4::Context->preference('ExtendedPatronAttributes');
81 my $set_messaging_prefs = C4::Context->preference('EnhancedMessagingPreferences');
82 my $update_dateexpiry = $params->{update_dateexpiry};
83 my $update_dateexpiry_from_today = $params->{update_dateexpiry_from_today};
85 my $schema = Koha::Database->new->schema;
86 $schema->storage->txn_begin if $dry_run;
88 my @columnkeys = $self->set_column_keys($extended);
96 my @imported_borrowers;
97 my $matchpoint_attr_type = $self->set_attribute_types({ extended => $extended, matchpoint => $matchpoint, });
99 # Use header line to construct key to column map
101 my $borrowerline = <$handle>;
102 my @csvcolumns = $self->prepare_columns({headerrow => $borrowerline, keycol => \%csvkeycol, errors => \@errors, });
103 push(@feedback, { feedback => 1, name => 'headerrow', value => join( ', ', @csvcolumns ) });
105 my @criticals = qw( surname ); # there probably should be others - rm branchcode && categorycode
106 LINE: while ( my $borrowerline = <$handle> ) {
107 my $line_number = $.;
109 my @missing_criticals;
111 my $status = $self->text_csv->parse($borrowerline);
112 my @columns = $self->text_csv->fields();
114 push @missing_criticals, { badparse => 1, line => $line_number, lineraw => decode_utf8($borrowerline) };
116 elsif ( @columns == @columnkeys ) {
117 @borrower{@columnkeys} = @columns;
119 # MJR: try to fill blanks gracefully by using default values
120 foreach my $key (@columnkeys) {
121 if ( $borrower{$key} !~ /\S/ ) {
122 $borrower{$key} = $defaults->{$key};
127 # MJR: try to recover gracefully by using default values
128 foreach my $key (@columnkeys) {
129 if ( defined( $csvkeycol{$key} ) and $columns[ $csvkeycol{$key} ] =~ /\S/ ) {
130 $borrower{$key} = $columns[ $csvkeycol{$key} ];
132 elsif ( $defaults->{$key} ) {
133 $borrower{$key} = $defaults->{$key};
135 elsif ( scalar grep { $key eq $_ } @criticals ) {
137 # a critical field is undefined
138 push @missing_criticals, { key => $key, line => $., lineraw => decode_utf8($borrowerline) };
141 $borrower{$key} = '';
146 $borrower{cardnumber} = undef if $borrower{cardnumber} eq "";
147 $borrower{auth_method} = undef if $borrower{auth_method} eq "";
149 # Check if borrower category code exists and if it matches to a known category. Pushing error to missing_criticals otherwise.
150 $self->check_borrower_category($borrower{categorycode}, $borrowerline, $line_number, \@missing_criticals);
152 # Check if branch code exists and if it matches to a branch name. Pushing error to missing_criticals otherwise.
153 $self->check_branch_code($borrower{branchcode}, $borrowerline, $line_number, \@missing_criticals);
155 # Popular spreadsheet applications make it difficult to force date outputs to be zero-padded, but we require it.
156 $self->format_dates({borrower => \%borrower, lineraw => $borrowerline, line => $line_number, missing_criticals => \@missing_criticals, });
158 if (@missing_criticals) {
159 foreach (@missing_criticals) {
160 $_->{borrowernumber} = $borrower{borrowernumber} || 'UNDEF';
161 $_->{surname} = $borrower{surname} || 'UNDEF';
164 ( 25 > scalar @errors ) and push @errors, { missing_criticals => \@missing_criticals };
166 # The first 25 errors are enough. Keeping track of 30,000+ would destroy performance.
170 # Generate patron attributes if extended.
171 my $patron_attributes = $self->generate_patron_attributes($extended, $borrower{patron_attributes}, \@feedback);
172 if( $extended ) { delete $borrower{patron_attributes}; } # Not really a field in borrowers.
174 # Default date enrolled and date expiry if not already set.
175 $borrower{dateenrolled} = $self->today_iso() unless $borrower{dateenrolled};
176 my $expiration_start_date = $update_dateexpiry_from_today ? dt_from_string : $borrower{dateenrolled};
177 $borrower{dateexpiry} = Koha::Patron::Categories->find( $borrower{categorycode} )->get_expiry_date( $expiration_start_date ) if $update_dateexpiry;
180 my ( $member, $patron );
181 if ( defined($matchpoint) && ( $matchpoint eq 'cardnumber' ) && ( $borrower{'cardnumber'} ) ) {
182 $patron = Koha::Patrons->find( { cardnumber => $borrower{'cardnumber'} } );
184 elsif ( defined($matchpoint) && ($matchpoint eq 'userid') && ($borrower{'userid'}) ) {
185 $patron = Koha::Patrons->find( { userid => $borrower{userid} } );
188 if ( defined($matchpoint_attr_type) ) {
189 foreach my $attr (@$patron_attributes) {
190 if ( $attr->{code} eq $matchpoint and $attr->{attribute} ne '' ) {
191 my @borrowernumbers = Koha::Patron::Attributes->search(
193 code => $matchpoint_attr_type->code,
194 attribute => $attr->{attribute}
196 )->get_column('borrowernumber');
198 $borrowernumber = $borrowernumbers[0] if scalar(@borrowernumbers) == 1;
199 $patron = Koha::Patrons->find( $borrowernumber );
208 $member = $patron->unblessed;
209 $borrowernumber = $member->{'borrowernumber'};
215 if ( C4::Members::checkcardnumber( $borrower{cardnumber}, $borrowernumber ) ) {
218 invalid_cardnumber => 1,
219 borrowernumber => $borrowernumber,
220 cardnumber => $borrower{cardnumber}
227 # Check if the userid provided does not exist yet
228 if ( defined($matchpoint)
229 and $matchpoint ne 'userid'
230 and exists $borrower{userid}
231 and $borrower{userid}
232 and not ( $borrowernumber ? $patron->userid( $borrower{userid} )->has_valid_userid : Koha::Patron->new( { userid => $borrower{userid} } )->has_valid_userid )
234 push @errors, { duplicate_userid => 1, userid => $borrower{userid} };
239 my $guarantor_relationship = $borrower{guarantor_relationship};
240 delete $borrower{guarantor_relationship};
241 my $guarantor_id = $borrower{guarantor_id};
242 delete $borrower{guarantor_id};
244 # Remove warning for int datatype that cannot be null
245 # Argument "" isn't numeric in numeric eq (==) at /usr/share/perl5/DBIx/Class/Row.pm line 1018
247 qw( privacy privacy_guarantor_fines privacy_guarantor_checkouts anonymized login_attempts ))
249 delete $borrower{$field}
250 if exists $borrower{$field} and $borrower{$field} eq "";
254 if ($borrowernumber) {
257 unless ($overwrite_cardnumber) {
263 value => $borrower{'surname'} . ' / ' . $borrowernumber
268 $borrower{'borrowernumber'} = $borrowernumber;
270 if ( $preserve_fields ) {
271 for my $field ( @$preserve_fields ) {
272 $borrower{$field} = $patron->$field;
276 for my $col ( keys %borrower ) {
278 # use values from extant patron unless our csv file includes this column or we provided a default.
279 # FIXME : You cannot update a field with a perl-evaluated false value using the defaults.
281 # The password is always encrypted, skip it unless we are forcing overwrite!
282 next if $col eq 'password' && !$overwrite_passwords;
283 next if $col eq 'dateexpiry' && $update_dateexpiry;
285 unless ( exists( $csvkeycol{$col} ) || $defaults->{$col} ) {
286 $borrower{$col} = $member->{$col} if ( $member->{$col} );
291 $schema->storage->txn_do(sub {
292 $patron->set(\%borrower)->store;
293 # Don't add a new restriction if the existing 'combined' restriction matches this one
294 if ( $borrower{debarred} && ( ( $borrower{debarred} ne $member->{debarred} ) || ( $borrower{debarredcomment} ne $member->{debarredcomment} ) ) ) {
296 # Check to see if this debarment already exists
297 my $restrictions = $patron->restrictions->search(
299 expiration => $borrower{debarred},
300 comment => $borrower{debarredcomment}
304 # If it doesn't, then add it!
305 unless ($restrictions->count) {
308 borrowernumber => $borrowernumber,
309 expiration => $borrower{debarred},
310 comment => $borrower{debarredcomment}
315 if ($patron->category->category_type ne 'S' && $overwrite_passwords && defined $borrower{password} && $borrower{password} ne ''){
317 $patron->set_password({ password => $borrower{password} });
320 if ( $_->isa('Koha::Exceptions::Password::TooShort') ) {
321 push @errors, { passwd_too_short => 1, borrowernumber => $borrowernumber, length => $_->{length}, min_length => $_->{min_length} };
323 elsif ( $_->isa('Koha::Exceptions::Password::WhitespaceCharacters') ) {
324 push @errors, { passwd_whitespace => 1, borrowernumber => $borrowernumber } ;
326 elsif ( $_->isa('Koha::Exceptions::Password::TooWeak') ) {
327 push @errors, { passwd_too_weak => 1, borrowernumber => $borrowernumber } ;
329 elsif ( $_->isa('Koha::Exceptions::Password::Plugin') ) {
330 push @errors, { passwd_plugin_err => 1, borrowernumber => $borrowernumber } ;
333 push @errors, { passwd_unknown_err => 1, borrowernumber => $borrowernumber } ;
337 if ($extended && @$patron_attributes) {
339 $patron_attributes = $patron->extended_attributes->merge_and_replace_with( $patron_attributes );
341 # We do not want to filter by branch, maybe we should?
342 Koha::Patrons->find($borrowernumber)->extended_attributes->delete;
343 $patron->extended_attributes($patron_attributes);
350 name => 'lastoverwritten',
351 value => $borrower{'surname'} . ' / ' . $borrowernumber
359 my $patron_id = defined $matchpoint ? $borrower{$matchpoint} : $matchpoint_attr_type;
360 if ( $_->isa('Koha::Exceptions::Patron::Attribute::UniqueIDConstraint') ) {
361 push @errors, { patron_attribute_unique_id_constraint => 1, borrowernumber => $borrowernumber, attribute => $_->attribute };
362 } elsif ( $_->isa('Koha::Exceptions::Patron::Attribute::InvalidType') ) {
363 push @errors, { patron_attribute_invalid_type => 1, borrowernumber => $borrowernumber, attribute_type_code => $_->type };
364 } elsif ( $_->isa('Koha::Exceptions::Patron::Attribute::NonRepeatable') ) {
365 push @errors, { patron_attribute_non_repeatable => 1, borrowernumber => $borrowernumber, attribute => $_->attribute };
368 push @errors, { unknown_error => 1 };
374 # TODO We can raise a better error
375 name => 'lastinvalid',
376 value => $borrower{'surname'} . ' / ' . $borrowernumber
383 $schema->storage->txn_do(sub {
384 $patron = Koha::Patron->new(\%borrower)->store;
385 $borrowernumber = $patron->id;
387 if ( $patron->is_debarred ) {
390 borrowernumber => $patron->borrowernumber,
391 expiration => $patron->debarred,
392 comment => $patron->debarredcomment,
397 if ($extended && @$patron_attributes) {
398 # FIXME Hum, we did not filter earlier and now we do?
399 $patron->extended_attributes->filter_by_branch_limitations->delete;
400 $patron->extended_attributes($patron_attributes);
403 if ($set_messaging_prefs) {
404 C4::Members::Messaging::SetMessagingPreferencesFromDefaults(
406 borrowernumber => $patron->borrowernumber,
407 categorycode => $patron->categorycode,
413 push @imported_borrowers, $patron->borrowernumber; #for patronlist
418 name => 'lastimported',
419 value => $patron->surname . ' / ' . $patron->borrowernumber,
426 my $patron_id = defined $matchpoint ? $borrower{$matchpoint} : $matchpoint_attr_type;
427 if ( $_->isa('Koha::Exceptions::Patron::Attribute::UniqueIDConstraint') ) {
428 push @errors, { patron_attribute_unique_id_constraint => 1, patron_id => $patron_id, attribute => $_->attribute };
429 } elsif ( $_->isa('Koha::Exceptions::Patron::Attribute::InvalidType') ) {
430 push @errors, { patron_attribute_invalid_type => 1, patron_id => $patron_id, attribute_type_code => $_->type };
431 } elsif ( $_->isa('Koha::Exceptions::Patron::Attribute::NonRepeatable') ) {
432 push @errors, { patron_attribute_non_repeatable => 1, patron_id => $patron_id, attribute => $_->attribute };
436 push @errors, { unknown_error => 1 };
441 name => 'lastinvalid',
442 value => $borrower{'surname'} . ' / Create patron',
448 next LINE unless $success;
450 # Send WELCOME welcome email is the user is new and we're set to send mail
451 if ($send_welcome && $is_new) {
452 my $emailaddr = $patron->notice_email_address;
454 # if we manage to find a valid email address, send notice
457 my $letter = GetPreparedLetter(
459 letter_code => 'WELCOME',
460 branchcode => $patron->branchcode,,
461 lang => $patron->lang || 'default',
463 'branches' => $patron->branchcode,
464 'borrowers' => $patron->borrowernumber,
469 my $message_id = EnqueueLetter(
472 borrowernumber => $patron->id,
473 to_address => $emailaddr,
474 message_transport_type => 'email'
479 push @errors, { welcome_email_err => 1, borrowernumber => $borrowernumber };
485 name => 'welcome_sent',
486 value => $borrower{'surname'} . ' / ' . $borrowernumber . ' / ' . $emailaddr
493 # Add a guarantor if we are given a relationship
494 if ( $guarantor_id ) {
495 my $relationship = Koha::Patron::Relationships->find(
497 guarantee_id => $borrowernumber,
498 guarantor_id => $guarantor_id,
502 if ( $relationship ) {
503 $relationship->relationship( $guarantor_relationship );
504 $relationship->store();
507 Koha::Patron::Relationship->new(
509 guarantee_id => $borrowernumber,
510 relationship => $guarantor_relationship,
511 guarantor_id => $guarantor_id,
518 $schema->storage->txn_rollback if $dry_run;
521 feedback => \@feedback,
523 imported => $imported,
524 overwritten => $overwritten,
525 already_in_db => $alreadyindb,
527 imported_borrowers => \@imported_borrowers,
531 =head2 prepare_columns
533 my @csvcolumns = $self->prepare_columns({headerrow => $borrowerline, keycol => \%csvkeycol, errors => \@errors, });
535 Returns an array of all column key and populates a hash of colunm key positions.
539 sub prepare_columns {
540 my ($self, $params) = @_;
542 my $status = $self->text_csv->parse($params->{headerrow});
544 push( @{$params->{errors}}, { badheader => 1, line => 1, lineraw => $params->{headerrow} });
548 my @csvcolumns = $self->text_csv->fields();
550 foreach my $keycol (@csvcolumns) {
551 # columnkeys don't contain whitespace, but some stupid tools add it
553 $keycol =~ s/^\N{BOM}//; # Strip BOM if exists, otherwise it will be part of first column key
554 $params->{keycol}->{$keycol} = $col++;
560 =head2 set_attribute_types
562 my $matchpoint_attr_type = $self->set_attribute_types({ extended => $extended, matchpoint => $matchpoint, });
564 Returns an attribute type based on matchpoint parameter.
568 sub set_attribute_types {
569 my ($self, $params) = @_;
572 if( $params->{extended} ) {
573 $attribute_type = Koha::Patron::Attribute::Types->find($params->{matchpoint});
576 return $attribute_type;
579 =head2 set_column_keys
581 my @columnkeys = set_column_keys($extended);
583 Returns an array of borrowers' table columns.
587 sub set_column_keys {
588 my ($self, $extended) = @_;
590 my @columnkeys = map { $_ ne 'borrowernumber' ? $_ : () } Koha::Patrons->columns();
591 push( @columnkeys, 'patron_attributes' ) if $extended;
592 push( @columnkeys, qw( guarantor_relationship guarantor_id ) );
597 =head2 generate_patron_attributes
599 my $patron_attributes = generate_patron_attributes($extended, $borrower{patron_attributes}, $feedback);
601 Returns a Koha::Patron::Attributes as expected by Koha::Patron->extended_attributes
605 sub generate_patron_attributes {
606 my ($self, $extended, $string, $feedback) = @_;
608 unless( $extended ) { return; }
609 unless( defined $string ) { return; }
611 # Fixup double quotes in case we are passed smart quotes
612 $string =~ s/\xe2\x80\x9c/"/g;
613 $string =~ s/\xe2\x80\x9d/"/g;
615 push (@$feedback, { feedback => 1, name => 'attribute string', value => $string });
616 return [] unless $string; # Unit tests want the feedback, is it really needed?
618 my $csv = Text::CSV->new({binary => 1}); # binary needed for non-ASCII Unicode
619 my $ok = $csv->parse($string); # parse field again to get subfields!
620 my @list = $csv->fields();
621 my @patron_attributes =
622 sort { $a->{code} cmp $b->{code} || $a->{attribute} cmp $b->{attribute} }
624 my @arr = split /:/, $_, 2;
625 { code => $arr[0], attribute => $arr[1] }
627 return \@patron_attributes;
628 # TODO: error handling (check $ok)
631 =head2 check_branch_code
633 check_branch_code($borrower{branchcode}, $borrowerline, $line_number, \@missing_criticals);
635 Pushes a 'missing_criticals' error entry if no branch code or branch code does not map to a branch name.
639 sub check_branch_code {
640 my ($self, $branchcode, $borrowerline, $line_number, $missing_criticals) = @_;
643 unless( $branchcode ) {
644 push (@$missing_criticals, { key => 'branchcode', line => $line_number, lineraw => decode_utf8($borrowerline), });
648 # look for branch code
649 my $library = Koha::Libraries->find( $branchcode );
651 push (@$missing_criticals, { key => 'branchcode', line => $line_number, lineraw => decode_utf8($borrowerline),
652 value => $branchcode, branch_map => 1, });
656 =head2 check_borrower_category
658 check_borrower_category($borrower{categorycode}, $borrowerline, $line_number, \@missing_criticals);
660 Pushes a 'missing_criticals' error entry if no category code or category code does not map to a known category.
664 sub check_borrower_category {
665 my ($self, $categorycode, $borrowerline, $line_number, $missing_criticals) = @_;
668 unless( $categorycode ) {
669 push (@$missing_criticals, { key => 'categorycode', line => $line_number, lineraw => decode_utf8($borrowerline), });
673 # Looking for borrower category
674 my $category = Koha::Patron::Categories->find($categorycode);
675 unless( $category ) {
676 push (@$missing_criticals, { key => 'categorycode', line => $line_number, lineraw => decode_utf8($borrowerline),
677 value => $categorycode, category_map => 1, });
683 format_dates({borrower => \%borrower, lineraw => $lineraw, line => $line_number, missing_criticals => \@missing_criticals, });
685 Pushes a 'missing_criticals' error entry for each of the 3 date types dateofbirth, dateenrolled and dateexpiry if it can not
686 be formatted to the chosen date format. Populates the correctly formatted date otherwise.
691 my ($self, $params) = @_;
693 foreach my $date_type (qw(dateofbirth dateenrolled dateexpiry date_renewed)) {
694 my $tempdate = $params->{borrower}->{$date_type} or next();
695 my $formatted_date = eval { output_pref( { dt => dt_from_string( $tempdate ), dateonly => 1, dateformat => 'iso' } ); };
697 if ($formatted_date) {
698 $params->{borrower}->{$date_type} = $formatted_date;
700 $params->{borrower}->{$date_type} = '';
701 push (@{$params->{missing_criticals}}, { key => $date_type, line => $params->{line}, lineraw => decode_utf8($params->{lineraw}), bad_date => 1 });