root/main/trunk/greenstone2/perllib/plugins/ImageConverter.pm @ 22655

Revision 22655, 17.7 KB (checked in by mdewsnip, 10 years ago)

Removed some old (commented out) "[srclink]" code, as part of tidying up the dmsafe stuff.

  • Property svn:executable set to *
Line 
1###########################################################################
2#
3# ImageConverter - helper plugin that does image conversion using ImageMagick
4#
5# A component of the Greenstone digital library software
6# from the New Zealand Digital Library Project at the
7# University of Waikato, New Zealand.
8#
9# Copyright (C) 2008 New Zealand Digital Library Project
10#
11# This program is free software; you can redistribute it and/or modify
12# it under the terms of the GNU General Public License as published by
13# the Free Software Foundation; either version 2 of the License, or
14# (at your option) any later version.
15#
16# This program is distributed in the hope that it will be useful,
17# but WITHOUT ANY WARRANTY; without even the implied warranty of
18# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19# GNU General Public License for more details.
20#
21# You should have received a copy of the GNU General Public License
22# along with this program; if not, write to the Free Software
23# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24#
25###########################################################################
26package ImageConverter;
27
28use BaseMediaConverter;
29
30
31use strict;
32no strict 'refs'; # allow filehandles to be variables and viceversa
33
34use gsprintf 'gsprintf';
35
36BEGIN {
37    @ImageConverter::ISA = ('BaseMediaConverter');
38}
39
40my $arguments = [
41      { 'name' => "create_thumbnail",
42    'desc' => "{ImageConverter.create_thumbnail}",
43    'type' => "enum",
44    'list' => [{'name' => "true", 'desc' => "{common.true}"},
45           {'name' => "false", 'desc' => "{common.false}"}],
46    'deft' => "true",
47    'reqd' => "no" },
48      { 'name' => "thumbnailsize",
49    'desc' => "{ImageConverter.thumbnailsize}",
50    'type' => "int",
51    'deft' => "100",
52    'range' => "1,",
53    'reqd' => "no" },
54      { 'name' => "thumbnailtype",
55    'desc' => "{ImageConverter.thumbnailtype}",
56    'type' => "string",
57    'deft' => "gif",
58    'reqd' => "no" },
59      { 'name' => "noscaleup",
60    'desc' => "{ImageConverter.noscaleup}",
61    'type' => "flag",
62    'reqd' => "no" },
63      { 'name' => "create_screenview",
64    'desc' => "{ImageConverter.create_screenview}",
65    'type' => "enum",
66    'list' => [{'name' => "true", 'desc' => "{common.true}"},
67           {'name' => "false", 'desc' => "{common.false}"}],
68    'deft' => "true",
69    'reqd' => "no" },
70      { 'name' => "screenviewsize",
71    'desc' => "{ImageConverter.screenviewsize}",
72    'type' => "int",
73    'deft' => "500",
74    'range' => "1,",
75    'reqd' => "no" },
76      { 'name' => "screenviewtype",
77    'desc' => "{ImageConverter.screenviewtype}",
78    'type' => "string",
79    'deft' => "jpg",
80    'reqd' => "no" },
81      { 'name' => "converttotype",
82    'desc' => "{ImageConverter.converttotype}",
83    'type' => "string",
84    'deft' => "",
85    'reqd' => "no" },
86      { 'name' => "minimumsize",
87    'desc' => "{ImageConverter.minimumsize}",
88    'type' => "int",
89    'deft' => "100",
90    'range' => "1,",
91    'reqd' => "no" }
92         ];
93
94my $options = { 'name' => "ImageConverter",
95        'desc' => "{ImageConverter.desc}",
96        'abstract' => "yes",
97        'inherits' => "yes",
98        'args' => $arguments };
99
100sub new {
101    my ($class) = shift (@_);
102    my ($pluginlist,$inputargs,$hashArgOptLists) = @_;
103    push(@$pluginlist, $class);
104
105    push(@{$hashArgOptLists->{"ArgList"}},@{$arguments});
106    push(@{$hashArgOptLists->{"OptList"}},$options);
107
108    my $self = new BaseMediaConverter($pluginlist, $inputargs, $hashArgOptLists, 1);
109
110
111    return bless $self, $class;
112
113}
114
115# needs to be called after BasePlugin init, so that outhandle is set up.
116sub init {
117    my $self = shift(@_);
118
119    $self->{'tmp_file_paths'} = ();
120
121    # Check that ImageMagick is installed and available on the path
122    my $image_conversion_available = 1;
123    my $no_image_conversion_reason = "";
124    # None of this works very well on Windows 95/98...
125    if ($ENV{'GSDLOS'} eq "windows" && !Win32::IsWinNT()) {
126    $image_conversion_available = 0;
127    $no_image_conversion_reason = "win95notsupported";
128    } else {
129    my $result = `identify -help 2>&1`;
130    my $return_value = $?;
131    if ( ($ENV{'GSDLOS'} eq "windows" && $return_value == 256) || $return_value == -1) {  # Linux and Windows return different values for "program not found"
132        $image_conversion_available = 0;
133        $no_image_conversion_reason = "imagemagicknotinstalled";
134    }
135    }
136    $self->{'image_conversion_available'} = $image_conversion_available;
137    $self->{'no_image_conversion_reason'} = $no_image_conversion_reason;
138
139    if ($self->{'image_conversion_available'} == 0) {
140    my $outhandle = $self->{'outhandle'};
141    &gsprintf($outhandle, "ImageConverter: {ImageConverter.noconversionavailable} ({ImageConverter.".$self->{'no_image_conversion_reason'}."})\n");
142    }
143       
144}
145   
146
147# convert image to new type if converttotype is set
148# generate thumbnails if required
149# generate screenview if required
150# discover image metadata
151# filename_no_path must be in utf8 and url-encoded
152sub generate_images {
153    my $self = shift(@_);
154    my ($filename_full_path, $filename_no_path, $doc_obj, $section) = @_;
155
156    # check image magick status
157    return 0 if $self->{'image_conversion_available'} == 0;
158
159    # check the filenames
160    return 0 if ($filename_no_path eq "" || !-f $filename_full_path);
161
162    if ($self->{'enable_cache'}) {
163    $self->init_cache_for_file($filename_full_path);
164    }
165    if ($self->{'store_file_paths'}) {
166    $self->{'orig_file'} = "";
167    $self->{'thumb_file'} = "";
168    $self->{'screen_file'} = "";
169    }
170    my $verbosity = $self->{'verbosity'};
171    my $outhandle = $self->{'outhandle'};
172
173    # check the size of the image against minimum size if specified
174    my $minimumsize = $self->{'minimumsize'};
175    if (defined $minimumsize && (-s $filename_full_path < $minimumsize)) {
176        print $outhandle "ImageConverter: \"$filename_full_path\" too small, skipping\n"
177        if ($verbosity > 1);
178    return 0; # or is there a better return value??
179    }
180   
181    my $filehead = $filename_no_path;
182    $filehead =~ s/\.([^\.]*)$//; # filename with no extension
183    my $assocfilemeta = "[assocfilepath]";
184    if ($section ne $doc_obj->get_top_section()) {
185    $assocfilemeta = "[parent(Top):assocfilepath]";
186    }
187
188    # The images that will get generated may contain percent signs in their src filenames
189    # Encode those percent signs themselves so that urls to the imgs refer to them correctly
190    my $url_to_filehead = &unicode::filename_to_url($filehead);
191    my $url_to_filename_no_path = &unicode::filename_to_url($filename_no_path);
192   
193    # Convert the image to a new type (if required).
194    my $converttotype = $self->{'converttotype'};
195    my $type = "unknown";
196
197    if ($converttotype ne "" && $filename_full_path !~ m/$converttotype$/) {
198    #    $doc_obj->add_utf8_metadata($section, "Image", $utf8_filename_meta);
199
200    my ($result, $converted_filename_full_path)
201        = $self->convert($filename_full_path, $converttotype, "", "CONVERTTYPE");
202
203    $type = $converttotype;
204    $filename_full_path = $converted_filename_full_path;
205    $filename_no_path = "$filehead.$type";
206    $url_to_filename_no_path = "$url_to_filehead.$type";
207    if ($self->{'store_file_paths'}) {
208        $self->{'orig_file'} = $converted_filename_full_path;
209    }
210    }
211
212    # add Image metadata
213    $doc_obj->add_utf8_metadata($section, "Image", $url_to_filename_no_path); # url to generated image
214
215    # here we overwrite the original with the potentially converted one
216    $doc_obj->set_utf8_metadata_element($section, "Source", &unicode::url_decode($filename_no_path)); # displayname of generated image
217    $doc_obj->set_utf8_metadata_element($section, "SourceFile", $url_to_filename_no_path); # displayname of generated image
218
219    # use identify to get info about the (possibly converted) image
220    my ($image_type, $image_width, $image_height, $image_size)
221    = &identify($filename_full_path, $outhandle, $verbosity);
222
223    if ($image_type ne " ") {
224    $type = $self->correct_mime_type($image_type);
225    }
226
227    #overwrite the ones added in BasePlugin
228    $doc_obj->set_metadata_element ($section, "FileFormat", $type);
229    $doc_obj->set_metadata_element ($section, "FileSize",   $image_size);
230
231    $doc_obj->add_metadata ($section, "ImageType",   $image_type);
232    $doc_obj->add_metadata ($section, "ImageWidth",  $image_width);
233    $doc_obj->add_metadata ($section, "ImageHeight", $image_height);
234    $doc_obj->add_metadata ($section, "ImageSize",   $image_size);
235
236    if ((defined $self->{'MaxImageWidth'})
237    && ($image_width > $self->{'MaxImageWidth'})) {
238    $self->{'MaxImageWidth'} = $image_width;
239    }
240    if ((defined $self->{'MaxImageHeight'})
241    && ($image_height > $self->{'MaxImageHeight'})) {
242    $self->{'MaxImageHeight'} = $image_height;
243    }
244
245    $doc_obj->add_metadata ($section, "srclink_file", "[Image]");
246    $doc_obj->add_metadata ($section, "srcicon", "<img src=\"_httpprefix_/collect/[collection]/index/assoc/$assocfilemeta/[Image]\" width=\"[ImageWidth]\" height=\"[ImageHeight]\">");
247
248    # Add the image as an associated file
249    $doc_obj->associate_file($filename_full_path, $filename_no_path, "image/$type", $section);
250
251    if ($self->{'create_thumbnail'} eq "true") {
252    $self->create_thumbnail($filename_full_path, $filehead, $doc_obj, $section, $assocfilemeta, $url_to_filehead);
253    }
254    if ($self->{'create_screenview'} eq "true") {
255    $self->create_screenview($filename_full_path, $filehead, $doc_obj, $section, $assocfilemeta, $url_to_filehead, $image_width, $image_height);
256    }
257
258    return 1;
259}
260
261sub create_thumbnail {
262    my $self = shift(@_);
263    my ($original_file, $filehead, $doc_obj, $section, $assocfilemeta, $url_to_filehead) = @_;
264    $url_to_filehead = $filehead unless defined $url_to_filehead;
265
266    my $thumbnailsize = $self->{'thumbnailsize'};
267    my $thumbnailtype = $self->correct_mime_type($self->{'thumbnailtype'});
268
269    # Generate the thumbnail with convert
270    my ($result,$thumbnailfile)
271    = $self->convert($original_file, $thumbnailtype, "-geometry $thumbnailsize" . "x$thumbnailsize", "THUMB");
272   
273    # Add the thumbnail as an associated file ...
274    if (-e "$thumbnailfile") {
275    $doc_obj->associate_file("$thumbnailfile", $filehead."_thumb.$thumbnailtype",
276                 "image/$thumbnailtype",$section); # name of generated image
277    $doc_obj->add_metadata ($section, "ThumbType", $thumbnailtype);
278    $doc_obj->add_utf8_metadata ($section, "Thumb", $url_to_filehead."_thumb.$thumbnailtype"); # url to generated image
279   
280    $doc_obj->add_metadata ($section, "thumbicon", "<img src=\"_httpprefix_/collect/[collection]/index/assoc/$assocfilemeta/[Thumb]\" width=[ThumbWidth] height=[ThumbHeight]>");
281   
282   
283    # Extract Thumbnail metadata from convert output
284    if ($result =~ m/[0-9]+x[0-9]+=>([0-9]+)x([0-9]+)/) {
285        $doc_obj->add_metadata ($section, "ThumbWidth", $1);
286        $doc_obj->add_metadata ($section, "ThumbHeight", $2);
287    }
288    if ($self->{'store_file_paths'}) {
289        $self->{'thumb_file'} = $thumbnailfile;
290    }
291
292    } else {
293    my $outhandle = $self->{'outhandle'};
294    print $outhandle "Couldn't find thumbnail $thumbnailfile\n";
295
296    }
297}
298
299sub create_screenview {
300   
301    my $self = shift(@_);
302    my ($original_file, $filehead, $doc_obj, $section, $assocfilemeta, $url_to_filehead, $image_width, $image_height) = @_;
303    $url_to_filehead = $filehead unless defined $url_to_filehead;
304
305    my $screenviewsize = $self->{'screenviewsize'};
306    my $screenviewtype = $self->correct_mime_type($self->{'screenviewtype'});
307
308    # Scale the image, unless the original image is smaller than the screenview size and -noscaleup is set
309    my $scale_option = "-geometry $screenviewsize" . "x$screenviewsize";
310    if ($self->{'noscaleup'} && $image_width < $screenviewsize && $image_height < $screenviewsize)
311    {
312    $scale_option = "";
313    }
314   
315    # make the screenview image
316    my ($result,$screenviewfilename)
317    = $self->convert($original_file, $screenviewtype, $scale_option, "SCREEN");   
318   
319    #add the screenview as an associated file ...
320    if (-e "$screenviewfilename") {
321    $doc_obj->associate_file("$screenviewfilename", $filehead."_screen.$screenviewtype", "image/$screenviewtype",$section); # name of generated image
322    $doc_obj->add_metadata ($section, "ScreenType", $screenviewtype);
323    $doc_obj->add_utf8_metadata ($section, "Screen", $url_to_filehead."_screen.$screenviewtype"); # url to generated image
324   
325    $doc_obj->add_metadata ($section, "screenicon", "<img src=\"_httpprefix_/collect/[collection]/index/assoc/$assocfilemeta/[Screen]\" width=[ScreenWidth] height=[ScreenHeight]>");
326
327    # get screenview dimensions, size and type
328    if ($result =~ m/[0-9]+x[0-9]+=>([0-9]+)x([0-9]+)/) {
329        $doc_obj->add_metadata ($section, "ScreenWidth", $1);
330        $doc_obj->add_metadata ($section, "ScreenHeight", $2);
331    } elsif ($result =~ m/([0-9]+)x([0-9]+)/) {
332        #if the image hasn't changed size, the previous regex doesn't match
333        $doc_obj->add_metadata ($section, "ScreenWidth", $1);
334        $doc_obj->add_metadata ($section, "ScreenHeight", $2);
335    }
336
337    if ($self->{'store_file_paths'}) {
338        $self->{'screen_file'} = $screenviewfilename;
339    }
340
341    } else {
342    my $outhandle = $self->{'outhandle'};
343    print $outhandle "Couldn't find screenview file $screenviewfilename\n";
344
345    }
346
347}
348
349
350
351sub convert {
352    my $self = shift(@_);
353    my $source_file_path = shift(@_);
354    my $target_file_type = shift(@_);
355    my $convert_options  = shift(@_) || "";
356    my $convert_id       = shift(@_) || "";
357    my $cache_mode       = shift(@_) || "";
358
359    my $outhandle = $self->{'outhandle'};
360    my $verbosity = $self->{'verbosity'};
361
362    my $source_file_no_path = &File::Basename::basename($source_file_path);
363
364    # Determine the full name and path of the output file
365    my $target_file_path;
366    if ($self->{'enable_cache'}) {
367    my $cached_image_dir = $self->{'cached_dir'};
368    my $image_root = $self->{'cached_file_root'};
369    $image_root .= "_$convert_id" if ($convert_id ne "");
370    my $image_file = "$image_root.$target_file_type";
371    $target_file_path = &util::filename_cat($cached_image_dir,$image_file);
372    }
373    else {
374    $target_file_path = &util::get_tmp_filename($target_file_type);
375    push(@{$self->{'tmp_file_paths'}}, $target_file_path);
376
377    # Output filename used to be parsed from result line:
378    #   my ($ofilename) = ($result =~ m/=>(.*\.$target_file_type)/);
379    # by the function that called 'convert'
380    # but this is no longer needed, as output filename is now
381    # explicitly passed back
382    }
383
384    # Generate and run the convert command
385    my $convert_command = "convert -interlace plane -verbose $convert_options \"$source_file_path\" \"$target_file_path\"";
386
387    my $print_info = { 'message_prefix' => $convert_id,
388               'message' => "Converting image $source_file_no_path to: $convert_id $target_file_type" };
389    $print_info->{'cache_mode'} = $cache_mode if ($cache_mode ne "");
390
391    my ($regenerated,$result,$had_error)
392    = $self->autorun_general_cmd($convert_command,$source_file_path,$target_file_path,$print_info);
393
394    return ($result,$target_file_path);
395}
396
397sub convert_without_result {
398    my $self = shift(@_);
399
400    my $source_file_path = shift(@_);
401    my $target_file_type = shift(@_);
402    my $convert_options  = shift(@_) || "";
403    my $convert_id       = shift(@_) || "";
404
405    return $self->convert($source_file_path,$target_file_type,
406              $convert_options,$convert_id,"without_result");
407}
408
409
410# Discover the characteristics of an image file with the ImageMagick
411# "identify" command.
412
413sub identify {
414    my ($image, $outhandle, $verbosity) = @_;
415
416    # Use the ImageMagick "identify" command to get the file specs
417    my $command = "identify \"$image\" 2>&1";
418    print $outhandle "$command\n" if ($verbosity > 2);
419    my $result = '';
420    $result = `$command`;
421    print $outhandle "$result\n" if ($verbosity > 3);
422
423    # Read the type, width, and height
424    my $type =   'unknown';
425    my $width =  'unknown';
426    my $height = 'unknown';
427
428    my $image_safe = quotemeta $image;
429    if ($result =~ /^$image_safe (\w+) (\d+)x(\d+)/) {
430    $type = $1;
431    $width = $2;
432    $height = $3;
433    }
434
435    # Read the size
436    my $size = "unknown";
437    if ($result =~ m/^.* ([0-9]+)b/) {
438    $size = $1;
439    }
440    elsif ($result =~ m/^.* ([0-9]+)(\.([0-9]+))?kb?/) {
441    $size = 1024 * $1;
442    if (defined($2)) {
443        $size = $size + (1024 * $2);
444        # Truncate size (it isn't going to be very accurate anyway)
445        $size = int($size);
446    }
447    }
448    elsif ($result =~ m/^.* ([0-9]+)(\.([0-9]+))?mb?/) {
449    $size = 1024 * 1024 * $1;
450        if (defined($2)) {
451        $size = $size + (1024 * 1024 * $2);
452            # Truncate size (it isn't going to be very accurate anyway)
453            $size = int($size);
454        }
455     }
456    elsif ($result =~ m/^.* (([0-9]+)(\.([0-9]+))?e\+([0-9]+))(kb|b)?/) {
457    # Deals with file sizes on Linux of type "3.4e+02kb" where e+02 is 1*10^2.
458    # 3.4e+02 therefore evaluates to 3.4 x 1 x 10^2 = 340kb.
459    # Programming languages including Perl know how that 3.4e+02 is a number,
460    # so we don't need to do any calculations.
461    $size = $1*1; # turn the string into a number by multiplying it by 1
462           #if we did $size = $1; $size would be merely the string "3.4e+02"
463    $size = int($size); # truncate size
464    }
465    print $outhandle "file: $image:\t $type, $width, $height, $size\n"
466    if ($verbosity > 2);
467
468    # Return the specs
469    return ($type, $width, $height, $size);
470}
471
472sub clean_up_temporary_files {
473    my $self = shift(@_);
474
475    foreach my $tmp_file_path (@{$self->{'tmp_file_paths'}}) {
476    if (-e $tmp_file_path) {
477        &util::rm($tmp_file_path);
478    }
479    }
480   
481}
482
483# image/jpg is not a valid mime-type, it ought to be image/jpeg.
484# Sometimes JPEG is passed in also, want to keep things lowercase just in case.
485sub correct_mime_type {
486    my $self = shift(@_);
487    my ($file_extension) = @_;
488   
489    $file_extension = lc($file_extension);
490    $file_extension =~ s/jpg/jpeg/s;
491
492    return $file_extension;
493}
494
4951; 
Note: See TracBrowser for help on using the browser.