[1733] | 1 | ###########################################################################
|
---|
| 2 | #
|
---|
[16820] | 3 | # ImagePlugin.pm -- for processing standalone images
|
---|
[1733] | 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 |
|
---|
[15872] | 26 | package ImagePlugin;
|
---|
[1733] | 27 |
|
---|
[15872] | 28 | use BasePlugin;
|
---|
| 29 | use ImageConverter;
|
---|
[1733] | 30 |
|
---|
[10254] | 31 | use strict;
|
---|
| 32 | no strict 'refs'; # allow filehandles to be variables and viceversa
|
---|
[16856] | 33 | no strict 'subs';
|
---|
[10254] | 34 |
|
---|
[16856] | 35 | use gsprintf 'gsprintf';
|
---|
| 36 |
|
---|
[1733] | 37 | sub BEGIN {
|
---|
[21287] | 38 | @ImagePlugin::ISA = ('BasePlugin', 'ImageConverter');
|
---|
[1733] | 39 | }
|
---|
| 40 |
|
---|
[4744] | 41 | my $arguments =
|
---|
| 42 | [ { 'name' => "process_exp",
|
---|
[15872] | 43 | 'desc' => "{BasePlugin.process_exp}",
|
---|
[6408] | 44 | 'type' => "regexp",
|
---|
[4744] | 45 | 'deft' => &get_default_process_exp(),
|
---|
| 46 | 'reqd' => "no" },
|
---|
[15872] | 47 | ];
|
---|
[1758] | 48 |
|
---|
[15872] | 49 | my $options = { 'name' => "ImagePlugin",
|
---|
| 50 | 'desc' => "{ImagePlugin.desc}",
|
---|
[6408] | 51 | 'abstract' => "no",
|
---|
[3540] | 52 | 'inherits' => "yes",
|
---|
| 53 | 'args' => $arguments };
|
---|
| 54 |
|
---|
| 55 |
|
---|
[1744] | 56 |
|
---|
[1733] | 57 | sub new {
|
---|
[10218] | 58 | my ($class) = shift (@_);
|
---|
| 59 | my ($pluginlist,$inputargs,$hashArgOptLists) = @_;
|
---|
| 60 | push(@$pluginlist, $class);
|
---|
[4724] | 61 |
|
---|
[15872] | 62 | push(@{$hashArgOptLists->{"ArgList"}},@{$arguments});
|
---|
| 63 | push(@{$hashArgOptLists->{"OptList"}},$options);
|
---|
[2230] | 64 |
|
---|
[21240] | 65 |
|
---|
[15872] | 66 | new ImageConverter($pluginlist, $inputargs, $hashArgOptLists);
|
---|
| 67 | my $self = new BasePlugin($pluginlist, $inputargs, $hashArgOptLists);
|
---|
[1744] | 68 |
|
---|
[1733] | 69 | return bless $self, $class;
|
---|
| 70 | }
|
---|
| 71 |
|
---|
[15872] | 72 | sub init {
|
---|
| 73 | my $self = shift (@_);
|
---|
| 74 | my ($verbosity, $outhandle, $failhandle) = @_;
|
---|
| 75 |
|
---|
| 76 | $self->SUPER::init(@_);
|
---|
| 77 | $self->ImageConverter::init();
|
---|
[17196] | 78 | $self->{'cover_image'} = 0; # makes no sense for images
|
---|
[15872] | 79 | }
|
---|
| 80 |
|
---|
[16847] | 81 | sub begin {
|
---|
| 82 | my $self = shift (@_);
|
---|
| 83 | my ($pluginfo, $base_dir, $processor, $maxdocs) = @_;
|
---|
| 84 |
|
---|
[16849] | 85 | $self->SUPER::begin(@_);
|
---|
[17250] | 86 | $self->ImageConverter::begin(@_);
|
---|
[16847] | 87 | }
|
---|
| 88 |
|
---|
[21287] | 89 |
|
---|
[1733] | 90 | sub get_default_process_exp {
|
---|
| 91 | my $self = shift (@_);
|
---|
| 92 |
|
---|
[17666] | 93 | # from .jpf and onwards below, the file extensions are for JPEG2000
|
---|
[22612] | 94 | return q^(?i)\.(jpe?g|gif|png|bmp|xbm|tif?f|jpf|jpx|jp2|jpc|j2k|pnm|pgx)$^;
|
---|
[1733] | 95 | }
|
---|
| 96 |
|
---|
[9067] | 97 | # this makes no sense for images
|
---|
| 98 | sub block_cover_image
|
---|
| 99 | {
|
---|
| 100 | my $self =shift (@_);
|
---|
| 101 | my ($filename) = @_;
|
---|
[2230] | 102 |
|
---|
[9067] | 103 | return;
|
---|
| 104 | }
|
---|
[2230] | 105 |
|
---|
[15872] | 106 | # do plugin specific processing of doc_obj
|
---|
| 107 | sub process {
|
---|
[1733] | 108 | my $self = shift (@_);
|
---|
[15872] | 109 | # options??
|
---|
| 110 | my ($pluginfo, $base_dir, $file, $metadata, $doc_obj, $gli) = @_;
|
---|
| 111 |
|
---|
[2230] | 112 | my $outhandle = $self->{'outhandle'};
|
---|
[16383] | 113 | my ($filename_full_path, $filename_no_path) = &util::get_full_filenames($base_dir, $file);
|
---|
[23347] | 114 |
|
---|
[19361] | 115 | if ($self->{'image_conversion_available'} == 1)
|
---|
| 116 | {
|
---|
[23347] | 117 | my $plugin_filename_encoding = $self->{'filename_encoding'};
|
---|
| 118 | my $filename_encoding = $self->deduce_filename_encoding($file,$metadata,$plugin_filename_encoding);
|
---|
| 119 |
|
---|
[23353] | 120 | my $url_encoded_full_filename
|
---|
| 121 | = &unicode::raw_filename_to_url_encoded($filename_full_path);
|
---|
| 122 |
|
---|
[23347] | 123 | # should we check the return value?
|
---|
[23353] | 124 | $self->generate_images($filename_full_path,
|
---|
| 125 | $url_encoded_full_filename,
|
---|
| 126 | $doc_obj, $doc_obj->get_top_section(),$filename_encoding);
|
---|
[23347] | 127 |
|
---|
[19361] | 128 | }
|
---|
| 129 | else
|
---|
| 130 | {
|
---|
[23347] | 131 | if ($gli) {
|
---|
| 132 | &gsprintf(STDERR, "<Warning p='ImagePlugin' r='{ImageConverter.noconversionavailable}: {ImageConverter.".$self->{'no_image_conversion_reason'}."}'>");
|
---|
| 133 | }
|
---|
| 134 | # all we do is add the original image as an associated file, and set up srclink etc
|
---|
| 135 | my $assoc_file = $doc_obj->get_assocfile_from_sourcefile();
|
---|
| 136 | my $section = $doc_obj->get_top_section();
|
---|
| 137 |
|
---|
| 138 | $doc_obj->associate_file($filename_full_path, $assoc_file, "", $section);
|
---|
| 139 |
|
---|
[24225] | 140 | # srclink_file is now deprecated because of the "_" in the metadataname. Use srclinkFile
|
---|
[23347] | 141 | $doc_obj->add_metadata ($section, "srclink_file", $doc_obj->get_sourcefile());
|
---|
[24225] | 142 | $doc_obj->add_metadata ($section, "srclinkFile", $doc_obj->get_sourcefile());
|
---|
[23347] | 143 | # We don't know the size of the image, but the browser should display it at full size
|
---|
[24225] | 144 | $doc_obj->add_metadata ($section, "srcicon", "<img src=\"_httpprefix_/collect/[collection]/index/assoc/[assocfilepath]/[srclinkFile]\">");
|
---|
[23347] | 145 |
|
---|
| 146 | # Add a fake thumbnail icon with the full-sized image scaled down by the browser
|
---|
[27787] | 147 | $doc_obj->add_metadata ($section, "thumbicon", "<img src=\"_httpprefix_/collect/[collection]/index/assoc/[assocfilepath]/[srclinkFile]\" alt=\"[srclinkFile]\" width=\"" . $self->{'thumbnailsize'} . "\">");
|
---|
[2230] | 148 | }
|
---|
[15872] | 149 | #we have no text - adds dummy text and NoText metadata
|
---|
| 150 | $self->add_dummy_text($doc_obj, $doc_obj->get_top_section());
|
---|
[23347] | 151 |
|
---|
[15872] | 152 | return 1;
|
---|
[23347] | 153 |
|
---|
[3137] | 154 | }
|
---|
[2230] | 155 |
|
---|
[21240] | 156 |
|
---|
[15872] | 157 | sub clean_up_after_doc_obj_processing {
|
---|
[14951] | 158 | my $self = shift(@_);
|
---|
[1733] | 159 |
|
---|
[15872] | 160 | $self->ImageConverter::clean_up_temporary_files();
|
---|
[1733] | 161 | }
|
---|
| 162 |
|
---|
| 163 | 1;
|
---|
[4724] | 164 |
|
---|
| 165 |
|
---|
| 166 |
|
---|
| 167 |
|
---|
| 168 |
|
---|
| 169 |
|
---|
| 170 |
|
---|
| 171 |
|
---|
| 172 |
|
---|
| 173 |
|
---|
| 174 |
|
---|