Changeset 27306 for main/trunk/greenstone2/perllib/plugout.pm

Timestamp:

2013-05-06T15:29:38+12:00 (11 years ago)

Author:

jmt12

Message:

Moving the critical file-related functions (copy, rm, etc) out of util.pm into their own proper class FileUtils. Use of the old functions in util.pm will prompt deprecated warning messages. There may be further functions that could be moved across in the future, but these are the critical ones when considering supporting other filesystems (HTTP, HDFS, WebDav, etc). Updated some key files to use the new functions so now deprecated messages thrown when importing/building demo collection 'out of the box'

File:

• main/trunk/greenstone2/perllib/plugout.pm (modified) (2 diffs)

main/trunk/greenstone2/perllib/plugout.pm

@@ -31 +31 @@
 
 require util;
+use FileUtils;
 use gsprintf 'gsprintf';
 
@@ -44 +45 @@
 my ($verbosity, $outhandle, $failhandle, $globaloptions);
 
+# - significantly rewritten to support plugouts in extensions [jmt12]
 sub load_plugout{
     my ($plugout) = shift @_;
+    my $plugout_name = shift @$plugout;
+    my $plugout_suffix = &FileUtils::filenameConcatenate('perllib', 'plugouts', $plugout_name . '.pm');
+    my $plugout_found = 0;
 
-    my $colplugdir = &util::filename_cat($ENV{'GSDLCOLLECTDIR'},"perllib/plugouts");
-    unshift (@INC, $colplugdir); 
-    
-    my $plugoutname = shift @$plugout;
+    # add collection plugout directory to INC unless it is already there
+    my $colplugdir = &FileUtils::filenameConcatenate($ENV{'GSDLCOLLECTDIR'},'perllib','plugouts');
+    if (-d $colplugdir)
+    {
+      my $found_colplugdir = 0;
+      foreach my $path (@INC)
+      {
+        if ($path eq $colplugdir)
+        {
+          $found_colplugdir = 1;
+          last;
+        }
+      }
+      if (!$found_colplugdir)
+      {
+        unshift (@INC, $colplugdir);
+      }
+    }
 
-    # find the plugout
-    my $customplugname;
+    # To find the plugout we check a number of possible locations
+    # - any plugout found in the collection itself is our first choice, with
+    #   those located in 'custom' having precedence
     if (defined($ENV{'GSDLCOLLECTION'}))
     {
-        $customplugname = &util::filename_cat($ENV{'GSDLCOLLECTDIR'}, "custom", $ENV{'GSDLCOLLECTION'}, 
-                         'perllib', 'plugouts', "${plugoutname}.pm");
+      my $collect_dir = $ENV{'GSDLCOLLECTION'};
+
+      # (needed for Veridian?)
+      my $custom_plugout = &FileUtils::filenameConcatenate($collect_dir, "custom", $collect_dir, $plugout_suffix);
+      if (&FileUtils::fileExists($custom_plugout))
+      {
+        require $custom_plugout;
+        $plugout_found = 1;
+      }
+      else
+      {
+        # typical collection override
+        my $collection_plugout = &FileUtils::filenameConcatenate($collect_dir, $plugout_suffix);
+        if (&FileUtils::fileExists($collection_plugout))
+        {
+          require $custom_plugout;
+          $plugout_found = 1;
+        }
+      }
+    }
+    # - we then search for overridden version provided by any registered GS3
+    #   extensions (check in order of extension definition)
+    if (!$plugout_found && defined $ENV{'GSDL3EXTS'})
+    {
+      my $ext_prefix = &FileUtils::filenameConcatenate($ENV{'GSDL3SRCHOME'}, "ext");
+      my @extensions = split(/:/,$ENV{'GSDL3EXTS'});
+      foreach my $e (@extensions)
+      {
+        my $extension_plugout = &FileUtils::filenameConcatenate($ext_prefix, $e, $plugout_suffix);
+        if (&FileUtils::fileExists($extension_plugout))
+        {
+          require $extension_plugout;
+          $plugout_found = 1;
+        }
+      }
+    }
+    # - similar for GS2 extensions
+    if (!$plugout_found && defined $ENV{'GSDLEXTS'})
+    {
+      my $ext_prefix = &FileUtils::filenameConcatenate($ENV{'GSDLHOME'}, "ext");
+      my @extensions = split(/:/,$ENV{'GSDLEXTS'});
+      foreach my $e (@extensions)
+      {
+        my $extension_plugout = &FileUtils::filenameConcatenate($ext_prefix, $e, $plugout_suffix);
+        if (&FileUtils::fileExists($extension_plugout))
+        {
+          require $extension_plugout;
+          $plugout_found = 1;
+        }
+      }
+    }
+    # - and the default is the main Greenstone version of the plugout
+    if (!$plugout_found)
+    {
+      my $main_plugout = &FileUtils::filenameConcatenate($ENV{'GSDLHOME'}, $plugout_suffix);
+      if (&FileUtils::fileExists($main_plugout))
+      {
+        require $main_plugout;
+        $plugout_found = 1;
+      }
     }
 
-    my $colplugname = &util::filename_cat($ENV{'GSDLCOLLECTDIR'}, 'perllib', 'plugouts', 
-                      "${plugoutname}.pm");
-    my $mainplugname = &util::filename_cat($ENV{'GSDLHOME'}, 'perllib', 'plugouts',
-                      "${plugoutname}.pm");
-    if (defined($customplugname) && -e $customplugname) { require $customplugname; }
-    elsif (-e $colplugname) { require $colplugname; }
-    elsif (-e $mainplugname) { require $mainplugname; }
-    else {
-    gsprintf($outhandle, "{plugout.could_not_find_plugout}\n",
-         $plugoutname);
-        die "\n";
+    # - no plugout found with this name
+    if (!$plugout_found)
+    {
+      gsprintf($outhandle, "{plugout.could_not_find_plugout}\n", $plugout_name);
+      die "\n";
     }
 
-    # create a plugout object
+    # - create a plugout object
     my ($plugobj);
 
-    eval ("\$plugobj = new \$plugoutname([],\$plugout)");
+    eval ("\$plugobj = new \$plugout_name([],\$plugout)");
     die "$@" if $@;