Changeset 27303 for main/trunk/greenstone2/perllib/plugin.pm

Timestamp:

2013-05-06T15:23:45+12:00 (11 years ago)

Author:

jmt12

Message:

Replacing hardcoded additions to INC and PATH environment variables with conditional ones - this allows us to use the order of values in these variables for precedence, thus allows better support for extensions that override classifiers, plugins etc. ENV and PATH functions already exists in util, but augmentINC() is a new function

File:

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

main/trunk/greenstone2/perllib/plugin.pm

@@ -32 +32 @@
 
 require util;
+use FileUtils;
 use gsprintf 'gsprintf';
 
@@ -84 +85 @@
     # pp_plugname shorthand for 'perllib' 'plugin' '$pluginname.pm' 
     my $pp_plugname 
-    = &util::filename_cat('perllib', 'plugins', "${pluginname}.pm");
+    = &FileUtils::filenameConcatenate('perllib', 'plugins', "${pluginname}.pm");
     my $collectdir = $ENV{'GSDLCOLLECTDIR'};
 
@@ -91 +92 @@
     {
     my $customplugname 
-        = &util::filename_cat($collectdir, "custom",$ENV{'GSDLCOLLECTION'},
+        = &FileUtils::filenameConcatenate($collectdir, "custom",$ENV{'GSDLCOLLECTION'},
                   $pp_plugname);
     push(@check_list,$customplugname);
     }
 
-    my $colplugname = &util::filename_cat($collectdir, $pp_plugname);
+    my $colplugname = &FileUtils::filenameConcatenate($collectdir, $pp_plugname);
     push(@check_list,$colplugname);
 
     if (defined $ENV{'GSDLEXTS'}) {
 
-    my $ext_prefix = &util::filename_cat($ENV{'GSDLHOME'}, "ext");
+    my $ext_prefix = &FileUtils::filenameConcatenate($ENV{'GSDLHOME'}, "ext");
 
     my @extensions = split(/:/,$ENV{'GSDLEXTS'});
     foreach my $e (@extensions) {
-        my $extplugname = &util::filename_cat($ext_prefix, $e, $pp_plugname);
+        my $extplugname = &FileUtils::filenameConcatenate($ext_prefix, $e, $pp_plugname);
         push(@check_list,$extplugname);
 
@@ -112 +113 @@
     if (defined $ENV{'GSDL3EXTS'}) {
 
-    my $ext_prefix = &util::filename_cat($ENV{'GSDL3SRCHOME'}, "ext");
+    my $ext_prefix = &FileUtils::filenameConcatenate($ENV{'GSDL3SRCHOME'}, "ext");
 
     my @extensions = split(/:/,$ENV{'GSDL3EXTS'});
     foreach my $e (@extensions) {
-        my $extplugname = &util::filename_cat($ext_prefix, $e, $pp_plugname);
+        my $extplugname = &FileUtils::filenameConcatenate($ext_prefix, $e, $pp_plugname);
         push(@check_list,$extplugname);
 
@@ -123 +124 @@
 
 
-    my $mainplugname = &util::filename_cat($ENV{'GSDLHOME'}, $pp_plugname);
+    my $mainplugname = &FileUtils::filenameConcatenate($ENV{'GSDLHOME'}, $pp_plugname);
     push(@check_list,$mainplugname);
 
@@ -130 +131 @@
     if (-e $plugname) {
         # lets add perllib folder to INC
+          # check it isn't already there first [jmt12]
         my ($perllibfolder) = $plugname =~ /^(.*[\/\\]perllib)[\/\\]plugins/;
-        if (-d $perllibfolder) {
+        if (-d $perllibfolder)
+            {
+              my $found_perllibfolder = 0;
+              foreach my $path (@INC)
+              {
+                if ($path eq $perllibfolder)
+                {
+                  $found_perllibfolder = 1;
+                  last;
+                }
+              }
+              if (!$found_perllibfolder)
+              {
         unshift (@INC, $perllibfolder);
-        } 
+              }
+        }
         require $plugname;
         $success=1;
@@ -171 +186 @@
     $failhandle = 'STDERR' unless defined $failhandle;
 
-    my $colperllibdir = &util::filename_cat($ENV{'GSDLCOLLECTDIR'},"perllib");
-    unshift (@INC, $colperllibdir);  
-    my $colplugindir = &util::filename_cat($colperllibdir,"plugins");
-     unshift (@INC, $colplugindir);  
+    # before pushing collection perl and plugin directories onto INC, test that
+    # they aren't already there [jmt12]
+    &util::augmentINC(&FileUtils::filenameConcatenate($ENV{'GSDLCOLLECTDIR'},'perllib'));
+    &util::augmentINC(&FileUtils::filenameConcatenate($ENV{'GSDLCOLLECTDIR'},'perllib','plugins'));
 
     map { $_ = "\"$_\""; } @$globaloptions;
@@ -270 +285 @@
     # the .kill file is a handy (if not very elegant) way of aborting 
     # an import.pl or buildcol.pl process
-    if (-e &util::filename_cat ($ENV{'GSDLCOLLECTDIR'}, ".kill")) {
+    if (-e &FileUtils::filenameConcatenate($ENV{'GSDLCOLLECTDIR'}, ".kill")) {
     gsprintf($outhandle, "{plugin.kill_file}\n");
     die "\n";
@@ -301 +316 @@
     # the .kill file is a handy (if not very elegant) way of aborting 
     # an import.pl or buildcol.pl process
-    if (-e &util::filename_cat ($ENV{'GSDLCOLLECTDIR'}, ".kill")) {
+    if (-e &FileUtils::filenameConcatenate($ENV{'GSDLCOLLECTDIR'}, ".kill")) {
     gsprintf($outhandle, "{plugin.kill_file}\n");
     die "\n";
@@ -352 +367 @@
     # the .kill file is a handy (if not very elegant) way of aborting 
     # an import.pl or buildcol.pl process
-    if (-e &util::filename_cat ($ENV{'GSDLCOLLECTDIR'}, ".kill")) {
+    if (-e &FileUtils::filenameConcatenate($ENV{'GSDLCOLLECTDIR'}, ".kill")) {
     gsprintf($outhandle, "{plugin.kill_file}\n");
     die "\n";