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