source: main/trunk/greenstone2/perllib/plugins/ImagePlugin.pm@ 21760

Last change on this file since 21760 was 21760, checked in by kjdon, 12 years ago

srclink now generated dynamically at runtime. instead of storing srclink metadata, we store srclink_file metadata, which can be a value (doc.doc) or a metadata format element (eg [SourceFile]).

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