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

gsdl/trunk/perllib/plugins/MP3Plugin.pm

@@ -1 +1 @@
 ###########################################################################
 #
-# MP3Plug.pm -- Plugin for MP3 files (MPEG audio layer 3).
+# MP3Plugin.pm -- Plugin for MP3 files (MPEG audio layer 3).
 #
 # A component of the Greenstone digital library software from the New
@@ -26 +26 @@
 
 
-package MP3Plug;
-
-use UnknownPlug;
+package MP3Plugin;
+
+use BasePlugin;
 
 use strict;
 no strict 'refs'; # allow filehandles to be variables and viceversa
+no strict 'subs';
 
 use MP3::Info;
@@ -38 +39 @@
 
 sub BEGIN {
-    @MP3Plug::ISA = ('UnknownPlug');
+    @MP3Plugin::ISA = ('BasePlugin');
 }
 
 my $arguments =
     [ { 'name' => "process_exp",
-    'desc' => "{BasPlug.process_exp}",
+    'desc' => "{BasePlugin.process_exp}",
     'type' => "regexp",
     'deft' => &get_default_process_exp(),
     'reqd' => "no" },
       { 'name' => "assoc_images",
-        'desc' => "{MP3Plug.assoc_images}",
+        'desc' => "{MP3Plugin.assoc_images}",
         'type' => "flag",
         'deft' => "",
         'reqd' => "no" },
       { 'name' => "applet_metadata",
-    'desc' => "{MP3Plug.applet_metadata}",
+    'desc' => "{MP3Plugin.applet_metadata}",
     'type' => "flag",
     'deft' => "" },
       { 'name' => "metadata_fields",
-    'desc' => "{MP3Plug.metadata_fields}",
+    'desc' => "{MP3Plugin.metadata_fields}",
     'type' => "string",
     'deft' => "Title,Artist,Genre" } ];
 
