Changeset 25499

Timestamp:

2012-04-27T17:12:40+12:00 (12 years ago)

Author:

ak19

Message:

Dr Bainbridge modified gsprintf code to print text containing ampersand, less than and greater then with their entity values instead so that printing to STDERR from BEGIN statements (so far used only in PDFBoxConverter of the PDFBox extension) will play nicely with the XML generated for Pluginfo.pl. Pluginfo.pl has also been modified to use the correct gsprintf printing methods.

Location:

main/trunk/greenstone2

Files:

• bin/script/pluginfo.pl (modified) (3 diffs)
• perllib/gsprintf.pm (modified) (4 diffs)

main/trunk/greenstone2/bin/script/pluginfo.pl

@@ -130 +130 @@
     }
     eval "\$$strVariable = \$value";
+    }
+
+    if ($xml) {
+    &gsprintf::set_print_freetext_for_xml();
     }
 
@@ -246 +250 @@
         push (@plugobj_list, $plugobj);
     }
+
+    &gsprintf::set_print_xml_tags();
     print STDERR "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
     print STDERR "<PluginList length=\"" . scalar(@plugin_list) . "\">\n";
@@ -270 +276 @@
     my $plugobj = &plugin::load_plugin_for_info ($plugin);
     if ($xml) {
+    &gsprintf::set_print_xml_tags();
     $plugobj->print_xml_usage($header);
     }

main/trunk/greenstone2/perllib/gsprintf.pm

@@ -50 +50 @@
 # Ignore the OutputEncoding strings in the resource bundles and output all text in UTF-8
 my $outputstringsinUTF8 = 0;
+my $freetext_xml_mode = 0;
+
+
+sub make_freetext_xml_safe
+{
+    my ($text) = @_;
+
+    $text =~ s/\&/&/g;
+    $text =~ s/\"/"/g;
+    $text =~ s/\</&lt;/g;
+    $text =~ s/\>/&gt;/g;
+
+    return $text;
+}
 
 
@@ -63 +77 @@
 
     # Resolve the string arguments using sprintf, then write out to the handle
-    print $handle sprintf($text_string, @text_arguments);
+    my $text_string_resolved = sprintf($text_string, @text_arguments);
+
+    if ($freetext_xml_mode) {
+    $text_string_resolved = make_freetext_xml_safe($text_string_resolved);
+    }
+
+    print $handle $text_string_resolved;
 }
 
@@ -156 +176 @@
     if (!%defaultresourcebundle) {
         # $! will still have the error value for the last failed syscall
-        print STDERR "$! $resourcebundlename\n";
+
+        my $error_message = "$! $resourcebundlename\n";
+
+    if ($freetext_xml_mode) {
+        $error_message = make_freetext_xml_safe($error_message);
+    }
+
+        print STDERR $error_message;
+
     # set something so we don't bother trying to load it again
     $defaultresourcebundle{0}=undef; 
@@ -292 +320 @@
 
 
+sub set_print_freetext_for_xml
+{
+    $freetext_xml_mode = 1;
+}
+
+sub set_print_xml_tags
+{
+    $freetext_xml_mode = 0;
+}
+
 sub output_strings_in_UTF8
 {