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>.
24 use Encode qw( decode_utf8 );
27 use C4::Members::Attributes qw(:all);
28 use C4::Members::AttributeTypes;
32 use Koha::Patron::Categories;
33 use Koha::Patron::Debarments;
38 Koha::Patrons::Import - Perl Module containing import_patrons method exported from import_borrowers script.
42 use Koha::Patrons::Import;
46 This module contains one method for importing patrons in bulk.
52 my $return = Koha::Patrons::Import::import_patrons($params);
54 Applies various checks and imports patrons in bulk from a csv file.
56 Further pod documentation needed here.
60 has 'today_iso' => ( is => 'ro', lazy => 1,
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 $ext_preserve = $params->{preserve_extended_attributes};
75 my $overwrite_cardnumber = $params->{overwrite_cardnumber};
76 my $extended = C4::Context->preference('ExtendedPatronAttributes');
77 my $set_messaging_prefs = C4::Context->preference('EnhancedMessagingPreferences');
79 my @columnkeys = $self->set_column_keys($extended);
87 my @imported_borrowers;
88 my $matchpoint_attr_type = $self->set_attribute_types({ extended => $extended, matchpoint => $matchpoint, });
90 # Use header line to construct key to column map
92 my $borrowerline = <$handle>;
93 my @csvcolumns = $self->prepare_columns({headerrow => $borrowerline, keycol => \%csvkeycol, errors => \@errors, });
94 push(@feedback, { feedback => 1, name => 'headerrow', value => join( ', ', @csvcolumns ) });
96 my @criticals = qw( surname ); # there probably should be others - rm branchcode && categorycode
97 LINE: while ( my $borrowerline = <$handle> ) {
100 my @missing_criticals;
102 my $status = $self->text_csv->parse($borrowerline);
103 my @columns = $self->text_csv->fields();
105 push @missing_criticals, { badparse => 1, line => $line_number, lineraw => decode_utf8($borrowerline) };
107 elsif ( @columns == @columnkeys ) {
108 @borrower{@columnkeys} = @columns;
110 # MJR: try to fill blanks gracefully by using default values
111 foreach my $key (@columnkeys) {
112 if ( $borrower{$key} !~ /\S/ ) {
113 $borrower{$key} = $defaults->{$key};
118 # MJR: try to recover gracefully by using default values
119 foreach my $key (@columnkeys) {
120 if ( defined( $csvkeycol{$key} ) and $columns[ $csvkeycol{$key} ] =~ /\S/ ) {
121 $borrower{$key} = $columns[ $csvkeycol{$key} ];
123 elsif ( $defaults->{$key} ) {
124 $borrower{$key} = $defaults->{$key};
126 elsif ( scalar grep { $key eq $_ } @criticals ) {
128 # a critical field is undefined
129 push @missing_criticals, { key => $key, line => $., lineraw => decode_utf8($borrowerline) };
132 $borrower{$key} = '';
137 $borrower{cardnumber} = undef if $borrower{cardnumber} eq "";
139 # Check if borrower category code exists and if it matches to a known category. Pushing error to missing_criticals otherwise.
140 $self->check_borrower_category($borrower{categorycode}, $borrowerline, $line_number, \@missing_criticals);
142 # Check if branch code exists and if it matches to a branch name. Pushing error to missing_criticals otherwise.
143 $self->check_branch_code($borrower{branchcode}, $borrowerline, $line_number, \@missing_criticals);
145 # Popular spreadsheet applications make it difficult to force date outputs to be zero-padded, but we require it.
146 $self->format_dates({borrower => \%borrower, lineraw => $borrowerline, line => $line_number, missing_criticals => \@missing_criticals, });
148 if (@missing_criticals) {
149 foreach (@missing_criticals) {
150 $_->{borrowernumber} = $borrower{borrowernumber} || 'UNDEF';
151 $_->{surname} = $borrower{surname} || 'UNDEF';
154 ( 25 > scalar @errors ) and push @errors, { missing_criticals => \@missing_criticals };
156 # The first 25 errors are enough. Keeping track of 30,000+ would destroy performance.
160 # Set patron attributes if extended.
161 my $patron_attributes = $self->set_patron_attributes($extended, $borrower{patron_attributes}, \@feedback);
162 if( $extended ) { delete $borrower{patron_attributes}; } # Not really a field in borrowers.
164 # Default date enrolled and date expiry if not already set.
165 $borrower{dateenrolled} = $self->today_iso() unless $borrower{dateenrolled};
166 $borrower{dateexpiry} = Koha::Patron::Categories->find( $borrower{categorycode} )->get_expiry_date( $borrower{dateenrolled} ) unless $borrower{dateexpiry};
169 my ( $member, $patron );
170 if ( defined($matchpoint) && ( $matchpoint eq 'cardnumber' ) && ( $borrower{'cardnumber'} ) ) {
171 $patron = Koha::Patrons->find( { cardnumber => $borrower{'cardnumber'} } );
173 elsif ( defined($matchpoint) && ($matchpoint eq 'userid') && ($borrower{'userid'}) ) {
174 $patron = Koha::Patrons->find( { userid => $borrower{userid} } );
177 if ( defined($matchpoint_attr_type) ) {
178 foreach my $attr (@$patron_attributes) {
179 if ( $attr->{code} eq $matchpoint and $attr->{value} ne '' ) {
180 my @borrowernumbers = $matchpoint_attr_type->get_patrons( $attr->{value} );
181 $borrowernumber = $borrowernumbers[0] if scalar(@borrowernumbers) == 1;
182 $patron = Koha::Patrons->find( $borrowernumber );
190 $member = $patron->unblessed;
191 $borrowernumber = $member->{'borrowernumber'};
196 if ( C4::Members::checkcardnumber( $borrower{cardnumber}, $borrowernumber ) ) {
199 invalid_cardnumber => 1,
200 borrowernumber => $borrowernumber,
201 cardnumber => $borrower{cardnumber}
208 # Check if the userid provided does not exist yet
209 if ( defined($matchpoint)
210 and $matchpoint ne 'userid'
211 and exists $borrower{userid}
212 and $borrower{userid}
213 and not ( $borrowernumber ? $patron->userid( $borrower{userid} )->has_valid_userid : Koha::Patron->new( { userid => $borrower{userid} } )->has_valid_userid )
215 push @errors, { duplicate_userid => 1, userid => $borrower{userid} };
220 my $relationship = $borrower{relationship};
221 my $guarantor_id = $borrower{guarantor_id};
222 delete $borrower{relationship};
223 delete $borrower{guarantor_id};
225 # Remove warning for int datatype that cannot be null
226 # Argument "" isn't numeric in numeric eq (==) at /usr/share/perl5/DBIx/Class/Row.pm line 1018
228 qw( privacy privacy_guarantor_fines privacy_guarantor_checkouts anonymized ))
230 delete $borrower{$field}
231 if exists $borrower{$field} and $borrower{$field} eq "";
234 if ($borrowernumber) {
237 unless ($overwrite_cardnumber) {
243 value => $borrower{'surname'} . ' / ' . $borrowernumber
248 $borrower{'borrowernumber'} = $borrowernumber;
249 for my $col ( keys %borrower ) {
251 # use values from extant patron unless our csv file includes this column or we provided a default.
252 # FIXME : You cannot update a field with a perl-evaluated false value using the defaults.
254 # The password is always encrypted, skip it!
255 next if $col eq 'password';
257 unless ( exists( $csvkeycol{$col} ) || $defaults->{$col} ) {
258 $borrower{$col} = $member->{$col} if ( $member->{$col} );
262 my $patron = Koha::Patrons->find( $borrowernumber );
263 eval { $patron->set(\%borrower)->store };
270 # TODO We can raise a better error
271 name => 'lastinvalid',
272 value => $borrower{'surname'} . ' / ' . $borrowernumber
277 # Don't add a new restriction if the existing 'combined' restriction matches this one
278 if ( $borrower{debarred} && ( ( $borrower{debarred} ne $member->{debarred} ) || ( $borrower{debarredcomment} ne $member->{debarredcomment} ) ) ) {
280 # Check to see if this debarment already exists
281 my $debarrments = GetDebarments(
283 borrowernumber => $borrowernumber,
284 expiration => $borrower{debarred},
285 comment => $borrower{debarredcomment}
289 # If it doesn't, then add it!
290 unless (@$debarrments) {
293 borrowernumber => $borrowernumber,
294 expiration => $borrower{debarred},
295 comment => $borrower{debarredcomment}
302 my $old_attributes = $patron->get_extended_attributes->as_list;
303 $patron_attributes = extended_attributes_merge( $old_attributes, $patron_attributes );
305 push @errors, { unknown_error => 1 }
306 unless SetBorrowerAttributes( $borrower{'borrowernumber'}, $patron_attributes, 'no_branch_limit' );
313 name => 'lastoverwritten',
314 value => $borrower{'surname'} . ' / ' . $borrowernumber
320 Koha::Patron->new(\%borrower)->store;
324 if ( $patron->is_debarred ) {
327 borrowernumber => $patron->borrowernumber,
328 expiration => $patron->debarred,
329 comment => $patron->debarredcomment,
335 SetBorrowerAttributes( $patron->borrowernumber, $patron_attributes );
338 if ($set_messaging_prefs) {
339 C4::Members::Messaging::SetMessagingPreferencesFromDefaults(
341 borrowernumber => $patron->borrowernumber,
342 categorycode => $patron->categorycode,
348 push @imported_borrowers, $patron->borrowernumber; #for patronlist
353 name => 'lastimported',
354 value => $patron->surname . ' / ' . $patron->borrowernumber,
360 push @errors, { unknown_error => 1 };
364 name => 'lastinvalid',
365 value => $borrower{'surname'} . ' / Create patron',
371 # Add a guarantor if we are given a relationship
372 if ( $guarantor_id ) {
373 Koha::Patron::Relationship->new(
375 guarantee_id => $borrowernumber,
376 relationship => $relationship,
377 guarantor_id => $guarantor_id,
384 feedback => \@feedback,
386 imported => $imported,
387 overwritten => $overwritten,
388 already_in_db => $alreadyindb,
390 imported_borrowers => \@imported_borrowers,
394 =head2 prepare_columns
396 my @csvcolumns = $self->prepare_columns({headerrow => $borrowerline, keycol => \%csvkeycol, errors => \@errors, });
398 Returns an array of all column key and populates a hash of colunm key positions.
402 sub prepare_columns {
403 my ($self, $params) = @_;
405 my $status = $self->text_csv->parse($params->{headerrow});
407 push( @{$params->{errors}}, { badheader => 1, line => 1, lineraw => $params->{headerrow} });
411 my @csvcolumns = $self->text_csv->fields();
413 foreach my $keycol (@csvcolumns) {
414 # columnkeys don't contain whitespace, but some stupid tools add it
416 $keycol =~ s/^\N{BOM}//; # Strip BOM if exists, otherwise it will be part of first column key
417 $params->{keycol}->{$keycol} = $col++;
423 =head2 set_attribute_types
425 my $matchpoint_attr_type = $self->set_attribute_types({ extended => $extended, matchpoint => $matchpoint, });
427 Returns an attribute type based on matchpoint parameter.
431 sub set_attribute_types {
432 my ($self, $params) = @_;
435 if( $params->{extended} ) {
436 $attribute_types = C4::Members::AttributeTypes->fetch($params->{matchpoint});
439 return $attribute_types;
442 =head2 set_column_keys
444 my @columnkeys = set_column_keys($extended);
446 Returns an array of borrowers' table columns.
450 sub set_column_keys {
451 my ($self, $extended) = @_;
453 my @columnkeys = map { $_ ne 'borrowernumber' ? $_ : () } Koha::Patrons->columns();
454 push( @columnkeys, 'patron_attributes' ) if $extended;
459 =head2 set_patron_attributes
461 my $patron_attributes = set_patron_attributes($extended, $borrower{patron_attributes}, $feedback);
463 Returns a reference to array of hashrefs data structure as expected by SetBorrowerAttributes.
467 sub set_patron_attributes {
468 my ($self, $extended, $patron_attributes, $feedback) = @_;
470 unless( $extended ) { return; }
471 unless( defined($patron_attributes) ) { return; }
473 # Fixup double quotes in case we are passed smart quotes
474 $patron_attributes =~ s/\xe2\x80\x9c/"/g;
475 $patron_attributes =~ s/\xe2\x80\x9d/"/g;
477 push (@$feedback, { feedback => 1, name => 'attribute string', value => $patron_attributes });
479 my $result = extended_attributes_code_value_arrayref($patron_attributes);
484 =head2 check_branch_code
486 check_branch_code($borrower{branchcode}, $borrowerline, $line_number, \@missing_criticals);
488 Pushes a 'missing_criticals' error entry if no branch code or branch code does not map to a branch name.
492 sub check_branch_code {
493 my ($self, $branchcode, $borrowerline, $line_number, $missing_criticals) = @_;
496 unless( $branchcode ) {
497 push (@$missing_criticals, { key => 'branchcode', line => $line_number, lineraw => decode_utf8($borrowerline), });
501 # look for branch code
502 my $library = Koha::Libraries->find( $branchcode );
504 push (@$missing_criticals, { key => 'branchcode', line => $line_number, lineraw => decode_utf8($borrowerline),
505 value => $branchcode, branch_map => 1, });
509 =head2 check_borrower_category
511 check_borrower_category($borrower{categorycode}, $borrowerline, $line_number, \@missing_criticals);
513 Pushes a 'missing_criticals' error entry if no category code or category code does not map to a known category.
517 sub check_borrower_category {
518 my ($self, $categorycode, $borrowerline, $line_number, $missing_criticals) = @_;
521 unless( $categorycode ) {
522 push (@$missing_criticals, { key => 'categorycode', line => $line_number, lineraw => decode_utf8($borrowerline), });
526 # Looking for borrower category
527 my $category = Koha::Patron::Categories->find($categorycode);
528 unless( $category ) {
529 push (@$missing_criticals, { key => 'categorycode', line => $line_number, lineraw => decode_utf8($borrowerline),
530 value => $categorycode, category_map => 1, });
536 format_dates({borrower => \%borrower, lineraw => $lineraw, line => $line_number, missing_criticals => \@missing_criticals, });
538 Pushes a 'missing_criticals' error entry for each of the 3 date types dateofbirth, dateenrolled and dateexpiry if it can not
539 be formatted to the chosen date format. Populates the correctly formatted date otherwise.
544 my ($self, $params) = @_;
546 foreach my $date_type (qw(dateofbirth dateenrolled dateexpiry date_renewed)) {
547 my $tempdate = $params->{borrower}->{$date_type} or next();
548 my $formatted_date = eval { output_pref( { dt => dt_from_string( $tempdate ), dateonly => 1, dateformat => 'iso' } ); };
550 if ($formatted_date) {
551 $params->{borrower}->{$date_type} = $formatted_date;
553 $params->{borrower}->{$date_type} = '';
554 push (@{$params->{missing_criticals}}, { key => $date_type, line => $params->{line}, lineraw => decode_utf8($params->{lineraw}), bad_date => 1 });