-my $options = { 'name'     => "MP3Plug",
-        'desc'     => "{MP3Plug.desc}",
+my $options = { 'name'     => "MP3Plugin",
+        'desc'     => "{MP3Plugin.desc}",
         'abstract' => "no",
         'inherits' => "yes",
@@ -72 +73 @@
     push(@$pluginlist, $class);
 
-    if(defined $arguments){ push(@{$hashArgOptLists->{"ArgList"}},@{$arguments});}
-    if(defined $options) { push(@{$hashArgOptLists->{"OptList"}},$options)};
-
-    my $self = new UnknownPlug($pluginlist, $inputargs, $hashArgOptLists);
+    push(@{$hashArgOptLists->{"ArgList"}},@{$arguments});
+    push(@{$hashArgOptLists->{"OptList"}},$options);
+
+    my $self = new BasePlugin($pluginlist, $inputargs, $hashArgOptLists);
 
     return bless $self, $class;
@@ -82 +83 @@
 sub get_default_process_exp {
     return q^(?i)\.mp3$^;
+}
+
+sub process {
+    my $self = shift (@_);
+    my ($pluginfo, $base_dir, $file, $metadata, $doc_obj, $gli) = @_;
+
+    my ($filename_full_path, $filename_no_path) = $self->get_full_filenames($base_dir, $file);
+    # do something about OIDtype so no hashing
+     
+    # old code was in effect the following. 
+    if ($doc_obj->{'OIDtype'} =~ /^hash$/) {
+    $doc_obj->set_OIDtype ("incremental");
+    }
+
+
+    # associate the file with the document
+    if ($self->associate_mp3_file($filename_full_path, $filename_no_path, $doc_obj) != 1)
+    {
+    print "MP3Plugin: couldn't process \"$filename_full_path\"\n";
+    return 0;
+    }
+   
+    #whats this crap?
+   my $text = &gsprintf::lookup_string("{BasePlugin.dummy_text}",1);
+    if ($self->{'assoc_images'}) {
+    $text .= "[img1]<br>";
+    $text .= "[img2]<br>";
+    }
+    $doc_obj->add_utf8_text($doc_obj->get_top_section(), $text);
+
 }
 
@@ -155 +186 @@
 
     $doc_obj->associate_file($filename, $dst_file, $mime_type, $section);
-    $doc_obj->add_metadata ($section, "Source", $file);
     $doc_obj->add_metadata ($section, $assoc_field, $assoc_name);
     $doc_obj->add_metadata ($section, "srcurl", $assoc_url);
@@ -295 +325 @@
 
 
-
-# The MP3Plug read() function is based on UnknownPlug read().  This
-# function does all the right things to make general options work for
-# a given plugin. 
-
-my $mp3_doc_count = 0; ## is this used anywhere now !!???
-
-sub read {
-    my $self = shift (@_);
-    my ($pluginfo, $base_dir, $file, $metadata, $processor, $maxdocs, $total_count, $gli) = @_;
-
-    my $outhandle = $self->{'outhandle'};
-
-    #check for associate_ext, blocking etc
-    my ($block_status,$filename) = $self->read_block(@_);    
-    return $block_status if ((!defined $block_status) || ($block_status==0));
-
-    print STDERR "<Processing n='$file' p='MP3Plug'>\n" if ($gli);
-    print $outhandle "MP3Plug processing \"$filename\"\n"
-        if $self->{'verbosity'} > 1;
-
-    #if there's a leading directory name, eat it...
-    $file =~ s/^.*[\/\\]//;
-    
-    # create a new document
-    my $doc_obj = new doc ($filename, "indexed_doc");
-    $mp3_doc_count++;
-    
-##    $doc_obj->set_OIDtype ($processor->{'OIDtype'});  
-    if ($processor->{'OIDtype'} =~ /^(assigned|dirname)$/) {
-    $doc_obj->set_OIDtype ($processor->{'OIDtype'}, $processor->{'OIDmetadata'});
-    }
-    else {
-    $doc_obj->set_OIDtype ("incremental");    # this is done to avoid hashing content of file
-    }
-    $doc_obj->add_utf8_metadata($doc_obj->get_top_section(), "Plugin", "$self->{'plugin_type'}");
-    $doc_obj->add_utf8_metadata($doc_obj->get_top_section(), "FileSize", (-s $filename));
-
-    # associate the file with the document
-    if (associate_mp3_file($self, $filename, $file, $doc_obj) != 1)
-    {
-    print "MP3Plug: couldn't process \"$filename\"\n";
-    return 0;
-    }
-
-    #create an empty text string so we don't break downstream plugins 
-    my $text = &gsprintf::lookup_string("{BasPlug.dummy_text}",1);
-    if ($self->{'assoc_images'}) {
-    $text .= "[img1]<br>";
-    $text .= "[img2]<br>";
-    }
-    # include any metadata passed in from previous plugins 
-    my $section = $doc_obj->get_top_section();
-    $self->extra_metadata ($doc_obj, $section, $metadata);
-
-    $self->title_fallback($doc_obj,$section,$file);
-
-    # do plugin specific processing of doc_obj
-    return undef unless defined ($self->process (\$text, $pluginfo, $base_dir, 
-                         $file, $metadata, $doc_obj));
-
-    # do any automatic metadata extraction
-    $self->auto_extract_metadata ($doc_obj);
-
-    # add an OID
-    $doc_obj->set_OID();
-    $doc_obj->add_utf8_text($section, $text);
-
-    # process the document
-    $processor->process($doc_obj);
-
-    $self->{'num_processed'} ++;
-    return 1;
-}
-
-
+# we want to use mp3:Title if its there, otherwise we'll use BasePlugin method
 sub title_fallback
 {
@@ -382 +337 @@
     }
     else {
-        &BasPlug::title_fallback($self, $doc_obj, $section, $file);
+        $self->BasePlugin::title_fallback($doc_obj, $section, $file);
     }
     }