Changeset 31492 for main/trunk/greenstone2/perllib/plugins/CommonUtil.pm

Timestamp:

2017-03-13T11:12:37+13:00 (7 years ago)

Author:

kjdon

Message:

renamed EncodingUtil to CommonUtil, BasePlugin to BaseImporter. The idea is that only top level plugins that you can specify in your collection get to have plugin in their name. Modified all other plugins to reflect these name changes

File:

• main/trunk/greenstone2/perllib/plugins/CommonUtil.pm (moved) (moved from main/trunk/greenstone2/perllib/plugins/EncodingUtil.pm ) (9 diffs)

main/trunk/greenstone2/perllib/plugins/CommonUtil.pm

@@ -1 +1 @@
 ###########################################################################
 #
-# EncodingUtil.pm -- base class for file and directory plugins - aims to 
-# handle all encoding stuff, to keep it in one place
+# CommonUtil.pm -- base class for file and directory plugins - aims to 
+# handle all encoding stuff, blocking stuff, to keep it in one place
 # A component of the Greenstone digital library software
 # from the New Zealand Digital Library Project at the 
@@ -25 +25 @@
 ###########################################################################
 
-package EncodingUtil;
+package CommonUtil;
 
 use strict; 
@@ -39 +39 @@
 
 BEGIN {
-    @EncodingUtil::ISA = ( 'PrintInfo' );
+    @CommonUtil::ISA = ( 'PrintInfo' );
 }
 
 our $encoding_list =
     [ { 'name' => "ascii",
-    'desc' => "{BasePlugin.encoding.ascii}" },
+    'desc' => "{BaseImporter.encoding.ascii}" },
       { 'name' => "utf8",
-    'desc' => "{BasePlugin.encoding.utf8}" },
+    'desc' => "{BaseImporter.encoding.utf8}" },
       { 'name' => "unicode",
-    'desc' => "{BasePlugin.encoding.unicode}" } ];
+    'desc' => "{BaseImporter.encoding.unicode}" } ];
 
 
@@ -63 +63 @@
 our $encoding_plus_auto_list = 
     [ { 'name' => "auto",
-    'desc' => "{BasePlugin.filename_encoding.auto}" },
+    'desc' => "{BaseImporter.filename_encoding.auto}" },
       { 'name' => "auto-language-analysis",
-    'desc' => "{BasePlugin.filename_encoding.auto_language_analysis}" }, # textcat
+    'desc' => "{BaseImporter.filename_encoding.auto_language_analysis}" }, # textcat
       { 'name' => "auto-filesystem-encoding",
-    'desc' => "{BasePlugin.filename_encoding.auto_filesystem_encoding}" }, # locale
+    'desc' => "{BaseImporter.filename_encoding.auto_filesystem_encoding}" }, # locale
       { 'name' => "auto-fl",
-    'desc' => "{BasePlugin.filename_encoding.auto_fl}" }, # locale followed by textcat
+    'desc' => "{BaseImporter.filename_encoding.auto_fl}" }, # locale followed by textcat
       { 'name' => "auto-lf",
-    'desc' => "{BasePlugin.filename_encoding.auto_lf}" } ]; # texcat followed by locale 
+    'desc' => "{BaseImporter.filename_encoding.auto_lf}" } ]; # texcat followed by locale 
 
 push(@{$encoding_plus_auto_list},@{$encoding_list});
@@ -77 +77 @@
 my $arguments =
     [  { 'name' => "block_exp",
-     'desc' => "{BasePlugin.block_exp}",
+     'desc' => "{BaseImporter.block_exp}",
      'type' => "regexp",
      'deft' => "",
      'reqd' => "no" },
        { 'name' => "no_blocking",
-     'desc' => "{BasePlugin.no_blocking}",
+     'desc' => "{BaseImporter.no_blocking}",
      'type' => "flag",
      'reqd' => "no"},
        { 'name' => "filename_encoding",
-     'desc' => "{BasePlugin.filename_encoding}",
+     'desc' => "{BaseImporter.filename_encoding}",
      'type' => "enum",
      'deft' => "auto",
@@ -93 +93 @@
     ];
 
-my $options = { 'name'     => "EncodingUtil",
-        'desc'     => "{EncodingUtil.desc}",
+my $options = { 'name'     => "CommonUtil",
+        'desc'     => "{CommonUtil.desc}",
         'abstract' => "yes",
         'inherits' => "no",
@@ -140 +140 @@
     my $filename_encoding =  $self->guess_filesystem_encoding();  
         
-    # copied this from set_Source_metadata in BasePlugin
+    # copied this from set_Source_metadata in BaseImporter
     if ((defined $filename_encoding) && ($filename_encoding ne "ascii")) {
     # Use filename_encoding to map raw filename to a Perl unicode-aware string 
@@ -267 +267 @@
     my $outhandle = $self->{'outhandle'};
 
-    print $outhandle "****!!!!**** BasePlugin::filename_to_utf8_metadata now deprecated\n";
+    print $outhandle "****!!!!**** BaseImporter::filename_to_utf8_metadata now deprecated\n";
     my ($cpackage,$cfilename,$cline,$csubr,$chas_args,$cwantarray) = caller(0);
     print $outhandle "Calling method: $cfilename:$cline $cpackage->$csubr\n";
@@ -363 +363 @@
     {
     if ($self->{'verbosity'}) { 
-        gsprintf($outhandle, "BasePlugin: {ReadTextFile.unsupported_encoding}\n", $text, $best_encoding, "undef");
+        gsprintf($outhandle, "BaseImporter: {ReadTextFile.unsupported_encoding}\n", $text, $best_encoding, "undef");
     }
     $best_encoding = undef;