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');
49 #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.
50 # Other parts of this code could be optimized as well, I think. Perhaps the file upload could be done with YUI's upload
53 warn "Params are: filetype=$filetype, cardnumber=$cardnumber, uploadfile=$uploadfilename" if $DEBUG;
57 picture-upload.p. - Script for handling uploading of both single and bulk patronimages and importing them into the database.
65 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 my ( $total, $handled, @counts, $tempfile, $tfh );
74 my $dirname = File::Temp::tempdir( CLEANUP => 1);
75 warn "dirname = $dirname" if $DEBUG;
76 my $filesuffix = $1 if $uploadfilename =~ m/(\..+)$/i;
77 ( $tfh, $tempfile ) = File::Temp::tempfile( SUFFIX => $filesuffix, UNLINK => 1 );
78 warn "tempfile = $tempfile" if $DEBUG;
79 my ( @directories, $errors );
81 $errors{'NOTZIP'} = 1 if ( $uploadfilename !~ /\.zip$/i && $filetype =~ m/zip/i );
82 $errors{'NOWRITETEMP'} = 1 unless ( -w $dirname );
83 $errors{'EMPTYUPLOAD'} = 1 unless ( length( $uploadfile ) > 0 );
86 $template->param( ERRORS => [ \%errors ] );
88 while ( <$uploadfile> ) {
93 if ( $filetype eq 'zip' ) {
94 unless (system("unzip $tempfile -d $dirname") == 0) {
95 $errors{'UZIPFAIL'} = $uploadfilename;
96 $template->param( ERRORS => [ \%errors ] );
97 output_html_with_http_headers $input, $cookie, $template->output; # This error is fatal to the import, so bail out here
100 push @directories, "$dirname";
101 foreach $recursive_dir ( @directories ) {
102 opendir $dir, $recursive_dir;
103 while ( my $entry = readdir $dir ) {
104 push @directories, "$recursive_dir/$entry" if ( -d "$recursive_dir/$entry" and $entry !~ /^\./ );
105 warn "$recursive_dir/$entry" if $DEBUG;
110 foreach my $dir ( @directories ) {
111 $results = handle_dir( $dir, $filesuffix );
112 $handled++ if $results == 1;
114 $total = scalar @directories;
115 } else { #if ($filetype eq 'zip' )
116 $result = handle_dir( $dirname, $filesuffix );
121 if ( %$results || %errors ) {
122 $template->param( ERRORS => [ \%$results ] );
124 warn "Total files processed: $total" if $DEBUG;
125 warn "Errors in \$errors." if $errors;
130 TCOUNTS => scalar(@counts),
135 $template->param(cardnumber => $cardnumber );
136 $template->param(filetype => $filetype );
139 output_html_with_http_headers $input, $cookie, $template->output;
142 my ( $dir, $suffix ) = @_;
144 warn "Entering sub handle_dir; passed \$dir=$dir, \$suffix=$suffix" if $DEBUG;
145 if ($suffix =~ m/zip/i) { # If we were sent a zip file, process any included data/idlink.txt files
146 my ( $file, $filename, $cardnumber );
147 warn "Passed a zip file." if $DEBUG;
148 opendir my $dirhandle, $dir;
149 while ( my $filename = readdir $dirhandle ) {
150 $file = "$dir/$filename" if ($filename =~ m/datalink\.txt/i || $filename =~ m/idlink\.txt/i);
152 unless (open (FILE, $file)) {
153 warn "Opening $dir/$file failed!";
154 $errors{'OPNLINK'} = $file;
155 return $errors; # This error is fatal to the import of this directory contents, so bail and return the error to the caller
158 while (my $line = <FILE>) {
159 warn "Reading contents of $file" if $DEBUG;
161 warn "Examining line: $line" if $DEBUG;
162 my $delim = ($line =~ /\t/) ? "\t" : ($line =~ /,/) ? "," : "";
163 warn "Delimeter is \'$delim\'" if $DEBUG;
164 unless ( $delim eq "," || $delim eq "\t" ) {
165 warn "Unrecognized or missing field delimeter. Please verify that you are using either a ',' or a 'tab'";
166 $errors{'DELERR'} = 1; # This error is fatal to the import of this directory contents, so bail and return the error to the caller
169 ($cardnumber, $filename) = split $delim, $line;
170 $cardnumber =~ s/[\"\r\n]//g; # remove offensive characters
171 $filename =~ s/[\"\r\n\s]//g;
172 warn "Cardnumber: $cardnumber Filename: $filename" if $DEBUG;
173 $source = "$dir/$filename";
174 %counts = handle_file($cardnumber, $source, %counts);
177 closedir ($dirhandle);
180 %counts = handle_file($cardnumber, $source, %counts);
182 push @counts, \%counts;
187 my ($cardnumber, $source, %count) = @_;
188 warn "Entering sub handle_file; passed \$cardnumber=$cardnumber, \$source=$source" if $DEBUG;
190 "gif" => "image/gif",
191 "jpg" => "image/jpeg",
192 "jpeg" => "image/jpeg",
195 $count{filenames} = () if !$count{filenames};
196 $count{source} = $source if !$count{source};
197 if ($cardnumber && $source) { # Now process any imagefiles
199 warn "Source: $source" if $DEBUG;
200 if (open (IMG, "$source")) {
201 #binmode (IMG); # Not sure if we need this or not -fbcit
206 if ($filetype eq 'image') {
207 $filename = $uploadfilename;
209 $filename = $1 if ($source =~ /\/([^\/]+)$/);
211 warn "\$filename=$filename";
212 my $mimetype = $mimemap->{lc ($1)} if $filename =~ m/\.([^.]+)$/i;
213 warn "$filename is mimetype \"$mimetype\"" if $DEBUG;
214 my $dberror = PutPatronImage($cardnumber,$mimetype, $imgfile) if $mimetype;
216 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
218 push @{ $count{filenames} }, { source => $filename, cardnumber => $cardnumber };
219 } elsif ( $dberror ) {
220 warn "Database returned error: $dberror";
221 ($dberror =~ /patronimage_fk1/) ? $filerrors{'IMGEXISTS'} = 1 : $filerrors{'DBERR'} = 1;
222 push my @filerrors, \%filerrors;
223 push @{ $count{filenames} }, { filerrors => \@filerrors, source => $filename, cardnumber => $cardnumber };
224 $template->param( ERRORS => 1 );
225 } elsif ( !$mimetype ) {
226 warn "Unable to determine mime type of $filename. Please verify mimetype and add to \%mimemap if necessary.";
227 $filerrors{'MIMERR'} = 1;
228 push my @filerrors, \%filerrors;
229 push @{ $count{filenames} }, { filerrors => \@filerrors, source => $filename, cardnumber => $cardnumber };
230 $template->param( ERRORS => 1 );
233 warn "Opening $dir/$filename failed!";
234 $filerrors{'OPNERR'} = 1;
235 push my @filerrors, \%filerrors;
236 push @{ $count{filenames} }, { filerrors => \@filerrors, source => $filename, cardnumber => $cardnumber };
237 $template->param( ERRORS => 1 );
239 } else { # The need for this seems a bit unlikely, however, to maximize error trapping it is included
240 warn "Missing " . ($cardnumber ? "filename" : ($filename ? "cardnumber" : "cardnumber and filename"));
241 $filerrors{'CRDFIL'} = ($cardnumber ? "filename" : ($filename ? "cardnumber" : "cardnumber and filename"));
242 push my @filerrors, \%filerrors;
243 push @{ $count{filenames} }, { filerrors => \@filerrors, source => $filename, cardnumber => $cardnumber };
244 $template->param( ERRORS => 1 );
253 Original contributor(s) undocumented
255 Database storage, single patronimage upload option, and extensive error trapping contributed by Chris Nighswonger cnighswonger <at> foundations <dot> edu