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 GetDebarments );
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 default => sub { output_pref( { dt => dt_from_string(), dateonly => 1, dateformat => 'iso' } ); }, );
62 has 'text_csv' => ( is => 'rw', lazy => 1,
63 default => sub { Text::CSV->new( { binary => 1, } ); }, );
66 my ($self, $params) = @_;
68 my $handle = $params->{file};
69 unless( $handle ) { carp('No file handle passed in!'); return; }
71 my $matchpoint = $params->{matchpoint};
72 my $defaults = $params->{defaults};
73 my $preserve_fields = $params->{preserve_fields};
74 my $ext_preserve = $params->{preserve_extended_attributes};
75 my $overwrite_cardnumber = $params->{overwrite_cardnumber};
76 my $overwrite_passwords = $params->{overwrite_passwords};
77 my $dry_run = $params->{dry_run};
78 my $send_welcome = $params->{send_welcome};
79 my $extended = C4::Context->preference('ExtendedPatronAttributes');
80 my $set_messaging_prefs = C4::Context->preference('EnhancedMessagingPreferences');
82 my $schema = Koha::Database->new->schema;
83 $schema->storage->txn_begin if $dry_run;
85 my @columnkeys = $self->set_column_keys($extended);
93 my @imported_borrowers;
94 my $matchpoint_attr_type = $self->set_attribute_types({ extended => $extended, matchpoint => $matchpoint, });
96 # Use header line to construct key to column map
98 my $borrowerline = <$handle>;
99 my @csvcolumns = $self->prepare_columns({headerrow => $borrowerline, keycol => \%csvkeycol, errors => \@errors, });
100 push(@feedback, { feedback => 1, name => 'headerrow', value => join( ', ', @csvcolumns ) });
102 my @criticals = qw( surname ); # there probably should be others - rm branchcode && categorycode
103 LINE: while ( my $borrowerline = <$handle> ) {
104 my $line_number = $.;
106 my @missing_criticals;
108 my $status = $self->text_csv->parse($borrowerline);
109 my @columns = $self->text_csv->fields();
111 push @missing_criticals, { badparse => 1, line => $line_number, lineraw => decode_utf8($borrowerline) };
113 elsif ( @columns == @columnkeys ) {
114 @borrower{@columnkeys} = @columns;
116 # MJR: try to fill blanks gracefully by using default values
117 foreach my $key (@columnkeys) {
118 if ( $borrower{$key} !~ /\S/ ) {
119 $borrower{$key} = $defaults->{$key};
124 # MJR: try to recover gracefully by using default values
125 foreach my $key (@columnkeys) {
126 if ( defined( $csvkeycol{$key} ) and $columns[ $csvkeycol{$key} ] =~ /\S/ ) {
127 $borrower{$key} = $columns[ $csvkeycol{$key} ];
129 elsif ( $defaults->{$key} ) {
130 $borrower{$key} = $defaults->{$key};
132 elsif ( scalar grep { $key eq $_ } @criticals ) {
134 # a critical field is undefined
135 push @missing_criticals, { key => $key, line => $., lineraw => decode_utf8($borrowerline) };
138 $borrower{$key} = '';
143 $borrower{cardnumber} = undef if $borrower{cardnumber} eq "";
144 $borrower{auth_method} = undef if $borrower{auth_method} eq "";
146 # Check if borrower category code exists and if it matches to a known category. Pushing error to missing_criticals otherwise.
147 $self->check_borrower_category($borrower{categorycode}, $borrowerline, $line_number, \@missing_criticals);
149 # Check if branch code exists and if it matches to a branch name. Pushing error to missing_criticals otherwise.
150 $self->check_branch_code($borrower{branchcode}, $borrowerline, $line_number, \@missing_criticals);
152 # Popular spreadsheet applications make it difficult to force date outputs to be zero-padded, but we require it.
153 $self->format_dates({borrower => \%borrower, lineraw => $borrowerline, line => $line_number, missing_criticals => \@missing_criticals, });
155 if (@missing_criticals) {
156 foreach (@missing_criticals) {
157 $_->{borrowernumber} = $borrower{borrowernumber} || 'UNDEF';
158 $_->{surname} = $borrower{surname} || 'UNDEF';
161 ( 25 > scalar @errors ) and push @errors, { missing_criticals => \@missing_criticals };
163 # The first 25 errors are enough. Keeping track of 30,000+ would destroy performance.
167 # Generate patron attributes if extended.
168 my $patron_attributes = $self->generate_patron_attributes($extended, $borrower{patron_attributes}, \@feedback);
169 if( $extended ) { delete $borrower{patron_attributes}; } # Not really a field in borrowers.
171 # Default date enrolled and date expiry if not already set.
172 $borrower{dateenrolled} = $self->today_iso() unless $borrower{dateenrolled};
173 $borrower{dateexpiry} = Koha::Patron::Categories->find( $borrower{categorycode} )->get_expiry_date( $borrower{dateenrolled} ) unless $borrower{dateexpiry};
176 my ( $member, $patron );
177 if ( defined($matchpoint) && ( $matchpoint eq 'cardnumber' ) && ( $borrower{'cardnumber'} ) ) {
178 $patron = Koha::Patrons->find( { cardnumber => $borrower{'cardnumber'} } );
180 elsif ( defined($matchpoint) && ($matchpoint eq 'userid') && ($borrower{'userid'}) ) {
181 $patron = Koha::Patrons->find( { userid => $borrower{userid} } );
184 if ( defined($matchpoint_attr_type) ) {
185 foreach my $attr (@$patron_attributes) {
186 if ( $attr->{code} eq $matchpoint and $attr->{attribute} ne '' ) {
187 my @borrowernumbers = Koha::Patron::Attributes->search(
189 code => $matchpoint_attr_type->code,
190 attribute => $attr->{attribute}
192 )->get_column('borrowernumber');
194 $borrowernumber = $borrowernumbers[0] if scalar(@borrowernumbers) == 1;
195 $patron = Koha::Patrons->find( $borrowernumber );
204 $member = $patron->unblessed;
205 $borrowernumber = $member->{'borrowernumber'};
211 if ( C4::Members::checkcardnumber( $borrower{cardnumber}, $borrowernumber ) ) {
214 invalid_cardnumber => 1,
215 borrowernumber => $borrowernumber,
216 cardnumber => $borrower{cardnumber}
223 # Check if the userid provided does not exist yet
224 if ( defined($matchpoint)
225 and $matchpoint ne 'userid'
226 and exists $borrower{userid}
227 and $borrower{userid}
228 and not ( $borrowernumber ? $patron->userid( $borrower{userid} )->has_valid_userid : Koha::Patron->new( { userid => $borrower{userid} } )->has_valid_userid )
230 push @errors, { duplicate_userid => 1, userid => $borrower{userid} };
235 my $guarantor_relationship = $borrower{guarantor_relationship};
236 delete $borrower{guarantor_relationship};
237 my $guarantor_id = $borrower{guarantor_id};
238 delete $borrower{guarantor_id};
240 # Remove warning for int datatype that cannot be null
241 # Argument "" isn't numeric in numeric eq (==) at /usr/share/perl5/DBIx/Class/Row.pm line 1018
243 qw( privacy privacy_guarantor_fines privacy_guarantor_checkouts anonymized login_attempts ))
245 delete $borrower{$field}
246 if exists $borrower{$field} and $borrower{$field} eq "";
250 if ($borrowernumber) {
253 unless ($overwrite_cardnumber) {
259 value => $borrower{'surname'} . ' / ' . $borrowernumber
264 $borrower{'borrowernumber'} = $borrowernumber;
266 if ( $preserve_fields ) {
267 for my $field ( @$preserve_fields ) {
268 $borrower{$field} = $patron->$field;
272 for my $col ( keys %borrower ) {
274 # use values from extant patron unless our csv file includes this column or we provided a default.
275 # FIXME : You cannot update a field with a perl-evaluated false value using the defaults.
277 # The password is always encrypted, skip it unless we are forcing overwrite!
278 next if $col eq 'password' && !$overwrite_passwords;
280 unless ( exists( $csvkeycol{$col} ) || $defaults->{$col} ) {
281 $borrower{$col} = $member->{$col} if ( $member->{$col} );
286 $schema->storage->txn_do(sub {
287 $patron->set(\%borrower)->store;
288 # Don't add a new restriction if the existing 'combined' restriction matches this one
289 if ( $borrower{debarred} && ( ( $borrower{debarred} ne $member->{debarred} ) || ( $borrower{debarredcomment} ne $member->{debarredcomment} ) ) ) {
291 # Check to see if this debarment already exists
292 my $debarrments = GetDebarments(
294 borrowernumber => $borrowernumber,
295 expiration => $borrower{debarred},
296 comment => $borrower{debarredcomment}
300 # If it doesn't, then add it!
301 unless (@$debarrments) {
304 borrowernumber => $borrowernumber,
305 expiration => $borrower{debarred},
306 comment => $borrower{debarredcomment}
311 if ($patron->category->category_type ne 'S' && $overwrite_passwords && defined $borrower{password} && $borrower{password} ne ''){
313 $patron->set_password({ password => $borrower{password} });
316 if ( $_->isa('Koha::Exceptions::Password::TooShort') ) {
317 push @errors, { passwd_too_short => 1, borrowernumber => $borrowernumber, length => $_->{length}, min_length => $_->{min_length} };
319 elsif ( $_->isa('Koha::Exceptions::Password::WhitespaceCharacters') ) {
320 push @errors, { passwd_whitespace => 1, borrowernumber => $borrowernumber } ;
322 elsif ( $_->isa('Koha::Exceptions::Password::TooWeak') ) {
323 push @errors, { passwd_too_weak => 1, borrowernumber => $borrowernumber } ;
325 elsif ( $_->isa('Koha::Exceptions::Password::Plugin') ) {
326 push @errors, { passwd_plugin_err => 1, borrowernumber => $borrowernumber } ;
329 push @errors, { passwd_unknown_err => 1, borrowernumber => $borrowernumber } ;
335 $patron_attributes = $patron->extended_attributes->merge_and_replace_with( $patron_attributes );
337 # We do not want to filter by branch, maybe we should?
338 Koha::Patrons->find($borrowernumber)->extended_attributes->delete;
339 $patron->extended_attributes($patron_attributes);
346 name => 'lastoverwritten',
347 value => $borrower{'surname'} . ' / ' . $borrowernumber
355 my $patron_id = defined $matchpoint ? $borrower{$matchpoint} : $matchpoint_attr_type;
356 if ( $_->isa('Koha::Exceptions::Patron::Attribute::UniqueIDConstraint') ) {
357 push @errors, { patron_attribute_unique_id_constraint => 1, borrowernumber => $borrowernumber, attribute => $_->attribute };
358 } elsif ( $_->isa('Koha::Exceptions::Patron::Attribute::InvalidType') ) {
359 push @errors, { patron_attribute_invalid_type => 1, borrowernumber => $borrowernumber, attribute_type_code => $_->type };
360 } elsif ( $_->isa('Koha::Exceptions::Patron::Attribute::NonRepeatable') ) {
361 push @errors, { patron_attribute_non_repeatable => 1, borrowernumber => $borrowernumber, attribute => $_->attribute };
364 push @errors, { unknown_error => 1 };
370 # TODO We can raise a better error
371 name => 'lastinvalid',
372 value => $borrower{'surname'} . ' / ' . $borrowernumber
379 $schema->storage->txn_do(sub {
380 $patron = Koha::Patron->new(\%borrower)->store;
381 $borrowernumber = $patron->id;
383 if ( $patron->is_debarred ) {
386 borrowernumber => $patron->borrowernumber,
387 expiration => $patron->debarred,
388 comment => $patron->debarredcomment,
394 # FIXME Hum, we did not filter earlier and now we do?
395 $patron->extended_attributes->filter_by_branch_limitations->delete;
396 $patron->extended_attributes($patron_attributes);
399 if ($set_messaging_prefs) {
400 C4::Members::Messaging::SetMessagingPreferencesFromDefaults(
402 borrowernumber => $patron->borrowernumber,
403 categorycode => $patron->categorycode,
409 push @imported_borrowers, $patron->borrowernumber; #for patronlist
414 name => 'lastimported',
415 value => $patron->surname . ' / ' . $patron->borrowernumber,
422 my $patron_id = defined $matchpoint ? $borrower{$matchpoint} : $matchpoint_attr_type;
423 if ( $_->isa('Koha::Exceptions::Patron::Attribute::UniqueIDConstraint') ) {
424 push @errors, { patron_attribute_unique_id_constraint => 1, patron_id => $patron_id, attribute => $_->attribute };
425 } elsif ( $_->isa('Koha::Exceptions::Patron::Attribute::InvalidType') ) {
426 push @errors, { patron_attribute_invalid_type => 1, patron_id => $patron_id, attribute_type_code => $_->type };
427 } elsif ( $_->isa('Koha::Exceptions::Patron::Attribute::NonRepeatable') ) {
428 push @errors, { patron_attribute_non_repeatable => 1, patron_id => $patron_id, attribute => $_->attribute };
432 push @errors, { unknown_error => 1 };
437 name => 'lastinvalid',
438 value => $borrower{'surname'} . ' / Create patron',
444 next LINE unless $success;
446 # Send WELCOME welcome email is the user is new and we're set to send mail
447 if ($send_welcome && $is_new) {
448 my $emailaddr = $patron->notice_email_address;
450 # if we manage to find a valid email address, send notice
453 my $letter = GetPreparedLetter(
455 letter_code => 'WELCOME',
456 branchcode => $patron->branchcode,,
457 lang => $patron->lang || 'default',
459 'branches' => $patron->branchcode,
460 'borrowers' => $patron->borrowernumber,
465 my $message_id = EnqueueLetter(
468 borrowernumber => $patron->id,
469 to_address => $emailaddr,
470 message_transport_type => 'email'
475 push @errors, { welcome_email_err => 1, borrowernumber => $borrowernumber };
481 name => 'welcome_sent',
482 value => $borrower{'surname'} . ' / ' . $borrowernumber . ' / ' . $emailaddr
489 # Add a guarantor if we are given a relationship
490 if ( $guarantor_id ) {
491 my $relationship = Koha::Patron::Relationships->find(
493 guarantee_id => $borrowernumber,
494 guarantor_id => $guarantor_id,
498 if ( $relationship ) {
499 $relationship->relationship( $guarantor_relationship );
500 $relationship->store();
503 Koha::Patron::Relationship->new(
505 guarantee_id => $borrowernumber,
506 relationship => $guarantor_relationship,
507 guarantor_id => $guarantor_id,
514 $schema->storage->txn_rollback if $dry_run;
517 feedback => \@feedback,
519 imported => $imported,
520 overwritten => $overwritten,
521 already_in_db => $alreadyindb,
523 imported_borrowers => \@imported_borrowers,
527 =head2 prepare_columns
529 my @csvcolumns = $self->prepare_columns({headerrow => $borrowerline, keycol => \%csvkeycol, errors => \@errors, });
531 Returns an array of all column key and populates a hash of colunm key positions.
535 sub prepare_columns {
536 my ($self, $params) = @_;
538 my $status = $self->text_csv->parse($params->{headerrow});
540 push( @{$params->{errors}}, { badheader => 1, line => 1, lineraw => $params->{headerrow} });
544 my @csvcolumns = $self->text_csv->fields();
546 foreach my $keycol (@csvcolumns) {
547 # columnkeys don't contain whitespace, but some stupid tools add it
549 $keycol =~ s/^\N{BOM}//; # Strip BOM if exists, otherwise it will be part of first column key
550 $params->{keycol}->{$keycol} = $col++;
556 =head2 set_attribute_types
558 my $matchpoint_attr_type = $self->set_attribute_types({ extended => $extended, matchpoint => $matchpoint, });
560 Returns an attribute type based on matchpoint parameter.
564 sub set_attribute_types {
565 my ($self, $params) = @_;
568 if( $params->{extended} ) {
569 $attribute_type = Koha::Patron::Attribute::Types->find($params->{matchpoint});
572 return $attribute_type;
575 =head2 set_column_keys
577 my @columnkeys = set_column_keys($extended);
579 Returns an array of borrowers' table columns.
583 sub set_column_keys {
584 my ($self, $extended) = @_;
586 my @columnkeys = map { $_ ne 'borrowernumber' ? $_ : () } Koha::Patrons->columns();
587 push( @columnkeys, 'patron_attributes' ) if $extended;
588 push( @columnkeys, qw( guarantor_relationship guarantor_id ) );
593 =head2 generate_patron_attributes
595 my $patron_attributes = generate_patron_attributes($extended, $borrower{patron_attributes}, $feedback);
597 Returns a Koha::Patron::Attributes as expected by Koha::Patron->extended_attributes
601 sub generate_patron_attributes {
602 my ($self, $extended, $string, $feedback) = @_;
604 unless( $extended ) { return; }
605 unless( defined $string ) { return; }
607 # Fixup double quotes in case we are passed smart quotes
608 $string =~ s/\xe2\x80\x9c/"/g;
609 $string =~ s/\xe2\x80\x9d/"/g;
611 push (@$feedback, { feedback => 1, name => 'attribute string', value => $string });
612 return [] unless $string; # Unit tests want the feedback, is it really needed?
614 my $csv = Text::CSV->new({binary => 1}); # binary needed for non-ASCII Unicode
615 my $ok = $csv->parse($string); # parse field again to get subfields!
616 my @list = $csv->fields();
617 my @patron_attributes =
618 sort { $a->{code} cmp $b->{code} || $a->{attribute} cmp $b->{attribute} }
620 my @arr = split /:/, $_, 2;
621 { code => $arr[0], attribute => $arr[1] }
623 return \@patron_attributes;
624 # TODO: error handling (check $ok)
627 =head2 check_branch_code
629 check_branch_code($borrower{branchcode}, $borrowerline, $line_number, \@missing_criticals);
631 Pushes a 'missing_criticals' error entry if no branch code or branch code does not map to a branch name.
635 sub check_branch_code {
636 my ($self, $branchcode, $borrowerline, $line_number, $missing_criticals) = @_;
639 unless( $branchcode ) {
640 push (@$missing_criticals, { key => 'branchcode', line => $line_number, lineraw => decode_utf8($borrowerline), });
644 # look for branch code
645 my $library = Koha::Libraries->find( $branchcode );
647 push (@$missing_criticals, { key => 'branchcode', line => $line_number, lineraw => decode_utf8($borrowerline),
648 value => $branchcode, branch_map => 1, });
652 =head2 check_borrower_category
654 check_borrower_category($borrower{categorycode}, $borrowerline, $line_number, \@missing_criticals);
656 Pushes a 'missing_criticals' error entry if no category code or category code does not map to a known category.
660 sub check_borrower_category {
661 my ($self, $categorycode, $borrowerline, $line_number, $missing_criticals) = @_;
664 unless( $categorycode ) {
665 push (@$missing_criticals, { key => 'categorycode', line => $line_number, lineraw => decode_utf8($borrowerline), });
669 # Looking for borrower category
670 my $category = Koha::Patron::Categories->find($categorycode);
671 unless( $category ) {
672 push (@$missing_criticals, { key => 'categorycode', line => $line_number, lineraw => decode_utf8($borrowerline),
673 value => $categorycode, category_map => 1, });
679 format_dates({borrower => \%borrower, lineraw => $lineraw, line => $line_number, missing_criticals => \@missing_criticals, });
681 Pushes a 'missing_criticals' error entry for each of the 3 date types dateofbirth, dateenrolled and dateexpiry if it can not
682 be formatted to the chosen date format. Populates the correctly formatted date otherwise.
687 my ($self, $params) = @_;
689 foreach my $date_type (qw(dateofbirth dateenrolled dateexpiry date_renewed)) {
690 my $tempdate = $params->{borrower}->{$date_type} or next();
691 my $formatted_date = eval { output_pref( { dt => dt_from_string( $tempdate ), dateonly => 1, dateformat => 'iso' } ); };
693 if ($formatted_date) {
694 $params->{borrower}->{$date_type} = $formatted_date;
696 $params->{borrower}->{$date_type} = '';
697 push (@{$params->{missing_criticals}}, { key => $date_type, line => $params->{line}, lineraw => decode_utf8($params->{lineraw}), bad_date => 1 });