Bug 19722: Don't show items at job completion if over pref
[koha.git] / 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;
40 use C4::Output;
41 use C4::Templates;
42 use Koha::Patrons;
43 use Koha::DateUtils;
44 use Koha::Token;
45 use Koha::Libraries;
46 use Koha::Patron::Categories;
47 use Koha::List::Patron;
48
49 use Koha::Patrons::Import;
50 my $Import = Koha::Patrons::Import->new();
51
52 use Text::CSV;
53
54 # Text::CSV::Unicode, even in binary mode, fails to parse lines with these diacriticals:
55 # ė
56 # č
57
58 use CGI qw ( -utf8 );
59
60 my ( @errors, @feedback );
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
66 my $input = CGI->new();
67
68 #push @feedback, {feedback=>1, name=>'backend', value=>$csv->backend, backend=>$csv->backend}; #XXX
69
70 my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
71     {
72         template_name   => "tools/import_borrowers.tt",
73         query           => $input,
74         type            => "intranet",
75         authnotrequired => 0,
76         flagsrequired   => { tools => 'import_patrons' },
77         debug           => 1,
78     }
79 );
80
81 # get the patron categories and pass them to the template
82 my @patron_categories = Koha::Patron::Categories->search_limited({}, {order_by => ['description']});
83 $template->param( categories => \@patron_categories );
84 my $columns = C4::Templates::GetColumnDefs( $input )->{borrowers};
85 $columns = [ grep { $_->{field} ne 'borrowernumber' ? $_ : () } @$columns ];
86 $template->param( borrower_fields => $columns );
87
88 if ( $input->param('sample') ) {
89     our $csv = Text::CSV->new( { binary => 1 } );    # binary needed for non-ASCII Unicode
90     print $input->header(
91         -type       => 'application/vnd.sun.xml.calc',    # 'application/vnd.ms-excel' ?
92         -attachment => 'patron_import.csv',
93     );
94     $csv->combine(@columnkeys);
95     print $csv->string, "\n";
96     exit 0;
97 }
98
99 my $uploadborrowers = $input->param('uploadborrowers');
100 my $matchpoint      = $input->param('matchpoint');
101 if ($matchpoint) {
102     $matchpoint =~ s/^patron_attribute_//;
103 }
104
105 #create a patronlist
106 my $createpatronlist = $input->param('createpatronlist') || 0;
107 my $dt = dt_from_string();
108 my $timestamp = $dt->ymd('-').' '.$dt->hms(':');
109 my $patronlistname = $uploadborrowers . ' (' . $timestamp .')';
110
111 $template->param( SCRIPT_NAME => '/cgi-bin/koha/tools/import_borrowers.pl' );
112
113 if ( $uploadborrowers && length($uploadborrowers) > 0 ) {
114     output_and_exit( $input, $cookie, $template, 'wrong_csrf_token' )
115         unless Koha::Token->new->check_csrf({
116             session_id => scalar $input->cookie('CGISESSID'),
117             token  => scalar $input->param('csrf_token'),
118         });
119
120     my $handle   = $input->upload('uploadborrowers');
121     my %defaults = $input->Vars;
122
123     my $return = $Import->import_patrons(
124         {
125             file                         => $handle,
126             defaults                     => \%defaults,
127             matchpoint                   => $matchpoint,
128             overwrite_cardnumber         => $input->param('overwrite_cardnumber'),
129             preserve_extended_attributes => $input->param('ext_preserve') || 0,
130         }
131     );
132
133     my $feedback    = $return->{feedback};
134     my $errors      = $return->{errors};
135     my $imported    = $return->{imported};
136     my $overwritten = $return->{overwritten};
137     my $alreadyindb = $return->{already_in_db};
138     my $invalid     = $return->{invalid};
139     my $imported_borrowers = $return->{imported_borrowers};
140
141     if ( $imported && $createpatronlist ) {
142         my $patronlist = AddPatronList({ name => $patronlistname });
143         AddPatronsToList({ list => $patronlist, borrowernumbers => $imported_borrowers });
144         $template->param('patronlistname' => $patronlistname);
145     }
146
147     my $uploadinfo = $input->uploadInfo($uploadborrowers);
148     foreach ( keys %$uploadinfo ) {
149         push @$feedback, { feedback => 1, name => $_, value => $uploadinfo->{$_}, $_ => $uploadinfo->{$_} };
150     }
151
152     push @$feedback, { feedback => 1, name => 'filename', value => $uploadborrowers, filename => $uploadborrowers };
153
154     $template->param(
155         uploadborrowers => 1,
156         errors          => $errors,
157         feedback        => $feedback,
158         imported        => $imported,
159         overwritten     => $overwritten,
160         alreadyindb     => $alreadyindb,
161         invalid         => $invalid,
162         total           => $imported + $alreadyindb + $invalid + $overwritten,
163     );
164
165 }
166 else {
167     if ($extended) {
168         my @matchpoints = ();
169         my @attr_types = C4::Members::AttributeTypes::GetAttributeTypes( undef, 1 );
170         foreach my $type (@attr_types) {
171             my $attr_type = C4::Members::AttributeTypes->fetch( $type->{code} );
172             if ( $attr_type->unique_id() ) {
173                 push @matchpoints,
174                   { code => "patron_attribute_" . $attr_type->code(), description => $attr_type->description() };
175             }
176         }
177         $template->param( matchpoints => \@matchpoints );
178     }
179
180     $template->param(
181         csrf_token => Koha::Token->new->generate_csrf(
182             { session_id => scalar $input->cookie('CGISESSID'), }
183         ),
184     );
185
186 }
187
188 output_html_with_http_headers $input, $cookie, $template->output;
189