Changeset 17026 for gsdl/trunk/perllib/plugins/BasePlugin.pm

Timestamp:

2008-08-27T20:40:20+12:00 (16 years ago)

Author:

kjdon

Message:

OID generation modifications: OIDtype and OIDmetadata options now available for plugins as well as import. OIDtype for plugins defaults to auto - if set to auto, then use the values from import. All plugins now call self->add_OID instead of doc_obj->set_OID. This sets the doc_obj OIDtype so that doesn't need to be donein other places any more. all plugins have the get_oid_hash_type method - normally returns hash_on_file, but can be overridden to return hash_on_ga_xml for those plugins that don't want hashing on file (MP3,OggVorbis...)

File:

• gsdl/trunk/perllib/plugins/BasePlugin.pm (modified) (7 diffs)

gsdl/trunk/perllib/plugins/BasePlugin.pm

@@ -79 +79 @@
 
 our $oidtype_list = 
-    [ { 'name' => "hash",
+    [ { 'name' => "auto",
+    'desc' => "{BasePlugin.OIDtype.auto}" },
+      { 'name' => "hash",
         'desc' => "{import.OIDtype.hash}" },
       { 'name' => "assigned",
@@ -116 +118 @@
     'list' => $oidtype_list,
     # leave default empty so we can tell if its been set or not - if not set will use option from import.pl
-    #'deft' => "hash",
+    'deft' => "auto",
     'reqd' => "no",
     'modegli' => "2" },
@@ -282 +284 @@
     my ($pluginfo, $base_dir, $processor, $maxdocs) = @_;
 
+    if ($self->{'OIDtype'} eq "auto") {
+    # hasn't been set in the plugin, use the processor values
+    $self->{'OIDtype'} = $processor->{'OIDtype'};
+    $self->{'OIDmetadata'} = $processor->{'OIDmetadata'};
+    }
+    if ($self->{'OIDtype'} eq "hash") {
+    # should we hash on the file or on the doc xml??
+    $self->{'OIDtype'} = $self->get_oid_hash_type();
+    if ($self->{'OIDtype'} !~ /^(hash_on_file|hash_on_ga_xml)$/) {
+        $self->{'OIDtype'} = "hash_on_file";
+    }
+    }
 }
 
@@ -295 +309 @@
 
     my ($self) = @_;
+}
+
+# default hashing type is to hash on the original file (or converted file)
+# override this to return hash_on_ga_xml for filetypes where hashing on the 
+# file is no good eg video
+sub get_oid_hash_type {
+
+    my $self = shift (@_);
+
+    return "hash_on_file";
 }
 
@@ -715 +739 @@
     my ($doc_obj, $filename_no_path, $file_encoding) = @_;
 
+
     my $top_section = $doc_obj->get_top_section();
     
@@ -729 +754 @@
     $doc_obj->set_utf8_metadata_element($top_section, "SourceFile", $filemeta);
 }
-     
+   
+# this should be called by all plugins to set the oid of the doc obj, rather
+# than calling doc_obj->set_OID directly
 sub add_OID {
     my $self = shift (@_);  
     my ($doc_obj) = @_;
 
-    # See if a metadata field is specified as the field
-    if ((defined $self->{'use_as_doc_identifier'}) && ($self->{'use_as_doc_identifier'} ne "")) {
-    my $metadata_doc_id = $self->{'use_as_doc_identifier'};
-
-    # Consider "tidying" up metadata_doc_id to be something
-    # suitable in a URL
-    # Could even support a user specified plugin RE for this.
-
-    my $top_section = $doc_obj->get_top_section();
-    my $oid = $doc_obj->get_metadata_element($top_section,$metadata_doc_id);
-        $doc_obj->set_OID($oid);
-    }
-    # See if there is a plugin-specific set_OID function...
-    elsif (defined ($self->can('set_OID'))) {
-    # it will need $doc_obj to set the Identifier metadata...
-    $self->set_OID(@_); # pass through any extra arguments supplied
-    } else {
+    $doc_obj->set_OIDtype($self->{'OIDtype'}, $self->{'OIDmetadata'});
+
+    # see if there is a plugin specific set_OID function
+    if (defined ($self->can('set_OID'))) {
+    $self->set_OID(@_); # pass through doc_obj and any extra arguments
+    }
+    else {
     # use the default set_OID() in doc.pm
     $doc_obj->set_OID();
     }
-}
-
-
-
+
+}
+  
 # The BasePlugin read_into_doc_obj() function. This function does all the
 # right things to make general options work for a given plugin.  It doesn't do anything with the file other than setting reads in
@@ -791 +807 @@
     my $top_section = $doc_obj->get_top_section();
 
-    # this should look at the plugin option too...
-    $doc_obj->set_OIDtype ($processor->{'OIDtype'}, $processor->{'OIDmetadata'});    
     $doc_obj->add_utf8_metadata($top_section, "Plugin", "$self->{'plugin_type'}");
     $doc_obj->add_utf8_metadata($top_section, "FileSize", (-s $filename_full_path));