Changeset 5681

Timestamp:

2003-10-20T14:59:00+13:00 (21 years ago)

Author:

mdewsnip

Message:

Rewritten option display code (used by all plugins) to use the new gsprintf module, which makes using the resource bundle strings much easier.

File:

• trunk/gsdl/perllib/plugins/BasPlug.pm (modified) (25 diffs)

trunk/gsdl/perllib/plugins/BasPlug.pm

@@ -43 +43 @@
 use DateExtract;
 use ghtml;
+use gsprintf;
 use printusage;
+
 
 my $unicode_list =
@@ -126 +128 @@
 
 my $options = { 'name'     => "BasPlug",
-        'desc'     => "Base class for all the import plugins.",
+        'desc'     => "{BasPlug.desc}",
         'inherits' => "No",
         'args'     => $arguments };
+
+
+sub gsprintf
+{
+    return &gsprintf::gsprintf(@_);
+}
 
 
@@ -233 +241 @@
     # Produce the usage information using the data structure above
     if ($isleafclass) {
-    print STDERR " usage: plugin $pluginname [options]\n\n";
+    &gsprintf(STDERR, " {common.usage}: plugin $pluginname [{common.options}]\n\n");
+    # print STDERR " usage: classify $classifiername [options]\n\n";
     }
 
@@ -242 +251 @@
 
     if ($isleafclass) {
-        print STDERR " specific options:\n";
+        &gsprintf(STDERR, " {common.specific_options}:\n");
+        # print STDERR " specific options:\n";
     }
     else {
-        print STDERR " general options (from $pluginname):\n";
+        &gsprintf(STDERR, " {common.general_options}:\n", $pluginname);
+        # print STDERR " general options (from $classifiername):\n";
     }
 
