patron attributes - batch import
[koha.git] / tools / picture-upload.pl
index d00092c..695adb3 100755 (executable)
 use File::Temp;
 use File::Copy;
 use CGI;
+use Image::Magick;
 use C4::Context;
 use C4::Auth;
 use C4::Output;
 use C4::Members;
+use C4::Debug;
 #use Data::Dumper;
 
-my $DEBUG = ($ENV{DEBUG}) ? 1 : 0;
-
 my $input = new CGI;
 
 my ($template, $loggedinuser, $cookie)
@@ -37,7 +37,7 @@ my ($template, $loggedinuser, $cookie)
                                        query => $input,
                                        type => "intranet",
                                        authnotrequired => 0,
-                                       flagsrequired => {management => 1, tools => 1},
+                                       flagsrequired => {management => 1, tools => 'batch_upload_patron_images'},
                                        debug => 0,
                                        });
 
@@ -45,12 +45,14 @@ my $filetype            = $input->param('filetype');
 my $cardnumber          = $input->param('cardnumber');
 my $uploadfilename      = $input->param('uploadfile');
 my $uploadfile          = $input->upload('uploadfile');
+my $borrowernumber      = $input->param('borrowernumber');
+my $op                  = $input->param('op');
 
 #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.
 #       Other parts of this code could be optimized as well, I think. Perhaps the file upload could be done with YUI's upload
 #       coded. -fbcit
 
-warn "Params are: filetype=$filetype, cardnumber=$cardnumber, uploadfile=$uploadfilename" if $DEBUG;
+$debug and warn "Params are: filetype=$filetype, cardnumber=$cardnumber, uploadfile=$uploadfilename";
 
 =head1 NAME
 
@@ -62,20 +64,21 @@ picture-upload.pl
 
 =head1 DESCRIPTION
 
-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.
+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.
+Files greater than 100K will be refused. Images should be 140x200 pixels. If they are larger they will be auto-resized to comply.
 
 =cut
 
-
+$debug and warn "Operation requested: $op";
 
 my ( $total, $handled, @counts, $tempfile, $tfh );
 
