X-Git-Url: http://git.rot13.org/?a=blobdiff_plain;f=tools%2Fimport_borrowers.pl;h=febb73817b7a136a8c06b36fe34bad73ec5da29a;hb=e73f273a5e747f7f5eb693a03105131b67f0c91b;hp=30200d4faeae11e424d8ed79d42d813ba7bd0cda;hpb=9f1d798bfe33c4b8e72e61d589ca5ee4b275d34c;p=koha.git

diff --git a/tools/import_borrowers.pl b/tools/import_borrowers.pl
index 30200d4fae..febb73817b 100755
--- a/tools/import_borrowers.pl
+++ b/tools/import_borrowers.pl
@@ -34,88 +34,247 @@
 # 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 qw(:all);
+use C4::Members::AttributeTypes;
 
 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, @feedback);
+my $extended = C4::Context->preference('ExtendedPatronAttributes');
+my @columnkeys = C4::Members->columns;
+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};
 
-my @columnkeys = (
-    'cardnumber',    'surname',      'firstname',        'title',
-    'othernames',    'initials',     'streetnumber',     'streettype',
-    'address',       'address2',     'city',             'zipcode',
-    'email',         'phone',        'mobile',           'fax',
-    'emailpro',      'phonepro',     'B_streetnumber',   'B_streettype',
-    'B_address',     'B_city',       'B_zipcode',        'B_email',
-    'B_phone',       'dateofbirth',  'branchcode',       'categorycode',
-    'dateenrolled',  'dateexpiry',   'gonenoaddress',    'lost',
-    'debarred',      'contactname',  'contactfirstname', 'contacttitle',
-    'borrowernotes', 'relationship', 'ethnicity',        'ethnotes',
-    'sex',           'userid',       'opacnote',         'contactnote',
-    'password',      'sort1',        'sort2'
-);
-
-my $input = new CGI;
-
-my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
-    {
+my ( $template, $loggedinuser, $cookie ) = get_template_and_user({
         template_name   => "tools/import_borrowers.tmpl",
         query           => $input,
         type            => "intranet",
         authnotrequired => 0,
-        flagsrequired   => { tools => 1 },
+        flagsrequired   => { tools => 'import_patrons' },
         debug           => 1,
-    }
-);
+});
 
-my $uploadborrowers      = $input->param('uploadborrowers');
+$template->param(columnkeys => $columnkeystpl);
+
+if ($input->param('sample')) {
+    print $input->header(
+        -type       => 'application/vnd.sun.xml.calc', # 'application/vnd.ms-excel' ?
+        -attachment => 'patron_import.csv',
+    );
+    $csv->combine(@columnkeys);
+    print $csv->string, "\n";
+    exit 1;
+}
+my $uploadborrowers = $input->param('uploadborrowers');
+my $matchpoint      = $input->param('matchpoint');
+if ($matchpoint) {
+    $matchpoint =~ s/^patron_attribute_//;
+}
 my $overwrite_cardnumber = $input->param('overwrite_cardnumber');
 
 $template->param( SCRIPT_NAME => $ENV{'SCRIPT_NAME'} );
 
