Changeset 7362

Timestamp:

2004-05-21T11:03:12+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

Location:

trunk/gsdl/perllib/plugins

Files:

• BasPlug.pm (modified) (4 diffs)
• ConvertToPlug.pm (modified) (1 diff)
• ConvertToRogPlug.pm (modified) (1 diff)
• FOXPlug.pm (modified) (4 diffs)
• GMLPlug.pm (modified) (1 diff)
• ImagePlug.pm (modified) (2 diffs)
• OAIPlug.pm (modified) (1 diff)
• PagedImgPlug.pm (modified) (1 diff)
• RecPlug.pm (modified) (1 diff)
• SplitPlug.pm (modified) (1 diff)
• TEXTPlug.pm (modified) (1 diff)
• UnknownPlug.pm (modified) (2 diffs)
• W3ImgPlug.pm (modified) (2 diffs)
• XMLPlug.pm (modified) (1 diff)

trunk/gsdl/perllib/plugins/BasPlug.pm

@@ -400 +400 @@
 # GMLPlug) should normally implement their own version of read()
 #
-# Return number of files processed, undef if can't process
+# Return number of files processed, undef if can't recognise, -1 if can't
+# process
 # Note that $base_dir might be "" and that $file might 
 # include directories
@@ -420 +421 @@
     if ($self->{'block_exp'} ne "" && $filename =~ /$self->{'block_exp'}/) {
     $self->{'num_blocked'} ++;
-    return 0;
+    return 0; # blocked
     }
     if ($filename !~ /$self->{'process_exp'}/ || !-f $filename) {
-    return undef;
+    return undef; # can't recognise
     }
     $file =~ s/^[\/\\]+//; # $file often begins with / so we'll tidy it up
@@ -456 +457 @@
     $self->{'num_not_processed'} ++;
 
-    return 0;
+    return 0; # what should we return here?? error but don't want to pass it on
     }
    
@@ -464 +465 @@
 
     # do plugin specific processing of doc_obj
-    return undef unless defined ($self->process (\$text, $pluginfo, $base_dir, $file, $metadata, $doc_obj, $gli));
+    return -1  unless defined ($self->process (\$text, $pluginfo, $base_dir, $file, $metadata, $doc_obj, $gli));
    
     # do any automatic metadata extraction

trunk/gsdl/perllib/plugins/ConvertToPlug.pm

@@ -314 +314 @@
     $self->extra_metadata ($doc_obj, $doc_obj->get_top_section(), $metadata);
     # do plugin specific processing of doc_obj
-    return undef unless defined ($self->process (\$text, $pluginfo, $base_dir, $file, $metadata, $doc_obj));
+    return -1 unless defined ($self->process (\$text, $pluginfo, $base_dir, $file, $metadata, $doc_obj));
     # do any automatic metadata extraction
     $self->auto_extract_metadata ($doc_obj);

trunk/gsdl/perllib/plugins/ConvertToRogPlug.pm

@@ -411 +411 @@
     $self->extra_metadata ($doc_obj, $doc_obj->get_top_section(), $metadata);
     # do plugin specific processing of doc_obj
-    return undef unless defined ($self->process (\$text, $pluginfo, $base_dir, $file, $metadata, $doc_obj));
+    return -1 unless defined ($self->process (\$text, $pluginfo, $base_dir, $file, $metadata, $doc_obj));
     # do any automatic metadata extraction
     $self->auto_extract_metadata ($doc_obj);

trunk/gsdl/perllib/plugins/FOXPlug.pm

@@ -87 +87 @@
     if (!open (FOXBASEIN, $fullname)) {
     print STDERR "FOXPlug::read - couldn't read $fullname\n";
-    return undef;
+    return -1; # error in processing
     }
 
@@ -101 +101 @@
     print STDERR "FOXPlug::read - eof while reading database header";
     close (FOXBASEIN);
-    return undef;
+    return -1;
     }
     
@@ -117 +117 @@
     } else {
     print STDERR "FOXPlug:read $fullname doesn't seem to be a Foxbase file\n";
-    return undef;
+    return -1;
     }
 
