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

gsdl/trunk/perllib/plugins/DSpacePlugin.pm

@@ -2 +2 @@
 ###########################################################################
 #
-# DSpacePlug.pm -- plugin for import the collection from DSpace 
+# DSpacePlugin.pm -- plugin for importing a collection from DSpace 
 # 
 # A component of the Greenstone digital library software
@@ -8 +8 @@
 # University of Waikato, New Zealand.
 #
-# Copyright (C) 1999 New Zealand Digital Library Project
+# Copyright (C) 2004 New Zealand Digital Library Project
 #
 # This program is free software; you can redistribute it and/or modify
@@ -26 +26 @@
 ###########################################################################
 
-# DSpace Plug - 10/2004
-# 
-#
+
 # This plugin takes "contents" and dublin_core.xml file, which contain 
 # Metadata and lists of associated files for a particular document
@@ -47 +45 @@
 #
 
-package DSpacePlug;
-
-use BasPlug;
+package DSpacePlugin;
+
+use BasePlugin;
 use plugin;
-#use ghtml;
 use XMLParser;
 use strict;
@@ -57 +54 @@
 
 sub BEGIN {
-    @DSpacePlug::ISA = ('BasPlug');
+    @DSpacePlugin::ISA = ('BasePlugin');
 }
 
 my $arguments =
     [ { 'name' => "process_exp",
-    'desc' => "{BasPlug.process_exp}",
+    'desc' => "{BasePlugin.process_exp}",
     'type' => "string",
     'deft' => &get_default_process_exp(),
     'reqd' => "no" },
       { 'name' => "only_first_doc",
-    'desc' => "{DSpacePlug.only_first_doc}",
+    'desc' => "{DSpacePlugin.only_first_doc}",
     'type' => "flag",
     'reqd' => "no" },
       { 'name' => "first_inorder_ext",
-    'desc' => "{DSpacePlug.first_inorder_ext}",
+    'desc' => "{DSpacePlugin.first_inorder_ext}",
     'type' => "string",
     'reqd' => "no" },
       { 'name' => "first_inorder_mime",
-    'desc' => "{DSpacePlug.first_inorder_mime}",
+    'desc' => "{DSpacePlugin.first_inorder_mime}",
     'type' => "flag",
     'reqd' => "no" },
       { 'name' => "block_exp",
-    'desc' => "{BasPlug.block_exp}",
+    'desc' => "{BasePlugin.block_exp}",
     'type' => "regexp",
     'deft' => &get_default_block_exp(),
@@ -85 +82 @@
 
 
-my $options = { 'name'     => "DSpacePlug",
-        'desc'     => "{DSpacePlug.desc}",
+my $options = { 'name'     => "DSpacePlugin",
+        'desc'     => "{DSpacePlugin.desc}",
         'inherits' => "yes",
         'abstract' => "no",
@@ -104 +101 @@
     push(@$pluginlist, $class);
 
-    if(defined $arguments){ push(@{$hashArgOptLists->{"ArgList"}},@{$arguments});}
-    if(defined $options) { push(@{$hashArgOptLists->{"OptList"}},$options)};
-
-    $self = new BasPlug($pluginlist, $inputargs, $hashArgOptLists);
-    
+    push(@{$hashArgOptLists->{"ArgList"}},@{$arguments});
+    push(@{$hashArgOptLists->{"OptList"}},$options);
+
+    $self = new BasePlugin($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
     my $parser = new XML::Parser('Style' => 'Stream',
@@ -252 +255 @@
     }
     
-    print $outhandle "DSpacePlug: extracting metadata from $file\n"
+    print $outhandle "DSpacePlugin: extracting metadata from $file\n"
     if $self->{'verbosity'} > 1;
     
@@ -262 +265 @@
     
     if ($@) {
-    die "DSpacePlug: ERROR $filename is not a well formed dublin_core.xml file ($@)\n";
+    die "DSpacePlugin: ERROR $filename is not a well formed dublin_core.xml file ($@)\n";
     }
 
@@ -287 +290 @@
 
     # Temporarily store associate file info in metadata table
-    # This will be removed in 'extra_metadata' in BasPlug and used
+    # This will be removed in 'extra_metadata' in BasePlugin and used
     # to perform the actual file association (once the doc obj has
     # been formed
@@ -313 +316 @@
 
 
-# The DSpacePlug read() function. This function does all the right things
-# to make general options work for a given plugin. It calls the process()
-# function which does all the work specific to a plugin (like the old
-# read functions used to do). Most plugins should define their own 
-# process() function and let this read() function keep control.
-#
-# DSpace overrides read() because there is no need to read the actual 
-# text of the file in, because the contents of the file is not text...
-#
-# Return number of files processed, undef if can't process
-# Note that $base_dir might be "" and that $file might 
-# include directories
-
+# The DSpacePlugin read() function. We are not actually reading any documents 
+# here, just blocking ones that have been processed by metadata read.
+#
+# Returns 0 for a file its blocking, undef for any other
 sub read {
     my $self = shift (@_);
@@ -340 +334 @@
     return 0 if (defined $self->{'extra_blocks'}->{$filename});
     return undef;
-}
-
-# do plugin specific processing of doc_obj
-sub process {
-    my $self = shift (@_);
-    my ($textref, $pluginfo, $base_dir, $file, $metadata, $doc_obj) = @_;
-    my $outhandle = $self->{'outhandle'};
-    
-    return 1;
 }