Changeset 16467 for gsdl

Timestamp:

2008-07-18T15:47:37+12:00 (16 years ago)

Author:

ak19

Message:

Merged GS2's gliserver.pl and gsdlCGI.pm with GS3's gliserver4gs3.pl and gsdlCGI4gs3.pm and moved them into gs2's svn trunk (previously still in GS3's svn trunk). Now there's one set of gliserver files that will work for both GS2 and GS3 remote Greenstone servers.

Location:

gsdl/trunk/cgi-bin

Files:

• gliserver.pl (modified) (57 diffs)
• gsdlCGI.pm (modified) (13 diffs)
• gsdlsite.cfg (modified) (3 diffs)

gsdl/trunk/cgi-bin/gliserver.pl

@@ -1 +1 @@
 #!/usr/bin/perl -w
-#!perl -w
 # Need to specify the full path of Perl above
 
+# This file merges Michael Dewsnip's gliserver.pl for GS2 and Quan Qiu's gliserver4gs3.pl (GS3)
 
 use strict;
+no strict 'subs';
+no strict 'refs'; # allow filehandles to be variables and viceversa
 
 
@@ -10 +12 @@
 my $iis6_mode = 0;
 
-
+##
 # IIS 6: for some reason, IIS runs this script with the working directory set to the Greenstone
 #   directory rather than the cgi-bin directory, causing lots of stuff to fail
 if ($iis6_mode)
 {
-    # Change into cgi-bin directory
-    chdir("cgi-bin");
-}
-
-
-# We use require and an eval here (instead of "use") to catch any errors loading the module (for IIS)
+    # Change into cgi-bin directory - need to ensure it exists, since gliserver deals with both GS2 and GS3
+    if(-e "cgi-bin" && -d "cgi-bin") { # GS2
+    chdir("cgi-bin");
+    } else { # iis6_mode is not applicable for Greenstone 3
+    $iis6_mode = 0;
+    }
+}
+
+
+# We use require and an eval here (instead of "use package") to catch any errors loading the module (for IIS)
 eval("require \"gsdlCGI.pm\"");
 if ($@)
@@ -30 +36 @@
 
 
-my $debugging_enabled = 0;
+#my $authentication_enabled = 0;
+my $debugging_enabled = 0; # if 1, debugging is enabled and unlinking intermediate files (deleting files) will not happen
 
 my $mail_enabled = 0;
@@ -38 +45 @@
 
 sub main
-{
+{   
     my $gsdl_cgi = new gsdlCGI();
 
@@ -44 +51 @@
     $gsdl_cgi->setup_gsdl();
     my $gsdlhome = $ENV{'GSDLHOME'};
+
     $gsdl_cgi->checked_chdir($gsdlhome);
-    require "$gsdlhome/perllib/util.pm";  # This is OK on Windows
-    require "$gsdlhome/perllib/cpan/Crypt/UnixCrypt.pm";  # This is OK on Windows
 
     # Encrypt the password
-    if (defined $gsdl_cgi->param("pw")) {
-    $gsdl_cgi->param('-name' => "pw", '-value' => &Crypt::UnixCrypt::crypt($gsdl_cgi->clean_param("pw"), "Tp"));
-    }
+    $gsdl_cgi->encrypt_password();
 
     $gsdl_cgi->parse_cgi_args();
@@ -65 +69 @@
     $gsdl_cgi->delete("cmd");
 
-    # The check-installation command has no arguments
+    # The check-installation, greenstone-server-version and get-library-url commands have no arguments
     if ($cmd eq "check-installation") {
     &check_installation($gsdl_cgi);
+    return;
+    }
+    elsif ($cmd eq "greenstone-server-version") {
+    &greenstone_server_version($gsdl_cgi);
+    return;
+    }
+    elsif ($cmd eq "get-library-url-suffix") {
+    &get_library_url_suffix($gsdl_cgi);
     return;
     }
@@ -76 +88 @@
     $gsdl_cgi->generate_error("No username specified.");
     }
-    # Remove the un argument (since this can mess up other scripts)
     $gsdl_cgi->delete("un");
 
@@ -86 +97 @@
     $gsdl_cgi->delete("ts");
 
+    my $site; # undefined on declaration, see http://perldoc.perl.org/perlsyn.html
+    if($gsdl_cgi->greenstone_version() != 2) { # all GS versions after 2 may define site
+    $site = $gsdl_cgi->clean_param("site");   
+    if (!defined $site) {
+        $gsdl_cgi->generate_error("No site specified.");
+    }
+    $gsdl_cgi->delete("site");
+    }
+
+
     if ($cmd eq "delete-collection") {
-    &delete_collection($gsdl_cgi, $username, $timestamp);
+    &delete_collection($gsdl_cgi, $username, $timestamp, $site);
     }
     elsif ($cmd eq "download-collection") {
-    &download_collection($gsdl_cgi, $username, $timestamp);
+    &download_collection($gsdl_cgi, $username, $timestamp, $site);
     }
     elsif ($cmd eq "download-collection-archives") {
-    &download_collection_archives($gsdl_cgi, $username, $timestamp);
+    &download_collection_archives($gsdl_cgi, $username, $timestamp, $site);
     }
     elsif ($cmd eq "download-collection-configurations") {
-    &download_collection_configurations($gsdl_cgi, $username, $timestamp);
+    &download_collection_configurations($gsdl_cgi, $username, $timestamp, $site);
     }
     elsif ($cmd eq "download-collection-file") {
-    &download_collection_file($gsdl_cgi, $username, $timestamp);
+    &download_collection_file($gsdl_cgi, $username, $timestamp, $site);
     }
     elsif ($cmd eq "delete-collection-file") {
-    &delete_collection_file($gsdl_cgi, $username, $timestamp);
+    &delete_collection_file($gsdl_cgi, $username, $timestamp, $site);
     }
     elsif ($cmd eq "get-script-options") {
-    &get_script_options($gsdl_cgi, $username, $timestamp);
+    &get_script_options($gsdl_cgi, $username, $timestamp, $site);
     }
     elsif ($cmd eq "move-collection-file") {
-    &move_collection_file($gsdl_cgi, $username, $timestamp);
+    &move_collection_file($gsdl_cgi, $username, $timestamp, $site);
     }
     elsif ($cmd eq "new-collection-directory") {
-    &new_collection_directory($gsdl_cgi, $username, $timestamp);
+    &new_collection_directory($gsdl_cgi, $username, $timestamp, $site);
     }
     elsif ($cmd eq "run-script") {
-    &run_script($gsdl_cgi, $username, $timestamp);
+    &run_script($gsdl_cgi, $username, $timestamp, $site);
     }
     elsif ($cmd eq "timeout-test") {
@@ -120 +141 @@
     }
     elsif ($cmd eq "upload-collection-file") {
-    &upload_collection_file($gsdl_cgi, $username, $timestamp);
-    } 
+    &upload_collection_file($gsdl_cgi, $username, $timestamp, $site);
+    }
     elsif ($cmd eq "file-exists") { 
-    &file_exists($gsdl_cgi);
-    }   
+    &file_exists($gsdl_cgi, $site);
+    }
+    # cmds not in Greenstone 2:
+    elsif ($gsdl_cgi->greenstone_version() != 2) {  
+    if ($cmd eq "download-web-xml-file") {
+        &download_web_xml_file($gsdl_cgi, $username, $timestamp, $site);
+    } 
+    elsif ($cmd eq "user-validation") {
+        &user_validation($gsdl_cgi, $username, $timestamp, $site);
+    }
+    elsif ($cmd eq "get-site-names") {
+        &get_site_names($gsdl_cgi, $username, $timestamp, $site);
+    }
+    }
     else {
     $gsdl_cgi->generate_error("Unrecognised command: '$cmd'");
     }
-}
+        
+}
+
 
 sub authenticate_user
@@ -135 +170 @@
     my $username = shift(@_);
     my $collection = shift(@_);
-
-    # Remove the pw argument (since this can mess up other scripts)
+    my $site = shift(@_);
+
+    # Even if we're not authenticating remove the un and pw arguments, since these can mess up other scripts
     my $user_password = $gsdl_cgi->clean_param("pw");
     $gsdl_cgi->delete("pw");
 
+    # Only authenticate if it is enabled
+    # return "all-collections-editor" if (!$authentication_enabled);
+
     if ((!defined $user_password) || ($user_password =~ m/^\s*$/)) {
     $gsdl_cgi->generate_error("Authentication failed: no password specified.");
     }
 
