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

Timestamp:

2013-09-04T21:46:07+12:00 (11 years ago)

Author:

ak19

Message:

No more absolute paths in archiveinf-doc.gdb and archiveinf-src.gdb

File:

• main/trunk/greenstone2/perllib/util.pm (modified) (10 diffs)

main/trunk/greenstone2/perllib/util.pm

@@ -824 +824 @@
     }
 
+    if (!defined $ENV{'GREENSTONEHOME'}) { # for GS3, would have been defined in use_site_collection, to GSDL3HOME
+     $ENV{'GREENSTONEHOME'} = $ENV{'GSDLHOME'}; 
+    }
+
     # get and check the collection
     if (!defined($collection) || $collection eq "") {
@@ -842 +846 @@
     # are defined
     $ENV{'GSDLCOLLECTION'} = $collection;
+    $ENV{'GSDLCOLLECTHOME'} = $collectdir;
     $ENV{'GSDLCOLLECTDIR'} = &FileUtils::filenameConcatenate($collectdir, $collection);
 
@@ -868 +873 @@
     die "GSDL3HOME not set.\n" unless defined $ENV{'GSDL3HOME'};
     $collectdir = &FileUtils::filenameConcatenate($ENV{'GSDL3HOME'}, "sites", $site, "collect");
+    }
+
+    if (defined $ENV{'GSDL3HOME'}) {
+    $ENV{'GREENSTONEHOME'} = $ENV{'GSDL3HOME'};     
+    $ENV{'SITEHOME'} = &FileUtils::filenameConcatenate($ENV{'GREENSTONEHOME'}, "sites", $site);
+    } elsif (defined $ENV{'GSDL3SRCHOME'}) {
+    $ENV{'GREENSTONEHOME'} = &FileUtils::filenameConcatenate($ENV{'GSDL3SRCHOME'}, "web");  
+    $ENV{'SITEHOME'} = &FileUtils::filenameConcatenate($ENV{'GREENSTONEHOME'}, "sites", $site);
+    } else {
+    print STDERR "*** util::use_site_collection(). Warning: Neither GSDL3HOME nor GSDL3SRCHOME set.\n";
     }
 
@@ -1213 +1228 @@
     my ($collect_dir, $qualified_collection, $site) = @_; #, $gs_mode
     
+    if (defined $ENV{'GSDLCOLLECTDIR'}) { # a predefined collection dir exists
+        return $ENV{'GSDLCOLLECTDIR'};
+    }
+
     my ($colgroup, $collection) = &util::get_collection_parts($qualified_collection);   
     
