[1733] | 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 |
|
---|
| 26 | package ImagePlug;
|
---|
| 27 |
|
---|
| 28 | use BasPlug;
|
---|
| 29 |
|
---|
[10254] | 30 | use strict;
|
---|
| 31 | no strict 'refs'; # allow filehandles to be variables and viceversa
|
---|
| 32 |
|
---|
[1733] | 33 | sub BEGIN {
|
---|
[10254] | 34 | @ImagePlug::ISA = ('BasPlug');
|
---|
[1733] | 35 | }
|
---|
| 36 |
|
---|
[4744] | 37 | my $arguments =
|
---|
| 38 | [ { 'name' => "process_exp",
|
---|
[4873] | 39 | 'desc' => "{BasPlug.process_exp}",
|
---|
[6408] | 40 | 'type' => "regexp",
|
---|
[4744] | 41 | 'deft' => &get_default_process_exp(),
|
---|
| 42 | 'reqd' => "no" },
|
---|
| 43 | { 'name' => "noscaleup",
|
---|
[4873] | 44 | 'desc' => "{ImagePlug.noscaleup}",
|
---|
[4744] | 45 | 'type' => "flag",
|
---|
| 46 | 'reqd' => "no" },
|
---|
| 47 | { 'name' => "thumbnailsize",
|
---|
[4873] | 48 | 'desc' => "{ImagePlug.thumbnailsize}",
|
---|
[4744] | 49 | 'type' => "int",
|
---|
| 50 | 'deft' => "100",
|
---|
[10218] | 51 | 'range' => "1,",
|
---|
[4744] | 52 | 'reqd' => "no" },
|
---|
| 53 | { 'name' => "thumbnailtype",
|
---|
[4873] | 54 | 'desc' => "{ImagePlug.thumbnailtype}",
|
---|
[4744] | 55 | 'type' => "string",
|
---|
| 56 | 'deft' => "gif",
|
---|
| 57 | 'reqd' => "no" },
|
---|
| 58 | { 'name' => "screenviewsize",
|
---|
[4873] | 59 | 'desc' => "{ImagePlug.screenviewsize}",
|
---|
[4744] | 60 | 'type' => "int",
|
---|
| 61 | 'deft' => "0",
|
---|
[10218] | 62 | 'range' => "1,",
|
---|
[4744] | 63 | 'reqd' => "no" },
|
---|
| 64 | { 'name' => "screenviewtype",
|
---|
[4873] | 65 | 'desc' => "{ImagePlug.screenviewtype}",
|
---|
[4744] | 66 | 'type' => "string",
|
---|
| 67 | 'deft' => "jpg",
|
---|
| 68 | 'reqd' => "no" },
|
---|
| 69 | { 'name' => "converttotype",
|
---|
[4873] | 70 | 'desc' => "{ImagePlug.converttotype}",
|
---|
[4744] | 71 | 'type' => "string",
|
---|
| 72 | 'deft' => "",
|
---|
| 73 | 'reqd' => "no" },
|
---|
| 74 | { 'name' => "minimumsize",
|
---|
[4873] | 75 | 'desc' => "{ImagePlug.minimumsize}",
|
---|
[4744] | 76 | 'type' => "int",
|
---|
| 77 | 'deft' => "100",
|
---|
[10218] | 78 | 'range' => "1,",
|
---|
[4744] | 79 | 'reqd' => "no" } ];
|
---|
[1758] | 80 |
|
---|
[3540] | 81 | my $options = { 'name' => "ImagePlug",
|
---|
[5680] | 82 | 'desc' => "{ImagePlug.desc}",
|
---|
[6408] | 83 | 'abstract' => "no",
|
---|
[3540] | 84 | 'inherits' => "yes",
|
---|
| 85 | 'args' => $arguments };
|
---|
| 86 |
|
---|
| 87 |
|
---|
[1744] | 88 |
|
---|
[1733] | 89 | sub new {
|
---|
[10218] | 90 | my ($class) = shift (@_);
|
---|
| 91 | my ($pluginlist,$inputargs,$hashArgOptLists) = @_;
|
---|
| 92 | push(@$pluginlist, $class);
|
---|
[4724] | 93 |
|
---|
[10218] | 94 | if(defined $arguments){ push(@{$hashArgOptLists->{"ArgList"}},@{$arguments});}
|
---|
| 95 | if(defined $options) { push(@{$hashArgOptLists->{"OptList"}},$options)};
|
---|
[2230] | 96 |
|
---|
[12169] | 97 | my $self = new BasPlug($pluginlist, $inputargs, $hashArgOptLists);
|
---|
[1744] | 98 |
|
---|
[9574] | 99 | # Check that ImageMagick is installed and available on the path (except for Windows 95/98)
|
---|
| 100 | if (!($ENV{'GSDLOS'} eq "windows" && !Win32::IsWinNT())) {
|
---|
| 101 | my $result = `identify 2>&1`;
|
---|
| 102 | if ($? == -1 || $? == 256) { # Linux and Windows return different values for "program not found"
|
---|
| 103 | $self->{'imagemagick_not_installed'} = 1;
|
---|
| 104 | }
|
---|
[8145] | 105 | }
|
---|
| 106 |
|
---|
[13243] | 107 |
|
---|
[1733] | 108 | return bless $self, $class;
|
---|
| 109 | }
|
---|
| 110 |
|
---|
| 111 | sub get_default_process_exp {
|
---|
| 112 | my $self = shift (@_);
|
---|
| 113 |
|
---|
[1758] | 114 | return q^(?i)(\.jpe?g|\.gif|\.png|\.bmp|\.xbm|\.tif?f)$^;
|
---|
[1733] | 115 | }
|
---|
| 116 |
|
---|
[9067] | 117 | # this makes no sense for images
|
---|
| 118 | sub block_cover_image
|
---|
| 119 | {
|
---|
| 120 | my $self =shift (@_);
|
---|
| 121 | my ($filename) = @_;
|
---|
[2230] | 122 |
|
---|
[9067] | 123 | return;
|
---|
| 124 | }
|
---|
[2230] | 125 | # Create the thumbnail and screenview images, and discover the Image's
|
---|
| 126 | # size, width, and height using the convert utility.
|
---|
| 127 |
|
---|
[1733] | 128 | sub run_convert {
|
---|
| 129 | my $self = shift (@_);
|
---|
[2230] | 130 | my $filename = shift (@_); # filename with full path
|
---|
| 131 | my $file = shift (@_); # filename without path
|
---|
[1733] | 132 | my $doc_obj = shift (@_);
|
---|
[1744] | 133 | my $section = $doc_obj->get_top_section();
|
---|
[2230] | 134 |
|
---|
| 135 | my $verbosity = $self->{'verbosity'};
|
---|
| 136 | my $outhandle = $self->{'outhandle'};
|
---|
[1733] | 137 |
|
---|
[2230] | 138 | # check the filename is okay
|
---|
| 139 | return 0 if ($file eq "" || $filename eq "");
|
---|
| 140 |
|
---|
[3307] | 141 | # Code now extended to quote filenames in 'convert' commnads
|
---|
| 142 | # Allows spaces in filenames, but note needs spaces to be escaped in URL as well
|
---|
| 143 | # if ($filename =~ m/ /) {
|
---|
| 144 | # print $outhandle "ImagePlug: \"$filename\" contains a space. choking.\n";
|
---|
| 145 | # return undef;
|
---|
| 146 | # }
|
---|
[1744] | 147 |
|
---|
[1758] | 148 | my $minimumsize = $self->{'minimumsize'};
|
---|
[2230] | 149 | if (defined $minimumsize && (-s $filename < $minimumsize)) {
|
---|
| 150 | print $outhandle "ImagePlug: \"$filename\" too small, skipping\n"
|
---|
| 151 | if ($verbosity > 1);
|
---|
| 152 | }
|
---|
| 153 |
|
---|
[4724] | 154 |
|
---|
[2230] | 155 | # Convert the image to a new type (if required).
|
---|
[1744] | 156 | my $converttotype = $self->{'converttotype'};
|
---|
[2230] | 157 | my $originalfilename = ""; # only set if we do a conversion
|
---|
[1733] | 158 | my $type = "unknown";
|
---|
[1758] | 159 |
|
---|
[8121] | 160 |
|
---|
[1758] | 161 | if ($converttotype ne "" && $filename =~ m/$converttotype$/) {
|
---|
[2230] | 162 |
|
---|
[1744] | 163 | $originalfilename = $filename;
|
---|
[2230] | 164 | $filename = &util::get_tmp_filename() . ".$converttotype";
|
---|
[1744] | 165 | $self->{'tmp_filename'} = $filename;
|
---|
[2230] | 166 |
|
---|
[3307] | 167 | my $command = "convert -interlace plane -verbose \"$originalfilename\" \"$filename\"";
|
---|
[2230] | 168 | print $outhandle "$command\n" if ($verbosity > 2);
|
---|
| 169 | my $result = '';
|
---|
[1744] | 170 | $result = `$command`;
|
---|
[4724] | 171 | print $outhandle "RESULT = $result\n" if ($verbosity > 2);
|
---|
[2230] | 172 |
|
---|
[1744] | 173 | $type = $converttotype;
|
---|
[1733] | 174 | }
|
---|
[1744] | 175 |
|
---|
[4724] | 176 |
|
---|
[3137] | 177 | # Add the image metadata
|
---|
[3307] | 178 | my $url = $file;
|
---|
| 179 | $url =~ s/ /%20/g;
|
---|
| 180 |
|
---|
| 181 | $doc_obj->add_metadata ($section, "Image", $url);
|
---|
[3517] | 182 |
|
---|
| 183 | # Also want to set filename as 'Source' metadata to be
|
---|
| 184 | # consistent with other plugins
|
---|
| 185 | $doc_obj->add_metadata ($section, "Source", $url);
|
---|
| 186 |
|
---|
[3137] | 187 | my ($image_type, $image_width, $image_height, $image_size)
|
---|
| 188 | = &identify($filename, $outhandle, $verbosity);
|
---|
[2230] | 189 |
|
---|
[8121] | 190 | if ($image_type ne " ") {
|
---|
| 191 | $type = $image_type;
|
---|
| 192 | }
|
---|
| 193 |
|
---|
| 194 | $doc_obj->add_metadata ($section, "FileFormat", $type);
|
---|
[8166] | 195 | $doc_obj->add_metadata ($section, "FileSize", $image_size);
|
---|
[8121] | 196 |
|
---|
[3137] | 197 | $doc_obj->add_metadata ($section, "ImageType", $image_type);
|
---|
| 198 | $doc_obj->add_metadata ($section, "ImageWidth", $image_width);
|
---|
| 199 | $doc_obj->add_metadata ($section, "ImageHeight", $image_height);
|
---|
| 200 | $doc_obj->add_metadata ($section, "ImageSize", $image_size);
|
---|
| 201 |
|
---|
[4724] | 202 | $doc_obj->add_metadata ($section, "srclink",
|
---|
[11834] | 203 | "<a href=\"_httpprefix_/collect/[collection]/index/assoc/[assocfilepath]/[Image]\">");
|
---|
[4724] | 204 | $doc_obj->add_metadata ($section, "/srclink", "</a>");
|
---|
| 205 |
|
---|
[11834] | 206 | $doc_obj->add_metadata ($section, "srcicon", "<img src=\"_httpprefix_/collect/[collection]/index/assoc/[assocfilepath]/[Image]\" width=100>");
|
---|
[4724] | 207 |
|
---|
| 208 |
|
---|
[3137] | 209 | # Add the image as an associated file
|
---|
| 210 | $doc_obj->associate_file($filename,$file,"image/$type",$section);
|
---|
| 211 |
|
---|
[4724] | 212 |
|
---|
[2230] | 213 | # Make the thumbnail image
|
---|
[3137] | 214 | my $thumbnailsize = $self->{'thumbnailsize'} || 100;
|
---|
[2230] | 215 | my $thumbnailtype = $self->{'thumbnailtype'} || 'gif';
|
---|
[4724] | 216 |
|
---|
[3137] | 217 | my $thumbnailfile = &util::get_tmp_filename() . ".$thumbnailtype";
|
---|
| 218 | $self->{'tmp_filename2'} = $thumbnailfile;
|
---|
[1733] | 219 |
|
---|
[2230] | 220 | # Generate the thumbnail with convert
|
---|
[3307] | 221 | my $command = "convert -interlace plane -verbose -geometry $thumbnailsize"
|
---|
| 222 | . "x$thumbnailsize \"$filename\" \"$thumbnailfile\"";
|
---|
[4724] | 223 | print $outhandle "THUMBNAIL: $command\n" if ($verbosity > 2);
|
---|
[2230] | 224 | my $result = '';
|
---|
[2882] | 225 | $result = `$command 2>&1` ;
|
---|
[4724] | 226 | print $outhandle "THUMB RESULT: $result\n" if ($verbosity > 2);
|
---|
[2230] | 227 |
|
---|
| 228 | # Add the thumbnail as an associated file ...
|
---|
[3137] | 229 | if (-e "$thumbnailfile") {
|
---|
| 230 | $doc_obj->associate_file("$thumbnailfile", "thumbnail.$thumbnailtype",
|
---|
[2230] | 231 | "image/$thumbnailtype",$section);
|
---|
| 232 | $doc_obj->add_metadata ($section, "ThumbType", $thumbnailtype);
|
---|
| 233 | $doc_obj->add_metadata ($section, "Thumb", "thumbnail.$thumbnailtype");
|
---|
[4724] | 234 |
|
---|
[11834] | 235 | $doc_obj->add_metadata ($section, "thumbicon", "<img src=\"_httpprefix_/collect/[collection]/index/assoc/[assocfilepath]/[Thumb]\" width=[ThumbWidth] height=[ThumbHeight]>");
|
---|
[2230] | 236 | }
|
---|
| 237 |
|
---|
[3137] | 238 | # Extract Thumnail metadata from convert output
|
---|
| 239 | if ($result =~ m/[0-9]+x[0-9]+=>([0-9]+)x([0-9]+)/) {
|
---|
| 240 | $doc_obj->add_metadata ($section, "ThumbWidth", $1);
|
---|
| 241 | $doc_obj->add_metadata ($section, "ThumbHeight", $2);
|
---|
[1733] | 242 | }
|
---|
[1758] | 243 |
|
---|
[2230] | 244 | # Make a screen-sized version of the picture if requested
|
---|
| 245 | if ($self->{'screenviewsize'}) {
|
---|
| 246 |
|
---|
[3137] | 247 | # To do: if the actual image smaller than the screenview size,
|
---|
| 248 | # we should use the original !
|
---|
| 249 |
|
---|
[2230] | 250 | my $screenviewsize = $self->{'screenviewsize'};
|
---|
| 251 | my $screenviewtype = $self->{'screenviewtype'} || 'jpeg';
|
---|
| 252 | my $screenviewfilename = &util::get_tmp_filename() . ".$screenviewtype";
|
---|
| 253 | $self->{'tmp_filename3'} = $screenviewfilename;
|
---|
| 254 |
|
---|
| 255 | # make the screenview image
|
---|
[3307] | 256 | my $command = "convert -interlace plane -verbose -geometry $screenviewsize"
|
---|
| 257 | . "x$screenviewsize \"$filename\" \"$screenviewfilename\"";
|
---|
[2230] | 258 | print $outhandle "$command\n" if ($verbosity > 2);
|
---|
| 259 | my $result = "";
|
---|
[2882] | 260 | $result = `$command 2>&1` ;
|
---|
[2230] | 261 | print $outhandle "$result\n" if ($verbosity > 3);
|
---|
| 262 |
|
---|
| 263 | # get screenview dimensions, size and type
|
---|
| 264 | if ($result =~ m/[0-9]+x[0-9]+=>([0-9]+)x([0-9]+)/) {
|
---|
| 265 | $doc_obj->add_metadata ($section, "ScreenWidth", $1);
|
---|
| 266 | $doc_obj->add_metadata ($section, "ScreenHeight", $2);
|
---|
| 267 | }
|
---|
[5078] | 268 | else {
|
---|
| 269 | $doc_obj->add_metadata ($section, "ScreenWidth", $image_width);
|
---|
| 270 | $doc_obj->add_metadata ($section, "ScreenHeight", $image_height);
|
---|
| 271 | }
|
---|
| 272 |
|
---|
[2230] | 273 | #add the screenview as an associated file ...
|
---|
| 274 | if (-e "$screenviewfilename") {
|
---|
| 275 | $doc_obj->associate_file("$screenviewfilename", "screenview.$screenviewtype",
|
---|
| 276 | "image/$screenviewtype",$section);
|
---|
| 277 | $doc_obj->add_metadata ($section, "ScreenType", $screenviewtype);
|
---|
| 278 | $doc_obj->add_metadata ($section, "Screen", "screenview.$screenviewtype");
|
---|
[4724] | 279 |
|
---|
[11834] | 280 | $doc_obj->add_metadata ($section, "screenicon", "<img src=\"_httpprefix_/collect/[collection]/index/assoc/[assocfilepath]/[Screen]\" width=[ScreenWidth] height=[ScreenHeight]>");
|
---|
[2230] | 281 | } else {
|
---|
| 282 | print $outhandle "ImagePlug: couldn't find \"$screenviewfilename\"\n";
|
---|
| 283 | }
|
---|
| 284 | }
|
---|
| 285 |
|
---|
[1733] | 286 | return $type;
|
---|
[4724] | 287 |
|
---|
| 288 |
|
---|
[3137] | 289 | }
|
---|
[2230] | 290 |
|
---|
| 291 |
|
---|
[4724] | 292 |
|
---|
[3137] | 293 | # Discover the characteristics of an image file with the ImageMagick
|
---|
| 294 | # "identify" command.
|
---|
| 295 |
|
---|
| 296 | sub identify {
|
---|
| 297 | my ($image, $outhandle, $verbosity) = @_;
|
---|
| 298 |
|
---|
| 299 | # Use the ImageMagick "identify" command to get the file specs
|
---|
[5845] | 300 | my $command = "identify \"$image\" 2>&1";
|
---|
[3137] | 301 | print $outhandle "$command\n" if ($verbosity > 2);
|
---|
| 302 | my $result = '';
|
---|
| 303 | $result = `$command`;
|
---|
| 304 | print $outhandle "$result\n" if ($verbosity > 3);
|
---|
| 305 |
|
---|
| 306 | # Read the type, width, and height
|
---|
| 307 | my $type = 'unknown';
|
---|
| 308 | my $width = 'unknown';
|
---|
| 309 | my $height = 'unknown';
|
---|
| 310 |
|
---|
[4790] | 311 | my $image_safe = quotemeta $image;
|
---|
| 312 | if ($result =~ /^$image_safe (\w+) (\d+)x(\d+)/) {
|
---|
[3137] | 313 | $type = $1;
|
---|
| 314 | $width = $2;
|
---|
| 315 | $height = $3;
|
---|
| 316 | }
|
---|
[5103] | 317 |
|
---|
[3137] | 318 | # Read the size
|
---|
| 319 | my $size = "unknown";
|
---|
| 320 | if ($result =~ m/^.* ([0-9]+)b/) {
|
---|
| 321 | $size = $1;
|
---|
[5103] | 322 | }
|
---|
[5845] | 323 | elsif ($result =~ m/^.* ([0-9]+)(\.([0-9]+))?kb?/) {
|
---|
[3137] | 324 | $size = 1024 * $1;
|
---|
[5103] | 325 | if (defined($2)) {
|
---|
| 326 | $size = $size + (1024 * $2);
|
---|
| 327 | # Truncate size (it isn't going to be very accurate anyway)
|
---|
| 328 | $size = int($size);
|
---|
| 329 | }
|
---|
[3137] | 330 | }
|
---|
| 331 |
|
---|
| 332 | print $outhandle "file: $image:\t $type, $width, $height, $size\n"
|
---|
| 333 | if ($verbosity > 2);
|
---|
| 334 |
|
---|
| 335 | # Return the specs
|
---|
| 336 | return ($type, $width, $height, $size);
|
---|
[1733] | 337 | }
|
---|
| 338 |
|
---|
| 339 |
|
---|
[11090] | 340 | # The ImagePlug read() function.
|
---|
[1733] | 341 | # ImagePlug overrides read() because there is no need to read the actual
|
---|
| 342 | # text of the file in, because the contents of the file is not text...
|
---|
| 343 | #
|
---|
| 344 | # Return number of files processed, undef if can't process
|
---|
| 345 | # Note that $base_dir might be "" and that $file might
|
---|
| 346 | # include directories
|
---|
| 347 |
|
---|
| 348 | sub read {
|
---|
| 349 | my $self = shift (@_);
|
---|
[9853] | 350 | my ($pluginfo, $base_dir, $file, $metadata, $processor, $maxdocs, $total_count, $gli) = @_;
|
---|
[1733] | 351 |
|
---|
[2230] | 352 | my $outhandle = $self->{'outhandle'};
|
---|
| 353 |
|
---|
[11090] | 354 | #check process and block exps, smart block, etc
|
---|
| 355 | my ($block_status,$filename) = $self->read_block(@_);
|
---|
| 356 | return $block_status if ((!defined $block_status) || ($block_status==0));
|
---|
[6332] | 357 |
|
---|
| 358 | print STDERR "<Processing n='$file' p='ImagePlug'>\n" if ($gli);
|
---|
[9960] | 359 | print $outhandle "ImagePlug processing $file\n"
|
---|
[1758] | 360 | if $self->{'verbosity'} > 1;
|
---|
| 361 |
|
---|
[9585] | 362 | # None of this works very well on Windows 95/98...
|
---|
| 363 | if ($ENV{'GSDLOS'} eq "windows" && !Win32::IsWinNT()) {
|
---|
| 364 | if ($gli) {
|
---|
| 365 | print STDERR "<ProcessingError n='$file' r='Windows 95/98 not supported'>\n";
|
---|
| 366 | }
|
---|
[9703] | 367 | print $outhandle "ImagePlug: Windows 95/98 not supported\n";
|
---|
[9585] | 368 | return -1;
|
---|
| 369 | }
|
---|
| 370 |
|
---|
| 371 | # None of this is going to work very well without ImageMagick...
|
---|
| 372 | if ($self->{'imagemagick_not_installed'}) {
|
---|
| 373 | if ($gli) {
|
---|
| 374 | print STDERR "<ProcessingError n='$file' r='ImageMagick not installed'>\n";
|
---|
| 375 | }
|
---|
[9703] | 376 | print $outhandle "ImagePlug: ImageMagick not installed\n";
|
---|
[9585] | 377 | return -1;
|
---|
| 378 | }
|
---|
| 379 |
|
---|
[2230] | 380 | #if there's a leading directory name, eat it...
|
---|
| 381 | $file =~ s/^.*[\/\\]//;
|
---|
[1733] | 382 |
|
---|
| 383 | # create a new document
|
---|
| 384 | my $doc_obj = new doc ($filename, "indexed_doc");
|
---|
[12270] | 385 | $doc_obj->set_OIDtype ($processor->{'OIDtype'}, $processor->{'OIDmetadata'});
|
---|
[7508] | 386 | $doc_obj->add_utf8_metadata($doc_obj->get_top_section(), "Plugin", "$self->{'plugin_type'}");
|
---|
[2327] | 387 |
|
---|
[1733] | 388 | #run convert to get the thumbnail and extract size and type info
|
---|
[1758] | 389 | my $result = run_convert($self, $filename, $file, $doc_obj);
|
---|
[1744] | 390 |
|
---|
[1758] | 391 | if (!defined $result)
|
---|
[1744] | 392 | {
|
---|
[9585] | 393 | if ($gli) {
|
---|
| 394 | print STDERR "<ProcessingError n='$file'>\n";
|
---|
| 395 | }
|
---|
[9703] | 396 | print $outhandle "ImagePlug: couldn't process \"$filename\"\n";
|
---|
[7362] | 397 | return -1; # error during processing
|
---|
[1733] | 398 | }
|
---|
| 399 |
|
---|
[13243] | 400 |
|
---|
[1733] | 401 | #create an empty text string so we don't break downstream plugins
|
---|
[13243] | 402 | &gsprintf::output_strings_in_UTF8;
|
---|
[7506] | 403 | my $text = &gsprintf::lookup_string("{BasPlug.dummy_text}");
|
---|
[13243] | 404 |
|
---|
[1733] | 405 | # include any metadata passed in from previous plugins
|
---|
| 406 | # note that this metadata is associated with the top level section
|
---|
[1744] | 407 | my $section = $doc_obj->get_top_section();
|
---|
[1733] | 408 | $self->extra_metadata ($doc_obj, $section, $metadata);
|
---|
| 409 |
|
---|
| 410 | # do plugin specific processing of doc_obj
|
---|
[9585] | 411 | unless (defined ($self->process(\$text, $pluginfo, $base_dir, $file, $metadata, $doc_obj))) {
|
---|
| 412 | print STDERR "<ProcessingError n='$file'>\n" if ($gli);
|
---|
| 413 | return -1;
|
---|
| 414 | }
|
---|
[1733] | 415 |
|
---|
| 416 | # do any automatic metadata extraction
|
---|
| 417 | $self->auto_extract_metadata ($doc_obj);
|
---|
| 418 |
|
---|
[8350] | 419 | # if we haven't found any Title so far, assign one
|
---|
| 420 | # this was shifted to here from inside read()
|
---|
| 421 | $self->title_fallback($doc_obj,$section,$file);
|
---|
[1733] | 422 | # add an OID
|
---|
| 423 | $doc_obj->set_OID();
|
---|
[13243] | 424 | $doc_obj->add_utf8_text($section, $text);
|
---|
[1733] | 425 |
|
---|
| 426 | # process the document
|
---|
| 427 | $processor->process($doc_obj);
|
---|
| 428 |
|
---|
[2230] | 429 | # clean up temporary files - we do this here instead of in
|
---|
| 430 | # run_convert becuase associated files aren't actually copied
|
---|
| 431 | # until after process has been run.
|
---|
[1744] | 432 | if (defined $self->{'tmp_filename'} &&
|
---|
| 433 | -e $self->{'tmp_filename'}) {
|
---|
[2230] | 434 | &util::rm($self->{'tmp_filename'})
|
---|
[1733] | 435 | }
|
---|
[13243] | 436 |
|
---|
[1744] | 437 | if (defined $self->{'tmp_filename2'} &&
|
---|
| 438 | -e $self->{'tmp_filename2'}) {
|
---|
[2230] | 439 | &util::rm($self->{'tmp_filename2'})
|
---|
[1744] | 440 | }
|
---|
[2230] | 441 | if (defined $self->{'tmp_filename3'} &&
|
---|
| 442 | -e $self->{'tmp_filename3'}) {
|
---|
| 443 | &util::rm($self->{'tmp_filename3'})
|
---|
| 444 | }
|
---|
[1733] | 445 |
|
---|
[3307] | 446 | $self->{'num_processed'}++;
|
---|
| 447 |
|
---|
[2207] | 448 | return 1;
|
---|
[1733] | 449 | }
|
---|
| 450 |
|
---|
| 451 | # do plugin specific processing of doc_obj
|
---|
| 452 | sub process {
|
---|
| 453 | my $self = shift (@_);
|
---|
| 454 | my ($textref, $pluginfo, $base_dir, $file, $metadata, $doc_obj) = @_;
|
---|
| 455 | my $outhandle = $self->{'outhandle'};
|
---|
| 456 |
|
---|
| 457 | return 1;
|
---|
| 458 | }
|
---|
| 459 |
|
---|
| 460 | 1;
|
---|
[4724] | 461 |
|
---|
| 462 |
|
---|
| 463 |
|
---|
| 464 |
|
---|
| 465 |
|
---|
| 466 |
|
---|
| 467 |
|
---|
| 468 |
|
---|
| 469 |
|
---|
| 470 |
|
---|
| 471 |
|
---|