-    my $gsdlhome = $ENV{'GSDLHOME'};
-    my $etc_directory = &util::filename_cat($gsdlhome, "etc");
-    my $users_db_file_path = &util::filename_cat($etc_directory, "users.db");
-
-    # Use db2txt instead of GDBM_File to get the user accounts information
-    my $users_db_content = "";
-    open(USERS_DB, "db2txt \"$users_db_file_path\" |");
-    while (<USERS_DB>) {
-    $users_db_content .= $_;
-    }
-
-    # Get the user account information from the users.db database
+    my $users_db_content;
+    if($gsdl_cgi->greenstone_version() == 2) {
+    my $etc_directory = &util::filename_cat($ENV{'GSDLHOME'}, "etc");
+    my $users_db_file_path = &util::filename_cat($etc_directory, "users.db");
+    
+    # Use db2txt instead of GDBM_File to get the user accounts information
+    $users_db_content = "";
+    open(USERS_DB, "db2txt \"$users_db_file_path\" |");
+    while (<USERS_DB>) {
+        $users_db_content .= $_;
+    }
+    }
+    elsif($gsdl_cgi->greenstone_version() == 3) {
+    my $gsdl3srchome = $ENV{'GSDL3SRCHOME'};
+
+    my $java = $gsdl_cgi->get_java_path();
+    my $java_gsdl3_classpath = &util::filename_cat($gsdl3srchome, "web", "WEB-INF", "lib", "gsdl3.jar");
+    my $java_derby_classpath = &util::filename_cat($gsdl3srchome, "web", "WEB-INF", "lib", "derby.jar");
+    my $java_classpath;
+    my $gsdlos = $ENV{'GSDLOS'};
+    if ($gsdlos !~ m/windows/){
+        $java_classpath = $java_gsdl3_classpath . ":" . $java_derby_classpath;
+    }else{
+        $java_classpath = $java_gsdl3_classpath . ";" . $java_derby_classpath;
+    }
+    my $java_args = &util::filename_cat($gsdl3srchome, "web", "sites", $site, "etc", "usersDB");
+    $gsdl_cgi->checked_chdir($java_args);
+    my $java_command="\"$java\" -classpath \"$java_classpath\" org.greenstone.gsdl3.util.usersDB2txt \"$java_args\" 2>&1";
+    $users_db_content = `$java_command`;
+    }
+    
+    # Get the user account information from the usersDB database
     my %users_db_data = ();
     foreach my $users_db_entry (split(/-{70}/, $users_db_content)) {
-    if ($users_db_entry =~ /\n?\[(.+)\]\n/) {
+    if ($users_db_entry =~ m/\n?\[(.+)\]\n/) {
         $users_db_data{$1} = $users_db_entry;
     }
@@ -170 +229 @@
 
     # Check password
-    my ($valid_user_password) = ($user_data =~ /\<password\>(.*)/);
+    my ($valid_user_password) = ($user_data =~ m/\<password\>(.*)/);
     if ($user_password ne $valid_user_password) {
     $gsdl_cgi->generate_error("Authentication failed: incorrect password.");
@@ -176 +235 @@
 
     # Check group
-    my ($user_groups) = ($user_data =~ /\<groups\>(.*)/);
+    my ($user_groups) = ($user_data =~ m/\<groups\>(.*)/);
+
     if ($collection eq "") {
     # If we're not editing a collection then the user doesn't need to be in a particular group
     return $user_groups;  # Authentication successful
     }
+
     foreach my $user_group (split(/\,/, $user_groups)) {
     # Does this user have access to all collections?
@@ -187 +248 @@
     }
     # Does this user have access to personal collections, and is this one?
-    if ($user_group eq "personal-collections-editor" && $collection =~ /^$username\-/) {
+    if ($user_group eq "personal-collections-editor" && $collection =~ m/^$username\-/) {
         return $user_groups;  # Authentication successful
     }
@@ -195 +256 @@
     }
     }
-
     $gsdl_cgi->generate_error("Authentication failed: user is not in the required group.");
 }
@@ -205 +265 @@
     my $username = shift(@_);
     my $collection = shift(@_);
+    my $site = shift(@_);
 
     my $steal_lock = $gsdl_cgi->clean_param("steal_lock");
     $gsdl_cgi->delete("steal_lock");
 
-    my $gsdlhome = $ENV{'GSDLHOME'};
-    my $collection_directory = &util::filename_cat($gsdlhome, "collect", $collection);
+    my $collection_directory = $gsdl_cgi->get_collection_dir($site, $collection);
     $gsdl_cgi->checked_chdir($collection_directory);
 
@@ -225 +285 @@
 
     # Pick out the owner of the lock file
-    $lock_file_content =~ /\<User\>(.*?)\<\/User\>/;
+    $lock_file_content =~ m/\<User\>(.*?)\<\/User\>/;
     my $lock_file_owner = $1;
 
@@ -257 +317 @@
 #   ACTIONS
 # ----------------------------------------------------------------------------------------------------
-
+# This routine, which uses the variable site, won't get called by GS2, 
+sub user_validation{
+    my ($gsdl_cgi, $username, $timestamp, $site) = @_;
+   
+    # Users can be in any group to perform this action
+    my $user_err = &authenticate_user($gsdl_cgi, $username, "", $site);
+     if (defined $user_err && $user_err!~ m/ERROR/){
+     if ($user_err!~ m/ERROR/){
+         #$gsdl_cgi->generate_error("Authentication failed: $username is not valid");
+         $gsdl_cgi->generate_ok($user_err);
+         #print $user_err;
+     }else{
+         $gsdl_cgi->generate_error($user_err);
+         #print "not valid" . $user_err;
+     }
+     }else{
+     $gsdl_cgi->generate_error("Authentication failed: $username is not valid");     
+     }
+}
 
 sub check_installation
@@ -266 +344 @@
     my $installation_status = "";
 
-    print STDOUT "Content-type:text/plain\n\n";
-
     # Check that Java is installed and accessible
     my $java = $gsdl_cgi->get_java_path();
-    my $java_command = "$java -version 2>&1";
-
+    my $java_command = "\"$java\" -version 2>&1";
+    
     # IIS 6: redirecting output from STDERR to STDOUT just doesn't work, so we have to let it go
     #   directly out to the page
-    if ($iis6_mode)
-    {
-    $java_command = "java -version";
+    if($iis6_mode && $gsdl_cgi->greenstone_version() == 2) { ##
+    print STDOUT "Content-type:text/plain\n\n";
+    $java_command = "\"$java\" -version";
     }
 
     my $java_output = `$java_command`;
+        
     my $java_status = $?;
     if ($java_status < 0) {
@@ -292 +369 @@
     # Show the values of some important environment variables
     $installation_status .= "\n";
+    if($gsdl_cgi->greenstone_version() != 2) {
+    $installation_status .= "GSDL3SRCHOME: " . $ENV{'GSDL3SRCHOME'} . "\n";
+    $installation_status .= "GSDL3HOME: " . $ENV{'GSDL3HOME'} . "\n";
+    }
     $installation_status .= "GSDLHOME: " . $ENV{'GSDLHOME'} . "\n";
     $installation_status .= "GSDLOS: " . $ENV{'GSDLOS'} . "\n";
+    $installation_status .= "JAVA_HOME: " . $ENV{'JAVA_HOME'} . "\n" if defined($ENV{'JAVA_HOME'}); # on GS2, Java's only on the PATH
     $installation_status .= "PATH: " . $ENV{'PATH'} . "\n";
-
-    if ($installation_ok) {
-    print STDOUT $installation_status . "\nInstallation OK!";
+    if(defined $ENV{'FEDORA_VERSION'}) { # not using FLI unless version set
+    $installation_status .= "FEDORA_HOME: ".$ENV{'FEDORA_HOME'} . "\n";
+    $installation_status .= "FEDORA_VERSION: ".$ENV{'FEDORA_VERSION'};
+    }
+    
+    if ($installation_ok) { ## M. Dewsnip's svn log comment stated that for iis6_mode output needs to go to STDOUT
+    if($iis6_mode && $gsdl_cgi->greenstone_version() == 2) {
+        print STDOUT $installation_status . "\nInstallation OK!";
+    } else {
+        $gsdl_cgi->generate_ok_message($installation_status . "\nInstallation OK!");
+    }
     }
     else {
-    print STDOUT $installation_status;
+    if($iis6_mode && $gsdl_cgi->greenstone_version() == 2) {
+        print STDOUT $installation_status;
+    } else {
+        $gsdl_cgi->generate_error($installation_status);
+    }
     }
 }
@@ -307 +401 @@
 sub delete_collection
 {
-    my ($gsdl_cgi, $username, $timestamp) = @_;
+    my ($gsdl_cgi, $username, $timestamp, $site) = @_;
 
     my $collection = $gsdl_cgi->clean_param("c");
@@ -315 +409 @@
 
     # Ensure the user is allowed to edit this collection
-    &authenticate_user($gsdl_cgi, $username, $collection);
-
-    my $gsdlhome = $ENV{'GSDLHOME'};
-    my $collect_directory = &util::filename_cat($gsdlhome, "collect");
+    &authenticate_user($gsdl_cgi, $username, $collection, $site);
+
+
+    my $collect_directory = $gsdl_cgi->get_collection_dir($site);
     $gsdl_cgi->checked_chdir($collect_directory);
 
@@ -327 +421 @@
 
     # Make sure the collection isn't locked by someone else
-    &lock_collection($gsdl_cgi, $username, $collection);
+    &lock_collection($gsdl_cgi, $username, $collection, $site);
 
     $gsdl_cgi->checked_chdir($collect_directory);
@@ -343 +437 @@
 sub delete_collection_file
 {
-    my ($gsdl_cgi, $username, $timestamp) = @_;
+    my ($gsdl_cgi, $username, $timestamp, $site) = @_;
 
     my $collection = $gsdl_cgi->clean_param("c");
@@ -356 +450 @@
 
     # Make sure we don't try to delete anything outside the collection
-    if ($file =~ /\.\./) {
+    if ($file =~ m/\.\./) {
     $gsdl_cgi->generate_error("Illegal file specified.");
     }
 
     # Ensure the user is allowed to edit this collection
-    &authenticate_user($gsdl_cgi, $username, $collection);
-
-    my $gsdlhome = $ENV{'GSDLHOME'};
-    my $collection_directory = &util::filename_cat($gsdlhome, "collect", $collection);
+    &authenticate_user($gsdl_cgi, $username, $collection, $site);
+
+    my $collection_directory = $gsdl_cgi->get_collection_dir($site, $collection);
+    if (!-d $collection_directory){ ## wasn't there in gs2, ok_msg or error_msg?
+    $gsdl_cgi->generate_ok_message("Directory $collection_directory does not exist."); 
+    die;
+    }
+
     $gsdl_cgi->checked_chdir($collection_directory);
 
     # Make sure the collection isn't locked by someone else
-    &lock_collection($gsdl_cgi, $username, $collection);
+    &lock_collection($gsdl_cgi, $username, $collection, $site);
 
     # Check that the collection file exists
-    if (!-e $file) {
+    if (!-e $file) { ## original didn't have 'die', but it was an ok message
     $gsdl_cgi->generate_ok_message("Collection file $file does not exist.");
+    die;
     }
     $gsdl_cgi->local_rm_r("$file");
@@ -387 +486 @@
 sub download_collection
 {
-    my ($gsdl_cgi, $username, $timestamp) = @_;
+    my ($gsdl_cgi, $username, $timestamp, $site) = @_;
 
     my $collection = $gsdl_cgi->clean_param("c");
@@ -395 +494 @@
 
     # Ensure the user is allowed to edit this collection
-    &authenticate_user($gsdl_cgi, $username, $collection);
-
-    my $gsdlhome = $ENV{'GSDLHOME'};
-    my $collect_directory = &util::filename_cat($gsdlhome, "collect");
+    &authenticate_user($gsdl_cgi, $username, $collection, $site);
+
+    my $collect_directory = $gsdl_cgi->get_collection_dir($site);
     $gsdl_cgi->checked_chdir($collect_directory);
 
     # Check that the collection exists
     if (!-d $collection) {
-    $gsdl_cgi->generate_error("Collection $collection does not exist.");
+    $gsdl_cgi->generate_ok_message("Collection $collection does not exist."); ## original had an error msg (from where it would die)
+    die;
     }
 
     # Make sure the collection isn't locked by someone else
-    &lock_collection($gsdl_cgi, $username, $collection);
+    &lock_collection($gsdl_cgi, $username, $collection, $site);
 
     # Zip up the collection
     my $java = $gsdl_cgi->get_java_path();
-    my $java_classpath = &util::filename_cat($gsdlhome, "bin", "java", "GLIServer.jar");
+    my $java_classpath = &util::filename_cat($ENV{'GSDLHOME'}, "bin", "java", "GLIServer.jar");
     my $zip_file_path = &util::filename_cat($collect_directory, $collection . "-" . $timestamp . ".zip");
     my $java_args = "\"$zip_file_path\" \"$collect_directory\" \"$collection\"";
-    my $java_command = "$java -classpath \"$java_classpath\" org.greenstone.gatherer.remote.ZipCollectionShell $java_args"; 
+    if($gsdl_cgi->greenstone_version() != 2) {
+    $java_args .= " gsdl3"; ## must this be done elsewhere as well?
+    }
+    my $java_command = "\"$java\" -classpath \"$java_classpath\" org.greenstone.gatherer.remote.ZipCollectionShell $java_args"; 
 
     my $java_output = `$java_command`;
@@ -427 +529 @@
     }
 
-    &put_file($gsdl_cgi, $zip_file_path, "application/zip");
-    unlink("$zip_file_path") unless $debugging_enabled;
+    &put_file($gsdl_cgi, $zip_file_path, "application/zip"); # file is transferred to client
+    unlink("$zip_file_path") unless $debugging_enabled;      # deletes the local intermediate zip file
 }
 
@@ -434 +536 @@
 sub download_collection_archives
 {
-    my ($gsdl_cgi, $username, $timestamp) = @_;
+    my ($gsdl_cgi, $username, $timestamp, $site) = @_;
 
     my $collection = $gsdl_cgi->clean_param("c");
@@ -442 +544 @@
 
     # Ensure the user is allowed to edit this collection
-    &authenticate_user($gsdl_cgi, $username, $collection);
-
-    my $gsdlhome = $ENV{'GSDLHOME'};
-    my $collect_directory = &util::filename_cat($gsdlhome, "collect");
+    &authenticate_user($gsdl_cgi, $username, $collection, $site);
+
+    my $collect_directory = $gsdl_cgi->get_collection_dir($site);
     $gsdl_cgi->checked_chdir($collect_directory);
 
@@ -454 +555 @@
 
     # Make sure the collection isn't locked by someone else
-    &lock_collection($gsdl_cgi, $username, $collection);
+    &lock_collection($gsdl_cgi, $username, $collection, $site);
 
     # Zip up the collection archives
     my $java = $gsdl_cgi->get_java_path();
-    my $java_classpath = &util::filename_cat($gsdlhome, "bin", "java", "GLIServer.jar");
+    my $java_classpath = &util::filename_cat($ENV{'GSDLHOME'}, "bin", "java", "GLIServer.jar");
     my $zip_file_path = &util::filename_cat($collect_directory, $collection . "-archives-" . $timestamp . ".zip");
     my $java_args = "\"$zip_file_path\" \"$collect_directory\" \"$collection\"";
-    my $java_command = "$java -classpath \"$java_classpath\" org.greenstone.gatherer.remote.ZipCollectionArchives $java_args"; 
+    my $java_command = "\"$java\" -classpath \"$java_classpath\" org.greenstone.gatherer.remote.ZipCollectionArchives $java_args"; 
 
     my $java_output = `$java_command`;
@@ -482 +583 @@
 sub download_collection_configurations
 {
-    my ($gsdl_cgi, $username, $timestamp) = @_;
-
+    my ($gsdl_cgi, $username, $timestamp, $site) = @_;
+   
     # Users can be in any group to perform this action
-    my $user_groups = &authenticate_user($gsdl_cgi, $username, "");
-
-    my $gsdlhome = $ENV{'GSDLHOME'};
-    my $collect_directory = &util::filename_cat($gsdlhome, "collect");
+    my $user_groups = &authenticate_user($gsdl_cgi, $username, "", $site);
+
+    my $collect_directory = $gsdl_cgi->get_collection_dir($site);
     $gsdl_cgi->checked_chdir($collect_directory);
 
     # Zip up the collection configurations
     my $java = $gsdl_cgi->get_java_path();
-    my $java_classpath = &util::filename_cat($gsdlhome, "bin", "java", "GLIServer.jar");
+    my $java_classpath = &util::filename_cat($ENV{'GSDLHOME'}, "bin", "java", "GLIServer.jar");
     my $zip_file_path = &util::filename_cat($collect_directory, "collection-configurations-" . $timestamp . ".zip");
     my $java_args = "\"$zip_file_path\" \"$collect_directory\" \"$username\" \"$user_groups\"";
-    my $java_command = "$java -classpath \"$java_classpath\" org.greenstone.gatherer.remote.ZipCollectionConfigurations $java_args"; 
-
+    my $java_command = "\"$java\" -classpath \"$java_classpath\" org.greenstone.gatherer.remote.ZipCollectionConfigurations $java_args"; 
     my $java_output = `$java_command`;
     my $java_status = $?;
@@ -518 +617 @@
 sub file_exists
 {
-    my ($gsdl_cgi) = @_;
+    my ($gsdl_cgi, $site) = @_;
 
     my $collection = $gsdl_cgi->clean_param("c");
@@ -530 +629 @@
     $file =~ s/\|/&util::get_dirsep()/eg;  # Convert the '|' characters into whatever is right for this OS
    
-    # Not necessary: checking whether the user is authenticated to query existance of the file
+    # Not necessary: checking whether the user is authenticated to query existence of the file
     #&authenticate_user($gsdl_cgi, $username, $collection);
 
-    my $gsdlhome = $ENV{'GSDLHOME'};
-    my $collection_directory = &util::filename_cat($gsdlhome, "collect", $collection);
-    $gsdl_cgi->checked_chdir($collection_directory);
+    my $collection_directory = $gsdl_cgi->get_collection_dir($site, $collection);
+    $gsdl_cgi->checked_chdir($collection_directory); # cd into the directory of that collection
 
     # Check that the collection file exists
@@ -547 +645 @@
 sub download_collection_file
 {
-    my ($gsdl_cgi, $username, $timestamp) = @_;
+    my ($gsdl_cgi, $username, $timestamp, $site) = @_;
 
     my $collection = $gsdl_cgi->clean_param("c");
@@ -560 +658 @@
 
     # Make sure we don't try to download anything outside the collection
-    if ($file =~ /\.\./) {
+    if ($file =~ m/\.\./) {
     $gsdl_cgi->generate_error("Illegal file specified.");
     }
 
     # Ensure the user is allowed to edit this collection
-    &authenticate_user($gsdl_cgi, $username, $collection);
-
-    my $gsdlhome = $ENV{'GSDLHOME'};
-    my $collection_directory = &util::filename_cat($gsdlhome, "collect", $collection);
+    &authenticate_user($gsdl_cgi, $username, $collection, $site);
+
+    my $collection_directory = $gsdl_cgi->get_collection_dir($site, $collection);
     $gsdl_cgi->checked_chdir($collection_directory);
 
     # Check that the collection file exists
     if (!-e $file) {
-    $gsdl_cgi->generate_error("Collection file $file does not exist.");
+    $gsdl_cgi->generate_ok_message("Collection file $file does not exist.");
+    die;
     }
 
     # Make sure the collection isn't locked by someone else
-    &lock_collection($gsdl_cgi, $username, $collection);
+    &lock_collection($gsdl_cgi, $username, $collection, $site);
 
     # Zip up the collection file
     my $java = $gsdl_cgi->get_java_path();
-    my $java_classpath = &util::filename_cat($gsdlhome, "bin", "java", "GLIServer.jar");
+    my $java_classpath = &util::filename_cat($ENV{'GSDLHOME'}, "bin", "java", "GLIServer.jar");
     my $zip_file_path = &util::filename_cat($collection_directory, $collection . "-file-" . $timestamp . ".zip");
     my $java_args = "\"$zip_file_path\" \"$collection_directory\" \"$file\"";
-    my $java_command = "$java -classpath \"$java_classpath\" org.greenstone.gatherer.remote.ZipFiles $java_args"; 
+    my $java_command = "\"$java\" -classpath \"$java_classpath\" org.greenstone.gatherer.remote.ZipFiles $java_args"; 
 
     my $java_output = `$java_command`;
@@ -601 +699 @@
 }
 
+# download web.xml from the server
+sub download_web_xml_file
+{
+    my ($gsdl_cgi, $username, $timestamp, $site) = @_;
+
+    # Users can be in any group to perform this action
+    my $user_groups = &authenticate_user($gsdl_cgi, $username, "", $site);
+
+    my $file = $gsdl_cgi->clean_param("file");
+    if ((!defined $file) || ($file =~ m/^\s*$/)) {
+    $gsdl_cgi->generate_error("No file specified.");
+    }
+    $file =~ s/\|/&util::get_dirsep()/eg;  # Convert the '|' characters into whatever is right for this OS
+
+    # Make sure we don't try to download anything else
+    if ($file =~ m/\.\./) {
+    $gsdl_cgi->generate_error("Illegal file specified.");
+    }
+
+    my $web_inf_directory = &util::filename_cat($ENV{'GSDL3SRCHOME'}, "web", "WEB-INF");
+    $gsdl_cgi->checked_chdir($web_inf_directory);
+
+    # Check that the collection file exists
+    if (!-e $file) {
+    $gsdl_cgi->generate_error("file $file does not exist.");
+    }
+
+    # Zip up the collection file
+    my $java = $gsdl_cgi->get_java_path();
+    my $java_classpath = &util::filename_cat($ENV{'GSDLHOME'}, "bin", "java", "GLIServer.jar");
+    my $zip_file_path = &util::filename_cat($web_inf_directory, "webxml" . $timestamp . ".zip");
+    my $java_args = "\"$zip_file_path\" \"$web_inf_directory\" \"$file\"";
+    my $java_command = "\"$java\" -classpath \"$java_classpath\" org.greenstone.gatherer.remote.ZipFiles $java_args"; 
+    my $java_output = `$java_command`;
+
+    my $java_status = $?;
+    if ($java_status > 0) {
+    $gsdl_cgi->generate_error("Java failed: $java_command\n--\n$java_output\nExit status: " . ($java_status / 256) . "\n" . $gsdl_cgi->check_java_home());
+    }
+
+    # Check that the zip file was created successfully
+    if (!-e $zip_file_path || -z $zip_file_path) {
+    $gsdl_cgi->generate_error("web.xml zip file $zip_file_path could not be created.");
+    }
+
+    &put_file($gsdl_cgi, $zip_file_path, "application/zip");
+
+    unlink("$zip_file_path") unless $debugging_enabled;
+}
 
 # Collection locking unnecessary because this action isn't related to a particular collection
 sub get_script_options
 {
-    my ($gsdl_cgi, $username, $timestamp) = @_;
+    my ($gsdl_cgi, $username, $timestamp, $site) = @_;
 
     my $script = $gsdl_cgi->clean_param("script");
@@ -614 +761 @@
 
     # Users can be in any group to perform this action
-    &authenticate_user($gsdl_cgi, $username, "");
+    &authenticate_user($gsdl_cgi, $username, "", $site);
+    $gsdl_cgi->delete("ts"); ## two lines from GS3 version, doesn't seem to harm GS2
+    $gsdl_cgi->delete("pw"); 
+    
 
     my $perl_args = "";
@@ -637 +787 @@
     }
 
-    print STDOUT "Content-type:text/plain\n\n";
-
-    my $perl_command = "perl -S $script $perl_args 2>&1";
 
     # IIS 6: redirecting output from STDERR to STDOUT just doesn't work, so we have to let it go
     #   directly out to the page
-    if ($iis6_mode)
+    print STDOUT "Content-type:text/plain\n\n";
+    my $perl_command;
+    if($iis6_mode && $gsdl_cgi->greenstone_version() == 2)
     {
     $perl_command = "perl -S $script $perl_args";
+    } else {
+    $perl_command = "perl -S $script $perl_args 2>&1";
     }
 
@@ -660 +811 @@
 }
 
+# get the names of all sites available on the server
+sub get_site_names
+{
+    my ($gsdl_cgi, $username, $timestamp, $site) = @_;
+    my $sites_directory = &util::filename_cat($ENV{'GSDL3SRCHOME'}, "web", "sites");
+
+    my @sites_dir;
+    my @site_dir;
+    
+    $gsdl_cgi->checked_chdir($sites_directory);
+    opendir(DIR, $sites_directory);
+    @sites_dir= readdir(DIR);
+    my $sites_dir;
+    my $sub_dir_file;
+
+    print STDOUT "Content-type:text/plain\n\n";
+    foreach $sites_dir(@sites_dir)
+    {
+    if (!(($sites_dir eq ".") || ($sites_dir eq "..") || ($sites_dir eq "CVS")))
+    {
+        my $site_dir_path= &util::filename_cat($sites_directory,$sites_dir);
+        $gsdl_cgi->checked_chdir($site_dir_path);
+        opendir(DIR,$site_dir_path);
+        @site_dir=readdir(DIR);
+        closedir(DIR);
+        
+        foreach $sub_dir_file(@site_dir)
+        {
+        if ($sub_dir_file eq "siteConfig.xml"){
+            print STDOUT "$sites_dir" . "-----";
+        }
+        }
+    }
+    }
+
+}
 
 sub move_collection_file
 {
-    my ($gsdl_cgi, $username, $timestamp) = @_;
+    my ($gsdl_cgi, $username, $timestamp, $site) = @_;
 
     my $collection = $gsdl_cgi->clean_param("c");
@@ -681 +868 @@
 
     # Make sure we don't try to move anything outside the collection
-    if ($source_file =~ /\.\./ || $target_file =~ /\.\./) {
+    if ($source_file =~ m/\.\./ || $target_file =~ m/\.\./) {
     $gsdl_cgi->generate_error("Illegal file specified.");
     }
 
     # Ensure the user is allowed to edit this collection
-    &authenticate_user($gsdl_cgi, $username, $collection);
-
-    my $gsdlhome = $ENV{'GSDLHOME'};
-    my $collection_directory = &util::filename_cat($gsdlhome, "collect", $collection);
+    &authenticate_user($gsdl_cgi, $username, $collection, $site);
+
+    my $collection_directory = $gsdl_cgi->get_collection_dir($site, $collection);
     $gsdl_cgi->checked_chdir($collection_directory);
 
@@ -698 +884 @@
 
     # Make sure the collection isn't locked by someone else
-    &lock_collection($gsdl_cgi, $username, $collection);
+    &lock_collection($gsdl_cgi, $username, $collection, $site);
 
     &util::mv($source_file, $target_file);
@@ -704 +890 @@
     # Check that the collection source file was moved
     if (-e $source_file || !-e $target_file) {
-    $gsdl_cgi->generate_error("Could not move collection file $source_file to $target_file.");
+    $gsdl_cgi->generate_error("Could not move collection file $source_file to $target_file."); # dies
     }
 
@@ -713 +899 @@
 sub new_collection_directory
 {
-    my ($gsdl_cgi, $username, $timestamp) = @_;
+    my ($gsdl_cgi, $username, $timestamp, $site) = @_;
 
     my $collection = $gsdl_cgi->clean_param("c");
@@ -726 +912 @@
 
     # Make sure we don't try to create anything outside the collection
-    if ($directory =~ /\.\./) {
+    if ($directory =~ m/\.\./) {
     $gsdl_cgi->generate_error("Illegal directory specified.");
     }
 
     # Ensure the user is allowed to edit this collection
-    &authenticate_user($gsdl_cgi, $username, $collection);
-
-    my $gsdlhome = $ENV{'GSDLHOME'};
-    my $collection_directory = &util::filename_cat($gsdlhome, "collect", $collection);
+    &authenticate_user($gsdl_cgi, $username, $collection, $site);
+
+    my $collection_directory = $gsdl_cgi->get_collection_dir($site, $collection);
     $gsdl_cgi->checked_chdir($collection_directory);
 
     # Check that the collection directory doesn't already exist
-    # ZipTools doesn't zip up empty directories, so this causes an error when downloading a new collection as we explicity
+    # ZipTools doesn't zip up empty directories, so this causes an error when downloading a new collection as we explicitly
     # try to create the import directory
-#    if (-d $directory) {
-#   $gsdl_cgi->generate_error("Collection directory $directory already exists.");
-#    }
+## log -r13497 for GS2's gliserver.pl, Katherine Don explains:
+# "commented out checking for existence of a directory in new_collection_directory 
+# as it throws an error which we don't want"
+    #if($gsdl_cgi->greenstone_version() != 2 && -d $directory) {
+    #$gsdl_cgi->generate_error("Collection directory $directory already exists.");
+    #}
 
     # Make sure the collection isn't locked by someone else
-    &lock_collection($gsdl_cgi, $username, $collection);
+    &lock_collection($gsdl_cgi, $username, $collection, $site);
 
     &util::mk_dir($directory);
@@ -760 +948 @@
 sub run_script
 {
-    my ($gsdl_cgi, $username, $timestamp) = @_;
+    my ($gsdl_cgi, $username, $timestamp, $site) = @_;
 
     my $script = $gsdl_cgi->clean_param("script");
@@ -767 +955 @@
     }
     $gsdl_cgi->delete("script");
+ 
     my $collection = $gsdl_cgi->clean_param("c");
     if ((!defined $collection) || ($collection =~ m/^\s*$/)) {
@@ -773 +962 @@
     $gsdl_cgi->delete("c");
 
+    # confuse other, so delete timestamp
+    $gsdl_cgi->delete("ts");
+
     # Ensure the user is allowed to edit this collection
-    &authenticate_user($gsdl_cgi, $username, $collection);
+    &authenticate_user($gsdl_cgi, $username, $collection, $site);
 
     # Make sure the collection isn't locked by someone else (unless we're running mkcol.pl, of course)
-    &lock_collection($gsdl_cgi, $username, $collection) unless ($script eq "mkcol.pl");
+    &lock_collection($gsdl_cgi, $username, $collection, $site) unless ($script eq "mkcol.pl");
 
     # Last argument is the collection name, except for explode_metadata_database.pl and
@@ -783 +975 @@
     my $perl_args = $collection;
     if ($script eq "explode_metadata_database.pl" || $script eq "replace_srcdoc_with_html.pl") {
-    # Last argument is the file to be exploded
+    # Last argument is the file to be exploded or it is the file to be replaced with its html version
     my $file = $gsdl_cgi->clean_param("file");
     if ((!defined $file) || ($file =~ m/^\s*$/)) {
@@ -789 +981 @@
     }
     $gsdl_cgi->delete("file");
-    $file =~ s/ /\\ /g; # escape all spaces in filename with a backslash, i.e. "\ ".
-    $perl_args = $file; 
+    #$file =~ s/ /\\ /g; # Works on linux: escape all spaces in filename with a backslash, i.e. "\ ".
+    $file = "\"$file\""; # Windows: bookend the relative filepath with quotes in case it contains spaces 
+    $perl_args = $file;
     }
 
@@ -803 +996 @@
     }
 
-    print STDOUT "Content-type:text/plain\n\n";
+    # mkcol.pl and import.pl, buildcol.pl, g2f-import.pl, g2f-buildcol.pl all need the -collectdir option passed
+    my $import_pl = "import.pl"; # import is a reserved word, need to put it in quotes
+    
+    if (($script =~ m/$import_pl|buildcol.pl/) || ($script eq "mkcol.pl")) { # || ($script eq "schedule.pl")
+    my $collect_directory = $gsdl_cgi->get_collection_dir($site); 
+    $perl_args = $perl_args . " -collectdir \"$collect_directory\"";
+    }
 
     my $perl_command = "perl -S $script $perl_args 2>&1";
-
     # IIS 6: redirecting output from STDERR to STDOUT just doesn't work, so we have to let it go
     #   directly out to the page
-    if ($iis6_mode)
+    if($gsdl_cgi->greenstone_version() == 2 && $iis6_mode)
     {
     $perl_command = "perl -S $script $perl_args";
     }
-
     if (!open(PIN, "$perl_command |")) {
     $gsdl_cgi->generate_error("Unable to execute command: $perl_command");
     }
+
+    print STDOUT "Content-type:text/plain\n\n";
+    print "$perl_command  \n";
 
     while (defined (my $perl_output_line = <PIN>)) {
@@ -834 +1034 @@
 }
 
-
 sub upload_collection_file
 {
-    my ($gsdl_cgi, $username, $timestamp) = @_;
-
+    my ($gsdl_cgi, $username, $timestamp, $site) = @_;
+   
     my $collection = $gsdl_cgi->clean_param("c");
     if ((!defined $collection) || ($collection =~ m/^\s*$/)) {
@@ -852 +1051 @@
 
     # Make sure we don't try to upload anything outside the collection
-    if ($file =~ /\.\./) {
+    if ($file =~ m/\.\./) {
     $gsdl_cgi->generate_error("Illegal file specified.");
     }
-    if ($directory =~ /\.\./) {
+    if ($directory =~ m/\.\./) {
     $gsdl_cgi->generate_error("Illegal directory specified.");
     }
 
     # Ensure the user is allowed to edit this collection
-    &authenticate_user($gsdl_cgi, $username, $collection);
-
-    my $gsdlhome = $ENV{'GSDLHOME'};
-    my $collection_directory = &util::filename_cat($gsdlhome, "collect", $collection);
+    if($gsdl_cgi->greenstone_version() == 2) { ## Quan commented this out for GS3 in r14325
+    &authenticate_user($gsdl_cgi, $username, $collection, $site); # site will be undefined for GS2, of course
+    }
+
+    my $collection_directory = $gsdl_cgi->get_collection_dir($site, $collection);
     $gsdl_cgi->checked_chdir($collection_directory);
 
     # Make sure the collection isn't locked by someone else
-    &lock_collection($gsdl_cgi, $username, $collection);
+    &lock_collection($gsdl_cgi, $username, $collection, $site);
 
     my $directory_path = &util::filename_cat($collection_directory, $directory);
@@ -877 +1077 @@
     }
 
-    my $file_path = &util::filename_cat($directory_path, $file . "-" . $timestamp);
+    #my $file_path = &util::filename_cat($directory_path, $file . "-" . $timestamp); 
+    my $file_path = "";
+    if($gsdl_cgi->greenstone_version() == 2) {
+    $file_path = &util::filename_cat($directory_path, $file . "-" . $timestamp); 
+    } else {
+    $file_path = &util::filename_cat($directory_path, $file); 
+    }
+   
     if (!open(FOUT, ">$file_path")) {
+    print STDERR "Unable to write file $file_path\n";
     $gsdl_cgi->generate_error("Unable to write file $file_path");
     }
 
     # Read the uploaded data and write it out to file
-    # We have to pass the size of the uploaded data in the "fs" argument because IIS 6 seems to be
-    #   completely incapable of working this out otherwise (causing the old code to crash)
     my $buf;
     my $num_bytes = 0;
-    my $num_bytes_remaining = $gsdl_cgi->clean_param("fs");
-    my $bytes_to_read = $num_bytes_remaining;
-    if ($bytes_to_read > 1024) { $bytes_to_read = 1024; }
     binmode(FOUT);
-    while (read(STDIN, $buf, $bytes_to_read) > 0) {
-    print FOUT $buf;
-    $num_bytes += length($buf);
-    $num_bytes_remaining -= length($buf);
-    $bytes_to_read = $num_bytes_remaining;
+    if($gsdl_cgi->greenstone_version() == 2) { ##
+    # We have to pass the size of the uploaded data in the "fs" argument because IIS 6 seems to be
+    #   completely incapable of working this out otherwise (causing the old code to crash)
+    my $num_bytes_remaining = $gsdl_cgi->clean_param("fs");
+    my $bytes_to_read = $num_bytes_remaining;
     if ($bytes_to_read > 1024) { $bytes_to_read = 1024; }
+
+    while (read(STDIN, $buf, $bytes_to_read) > 0) {
+        print FOUT $buf;
+        $num_bytes += length($buf);
+        $num_bytes_remaining -= length($buf);
+        $bytes_to_read = $num_bytes_remaining;
+        if ($bytes_to_read > 1024) { $bytes_to_read = 1024; }
+    }
+    } else { # GS3 and later
+        my $bread;
+    my $fh = $gsdl_cgi->clean_param("uploaded_file");
+
+    if (!defined $fh) {
+        print STDERR "ERROR. Filehandle undefined. No file uploaded onto GS3 server.\n";
+        $gsdl_cgi->generate_error("ERROR. Filehandle undefined. No file uploaded (GS3 server).");
+    } else {
+        while ($bread=read($fh, $buf, 1024)) {
+        print FOUT $buf;
+        }
+    }
     }
     close(FOUT);
-
+       
     # If we have downloaded a zip file, unzip it
     if (defined $zip) {
     my $java = $gsdl_cgi->get_java_path();
-    my $java_classpath = &util::filename_cat($gsdlhome, "bin", "java", "GLIServer.jar");
+    my $java_classpath = &util::filename_cat($ENV{'GSDLHOME'}, "bin", "java", "GLIServer.jar");
     my $java_args = "\"$file_path\" \"$directory_path\"";
-    my $java_command = "$java -classpath \"$java_classpath\" org.greenstone.gatherer.remote.Unzip $java_args"; 
+    my $java_command = "\"$java\" -classpath \"$java_classpath\" org.greenstone.gatherer.remote.Unzip $java_args"; 
 
     my $java_output = `$java_command`;
@@ -911 +1134 @@
 
     # Remove the zip file once we have unzipped it, since it is an intermediate file only
-    unlink("$file_path");
-
+    unlink("$file_path") unless $debugging_enabled;
+    
     if ($java_status > 0) {
-        $gsdl_cgi->generate_error("Java failed: $java_command\n--\n$java_output\nExit status: " . ($java_status / 256) . "\n" . $gsdl_cgi->check_java_home());
+        $gsdl_cgi->generate_error("Java failed: $java_command\n--\n$java_output\nExit status: " . ($java_status / 256) . "\n" . $gsdl_cgi->check_java_home()); # dies
     }
     }
@@ -920 +1143 @@
     $gsdl_cgi->generate_ok_message("Collection file $file uploaded successfully.");
 }
-
 
 sub put_file
@@ -928 +1150 @@
     my $content_type = shift(@_);
 
+    if(!defined $content_type) { ##
+    $content_type = "application/zip";
+    }
+    
     if (open(PIN, "<$file_path")) {
-    print STDOUT "Content-type:$content_type\n\n";
-
+    print STDOUT "Content-type:$content_type\n\n"; ## For GS3: "Content-type:application/zip\n\n";
     my $buf;
     my $num_bytes = 0;
@@ -966 +1191 @@
 }
 
+sub greenstone_server_version
+{   
+    my $gsdl_cgi = shift(@_);
+    my $version = $gsdl_cgi->greenstone_version();
+    $gsdl_cgi->generate_ok_message("Greenstone server version is: $version\n");
+}
+
+sub get_library_url_suffix
+{
+    my $gsdl_cgi = shift(@_);
+    my $library_url = $gsdl_cgi->library_url_suffix();
+    $gsdl_cgi->generate_ok_message("Greenstone library URL suffix is: $library_url\n");
+}
 
 &main();

gsdl/trunk/cgi-bin/gsdlCGI.pm

@@ -1 @@
-
 package gsdlCGI;
 
-
+# This file merges Michael Dewsnip's gsdlCGI.pm for GS2 and Quan Qiu's gsdlCGI4gs3.pm (GS3)
+
+use strict; 
+no strict 'subs';
+no strict 'refs'; # allow filehandles to be variables and viceversa
 
 use CGI;
 use Cwd;
 
-@ISA = ('CGI');
+@gsdlCGI::ISA = ( 'CGI' ); 
 
 sub new {
     my $class = shift @_;
-
+    
     my $self;
+   
+    # We'll determine the correct config file in this constructor itself 
+    # and use it to determine the Greenstone server's version. 
+    # Perhaps later, another test can be used for finding out what version 
+    # of the Greenstone server we are working with.
+    my $version;
+    if (-e "gsdl3site.cfg") {
+    $version = 3;
+    } else {
+    $version = 2;
+    }
+
     if ((defined $ENV{'REQUEST_METHOD'}) && ($ENV{'REQUEST_METHOD'} eq "POST")) {
-    my $line = <STDIN>;
-    if ((defined $line) && ($line ne "")) {
-        $self = new CGI($line);
-    }
-    else {
-        $self = new CGI();
-    }
-    }
-    else {
+
+    # Check if we're dealing with the upload-coll-file cmd. Because it will be a 
+    # multipart POST message and must be dealt with by the default CGI() constructor
+    if((defined $ENV{'QUERY_STRING'}) && ($ENV{'QUERY_STRING'} =~ m/upload-collection-file/)) {
+        $self = new CGI(); 
+    } 
+
+    else { # all other POST commands processed using CGI($line)
+        my $line = <STDIN>;
+        if ((defined $line) && ($line ne "")) { 
+        $self = new CGI($line);
+        }
+    }
+    
+    }    
+    
+    # If one of the conditions above did not hold, then self=new CGI() 
+    if (!defined $self) { 
     $self = new CGI();
     }
 
+    if ($version == 2) {
+    $self->{'site_filename'} = "gsdlsite.cfg";
+    $self->{'greenstone_version'} = 2;
+    } 
+    elsif ($version == 3) {
+    $self->{'site_filename'} = "gsdl3site.cfg";
+    $self->{'greenstone_version'} = 3;
+    }
+    
     return bless $self, $class;
 }
@@ -73 +106 @@
 }
 
+sub generate_message
+{
+    my $self = shift @_;
+    my ($message) = @_;
+    
+    #if($self->{'greenstone_version'} == 2) { # plain text, for IIS 6
+    print STDOUT "Content-type:text/plain\n\n$message";
+    #} else {
+    #print "Content-type:text/html\n\n";
+    #print "<pre>";
+    #print STDOUT $message;
+    #print "</pre>";
+    #}
+}
 
 sub generate_error
@@ -98 +145 @@
     }
 
-    print STDOUT "Content-type:text/plain\n\n";
-    print STDOUT $full_mess;
-
-    exit 0;
+    $self->generate_message($full_mess);
+
+    die $full_mess;
 }
 
@@ -128 +174 @@
     }
 
-    print STDOUT "Content-type:text/plain\n\n";
-    print STDOUT $full_mess;
+    $self->generate_message($full_mess);
 
     print STDERR $full_mess;
@@ -152 +197 @@
     $full_mess = "$mess\n";
     }
-
-    print STDOUT "Content-type:text/plain\n\n";
-    print STDOUT $full_mess;
+ 
+    $self->generate_message($full_mess);
 }
 
@@ -161 +205 @@
 sub get_config_info {
     my $self = shift @_;
-    my ($infotype) = @_;
-
-    my $site_filename = "gsdlsite.cfg";
+    my ($infotype, $optional) = @_;
+
+    my $site_filename = $self->{'site_filename'};
     open (FILEIN, "<$site_filename") 
-    || $self->generate_error("Could not open gsdlsite.cfg");
+    || $self->generate_error("Could not open $site_filename");
 
     my $config_content = "";
@@ -174 +218 @@
 
     my ($loc) = ($config_content =~ m/^$infotype\s+((\".+\")|(\S+))\s*\n/m);
-    $loc =~ s/\"//g;
+    $loc =~ s/\"//g if defined $loc;
 
     if ((!defined $loc) || ($loc =~ m/^\s*$/)) {
-    $self->generate_error("$infotype is not set in gsdlsite.cfg");
+    if((!defined $optional) || (!$optional)) {
+        $self->generate_error("$infotype is not set in $site_filename");
+    }
     }
 
     return $loc;
+}
+
+sub get_gsdl3_src_home{
+    my $self = shift @_;
+    if (defined $self->{'gsdl3srchome'}) {
+    return $self->{'gsdl3srchome'};
+    }
+
+    my $gsdl3srchome = $self->get_config_info("gsdl3srchome");
+
+    if(defined $gsdl3srchome) {
+    $gsdl3srchome =~ s/(\/|\\)$//; # remove trailing slash
+    }
+    $self->{'gsdl3srchome'} = $gsdl3srchome;
+
+    return $gsdl3srchome;
 }
 
@@ -200 +262 @@
 }
 
+sub get_gsdl3_home {
+    my $self = shift @_;
+    my ($optional) = @_;
+    
+    if (defined $self->{'gsdl3home'}) {
+    return $self->{'gsdl3home'};
+    }
+
+    my $gsdl3home = $self->get_config_info("gsdl3home", $optional);
+
+    if(defined $gsdl3home) {
+    $gsdl3home =~ s/(\/|\\)$//; # remove trailing slash
+    $self->{'gsdl3home'} = $gsdl3home;
+    }
+    return $gsdl3home;
+}
+
+sub get_java_home {
+    my $self = shift @_;
+    my ($optional) = @_;
+    
+    if (defined $self->{'javahome'}) {
+    return $self->{'javahome'};
+    }
+
+    my $javahome = $self->get_config_info("javahome", $optional);
+    if(defined $javahome) {
+    $javahome =~ s/(\/|\\)$//; # remove trailing slash
+    $self->{'javahome'} = $javahome;
+    }
+    return $javahome;
+}
+
+sub get_perl_path {
+    my $self = shift @_;
+    
+    if (defined $self->{'perlpath'}) {
+    return $self->{'perlpath'};
+    }
+
+    my $perlpath = $self->get_config_info("perlpath");
+
+    if(defined $perlpath) {
+    $perlpath =~ s/(\/|\\)$//; # remove trailing slash
+    $self->{'perlpath'} = $perlpath;
+    }
+    return $perlpath;
+}
+
 sub get_gsdl_os {
     my $self = shift @_;
@@ -208 +319 @@
     return "linux";
     }
-    elsif ($os =~ /mswin/i) {
+    elsif ($os =~ m/mswin/i) {
     return "windows";
     }
-    elsif ($os =~ /macos/i) {
+    elsif ($os =~ m/macos/i) {
     return "darwin";
     }
@@ -220 +331 @@
 }
 
+sub get_library_url_suffix {
+    my $self = shift @_;
+    
+    if (defined $self->{'library_url_suffix'}) {
+    return $self->{'library_url_suffix'};
+    }
+
+    my $optional = 1; # ignore absence of gwcgi if not found
+    my $library_url = $self->get_config_info("gwcgi", $optional);
+    if(defined $library_url) {
+    $library_url =~ s/(\/|\\)$//; # remove trailing slash
+    }
+    else {
+
+    if($self->{'greenstone_version'} == 2) {
+        $library_url = $self->get_config_info("httpprefix");
+        $library_url = "$library_url/cgi-bin/library";
+
+        my $gsdlos = (defined $ENV{'GSDLOS'}) ? $ENV{'GSDLOS'} : $self->get_gsdl_os();
+        if($gsdlos =~ m/windows/) { # remote GS2 server on Windows uses "library.exe"
+        $library_url .= ".exe";
+        }
+    } 
+    else { # greenstone 3 or later and gwcgi not defined
+        $library_url = "/greenstone3"; #"/greenstone3/library";
+    }
+    }
+
+    $self->{'library_url_suffix'} = $library_url;
+    return $library_url;
+}
+
+sub setup_fedora_homes {
+    my $self = shift @_;
+    my ($optional) = @_;
+
+    # The following will still allow the FEDORA_HOME and FEDORA_VERSION environment 
+    # variables to have been set outside the gsdlsite.cfg file. Existing env vars 
+    # are only overwritten if they've *also* been defined in gsdlsite.cfg.
+
+    if (!defined $self->{'fedora_home'}) # Don't need to go through it all again if we'd already done this before
+    {
+    # First look in the gsdlsite.cfg file for the fedora properties to be defined
+    # and set $ENV{FEDORA_HOME} and $ENV{FEDORA_VERSION} if values were provided
+    $self->{'fedora_home'} = $self->get_config_info("fedorahome", $optional);
+    
+    if (defined $self->{'fedora_home'}) {
+        $ENV{'FEDORA_HOME'} = $self->{'fedora_home'}; 
+    } 
+    elsif (defined $ENV{'FEDORA_HOME'}) { # check environment variable
+        $self->{'fedora_home'} = $ENV{'FEDORA_HOME'};
+    }
+    
+    # if FEDORA_HOME is now defined, we can look for the fedora version that is being used
+    if (defined $ENV{'FEDORA_HOME'}) 
+    {
+        # first look in the file
+        $self->{'fedora_version'} = $self->get_config_info("fedoraversion", $optional);
+
+        if (defined $self->{'fedora_version'}) {
+        $ENV{'FEDORA_VERSION'} = $self->{'fedora_version'};
+        } 
+        elsif (defined $ENV{'FEDORA_VERSION'}) { # then check environment variable
+        $self->{'fedora_version'} = $ENV{'FEDORA_VERSION'};
+        } 
+        else { # finally, default to version 3 and warn the user
+        $ENV{'FEDORA_VERSION'} = "3";
+        $self->{'fedora_version'} = $ENV{'FEDORA_VERSION'};
+        #$self->generate_ok_message("FEDORA_HOME is set, but not FEDORA_VERSION, defaulted to: 3.");
+        }
+    }
+    }
+}
+
 sub setup_gsdl {
     my $self = shift @_;
+    my $optional = 1; # ignore absence of specified properties in gsdl(3)site.cfg if not found
 
     my $gsdlhome = $self->get_gsdl_home();
     my $gsdlos = $self->get_gsdl_os();
-
     $ENV{'GSDLHOME'} = $gsdlhome;
     $ENV{'GSDLOS'} = $gsdlos;
 
+    my $library_url = $self->get_library_url_suffix(); # best to have GSDLOS set beforehand
+    $self->{'library_url_suffix'} = $library_url;
+
     require "$gsdlhome/perllib/util.pm";
 
+    if($self->{'greenstone_version'} == 3) {
+    my $gsdl3srchome = $self->get_gsdl3_src_home();
+    $ENV{'GSDL3SRCHOME'} = $gsdl3srchome;
+
+    my $gsdl3home = $self->get_gsdl3_home($optional);
+    # if a specific location for GS3's web folder is not provided,
+    # assume the GS3 web folder is in the default location
+    if(!defined $gsdl3home) { 
+        $gsdl3home = &util::filename_cat($ENV{'GSDL3SRCHOME'}, "web");
+        $self->{'gsdl3home'} = $gsdl3home;
+    } 
+    $ENV{'GSDL3HOME'} = $gsdl3home;
+    } 
+   
+    
     my $gsdl_bin_script = &util::filename_cat($gsdlhome,"bin","script");
     &util::envvar_append("PATH",$gsdl_bin_script);
-
+    
     my $gsdl_bin_os = &util::filename_cat($gsdlhome,"bin",$gsdlos);
     &util::envvar_append("PATH",$gsdl_bin_os);
-
+    
+    # Perl comes installed with the GS Windows Release Kit. 
+    # However, if GS is from SVN, the user must have their own Perl and put it on the path.
+    my $perl_bin_dir; # undefined
     if ($gsdlos eq "windows") {
-    my $gsdl_perl_bin_directory = &util::filename_cat($gsdlhome, "bin", "windows", "perl", "bin");
-    &util::envvar_append("PATH", $gsdl_perl_bin_directory);
-    }
-}
-
+    $perl_bin_dir = &util::filename_cat($gsdlhome, "bin", "windows", "perl", "bin");
+    if(-e $perl_bin_dir) {
+        &util::envvar_append("PATH", $perl_bin_dir);
+    }
+    }
+
+    # Uncomment these lines if you want to read the "perlpath" property from
+    # the gsdl(3)site.cfg config file into PATH
+    #if(!defined $perl_bin_dir) {
+    #$perl_bin_dir = $self->get_perl_path();
+    #&util::envvar_append("PATH", $perl_bin_dir);
+    #}
+    
+    # gsdl(3)site.cfg can specify JAVA_HOME and FEDORA_HOME along with Fedora's version. Both
+    # are needed (by scripts g2f-import and g2f-buildcol) when using Greenstone 2 with Fedora.
+    if(!defined $ENV{'JAVA_HOME'}) {
+    $ENV{'JAVA_HOME'} = $self->get_java_home($optional);
+    }
+
+    $self->setup_fedora_homes($optional);
+}
+
+sub greenstone_version {
+    my $self = shift @_;
+    return $self->{'greenstone_version'};
+}
+
+sub library_url_suffix {
+    my $self = shift @_;
+    return $self->{'library_url_suffix'};
+}
+
+# Only useful to call this after calling setup_gsdl, as it uses some environment variables
+# Returns the Greenstone collect directory, or a specific collection directory inside collect
+sub get_collection_dir {
+    my $self = shift @_;
+    my ($site, $collection) = @_; # both may be undefined
+
+    require "$ENV{'GSDLHOME'}/perllib/util.pm";
+    my $collection_directory;
+    if($self->{'greenstone_version'} == 2 && defined $ENV{'GSDLHOME'}) {
+    if(defined $collection) {
+        $collection_directory = &util::filename_cat($ENV{'GSDLHOME'}, "collect", $collection);
+    } else {
+        $collection_directory = &util::filename_cat($ENV{'GSDLHOME'}, "collect");
+    }
+    }
+    elsif($self->{'greenstone_version'} == 3 && defined $ENV{'GSDL3SRCHOME'}) {
+    if(defined $collection) {
+        $collection_directory = &util::filename_cat($ENV{'GSDL3SRCHOME'}, "web", "sites", $site, "collect", $collection);
+    } else {
+        $collection_directory = &util::filename_cat($ENV{'GSDL3SRCHOME'}, "web", "sites", $site, "collect");
+    }
+    }
+}
 
 sub local_rm_r
@@ -250 +506 @@
 
     my $prefix_dir = getcwd(); 
-
+    my $full_path = &util::filename_cat($prefix_dir,$local_dir);
+    
     if ($prefix_dir !~ m/collect/) {
-    $self->generate_error("Trying to delete outside of Greenstone collect: $full_dir");
-    }
-
-    my $full_dir = &util::filename_cat($prefix_dir,$local_dir);
+    $self->generate_error("Trying to delete outside of Greenstone collect: $full_path");
+    }
 
     # Delete recursively
-    if (!-e $full_dir) {
-    $self->generate_error("File/Directory does not exist: $full_dir");
-    }
-
-    &util::rm_r($full_dir);
+    if (!-e $full_path) {
+    $self->generate_error("File/Directory does not exist: $full_path");
+    }
+
+    &util::rm_r($full_path);
 }
 
@@ -282 +537 @@
 sub check_java_home()
 {
-    # Return a warning unless the JAVA_HOME enrivonmen variable is set
+    # Return a warning unless the JAVA_HOME environment variable is set
     if (!defined $ENV{'JAVA_HOME'}) {
     return "JAVA_HOME environment variable not set. Might not be able to find Java unless in PATH (" . $ENV{'PATH'} . ")";
@@ -304 +559 @@
 }
 
+sub rot13()
+{
+    my $self = shift @_;
+    my ($password)=@_;
+    my @password_arr=split(//,$password);
+    
+    my @encrypt_password;
+    foreach my $str (@password_arr){
+    my $char=unpack("c",$str);
+    if ($char>=97 && $char<=109){
+        $char+=13;
+    }elsif ($char>=110 && $char<=122){
+        $char-=13;
+    }elsif ($char>=65 && $char<=77){
+        $char+=13;
+    }elsif ($char>=78 && $char<=90){
+        $char-=13;
+    }
+    $char=pack("c",$char);
+    push(@encrypt_password,$char);
+    }
+    return join("",@encrypt_password);
+}
+
+sub encrypt_password
+{
+    my $self = shift @_;
+    
+    if (defined $self->param("pw")) { ##
+    if ($self->{'greenstone_version'} == 3) { # GS3 is in Java, so needs different encryption
+        $self->param('-name' => "pw", '-value' => $self->rot13($self->clean_param("pw")));
+    }
+    else { # GS2 (and versions of GS other than 3?)
+        #require "$self->{'gsdlhome'}/perllib/util.pm";  # This is OK on Windows
+        require "$self->{'gsdlhome'}/perllib/cpan/Crypt/UnixCrypt.pm";  # This is OK on Windows
+        $self->param('-name' => "pw", '-value' => &Crypt::UnixCrypt::crypt($self->clean_param("pw"), "Tp"));
+    }
+    } 
+}
+
 1;
 

gsdl/trunk/cgi-bin/gsdlsite.cfg

@@ -4 +4 @@
 
 # points to the GSDLHOME directory
-gsdlhome    **GSDLHOME**
+gsdlhome    "/research/ak19/gs2PerlUpdates"
 
 # this is the http address of GSDLHOME
 # if your webservers DocumentRoot is set to $GSDLHOME
 # then httpprefix can remain commented out
-#httpprefix  /gsdl
+httpprefix  /gs2perl
 
 # this is the http address of the directory which
@@ -15 +15 @@
 # if your webservers DocumentRoot is set to $GSDLHOME
 # then httpimg will be /images
-httpimg     /images
+httpimg     /gs2perl/images
 
 # should contain the http address of this cgi script. This 
@@ -29 +29 @@
 maxrequests 10000
 
-# If you wish to use Fedora with Greenstone2's GLI Server, then
-# you need to set the full paths to JAVA_HOME and FEDORA_HOME 
-# here as well as the major version of fedora
-#javahome /full/path/to/j2sdk1.4.2_13
-#fedorahome /full/path/to/fedora
-#fedoraversion 3
+# JAVA_HOME and FEDORA_HOME need to be set when using Greenstone 2
+# with Fedora.
+# full path to javahome
+javahome /opt/jdk1.5.0_10/
+
+# full path to FEDORA_HOME and the major version number of the
+# fedora installation
+fedorahome /research/ak19/fedora
+fedoraversion 2