@@ -1224 +1243 @@
 # work out the full path to "collect" of this greenstone 2/3 installation
 sub get_working_collect_dir {
-    my ($site) = @_;
-    
-    if (defined $ENV{'GSDLCOLLECTDIR'}) { # a predefined collect dir exists
-    return $ENV{'GSDLCOLLECTDIR'};
-    }
-    
-    elsif (defined $site && $site) { # site non-empty, so get default collect dir for GS3
-    return &FileUtils::filenameConcatenate(&util::get_site_dir($site),"collect");
+    my ($site) = @_;    
+
+    if (defined $ENV{'GSDLCOLLECTHOME'}) { # a predefined collect dir exists
+    return $ENV{'GSDLCOLLECTHOME'};
+    }
+
+    if (defined $site && $site) { # site non-empty, so get default collect dir for GS3
+    
+    if (defined $ENV{'GSDL3HOME'}) {
+        return &FileUtils::filenameConcatenate($ENV{'GSDL3HOME'},"sites",$site,"collect"); # web folder
+    } 
+    elsif (defined $ENV{'GSDL3SRCHOME'}) {
+        return &FileUtils::filenameConcatenate($ENV{'GSDL3SRCHOME'},"web","sites",$site,"collect");
+    }
+    } 
+
+    elsif (defined $ENV{'SITEHOME'}) { #&FileUtils::filenameConcatenate(&util::get_site_dir($site),"collect");
+    return &FileUtils::filenameConcatenate($ENV{'SITEHOME'},"collect");
     }
     
@@ -1239 +1268 @@
 }
 
-# returns path to current GS3 site.
-# Returns "" if $site parameter is empty string, undefined or otherwise false
-sub get_site_dir {
-    my ($site) = @_;
-    
-    if (defined $ENV{'GSDL3HOME'}) {
-    return &FileUtils::filenameConcatenate($ENV{'GSDL3HOME'},"sites",$site); # web folder
-    } 
-    elsif (defined $ENV{'GSDL3SRCHOME'}) {
-    return &FileUtils::filenameConcatenate($ENV{'GSDL3SRCHOME'},"web","sites",$site);
-    }
-    else { # site has no meaning, return "" (covers the case of this subroutine having been called for a GS2 situation)
-    return "";
-    }
-}
-
-# returns path to GSDL3HOME if GS3, or GSDLHOME if GS2
-sub get_gs_home {
-    my ($site) = @_;
-
-    if (defined $site && $site) { # not undefined or empty string, so GS3 case
-    if (defined $ENV{'GSDL3HOME'}) {
-        return $ENV{'GSDL3HOME'};
-    } else {
-        return &FileUtils::filenameConcatenate($ENV{'GSDL3SRCHOME'},"web");
-    }
-    } else {
-    return $ENV{'GSDLHOME'};
-    }
-}
-
-sub is_abs_path {
+sub is_abs_path_this_os {
     my ($path) = @_;
+
+    # File::Spec loads the module appropriate for the OS
+    return &FileUtils::isFilenameAbsolute(@_); #return File::Spec->file_name_is_absolute( $path );
+}
+
+
+sub is_abs_path_any_os {
+    my ($path) = @_;
+
+    # We can have filenames in our DBs that were produced on other OS, so this method exists
+    # to help identify absolute paths in such cases.
 
     return 1 if($path =~ m@^/@); # full paths begin with forward slash on linux/mac
@@ -1277 +1286 @@
 
     return 0;
-
-    # File::Spec loads the module appropriate for the OS, but abs paths in archiveinf-doc.xml may be generated on another OS to this one
-    #return File::Spec->file_name_is_absolute( $path );    
-}
-
-# returns an array of the FULL PATHS to the specific collection given, to the general collect_dir,
-# to the site directory if gs3 and to the greenstone home folder (GSDLHOME or GSDL3HOME). 
-# These elements are returned in this ORDER, in order to allow matching from longest to shortest path.
-sub get_common_gs_paths {
-
-    my ($site, $qualified_collection_name) = @_;
-    
-    my $collect_dir = &util::get_working_collect_dir($site);
-    my $collection_path = "";
-    if($qualified_collection_name ne "") {
-    $collection_path = &util::resolve_collection_dir($collect_dir, $qualified_collection_name, $site);
-    }
-    
-    my $site_dir = &util::get_site_dir($site); # returns "" for GS2
-    my $gs_home = &util::get_gs_home(); # GSDLHOME or GSDL3HOME folder
-    
-    return ($collection_path, $collect_dir, $site_dir, $gs_home); # list in this order: from longest to shortest path
-    #my @gs_paths = ($collection_path, $collect_dir, $site_dir, $gs_home); # list in this order: from longest to shortest path
-    #return @gs_paths;
-}
+}
+
 
 # This subroutine is for improving portability of Greenstone collections from one OS to another,
@@ -1316 +1302 @@
     my $path = shift(@_); # path to convert from absolute to one with placeholders
 
-    my ($collection_path, $collect_dir, $site_dir, $gs_home) = @_;
-
-    return $path unless is_abs_path($path); # path is relative
+    return $path unless is_abs_path_any_os($path); # path is relative
     
     # now we know we're dealing with absolute paths and have to replace gs prefixes with placeholders
 
-    my @gs_paths = ($collection_path, $collect_dir, $site_dir, $gs_home); # list in this order: from longest to shortest path
-
-    my %placeholder_map = ($gs_home => '@GSDLHOME@', # can't use double-quotes around at-sign, else perl tries to evaluate it as referring to an array
-               $site_dir => '@SITEHOME@',
-               $collect_dir => '@COLLECTHOME@',
-               $collection_path => '@THISCOLLECTPATH@'
+    my $site = $ENV{'SITEHOME'} ? $ENV{'SITEHOME'} : "";
+    my @gs_paths = ($ENV{'GSDLCOLLECTDIR'}, $ENV{'GSDLCOLLECTHOME'}, $site, $ENV{'GREENSTONEHOME'}); # list in this order: from longest to shortest path
+
+    my %placeholder_map = ($ENV{'GREENSTONEHOME'} => '@GSDLHOME@', # can't use double-quotes around at-sign, else perl tries to evaluate it as referring to an array
+               $site => '@SITEHOME@',
+               $ENV{'GSDLCOLLECTHOME'} => '@COLLECTHOME@',
+               $ENV{'GSDLCOLLECTDIR'} => '@THISCOLLECTPATH@'
     );
 
@@ -1336 +1321 @@
 
     foreach my $gs_path (@gs_paths) { 
+    next if($gs_path eq ""); # site can be empty
+
     my $re_path =  &util::filename_to_regex($gs_path); # escape for regex
 
-    next if($re_path eq ""); # site can be empty
-
-    if($path =~ m/^$re_path/) { # case sensitive or not for OS?
+    if($path =~ m/^$re_path/i) { # case sensitive or not for OS?
 
         my $placeholder = $placeholder_map{$gs_path}; # get the placeholder to replace the matched path with
@@ -1358 +1343 @@
     my $path = shift(@_); # path that can contain placeholders to convert to resolved absolute path
 
-    my ($collection_path, $collect_dir, $site_dir, $gs_home) = @_;
-
     return $path if($path !~ m/@/); # path contains no placeholders
     
     # replace placeholders with gs prefixes 
-
+    my $site = $ENV{'SITEHOME'} ? $ENV{'SITEHOME'} : "";
     my @placeholders = ('@THISCOLLECTPATH@', '@COLLECTHOME@', '@SITEHOME@', '@GSDLHOME@'); # order of paths not crucial in this case, 
                        # but listed here from longest to shortest once placeholders are have been resolved
 
-    my %placeholder_to_gspath_map = ('@GSDLHOME@' => $gs_home, # can't use double-quotes around at-sign, else perl tries to evaluate it as referring to an array
-               '@SITEHOME@' => $site_dir,
-               '@COLLECTHOME@' => $collect_dir,
-               '@THISCOLLECTPATH@' => $collection_path
+    my %placeholder_to_gspath_map = ('@GSDLHOME@' => $ENV{'GREENSTONEHOME'}, # can't use double-quotes around at-sign, else perl tries to evaluate it as referring to an array
+               '@SITEHOME@' => $site,
+               '@COLLECTHOME@' => $ENV{'GSDLCOLLECTHOME'},
+               '@THISCOLLECTPATH@' => $ENV{'GSDLCOLLECTDIR'}
     );