4 # This file is part of Koha.
6 # Koha is free software; you can redistribute it and/or modify it
7 # under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 3 of the License, or
9 # (at your option) any later version.
11 # Koha is distributed in the hope that it will be useful, but
12 # WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with Koha; if not, see <http://www.gnu.org/licenses>.
28 use C4::Auth qw( get_template_and_user );
29 use C4::Output qw( output_and_exit output_html_with_http_headers );
34 use Koha::Patron::Images;
39 unless (C4::Context->preference('patronimages')) {
40 # redirect to intranet home if patronimages is not enabled
41 print $input->redirect("/cgi-bin/koha/mainpage.pl");
45 my ($template, $loggedinuser, $cookie)
46 = get_template_and_user({template_name => "tools/picture-upload.tt",
49 flagsrequired => { tools => 'batch_upload_patron_images'},
52 our $filetype = $input->param('filetype') || '';
53 my $cardnumber = $input->param('cardnumber');
54 our $uploadfilename = $input->param('uploadfile') || '';
55 my $uploadfile = $input->upload('uploadfile');
56 my $borrowernumber = $input->param('borrowernumber');
57 my $op = $input->param('op') || '';
59 #FIXME: This code is really in the rough. The variables need to be re-scoped as the two subs depend on global vars to operate.
60 # Other parts of this code could be optimized as well, I think. Perhaps the file upload could be done with YUI's upload
63 our $logger = Koha::Logger->get;
64 $logger->debug("Params are: filetype=$filetype, cardnumber=$cardnumber, borrowernumber=$borrowernumber, uploadfile=$uploadfilename");
68 picture-upload.pl - Script for handling uploading of both single and bulk patronimages and importing them into the database.
76 This script is called and presents the user with an interface allowing him/her to upload a single patron image or bulk patron images via a zip file.
77 Files greater than 100K will be refused. Images should be 140x200 pixels. If they are larger they will be auto-resized to comply.
81 my ( $total, $handled, $tempfile, $tfh );
85 # Case is important in these operational values as the template must use case to be visually pleasing!
86 if ( ( $op eq 'Upload' ) && $uploadfile ) {
88 output_and_exit( $input, $cookie, $template, 'wrong_csrf_token' )
89 unless Koha::Token->new->check_csrf({
90 session_id => scalar $input->cookie('CGISESSID'),
91 token => scalar $input->param('csrf_token'),
94 my $dirname = File::Temp::tempdir( CLEANUP => 1 );
96 if ( $uploadfilename =~ m/(\..+)$/i ) {
100 File::Temp::tempfile( SUFFIX => $filesuffix, UNLINK => 1 );
101 my ( @directories, $results );
103 $errors{'NOTZIP'} = 1
104 if ( $uploadfilename !~ /\.zip$/i && $filetype =~ m/zip/i );
105 $errors{'NOWRITETEMP'} = 1 unless ( -w $dirname );
106 $errors{'EMPTYUPLOAD'} = 1 unless ( length($uploadfile) > 0 );
109 $template->param( ERRORS => [ \%errors ] );
110 output_html_with_http_headers $input, $cookie, $template->output;
113 while (<$uploadfile>) {
117 if ( $filetype eq 'zip' ) {
118 qx/unzip $tempfile -d $dirname/;
120 unless ( $exit_code == 0 ) {
121 $errors{'UZIPFAIL'} = $uploadfilename;
122 $template->param( ERRORS => [ \%errors ] );
123 # This error is fatal to the import, so bail out here
124 output_html_with_http_headers $input, $cookie, $template->output;
127 push @directories, "$dirname";
128 foreach my $recursive_dir (@directories) {
129 opendir RECDIR, $recursive_dir;
130 while ( my $entry = readdir RECDIR ) {
131 push @directories, "$recursive_dir/$entry"
132 if ( -d "$recursive_dir/$entry" and $entry !~ /^\./ );
136 foreach my $dir (@directories) {
137 $results = handle_dir( $dir, $filesuffix, $template );
138 $handled++ if $results == 1;
140 $total = scalar @directories;
143 #if ($filetype eq 'zip' )
144 $results = handle_dir( $dirname, $filesuffix, $template, $cardnumber,
146 $handled++ if $results == 1;
150 if ( $results!=1 || %errors ) {
151 $template->param( ERRORS => [$results] );
155 map { $filecount += $_->{count} } @counts;
156 $logger->debug("Total directories processed: $total");
157 $logger->debug("Total files processed: $filecount");
162 TCOUNTS => ( $filecount > 0 ? $filecount : undef ),
164 $template->param( borrowernumber => $borrowernumber )
168 elsif ( ( $op eq 'Upload' ) && !$uploadfile ) {
169 warn "Problem uploading file or no file uploaded.";
170 $template->param( cardnumber => $cardnumber );
171 $template->param( filetype => $filetype );
173 elsif ( $op eq 'Delete' ) {
174 output_and_exit( $input, $cookie, $template, 'wrong_csrf_token' )
175 unless Koha::Token->new->check_csrf({
176 session_id => scalar $input->cookie('CGISESSID'),
177 token => scalar $input->param('csrf_token'),
181 Koha::Patron::Images->find( $borrowernumber )->delete;
183 if ( $@ or not $deleted ) {
184 warn "Image for patron '$borrowernumber' has not been deleted";
187 if ( $borrowernumber && !%errors && !$template->param('ERRORS') ) {
188 print $input->redirect(
189 "/cgi-bin/koha/members/moremember.pl?borrowernumber=$borrowernumber");
193 csrf_token => Koha::Token->new->generate_csrf({
194 session_id => scalar $input->cookie('CGISESSID'),
197 output_html_with_http_headers $input, $cookie, $template->output;
201 my ( $dir, $suffix, $template, $cardnumber, $source ) = @_;
202 my ( %counts, %direrrors );
203 $logger->debug("Entering sub handle_dir; passed \$dir=$dir, \$suffix=$suffix");
204 if ( $suffix =~ m/zip/i ) {
205 # If we were sent a zip file, process any included data/idlink.txt files
206 my ( $file, $filename );
208 $logger->debug("Passed a zip file.");
210 while ( my $filename = readdir DIR ) {
211 $file = "$dir/$filename"
212 if ( $filename =~ m/datalink\.txt/i
213 || $filename =~ m/idlink\.txt/i );
216 unless ( open( $fh, '<', $file ) ) {
217 warn "Opening $dir/$file failed!";
218 $direrrors{'OPNLINK'} = $file;
219 # This error is fatal to the import of this directory contents
220 # so bail and return the error to the caller
224 while ( my $line = <$fh> ) {
225 $logger->debug("Reading contents of $file");
227 $logger->debug("Examining line: $line");
228 my $delim = ( $line =~ /\t/ ) ? "\t" : ( $line =~ /,/ ) ? "," : "";
229 $logger->debug("Delimeter is \'$delim\'");
230 unless ( $delim eq "," || $delim eq "\t" ) {
231 warn "Unrecognized or missing field delimeter. Please verify that you are using either a ',' or a 'tab'";
232 $direrrors{'DELERR'} = 1;
233 # This error is fatal to the import of this directory contents
234 # so bail and return the error to the caller
237 ( $cardnumber, $filename ) = split $delim, $line;
238 $cardnumber =~ s/[\"\r\n]//g; # remove offensive characters
239 $filename =~ s/[\"\r\n\s]//g;
240 $logger->debug("Cardnumber: $cardnumber Filename: $filename");
241 $source = "$dir/$filename";
242 %counts = handle_file( $cardnumber, $source, $template, %counts );
248 %counts = handle_file( $cardnumber, $source, $template, %counts );
250 push @counts, \%counts;
255 my ( $cardnumber, $source, $template, %count ) = @_;
256 $logger->debug("Entering sub handle_file; passed \$cardnumber=$cardnumber, \$source=$source");
257 $count{filenames} = () if !$count{filenames};
258 $count{source} = $source if !$count{source};
259 $count{count} = 0 unless exists $count{count};
262 if ( $filetype eq 'image' ) {
263 $filename = $uploadfilename;
266 $filename = $1 if ( $source && $source =~ /\/([^\/]+)$/ );
268 if ( $cardnumber && $source ) {
269 # Now process any imagefiles
270 $logger->debug("Source: $source");
271 my $size = ( stat($source) )[7];
272 if ( $size > 550000 ) {
273 # This check is necessary even with image resizing to avoid possible security/performance issues...
274 $filerrors{'OVRSIZ'} = 1;
275 push my @filerrors, \%filerrors;
276 push @{ $count{filenames} },
278 filerrors => \@filerrors,
280 cardnumber => $cardnumber
282 $template->param( ERRORS => 1 );
283 # this one is fatal so bail here...
286 my ( $srcimage, $image );
287 if ( open( my $fh, '<', $source ) ) {
288 $srcimage = GD::Image->new($fh);
290 if ( defined $srcimage ) {
292 my $mimetype = 'image/png';
293 # GD autodetects three basic image formats: PNG, JPEG, XPM
294 # we will convert all to PNG which is lossless...
295 # Check the pixel size of the image we are about to import...
296 my ( $width, $height ) = $srcimage->getBounds();
297 $logger->debug("$filename is $width pix X $height pix.");
298 if ( $width > 200 || $height > 300 ) {
299 # MAX pixel dims are 200 X 300...
300 $logger->debug("$filename exceeds the maximum pixel dimensions of 200 X 300. Resizing...");
301 # Percent we will reduce the image dimensions by...
303 if ( $width > 200 ) {
304 # If the width is oversize, scale based on width overage...
305 $percent_reduce = sprintf( "%.5f", ( 140 / $width ) );
308 # otherwise scale based on height overage.
309 $percent_reduce = sprintf( "%.5f", ( 200 / $height ) );
312 sprintf( "%.0f", ( $width * $percent_reduce ) );
314 sprintf( "%.0f", ( $height * $percent_reduce ) );
315 $logger->debug("Reducing $filename by "
316 . ( $percent_reduce * 100 )
317 . "\% or to $width_reduce pix X $height_reduce pix");
318 #'1' creates true color image...
319 $image = GD::Image->new( $width_reduce, $height_reduce, 1 );
320 $image->copyResampled( $srcimage, 0, 0, 0, 0, $width_reduce,
321 $height_reduce, $width, $height );
322 $imgfile = $image->png();
323 $logger->debug("$filename is "
325 . " bytes after resizing.");
327 undef $srcimage; # This object can get big...
331 $imgfile = $image->png();
332 $logger->debug("$filename is " . length($imgfile) . " bytes.");
334 undef $srcimage; # This object can get big...
336 $logger->debug("Image is of mimetype $mimetype");
338 my $patron = Koha::Patrons->find({ cardnumber => $cardnumber });
340 my $image = $patron->image;
341 $image ||= Koha::Patron::Image->new({ borrowernumber => $patron->borrowernumber });
343 mimetype => $mimetype,
344 imagefile => $imgfile,
346 eval { $image->store };
348 # Errors from here on are fatal only to the import of a particular image
349 #so don't bail, just note the error and keep going
350 warn "Database returned error: $@";
351 $filerrors{'DBERR'} = 1;
352 push my @filerrors, \%filerrors;
353 push @{ $count{filenames} },
355 filerrors => \@filerrors,
357 cardnumber => $cardnumber
359 $template->param( ERRORS => 1 );
362 push @{ $count{filenames} },
363 { source => $filename, cardnumber => $cardnumber };
366 warn "Patron with the cardnumber '$cardnumber' does not exist";
367 $filerrors{'CARDNUMBER_DOES_NOT_EXIST'} = 1;
368 push my @filerrors, \%filerrors;
369 push @{ $count{filenames} },
371 filerrors => \@filerrors,
373 cardnumber => $cardnumber
375 $template->param( ERRORS => 1 );
379 warn "Unable to determine mime type of $filename. Please verify mimetype.";
380 $filerrors{'MIMERR'} = 1;
381 push my @filerrors, \%filerrors;
382 push @{ $count{filenames} },
384 filerrors => \@filerrors,
386 cardnumber => $cardnumber
388 $template->param( ERRORS => 1 );
392 warn "Contents of $filename corrupted!";
394 $filerrors{'CORERR'} = 1;
395 push my @filerrors, \%filerrors;
396 push @{ $count{filenames} },
398 filerrors => \@filerrors,
400 cardnumber => $cardnumber
402 $template->param( ERRORS => 1 );
406 warn "Opening $source failed!";
407 $filerrors{'OPNERR'} = 1;
408 push my @filerrors, \%filerrors;
409 push @{ $count{filenames} },
411 filerrors => \@filerrors,
413 cardnumber => $cardnumber
415 $template->param( ERRORS => 1 );
419 # The need for this seems a bit unlikely, however, to maximize error trapping it is included
424 : ( $filename ? "cardnumber" : "cardnumber and filename" )
426 $filerrors{'CRDFIL'} = (
429 : ( $filename ? "cardnumber" : "cardnumber and filename" )
431 push my @filerrors, \%filerrors;
432 push @{ $count{filenames} },
434 filerrors => \@filerrors,
436 cardnumber => $cardnumber
438 $template->param( ERRORS => 1 );
445 Original contributor(s) undocumented
447 Database storage, single patronimage upload option, and extensive error trapping contributed by Chris Nighswonger cnighswonger <at> foundations <dot> edu
448 Image scaling/resizing contributed by the same.