+($extended) and $template->param(ExtendedPatronAttributes => 1);
+
 if ( $uploadborrowers && length($uploadborrowers) > 0 ) {
-    my $csv         = Text::CSV->new();
+    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;
     my $invalid     = 0;
-    while ( my $borrowerline = <$uploadborrowers> ) {
+    my $matchpoint_attr_type; 
+    my %defaults = $input->Vars;
+
+    # use header line to construct key to column map
+    my $borrowerline = <$handle>;
+    my $status = $csv->parse($borrowerline);
+    ($status) or push @errors, {badheader=>1,line=>$., lineraw=>$borrowerline};
+    my @csvcolumns = $csv->fields();
+    my %csvkeycol;
+    my $col = 0;
+    foreach my $keycol (@csvcolumns) {
+    	# columnkeys don't contain whitespace, but some stupid tools add it
+    	$keycol =~ s/ +//g;
+        $csvkeycol{$keycol} = $col++;
+    }
+    #warn($borrowerline);
+    my $ext_preserve = $input->param('ext_preserve') || 0;
+    if ($extended) {
+        $matchpoint_attr_type = C4::Members::AttributeTypes->fetch($matchpoint);
+    }
+
+    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;
         my $status  = $csv->parse($borrowerline);
         my @columns = $csv->fields();
-        my %borrower;
-        if ( @columns == @columnkeys ) {
+        if (! $status) {
+            push @missing_criticals, {badparse=>1, line=>$., lineraw=>$borrowerline};
+        } elsif (@columns == @columnkeys) {
             @borrower{@columnkeys} = @columns;
-			foreach (qw(dateofbirth dateenrolled dateexpiry)) {
-				my $tempdate = $borrower{$_} or next;
-				$borrower{$_} = format_date_in_iso($tempdate) || '';
-			}
-            if ( my $member =
-                GetMember( $borrower{'cardnumber'}, 'cardnumber' ) )
-            {
-                # borrower exists
-                if ($overwrite_cardnumber) {
-                    $borrower{'borrowernumber'} = $member->{'borrowernumber'};
-                    ModMember(%borrower);
-                    $overwritten++;
-                } else {
-                    $alreadyindb++;
+            # MJR: try to fill blanks gracefully by using default values
+            foreach my $key (@criticals) {
+                if ($borrower{$key} !~ /\S/) {
+                    $borrower{$key} = $defaults{$key};
+                }
+            } 
+        } else {
+            # MJR: try to recover gracefully by using default values
+            foreach my $key (@columnkeys) {
+            	if (defined($csvkeycol{$key}) and $columns[$csvkeycol{$key}] =~ /\S/) { 
+            	    $borrower{$key} = $columns[$csvkeycol{$key}];
+            	} elsif ( $defaults{$key} ) {
+            	    $borrower{$key} = $defaults{$key};
+            	} elsif ( scalar grep {$key eq $_} @criticals ) {
+            	    # a critical field is undefined
+            	    push @missing_criticals, {key=>$key, line=>$., lineraw=>$borrowerline};
+            	} else {
+            		$borrower{$key} = '';
+            	}
+            }
+        }
+        #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';
+                $_->{surname}        = $borrower{surname} || 'UNDEF';
+            }
+            $invalid++;
+            (25 > scalar @errors) and push @errors, {missing_criticals=>\@missing_criticals};
+            # The first 25 errors are enough.  Keeping track of 30,000+ would destroy performance.
+            next LINE;
+        }
+        if ($extended) {
+            my $attr_str = $borrower{patron_attributes};
+            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/) {
+                $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;
+        my $member;
+        if ( ($matchpoint eq 'cardnumber') && ($borrower{'cardnumber'}) ) {
+            $member = GetMember( $borrower{'cardnumber'}, 'cardnumber' );
+            if ($member) {
+                $borrowernumber = $member->{'borrowernumber'};
+            }
+        } elsif ($extended) {
+            if (defined($matchpoint_attr_type)) {
+                foreach my $attr (@$patron_attributes) {
+                    if ($attr->{code} eq $matchpoint and $attr->{value} ne '') {
+                        my @borrowernumbers = $matchpoint_attr_type->get_patrons($attr->{value});
+                        $borrowernumber = $borrowernumbers[0] if scalar(@borrowernumbers) == 1;
+                        last;
+                    }
                 }
             }
-            else {
-                if (AddMember(%borrower)) {
-                    $imported++;
-                } else {
-                    $invalid++;		# was just "$invalid", I assume incrementing was the point --atz
+        }
+            
+        if ($borrowernumber) {
+            # borrower exists
+            unless ($overwrite_cardnumber) {
+                $alreadyindb++;
+                $template->param('lastalreadyindb'=>$borrower{'surname'}.' / '.$borrowernumber);
+                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.
+                unless(exists($csvkeycol{$col}) || $defaults{$col}) {
+                    $borrower{$col} = $member->{$col} if($member->{$col}) ;
                 }
             }
+            unless (ModMember(%borrower)) {
+                $invalid++;
+                $template->param('lastinvalid'=>$borrower{'surname'}.' / '.$borrowernumber);
+                next LINE;
+            }
+            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);
+            }
+            $overwritten++;
+            $template->param('lastoverwritten'=>$borrower{'surname'}.' / '.$borrowernumber);
         } else {
-            $invalid++;
+            # 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(undef);
+            }
+            if ($borrowernumber = AddMember(%borrower)) {
+                if ($extended) {
+                    SetBorrowerAttributes($borrowernumber, $patron_attributes);
+                }
+                $imported++;
+                $template->param('lastimported'=>$borrower{'surname'}.' / '.$borrowernumber);
+            } else {
+                $invalid++;
+                $template->param('lastinvalid'=>$borrower{'surname'}.' / AddMember');
+            }
         }
     }
-    $template->param( 'uploadborrowers' => 1 );
+    (@errors  ) and $template->param(  ERRORS=>\@errors  );
+    (@feedback) and $template->param(FEEDBACK=>\@feedback);
     $template->param(
         'uploadborrowers' => 1,
         'imported'        => $imported,
@@ -125,6 +284,19 @@ if ( $uploadborrowers && length($uploadborrowers) > 0 ) {
         'total'           => $imported + $alreadyindb + $invalid + $overwritten,
     );
 
+} else {
+    if ($extended) {
+        my @matchpoints = ();
+        my @attr_types = C4::Members::AttributeTypes::GetAttributeTypes();
+        foreach my $type (@attr_types) {
+            my $attr_type = C4::Members::AttributeTypes->fetch($type->{code});
+            if ($attr_type->unique_id()) {
+            push @matchpoints, { code =>  "patron_attribute_" . $attr_type->code(), description => $attr_type->description() };
+            }
+        }
+        $template->param(matchpoints => \@matchpoints);
+    }
 }
+
 output_html_with_http_headers $input, $cookie, $template->output;