X-Git-Url: http://git.rot13.org/?a=blobdiff_plain;f=tools%2Fimport_borrowers.pl;h=5f65c979a6135c0ec55961a60da4d638e5195bf7;hb=7d0aea7c39e22f42760c3ecbba4c0cd0818785a7;hp=d8c4068bd6a1b6caa85ce710183539d20ada27c7;hpb=49e4e7020d0947ce5f436fe32bbd3342730348c3;p=koha.git diff --git a/tools/import_borrowers.pl b/tools/import_borrowers.pl index d8c4068bd6..5f65c979a6 100755 --- a/tools/import_borrowers.pl +++ b/tools/import_borrowers.pl @@ -1,6 +1,7 @@ #!/usr/bin/perl -# Copyright 2007 Liblime Ltd +# Copyright 2007 Liblime +# Parts copyright 2010 BibLibre # # This file is part of Koha. # @@ -13,18 +14,18 @@ # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR # A PARTICULAR PURPOSE. See the GNU General Public License for more details. # -# You should have received a copy of the GNU General Public License along with -# Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place, -# Suite 330, Boston, MA 02111-1307 USA +# You should have received a copy of the GNU General Public License along +# with Koha; if not, write to the Free Software Foundation, Inc., +# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. # Script to take some borrowers data in a known format and load it into Koha # # File format # # cardnumber,surname,firstname,title,othernames,initials,streetnumber,streettype, -# address line , address line 2, city, zipcode, email, phone, mobile, fax, work email, work phone, +# address line , address line 2, city, zipcode, contry, email, phone, mobile, fax, work email, work phone, # alternate streetnumber, alternate streettype, alternate address line 1, alternate city, -# alternate zipcode, alternate email, alternate phone, date of birth, branchcode, +# alternate zipcode, alternate country, alternate email, alternate phone, date of birth, branchcode, # categorycode, enrollment date, expiry date, noaddress, lost, debarred, contact surname, # contact firstname, contact title, borrower notes, contact relationship, ethnicity, ethnicity notes # gender, username, opac note, contact note, password, sort one, sort two @@ -34,27 +35,38 @@ # branchcode and categorycode need to be valid use strict; +use warnings; + use C4::Auth; use C4::Output; use C4::Dates qw(format_date_in_iso); use C4::Context; +use C4::Branch qw(GetBranchName); use C4::Members; -use C4::Members::Attributes; +use C4::Members::Attributes qw(:all); use C4::Members::AttributeTypes; +use C4::Members::Messaging; use Text::CSV; +# Text::CSV::Unicode, even in binary mode, fails to parse lines with these diacriticals: +# ė +# č + use CGI; +# use encoding 'utf8'; # don't do this -my @errors; +my (@errors, @feedback); my $extended = C4::Context->preference('ExtendedPatronAttributes'); -my @columnkeys = C4::Members->columns; +my $set_messaging_prefs = C4::Context->preference('EnhancedMessagingPreferences'); +my @columnkeys = C4::Members::columns(); if ($extended) { push @columnkeys, 'patron_attributes'; } -my $columnkeystpl = [ map { {'key' => $_} } @columnkeys ]; # ref. to array of hashrefs. +my $columnkeystpl = [ map { {'key' => $_} } grep {$_ ne 'borrowernumber' } @columnkeys ]; # ref. to array of hashrefs. my $input = CGI->new(); -my $csv = Text::CSV->new(); +our $csv = Text::CSV->new({binary => 1}); # binary needed for non-ASCII Unicode +#push @feedback, {feedback=>1, name=>'backend', value=>$csv->backend, backend=>$csv->backend}; #XXX my ( $template, $loggedinuser, $cookie ) = get_template_and_user({ template_name => "tools/import_borrowers.tmpl", @@ -76,8 +88,8 @@ if ($input->param('sample')) { print $csv->string, "\n"; exit 1; } -my $uploadborrowers = $input->param('uploadborrowers'); -my $matchpoint = $input->param('matchpoint'); +my $uploadborrowers = $input->param('uploadborrowers'); +my $matchpoint = $input->param('matchpoint'); if ($matchpoint) { $matchpoint =~ s/^patron_attribute_//; } @@ -88,6 +100,12 @@ $template->param( SCRIPT_NAME => $ENV{'SCRIPT_NAME'} ); ($extended) and $template->param(ExtendedPatronAttributes => 1); if ( $uploadborrowers && length($uploadborrowers) > 0 ) { + push @feedback, {feedback=>1, name=>'filename', value=>$uploadborrowers, filename=>$uploadborrowers}; + my $handle = $input->upload('uploadborrowers'); + my $uploadinfo = $input->uploadInfo($uploadborrowers); + foreach (keys %$uploadinfo) { + push @feedback, {feedback=>1, name=>$_, value=>$uploadinfo->{$_}, $_=>$uploadinfo->{$_}}; + } my $imported = 0; my $alreadyindb = 0; my $overwritten = 0; @@ -96,7 +114,7 @@ if ( $uploadborrowers && length($uploadborrowers) > 0 ) { my %defaults = $input->Vars; # use header line to construct key to column map - my $borrowerline = <$uploadborrowers>; + my $borrowerline = <$handle>; my $status = $csv->parse($borrowerline); ($status) or push @errors, {badheader=>1,line=>$., lineraw=>$borrowerline}; my @csvcolumns = $csv->fields(); @@ -108,14 +126,18 @@ if ( $uploadborrowers && length($uploadborrowers) > 0 ) { $csvkeycol{$keycol} = $col++; } #warn($borrowerline); - + my $ext_preserve = $input->param('ext_preserve') || 0; if ($extended) { $matchpoint_attr_type = C4::Members::AttributeTypes->fetch($matchpoint); } - my @criticals = qw(surname); # there probably should be others - my @errors; - LINE: while ( my $borrowerline = <$uploadborrowers> ) { + push @feedback, {feedback=>1, name=>'headerrow', value=>join(', ', @csvcolumns)}; + my $today_iso = C4::Dates->new()->output('iso'); + my @criticals = qw(surname branchcode categorycode); # there probably should be others + my @bad_dates; # I've had a few. + my $date_re = C4::Dates->new->regexp('syspref'); + my $iso_re = C4::Dates->new->regexp('iso'); + LINE: while ( my $borrowerline = <$handle> ) { my %borrower; my @missing_criticals; my $patron_attributes; @@ -125,6 +147,12 @@ if ( $uploadborrowers && length($uploadborrowers) > 0 ) { push @missing_criticals, {badparse=>1, line=>$., lineraw=>$borrowerline}; } elsif (@columns == @columnkeys) { @borrower{@columnkeys} = @columns; + # MJR: try to fill blanks gracefully by using default values + foreach my $key (@columnkeys) { + if ($borrower{$key} !~ /\S/) { + $borrower{$key} = $defaults{$key}; + } + } } else { # MJR: try to recover gracefully by using default values foreach my $key (@columnkeys) { @@ -141,6 +169,18 @@ if ( $uploadborrowers && length($uploadborrowers) > 0 ) { } } #warn join(':',%borrower); + if ($borrower{categorycode}) { + push @missing_criticals, {key=>'categorycode', line=>$. , lineraw=>$borrowerline, value=>$borrower{categorycode}, category_map=>1} + unless GetBorrowercategory($borrower{categorycode}); + } else { + push @missing_criticals, {key=>'categorycode', line=>$. , lineraw=>$borrowerline}; + } + if ($borrower{branchcode}) { + push @missing_criticals, {key=>'branchcode', line=>$. , lineraw=>$borrowerline, value=>$borrower{branchcode}, branch_map=>1} + unless GetBranchName($borrower{branchcode}); + } else { + push @missing_criticals, {key=>'branchcode', line=>$. , lineraw=>$borrowerline}; + } if (@missing_criticals) { foreach (@missing_criticals) { $_->{borrowernumber} = $borrower{borrowernumber} || 'UNDEF'; @@ -151,22 +191,32 @@ if ( $uploadborrowers && length($uploadborrowers) > 0 ) { # The first 25 errors are enough. Keeping track of 30,000+ would destroy performance. next LINE; } - my @attrs; if ($extended) { my $attr_str = $borrower{patron_attributes}; - delete $borrower{patron_attributes}; - my $ok = $csv->parse($attr_str); - my @list = $csv->fields(); - # FIXME error handling - $patron_attributes = [ map { map { my @arr = split /:/, $_, 2; { code => $arr[0], value => $arr[1] } } $_ } @list ]; + $attr_str =~ s/\xe2\x80\x9c/"/g; # fixup double quotes in case we are passed smart quotes + $attr_str =~ s/\xe2\x80\x9d/"/g; + push @feedback, {feedback=>1, name=>'attribute string', value=>$attr_str, filename=>$uploadborrowers}; + delete $borrower{patron_attributes}; # not really a field in borrowers, so we don't want to pass it to ModMember. + $patron_attributes = extended_attributes_code_value_arrayref($attr_str); } + # Popular spreadsheet applications make it difficult to force date outputs to be zero-padded, but we require it. foreach (qw(dateofbirth dateenrolled dateexpiry)) { my $tempdate = $borrower{$_} or next; - $borrower{$_} = format_date_in_iso($tempdate) || ''; + if ($tempdate =~ /$date_re/) { + $borrower{$_} = format_date_in_iso($tempdate); + } elsif ($tempdate =~ /$iso_re/) { + $borrower{$_} = $tempdate; + } else { + $borrower{$_} = ''; + push @missing_criticals, {key=>$_, line=>$. , lineraw=>$borrowerline, bad_date=>1}; + } } + $borrower{dateenrolled} = $today_iso unless $borrower{dateenrolled}; + $borrower{dateexpiry} = GetExpiryDate($borrower{categorycode},$borrower{dateenrolled}) unless $borrower{dateexpiry}; my $borrowernumber; - if ($matchpoint eq 'cardnumber') { - my $member = GetMember( $borrower{'cardnumber'}, 'cardnumber' ); + my $member; + if ( ($matchpoint eq 'cardnumber') && ($borrower{'cardnumber'}) ) { + $member = GetMember( 'cardnumber' => $borrower{'cardnumber'} ); if ($member) { $borrowernumber = $member->{'borrowernumber'}; } @@ -190,13 +240,30 @@ if ( $uploadborrowers && length($uploadborrowers) > 0 ) { next LINE; } $borrower{'borrowernumber'} = $borrowernumber; + for my $col (keys %borrower) { + # use values from extant patron unless our csv file includes this column or we provided a default. + # FIXME : You cannot update a field with a perl-evaluated false value using the defaults. + + # The password is always encrypted, skip it! + next if $col eq 'password'; + + unless(exists($csvkeycol{$col}) || $defaults{$col}) { + $borrower{$col} = $member->{$col} if($member->{$col}) ; + } + } unless (ModMember(%borrower)) { $invalid++; + # untill we have better error trapping, we have no way of knowing why ModMember errored out... + push @errors, {unknown_error => 1}; $template->param('lastinvalid'=>$borrower{'surname'}.' / '.$borrowernumber); next LINE; } if ($extended) { - C4::Members::Attributes::SetBorrowerAttributes($borrower{'borrowernumber'}, $patron_attributes); + if ($ext_preserve) { + my $old_attributes = GetBorrowerAttributes($borrowernumber); + $patron_attributes = extended_attributes_merge($old_attributes, $patron_attributes); #TODO: expose repeatable options in template + } + push @errors, {unknown_error => 1} unless SetBorrowerAttributes($borrower{'borrowernumber'}, $patron_attributes); } $overwritten++; $template->param('lastoverwritten'=>$borrower{'surname'}.' / '.$borrowernumber); @@ -204,21 +271,27 @@ if ( $uploadborrowers && length($uploadborrowers) > 0 ) { # FIXME: fixup_cardnumber says to lock table, but the web interface doesn't so this doesn't either. # At least this is closer to AddMember than in members/memberentry.pl if (!$borrower{'cardnumber'}) { - $borrower{'cardnumber'} = fixup_cardnumber(''); + $borrower{'cardnumber'} = fixup_cardnumber(undef); } if ($borrowernumber = AddMember(%borrower)) { if ($extended) { - C4::Members::Attributes::SetBorrowerAttributes($borrowernumber, $patron_attributes); + SetBorrowerAttributes($borrowernumber, $patron_attributes); + } + if ($set_messaging_prefs) { + C4::Members::Messaging::SetMessagingPreferencesFromDefaults({ borrowernumber => $borrowernumber, + categorycode => $borrower{categorycode} }); } $imported++; $template->param('lastimported'=>$borrower{'surname'}.' / '.$borrowernumber); } else { - $invalid++; # was just "$invalid", I assume incrementing was the point --atz + $invalid++; + push @errors, {unknown_error => 1}; $template->param('lastinvalid'=>$borrower{'surname'}.' / AddMember'); } } } - (@errors) and $template->param(ERRORS=>\@errors); + (@errors ) and $template->param( ERRORS=>\@errors ); + (@feedback) and $template->param(FEEDBACK=>\@feedback); $template->param( 'uploadborrowers' => 1, 'imported' => $imported, @@ -231,7 +304,7 @@ if ( $uploadborrowers && length($uploadborrowers) > 0 ) { } else { if ($extended) { my @matchpoints = (); - my @attr_types = C4::Members::AttributeTypes::GetAttributeTypes(); + my @attr_types = C4::Members::AttributeTypes::GetAttributeTypes(undef, 1); foreach my $type (@attr_types) { my $attr_type = C4::Members::AttributeTypes->fetch($type->{code}); if ($attr_type->unique_id()) {