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

gsdl/trunk/perllib/plugins/PPTPlugin.pm

@@ -1 +1 @@
 ###########################################################################
 #
-# PPTPlug.pm -- plugin for importing Microsoft PowerPoint files.
+# PPTPlugin.pm -- plugin for importing Microsoft PowerPoint files.
 #  (currently only versions 95 and 97)
 #
@@ -26 +26 @@
 ###########################################################################
 
-package PPTPlug;
+package PPTPlugin;
 
-use ConvertToPlug;
+use ConvertBinaryFile;
+use ReadTextFile; # for read_file in convert_post_process. do we need it?
+
 use strict;
 no strict 'refs'; # allow filehandles to be variables and viceversa
 
 sub BEGIN {
-    @PPTPlug::ISA = ('ConvertToPlug');
+    @PPTPlugin::ISA = ('ConvertBinaryFile', 'ReadTextFile');
 }
 
 my $convert_to_list =
     [ { 'name' => "auto",
-    'desc' => "{ConvertToPlug.convert_to.auto}" },
+    'desc' => "{ConvertBinaryFile.convert_to.auto}" },
       { 'name' => "html",
-    'desc' => "{ConvertToPlug.convert_to.html}" },
+    'desc' => "{ConvertBinaryFile.convert_to.html}" },
       { 'name' => "text",
-    'desc' => "{ConvertToPlug.convert_to.text}" },
+    'desc' => "{ConvertBinaryFile.convert_to.text}" },
       { 'name' => "pagedimg_jpg",
-    'desc' => "{ConvertToPlug.convert_to.pagedimg_jpg}" },
+    'desc' => "{ConvertBinaryFile.convert_to.pagedimg_jpg}" },
       { 'name' => "pagedimg_gif",
-    'desc' => "{ConvertToPlug.convert_to.pagedimg_gif}" },
+    'desc' => "{ConvertBinaryFile.convert_to.pagedimg_gif}" },
       { 'name' => "pagedimg_png",
-    'desc' => "{ConvertToPlug.convert_to.pagedimg_png}" }
+    'desc' => "{ConvertBinaryFile.convert_to.pagedimg_png}" }
       ];
 
 my $arguments = 
     [ { 'name' => "process_exp",
-    'desc' => "{BasPlug.process_exp}",
+    'desc' => "{BasePlugin.process_exp}",
     'type' => "regexp",
     'reqd' => "no",
@@ -59 +61 @@
       ];
 
-my $options = { 'name'     => "PPTPlug",
-        'desc'     => "{PPTPlug.desc}",
+my $options = { 'name'     => "PPTPlugin",
+        'desc'     => "{PPTPlugin.desc}",
         'abstract' => "no",
         'inherits' => "yes",
@@ -73 +75 @@
     if ($ENV{'GSDLOS'} =~ m/^windows$/i) {
     my $ws_arg =[{ 'name' => "convert_to",
-               'desc' => "{ConvertToPlug.convert_to}",
+               'desc' => "{ConvertBinaryFile.convert_to}",
                'type' => "enum",
                'reqd' => "yes",
@@ -79 +81 @@
                'deft' => "html" },
              { 'name' => "windows_scripting",
-               'desc' => "{PPTPlug.windows_scripting}",
+               'desc' => "{PPTPlugin.windows_scripting}",
                'type' => "flag",
                'reqd' => "no" }
@@ -86 +88 @@
     }
     
-    if(defined $arguments){ push(@{$hashArgOptLists->{"ArgList"}},@{$arguments});}
-    if(defined $options) { push(@{$hashArgOptLists->{"OptList"}},$options)};
+    push(@{$hashArgOptLists->{"ArgList"}},@{$arguments});
+    push(@{$hashArgOptLists->{"OptList"}},$options);
 
 
-    my @arg_array = @$inputargs;
-    my $self = new ConvertToPlug($pluginlist, $inputargs, $hashArgOptLists);
+    my $self = new ConvertBinaryFile($pluginlist, $inputargs, $hashArgOptLists);
  
     if ($self->{'info_only'}) {
@@ -98 +99 @@
     }
 
+    $self->{'filename_extension'} = "ppt";
+    $self->{'file_type'} = "PPT";
+
     # ppthtml outputs utf-8 already.
-    #these are passed through to gsConvert.pl by ConvertToPlug.pm
+    #these are passed through to gsConvert.pl by ConvertBinaryFile.pm
     $self->{'convert_options'} = "-windows_scripting" if $self->{'windows_scripting'};
     my $secondary_plugin_options = $self->{'secondary_plugin_options'};
 
     if ($self->{'windows_scripting'} && ($self->{'convert_to'} eq "PagedImg")) {
-    $secondary_plugin_options->{'PagedImgPlug'} = [];
+    $secondary_plugin_options->{'PagedImagePlugin'} = [];
     } else {
-    $secondary_plugin_options->{'HTMLPlug'} = [];
+    $secondary_plugin_options->{'HTMLPlugin'} = [];
     }
-    my $html_options = $secondary_plugin_options->{'HTMLPlug'};
-    my $pageimg_options = $secondary_plugin_options->{'PagedImgPlug'};
+    my $html_options = $secondary_plugin_options->{'HTMLPlugin'};
+    my $pageimg_options = $secondary_plugin_options->{'PagedImagePlugin'};
 
     if ($self->{'input_encoding'} eq "auto") {
     $self->{'input_encoding'} = "utf8";
-    if (defined $secondary_plugin_options->{'HTMLPlug'}){
+    if (defined $secondary_plugin_options->{'HTMLPlugin'}){
         push(@$html_options,"-input_encoding", "utf8");
         push(@$html_options,"-extract_language") if $self->{'extract_language'};
 
-        # Instruct HTMLPlug (when eventually accessed through read_into_doc_obj) 
+        # Instruct HTMLPlugin (when eventually accessed through read_into_doc_obj) 
         # to extract these metadata fields from the HEAD META fields
         push(@$html_options,"-metadata_fields","Title,GENERATOR,date,author<Creator>");
     } 
-    if (defined $secondary_plugin_options->{'PagedImgPlug'}){
+    if (defined $secondary_plugin_options->{'PagedImagePlugin'}){
         push(@$pageimg_options,"-input_encoding", "utf8");
         push(@$pageimg_options,"-extract_language") if $self->{'extract_language'};
@@ -138 +142 @@
 }
 
-sub get_file_type {
-    my $self = shift (@_);
-    my $file_type = "PPT";
-    return $file_type;
-}
-
+# do we need this? above states that ppthtml produces utf8 text...
 sub convert_post_process
 {
@@ -161 +160 @@
 }
 
-sub process {
-    my $self = shift (@_);
-    my ($textref, $pluginfo, $base_dir, $file, $metadata, $doc_obj, $gli) = @_;
-
-    return $self->process_type("ppt",$base_dir,$file,$doc_obj);
-}
 
 1;