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

gsdl/trunk/perllib/plugins/TextPlugin.pm

@@ -1 +1 @@
 ###########################################################################
 #
-# TEXTPlug.pm -- simple text plugin
+# TextPlugin.pm -- simple text plugin
 # A component of the Greenstone digital library software
 # from the New Zealand Digital Library Project at the 
@@ -29 +29 @@
 # 12/05/02 Added usage datastructure - John Thompson
 
-package TEXTPlug;
-
-use BasPlug;
+package TextPlugin;
+
+use ReadTextFile;
 
 use strict;
 no strict 'refs'; # allow filehandles to be variables and viceversa
+no strict 'subs';
 
 sub BEGIN {
-    @TEXTPlug::ISA = ('BasPlug');
+    @TextPlugin::ISA = ('ReadTextFile');
 }
 
 my $arguments =
     [ { 'name' => "process_exp",
-    'desc' => "{BasPlug.process_exp}",
+    'desc' => "{BasePlugin.process_exp}",
     'type' => "regexp",
     'deft' => &get_default_process_exp(),
     'reqd' => "no" } ,
       { 'name' => "title_sub",
-    'desc' => "{TEXTPlug.title_sub}",
+    'desc' => "{TextPlugin.title_sub}",
     'type' => "regexp",
     'deft' => "",
     'reqd' => "no" } ];
 
-my $options = { 'name'     => "TEXTPlug",
-        'desc'     => "{TEXTPlug.desc}",
+my $options = { 'name'     => "TextPlugin",
+        'desc'     => "{TextPlugin.desc}",
         'abstract' => "no",
         'inherits' => "yes",
@@ -65 +66 @@
     push(@$pluginlist, $class);
 
-    if(defined $arguments){ push(@{$hashArgOptLists->{"ArgList"}},@{$arguments});}
-    if(defined $options) { push(@{$hashArgOptLists->{"OptList"}},$options)};
-
-    my $self = new BasPlug($pluginlist, $inputargs, $hashArgOptLists);
+    push(@{$hashArgOptLists->{"ArgList"}},@{$arguments});
+    push(@{$hashArgOptLists->{"OptList"}},$options);
+
+    my $self = new ReadTextFile($pluginlist, $inputargs, $hashArgOptLists);
 
     return bless $self, $class;
@@ -85 +86 @@
     my $outhandle = $self->{'outhandle'};
 
-    print STDERR "<Processing n='$file' p='TEXTPlug'>\n" if ($gli);
-    print $outhandle "TEXTPlug: processing $file\n" 
+    print STDERR "<Processing n='$file' p='TextPlugin'>\n" if ($gli);
+    print $outhandle "TextPlugin xx: processing $file\n" 
     if $self->{'verbosity'} > 1;
     
@@ -109 +110 @@
     }
     # Add FileFormat metadata
-    $doc_obj->add_metadata($cursection, "FileFormat", "TEXT");
+    $doc_obj->add_metadata($cursection, "FileFormat", "Text");
 
     # insert preformat tags and add text to document object    
@@ -136 +137 @@
 # replace_srcdoc_with_html.pl requires all subroutines that support src_replaceable
 # to contain a method called tmp_area_convert_file - this is indeed the case with all
-# Perl modules that are subclasses of ConvertToPlug.pm, but as we want TEXTPlug to also
-# be srcreplaceable and because TEXTPlug does not inherit from ConvertToPlug.pm, we have
+# Perl modules that are subclasses of ConvertToPlug.pm, but as we want TextPlugin to also
+# be srcreplaceable and because TextPlugin does not inherit from ConvertToPlug.pm, we have
 # a similar subroutine with the same name here.
 sub tmp_area_convert_file {
@@ -192 +193 @@
     # Recreate the original file for writing the updated contents
     unless(open(TEXT, "<$tmp_filename")) { # open it as a new file for writing
-    print STDERR "TEXTPlug.pm: Unable to open and read from $tmp_filename for converting to html...ERROR: $!\n";
+    print STDERR "TextPlugin.pm: Unable to open and read from $tmp_filename for converting to html...ERROR: $!\n";
     return ""; # no file name
     }
@@ -212 +213 @@
     # try creating this new file writing and try opening it for writing, else exit with error value
     unless(open(HTML, ">$output_filename")) {  # open the new html file for writing
-    print STDERR "TEXTPlug.pm: Unable to create $output_filename for writing $tailname$suffix txt converted to html...ERROR: $!\n";
+    print STDERR "TextPlugin.pm: Unable to create $output_filename for writing $tailname$suffix txt converted to html...ERROR: $!\n";
     return ""; # no filename
     }