3 # Copyright 2007 Liblime
4 # Parts copyright 2010 BibLibre
6 # This file is part of Koha.
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.
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.
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>.
21 # Script to take some borrowers data in a known format and load it into Koha
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
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
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;
43 use Koha::DateUtils qw( dt_from_string );
46 use Koha::Patron::Categories;
47 use Koha::Patron::Attribute::Types;
48 use Koha::List::Patron qw( AddPatronList AddPatronsToList );
50 use Koha::Patrons::Import;
51 my $Import = Koha::Patrons::Import->new();
57 my $extended = C4::Context->preference('ExtendedPatronAttributes');
59 my @columnkeys = map { $_ ne 'borrowernumber' ? $_ : () } Koha::Patrons->columns();
60 push( @columnkeys, 'patron_attributes' ) if $extended;
61 push( @columnkeys, qw( guarantor_relationship guarantor_id ) );
63 my $input = CGI->new();
65 my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
67 template_name => "tools/import_borrowers.tt",
70 flagsrequired => { tools => 'import_patrons' },
74 # get the patron categories and pass them to the template
75 my @patron_categories = Koha::Patron::Categories->search_with_library_limits({}, {order_by => ['description']})->as_list;
76 $template->param( categories => \@patron_categories );
77 $template->param( borrower_fields => Koha::Database::Columns->columns->{borrowers} );
79 if ( $input->param('sample') ) {
80 our $csv = Text::CSV->new( { binary => 1 } ); # binary needed for non-ASCII Unicode
82 -type => 'application/vnd.sun.xml.calc', # 'application/vnd.ms-excel' ?
83 -attachment => 'patron_import.csv',
85 $csv->combine(@columnkeys);
86 print $csv->string, "\n";
90 my @preserve_fields = $input->multi_param('preserve_existing');
92 my $uploadborrowers = $input->param('uploadborrowers');
93 my $matchpoint = $input->param('matchpoint');
94 my $welcome_new = $input->param('welcome_new');
96 $matchpoint =~ s/^patron_attribute_//;
100 my $createpatronlist = $input->param('createpatronlist') || 0;
101 my $dt = dt_from_string();
102 my $timestamp = $dt->ymd('-').' '.$dt->hms(':');
103 my $patronlistname = $uploadborrowers . ' (' . $timestamp .')';
105 $template->param( SCRIPT_NAME => '/cgi-bin/koha/tools/import_borrowers.pl' );
107 if ( $uploadborrowers && length($uploadborrowers) > 0 ) {
108 output_and_exit( $input, $cookie, $template, 'wrong_csrf_token' )
109 unless Koha::Token->new->check_csrf({
110 session_id => scalar $input->cookie('CGISESSID'),
111 token => scalar $input->param('csrf_token'),
114 my $handle = $input->upload('uploadborrowers');
115 my %defaults = $input->Vars;
116 my $overwrite_passwords = defined $input->param('overwrite_passwords') ? 1 : 0;
117 my $update_dateexpiry = $input->param('update_dateexpiry');
118 my $return = $Import->import_patrons(
121 defaults => \%defaults,
122 matchpoint => $matchpoint,
123 overwrite_cardnumber => scalar $input->param('overwrite_cardnumber'),
124 overwrite_passwords => $overwrite_passwords,
125 preserve_extended_attributes => scalar $input->param('ext_preserve') || 0,
126 preserve_fields => \@preserve_fields,
127 update_dateexpiry => $update_dateexpiry ? 1 : 0,
128 update_dateexpiry_from_today => $update_dateexpiry eq "now" ? 1 : 0,
129 update_dateexpiry_from_existing => $update_dateexpiry eq "dateexpiry" ? 1 : 0,
130 send_welcome => $welcome_new,
134 my $feedback = $return->{feedback};
135 my $errors = $return->{errors};
136 my $imported = $return->{imported};
137 my $overwritten = $return->{overwritten};
138 my $alreadyindb = $return->{already_in_db};
139 my $invalid = $return->{invalid};
140 my $imported_borrowers = $return->{imported_borrowers};
142 if ( $imported && $createpatronlist ) {
143 my $patronlist = AddPatronList({ name => $patronlistname });
144 AddPatronsToList({ list => $patronlist, borrowernumbers => $imported_borrowers });
145 $template->param('patronlistname' => $patronlistname);
148 my $uploadinfo = $input->uploadInfo($uploadborrowers);
149 foreach ( keys %$uploadinfo ) {
150 push @$feedback, { feedback => 1, name => $_, value => $uploadinfo->{$_}, $_ => $uploadinfo->{$_} };
153 push @$feedback, { feedback => 1, name => 'filename', value => $uploadborrowers, filename => $uploadborrowers };
156 uploadborrowers => 1,
158 feedback => $feedback,
159 imported => $imported,
160 overwritten => $overwritten,
161 alreadyindb => $alreadyindb,
163 total => $imported + $alreadyindb + $invalid + $overwritten,
169 my @matchpoints = ();
170 my $attribute_types = Koha::Patron::Attribute::Types->search;
172 while ( my $attr_type = $attribute_types->next ) {
173 if ( $attr_type->unique_id() ) {
175 { code => "patron_attribute_" . $attr_type->code(), description => $attr_type->description() };
178 $template->param( matchpoints => \@matchpoints );
182 csrf_token => Koha::Token->new->generate_csrf(
183 { session_id => scalar $input->cookie('CGISESSID'), }
189 output_html_with_http_headers $input, $cookie, $template->output;