X-Git-Url: http://git.rot13.org/?a=blobdiff_plain;f=tools%2Fimport_borrowers.pl;h=d17bc408bc87d5ca776e7167d6560ad05c126ef5;hb=0ab22e1c7c6b6e8d14a4fb7478ab2a3d42da347d;hp=6141998a2ad20df4fee6faa0209d2971d9ca4e76;hpb=ff7affdf43b4850a0ce62c9924246caac69b9030;p=koha.git diff --git a/tools/import_borrowers.pl b/tools/import_borrowers.pl index 6141998a2a..d17bc408bc 100755 --- a/tools/import_borrowers.pl +++ b/tools/import_borrowers.pl @@ -5,18 +5,18 @@ # # This file is part of Koha. # -# Koha is free software; you can redistribute it and/or modify it under the -# terms of the GNU General Public License as published by the Free Software -# Foundation; either version 2 of the License, or (at your option) any later -# version. +# Koha is free software; you can redistribute it and/or modify it +# under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 3 of the License, or +# (at your option) any later version. # -# Koha is distributed in the hope that it will be useful, but WITHOUT ANY -# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR -# A PARTICULAR PURPOSE. See the GNU General Public License for more details. +# Koha is distributed in the hope that it will be useful, but +# WITHOUT ANY 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., -# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. +# You should have received a copy of the GNU General Public License +# along with Koha; if not, see . # Script to take some borrowers data in a known format and load it into Koha # @@ -27,49 +27,54 @@ # alternate streetnumber, alternate streettype, alternate address line 1, alternate city, # 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 +# contact firstname, contact title, borrower notes, contact relationship # gender, username, opac note, contact note, password, sort one, sort two # # any fields except cardnumber can be blank but the number of fields must match # dates should be in the format you have set up Koha to expect # branchcode and categorycode need to be valid -use strict; -use warnings; +use Modern::Perl; 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 qw(:all); use C4::Members::AttributeTypes; use C4::Members::Messaging; +use C4::Reports::Guided; +use C4::Templates; +use Koha::Patron::Debarments; +use Koha::Patrons; +use Koha::DateUtils; +use Koha::Token; +use Koha::Libraries; +use Koha::Patron::Categories; +use Koha::List::Patron; 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 +use CGI qw ( -utf8 ); my (@errors, @feedback); my $extended = C4::Context->preference('ExtendedPatronAttributes'); my $set_messaging_prefs = C4::Context->preference('EnhancedMessagingPreferences'); -my @columnkeys = C4::Members->columns; +my @columnkeys = Koha::Patrons->columns(); +@columnkeys = map { $_ ne 'borrowernumber' ? $_ : () } @columnkeys; if ($extended) { push @columnkeys, 'patron_attributes'; } -my $columnkeystpl = [ map { {'key' => $_} } grep {$_ ne 'borrowernumber' && $_ ne 'cardnumber'} @columnkeys ]; # ref. to array of hashrefs. my $input = CGI->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}; +#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", + template_name => "tools/import_borrowers.tt", query => $input, type => "intranet", authnotrequired => 0, @@ -77,7 +82,12 @@ my ( $template, $loggedinuser, $cookie ) = get_template_and_user({ debug => 1, }); -$template->param(columnkeys => $columnkeystpl); +# get the patron categories and pass them to the template +my @patron_categories = Koha::Patron::Categories->search_limited({}, {order_by => ['description']}); +$template->param( categories => \@patron_categories ); +my $columns = C4::Templates::GetColumnDefs( $input )->{borrowers}; +$columns = [ grep { $_->{field} ne 'borrowernumber' ? $_ : () } @$columns ]; +$template->param( borrower_fields => $columns ); if ($input->param('sample')) { print $input->header( @@ -86,7 +96,7 @@ if ($input->param('sample')) { ); $csv->combine(@columnkeys); print $csv->string, "\n"; - exit 1; + exit 0; } my $uploadborrowers = $input->param('uploadborrowers'); my $matchpoint = $input->param('matchpoint'); @@ -95,18 +105,30 @@ if ($matchpoint) { } my $overwrite_cardnumber = $input->param('overwrite_cardnumber'); -$template->param( SCRIPT_NAME => $ENV{'SCRIPT_NAME'} ); +#create a patronlist +my $createpatronlist = $input->param('createpatronlist') || 0; +my $dt = dt_from_string(); +my $timestamp = $dt->ymd('-').' '.$dt->hms(':'); +my $patronlistname = $uploadborrowers . ' (' . $timestamp .')'; -($extended) and $template->param(ExtendedPatronAttributes => 1); +$template->param( SCRIPT_NAME => '/cgi-bin/koha/tools/import_borrowers.pl' ); if ( $uploadborrowers && length($uploadborrowers) > 0 ) { + die "Wrong CSRF token" + unless Koha::Token->new->check_csrf({ + session_id => scalar $input->cookie('CGISESSID'), + token => scalar $input->param('csrf_token'), + }); + 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 @imported_borrowers; my $alreadyindb = 0; my $overwritten = 0; my $invalid = 0; @@ -132,11 +154,9 @@ if ( $uploadborrowers && length($uploadborrowers) > 0 ) { } push @feedback, {feedback=>1, name=>'headerrow', value=>join(', ', @csvcolumns)}; - my $today_iso = C4::Dates->new()->output('iso'); + my $today = output_pref; 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; @@ -171,13 +191,13 @@ 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}); + unless Koha::Patron::Categories->find($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}); + unless Koha::Libraries->find($borrower{branchcode}); } else { push @missing_criticals, {key=>'branchcode', line=>$. , lineraw=>$borrowerline}; } @@ -193,30 +213,31 @@ if ( $uploadborrowers && length($uploadborrowers) > 0 ) { } if ($extended) { my $attr_str = $borrower{patron_attributes}; + $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; - if ($tempdate =~ /$date_re/) { - $borrower{$_} = format_date_in_iso($tempdate); - } elsif ($tempdate =~ /$iso_re/) { + $tempdate = eval { output_pref( { dt => dt_from_string( $tempdate ), dateonly => 1, dateformat => 'iso' } ); }; + if ($tempdate) { $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}; + $borrower{dateenrolled} ||= $today; + $borrower{dateexpiry} ||= Koha::Patron::Categories->find( $borrower{categorycode} )->get_expiry_date( $borrower{dateenrolled} ); my $borrowernumber; my $member; if ( ($matchpoint eq 'cardnumber') && ($borrower{'cardnumber'}) ) { - $member = GetMember( 'cardnumber' => $borrower{'cardnumber'} ); - if ($member) { - $borrowernumber = $member->{'borrowernumber'}; - } + $member = Koha::Patrons->find( { cardnumber => $borrower{'cardnumber'} } ); + } elsif ( ($matchpoint eq 'userid') && ($borrower{'userid'}) ) { + $member = Koha::Patrons->find( { userid => $borrower{'userid'} } ); } elsif ($extended) { if (defined($matchpoint_attr_type)) { foreach my $attr (@$patron_attributes) { @@ -228,7 +249,24 @@ if ( $uploadborrowers && length($uploadborrowers) > 0 ) { } } } - + + if ($member) { + $member = $member->unblessed; + $borrowernumber = $member->{'borrowernumber'}; + } else { + $member = {}; + } + + if ( C4::Members::checkcardnumber( $borrower{cardnumber}, $borrowernumber ) ) { + push @errors, { + invalid_cardnumber => 1, + borrowernumber => $borrowernumber, + cardnumber => $borrower{cardnumber} + }; + $invalid++; + next; + } + if ($borrowernumber) { # borrower exists unless ($overwrite_cardnumber) { @@ -240,21 +278,60 @@ if ( $uploadborrowers && length($uploadborrowers) > 0 ) { 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}) ; } } + + # Check if the userid provided does not exist yet + if ( exists $borrower{userid} + and $borrower{userid} + and not Check_Userid( $borrower{userid}, $borrower{borrowernumber} ) ) { + push @errors, { duplicate_userid => 1, userid => $borrower{userid} }; + $invalid++; + next LINE; + } + unless (ModMember(%borrower)) { $invalid++; + # until 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; } + + # Don't add a new restriction if the existing 'combined' restriction matches this one + if ( $borrower{debarred} && ( ( $borrower{debarred} ne $member->{debarred} ) || ( $borrower{debarredcomment} ne $member->{debarredcomment} ) ) ) { + # Check to see if this debarment already exists + my $debarrments = GetDebarments( + { + borrowernumber => $borrowernumber, + expiration => $borrower{debarred}, + comment => $borrower{debarredcomment} + } + ); + # If it doesn't, then add it! + unless (@$debarrments) { + AddDebarment( + { + borrowernumber => $borrowernumber, + expiration => $borrower{debarred}, + comment => $borrower{debarredcomment} + } + ); + } + } + if ($extended) { if ($ext_preserve) { my $old_attributes = GetBorrowerAttributes($borrowernumber); $patron_attributes = extended_attributes_merge($old_attributes, $patron_attributes); #TODO: expose repeatable options in template } - SetBorrowerAttributes($borrower{'borrowernumber'}, $patron_attributes); + push @errors, {unknown_error => 1} unless SetBorrowerAttributes($borrower{'borrowernumber'}, $patron_attributes, 'no_branch_limit' ); } $overwritten++; $template->param('lastoverwritten'=>$borrower{'surname'}.' / '.$borrowernumber); @@ -265,21 +342,43 @@ if ( $uploadborrowers && length($uploadborrowers) > 0 ) { $borrower{'cardnumber'} = fixup_cardnumber(undef); } if ($borrowernumber = AddMember(%borrower)) { + + if ( $borrower{debarred} ) { + AddDebarment( + { + borrowernumber => $borrowernumber, + expiration => $borrower{debarred}, + comment => $borrower{debarredcomment} + } + ); + } + if ($extended) { SetBorrowerAttributes($borrowernumber, $patron_attributes); } + if ($set_messaging_prefs) { C4::Members::Messaging::SetMessagingPreferencesFromDefaults({ borrowernumber => $borrowernumber, categorycode => $borrower{categorycode} }); } + $imported++; $template->param('lastimported'=>$borrower{'surname'}.' / '.$borrowernumber); + push @imported_borrowers, $borrowernumber; #for patronlist } else { $invalid++; + push @errors, {unknown_error => 1}; $template->param('lastinvalid'=>$borrower{'surname'}.' / AddMember'); } } } + + if ( $imported && $createpatronlist ) { + my $patronlist = AddPatronList({ name => $patronlistname }); + AddPatronsToList({ list => $patronlist, borrowernumbers => \@imported_borrowers }); + $template->param('patronlistname' => $patronlistname); + } + (@errors ) and $template->param( ERRORS=>\@errors ); (@feedback) and $template->param(FEEDBACK=>\@feedback); $template->param( @@ -294,7 +393,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()) { @@ -303,6 +402,13 @@ if ( $uploadborrowers && length($uploadborrowers) > 0 ) { } $template->param(matchpoints => \@matchpoints); } + + $template->param( + csrf_token => Koha::Token->new->generate_csrf( + { session_id => scalar $input->cookie('CGISESSID'), } + ), + ); + } output_html_with_http_headers $input, $cookie, $template->output;