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 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
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.
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.
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 if ($borrowernumber) {
228 unless ($overwrite_cardnumber) {
234 value => $borrower{'surname'} . ' / ' . $borrowernumber
239 $borrower{'borrowernumber'} = $borrowernumber;
240 for my $col ( keys %borrower ) {
242 # use values from extant patron unless our csv file includes this column or we provided a default.
243 # FIXME : You cannot update a field with a perl-evaluated false value using the defaults.
245 # The password is always encrypted, skip it!
246 next if $col eq 'password';
248 unless ( exists( $csvkeycol{$col} ) || $defaults->{$col} ) {
249 $borrower{$col} = $member->{$col} if ( $member->{$col} );
253 my $patron = Koha::Patrons->find( $borrowernumber );
254 eval { $patron->set(\%borrower)->store };
261 # TODO We can raise a better error
262 name => 'lastinvalid',
263 value => $borrower{'surname'} . ' / ' . $borrowernumber
268 # Don't add a new restriction if the existing 'combined' restriction matches this one
269 if ( $borrower{debarred} && ( ( $borrower{debarred} ne $member->{debarred} ) || ( $borrower{debarredcomment} ne $member->{debarredcomment} ) ) ) {
271 # Check to see if this debarment already exists
272 my $debarrments = GetDebarments(
274 borrowernumber => $borrowernumber,
275 expiration => $borrower{debarred},
276 comment => $borrower{debarredcomment}
280 # If it doesn't, then add it!
281 unless (@$debarrments) {
284 borrowernumber => $borrowernumber,
285 expiration => $borrower{debarred},
286 comment => $borrower{debarredcomment}
293 my $old_attributes = GetBorrowerAttributes($borrowernumber);
294 $patron_attributes = extended_attributes_merge( $old_attributes, $patron_attributes );
296 push @errors, { unknown_error => 1 }
297 unless SetBorrowerAttributes( $borrower{'borrowernumber'}, $patron_attributes, 'no_branch_limit' );
304 name => 'lastoverwritten',
305 value => $borrower{'surname'} . ' / ' . $borrowernumber
311 Koha::Patron->new(\%borrower)->store;
315 if ( $patron->is_debarred ) {
318 borrowernumber => $patron->borrowernumber,
319 expiration => $patron->debarred,
320 comment => $patron->debarredcomment,
326 SetBorrowerAttributes( $patron->borrowernumber, $patron_attributes );
329 if ($set_messaging_prefs) {
330 C4::Members::Messaging::SetMessagingPreferencesFromDefaults(
332 borrowernumber => $patron->borrowernumber,
333 categorycode => $patron->categorycode,
339 push @imported_borrowers, $patron->borrowernumber; #for patronlist
344 name => 'lastimported',
345 value => $patron->surname . ' / ' . $patron->borrowernumber,
351 push @errors, { unknown_error => 1 };
355 name => 'lastinvalid',
356 value => $borrower{'surname'} . ' / Create patron',
362 # Add a guarantor if we are given a relationship
363 if ( $guarantor_id ) {
364 Koha::Patron::Relationship->new(
366 guarantee_id => $borrowernumber,
367 relationship => $relationship,
368 guarantor_id => $guarantor_id,
375 feedback => \@feedback,
377 imported => $imported,
378 overwritten => $overwritten,
379 already_in_db => $alreadyindb,
381 imported_borrowers => \@imported_borrowers,
385 =head2 prepare_columns
387 my @csvcolumns = $self->prepare_columns({headerrow => $borrowerline, keycol => \%csvkeycol, errors => \@errors, });
389 Returns an array of all column key and populates a hash of colunm key positions.
393 sub prepare_columns {
394 my ($self, $params) = @_;
396 my $status = $self->text_csv->parse($params->{headerrow});
398 push( @{$params->{errors}}, { badheader => 1, line => 1, lineraw => $params->{headerrow} });
402 my @csvcolumns = $self->text_csv->fields();
404 foreach my $keycol (@csvcolumns) {
405 # columnkeys don't contain whitespace, but some stupid tools add it
407 $keycol =~ s/^\N{BOM}//; # Strip BOM if exists, otherwise it will be part of first column key
408 $params->{keycol}->{$keycol} = $col++;
414 =head2 set_attribute_types
416 my $matchpoint_attr_type = $self->set_attribute_types({ extended => $extended, matchpoint => $matchpoint, });
418 Returns an attribute type based on matchpoint parameter.
422 sub set_attribute_types {
423 my ($self, $params) = @_;
426 if( $params->{extended} ) {
427 $attribute_types = C4::Members::AttributeTypes->fetch($params->{matchpoint});
430 return $attribute_types;
433 =head2 set_column_keys
435 my @columnkeys = set_column_keys($extended);
437 Returns an array of borrowers' table columns.
441 sub set_column_keys {
442 my ($self, $extended) = @_;
444 my @columnkeys = map { $_ ne 'borrowernumber' ? $_ : () } Koha::Patrons->columns();
445 push( @columnkeys, 'patron_attributes' ) if $extended;
450 =head2 set_patron_attributes
452 my $patron_attributes = set_patron_attributes($extended, $borrower{patron_attributes}, $feedback);
454 Returns a reference to array of hashrefs data structure as expected by SetBorrowerAttributes.
458 sub set_patron_attributes {
459 my ($self, $extended, $patron_attributes, $feedback) = @_;
461 unless( $extended ) { return; }
462 unless( defined($patron_attributes) ) { return; }
464 # Fixup double quotes in case we are passed smart quotes
465 $patron_attributes =~ s/\xe2\x80\x9c/"/g;
466 $patron_attributes =~ s/\xe2\x80\x9d/"/g;
468 push (@$feedback, { feedback => 1, name => 'attribute string', value => $patron_attributes });
470 my $result = extended_attributes_code_value_arrayref($patron_attributes);
475 =head2 check_branch_code
477 check_branch_code($borrower{branchcode}, $borrowerline, $line_number, \@missing_criticals);
479 Pushes a 'missing_criticals' error entry if no branch code or branch code does not map to a branch name.
483 sub check_branch_code {
484 my ($self, $branchcode, $borrowerline, $line_number, $missing_criticals) = @_;
487 unless( $branchcode ) {
488 push (@$missing_criticals, { key => 'branchcode', line => $line_number, lineraw => decode_utf8($borrowerline), });
492 # look for branch code
493 my $library = Koha::Libraries->find( $branchcode );
495 push (@$missing_criticals, { key => 'branchcode', line => $line_number, lineraw => decode_utf8($borrowerline),
496 value => $branchcode, branch_map => 1, });
500 =head2 check_borrower_category
502 check_borrower_category($borrower{categorycode}, $borrowerline, $line_number, \@missing_criticals);
504 Pushes a 'missing_criticals' error entry if no category code or category code does not map to a known category.
508 sub check_borrower_category {
509 my ($self, $categorycode, $borrowerline, $line_number, $missing_criticals) = @_;
512 unless( $categorycode ) {
513 push (@$missing_criticals, { key => 'categorycode', line => $line_number, lineraw => decode_utf8($borrowerline), });
517 # Looking for borrower category
518 my $category = Koha::Patron::Categories->find($categorycode);
519 unless( $category ) {
520 push (@$missing_criticals, { key => 'categorycode', line => $line_number, lineraw => decode_utf8($borrowerline),
521 value => $categorycode, category_map => 1, });
527 format_dates({borrower => \%borrower, lineraw => $lineraw, line => $line_number, missing_criticals => \@missing_criticals, });
529 Pushes a 'missing_criticals' error entry for each of the 3 date types dateofbirth, dateenrolled and dateexpiry if it can not
530 be formatted to the chosen date format. Populates the correctly formatted date otherwise.
535 my ($self, $params) = @_;
537 foreach my $date_type (qw(dateofbirth dateenrolled dateexpiry date_renewed)) {
538 my $tempdate = $params->{borrower}->{$date_type} or next();
539 my $formatted_date = eval { output_pref( { dt => dt_from_string( $tempdate ), dateonly => 1, dateformat => 'iso' } ); };
541 if ($formatted_date) {
542 $params->{borrower}->{$date_type} = $formatted_date;
544 $params->{borrower}->{$date_type} = '';
545 push (@{$params->{missing_criticals}}, { key => $date_type, line => $params->{line}, lineraw => decode_utf8($params->{lineraw}), bad_date => 1 });