Changeset 27305 for main/trunk/greenstone2/bin/script/import.pl

Timestamp:

2013-05-06T15:27:37+12:00 (11 years ago)

Author:

jmt12

Message:

Add code to allow importing and building to load overriding versions of inexport.pm and buildcolutils.pm from extensions at runtime. When an extension provides a possible override, Greenstone will dynamically detect and add additional options (visible in the --help). When a user specifies one of these options the appropriate inexport/buildcolutils subclass will be loaded

File:

• main/trunk/greenstone2/bin/script/import.pl (modified) (4 diffs)

main/trunk/greenstone2/bin/script/import.pl

@@ -67 +67 @@
 }
 
+# Pragma
 use strict;
+use warnings;
+
+# Modules
+use Symbol qw<qualify>; # Needed for runtime loading of modules [jmt12]
+
+# Greenstone Modules
+use FileUtils;
 use inexport;
-
-my $oidtype_list = 
+use util;
+
+my $oidtype_list =
     [ { 'name' => "hash",
         'desc' => "{import.OIDtype.hash}" },
@@ -129 +138 @@
     'type' => "string",
     # parsearg left "" as default
-    #'deft' => &util::filename_cat ($ENV{'GSDLHOME'}, "collect"),
+    #'deft' => &FileUtils::filenameConcatenate($ENV{'GSDLHOME'}, "collect"),
     'deft' => "",
     'reqd' => "no",
@@ -154 +163 @@
     'type' => "string",
     # parsearg left "" as default
-    #'deft' => &util::filename_cat("&lt;collectdir&gt;", "colname", "etc", "fail.log"),
+    #'deft' => &FileUtils::filenameConcatenate("&lt;collectdir&gt;", "colname", "etc", "fail.log"),
     'deft' => "",
     'reqd' => "no",
@@ -267 +276 @@
         'args' => $arguments };
 
-
-
-sub main 
+my $function_to_inexport_subclass_mappings = {};
+
+sub main
 {
-    my $inexport = new inexport("import",\@ARGV,$options);
-    
-    my $collection = $inexport->get_collection();
-
-    if (defined $collection) {
-    my ($config_filename,$collect_cfg) 
-        = $inexport->read_collection_cfg($collection,$options);    
-
-    $inexport->set_collection_options($collect_cfg);
-    
-    my $pluginfo = $inexport->process_files($config_filename,$collect_cfg);
-    
-    $inexport->generate_statistics($pluginfo);
+  # Dynamically include arguments from any subclasses of inexport we find
+  # in the extensions directory
+  if (defined $ENV{'GSDLEXTS'})
+  {
+    &_scanForSubclasses($ENV{'GSDLHOME'}, $ENV{'GSDLEXTS'});
+  }
+  if (defined $ENV{'GSDL3EXTS'})
+  {
+    &_scanForSubclasses($ENV{'GSDL3SRCHOME'}, $ENV{'GSDL3EXTS'});
+  }
+
+  # Loop through arguments, checking to see if any depend on a specific
+  # subclass of InExport. Note that we load the first subclass we encounter
+  # so only support a single 'override' ATM.
+  my $inexport_subclass;
+  foreach my $argument (@ARGV)
+  {
+    # proper arguments start with a hyphen
+    if ($argument =~ /^-/ && defined $function_to_inexport_subclass_mappings->{$argument})
+    {
+      my $required_inexport_subclass = $function_to_inexport_subclass_mappings->{$argument};
+      if (!defined $inexport_subclass)
+      {
+        $inexport_subclass = $required_inexport_subclass;
+      }
+      # Oh noes! The user has included specific arguments from two different
+      # inexport subclasses... this isn't supported
+      elsif ($inexport_subclass ne $required_inexport_subclass)
+      {
+        print STDERR "Error! You cannot specify arguments from two different extention specific inexport modules: " . $inexport_subclass . " != " . $required_inexport_subclass . "\n";
+        exit;
+      }
     }
+  }
+
+  my $inexport;
+  if (defined $inexport_subclass)
+  {
+    print "* Loading Overriding InExport Module: " . $inexport_subclass . "\n";
+    require $inexport_subclass . '.pm';
+    $inexport = new $inexport_subclass("import",\@ARGV,$options);
+  }
+  # We don't have a overridden inexport, or the above command failed somehow
+  # so load the base inexport class
+  if (!defined $inexport)
+  {
+    $inexport = new inexport("import",\@ARGV,$options);
+  }
+
+  my $collection = $inexport->get_collection();
+
+  if (defined $collection)
+  {
+    my ($config_filename,$collect_cfg) = $inexport->read_collection_cfg($collection,$options);
+
+    $inexport->set_collection_options($collect_cfg);
+
+    my $pluginfo = $inexport->process_files($config_filename,$collect_cfg);
+
+    $inexport->generate_statistics($pluginfo);
+  }
+
+  $inexport->deinit();
 }
-
+# main()
+
+# @function _scanForSubclasses()
+# @param $dir The extension directory to look within
+# @param $exts A list of the available extensions (as a colon separated string)
+# @return The number of subclasses of InExport found as an Integer
+sub _scanForSubclasses
+{
+  my ($dir, $exts) = @_;
+  my $inexport_class_count = 0;
+  my $ext_prefix = &FileUtils::filenameConcatenate($dir, "ext");
+  my @extensions = split(/:/, $exts);
+  foreach my $e (@extensions)
+  {
+    # - any subclass of InExport must be prefixed with the name of the ext
+    my $package_name = $e . 'inexport';
+    $package_name =~ s/[^a-z]//gi; # package names have limited characters
+    my $inexport_filename = $package_name . '.pm';
+    my $inexport_path = &FileUtils::filenameConcatenate($ext_prefix, $e, 'perllib', $inexport_filename);
+    # see if we have a subclass of InExport lurking in that extension folder
+    if (-f $inexport_path)
+    {
+      # - note we load the filename (with pm) unlike normal modules
+      require $inexport_filename;
+      # - make call to the newly created package
+      my $symbol = qualify('getSupportedArguments', $package_name);
+      # - strict prevents strings being used as function calls, so temporarily
+      #   disable that pragma
+      no strict;
+      # - lets check that the function we are about to call actually exists
+      if ( defined &{$symbol} )
+      {
+        my $extra_arguments = &{$symbol}();
+        foreach my $argument (@{$extra_arguments})
+        {
+          # - record a mapping from each extra arguments to the inexport class
+          #   that supports it. We put the hyphen on here to make comparing
+          #   with command line arguments even easier
+          $function_to_inexport_subclass_mappings->{'-' . $argument->{'name'}} = $package_name;
+          # - and them add them as acceptable arguments to import.pl
+          push(@{$options->{'args'}}, $argument);
+        }
+        $inexport_class_count++;
+      }
+      else
+      {
+        print "Warning! A subclass of InExport module (named '" . $inexport_filename . "') does not implement the required getSupportedArguments() function - ignoring. Found in: " . $inexport_path . "\n";
+      }
+    }
+  }
+  return $inexport_class_count;
+}
+# _scanForInExportModules()
 
 &main();