Changeset 29678

Timestamp:

2015-01-09T14:24:10+13:00 (9 years ago)

Author:

Jeremy Symon

Message:

Moved xml i/o handling to the module for simplicity of use

Location:

main/trunk/package-kits/scripts

Files:

• gs-servlet.pl (modified) (3 diffs)
• perllib/Greenstone/Config.pm (modified) (1 diff)
• perllib/Greenstone/Directory.pm (modified) (2 diffs)
• perllib/Greenstone/Site.pm (modified) (1 diff)
• perllib/Greenstone/XML/Tidy.pm (modified) (4 diffs)
• perllib/XML (deleted)

main/trunk/package-kits/scripts/gs-servlet.pl

@@ -9 +9 @@
 
 use lib 'perllib';
-use XML::Tidy;
+use Greenstone::XML::Tidy;
 
 my $hash;
@@ -39 +39 @@
         "Parses XML from a file into the internal state\n  input_file (- for STDIN)",
         sub {
-            my $file = shift @ARGV;
-            my $new;
-            if ($file eq '-') {
-                if (isatty *STDIN) {
-                    print STDERR "Reading XML from STDIN. Press ^D to end\n";
-                }
-                $new = read_xml *STDIN;
-            } else {
-                open FH, '<', $file;
-                $new = read_xml *FH;
-                close FH;
-            }
+            my $new = read_xml shift @ARGV;
             # Append the new data to the current data
             for my $key (keys %$new) {
@@ -73 +62 @@
         "Writes the current internal state as XML to a file\n  output_file (- for STDOUT)",
         sub {
-            my $file = shift @ARGV;
-            if ($file eq '-') {
-                write_xml $hash, *STDOUT;
-            } else {
-                open FH, '>', $file;
-                write_xml $hash, *FH;
-                close FH;
-            }
+            write_xml $hash, shift @ARGV;
         },
         1,

main/trunk/package-kits/scripts/perllib/Greenstone/Config.pm

@@ -10 +10 @@
 our $GSDLHOME = defined $ENV{GSDLHOME} ? $ENV{GSDLHOME} : $defaultGSDLHOME;
 our $GSDL3HOME= defined $ENV{GSDL3HOME}? $ENV{GSDL3HOME}: $defaultGSDL3HOME;
+
+1;

main/trunk/package-kits/scripts/perllib/Greenstone/Directory.pm

@@ -14 +14 @@
     my ($parent, $class, $name, %args) = @_;
     ref $class and die "Constructor used as object method\n";
-    defined $name or die "A site must have a name\n";
+    defined $name or die "Must have a name\n";
     my $self = bless (
         {
@@ -31 +31 @@
     my $parent = shift;
     ref $parent and die "Static method called on object\n";
-    my $sites = {};
+    my $dirs = {};
     my $dir = "$Greenstone::Config::GSDL3HOME/$parent";
-    opendir DH, $dir or die "Could not open sites directory '$dir'\n";
-    while (my $site = readdir DH) {
+    opendir DH, $dir or die "Could not open directory '$dir'\n";
+    while (my $entry = readdir DH) {
         # skip hidden files and current/parent directory
-        $site =~ /^\./ and next;
+        $entry =~ /^\./ and next;
         # skip non-directories
-        -d "$dir/$site" or next;
-        # We don't really need to store anything more than the fact that the site exists
+        -d "$dir/$entry" or next;
+        # We don't really need to store anything more than the fact that the directory exists
         # So we just store nothing, which is enough to put the key in the hash
         # (i.e. it acts as a hashset)
-        $sites->{$site} = ();
+        $dirs->{$entry} = ();
     }
     closedir DH;
-    return $sites;
+    return $dirs;
 }
 
 sub exists {
     my $self = shift;
-    my $sites = list $self->{parent};
-    return exists $sites->{$self->{name}};
+    my $dirs = list $self->{parent};
+    return exists $dirs->{$self->{name}};
 }
 

main/trunk/package-kits/scripts/perllib/Greenstone/Site.pm

@@ -25 +25 @@
     my $dir = $self->dir;
     mkdir "$dir/collect" or die "Failed to create collections directory: $!\n";
-    open FH, '>', "$dir/siteConfig.xml" or die "Failed to create site config: $!\n";
-    write_xml $configTemplate, *FH;
-    close FH;
-    return 1;
+    return write_xml $configTemplate, "$dir/siteConfig.xml";
 }
 

main/trunk/package-kits/scripts/perllib/Greenstone/XML/Tidy.pm

@@ -5 +5 @@
 use utf8;
 use XML::Parser;
+use POSIX 'isatty';
 use base 'Exporter';
 
@@ -53 +54 @@
 =cut
 sub read_xml {
-    my $FH = shift;
-    local $/ = undef;
-    my $xml = <$FH>;
-    # The xml needs a root element, so we wrap it in one
-    $xml='<__root__>' . $xml . '</__root__>';
+    my $file = shift;
+    my $xml;
+    if ($file eq '-') {
+        if (isatty *STDIN) {
+            print STDERR "Reading XML from STDIN. Press ^D to end\n";
+        }
+        local $/ = undef;
+        $xml = '<__root__>' . <STDIN> . '</__root__>';
+    } else {
+        $xml = '<!DOCTYPE doc [<!ENTITY real_doc SYSTEM "' . $file . '">]>
+                <__root__>&real_doc;</__root__>';
+    }
     # Parse the data using XML::Parser
     my $data = new XML::Parser (Style => 'Tree')->parse ($xml);
@@ -98 +106 @@
 # Writes a data structure to an XML file
 sub write_xml {
-    my ($hash, $FH) = @_;
-    select $FH;
+    my ($hash, $file) = @_;
+    my $FH;
+    if ($file ne '-') {
+        unless (open $FH, '>:utf8', $file) {
+            print STDERR "Failed to open output file '$file': $!\n";
+            return 0;
+        }
+        select $FH;
+    }
     sub open_tag {
         my ($indent, $tag, $attr) = @_;
@@ -155 +170 @@
     }
     write_element ("", $hash);
-    select STDOUT;
+    if ($file ne '-') {
+        select STDOUT;
+        close $FH;
+    }
+    return 1;
 }
+
+1;