Changeset 15872 for gsdl/trunk/perllib/plugins/LOMPlugin.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/LOMPlugin.pm (modified) (8 diffs)

gsdl/trunk/perllib/plugins/LOMPlugin.pm

@@ -1 +1 @@
 ###########################################################################
 #
-# LOMPlug.pm -- plugin for import the collection from LOM
+# LOMPlugin.pm -- plugin for import the collection from LOM
 # 
 # A component of the Greenstone digital library software
@@ -27 +27 @@
 ### Note this plugin currently can't download source documents from outside if you are behind a firewall.
 
-package LOMPlug;
-
-use BasPlug;
+package LOMPlugin;
+
+use ReadTextFile;
 use MetadataPass;
 use XMLParser;
@@ -35 +35 @@
 
 sub BEGIN {
-    @ISA = ('BasPlug', 'MetadataPass');
+    @ISA = ('ReadTextFile', 'MetadataPass');
 }
 
@@ -44 +44 @@
 my $arguments =
     [ { 'name' => "process_exp",
-    'desc' => "{BasPlug.process_exp}",
+    'desc' => "{ReadTextFile.process_exp}",
     'type' => "string",
     'deft' => &get_default_process_exp(),
     'reqd' => "no" },
       { 'name' => "root_tag",
-    'desc' => "{LOMPlug.root_tag}",
+    'desc' => "{LOMPlugin.root_tag}",
     'type' => "regexp",
     'deft' => q/^(?i)lom$/,
     'reqd' => "no" },
       { 'name' => "check_timestamp",
-    'desc' => "{LOMPlug.check_timestamp}",
+    'desc' => "{LOMPlugin.check_timestamp}",
     'type' => "flag" },
       { 'name' => "download_srcdocs",
-    'desc' => "{LOMPlug.download_srcdocs}",
+    'desc' => "{LOMPlugin.download_srcdocs}",
     'type' => "regexp",
     'deft' => "",
     'reqd' => "no" }];
 
-my $options = { 'name'     => "LOMPlug",
-        'desc'     => "{LOMPlug.desc}",
+my $options = { 'name'     => "LOMPlugin",
+        'desc'     => "{LOMPlugin.desc}",
         'inherits' => "yes",
         'args'     => $arguments };
@@ -75 +75 @@
     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);
    
-    $self = new BasPlug($pluginlist, $inputargs, $hashArgOptLists);
+    $self = new ReadTextFile($pluginlist, $inputargs, $hashArgOptLists);
+
+    if ($self->{'info_only'}) {
+    # don't worry about creating the XML parser as all we want is the 
+    # list of plugin options
+    return bless $self, $class;
+    }
 
     #create XML::Parser object for parsing dublin_core.xml files
@@ -120 +126 @@
     $file =~ s/^[\/\\]+//; # $file often begins with / so we'll tidy it up
     
-    print $outhandle "LOMPlug: extracting metadata from $file\n"
+    print $outhandle "LOMPlugin: extracting metadata from $file\n"
     if $self->{'verbosity'} > 1;
 
@@ -131 +137 @@
     
     if ($@) {
-    print $outhandle "LOMPlug: skipping $filename as not conformant to LOM syntax\n" if ($self->{'verbosity'} > 1);
+    print $outhandle "LOMPlugin: skipping $filename as not conformant to LOM syntax\n" if ($self->{'verbosity'} > 1);
     print $outhandle "\n Perl Error:\n $@\n" if ($self->{'verbosity'}>2);
     return 0;
@@ -262 +268 @@
     my $outhandle = $self->{'outhandle'};
 
-    print STDERR "<Processing n='$file' p='LOMPlug'>\n" if ($gli);
+    print STDERR "<Processing n='$file' p='LOMPlugin'>\n" if ($gli);
 
     print $outhandle "LOMPLug: processing $file\n";