Changeset 32511

Timestamp:

2018-10-10T21:25:13+13:00 (6 years ago)

Author:

ak19

Message:

Running plugoutinfo.pl with describeall or listall flag would break on FedoraMETSPlugout when either FEDORA_HOME or FEDORA_VERSION aren't set (as is often the case), as there's a die statement in the BEGIN of FedoraMETSPlugout. Needed to run die if either FEDORA env var is not set only if the plugout is NOT in info_only mode in plugout constructor. However, info_only mode was never set in any of the plugouts, so had to add set up the infrastructure for it in plugoutinfo.pl and plugout.pm. Then added the info_only test to all teh plugouts, even though it's redundant in most of them for making sure future changes to any plugout's constructors does not break plugoutinfo.pl.

Location:

main/trunk/greenstone2

Files:

• bin/script/plugoutinfo.pl (modified) (2 diffs)
• perllib/plugout.pm (modified) (2 diffs)
• perllib/plugouts/BasePlugout.pm (modified) (1 diff)
• perllib/plugouts/DSpacePlugout.pm (modified) (1 diff)
• perllib/plugouts/FedoraMETSPlugout.pm (modified) (2 diffs)
• perllib/plugouts/GreenstoneMETSPlugout.pm (modified) (1 diff)
• perllib/plugouts/GreenstoneXMLPlugout.pm (modified) (1 diff)
• perllib/plugouts/MARCXMLPlugout.pm (modified) (1 diff)
• perllib/plugouts/METSPlugout.pm (modified) (1 diff)

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

@@ -177 +177 @@
         my $plugout;
         push @$plugout,$plugout_name; 
