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
31 my $DEBUG = ($ENV{DEBUG}) ? 1 : 0;
35 my ($template, $loggedinuser, $cookie)
36 = get_template_and_user({template_name => "tools/picture-upload.tmpl",
40 flagsrequired => {management => 1, tools => 1},
44 my $filetype = $input->param('filetype');
45 my $cardnumber = $input->param('cardnumber');
46 my $uploadfilename = $input->param('uploadfile');
47 my $uploadfile = $input->upload('uploadfile');
48 my $borrowernumber = $input->param('borrowernumber');
49 my $op = $input->param('op');
51 #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.
52 # Other parts of this code could be optimized as well, I think. Perhaps the file upload could be done with YUI's upload
55 warn "Params are: filetype=$filetype, cardnumber=$cardnumber, uploadfile=$uploadfilename" if $DEBUG;
59 picture-upload.p. - Script for handling uploading of both single and bulk patronimages and importing them into the database.
67 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.
71 warn "Operation requested: $op" if $DEBUG;
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 warn "dirname = $dirname" if $DEBUG;
78 my $filesuffix = $1 if $uploadfilename =~ m/(\..+)$/i;
79 ( $tfh, $tempfile ) = File::Temp::tempfile( SUFFIX => $filesuffix, UNLINK => 1 );
80 warn "tempfile = $tempfile" if $DEBUG;
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> ) {
95 if ( $filetype eq 'zip' ) {
96 unless (system("unzip $tempfile -d $dirname") == 0) {
97 $errors{'UZIPFAIL'} = $uploadfilename;
98 $template->param( ERRORS => [ \%errors ] );
99 output_html_with_http_headers $input, $cookie, $template->output; # This error is fatal to the import, so bail out here
102 push @directories, "$dirname";
103 foreach $recursive_dir ( @directories ) {
104 opendir $dir, $recursive_dir;
105 while ( my $entry = readdir $dir ) {
106 push @directories, "$recursive_dir/$entry" if ( -d "$recursive_dir/$entry" and $entry !~ /^\./ );
107 warn "$recursive_dir/$entry" if $DEBUG;
112 foreach my $dir ( @directories ) {
113 $results = handle_dir( $dir, $filesuffix );
114 $handled++ if $results == 1;
116 $total = scalar @directories;
117 } else { #if ($filetype eq 'zip' )
118 $result = handle_dir( $dirname, $filesuffix );
123 if ( %$results || %errors ) {
124 $template->param( ERRORS => [ \%$results ] );
126 warn "Total files processed: $total" if $DEBUG;
127 warn "Errors in \$errors." if $errors;
132 TCOUNTS => scalar(@counts),
136 } elsif ( ($op eq 'Upload') && !$uploadfile ) {
137 warn "Problem uploading file or no file uploaded.";
138 $template->param(cardnumber => $cardnumber);
139 $template->param(filetype => $filetype);
140 } elsif ( $op eq 'Delete' ) {
141 my $dberror = RmPatronImage($cardnumber);
142 warn "Database returned $dberror" if $dberror;
143 } elsif ( $op eq 'Cancel' ) {
144 print $input->redirect ("/cgi-bin/koha/tools/picture-upload.pl");
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 warn "Entering sub handle_dir; passed \$dir=$dir, \$suffix=$suffix" if $DEBUG;
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 warn "Passed a zip file." if $DEBUG;
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 warn "Reading contents of $file" if $DEBUG;
173 warn "Examining line: $line" if $DEBUG;
174 my $delim = ($line =~ /\t/) ? "\t" : ($line =~ /,/) ? "," : "";
175 warn "Delimeter is \'$delim\'" if $DEBUG;
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 warn "Cardnumber: $cardnumber Filename: $filename" if $DEBUG;
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 warn "Entering sub handle_file; passed \$cardnumber=$cardnumber, \$source=$source" if $DEBUG;
202 "gif" => "image/gif",
203 "jpg" => "image/jpeg",
204 "jpeg" => "image/jpeg",
207 $count{filenames} = () if !$count{filenames};
208 $count{source} = $source if !$count{source};
209 if ($cardnumber && $source) { # Now process any imagefiles
211 warn "Source: $source" if $DEBUG;
212 if (open (IMG, "$source")) {
213 #binmode (IMG); # Not sure if we need this or not -fbcit
218 if ($filetype eq 'image') {
219 $filename = $uploadfilename;
221 $filename = $1 if ($source =~ /\/([^\/]+)$/);
223 warn "$filename is " . length($imgfile) . " bytes";
224 if (length($imgfile) > 100000) {
225 warn "$filename is TOO BIG!!! I refuse to beleagur my database with that much data. Try reducing the pixel dimensions and I\'ll reconsider.";
226 $filerrors{'OVRSIZ'} = 1;
227 push my @filerrors, \%filerrors;
228 push @{ $count{filenames} }, { filerrors => \@filerrors, source => $filename, cardnumber => $cardnumber };
229 $template->param( ERRORS => 1 );
232 my $mimetype = $mimemap->{lc ($1)} if $filename =~ m/\.([^.]+)$/i;
233 warn "$filename is mimetype \"$mimetype\"" if $DEBUG;
234 my $dberror = PutPatronImage($cardnumber,$mimetype, $imgfile) if $mimetype;
236 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
238 push @{ $count{filenames} }, { source => $filename, cardnumber => $cardnumber };
239 } elsif ( $dberror ) {
240 warn "Database returned error: $dberror";
241 ($dberror =~ /patronimage_fk1/) ? $filerrors{'IMGEXISTS'} = 1 : $filerrors{'DBERR'} = 1;
242 push my @filerrors, \%filerrors;
243 push @{ $count{filenames} }, { filerrors => \@filerrors, source => $filename, cardnumber => $cardnumber };
244 $template->param( ERRORS => 1 );
245 } elsif ( !$mimetype ) {
246 warn "Unable to determine mime type of $filename. Please verify mimetype and add to \%mimemap if necessary.";
247 $filerrors{'MIMERR'} = 1;
248 push my @filerrors, \%filerrors;
249 push @{ $count{filenames} }, { filerrors => \@filerrors, source => $filename, cardnumber => $cardnumber };
250 $template->param( ERRORS => 1 );
253 warn "Opening $dir/$filename failed!";
254 $filerrors{'OPNERR'} = 1;
255 push my @filerrors, \%filerrors;
256 push @{ $count{filenames} }, { filerrors => \@filerrors, source => $filename, cardnumber => $cardnumber };
257 $template->param( ERRORS => 1 );
259 } else { # The need for this seems a bit unlikely, however, to maximize error trapping it is included
260 warn "Missing " . ($cardnumber ? "filename" : ($filename ? "cardnumber" : "cardnumber and filename"));
261 $filerrors{'CRDFIL'} = ($cardnumber ? "filename" : ($filename ? "cardnumber" : "cardnumber and filename"));
262 push my @filerrors, \%filerrors;
263 push @{ $count{filenames} }, { filerrors => \@filerrors, source => $filename, cardnumber => $cardnumber };
264 $template->param( ERRORS => 1 );
273 Original contributor(s) undocumented
275 Database storage, single patronimage upload option, and extensive error trapping contributed by Chris Nighswonger cnighswonger <at> foundations <dot> edu