Changeset 7504

Timestamp:

2004-05-31T14:41:11+12:00 (20 years ago)

Author:

davidb

Message:

ImagePlug, MP3Plug, UnknownPlug modified to set Title metadata based
on filename if no explicit Title metadata given. Also FileFormat
metadata is now also set to indicate type of file processed. To
share some of the functionality introduced some of the new code is
located in BasPlug.

Location:

trunk/gsdl/perllib/plugins

Files:

• BasPlug.pm (modified) (1 diff)
• ImagePlug.pm (modified) (1 diff)
• MP3Plug.pm (modified) (6 diffs)
• UnknownPlug.pm (modified) (4 diffs)

trunk/gsdl/perllib/plugins/BasPlug.pm

@@ -540 +540 @@
 }
 
+sub filename_based_title
+{
+    my $self = shift (@_);
+    my ($file) = @_;
+
+    my $file_derived_title = $file;
+    $file_derived_title =~ s/_/ /g;
+    $file_derived_title =~ s/\..*?$//;
+
+    return $file_derived_title;
+}
+
+
+sub title_fallback
+{
+    my $self = shift (@_);
+    my ($doc_obj,$section,$file) = @_;
+
+    if (!defined $doc_obj->get_metadata_element ($section, "Title")) {
+
+    my $file_derived_title = $self->filename_based_title($file);
+    $doc_obj->add_metadata ($section, "Title", $file_derived_title);
+    }
+}
+
 sub textcat_get_language_encoding {
     my $self = shift (@_);

trunk/gsdl/perllib/plugins/ImagePlug.pm

@@ -178 +178 @@
     $doc_obj->add_metadata ($section, "Source", $url);
 
+    $self->title_fallback($doc_obj,$section,$file);
+    $doc_obj->add_metadata ($section, "FileFormat", $type);
+
     my ($image_type, $image_width, $image_height, $image_size) 
     = &identify($filename, $outhandle, $verbosity);

trunk/gsdl/perllib/plugins/MP3Plug.pm

@@ -44 +44 @@
         'type' => "flag",
         'deft' => "",
-        'reqd' => "no" } ];
+        'reqd' => "no" },
+      { 'name' => "applet_metadata",
+    'desc' => "{MP3Plug.applet_metadata}",
+    'type' => "flag",
+    'deft' => "" },
+      { 'name' => "metadata_fields",
+    'desc' => "{MP3Plug.metadata_fields}",
+    'type' => "string",
+    'deft' => "Title,Artist,Genre" } ];
 
 my $options = { 'name'     => "MP3Plug",
@@ -62 +70 @@
     if (!parsargv::parse(\@_, 
              q^assoc_images^, \$self->{'assoc_images'},
+             q^applet_metadata^, \$self->{'applet_metadata'},
+             q^metadata_fields/.*/Title,Artist,Genre^, \$self->{'metadata_fields'},
              "allow_extra_options")) {
     print STDERR "\nIncorrect options passed to MP3Plug, check your collect.cfg configuration file\n";
@@ -140 +150 @@
     # Add the file as an associated file ...
     my $section = $doc_obj->get_top_section();
-    my $file_type = $self->{'file_type'} || "audio/mp3";
+    my $mime_type = $self->{'mime_type'} || "audio/mp3";
     my $assoc_field = $self->{'assoc_field'} || "mp3";
     my $assoc_name = $file;
     $assoc_name =~ s/\.mp3$//;
 
-    $doc_obj->associate_file($filename, $dst_file, $file_type, $section);
+    $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);
 
+    $self->title_fallback($doc_obj,$section,$file);
+    $doc_obj->add_metadata ($section, "FileFormat", "MP3");
+
     my $mp3_info = get_mp3info($filename);
-    foreach my $ki ( keys %$mp3_info ) {
-    my $mp3_metavalue = $mp3_info->{$ki};
-
-    if ($mp3_metavalue !~ m/^\s*$/s) {
-        my $mp3_metaname = "mp3:".lc($ki);
-        $doc_obj->add_metadata ($section, $mp3_metaname, $mp3_metavalue);
-    }
-    }
-
     my $mp3_tags = get_mp3tag($filename);
-    foreach my $kt ( keys %$mp3_tags ) {
-    my $mp3_metavalue = $mp3_tags->{$kt};
-
-    if ($mp3_metavalue !~ m/^\s*$/s) {
-        my $kt_len = length($kt);
-        $kt_initial_cap = uc(substr($kt,0,1)).lc(substr($kt,1,$kt_len-1));
-        my $mp3_metaname = "mp3:".$kt_initial_cap;
-
-        $doc_obj->add_metadata ($section, $mp3_metaname, $mp3_metavalue);
-        if ($mp3_metaname eq "mp3:Title") {
-        $doc_obj->add_metadata ($section, "Title", $mp3_metavalue);
-        }
+
+    my $metadata_fields = $self->{'metadata_fields'};
+
+    if ($metadata_fields eq "*") {
+    # Locate all info and tag metadata
+
+    foreach my $ki ( keys %$mp3_info ) {
+        my $mp3_metavalue = $mp3_info->{$ki};
+
+        if ($mp3_metavalue !~ m/^\s*$/s) {
+        my $mp3_metaname = "mp3:".lc($ki);
+        $doc_obj->add_metadata ($section, $mp3_metaname, $mp3_metavalue);
+        }
+    }
+
+    foreach my $kt ( keys %$mp3_tags ) {
+        my $mp3_metavalue = $mp3_tags->{$kt};
+        
+        if ($mp3_metavalue !~ m/^\s*$/s) {
+        my $kt_len = length($kt);
+        $kt_initial_cap = uc(substr($kt,0,1)).lc(substr($kt,1,$kt_len-1));
+        my $mp3_metaname = "mp3:".$kt_initial_cap;
+        
+        $doc_obj->add_metadata ($section, $mp3_metaname, $mp3_metavalue);
+        if ($mp3_metaname eq "mp3:Title") {
+            $doc_obj->add_metadata ($section, "Title", $mp3_metavalue);
+        }
+        }
+    }
+    }
+    else {
+
+    # Restrict metadata to that specifically given
+    foreach my $field (split /,/, $metadata_fields) {
+
+        # check info
+        if (defined $mp3_info->{$field}) {
+
+        my $mp3i_metavalue = $mp3_info->{$field};
+        
+        if ($mp3i_metavalue !~ m/^\s*$/s) {
+            my $mp3i_metaname = "mp3:".lc($field);
+            $doc_obj->add_metadata ($section, $mp3i_metaname, $mp3i_metavalue);
+        }
+        }
+
+        # check tags
+        if (defined $mp3_tags->{$field}) {
+
+        my $mp3t_metavalue = $mp3_tags->{uc($field)};
+        
+        if ($mp3t_metavalue !~ m/^\s*$/s) {
+            my $mp3t_metaname = "mp3:".$field;
+            
+            $doc_obj->add_metadata ($section, $mp3t_metaname, $mp3t_metavalue);
+            if ($mp3t_metaname eq "mp3:Title") {
+            $doc_obj->add_metadata ($section, "Title", $mp3t_metavalue);
+            }
+        }
+        }
+        
     }
     }
@@ -178 +231 @@
     $doc_obj->add_metadata ($section, "srclink", 
                 "<a href=_httpcollection_/index/assoc/[assocfilepath]/[srcurl]>");
-    $doc_obj->add_metadata ($section, "srcicon", 
-                "<img src=_httpimg_/mp3icon.gif>");
+    $doc_obj->add_metadata ($section, "srcicon", "<img src=_httpimg_/mp3icon.gif>");
     $doc_obj->add_metadata ($section, "/srclink", "</a>");
 
-    $doc_obj->add_metadata ($section, "mp3applet", 
-                gen_mp3applet("_httpcollection_/index/assoc/[assocfilepath]/[srcurl]"));
-
-
+    my $applet_metadata = $self->{'applet_metadata'};
+    if (defined $applet_metadata && $applet_metadata ) {
+    my $applet_html 
+        = gen_mp3applet("_httpcollection_/index/assoc/[assocfilepath]/[srcurl]");
+    $doc_obj->add_metadata ($section, "mp3applet", $applet_html);
+    }
 
     my $assoc_images = $self->{'assoc_images'};
@@ -252 +306 @@
 # a given plugin. 
 
-my $mp3_doc_count = 0;
+my $mp3_doc_count = 0; ## is this used anywhere now !!???
 
 sub read {
@@ -278 +332 @@
     
 ##    $doc_obj->set_OIDtype ($processor->{'OIDtype'});    
-    $doc_obj->set_OIDtype ("incremental");    
+    $doc_obj->set_OIDtype ("incremental");    # this is done to avoid hashing content of file
     $doc_obj->add_utf8_metadata($doc_obj->get_top_section(), "$self->{'plugin_type'}", "1");
 

trunk/gsdl/perllib/plugins/UnknownPlug.pm

@@ -70 +70 @@
     'deft' => "",
     'reqd' => "no" } ,
-      { 'name' => "file_type",
-    'desc' => "{UnknownPlug.file_type}",
+      { 'name' => "file_format",
+    'desc' => "{UnknownPlug.file_format}",
+    'type' => "string",
+    'deft' => "",
+    'reqd' => "no" },
+      { 'name' => "mime_type",
+    'desc' => "{UnknownPlug.mime_type}",
     'type' => "string",
     'deft' => "",
@@ -93 +98 @@
     if (!parsargv::parse(\@_, 
              q^assoc_field/.*/^, \$self->{'assoc_field'},
-             q^file_type/.*/^, \$self->{'file_type'},
+             q^file_format/.*/^, \$self->{'file_format'},
+             q^mime_type/.*/^, \$self->{'mime_type'},
              "allow_extra_options")) {
     print STDERR "\nIncorrect options passed to UnknownPlug, check your collect.cfg configuration file\n";
@@ -123 +129 @@
     return 0 if ($file eq "" || $filename eq "");
 
-    # if ($filename =~ m/ /) {
-    # print $outhandle "UnknownPlug: \"$filename\" contains a space. choking.\n";
-    # return undef;
-    # }
-
     # Add the image metadata
     my $url = $file;
@@ -134 +135 @@
     # Add the file as an associated file ...
     my $section = $doc_obj->get_top_section();
-    my $file_type = $self->{'file_type'} || "unknown/unknown";
+    my $file_format = $self->{'file_format'} || "unknown";
+    my $mime_type = $self->{'mime_type'} || "unknown/unknown";
     my $assoc_field = $self->{'assoc_field'} || "unknown_file";
 
     $doc_obj->associate_file($filename, $file, $mime_type, $section);
+    $doc_obj->add_metadata ($section, "FileFormat", $file_format);
     $doc_obj->add_metadata ($section, $assoc_field, $file);
-
+    $doc_obj->add_metadata ($section, "Source", $file);
+
+    $self->title_fallback($doc_obj,$section,$file);
     
     $doc_obj->add_metadata ($section, "srclink", 
                 "<a href=_httpcollection_/index/assoc/[assocfilepath]/[$assoc_field]>");
+    $doc_obj->add_metadata ($section, "srcicon", "_iconunknown_");
     $doc_obj->add_metadata ($section, "/srclink", "</a>");