-        my $plugoutobj = &plugout::load_plugout ($plugout);
+        my $plugoutobj = &plugout::load_plugout ($plugout, "info_only");
         if ($describeall) {
         $plugoutobj->print_xml_usage(0);
@@ -202 +202 @@
     push @$plugout,$plugout_name;
 
-    my $plugoutobj = &plugout::load_plugout($plugout);
+    my $plugoutobj = &plugout::load_plugout($plugout, "info_only");
 
     if ($xml) {

main/trunk/greenstone2/perllib/plugout.pm

@@ -48 +48 @@
 sub load_plugout{
     my ($plugout) = shift @_;
+    my ($info_only) = shift @_; # optional. Set to info_only if we're just printing out plugout info
     my $plugout_name = shift @$plugout;
+
     my $plugout_suffix = &FileUtils::filenameConcatenate('perllib', 'plugouts', $plugout_name . '.pm');
     my $plugout_found = 0;
@@ -148 +150 @@
     my ($plugobj);
 
+    # if just doing plugoutinfo.pl, add in -gsdlinfo to plugout object's options
+    if($info_only) {
+    unshift (@$plugout, "-gsdlinfo");
+    }
+    
     eval ("\$plugobj = new \$plugout_name([],\$plugout)");
     die "$@" if $@;

main/trunk/greenstone2/perllib/plugouts/BasePlugout.pm

@@ -133 +133 @@
 
     # Check if gsdlinfo is in the argument list or not - if it is, don't parse 
-    # the args, just return the object.  
+    # the args, just return the object.
+    #print STDERR "#### " . join(",", @${args}) . "\n\n";
     foreach my $strArg (@{$args})
     {

main/trunk/greenstone2/perllib/plugouts/DSpacePlugout.pm

@@ -60 +60 @@
     push(@{$hashArgOptLists->{"OptList"}},$options);
 
-    my $self = new BasePlugout($plugoutlist,$inputargs,$hashArgOptLists);    
-
+    my $self = new BasePlugout($plugoutlist,$inputargs,$hashArgOptLists);
+    
+    if ($self->{'info_only'}) { 
+        # don't worry about any options etc
+        return bless $self, $class;
+    }
 #    print STDERR "***** metadata prefix = \"", $self->{'metadata_prefix'}, "\"\n";
 

main/trunk/greenstone2/perllib/plugouts/FedoraMETSPlugout.pm

@@ -37 +37 @@
     @FedoraMETSPlugout::ISA = ('METSPlugout');
 
-    if ((!defined $ENV{'FEDORA_HOME'}) || (!defined $ENV{'FEDORA_VERSION'})) {
-    if (defined $ENV{'FEDORA_HOME'}) {
-        print STDERR "FEDORA_HOME = $ENV{'FEDORA_HOME'}";
-    }
-
-    if (defined $ENV{'FEDORA_VERSION'}) {
-        print STDERR "FEDORA_VERSION = $ENV{'FEDORA_VERSION'}";
-    }
-
-    die "Need both environment variables FEDORA_HOME and FEDORA_VERSION to be set\n";
-    }
+    # Need both environment variables FEDORA_HOME and FEDORA_VERSION to be set to use this plugout!
+    # But we only test these vars are set in the constructor, so as not to break plugoutinfo.pl by
+    # a 'die' statement here nor break the xml that plugoutinfo.pl produces with print stmts here
+
 
     $ENV{'FEDORA_HOSTNAME'} = "localhost" if (!defined $ENV{'FEDORA_HOSTNAME'});
@@ -88 +81 @@
     
     my $self = new METSPlugout($plugoutlist,$inputargs,$hashArgOptLists);
-
+    
+    if ($self->{'info_only'}) {
+        # don't worry about any options etc
+        return bless $self, $class;
+    }
+    
+    # else (if we're not producing information for plugoutinfo.pl) make sure
+    # BOTH env vars FEDORA_HOME and FEDORA_VERSION are set. If either not set, die.
+    if ((!defined $ENV{'FEDORA_HOME'}) || (!defined $ENV{'FEDORA_VERSION'})) {
+    if (defined $ENV{'FEDORA_HOME'}) {
+        print STDERR "FEDORA_HOME = $ENV{'FEDORA_HOME'}";
+    }
+    
+    if (defined $ENV{'FEDORA_VERSION'}) {
+        print STDERR "FEDORA_VERSION = $ENV{'FEDORA_VERSION'}";
+    }
+    
+    die "ERROR: Need both environment variables FEDORA_HOME and FEDORA_VERSION to be set\n";
+    }
+    
     return bless $self, $class;
 }

main/trunk/greenstone2/perllib/plugouts/GreenstoneMETSPlugout.pm

@@ -57 +57 @@
 
     my $self = new METSPlugout($plugoutlist,$inputargs,$hashArgOptLists);
+    
+    if ($self->{'info_only'}) { 
+        # don't worry about any options etc
+        return bless $self, $class;
+    }
     
     return bless $self, $class;

main/trunk/greenstone2/perllib/plugouts/GreenstoneXMLPlugout.pm

@@ -63 +63 @@
 
     my $self = new BasePlugout($plugoutlist,$inputargs,$hashArgOptLists);
- 
+    
+    if ($self->{'info_only'}) { 
+        # don't worry about any options etc
+        return bless $self, $class;
+    }
     return bless $self, $class;
 }

main/trunk/greenstone2/perllib/plugouts/MARCXMLPlugout.pm

@@ -78 +78 @@
 
     my $self = new BasePlugout($plugoutlist,$inputargs,$hashArgOptLists);
-
+    
+    if ($self->{'info_only'}) { 
+        # don't worry about any options etc
+        return bless $self, $class;
+    }
+    
     $self->{'buffered_output'} ="";
      

main/trunk/greenstone2/perllib/plugouts/METSPlugout.pm

@@ -71 +71 @@
 
     my $self = new BasePlugout($plugoutlist,$inputargs,$hashArgOptLists);
-
+    
+    if ($self->{'info_only'}) {
+        # don't worry about any options etc
+        return bless $self, $class;
+    }
+    
     if(defined $self->{'xslt_txt'} &&  $self->{'xslt_txt'} ne "")
     {