Changeset 15872 for gsdl/trunk/perllib/plugins/MetadataCSVPlugin.pm

Timestamp:

2008-06-05T09:29:32+12:00 (16 years ago)

Author:

kjdon

Message:

plugin overhaul: plugins renamed to xxPlugin, and in some cases the names are made more sensible. They now use the new base plugins. Hopefully we have better code reuse. Some of the plugins still need work done as I didn't want to spend another month doing this before committing it. Alos, I haven't really tested anything yet...

File:

• gsdl/trunk/perllib/plugins/MetadataCSVPlugin.pm (modified) (11 diffs)

gsdl/trunk/perllib/plugins/MetadataCSVPlugin.pm

@@ -1 +1 @@
 ###########################################################################
 #
-# MetadataCSVPlug.pm -- A plugin for metadata in comma-separated value format
+# MetadataCSVPlugin.pm -- A plugin for metadata in comma-separated value format
 #
 # A component of the Greenstone digital library software
@@ -25 +25 @@
 ###########################################################################
 
-package MetadataCSVPlug;
+package MetadataCSVPlugin;
 
 
-use BasPlug;
+use BasePlugin;
 use strict;
 
 
 sub BEGIN {
-    @MetadataCSVPlug::ISA = ('BasPlug');
+    @MetadataCSVPlugin::ISA = ('BasePlugin');
 }
 
@@ -39 +39 @@
 my $arguments =
     [ { 'name' => "block_exp",
-    'desc' => "{BasPlug.block_exp}",
+    'desc' => "{BasePlugin.block_exp}",
     'type' => "regexp",
     'reqd' => "no",
@@ -45 +45 @@
 
 
-my $options = { 'name'     => "MetadataCSVPlug",
-        'desc'     => "{MetadataCSVPlug.desc}",
+my $options = { 'name'     => "MetadataCSVPlugin",
+        'desc'     => "{MetadataCSVPlugin.desc}",
         'abstract' => "no",
         'inherits' => "yes",
@@ -58 +58 @@
     push(@$pluginlist, $class);
 
-    if(defined $arguments){ push(@{$hashArgOptLists->{"ArgList"}},@{$arguments});}
-    if(defined $options) { push(@{$hashArgOptLists->{"OptList"}},$options)};
+    push(@{$hashArgOptLists->{"ArgList"}},@{$arguments});
+    push(@{$hashArgOptLists->{"OptList"}},$options);
 
-    my $self = new BasPlug($pluginlist, $inputargs, $hashArgOptLists);
+    my $self = new BasePlugin($pluginlist, $inputargs, $hashArgOptLists);
 
     return bless $self, $class;
@@ -74 +74 @@
 
 
-# We don't want any other plugins to see .csv files
+# Used by BasePlugin read to block this file
 sub get_default_block_exp
 {
@@ -91 +91 @@
     return undef;
     }
-    print STDERR "\n<Processing n='$file' p='MetadataCSVPlug'>\n" if ($gli);
-    print STDERR "MetadataCSVPlug: processing $file\n" if ($self->{'verbosity'}) > 1;
+    print STDERR "\n<Processing n='$file' p='MetadataCSVPlugin'>\n" if ($gli);
+    print STDERR "MetadataCSVPlugin: processing $file\n" if ($self->{'verbosity'}) > 1;
 
     # Read the CSV file to get the metadata
@@ -98 +98 @@
     open(CSV_FILE, "$filename");
     my $csv_file_reader = new multiread();
-    $csv_file_reader->set_handle('MetadataCSVPlug::CSV_FILE');
+    $csv_file_reader->set_handle('MetadataCSVPlugin::CSV_FILE');
     $csv_file_reader->read_file(\$csv_file_content);
     close(CSV_FILE);
@@ -118 +118 @@
 
     if (!$found_filename_field) {
-    print STDERR "MetadataCSVPlug Error: No Filename field in CSV file: $filename\n";
+    print STDERR "MetadataCSVPlugin Error: No Filename field in CSV file: $filename\n";
     return -1; # error
     }
@@ -153 +153 @@
         # The line must be formatted incorrectly
         else {
-        print STDERR "MetadataCSVPlug Error: Badly formatted CSV line: $csv_line.\n";
+        print STDERR "MetadataCSVPlugin Error: Badly formatted CSV line: $csv_line.\n";
         last;
         }
@@ -163 +163 @@
     my $csv_line_filename_array = $csv_line_metadata{"Filename"};
     if (!defined $csv_line_filename_array) {
-        print STDERR "MetadataCSVPlug Error: No Filename metadata in CSV line: $orig_csv_line\n";
+        print STDERR "MetadataCSVPlugin Error: No Filename metadata in CSV line: $orig_csv_line\n";
         next;
     }