source: main/trunk/greenstone2/perllib/plugin.pm@ 22221

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

added commented quote to make emacs colouring proper

  • Property svn:keywords set to Author Date Id Revision
File size: 13.8 KB
Line 
1###########################################################################
2#
3# plugin.pm -- functions to handle using plugins
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 plugin;
27
28
29use strict; # to pick up typos and undeclared variables...
30no strict 'refs'; # ...but allow filehandles to be variables and vice versa
31no strict 'subs';
32
33require util;
34use gsprintf 'gsprintf';
35
36# mapping from old plugin names to new ones for backwards compatibility
37# can remove at sometime in future when we no longer want to support old xxPlug names in the config file
38my $plugin_name_map = {
39 'GAPlug' => 'GreenstoneXMLPlugin',
40 'ArcPlug' => 'ArchivesInfPlugin',
41 'RecPlug' => 'DirectoryPlugin',
42 'TEXTPlug' => 'TextPlugin',
43 'XMLPlug' => 'ReadXMLFile',
44 'EMAILPlug' => 'EmailPlugin',
45 'SRCPlug' => 'SourceCodePlugin',
46 'NULPlug' => 'NulPlugin',
47 'W3ImgPlug' => 'HTMLImagePlugin',
48 'PagedImgPlug' => 'PagedImagePlugin',
49 'METSPlug' => 'GreenstoneMETSPlugin',
50 'PPTPlug' => 'PowerPointPlugin',
51 'PSPlug' => 'PostScriptPlugin',
52 'DBPlug' => 'DatabasePlugin'
53 };
54
55# global variables
56my $stats = {'num_processed' => 0,
57 'num_blocked' => 0,
58 'num_not_processed' => 0,
59 'num_not_recognised' => 0,
60 'num_archives' => 0
61 };
62
63#globaloptions contains any options that should be passed to all plugins
64my ($verbosity, $outhandle, $failhandle, $globaloptions);
65
66sub get_valid_pluginname {
67 my ($pluginname) = @_;
68 my $valid_name = $pluginname;
69 if (defined $plugin_name_map->{$pluginname}) {
70 $valid_name = $plugin_name_map->{$pluginname};
71 } elsif ($pluginname =~ /Plug$/) {
72 $valid_name =~ s/Plug/Plugin/;
73
74 }
75 return $valid_name;
76}
77
78sub load_plugin_require
79{
80 my ($pluginname) = @_;
81
82 my @check_list = ();
83
84 # pp_plugname shorthand for 'perllib' 'plugin' '$pluginname.pm'
85 my $pp_plugname
86 = &util::filename_cat('perllib', 'plugins', "${pluginname}.pm");
87 my $collectdir = $ENV{'GSDLCOLLECTDIR'};
88
89 # find the plugin
90 if (defined($ENV{'GSDLCOLLECTION'}))
91 {
92 my $customplugname
93 = &util::filename_cat($collectdir, "custom",$ENV{'GSDLCOLLECTION'},
94 $pp_plugname);
95 push(@check_list,$customplugname);
96 }
97
98 my $colplugname = &util::filename_cat($collectdir, $pp_plugname);
99 push(@check_list,$colplugname);
100
101 if (defined $ENV{'GSDLEXTS'}) {
102
103 my $ext_prefix = &util::filename_cat($ENV{'GSDLHOME'}, "ext");
104
105 my @extensions = split(/:/,$ENV{'GSDLEXTS'});
106 foreach my $e (@extensions) {
107 my $extplugname = &util::filename_cat($ext_prefix, $e, $pp_plugname);
108 push(@check_list,$extplugname);
109
110 }
111 }
112 if (defined $ENV{'GSDL3EXTS'}) {
113
114 my $ext_prefix = &util::filename_cat($ENV{'GSDL3SRCHOME'}, "ext");
115
116 my @extensions = split(/:/,$ENV{'GSDL3EXTS'});
117 foreach my $e (@extensions) {
118 my $extplugname = &util::filename_cat($ext_prefix, $e, $pp_plugname);
119 push(@check_list,$extplugname);
120
121 }
122 }
123
124
125 my $mainplugname = &util::filename_cat($ENV{'GSDLHOME'}, $pp_plugname);
126 push(@check_list,$mainplugname);
127
128 my $success=0;
129 foreach my $plugname (@check_list) {
130 if (-e $plugname) {
131 require $plugname;
132 $success=1;
133 last;
134 }
135 }
136
137 if (!$success) {
138 &gsprintf(STDERR, "{plugin.could_not_find_plugin}\n",
139 $pluginname);
140 die "\n";
141 }
142}
143
144sub load_plugin_for_info {
145 my ($pluginname) = shift @_;
146 $pluginname = &get_valid_pluginname($pluginname);
147 load_plugin_require($pluginname);
148
149 # create a plugin object
150 my ($plugobj);
151 my $options = "-gsdlinfo";
152
153 eval ("\$plugobj = new \$pluginname([],[$options])");
154 die "$@" if $@;
155
156 return $plugobj;
157}
158
159sub load_plugins {
160 my ($plugin_list) = shift @_;
161 my $incremental_mode;
162 ($verbosity, $outhandle, $failhandle, $globaloptions, $incremental_mode) = @_; # globals
163 my @plugin_objects = ();
164 $verbosity = 2 unless defined $verbosity;
165 $outhandle = 'STDERR' unless defined $outhandle;
166 $failhandle = 'STDERR' unless defined $failhandle;
167
168 my $colplugindir = &util::filename_cat($ENV{'GSDLCOLLECTDIR'},"perllib/plugins");
169 unshift (@INC, $colplugindir);
170
171 map { $_ = "\"$_\""; } @$globaloptions;
172 my $globals = join (",", @$globaloptions);
173
174 foreach my $pluginoptions (@$plugin_list) {
175 my $pluginname = shift @$pluginoptions;
176 next unless defined $pluginname;
177 $pluginname = &get_valid_pluginname($pluginname);
178 load_plugin_require($pluginname);
179
180 # create a plugin object
181 my ($plugobj);
182 map { $_ = "\"$_\""; } @$pluginoptions;
183 my $options = join (",", @$pluginoptions);
184 if ($globals) {
185 if (@$pluginoptions) {
186 $options .= ",";
187 }
188 $options .= "$globals";
189 }
190 # need to escape backslash before putting in to the eval
191 # but watch out for any \" (which shouldn't be further escaped)
192 $options =~ s/\\([^"])/\\\\$1/g; #"
193 $options =~ s/\$/\\\$/g;
194
195 eval ("\$plugobj = new \$pluginname([],[$options])");
196 die "$@" if $@;
197
198 # initialize plugin
199 $plugobj->init($verbosity, $outhandle, $failhandle);
200
201 $plugobj->set_incremental($incremental_mode);
202
203 # add this object to the list
204 push (@plugin_objects, $plugobj);
205 }
206
207 return \@plugin_objects;
208}
209
210
211sub begin {
212 my ($pluginfo, $base_dir, $processor, $maxdocs, $gli) = @_;
213
214 map { $_->{'gli'} = $gli; } @$pluginfo;
215 map { $_->begin($pluginfo, $base_dir, $processor, $maxdocs); } @$pluginfo;
216}
217
218 sub remove_all {
219 my ($pluginfo, $base_dir, $processor, $maxdocs) = @_;
220
221 map { $_->remove_all($pluginfo, $base_dir, $processor, $maxdocs); } @$pluginfo;
222}
223
224sub remove_some {
225 my ($pluginfo, $infodbtype, $archivedir, $deleted_files) = @_;
226 return if (scalar(@$deleted_files)==0);
227 my $arcinfo_src_filename = &dbutil::get_infodb_file_path($infodbtype, "archiveinf-src", $archivedir);
228
229 foreach my $file (@$deleted_files) {
230 # use 'archiveinf-src' info database to look up all the OIDs
231 # that this file is used in (note in most cases, it's just one OID)
232
233 my $src_rec_string = &dbutil::read_infodb_entry($infodbtype, $arcinfo_src_filename, $file);
234 my $src_rec = &dbutil::convert_infodb_string_to_hash($src_rec_string);
235 my $oids = $src_rec->{'oid'};
236 my $rv;
237 foreach my $plugobj (@$pluginfo) {
238
239 $rv = $plugobj->remove_one($file, $oids, $archivedir);
240 if (defined $rv && $rv != -1) {
241 return $rv;
242 } # else undefined (was not recognised by the plugin) or there was an error, try the next one
243 }
244 return 0;
245 }
246
247}
248sub file_block_read {
249 my ($pluginfo, $base_dir, $file, $block_hash, $metadata, $gli) = @_;
250
251
252 $gli = 0 unless defined $gli;
253
254 my $rv = 0;
255 my $glifile = $file;
256
257 $glifile =~ s/^[\/\\]+//; # file sometimes starts with a / so get rid of it
258
259 # Announce to GLI that we are handling a file
260 print STDERR "<File n='$glifile'>\n" if $gli;
261
262 # the .kill file is a handy (if not very elegant) way of aborting
263 # an import.pl or buildcol.pl process
264 if (-e &util::filename_cat ($ENV{'GSDLCOLLECTDIR'}, ".kill")) {
265 gsprintf($outhandle, "{plugin.kill_file}\n");
266 die "\n";
267 }
268
269 foreach my $plugobj (@$pluginfo) {
270
271 $rv = $plugobj->file_block_read($pluginfo, $base_dir, $file, $block_hash, $metadata, $gli);
272 #last if (defined $rv && $rv==1); # stop this file once we have found something to 'process' it
273 }
274
275}
276
277
278sub metadata_read {
279 my ($pluginfo, $base_dir, $file, $block_hash,
280 $extrametakeys, $extrametadata, $extrametafile,
281 $processor, $maxdocs, $gli, $aux) = @_;
282
283 $maxdocs = -1 unless defined $maxdocs && $maxdocs =~ /\d/;
284 $gli = 0 unless defined $gli;
285
286 my $rv = 0;
287 my $glifile = $file;
288
289 $glifile =~ s/^[\/\\]+//; # file sometimes starts with a / so get rid of it
290
291 # Announce to GLI that we are handling a file
292 print STDERR "<File n='$glifile'>\n" if $gli;
293
294 # the .kill file is a handy (if not very elegant) way of aborting
295 # an import.pl or buildcol.pl process
296 if (-e &util::filename_cat ($ENV{'GSDLCOLLECTDIR'}, ".kill")) {
297 gsprintf($outhandle, "{plugin.kill_file}\n");
298 die "\n";
299 }
300
301 my $had_error = 0;
302 # pass this file by each of the plugins in turn until one
303 # is found which will process it
304 # read must return:
305 # undef - could not recognise
306 # -1 - tried but error
307 # 0 - blocked
308 # anything else for successful processing
309
310 foreach my $plugobj (@$pluginfo) {
311
312 $rv = $plugobj->metadata_read($pluginfo, $base_dir, $file, $block_hash,
313 $extrametakeys, $extrametadata, $extrametafile,
314 $processor, $maxdocs, $gli, $aux);
315
316 if (defined $rv) {
317 if ($rv == -1) {
318 # an error has occurred
319 $had_error = 1;
320 print STDERR "<ProcessingError n='$glifile'>\n" if $gli;
321 } else {
322 return $rv;
323 }
324 } # else undefined - was not recognised by the plugin
325 }
326
327 return 0;
328}
329
330sub read {
331 my ($pluginfo, $base_dir, $file, $block_hash, $metadata, $processor, $maxdocs, $total_count, $gli, $aux) = @_;
332
333 $maxdocs = -1 unless defined $maxdocs && $maxdocs =~ /\d/;
334 $total_count = 0 unless defined $total_count && $total_count =~ /\d/;
335 $gli = 0 unless defined $gli;
336
337 my $rv = 0;
338 my $glifile = $file;
339
340 $glifile =~ s/^[\/\\]+//; # file sometimes starts with a / so get rid of it
341
342 # Announce to GLI that we are handling a file
343 print STDERR "<File n='$glifile'>\n" if $gli;
344
345 # the .kill file is a handy (if not very elegant) way of aborting
346 # an import.pl or buildcol.pl process
347 if (-e &util::filename_cat ($ENV{'GSDLCOLLECTDIR'}, ".kill")) {
348 gsprintf($outhandle, "{plugin.kill_file}\n");
349 die "\n";
350 }
351
352 my $had_error = 0;
353 # pass this file by each of the plugins in turn until one
354 # is found which will process it
355 # read must return:
356 # undef - could not recognise
357 # -1 - tried but error
358 # 0 - blocked
359 # anything else for successful processing
360
361 foreach my $plugobj (@$pluginfo) {
362
363 $rv = $plugobj->read($pluginfo, $base_dir, $file,
364 $block_hash, $metadata, $processor, $maxdocs,
365 $total_count, $gli, $aux);
366
367 if (defined $rv) {
368 if ($rv == -1) {
369 # an error has occurred
370 $had_error = 1;
371 } else {
372 return $rv;
373 }
374 } # else undefined - was not recognised by the plugin
375 }
376
377 if ($had_error) {
378 # was recognised but couldn't be processed
379 if ($verbosity >= 2) {
380 gsprintf($outhandle, "{plugin.no_plugin_could_process}\n", $file);
381 }
382 # tell the GLI that it was not processed
383 print STDERR "<NonProcessedFile n='$glifile'>\n" if $gli;
384
385 gsprintf($failhandle, "$file: {plugin.no_plugin_could_process_this_file}\n");
386 $stats->{'num_not_processed'} ++;
387 } else {
388 # was not recognised
389 if ($verbosity >= 2) {
390 gsprintf($outhandle, "{plugin.no_plugin_could_recognise}\n",$file);
391 }
392 # tell the GLI that it was not processed
393 print STDERR "<NonRecognisedFile n='$glifile'>\n" if $gli;
394
395 gsprintf($failhandle, "$file: {plugin.no_plugin_could_recognise_this_file}\n");
396 $stats->{'num_not_recognised'} ++;
397 }
398 return 0;
399}
400
401# write out some general stats that the plugins have compiled - note that
402# the buildcol.pl process doesn't currently call this process so the stats
403# are only output after import.pl -
404sub write_stats {
405 my ($pluginfo, $statshandle, $faillog, $gli) = @_;
406
407 $gli = 0 unless defined $gli;
408
409 foreach my $plugobj (@$pluginfo) {
410 $plugobj->compile_stats($stats);
411 }
412
413 my $total = $stats->{'num_processed'} + $stats->{'num_blocked'} +
414 $stats->{'num_not_processed'} + $stats->{'num_not_recognised'};
415
416 print STDERR "<ImportComplete considered='$total' processed='$stats->{'num_processed'}' blocked='$stats->{'num_blocked'}' ignored='$stats->{'num_not_recognised'}' failed='$stats->{'num_not_processed'}'>\n" if $gli;
417
418 if ($total == 1) {
419 gsprintf($statshandle, "* {plugin.one_considered}\n");
420 } else {
421 gsprintf($statshandle, "* {plugin.n_considered}\n", $total);
422 }
423 if ($stats->{'num_archives'}) {
424 if ($stats->{'num_archives'} == 1) {
425 gsprintf($statshandle, " ({plugin.including_archive})\n");
426 }
427 else {
428 gsprintf($statshandle, " ({plugin.including_archives})\n",
429 $stats->{'num_archives'});
430 }
431 }
432 if ($stats->{'num_processed'} == 1) {
433 gsprintf($statshandle, "* {plugin.one_included}\n");
434 } else {
435 gsprintf($statshandle, "* {plugin.n_included}\n", $stats->{'num_processed'});
436 }
437 if ($stats->{'num_not_recognised'}) {
438 if ($stats->{'num_not_recognised'} == 1) {
439 gsprintf($statshandle, "* {plugin.one_unrecognised}\n");
440 } else {
441 gsprintf($statshandle, "* {plugin.n_unrecognised}\n",
442 $stats->{'num_not_recognised'});
443 }
444
445 }
446 if ($stats->{'num_not_processed'}) {
447 if ($stats->{'num_not_processed'} == 1) {
448 gsprintf($statshandle, "* {plugin.one_rejected}\n");
449 } else {
450 gsprintf($statshandle, "* {plugin.n_rejected}\n",
451 $stats->{'num_not_processed'});
452 }
453 }
454 if ($stats->{'num_not_processed'} || $stats->{'num_not_recognised'}) {
455 gsprintf($statshandle, " {plugin.see_faillog}\n", $faillog);
456 }
457}
458
459sub end {
460 my ($pluginfo, $processor) = @_;
461 map { $_->end($processor); } @$pluginfo;
462}
463
464sub deinit {
465 my ($pluginfo, $processor) = @_;
466
467
468 map { $_->deinit($processor); } @$pluginfo;
469}
470
4711;
Note: See TracBrowser for help on using the repository browser.