Changeset 21719 for main/trunk/greenstone2/perllib/util.pm

Timestamp:

2010-02-16T19:57:37+13:00 (14 years ago)

Author:

ak19

Message:

For Fedora: the Greenstone server's prefix URL is obtained from gsdlsite.cfg for GS2 and from greenstone3.xml in packages/tomcat for GS3 and this is used by FedoraMETSPlugout so it can refer to the relative paths for associated files like images.

File:

• main/trunk/greenstone2/perllib/util.pm (modified) (1 diff)

main/trunk/greenstone2/perllib/util.pm

@@ -1142 +1142 @@
 
 
+# Returns the greenstone URL prefix extracted from the appropriate GS2/GS3 config file. 
+# By default, /greenstone3 for GS3 or /greenstone for GS2.
+sub get_greenstone_url_prefix() {
+    # if already set on a previous occasion, just return that
+    # (Don't want to keep repeating this: cost of re-opening and scanning files.)
+    return $ENV{'GREENSTONE_URL_PREFIX'} if($ENV{'GREENSTONE_URL_PREFIX'});
+
+    my ($configfile, $urlprefix, $defaultUrlprefix); 
+    my @propertynames = ();
+
+    if($ENV{'GSDL3SRCHOME'}) {
+    $defaultUrlprefix = "/greenstone3";
+    $configfile = &util::filename_cat($ENV{'GSDL3SRCHOME'}, "packages", "tomcat", "conf", "Catalina", "localhost", "greenstone3.xml");
+    push(@propertynames, qw/path\s*\=/);
+    } else {
+    $defaultUrlprefix = "/greenstone";
+    $configfile = &util::filename_cat($ENV{'GSDLHOME'}, "cgi-bin", "gsdlsite.cfg");
+    push(@propertynames, (qw/\nhttpprefix/, qw/\ngwcgi/)); # inspect one property then the other 
+    }
+
+    $urlprefix = &extract_propvalue_from_file($configfile, \@propertynames);
+
+    if(!$urlprefix) { # no values found for URL prefix, use default values
+    $urlprefix = $defaultUrlprefix;
+    } else {
+    #gwcgi can contain more than the wanted prefix, we split on / to get the first "directory" level
+    $urlprefix =~ s/^\///; # remove the starting slash
+    my @dirs = split(/(\\|\/)/, $urlprefix); 
+    $urlprefix = shift(@dirs);
+
+    if($urlprefix !~ m/^\//) { # in all cases: ensure the required forward slash is at the front
+        $urlprefix = "/$urlprefix";
+    }
+    }
+
+    # set for the future
+    $ENV{'GREENSTONE_URL_PREFIX'} = $urlprefix;
+#    print STDERR "*** in get_greenstone_url_prefix(): $urlprefix\n\n";
+    return $urlprefix;
+}
+
+
+# Given a config file (xml or java properties file) and a list/array of regular expressions
+# that represent property names to match on, this function will return the value for the 1st
+# matching property name. If the return value is undefined, no matching property was found.
+sub extract_propvalue_from_file() {
+    my ($configfile, $propertynames) = @_;
+
+    my $value;
+    unless(open(FIN, "<$configfile")) { 
+    print STDERR "extract_propvalue_from_file(): Unable to open $configfile. $!\n";
+    return $value; # not initialised
+    }
+
+    # Read the entire file at once, as one single line, then close it
+    my $filecontents;
+    {
+    local $/ = undef;        
+    $filecontents = <FIN>;
+    }
+    close(FIN);
+
+    foreach my $regex (@$propertynames) {
+        ($value) = $filecontents=~ m/$regex\s*(\S*)/s; # read value of the property given by regex up to the 1st space
+    if($value) { 
+            $value =~ s/^\"//;     # remove any startquotes
+        $value =~ s/\".*$//;   # remove the 1st endquotes (if any) followed by any xml
+        last;              # found value for a matching property, break from loop
+    }
+    }
+
+    return $value;
+}
+
 
 1;