tools/picture-upload.pl

   1 #!/usr/bin/perl
   2 #
   3 #
   4 # This file is part of Koha.
   5 #
   6 # Koha is free software; you can redistribute it and/or modify it under the
   7 # terms of the GNU General Public License as published by the Free Software
   8 # Foundation; either version 2 of the License, or (at your option) any later
   9 # version.
  10 #
  11 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  12 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  13 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License along with
  16 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
  17 # Suite 330, Boston, MA  02111-1307 USA
  18 #
  19 #
  20 #
  21
  22 #use strict;
  23 #use warnings; FIXME - Bug 2505
  24
  25 use File::Temp;
  26 use File::Copy;
  27 use CGI;
  28 use GD;
  29 use C4::Context;
  30 use C4::Auth;
  31 use C4::Output;
  32 use C4::Members;
  33 use C4::Debug;
  34
  35 my $input = new CGI;
  36
  37 my ($template, $loggedinuser, $cookie)
  38         = get_template_and_user({template_name => "tools/picture-upload.tmpl",
  39                                         query => $input,
  40                                         type => "intranet",
  41                                         authnotrequired => 0,
  42                                         flagsrequired => { tools => 'batch_upload_patron_images'},
  43                                         debug => 0,
  44                                         });
  45
  46 my $filetype            = $input->param('filetype');
  47 my $cardnumber          = $input->param('cardnumber');
  48 my $uploadfilename      = $input->param('uploadfile');
  49 my $uploadfile          = $input->upload('uploadfile');
  50 my $borrowernumber      = $input->param('borrowernumber');
  51 my $op                  = $input->param('op');
  52
  53 #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.
  54 #       Other parts of this code could be optimized as well, I think. Perhaps the file upload could be done with YUI's upload
  55 #       coded. -fbcit
  56
  57 $debug and warn "Params are: filetype=$filetype, cardnumber=$cardnumber, borrowernumber=$borrowernumber, uploadfile=$uploadfilename";
  58
  59 =head1 NAME
  60
  61 picture-upload.pl - Script for handling uploading of both single and bulk patronimages and importing them into the database.
  62
  63 =head1 SYNOPSIS
  64
  65 picture-upload.pl
  66
  67 =head1 DESCRIPTION
  68
  69 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.
  70 Files greater than 100K will be refused. Images should be 140x200 pixels. If they are larger they will be auto-resized to comply.
  71
  72 =cut
  73
  74 $debug and warn "Operation requested: $op";
  75
  76 my ( $total, $handled, @counts, $tempfile, $tfh );
  77
  78 if ( ($op eq 'Upload') && $uploadfile ) {       # Case is important in these operational values as the template must use case to be visually pleasing!
  79     my $dirname = File::Temp::tempdir( CLEANUP => 1);
  80     $debug and warn "dirname = $dirname";
  81     my $filesuffix;
  82     if ( $uploadfilename =~ m/(\..+)$/i ) {
  83         $filesuffix = $1;
  84     }
  85     ( $tfh, $tempfile ) = File::Temp::tempfile( SUFFIX => $filesuffix, UNLINK => 1 );
  86     $debug and warn "tempfile = $tempfile";
  87     my ( @directories, $errors );
  88
  89     $errors{'NOTZIP'} = 1 if ( $uploadfilename !~ /\.zip$/i && $filetype =~ m/zip/i );
  90     $errors{'NOWRITETEMP'} = 1 unless ( -w $dirname );
  91     $errors{'EMPTYUPLOAD'} = 1 unless ( length( $uploadfile ) > 0 );
  92
  93     if ( %errors ) {
  94         $template->param( ERRORS => [ \%errors ] );
  95     } else {
  96         while ( <$uploadfile> ) {
  97             print $tfh $_;
  98         }
  99         close $tfh;
 100         if ( $filetype eq 'zip' ) {
 101             unless (system("unzip", $tempfile,  '-d', $dirname) == 0) {
 102                 $errors{'UZIPFAIL'} = $uploadfilename;
 103                 $template->param( ERRORS => [ \%errors ] );
 104                 output_html_with_http_headers $input, $cookie, $template->output;   # This error is fatal to the import, so bail out here
 105                 exit;
 106             }
 107             push @directories, "$dirname";
 108             foreach $recursive_dir ( @directories ) {
 109                 opendir $dir, $recursive_dir;
 110                 while ( my $entry = readdir $dir ) {
 111                 push @directories, "$recursive_dir/$entry" if ( -d "$recursive_dir/$entry" and $entry !~ /^\./ );
 112                 $debug and warn "$recursive_dir/$entry";
 113                 }
 114                 closedir $dir;
 115             }
 116             my $results;
 117             foreach my $dir ( @directories ) {
 118                 $results = handle_dir( $dir, $filesuffix, $template );
 119                 $handled++ if $results == 1;
 120             }
 121             $total = scalar @directories;
 122         } else {       #if ($filetype eq 'zip' )
 123             $results = handle_dir( $dirname, $filesuffix, $template, $cardnumber, $tempfile );
 124             $handled = 1;
 125             $total = 1;
 126         }
 127
 128         if ( %$results || %errors ) {
 129             $template->param( ERRORS => [ \%$results ] );
 130         } else {
 131                         my $filecount;
 132                         map {$filecount += $_->{count}} @counts;
 133             $debug and warn "Total directories processed: $total";
 134             $debug and warn "Total files processed: $filecount";
 135             $template->param(
 136                         TOTAL => $total,
 137                         HANDLED => $handled,
 138                         COUNTS => \@counts,
 139                         TCOUNTS => ($filecount > 0 ? $filecount : undef),
 140             );
 141                         $template->param( borrowernumber => $borrowernumber ) if $borrowernumber;
 142         }
 143     }
 144 } elsif ( ($op eq 'Upload') && !$uploadfile ) {
 145     warn "Problem uploading file or no file uploaded.";
 146     $template->param(cardnumber => $cardnumber);
 147     $template->param(filetype => $filetype);
 148 } elsif ( $op eq 'Delete' ) {
 149     my $dberror = RmPatronImage($cardnumber);
 150         $debug and warn "Patron image deleted for $cardnumber";
 151     warn "Database returned $dberror" if $dberror;
 152 }
 153 if ( $borrowernumber && !$errors && !$template->param('ERRORS') ) {
 154     print $input->redirect ("/cgi-bin/koha/members/moremember.pl?borrowernumber=$borrowernumber");
 155 } else {
 156     output_html_with_http_headers $input, $cookie, $template->output;
 157 }
 158
 159 sub handle_dir {
 160     my ( $dir, $suffix, $template, $cardnumber, $source ) = @_;
 161     $debug and warn "Entering sub handle_dir; passed \$dir=$dir, \$suffix=$suffix";
 162     if ($suffix =~ m/zip/i) {     # If we were sent a zip file, process any included data/idlink.txt files
 163         my ( $file, $filename );
 164         undef $cardnumber;
 165         $debug and warn "Passed a zip file.";
 166         opendir my $dirhandle, $dir;
 167         while ( my $filename = readdir $dirhandle ) {
 168             $file = "$dir/$filename" if ($filename =~ m/datalink\.txt/i || $filename =~ m/idlink\.txt/i);
 169         }
 170         unless (open (FILE, $file)) {
 171                 warn "Opening $dir/$file failed!";
 172                 $errors{'OPNLINK'} = $file;
 173                 return $errors; # This error is fatal to the import of this directory contents, so bail and return the error to the caller
 174         };
 175
 176         while (my $line = <FILE>) {
 177             $debug and warn "Reading contents of $file";
 178             chomp $line;
 179             $debug and warn "Examining line: $line";
 180             my $delim = ($line =~ /\t/) ? "\t" : ($line =~ /,/) ? "," : "";
 181             $debug and warn "Delimeter is \'$delim\'";
 182             unless ( $delim eq "," || $delim eq "\t" ) {
 183                 warn "Unrecognized or missing field delimeter. Please verify that you are using either a ',' or a 'tab'";
 184                 $errors{'DELERR'} = 1;      # This error is fatal to the import of this directory contents, so bail and return the error to the caller
 185                 return $errors;
 186             }
 187             ($cardnumber, $filename) = split $delim, $line;
 188             $cardnumber =~ s/[\"\r\n]//g;  # remove offensive characters
 189             $filename   =~ s/[\"\r\n\s]//g;
 190             $debug and warn "Cardnumber: $cardnumber Filename: $filename";
 191             $source = "$dir/$filename";
 192             %counts = handle_file($cardnumber, $source, $template, %counts);
 193         }
 194         close FILE;
 195         closedir ($dirhandle);
 196     } else {
 197         %counts = handle_file($cardnumber, $source, $template, %counts);
 198     }
 199 push @counts, \%counts;
 200 return 1;
 201 }
 202
 203 sub handle_file {
 204     my ($cardnumber, $source, $template, %count) = @_;
 205     $debug and warn "Entering sub handle_file; passed \$cardnumber=$cardnumber, \$source=$source";
 206     $count{filenames} = () if !$count{filenames};
 207     $count{source} = $source if !$count{source};
 208     if ($cardnumber && $source) {     # Now process any imagefiles
 209         my %filerrors;
 210         my $filename;
 211         if ($filetype eq 'image') {
 212             $filename = $uploadfilename;
 213         } else {
 214             $filename = $1 if ($source =~ /\/([^\/]+)$/);
 215         }
 216         $debug and warn "Source: $source";
 217         my $size = (stat($source))[7];
 218             if ($size > 550000) {    # This check is necessary even with image resizing to avoid possible security/performance issues...
 219                 $filerrors{'OVRSIZ'} = 1;
 220                 push my @filerrors, \%filerrors;
 221                 push @{ $count{filenames} }, { filerrors => \@filerrors, source => $filename, cardnumber => $cardnumber };
 222                 $template->param( ERRORS => 1 );
 223                 return %count;    # this one is fatal so bail here...
 224             }
 225         my ($srcimage, $image);
 226         if (open (IMG, "$source")) {
 227             $srcimage = GD::Image->new(*IMG);
 228             close (IMG);
 229                         if (defined $srcimage) {
 230                                 my $mimetype = 'image/png';     # GD autodetects three basic image formats: PNG, JPEG, XPM; we will convert all to PNG which is lossless...
 231                                 # Check the pixel size of the image we are about to import...
 232                                 my ($width, $height) = $srcimage->getBounds();
 233                                 $debug and warn "$filename is $width pix X $height pix.";
 234                                 if ($width > 200 || $height > 300) {    # MAX pixel dims are 200 X 300...
 235                                         $debug and warn "$filename exceeds the maximum pixel dimensions of 200 X 300. Resizing...";
 236                                         my $percent_reduce;    # Percent we will reduce the image dimensions by...
 237                                         if ($width > 200) {
 238                                                 $percent_reduce = sprintf("%.5f",(140/$width));    # If the width is oversize, scale based on width overage...
 239                                         } else {
 240                                                 $percent_reduce = sprintf("%.5f",(200/$height));    # otherwise scale based on height overage.
 241                                         }
 242                                         my $width_reduce = sprintf("%.0f", ($width * $percent_reduce));
 243                                         my $height_reduce = sprintf("%.0f", ($height * $percent_reduce));
 244                                         $debug and warn "Reducing $filename by " . ($percent_reduce * 100) . "\% or to $width_reduce pix X $height_reduce pix";
 245                                         $image = GD::Image->new($width_reduce, $height_reduce, 1); #'1' creates true color image...
 246                                         $image->copyResampled($srcimage,0,0,0,0,$width_reduce,$height_reduce,$width,$height);
 247                                         $imgfile = $image->png();
 248                                         $debug and warn "$filename is " . length($imgfile) . " bytes after resizing.";
 249                                         undef $image;
 250                                         undef $srcimage;    # This object can get big...
 251                                 } else {
 252                                         $image = $srcimage;
 253                                         $imgfile = $image->png();
 254                                         $debug and warn "$filename is " . length($imgfile) . " bytes.";
 255                                         undef $image;
 256                                         undef $srcimage;    # This object can get big...
 257                                 }
 258                                 $debug and warn "Image is of mimetype $mimetype";
 259                 my $dberror;
 260                 if ($mimetype) {
 261                     $dberror = PutPatronImage( $cardnumber, $mimetype, $imgfile );
 262                 }
 263                 if ( !$dberror && $mimetype ) { # Errors from here on are fatal only to the import of a particular image, so don't bail, just note the error and keep going
 264                                         $count{count}++;
 265                                         push @{ $count{filenames} }, { source => $filename, cardnumber => $cardnumber };
 266                                 } elsif ( $dberror ) {
 267                                                 warn "Database returned error: $dberror";
 268                                                 ($dberror =~ /patronimage_fk1/) ? $filerrors{'IMGEXISTS'} = 1 : $filerrors{'DBERR'} = 1;
 269                                                 push my @filerrors, \%filerrors;
 270                                                 push @{ $count{filenames} }, { filerrors => \@filerrors, source => $filename, cardnumber => $cardnumber };
 271                                                 $template->param( ERRORS => 1 );
 272                                 } elsif ( !$mimetype ) {
 273                                         warn "Unable to determine mime type of $filename. Please verify mimetype.";
 274                                         $filerrors{'MIMERR'} = 1;
 275                                         push my @filerrors, \%filerrors;
 276                                         push @{ $count{filenames} }, { filerrors => \@filerrors, source => $filename, cardnumber => $cardnumber };
 277                                         $template->param( ERRORS => 1 );
 278                                 }
 279                         } else {
 280                                 warn "Contents of $filename corrupted!";
 281                         #       $count{count}--;
 282                                 $filerrors{'CORERR'} = 1;
 283                                 push my @filerrors, \%filerrors;
 284                                 push @{ $count{filenames} }, { filerrors => \@filerrors, source => $filename, cardnumber => $cardnumber };
 285                                 $template->param( ERRORS => 1 );
 286                         }
 287                 } else {
 288                         warn "Opening $dir/$filename failed!";
 289                         $filerrors{'OPNERR'} = 1;
 290                         push my @filerrors, \%filerrors;
 291                         push @{ $count{filenames} }, { filerrors => \@filerrors, source => $filename, cardnumber => $cardnumber };
 292                         $template->param( ERRORS => 1 );
 293                 }
 294     } else {    # The need for this seems a bit unlikely, however, to maximize error trapping it is included
 295         warn "Missing " . ($cardnumber ? "filename" : ($filename ? "cardnumber" : "cardnumber and filename"));
 296         $filerrors{'CRDFIL'} = ($cardnumber ? "filename" : ($filename ? "cardnumber" : "cardnumber and filename"));
 297         push my @filerrors, \%filerrors;
 298                 push @{ $count{filenames} }, { filerrors => \@filerrors, source => $filename, cardnumber => $cardnumber };
 299         $template->param( ERRORS => 1 );
 300     }
 301     return (%count);
 302 }
 303
 304 =head1 AUTHORS
 305
 306 Original contributor(s) undocumented
 307
 308 Database storage, single patronimage upload option, and extensive error trapping contributed by Chris Nighswonger cnighswonger <at> foundations <dot> edu
 309 Image scaling/resizing contributed by the same.
 310
 311 =cut