-if ( $uploadfile ) {
+if ( ($op eq 'Upload') && $uploadfile ) {       # Case is important in these operational values as the template must use case to be visually pleasing!
     my $dirname = File::Temp::tempdir( CLEANUP => 1);
-    warn "dirname = $dirname" if $DEBUG;
+    $debug and warn "dirname = $dirname";
     my $filesuffix = $1 if $uploadfilename =~ m/(\..+)$/i;
     ( $tfh, $tempfile ) = File::Temp::tempfile( SUFFIX => $filesuffix, UNLINK => 1 );
-    warn "tempfile = $tempfile" if $DEBUG;
+    $debug and warn "tempfile = $tempfile";
     my ( @directories, $errors );
 
     $errors{'NOTZIP'} = 1 if ( $uploadfilename !~ /\.zip$/i && $filetype =~ m/zip/i );
@@ -102,7 +105,7 @@ if ( $uploadfile ) {
                 opendir $dir, $recursive_dir;
                 while ( my $entry = readdir $dir ) {
                push @directories, "$recursive_dir/$entry" if ( -d "$recursive_dir/$entry" and $entry !~ /^\./ );
-                warn "$recursive_dir/$entry" if $DEBUG;
+                $debug and warn "$recursive_dir/$entry";
                 }   
                 closedir $dir;
             }       
@@ -113,7 +116,7 @@ if ( $uploadfile ) {
             }
             $total = scalar @directories;
         } else {       #if ($filetype eq 'zip' )
-            $result = handle_dir( $dirname, $filesuffix );
+            $results = handle_dir( $dirname, $filesuffix );
             $handled = 1;
             $total = 1;
         }
@@ -121,7 +124,7 @@ if ( $uploadfile ) {
         if ( %$results || %errors ) {
             $template->param( ERRORS => [ \%$results ] );
         } else {
-            warn "Total files processed: $total" if $DEBUG;
+            $debug and warn "Total files processed: $total";
             warn "Errors in \$errors." if $errors;
             $template->param(
                 TOTAL => $total,
@@ -131,17 +134,30 @@ if ( $uploadfile ) {
             );
         }   
     }
+} elsif ( ($op eq 'Upload') && !$uploadfile ) {
+    warn "Problem uploading file or no file uploaded.";
+    $template->param(cardnumber => $cardnumber);
+    $template->param(filetype => $filetype);
+} elsif ( $op eq 'Delete' ) {
+    my $dberror = RmPatronImage($cardnumber);
+    warn "Database returned $dberror" if $dberror;
+} elsif ( $op eq 'Cancel' ) {
+    print $input->redirect ("/cgi-bin/koha/tools/picture-upload.pl");
 }
 
-output_html_with_http_headers $input, $cookie, $template->output;
+if ( $borrowernumber && !$errors && !$template->param('ERRORS') ) {
+    print $input->redirect ("/cgi-bin/koha/members/moremember.pl?borrowernumber=$borrowernumber");
+} else {
+    output_html_with_http_headers $input, $cookie, $template->output;
+}
 
 sub handle_dir {
     my ( $dir, $suffix ) = @_;
     my $source;
-    warn "Entering sub handle_dir; passed \$dir=$dir, \$suffix=$suffix" if $DEBUG;
+    $debug and warn "Entering sub handle_dir; passed \$dir=$dir, \$suffix=$suffix";
     if ($suffix =~ m/zip/i) {     # If we were sent a zip file, process any included data/idlink.txt files 
         my ( $file, $filename, $cardnumber );
-        warn "Passed a zip file." if $DEBUG;
+        $debug and warn "Passed a zip file.";
         opendir my $dirhandle, $dir;
         while ( my $filename = readdir $dirhandle ) {
             $file = "$dir/$filename" if ($filename =~ m/datalink\.txt/i || $filename =~ m/idlink\.txt/i);
@@ -153,11 +169,11 @@ sub handle_dir {
         };
 
         while (my $line = <FILE>) {
-            warn "Reading contents of $file" if $DEBUG;
+            $debug and warn "Reading contents of $file";
            chomp $line;
-            warn "Examining line: $line" if $DEBUG;
+            $debug and warn "Examining line: $line";
            my $delim = ($line =~ /\t/) ? "\t" : ($line =~ /,/) ? "," : "";
-            warn "Delimeter is \'$delim\'" if $DEBUG;
+            $debug and warn "Delimeter is \'$delim\'";
             unless ( $delim eq "," || $delim eq "\t" ) {
                 warn "Unrecognized or missing field delimeter. Please verify that you are using either a ',' or a 'tab'";
                 $errors{'DELERR'} = 1;      # This error is fatal to the import of this directory contents, so bail and return the error to the caller
@@ -166,7 +182,7 @@ sub handle_dir {
            ($cardnumber, $filename) = split $delim, $line;
            $cardnumber =~ s/[\"\r\n]//g;  # remove offensive characters
            $filename   =~ s/[\"\r\n\s]//g;
-            warn "Cardnumber: $cardnumber Filename: $filename" if $DEBUG;
+            $debug and warn "Cardnumber: $cardnumber Filename: $filename";
             $source = "$dir/$filename";
             %counts = handle_file($cardnumber, $source, %counts);
         }
@@ -182,34 +198,59 @@ return 1;
 
 sub handle_file {
     my ($cardnumber, $source, %count) = @_;
-    warn "Entering sub handle_file; passed \$cardnumber=$cardnumber, \$source=$source" if $DEBUG;
-    my $mimemap = {
-        "gif"   => "image/gif",
-        "jpg"   => "image/jpeg",
-        "jpeg"  => "image/jpeg",
-        "png"   => "image/png"
-    };
+    $debug and warn "Entering sub handle_file; passed \$cardnumber=$cardnumber, \$source=$source";
     $count{filenames} = () if !$count{filenames};
     $count{source} = $source if !$count{source};
     if ($cardnumber && $source) {     # Now process any imagefiles
         my %filerrors;
-        warn "Source: $source" if $DEBUG;
-        if (open (IMG, "$source")) {
-            #binmode (IMG); # Not sure if we need this or not -fbcit
-            my $imgfile;
-            while (<IMG>) {
-                $imgfile .= $_;
+        my $filename;
+        if ($filetype eq 'image') {
+            $filename = $uploadfilename;
+        } else {
+            $filename = $1 if ($source =~ /\/([^\/]+)$/);
+        }
+        $debug and warn "Source: $source";
+        my $size = (stat($source))[7];
+            if ($size > 100000) {    # This check is necessary even with image resizing to avoid possible security/performance issues...
+                warn "$filename is TOO BIG!!! I refuse to beleagur my database with that much data. Try reducing the pixel dimensions and I\'ll reconsider.";
+                $filerrors{'OVRSIZ'} = 1;
+                push my @filerrors, \%filerrors;
+                push @{ $count{filenames} }, { filerrors => \@filerrors, source => $filename, cardnumber => $cardnumber };
+                $template->param( ERRORS => 1 );
+                return %count;    # this one is fatal so bail here...
             }
-            if ($filetype eq 'image') {
-                $filename = $uploadfilename;
+        my $image = Image::Magick->new;
+        if (open (IMG, "$source")) {
+            $image->Read(file=>\*IMG);
+            close (IMG);
+            my $mimetype = $image->Get('mime');
+            # Check the pixel size of the image we are about to import...
+            my ($height, $width) = $image->Get('height', 'width');
+            $debug and warn "$filename is $width pix X $height pix.";
+            if ($width > 140 || $height > 200) {    # MAX pixel dims are 140 X 200...
+                warn "$filename exceeds the maximum pixel dimensions of 140 X 200. Resizing...";
+                my $percent_reduce;    # Percent we will reduce the image dimensions by...
+                if ($width > 140) {
+                    $percent_reduce = sprintf("%.5f",(140/$width));    # If the width is oversize, scale based on width overage...
+                } else {
+                    $percent_reduce = sprintf("%.5f",(200/$height));    # otherwise scale based on height overage.
+                }
+                my $width_reduce = sprintf("%.0f", ($width * $percent_reduce));
+                my $height_reduce = sprintf("%.0f", ($height * $percent_reduce));
+                warn "Reducing $filename by " . ($percent_reduce * 100) . "\% or to $width_reduce pix X $height_reduce pix";
+                $image->Resize(width=>$width_reduce, height=>$height_reduce);
+                my @img = $image->ImageToBlob();
+                $imgfile = $img[0];
+                warn "$filename is " . length($imgfile) . " bytes after resizing.";
+                undef $image;    # This object can get big...
             } else {
-                $filename = $1 if ($source =~ /\/([^\/]+)$/);
+                my @img = $image->ImageToBlob();
+                $imgfile = $img[0];
+                $debug and warn "$filename is " . length($imgfile) . " bytes.";
+                undef $image;
             }
-            warn "\$filename=$filename";
-            my $mimetype = $mimemap->{lc ($1)} if $filename =~ m/\.([^.]+)$/i;
-            warn "$filename is mimetype \"$mimetype\"" if $DEBUG;
+            $debug and warn "Image is of mimetype $mimetype";
             my $dberror = PutPatronImage($cardnumber,$mimetype, $imgfile) if $mimetype;
-            close (IMG);
            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
                $count{count}++;
                push @{ $count{filenames} }, { source => $filename, cardnumber => $cardnumber };
@@ -250,5 +291,6 @@ sub handle_file {
 Original contributor(s) undocumented
 
 Database storage, single patronimage upload option, and extensive error trapping contributed by Chris Nighswonger cnighswonger <at> foundations <dot> edu
+Image scaling/resizing contributed by the same.
 
 =cut