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