@@ -392 +403 @@
              q^cover_image^, \$self->{'cover_image'},
              "allow_extra_options")) {
-    
-    print STDERR "\nThe $plugin_name plugin uses an incorrect general option (general options are those\n";
-    print STDERR "available to all plugins). Check your collect.cfg configuration file.\n";
+
+    &gsprintf(STDERR, "\n{BasPlug.bad_general_option}\n", $plugin_name);
     $self->print_txt_usage("");  # Use default resource bundle
     die "\n";
@@ -483 +493 @@
 
     if ($self->is_recursive()) {
-    die "BasPlug::read function must be implemented in sub-class for recursive plugins\n";
+    &gsprintf(STDERR, "{BasPlug.read_must_be_implemented}") && die "\n";
     }
 
@@ -521 +531 @@
     if (!length ($text)) {
     my $plugin_name = ref ($self);
-    print $outhandle "$plugin_name: ERROR: $file contains no text\n" if $self->{'verbosity'};
+    &gsprintf($outhandle, "$plugin_name: {BasPlug.file_has_no_text}\n", $filename) if $self->{'verbosity'};
 
     my $failhandle = $self->{'failhandle'};
-    print $failhandle "$file: " . ref($self) . ": file contains no text\n";
+    &gsprintf($failhandle, "$file: " . ref($self) . ": {BasPlug.empty_file}\n");
+    # print $failhandle "$file: " . ref($self) . ": file contains no text\n";
     $self->{'num_not_processed'} ++;
 
@@ -563 +574 @@
     my ($textref, $pluginfo, $base_dir, $file, $metadata, $doc_obj) = @_;
 
-    die "Basplug::process function must be implemented in sub-class\n";
+    &gsprintf(STDERR, "BasPlug::process {common.must_be_implemented}\n") && die "\n";
+    # die "Basplug::process function must be implemented in sub-class\n";
 
     return undef; # never gets here
@@ -579 +591 @@
     {
     my $outhandle = $self->{'outhandle'};
-    print $outhandle "Read permission denied for $filename\n" if $self->{'verbosity'};
+    &gsprintf($outhandle, "{BasPlug.read_denied}\n", $filename) if $self->{'verbosity'};
+    # print $outhandle "Read permission denied for $filename\n" if $self->{'verbosity'};
     return;
     }
@@ -585 +598 @@
     $$textref = "";
 
-    open (FILE, $filename) || die "BasPlug::read_file could not open $filename for reading ($!)\n";
+    open (FILE, $filename) || (&gsprintf(STDERR, "BasPlug::read_file {BasPlug.could_not_open_for_reading} ($!)\n", $filename) && die "\n");
+    # open (FILE, $filename) || die "BasPlug::read_file could not open $filename for reading ($!)\n";
 
     if ($encoding eq "ascii") {
@@ -621 +635 @@
         my $plugin_name = ref ($self);
         my $outhandle = $self->{'outhandle'};
-            print $outhandle "$plugin_name: WARNING: $filename was read using $encoding encoding but ";
-            print $outhandle "appears to be encoded as $extracted_encoding.\n";
+        &gsprintf($outhandle, "$plugin_name: {BasPlug.wrong_encoding}\n", $filename, $encoding, $extracted_encoding);
+            # print $outhandle "$plugin_name: WARNING: $filename was read using $encoding encoding but ";
+            # print $outhandle "appears to be encoded as $extracted_encoding.\n";
         }
     } else {
@@ -640 +655 @@
 
     # read in file
-    open (FILE, $filename) || die "BasPlug::get_language_encoding could not open $filename for reading ($!)\n";
+    open (FILE, $filename) || (&gsprintf(STDERR, "BasPlug::get_language_encoding {BasPlug.could_not_open_for_reading} ($!)\n", $filename) && die "\n"); # die "BasPlug::get_language_encoding could not open $filename for reading ($!)\n";
     undef $/;
     my $text = <FILE>;
@@ -681 +696 @@
     if ($self->{'input_encoding'} ne 'auto') {
         if ($self->{'extract_language'} && $self->{'verbosity'}) {
-        print $outhandle "BasPlug: WARNING: language could not be extracted from $filename - ";
-        print $outhandle "defaulting to $self->{'default_language'}\n";
+        &gsprintf($outhandle, "BasPlug: {BasPlug.could_not_extract_language}\n", $filename, $self->{'default_language'});
+        # print $outhandle "BasPlug: WARNING: language could not be extracted from $filename - ";
+        # print $outhandle "defaulting to $self->{'default_language'}\n";
         }       
         return ($self->{'default_language'}, $self->{'input_encoding'});
@@ -688 +704 @@
     } else {
         if ($self->{'verbosity'}) {
-        print $outhandle "BASPlug: WARNING: language could not be extracted from $filename - ";
-        print $outhandle "defaulting to $self->{'default_language'}.\n";
+        &gsprintf($outhandle, "BasPlug: {BasPlug.could_not_extract_language}\n", $filename, $self->{'default_language'});
+        # print $outhandle "BASPlug: WARNING: language could not be extracted from $filename - ";
+        # print $outhandle "defaulting to $self->{'default_language'}.\n";
         }
         return ($self->{'default_language'}, $best_encoding);
@@ -699 +716 @@
     if (!defined $language) {
     if ($self->{'verbosity'}) {
-        print $outhandle "BasPlug: WARNING: language could not be extracted from $filename - ";
-        print $outhandle "defaulting to $self->{'default_language'}\n";
+        &gsprintf($outhandle, "BasPlug: {BasPlug.could_not_extract_language}\n", $filename, $self->{'default_language'});
+        # print $outhandle "BasPlug: WARNING: language could not be extracted from $filename - ";
+        # print $outhandle "defaulting to $self->{'default_language'}\n";
     }
     $language = $self->{'default_language'};
@@ -706 +724 @@
     if (!defined $encoding) {
     if ($self->{'verbosity'}) {
-        print $outhandle "BasPlug: WARNING: encoding could not be extracted from $filename - ";
-        print $outhandle "defaulting to $self->{'default_encoding'}\n";
+        &gsprintf($outhandle, "BasPlug: {BasPlug.could_not_extract_encoding}\n", $filename, $self->{'default_encoding'});
+        # print $outhandle "BasPlug: WARNING: encoding could not be extracted from $filename - ";
+        # print $outhandle "defaulting to $self->{'default_encoding'}\n";
     }
     $encoding = $self->{'default_encoding'};
@@ -715 +734 @@
     !defined $encodings::encodings->{$encoding}) {
     if ($self->{'verbosity'}) {
-        print $outhandle "BasPlug: WARNING: $filename appears to be encoded in an unsupported encoding ($encoding) - ";
-        print $outhandle "using $self->{'default_encoding'}\n";
+        &gsprintf($outhandle, "BasPlug: {BasPlug.unsupported_encoding}\n", $filename, $encoding, $self->{'default_encoding'});
+        # print $outhandle "BasPlug: WARNING: $filename appears to be encoded in an unsupported encoding ($encoding) - ";
+        # print $outhandle "using $self->{'default_encoding'}\n";
     }
     $encoding = $self->{'default_encoding'};
@@ -783 +803 @@
     my $outhandle = $self->{'outhandle'};
 
-    print $outhandle " extracting email addresses ...\n" 
+    # print $outhandle " extracting email addresses ...\n" 
+    &gsprintf($outhandle, " {BasPlug.extracting_emails}...\n")
     if ($self->{'verbosity'} > 2);
     
@@ -794 +815 @@
         push @email2, $address;
         $doc_obj->add_utf8_metadata ($thissection, "emailAddress", $address);
-        print $outhandle "  extracting $address\n" 
+        # print $outhandle "  extracting $address\n" 
+        &gsprintf($outhandle, "  {BasPlug.extracting} $address\n")
         if ($self->{'verbosity'} > 3);
     }
     }
-    print $outhandle " done extracting email addresses.\n" 
+    # print $outhandle " done extracting email addresses.\n" 
+    &gsprintf($outhandle, " {BasPlug.done_email_extract}\n")
     if ($self->{'verbosity'} > 2);
-
 }
 
 # extract metadata
-sub auto_extract_metadata { 
- 
+sub auto_extract_metadata {
 
     my $self = shift (@_);
@@ -842 +863 @@
         my $keyphrases = $list[0]; #first arg is keyphrase list
         my $stems = $list[1]; #second  arg is stemmed keyphrase list
-        print STDERR "keyphrases: $keyphrases\n"; 
-        print STDERR "stems: $stems\n";
+        &gsprintf(STDERR, "{BasPlug.keyphrases}: $keyphrases\n");
+        # print STDERR "keyphrases: $keyphrases\n"; 
+        &gsprintf(STDERR, "{BasPlug.stems}: $stems\n");
+        # print STDERR "stems: $stems\n";
         $thissection = $doc_obj->get_top_section(); #add metadata to top section
         $doc_obj->add_metadata($thissection, "kea", $keyphrases);
@@ -903 +926 @@
     my $outhandle = $self->{'outhandle'};
 
-    print $outhandle " extracting acronyms ...\n" 
+    # print $outhandle " extracting acronyms ...\n" 
+    &gsprintf($outhandle, " {BasPlug.extracting_acronyms}...\n")
     if ($self->{'verbosity'} > 2);
 
@@ -916 +940 @@
         if ($thisAcro eq $acro->to_string()) {
         $seen_before = "true";
-        print $outhandle "  already seen ". $acro->to_string() . "\n" 
+        # print $outhandle "  already seen ". $acro->to_string() . "\n" 
+        &gsprintf($outhandle, " {BasPlug.already_seen} " . $acro->to_string() . "\n")
             if ($self->{'verbosity'} >= 4);
-        }       
+        }
     }
 
@@ -927 +952 @@
         #do the normal acronym
         $doc_obj->add_utf8_metadata($thissection, "Acronym",  $acro->to_string());
-        print $outhandle "  adding ". $acro->to_string() . "\n" 
+        # print $outhandle "  adding ". $acro->to_string() . "\n" 
+        &gsprintf($outhandle, " {BasPlug.adding} " . $acro->to_string() . "\n")
         if ($self->{'verbosity'} > 3);
-        
-    }
-    }
-    print $outhandle " done extracting acronyms. \n" 
+    }
+    }
+
+    # print $outhandle " done extracting acronyms. \n" 
+    &gsprintf($outhandle, " {BasPlug.done_acronym_extract}\n")
     if ($self->{'verbosity'} > 2);
 }
@@ -941 +968 @@
     my $outhandle = $self->{'outhandle'};
 
-    print $outhandle " marking up acronyms ...\n" 
+    # print $outhandle " marking up acronyms ...\n" 
+    &gsprintf($outhandle, " {BasPlug.marking_up_acronyms}...\n")
     if ($self->{'verbosity'} > 2);
 
@@ -947 +975 @@
     $text = &acronym::markup_acronyms($text, $self);
 
-    print $outhandle " done marking up acronyms. \n" 
+    # print $outhandle " done marking up acronyms. \n" 
+    &gsprintf($outhandle, " {BasPlug.done_acronym_markup}\n")
     if ($self->{'verbosity'} > 2);