@@ -147 +147 @@
     print STDERR "FOXPlug::read - couldn't read $dbtfullname\n";
     close (FOXBASEIN);
-    return undef;
+    return -1;
     }
 

trunk/gsdl/perllib/plugins/GMLPlug.pm

@@ -94 +94 @@
     if (!open (INFILE, $filename)) {
     print $outhandle "GMLPlug::read - couldn't read $filename\n";
-    return 0;
+    return -1;
     }
 

trunk/gsdl/perllib/plugins/ImagePlug.pm

@@ -368 +368 @@
     {
     print "ImagePlug: couldn't process \"$filename\"\n";
-    return 0;
+    return -1; # error during processing
     }
 
@@ -380 +380 @@
 
     # do plugin specific processing of doc_obj
-    return undef unless defined ($self->process (\$text, $pluginfo, $base_dir, 
+    return -1 unless defined ($self->process (\$text, $pluginfo, $base_dir, 
                          $file, $metadata, $doc_obj));
 

trunk/gsdl/perllib/plugins/OAIPlug.pm

@@ -148 +148 @@
 
     # do plugin specific processing of doc_obj
-    return undef unless defined ($self->process (\$text, $pluginfo, $base_dir, $file, $metadata, $doc_obj));
+    return -1 unless defined ($self->process (\$text, $pluginfo, $base_dir, $file, $metadata, $doc_obj));
 
     # do any automatic metadata extraction

trunk/gsdl/perllib/plugins/PagedImgPlug.pm

@@ -519 +519 @@
 
     # do plugin specific processing of doc_obj
-    return undef unless defined ($self->process (\$text, $pluginfo, $base_dir, 
+    return -1 unless defined ($self->process (\$text, $pluginfo, $base_dir, 
                          $file, $metadata, $doc_obj));
 

trunk/gsdl/perllib/plugins/RecPlug.pm

@@ -228 +228 @@
     if (!opendir (DIR, $dirname)) {
     print $outhandle "RecPlug: WARNING - couldn't read directory $dirname\n";
-    return undef;
+    return -1; # error in processing
     }
     @dir = readdir (DIR);

trunk/gsdl/perllib/plugins/SplitPlug.pm

@@ -154 +154 @@
     $self->{'num_not_processed'} ++;
 
-    return 0;
+    return 0; # not processed but no point in passing it on
     }
     

trunk/gsdl/perllib/plugins/TEXTPlug.pm

@@ -95 +95 @@
     
     my $cursection = $doc_obj->get_top_section();
-    
+    return undef; # an error
     # get title metadata
     # (don't need to get title if it has been passed

trunk/gsdl/perllib/plugins/UnknownPlug.pm

@@ -189 +189 @@
     {
     print "UnknownPlug: couldn't process \"$filename\"\n";
-    return 0;
+    return -1; # error during processing
     }
 
@@ -200 +200 @@
 
     # do plugin specific processing of doc_obj
-    return undef unless defined ($self->process (\$text, $pluginfo, $base_dir, 
+    return -1 unless defined ($self->process (\$text, $pluginfo, $base_dir, 
                          $file, $metadata, $doc_obj));
 

trunk/gsdl/perllib/plugins/W3ImgPlug.pm

@@ -411 +411 @@
 }
 
-# return number of files processed, undef if can't process
+# return number of files processed, undef if can't recognise, -1 if 
+# cant process
 # Note that $base_dir might be "" and that $file might 
 # include directories
@@ -419 +420 @@
     # forward normal read (runs HTMLPlug if index_pages T)
     my $ok =  $self->SUPER::read($pluginfo, $base_dir, $file, $metadata, $processor, $maxdocs); 
-    if ( ! $ok ) { return $ok }
+    if ( ! $ok ) { return $ok } # what is this returning??
 
     my $outhandle = $self->{'outhandle'};

trunk/gsdl/perllib/plugins/XMLPlug.pm

@@ -117 +117 @@
     # reset ourself for the next document
     $self->{'section_level'}=0;
-    return undef;
+    return -1; # error during processing
     }