source: trunk/gsdl/perllib/plugins/ImagePlug.pm@ 8915

Last change on this file since 8915 was 8365, checked in by kjdon, 20 years ago

put doule quotes around values of <a href=xxx> and <img src=xxx>

  • Property svn:keywords set to Author Date Id Revision
File size: 14.5 KB
Line 
1###########################################################################
2#
3# ImagePlug.pm -- simple text plugin
4# A component of the Greenstone digital library software
5# from the New Zealand Digital Library Project at the
6# University of Waikato, New Zealand.
7#
8# Copyright (C) 1999 New Zealand Digital Library Project
9#
10# This program is free software; you can redistribute it and/or modify
11# it under the terms of the GNU General Public License as published by
12# the Free Software Foundation; either version 2 of the License, or
13# (at your option) any later version.
14#
15# This program is distributed in the hope that it will be useful,
16# but WITHOUT ANY WARRANTY; without even the implied warranty of
17# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18# GNU General Public License for more details.
19#
20# You should have received a copy of the GNU General Public License
21# along with this program; if not, write to the Free Software
22# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
23#
24###########################################################################
25
26package ImagePlug;
27
28use BasPlug;
29
30sub BEGIN {
31 @ISA = ('BasPlug');
32}
33
34my $arguments =
35 [ { 'name' => "process_exp",
36 'desc' => "{BasPlug.process_exp}",
37 'type' => "regexp",
38 'deft' => &get_default_process_exp(),
39 'reqd' => "no" },
40 { 'name' => "noscaleup",
41 'desc' => "{ImagePlug.noscaleup}",
42 'type' => "flag",
43 'reqd' => "no" },
44 { 'name' => "thumbnailsize",
45 'desc' => "{ImagePlug.thumbnailsize}",
46 'type' => "int",
47 'deft' => "100",
48 'reqd' => "no" },
49 { 'name' => "thumbnailtype",
50 'desc' => "{ImagePlug.thumbnailtype}",
51 'type' => "string",
52 'deft' => "gif",
53 'reqd' => "no" },
54 { 'name' => "screenviewsize",
55 'desc' => "{ImagePlug.screenviewsize}",
56 'type' => "int",
57 'deft' => "0",
58 'reqd' => "no" },
59 { 'name' => "screenviewtype",
60 'desc' => "{ImagePlug.screenviewtype}",
61 'type' => "string",
62 'deft' => "jpg",
63 'reqd' => "no" },
64 { 'name' => "converttotype",
65 'desc' => "{ImagePlug.converttotype}",
66 'type' => "string",
67 'deft' => "",
68 'reqd' => "no" },
69 { 'name' => "minimumsize",
70 'desc' => "{ImagePlug.minimumsize}",
71 'type' => "int",
72 'deft' => "100",
73 'reqd' => "no" } ];
74
75my $options = { 'name' => "ImagePlug",
76 'desc' => "{ImagePlug.desc}",
77 'abstract' => "no",
78 'inherits' => "yes",
79 'args' => $arguments };
80
81
82
83sub new {
84 my ($class) = @_;
85 my $plugin_name = shift (@_);
86 my $self = new BasPlug ("ImagePlug", @_);
87 $self->{'plugin_type'} = "ImagePlug";
88 # 14-05-02 To allow for proper inheritance of arguments - John Thompson
89 my $option_list = $self->{'option_list'};
90 push( @{$option_list}, $options );
91
92 if (!parsargv::parse(\@_,
93 q^noscaleup^, \$self->{'noscaleup'},
94 q^converttotype/.*/^, \$self->{'converttotype'},
95 q^minimumsize/[0-9]*/100^, \$self->{'minimumsize'},
96
97 q^thumbnailsize/[0-9]*/100^, \$self->{'thumbnailsize'},
98 q^thumbnailtype/.*/gif^, \$self->{'thumbnailtype'},
99 q^screenviewsize/[0-9]*/0^, \$self->{'screenviewsize'},
100 q^screenviewtype/.*/jpg^, \$self->{'screenviewtype'},
101 "allow_extra_options")) {
102
103 print STDERR "\nImagePlug uses an incorrect option.\n";
104 print STDERR "Check your collect.cfg configuration file.\n";
105 $self->print_txt_usage(""); # Use default resource bundle
106 die "\n";
107 }
108
109 # Check that ImageMagick is installed and available on the path
110 my $result = `identify 2>&1`;
111 if ($? == -1 || $? == 256) { # Linux and Windows return different values for "program not found"
112 $self->{'imagemagick_not_installed'} = 1;
113 }
114
115 return bless $self, $class;
116}
117
118sub get_default_process_exp {
119 my $self = shift (@_);
120
121 return q^(?i)(\.jpe?g|\.gif|\.png|\.bmp|\.xbm|\.tif?f)$^;
122}
123
124
125# Create the thumbnail and screenview images, and discover the Image's
126# size, width, and height using the convert utility.
127
128sub run_convert {
129 my $self = shift (@_);
130 my $filename = shift (@_); # filename with full path
131 my $file = shift (@_); # filename without path
132 my $doc_obj = shift (@_);
133 my $section = $doc_obj->get_top_section();
134
135 my $verbosity = $self->{'verbosity'};
136 my $outhandle = $self->{'outhandle'};
137
138 # None of this is going to work very well without ImageMagick...
139 if ($self->{'imagemagick_not_installed'}) {
140 print $outhandle "ImagePlug: ImageMagick not installed\n" if ($verbosity > 1);
141 return undef;
142 }
143
144 # check the filename is okay
145 return 0 if ($file eq "" || $filename eq "");
146
147# Code now extended to quote filenames in 'convert' commnads
148# Allows spaces in filenames, but note needs spaces to be escaped in URL as well
149# if ($filename =~ m/ /) {
150# print $outhandle "ImagePlug: \"$filename\" contains a space. choking.\n";
151# return undef;
152# }
153
154 my $minimumsize = $self->{'minimumsize'};
155 if (defined $minimumsize && (-s $filename < $minimumsize)) {
156 print $outhandle "ImagePlug: \"$filename\" too small, skipping\n"
157 if ($verbosity > 1);
158 }
159
160
161 # Convert the image to a new type (if required).
162 my $converttotype = $self->{'converttotype'};
163 my $originalfilename = ""; # only set if we do a conversion
164 my $type = "unknown";
165
166
167 if ($converttotype ne "" && $filename =~ m/$converttotype$/) {
168
169 $originalfilename = $filename;
170 $filename = &util::get_tmp_filename() . ".$converttotype";
171 $self->{'tmp_filename'} = $filename;
172
173 my $command = "convert -interlace plane -verbose \"$originalfilename\" \"$filename\"";
174 print $outhandle "$command\n" if ($verbosity > 2);
175 my $result = '';
176 $result = `$command`;
177 print $outhandle "RESULT = $result\n" if ($verbosity > 2);
178
179 $type = $converttotype;
180 }
181
182
183 # Add the image metadata
184 my $url = $file;
185 $url =~ s/ /%20/g;
186
187 $doc_obj->add_metadata ($section, "Image", $url);
188
189 # Also want to set filename as 'Source' metadata to be
190 # consistent with other plugins
191 $doc_obj->add_metadata ($section, "Source", $url);
192
193 my ($image_type, $image_width, $image_height, $image_size)
194 = &identify($filename, $outhandle, $verbosity);
195
196 if ($image_type ne " ") {
197 $type = $image_type;
198 }
199
200 $doc_obj->add_metadata ($section, "FileFormat", $type);
201 $doc_obj->add_metadata ($section, "FileSize", $image_size);
202
203 $doc_obj->add_metadata ($section, "ImageType", $image_type);
204 $doc_obj->add_metadata ($section, "ImageWidth", $image_width);
205 $doc_obj->add_metadata ($section, "ImageHeight", $image_height);
206 $doc_obj->add_metadata ($section, "ImageSize", $image_size);
207
208 $doc_obj->add_metadata ($section, "srclink",
209 "<a href=\"_httpcollection_/index/assoc/[assocfilepath]/[Image]\">");
210 $doc_obj->add_metadata ($section, "/srclink", "</a>");
211
212 $doc_obj->add_metadata ($section, "srcicon", "<img src=\"_httpcollection_/index/assoc/[assocfilepath]/[Image]\" width=100>");
213
214
215 # Add the image as an associated file
216 $doc_obj->associate_file($filename,$file,"image/$type",$section);
217
218
219 # Make the thumbnail image
220 my $thumbnailsize = $self->{'thumbnailsize'} || 100;
221 my $thumbnailtype = $self->{'thumbnailtype'} || 'gif';
222
223 my $thumbnailfile = &util::get_tmp_filename() . ".$thumbnailtype";
224 $self->{'tmp_filename2'} = $thumbnailfile;
225
226 # Generate the thumbnail with convert
227 my $command = "convert -interlace plane -verbose -geometry $thumbnailsize"
228 . "x$thumbnailsize \"$filename\" \"$thumbnailfile\"";
229 print $outhandle "THUMBNAIL: $command\n" if ($verbosity > 2);
230 my $result = '';
231 $result = `$command 2>&1` ;
232 print $outhandle "THUMB RESULT: $result\n" if ($verbosity > 2);
233
234 # Add the thumbnail as an associated file ...
235 if (-e "$thumbnailfile") {
236 $doc_obj->associate_file("$thumbnailfile", "thumbnail.$thumbnailtype",
237 "image/$thumbnailtype",$section);
238 $doc_obj->add_metadata ($section, "ThumbType", $thumbnailtype);
239 $doc_obj->add_metadata ($section, "Thumb", "thumbnail.$thumbnailtype");
240
241 $doc_obj->add_metadata ($section, "thumbicon", "<img src=\"_httpcollection_/index/assoc/[assocfilepath]/[Thumb]\" width=[ThumbWidth] height=[ThumbHeight]>");
242 }
243
244 # Extract Thumnail metadata from convert output
245 if ($result =~ m/[0-9]+x[0-9]+=>([0-9]+)x([0-9]+)/) {
246 $doc_obj->add_metadata ($section, "ThumbWidth", $1);
247 $doc_obj->add_metadata ($section, "ThumbHeight", $2);
248 }
249
250 # Make a screen-sized version of the picture if requested
251 if ($self->{'screenviewsize'}) {
252
253 # To do: if the actual image smaller than the screenview size,
254 # we should use the original !
255
256 my $screenviewsize = $self->{'screenviewsize'};
257 my $screenviewtype = $self->{'screenviewtype'} || 'jpeg';
258 my $screenviewfilename = &util::get_tmp_filename() . ".$screenviewtype";
259 $self->{'tmp_filename3'} = $screenviewfilename;
260
261 # make the screenview image
262 my $command = "convert -interlace plane -verbose -geometry $screenviewsize"
263 . "x$screenviewsize \"$filename\" \"$screenviewfilename\"";
264 print $outhandle "$command\n" if ($verbosity > 2);
265 my $result = "";
266 $result = `$command 2>&1` ;
267 print $outhandle "$result\n" if ($verbosity > 3);
268
269 # get screenview dimensions, size and type
270 if ($result =~ m/[0-9]+x[0-9]+=>([0-9]+)x([0-9]+)/) {
271 $doc_obj->add_metadata ($section, "ScreenWidth", $1);
272 $doc_obj->add_metadata ($section, "ScreenHeight", $2);
273 }
274 else {
275 $doc_obj->add_metadata ($section, "ScreenWidth", $image_width);
276 $doc_obj->add_metadata ($section, "ScreenHeight", $image_height);
277 }
278
279 #add the screenview as an associated file ...
280 if (-e "$screenviewfilename") {
281 $doc_obj->associate_file("$screenviewfilename", "screenview.$screenviewtype",
282 "image/$screenviewtype",$section);
283 $doc_obj->add_metadata ($section, "ScreenType", $screenviewtype);
284 $doc_obj->add_metadata ($section, "Screen", "screenview.$screenviewtype");
285
286 $doc_obj->add_metadata ($section, "screenicon", "<img src=\"_httpcollection_/index/assoc/[assocfilepath]/[Screen]\" width=[ScreenWidth] height=[ScreenHeight]>");
287 } else {
288 print $outhandle "ImagePlug: couldn't find \"$screenviewfilename\"\n";
289 }
290 }
291
292 return $type;
293
294
295}
296
297
298
299# Discover the characteristics of an image file with the ImageMagick
300# "identify" command.
301
302sub identify {
303 my ($image, $outhandle, $verbosity) = @_;
304
305 # Use the ImageMagick "identify" command to get the file specs
306 my $command = "identify \"$image\" 2>&1";
307 print $outhandle "$command\n" if ($verbosity > 2);
308 my $result = '';
309 $result = `$command`;
310 print $outhandle "$result\n" if ($verbosity > 3);
311
312 # Read the type, width, and height
313 my $type = 'unknown';
314 my $width = 'unknown';
315 my $height = 'unknown';
316
317 my $image_safe = quotemeta $image;
318 if ($result =~ /^$image_safe (\w+) (\d+)x(\d+)/) {
319 $type = $1;
320 $width = $2;
321 $height = $3;
322 }
323
324 # Read the size
325 my $size = "unknown";
326 if ($result =~ m/^.* ([0-9]+)b/) {
327 $size = $1;
328 }
329 elsif ($result =~ m/^.* ([0-9]+)(\.([0-9]+))?kb?/) {
330 $size = 1024 * $1;
331 if (defined($2)) {
332 $size = $size + (1024 * $2);
333 # Truncate size (it isn't going to be very accurate anyway)
334 $size = int($size);
335 }
336 }
337
338 print $outhandle "file: $image:\t $type, $width, $height, $size\n"
339 if ($verbosity > 2);
340
341 # Return the specs
342 return ($type, $width, $height, $size);
343}
344
345
346# The ImagePlug read() function. This function does all the right things
347# to make general options work for a given plugin. It calls the process()
348# function which does all the work specific to a plugin (like the old
349# read functions used to do). Most plugins should define their own
350# process() function and let this read() function keep control.
351#
352# ImagePlug overrides read() because there is no need to read the actual
353# text of the file in, because the contents of the file is not text...
354#
355# Return number of files processed, undef if can't process
356# Note that $base_dir might be "" and that $file might
357# include directories
358
359sub read {
360 my $self = shift (@_);
361 my ($pluginfo, $base_dir, $file, $metadata, $processor, $maxdocs, $gli) = @_;
362
363 my $outhandle = $self->{'outhandle'};
364
365 my $filename = &util::filename_cat($base_dir, $file);
366 return 0 if $self->{'block_exp'} ne "" && $filename =~ /$self->{'block_exp'}/;
367 if ($filename !~ /$self->{'process_exp'}/ || !-f $filename) {
368 return undef;
369 }
370
371 print STDERR "<Processing n='$file' p='ImagePlug'>\n" if ($gli);
372 print $outhandle "ImagePlug processing $filename\n"
373 if $self->{'verbosity'} > 1;
374
375 #if there's a leading directory name, eat it...
376 $file =~ s/^.*[\/\\]//;
377
378 # create a new document
379 my $doc_obj = new doc ($filename, "indexed_doc");
380 $doc_obj->set_OIDtype ($processor->{'OIDtype'});
381 $doc_obj->add_utf8_metadata($doc_obj->get_top_section(), "Plugin", "$self->{'plugin_type'}");
382
383 #run convert to get the thumbnail and extract size and type info
384 my $result = run_convert($self, $filename, $file, $doc_obj);
385
386 if (!defined $result)
387 {
388 print "ImagePlug: couldn't process \"$filename\"\n";
389 return -1; # error during processing
390 }
391
392 #create an empty text string so we don't break downstream plugins
393 my $text = &gsprintf::lookup_string("{BasPlug.dummy_text}");
394 # include any metadata passed in from previous plugins
395 # note that this metadata is associated with the top level section
396 my $section = $doc_obj->get_top_section();
397 $self->extra_metadata ($doc_obj, $section, $metadata);
398
399 # do plugin specific processing of doc_obj
400 return -1 unless defined ($self->process (\$text, $pluginfo, $base_dir,
401 $file, $metadata, $doc_obj));
402
403 # do any automatic metadata extraction
404 $self->auto_extract_metadata ($doc_obj);
405
406 # if we haven't found any Title so far, assign one
407 # this was shifted to here from inside read()
408 $self->title_fallback($doc_obj,$section,$file);
409 # add an OID
410 $doc_obj->set_OID();
411 $doc_obj->add_text($section, $text);
412
413 # process the document
414 $processor->process($doc_obj);
415
416 # clean up temporary files - we do this here instead of in
417 # run_convert becuase associated files aren't actually copied
418 # until after process has been run.
419 if (defined $self->{'tmp_filename'} &&
420 -e $self->{'tmp_filename'}) {
421 &util::rm($self->{'tmp_filename'})
422 }
423 if (defined $self->{'tmp_filename2'} &&
424 -e $self->{'tmp_filename2'}) {
425 &util::rm($self->{'tmp_filename2'})
426 }
427 if (defined $self->{'tmp_filename3'} &&
428 -e $self->{'tmp_filename3'}) {
429 &util::rm($self->{'tmp_filename3'})
430 }
431
432 $self->{'num_processed'}++;
433
434 return 1;
435}
436
437# do plugin specific processing of doc_obj
438sub process {
439 my $self = shift (@_);
440 my ($textref, $pluginfo, $base_dir, $file, $metadata, $doc_obj) = @_;
441 my $outhandle = $self->{'outhandle'};
442
443 return 1;
444}
445
4461;
447
448
449
450
451
452
453
454
455
456
457
Note: See TracBrowser for help on using the repository browser.