Changeset 2785 for trunk/gsdl/perllib/plugin.pm

Timestamp:

2001-10-09T17:21:29+13:00 (23 years ago)

Author:

sjboddie

Message:

The build process now creates a summary of how many files were included,
which were rejected, etc. A link to a page containing this summary is
provided from the final page of the collector (once the collection is built
successfully) and from the default "about this collection" text for
collections built by the collector.

Also did a little bit of tidying in a couple of places

File:

• trunk/gsdl/perllib/plugin.pm (modified) (3 diffs)

trunk/gsdl/perllib/plugin.pm

@@ -28 +28 @@
 require util;
 
+my $stats = {'num_processed' => 0,
+         'num_blocked' => 0,
+         'num_not_processed' => 0,
+         'num_archives' => 0
+         };
+
 sub load_plugins {
     my ($plugin_list) = shift @_;
-    ($verbosity, $outhandle, $faillogname) = @_; # globals
+    ($verbosity, $outhandle, $failhandle) = @_; # globals
     my @plugin_objects = ();
 
     $verbosity = 2 unless defined $verbosity;
     $outhandle = STDERR unless defined $outhandle;
+    $failhandle = STDERR unless defined $failhandle;
 
     foreach $pluginoptions (@$plugin_list) {
@@ -58 +65 @@
     
     # initialize plugin
-    $plugobj->init($verbosity, $outhandle, $faillogname);
+    $plugobj->init($verbosity, $outhandle, $failhandle);
 
     # add this object to the list
@@ -94 +101 @@
     return $rv if defined $rv;
     }
+
+    if ($verbosity >= 2) {
+    print $outhandle "WARNING - no plugin could process $file\n";
+    }
     
-    if ($verbosity >= 2) {
-    print $outhandle "WARNING - no plugin could process " . 
-        &util::filename_cat($base_dir,$file) . "\n";
+    $file =~ s/([^\\\/]+)$/$1/;
+    print $failhandle "$file: no plugin could process this file\n";
+    $stats->{'num_not_processed'} ++;
+
+    return 0;
+}
+
+# write out some general stats that the plugins have compiled - note that
+# the buildcol.pl process doesn't currently call this process so the stats
+# are only output after import.pl -
+sub write_stats {
+    my ($pluginfo, $statshandle) = @_;
+
+    foreach $plugobj (@$pluginfo) {
+    $plugobj->compile_stats($stats);
     }
-    return 0;
+
+    my $total = $stats->{'num_processed'} + $stats->{'num_blocked'} + 
+    $stats->{'num_not_processed'};
+
+    if ($total == 1) {
+    print $statshandle "* 1 document was considered for processing\n";
+    } else {
+    print $statshandle "* $total documents were considered for processing\n";
+    }
+    if ($stats->{'num_archives'}) {
+    print $statshandle "   (including the contents of " . $stats->{'num_archives'} .
+        " ZIP/TAR archive";
+    if ($stats->{'num_archives'} == 1) {print $statshandle ")\n";}
+    else {print $statshandle "s)\n";}
+    }
+    if ($stats->{'num_processed'} == 1) {
+    print $statshandle "* 1 was processed and included in the collection\n";
+    } else {
+    print $statshandle "* " . $stats->{'num_processed'} . " were processed and included in the collection\n";
+    }
+    if ($stats->{'num_not_processed'} == 1) {
+    print $statshandle "* 1 was rejected.";
+    } else {
+    print $statshandle "* " . $stats->{'num_not_processed'} . " were rejected.";
+    } 
+    print $statshandle " See the fail log for a list of rejected documents\n";
+    
 }