tools/import_borrowers.pl

   1 #!/usr/bin/perl
   2
   3 # Copyright 2007 Liblime
   4 # Parts copyright 2010 BibLibre
   5 #
   6 # This file is part of Koha.
   7 #
   8 # Koha is free software; you can redistribute it and/or modify it
   9 # under the terms of the GNU General Public License as published by
  10 # the Free Software Foundation; either version 3 of the License, or
  11 # (at your option) any later version.
  12 #
  13 # Koha is distributed in the hope that it will be useful, but
  14 # WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16 # GNU General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU General Public License
  19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  20
  21 # Script to take some borrowers data in a known format and load it into Koha
  22 #
  23 # File format
  24 #
  25 # cardnumber,surname,firstname,title,othernames,initials,streetnumber,streettype,
  26 # address line , address line 2, city, zipcode, contry, email, phone, mobile, fax, work email, work phone,
  27 # alternate streetnumber, alternate streettype, alternate address line 1, alternate city,
  28 # alternate zipcode, alternate country, alternate email, alternate phone, date of birth, branchcode,
  29 # categorycode, enrollment date, expiry date, noaddress, lost, debarred, contact surname,
  30 # contact firstname, contact title, borrower notes, contact relationship
  31 # gender, username, opac note, contact note, password, sort one, sort two
  32 #
  33 # any fields except cardnumber can be blank but the number of fields must match
  34 # dates should be in the format you have set up Koha to expect
  35 # branchcode and categorycode need to be valid
  36
  37 use Modern::Perl;
  38
  39 use C4::Auth qw( get_template_and_user );
  40 use C4::Output qw( output_and_exit output_html_with_http_headers );
  41 use Koha::Database::Columns;
  42 use Koha::Patrons;
  43 use Koha::DateUtils qw( dt_from_string );
  44 use Koha::Token;
  45 use Koha::Libraries;
  46 use Koha::Patron::Categories;
  47 use Koha::Patron::Attribute::Types;
  48 use Koha::List::Patron qw( AddPatronList AddPatronsToList );
  49
  50 use Koha::Patrons::Import;
  51 my $Import = Koha::Patrons::Import->new();
  52
  53 use Text::CSV;
  54
  55 # Text::CSV::Unicode, even in binary mode, fails to parse lines with these diacriticals:
  56 # ė
  57 # č
  58
  59 use CGI qw ( -utf8 );
  60
  61 my $extended = C4::Context->preference('ExtendedPatronAttributes');
  62
  63 my @columnkeys = map { $_ ne 'borrowernumber' ? $_ : () } Koha::Patrons->columns();
  64 push( @columnkeys, 'patron_attributes' ) if $extended;
  65 push( @columnkeys, qw( guarantor_relationship guarantor_id ) );
  66
  67 my $input = CGI->new();
  68
  69 my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
  70     {
  71         template_name   => "tools/import_borrowers.tt",
  72         query           => $input,
  73         type            => "intranet",
  74         flagsrequired   => { tools => 'import_patrons' },
  75     }
  76 );
  77
  78 # get the patron categories and pass them to the template
  79 my @patron_categories = Koha::Patron::Categories->search_with_library_limits({}, {order_by => ['description']})->as_list;
  80 $template->param( categories => \@patron_categories );
  81 $template->param( borrower_fields => Koha::Database::Columns->columns->{borrowers} );
  82
  83 if ( $input->param('sample') ) {
  84     our $csv = Text::CSV->new( { binary => 1 } );    # binary needed for non-ASCII Unicode
  85     print $input->header(
  86         -type       => 'application/vnd.sun.xml.calc',    # 'application/vnd.ms-excel' ?
  87         -attachment => 'patron_import.csv',
  88     );
  89     $csv->combine(@columnkeys);
  90     print $csv->string, "\n";
  91     exit 0;
  92 }
  93
  94 my @preserve_fields = $input->multi_param('preserve_existing');
  95
  96 my $uploadborrowers = $input->param('uploadborrowers');
  97 my $matchpoint      = $input->param('matchpoint');
  98 if ($matchpoint) {
  99     $matchpoint =~ s/^patron_attribute_//;
 100 }
 101
 102 #create a patronlist
 103 my $createpatronlist = $input->param('createpatronlist') || 0;
 104 my $dt = dt_from_string();
 105 my $timestamp = $dt->ymd('-').' '.$dt->hms(':');
 106 my $patronlistname = $uploadborrowers . ' (' . $timestamp .')';
 107
 108 $template->param( SCRIPT_NAME => '/cgi-bin/koha/tools/import_borrowers.pl' );
 109
 110 if ( $uploadborrowers && length($uploadborrowers) > 0 ) {
 111     output_and_exit( $input, $cookie, $template, 'wrong_csrf_token' )
 112         unless Koha::Token->new->check_csrf({
 113             session_id => scalar $input->cookie('CGISESSID'),
 114             token  => scalar $input->param('csrf_token'),
 115         });
 116
 117     my $handle   = $input->upload('uploadborrowers');
 118     my %defaults = $input->Vars;
 119     my $overwrite_passwords = defined $input->param('overwrite_passwords') ? 1 : 0;
 120     my $return = $Import->import_patrons(
 121         {
 122             file                         => $handle,
 123             defaults                     => \%defaults,
 124             matchpoint                   => $matchpoint,
 125             overwrite_cardnumber         => scalar $input->param( 'overwrite_cardnumber' ),
 126             overwrite_passwords          => $overwrite_passwords,
 127             preserve_extended_attributes => scalar $input->param( 'ext_preserve' ) || 0,
 128             preserve_fields              => \@preserve_fields,
 129         }
 130     );
 131
 132     my $feedback    = $return->{feedback};
 133     my $errors      = $return->{errors};
 134     my $imported    = $return->{imported};
 135     my $overwritten = $return->{overwritten};
 136     my $alreadyindb = $return->{already_in_db};
 137     my $invalid     = $return->{invalid};
 138     my $imported_borrowers = $return->{imported_borrowers};
 139
 140     if ( $imported && $createpatronlist ) {
 141         my $patronlist = AddPatronList({ name => $patronlistname });
 142         AddPatronsToList({ list => $patronlist, borrowernumbers => $imported_borrowers });
 143         $template->param('patronlistname' => $patronlistname);
 144     }
 145
 146     my $uploadinfo = $input->uploadInfo($uploadborrowers);
 147     foreach ( keys %$uploadinfo ) {
 148         push @$feedback, { feedback => 1, name => $_, value => $uploadinfo->{$_}, $_ => $uploadinfo->{$_} };
 149     }
 150
 151     push @$feedback, { feedback => 1, name => 'filename', value => $uploadborrowers, filename => $uploadborrowers };
 152
 153     $template->param(
 154         uploadborrowers => 1,
 155         errors          => $errors,
 156         feedback        => $feedback,
 157         imported        => $imported,
 158         overwritten     => $overwritten,
 159         alreadyindb     => $alreadyindb,
 160         invalid         => $invalid,
 161         total           => $imported + $alreadyindb + $invalid + $overwritten,
 162     );
 163
 164 }
 165 else {
 166     if ($extended) {
 167         my @matchpoints = ();
 168         my $attribute_types = Koha::Patron::Attribute::Types->search;
 169
 170         while ( my $attr_type = $attribute_types->next ) {
 171             if ( $attr_type->unique_id() ) {
 172                 push @matchpoints,
 173                   { code => "patron_attribute_" . $attr_type->code(), description => $attr_type->description() };
 174             }
 175         }
 176         $template->param( matchpoints => \@matchpoints );
 177     }
 178
 179     $template->param(
 180         csrf_token => Koha::Token->new->generate_csrf(
 181             { session_id => scalar $input->cookie('CGISESSID'), }
 182         ),
 183     );
 184
 185 }
 186
 187 output_html_with_http_headers $input, $cookie, $template->output;
 188