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

Timestamp:

2004-05-21T11:18:44+12:00 (20 years ago)

Author:

kjdon

Message:

plugin read functions now return 'undef' - didn't recognise, '-1' - recognised but had an error during processing, '0' - blocked or didn't process but don't pass it on to other plugins, or 'num_docs' processed. this emables a bit better error reporting about what has happened to each file. this now sends some more informative messages to GLI and general output

File:

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

trunk/gsdl/perllib/plugin.pm

@@ -32 +32 @@
          'num_blocked' => 0,
          'num_not_processed' => 0,
+         'num_not_recognised' => 0,
          'num_archives' => 0
          };
@@ -108 +109 @@
 
     my $rv = 0;
-
+    my $glifile = $file;
+    $glifile =~ s/^[\/\\]+//; # file sometimes starts with a / so get rid of it
     # Announce to GLI that we are handling a file
-    print STDERR "<File n='$file'>\n" if $gli;
+    print STDERR "<File n='$glifile'>\n" if $gli;
 
     # the .kill file is a handy (if not very elegant) way of aborting 
@@ -116 +118 @@
     if (-e &util::filename_cat ($ENV{'GSDLCOLLECTDIR'}, ".kill")) {
     &gsprintf($outhandle, "{plugin.kill_file}\n");
-    # print $outhandle "Process killed by .kill file\n";
     die "\n";
     }
     
+    my $had_error = 0;
     # pass this file by each of the plugins in turn until one
     # is found which will process it
+    # read must return:
+    # undef - could not recognise
+    # -1 - tried but error
+    # 0 - blocked
+    # anything else for successful processing
     foreach $plugobj (@$pluginfo) {
     $rv = $plugobj->read($pluginfo, $base_dir, $file, 
                  $metadata, $processor, $maxdocs, $gli, $aux);
-    return $rv if defined $rv;
-    }
-
-    if ($verbosity >= 2) {
-    &gsprintf($outhandle, "{plugin.no_plugin_could_process}\n", $file);
-    # print $outhandle "WARNING - no plugin could process $file\n";
-    }
-    # tell the GLI that it was not processed
-    print STDERR "<Processing n='$file' p=''>\n" if $gli;
-
-    $file =~ s/.*?([^\\\/]+)$/$1/;
-    &gsprintf($failhandle, "$file: {plugin.no_plugin_could_process_this_file}\n");
-    # print $failhandle "$file: no plugin could process this file\n";
-    $stats->{'num_not_processed'} ++;
+    if (defined $rv) {
+        if ($rv == -1) {
+        # an error has occurred
+        $had_error = 1;
+        print STDERR "<ProcessingError n='$glifile'>\n" if $gli;
+        } else {
+        return $rv;
+        }
+    } # else undefined - was not recognised by the plugin
+    }
+    
+    if ($had_error) {
+    # was recognised but couldn't be processed
+    if ($verbosity >= 2) {
+        &gsprintf($outhandle, "{plugin.no_plugin_could_process}\n", $file);
+        # print $outhandle "WARNING - no plugin could process $file\n";
+    }
+    # tell the GLI that it was not processed
+    print STDERR "<NonProcessedFile n='$glifile'>\n" if $gli;
+    
+    $file =~ s/.*?([^\\\/]+)$/$1/;
+    &gsprintf($failhandle, "$file: {plugin.no_plugin_could_process_this_file}\n");
+    # print $failhandle "$file: no plugin could process this file\n";
+    $stats->{'num_not_processed'} ++;
+    } else {
+    # was not recognised
+    if ($verbosity >= 2) {
+        &gsprintf($outhandle, "{plugin.no_plugin_could_recognise}\n", $file);
+        # print $outhandle "WARNING - no plugin could process $file\n";
+    }
+    # tell the GLI that it was not processed
+    print STDERR "<NonRecognisedFile n='$glifile'>\n" if $gli;
+    
+    $file =~ s/.*?([^\\\/]+)$/$1/;
+    &gsprintf($failhandle, "$file: {plugin.no_plugin_could_recognise_this_file}\n");
+    # print $failhandle "$file: no plugin could process this file\n";
+    $stats->{'num_not_recognised'} ++;
+    
+    }
 
     return 0;
@@ -156 +188 @@
 
     my $total = $stats->{'num_processed'} + $stats->{'num_blocked'} + 
-    $stats->{'num_not_processed'};
-
-    print STDERR "<ImportComplete considered='$total' processed='$stats->{'num_processed'}' blocked='$stats->{'num_blocked'}' ignored='$stats->{'num_not_processed'}'>\n" if $gli;
+    $stats->{'num_not_processed'} + $stats->{'num_not_recognised'};
+
+    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;
 
     if ($total == 1) {
     &gsprintf($statshandle, "* {plugin.one_considered}\n");
-    # print $statshandle "* 1 document was considered for processing\n";
     } else {
     &gsprintf($statshandle, "* {plugin.n_considered}\n", $total);
-    # 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) {
         &gsprintf($statshandle, "   ({plugin.including_archive})\n");
-        # print $statshandle ")\n";}
     }
     else {
         &gsprintf($statshandle, "   ({plugin.including_archives})\n", $stats->{'num_archives'});
-        # print $statshandle "s)\n";}
     }
     }
     if ($stats->{'num_processed'} == 1) {
     &gsprintf($statshandle, "* {plugin.one_included}\n");
-    # print $statshandle "* 1 was processed and included in the collection\n";
     } else {
     &gsprintf($statshandle, "* {plugin.n_included}\n", $stats->{'num_processed'});
-    # print $statshandle "* " . $stats->{'num_processed'} . " were processed and included in the collection\n";
+    }
+    if ($stats->{'num_not_recognised'}) {
+    if ($stats->{'num_not_recognised'} == 1) {
+        &gsprintf($statshandle, "* {plugin.one_unrecognised}\n");
+    } else {
+        &gsprintf($statshandle, "* {plugin.n_unrecognised}\n", $stats->{'num_not_recognised'});
+    }
+
     }
     if ($stats->{'num_not_processed'}) {
     if ($stats->{'num_not_processed'} == 1) {
         &gsprintf($statshandle, "* {plugin.one_rejected}\n");
-        # print $statshandle "* 1 was rejected.";
     } else {
         &gsprintf($statshandle, "* {plugin.n_rejected}\n", $stats->{'num_not_processed'});
-        # print $statshandle "* " . $stats->{'num_not_processed'} . " were rejected.";
-    }
+    }
+    }
+    if ($stats->{'num_not_processed'} || $stats->{'num_not_recognised'}) {
     &gsprintf($statshandle, " {plugin.see_faillog}\n", $faillog);
-    # print $statshandle " See $faillog for a list of rejected documents\n";
     }
 }