4 # This file is part of Koha.
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
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.
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
34 my ($template, $loggedinuser, $cookie)
35 = get_template_and_user
({template_name
=> "tools/picture-upload.tmpl",
39 flagsrequired
=> { tools
=> 'batch_upload_patron_images'},
43 my $filetype = $input->param('filetype');
44 my $cardnumber = $input->param('cardnumber');
45 my $uploadfilename = $input->param('uploadfile');
46 my $uploadfile = $input->upload('uploadfile');
47 my $borrowernumber = $input->param('borrowernumber');
48 my $op = $input->param('op');
50 #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.
51 # Other parts of this code could be optimized as well, I think. Perhaps the file upload could be done with YUI's upload
54 $debug and warn "Params are: filetype=$filetype, cardnumber=$cardnumber, borrowernumber=$borrowernumber, uploadfile=$uploadfilename";
58 picture-upload.p. - Script for handling uploading of both single and bulk patronimages and importing them into the database.
66 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.
67 Files greater than 100K will be refused. Images should be 140x200 pixels. If they are larger they will be auto-resized to comply.
71 $debug and warn "Operation requested: $op";
73 my ( $total, $handled, @counts, $tempfile, $tfh );
75 if ( ($op eq 'Upload') && $uploadfile ) { # Case is important in these operational values as the template must use case to be visually pleasing!
76 my $dirname = File
::Temp
::tempdir
( CLEANUP
=> 1);
77 $debug and warn "dirname = $dirname";
78 my $filesuffix = $1 if $uploadfilename =~ m/(\..+)$/i;
79 ( $tfh, $tempfile ) = File
::Temp
::tempfile
( SUFFIX
=> $filesuffix, UNLINK
=> 1 );
80 $debug and warn "tempfile = $tempfile";
81 my ( @directories, $errors );
83 $errors{'NOTZIP'} = 1 if ( $uploadfilename !~ /\.zip$/i && $filetype =~ m/zip/i );
84 $errors{'NOWRITETEMP'} = 1 unless ( -w
$dirname );
85 $errors{'EMPTYUPLOAD'} = 1 unless ( length( $uploadfile ) > 0 );
88 $template->param( ERRORS
=> [ \
%errors ] );
90 while ( <$uploadfile> ) {
94 if ( $filetype eq 'zip' ) {
95 unless (system("unzip $tempfile -d $dirname") == 0) {
96 $errors{'UZIPFAIL'} = $uploadfilename;
97 $template->param( ERRORS
=> [ \
%errors ] );
98 output_html_with_http_headers
$input, $cookie, $template->output; # This error is fatal to the import, so bail out here
101 push @directories, "$dirname";
102 foreach $recursive_dir ( @directories ) {
103 opendir $dir, $recursive_dir;
104 while ( my $entry = readdir $dir ) {
105 push @directories, "$recursive_dir/$entry" if ( -d
"$recursive_dir/$entry" and $entry !~ /^\./ );
106 $debug and warn "$recursive_dir/$entry";
111 foreach my $dir ( @directories ) {
112 $results = handle_dir
( $dir, $filesuffix );
113 $handled++ if $results == 1;
115 $total = scalar @directories;
116 } else { #if ($filetype eq 'zip' )
117 $results = handle_dir
( $dirname, $filesuffix );
122 if ( %$results || %errors ) {
123 $template->param( ERRORS
=> [ \
%$results ] );
126 map {$filecount += $_->{count
}} @counts;
127 $debug and warn "Total directories processed: $total";
128 $debug and warn "Total files processed: $filecount";
133 TCOUNTS
=> ($filecount > 0 ?
$filecount : undef),
135 $template->param( borrowernumber
=> $borrowernumber ) if $borrowernumber;
138 } elsif ( ($op eq 'Upload') && !$uploadfile ) {
139 warn "Problem uploading file or no file uploaded.";
140 $template->param(cardnumber
=> $cardnumber);
141 $template->param(filetype
=> $filetype);
142 } elsif ( $op eq 'Delete' ) {
143 my $dberror = RmPatronImage
($cardnumber);
144 $debug and warn "Patron image deleted for $cardnumber";
145 warn "Database returned $dberror" if $dberror;
147 if ( $borrowernumber && !$errors && !$template->param('ERRORS') ) {
148 print $input->redirect ("/cgi-bin/koha/members/moremember.pl?borrowernumber=$borrowernumber");
150 output_html_with_http_headers
$input, $cookie, $template->output;
154 my ( $dir, $suffix ) = @_;
156 $debug and warn "Entering sub handle_dir; passed \$dir=$dir, \$suffix=$suffix";
157 if ($suffix =~ m/zip/i) { # If we were sent a zip file, process any included data/idlink.txt files
158 my ( $file, $filename, $cardnumber );
159 $debug and warn "Passed a zip file.";
160 opendir my $dirhandle, $dir;
161 while ( my $filename = readdir $dirhandle ) {
162 $file = "$dir/$filename" if ($filename =~ m
/datalink\
.txt
/i || $filename =~ m/idlink\
.txt
/i
);
164 unless (open (FILE
, $file)) {
165 warn "Opening $dir/$file failed!";
166 $errors{'OPNLINK'} = $file;
167 return $errors; # This error is fatal to the import of this directory contents, so bail and return the error to the caller
170 while (my $line = <FILE
>) {
171 $debug and warn "Reading contents of $file";
173 $debug and warn "Examining line: $line";
174 my $delim = ($line =~ /\t/) ?
"\t" : ($line =~ /,/) ?
"," : "";
175 $debug and warn "Delimeter is \'$delim\'";
176 unless ( $delim eq "," || $delim eq "\t" ) {
177 warn "Unrecognized or missing field delimeter. Please verify that you are using either a ',' or a 'tab'";
178 $errors{'DELERR'} = 1; # This error is fatal to the import of this directory contents, so bail and return the error to the caller
181 ($cardnumber, $filename) = split $delim, $line;
182 $cardnumber =~ s/[\"\r\n]//g; # remove offensive characters
183 $filename =~ s/[\"\r\n\s]//g;
184 $debug and warn "Cardnumber: $cardnumber Filename: $filename";
185 $source = "$dir/$filename";
186 %counts = handle_file
($cardnumber, $source, %counts);
189 closedir ($dirhandle);
192 %counts = handle_file
($cardnumber, $source, %counts);
194 push @counts, \
%counts;
199 my ($cardnumber, $source, %count) = @_;
200 $debug and warn "Entering sub handle_file; passed \$cardnumber=$cardnumber, \$source=$source";
201 $count{filenames
} = () if !$count{filenames
};
202 $count{source
} = $source if !$count{source
};
203 if ($cardnumber && $source) { # Now process any imagefiles
206 if ($filetype eq 'image') {
207 $filename = $uploadfilename;
209 $filename = $1 if ($source =~ /\/([^\
/]+)$/);
211 $debug and warn "Source: $source";
212 my $size = (stat($source))[7];
213 if ($size > 100000) { # This check is necessary even with image resizing to avoid possible security/performance issues...
214 $filerrors{'OVRSIZ'} = 1;
215 push my @filerrors, \
%filerrors;
216 push @
{ $count{filenames
} }, { filerrors
=> \
@filerrors, source
=> $filename, cardnumber
=> $cardnumber };
217 $template->param( ERRORS
=> 1 );
218 return %count; # this one is fatal so bail here...
220 my ($srcimage, $image);
221 if (open (IMG
, "$source")) {
222 $srcimage = GD
::Image
->new(*IMG
);
224 if (defined $srcimage) {
225 my $mimetype = 'image/jpeg'; # GD autodetects three basic image formats: PNG, JPEG, XPM; we will convert all to JPEG...
226 # Check the pixel size of the image we are about to import...
227 my ($width, $height) = $srcimage->getBounds();
228 $debug and warn "$filename is $width pix X $height pix.";
229 if ($width > 140 || $height > 200) { # MAX pixel dims are 140 X 200...
230 $debug and warn "$filename exceeds the maximum pixel dimensions of 140 X 200. Resizing...";
231 my $percent_reduce; # Percent we will reduce the image dimensions by...
233 $percent_reduce = sprintf("%.5f",(140/$width)); # If the width is oversize, scale based on width overage...
235 $percent_reduce = sprintf("%.5f",(200/$height)); # otherwise scale based on height overage.
237 my $width_reduce = sprintf("%.0f", ($width * $percent_reduce));
238 my $height_reduce = sprintf("%.0f", ($height * $percent_reduce));
239 $debug and warn "Reducing $filename by " . ($percent_reduce * 100) . "\% or to $width_reduce pix X $height_reduce pix";
240 $image = GD
::Image
->new($width_reduce, $height_reduce, 1); #'1' creates true color image...
241 $image->copyResampled($srcimage,0,0,0,0,$width_reduce,$height_reduce,$width,$height);
242 $imgfile = $image->jpeg(100);
243 $debug and warn "$filename is " . length($imgfile) . " bytes after resizing.";
245 undef $srcimage; # This object can get big...
248 $imgfile = $image->jpeg();
249 $debug and warn "$filename is " . length($imgfile) . " bytes.";
251 undef $srcimage; # This object can get big...
253 $debug and warn "Image is of mimetype $mimetype";
254 my $dberror = PutPatronImage
($cardnumber,$mimetype, $imgfile) if $mimetype;
255 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
257 push @
{ $count{filenames
} }, { source
=> $filename, cardnumber
=> $cardnumber };
258 } elsif ( $dberror ) {
259 warn "Database returned error: $dberror";
260 ($dberror =~ /patronimage_fk1/) ?
$filerrors{'IMGEXISTS'} = 1 : $filerrors{'DBERR'} = 1;
261 push my @filerrors, \
%filerrors;
262 push @
{ $count{filenames
} }, { filerrors
=> \
@filerrors, source
=> $filename, cardnumber
=> $cardnumber };
263 $template->param( ERRORS
=> 1 );
264 } elsif ( !$mimetype ) {
265 warn "Unable to determine mime type of $filename. Please verify mimetype.";
266 $filerrors{'MIMERR'} = 1;
267 push my @filerrors, \
%filerrors;
268 push @
{ $count{filenames
} }, { filerrors
=> \
@filerrors, source
=> $filename, cardnumber
=> $cardnumber };
269 $template->param( ERRORS
=> 1 );
272 warn "Contents of $filename corrupted!";
274 $filerrors{'CORERR'} = 1;
275 push my @filerrors, \
%filerrors;
276 push @
{ $count{filenames
} }, { filerrors
=> \
@filerrors, source
=> $filename, cardnumber
=> $cardnumber };
277 $template->param( ERRORS
=> 1 );
280 warn "Opening $dir/$filename failed!";
281 $filerrors{'OPNERR'} = 1;
282 push my @filerrors, \
%filerrors;
283 push @
{ $count{filenames
} }, { filerrors
=> \
@filerrors, source
=> $filename, cardnumber
=> $cardnumber };
284 $template->param( ERRORS
=> 1 );
286 } else { # The need for this seems a bit unlikely, however, to maximize error trapping it is included
287 warn "Missing " . ($cardnumber ?
"filename" : ($filename ?
"cardnumber" : "cardnumber and filename"));
288 $filerrors{'CRDFIL'} = ($cardnumber ?
"filename" : ($filename ?
"cardnumber" : "cardnumber and filename"));
289 push my @filerrors, \
%filerrors;
290 push @
{ $count{filenames
} }, { filerrors
=> \
@filerrors, source
=> $filename, cardnumber
=> $cardnumber };
291 $template->param( ERRORS
=> 1 );
300 Original contributor(s) undocumented
302 Database storage, single patronimage upload option, and extensive error trapping contributed by Chris Nighswonger cnighswonger <at> foundations <dot> edu
303 Image scaling/resizing contributed by the same.