Changeset 5000

Timestamp:

2003-07-22T13:23:35+12:00 (21 years ago)

Author:

jmt12

Message:

GLI will now accept arguments with spaces in them. Plus connecting to local library will now timeout.

File:

• trunk/gli/src/org/greenstone/gatherer/Gatherer.java (modified) (15 diffs)

trunk/gli/src/org/greenstone/gatherer/Gatherer.java

@@ -1 @@
-package org.greenstone.gatherer;
 /**
  *#########################################################################
@@ -7 +6 @@
  * University of Waikato, New Zealand.
  *
- * <BR><BR>
- *
  * Author: John Thompson, Greenstone Digital Library, University of Waikato
  *
- * <BR><BR>
- *
  * Copyright (C) 1999 New Zealand Digital Library Project
- *
- * <BR><BR>
  *
  * This program is free software; you can redistribute it and/or modify
@@ -22 +15 @@
  * (at your option) any later version.
  *
- * <BR><BR>
- *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
- *
- * <BR><BR>
  *
  * You should have received a copy of the GNU General Public License
@@ -36 +25 @@
  *########################################################################
  */
+package org.greenstone.gatherer;
+/**************************************************************************************
+ * Written:      ??/??/02
+ * Revised:      ??/??/02 - Commented
+ *               ??/??/03 - Added support for local library server
+ *               20/07/03 - Rewrote argument parsing so that spaces no longer cause GLI to die. Also added time out when starting local library.
+ **************************************************************************************/
+
 import com.l2fprod.gui.*;
 import com.l2fprod.gui.plaf.skin.*;
 import com.l2fprod.util.*;
-
 import java.awt.*;
+import java.awt.event.*;
 import java.io.*;
 import java.lang.*;
@@ -47 +44 @@
 import javax.swing.*;
 import javax.swing.plaf.*;
+import javax.swing.text.*;
 import org.greenstone.gatherer.Configuration;
 import org.greenstone.gatherer.GAuthenticator;
@@ -60 +58 @@
 import org.greenstone.gatherer.util.ArrayTools;
 import org.greenstone.gatherer.util.GSDLSiteConfig;
+import org.greenstone.gatherer.util.StaticStrings;
 import org.greenstone.gatherer.util.Utility;
 import sun.misc.*;
@@ -67 +66 @@
  */
 public class Gatherer {
+
+    static final private String SKIN_DEFINITION_FILE = "lib/greenaqua/greenaqua.xml";
+
     /** Has the exit flag been set? <i>true</i> if so, <i>false</i> otherwise. */
     public boolean exit = false;
@@ -105 +107 @@
     /** The name of the Gatherers configuration file. */
     static private String CONFIG_FILE_NAME = "gatherer.cfg";
+
+    /** Magic to allow Enter to fire the default button. */
+    static {
+      KeyStroke enter = KeyStroke.getKeyStroke(KeyEvent.VK_ENTER, 0);
+      Keymap map = JTextComponent.getKeymap(JTextComponent.DEFAULT_KEYMAP);
+      map.removeKeyStrokeBinding(enter);
+    }
+
+
+
     /** Constructor. Make the three main modules, c_man, f_man and g_man, and any other necessary classes such as Dictionary.
      * @param size The desired size of the Gatherer window as a <strong>Dimension</strong>.
@@ -134 +146 @@
 
     // This will hopefully catch ctrl-c and terminate, and exit gracefully. However it is platform specific, and may not be supported by some JVMs.
-    /** It does, but I get bloddy sick of it working when the Gatherer hangs.
+    /** It does, but I get bloody sick of it working when the Gatherer hangs.
         CTRLCHandler handler = new CTRLCHandler();
         Signal.handle(new Signal("INT"), handler);
@@ -405 +417 @@
     }
 
-    /** Some startup arguments to the Gatherer have been encoded, where ' ' is replaced with '%', in order to allow arguments containing spaces to be parsed correctly by the JVM, and this method restores these arguments to thier original state.
-     * @param encoded An encoded <strong>String</strong>.
-     * @return The decoded <strong>String</strong>.
-     */
-    static public String decode(String encoded) {
-    return encoded.replace('%', ' ');
-    }
     /** The entry point into the Gatherer. Parses arguments.
      * @param args A collection of arguments that may include: initial screen size, dictionary, path to the GSDL etc.
@@ -421 +426 @@
      * @see org.greenstone.gatherer.Gatherer
      * @see org.greenstone.gatherer.gui.Splash
+     * @see org.greenstone.gatherer.util.StaticStrings
      */
     static public void main(String[] args) {
@@ -439 +445 @@
     String perl_path = null;
     // Parse arguments
-    for(int i = 0; i < args.length; i++) {
-        if(args[i].equals("-gsdl")) {
-        gsdl_path = decode(args[i+1]);
-        if(!gsdl_path.endsWith(File.separator)) {
-            gsdl_path = gsdl_path + File.separator;
-        }
-        }
-        if(args[i].equals("-load")) {
-        filename = decode(args[i+1]);
-        }
-        else if(args[i].equals("-library") && (i + 1) < args.length) {
-        exec_path = args[i+1];
-        // If we are on a non-windows system, and thus the local server is unavailable, we can append http:// if no protocol found.
-        if(exec_path.lastIndexOf(":", 5) == -1) {
-            exec_path = "http://" + exec_path;
-        }
-        // If the user has given us an address, but it ends with a '/' we assume we're using the greenstone library.cgi
-        if(exec_path.startsWith("http://") && exec_path.endsWith("/")) {
-            exec_path = exec_path + "library";
-        }
-        }
-        else if(args[i].equals("-perl")) {
-        perl_path = decode(args[i+1]);
-        // Test whether this points to the Perl bin directory or the Perl executable itself.
-        File perl_file = new File(perl_path);
-        if(perl_file.isDirectory()) {
-            // If this is windows we create a child file perl.exe, otherwise we create perl
-            if(Utility.isWindows()) {
-            perl_file = new File(perl_file, Utility.PERL_EXECUTABLE_WINDOWS);
-            }
-            else {
-            perl_file = new File(perl_file, Utility.PERL_EXECUTABLE_UNIX);
-            }
-            // And store this new path.
-            perl_path = perl_file.getAbsolutePath();
-            perl_file = null;
-        }
-        // Otherwise its fine as it is
-        ///ystem.err.println("Perl executable is: " + perl_path);
-        }
-        else if(args[i].equals("--help") || args[i].equals("-help") || args[i].equals("?") || args[i].equals("/?") || args[i].equals("/help")) {
-        printUsage(dictionary);
-        System.exit(0);
-        }
-        else if(args[i].equals("--debug") || args[i].equals("-debug")) {
-        debug = true;
-        }
-                // Don't load any previous collection. Convenient for me
-        else if(args[i].equals("-no_load")) {
-        no_load = true;
-        }
-                // Check if they want it skinned.
-        else if(args[i].equals("-skinlf")) {
-        // SkinLF
-        try {
-            SkinLookAndFeel.setSkin(SkinLookAndFeel.loadThemePackDefinition(SkinUtils.toURL(new File("lib/greenaqua/greenaqua.xml"))));
-            SkinLookAndFeel.enable();
-        }
-        catch (Exception error) {
-            ///ystem.err.println("Error: " + error);
-            error.printStackTrace();
-        }
-        }
-    }
+    int argument_index = 0;
+    String next_token = null;
+    while(argument_index < args.length) {
+        // 1. We start by attempting to parse an argument name. An argument must start with a '-', and should not contain spaces. If anything else is encountered it is ignored.
+        String argument_name = null;
+        if(next_token == null) {
+            next_token = args[argument_index];
+            argument_index++;
+        }
+        if(next_token.startsWith(StaticStrings.MINUS_CHARACTER)) {
+            // Trim second '-' just to be kind to Unixy-type people
+            if(next_token.startsWith(StaticStrings.MINUS_CHARACTER + StaticStrings.MINUS_CHARACTER)) {
+                argument_name = next_token.substring(1);
+            }
+            else {
+                argument_name = next_token;
+            }
+        }
+        next_token = null;
+        // 2. If we now have an argument name we continue by attempting to parse a value. A value is taken to be the sequence of space seperated Strings between the last argument name and up to but not including the next argument name. Of course an argument needn't have any value (ie -debug, -help), in which case value will be null.
+        if(argument_name != null) {
+            String argument_value = null;
+            StringBuffer argument_value_buffer = new StringBuffer("");
+            while(argument_index < args.length && next_token == null) {
+                next_token = args[argument_index];
+                argument_index++;
+                // If we just parsed an arbitary String then append it to value, followed by a single space
+                if(!next_token.startsWith(StaticStrings.MINUS_CHARACTER)) {
+                    argument_value_buffer.append(next_token);
+                    argument_value_buffer.append(StaticStrings.SPACE_CHARACTER);
+                    next_token = null;
+                }
+                // If the argument token retrieved is an argument name, then leave it in next_token, which will cause the argument parsing process to move onto the next step.
+            }
+            // If a value now exists in argument buffer, retrieve it. Remove the last character as it will be an erroneous space.
+            if(argument_value_buffer.length() > 0) {
+                argument_value = argument_value_buffer.substring(0, argument_value_buffer.length() - 1);
+            }
+
+            // 3. We now have the argument name, and any associated value. We are ready to store the data in the appropriate variables.
+            Gatherer.println("Parsed Argument: name=" + argument_name + (argument_value != null ? (", value=" + argument_value) : ", no value"));
+            // 3a. First those arguments that have no associated value
+            if(argument_value == null) {
+                if(argument_name.equals(StaticStrings.HELP_ARGUMENT)) {
+                    printUsage(dictionary);
+                    System.exit(0);
+                }
+                // Run GLI in debug mode. Produces debug log plus extra messages.
+                else if(argument_name.equals(StaticStrings.DEBUG_ARGUMENT)) {
+                    debug = true;
+                }
+                // Forces no loading on previous collection.
+                else if(argument_name.equals(StaticStrings.NO_LOAD_ARGUMENT)) {
+                    no_load = true;
+                    filename = null;
+                }
+                // Specify the use of Greenstone LAF.
+                else if(argument_name.equals(StaticStrings.SKIN_ARGUMENT)) {
+                    // SkinLF
+                    try {
+                        SkinLookAndFeel.setSkin(SkinLookAndFeel.loadThemePackDefinition(SkinUtils.toURL(new File(SKIN_DEFINITION_FILE))));
+                        SkinLookAndFeel.enable();
+                    }
+                    catch (Exception error) {
+                        ///ystem.err.println("Error: " + error);
+                        error.printStackTrace();
+                    }
+                }
+            }
+            // 3b. Now for those that do
+            else {
+                // Parse the path to the GSDL. Required argument.
+                if(argument_name.equals(StaticStrings.GSDL_ARGUMENT)) {
+                    if(argument_value.endsWith(File.separator)) {
+                        gsdl_path = argument_value;
+                    }
+                    else {
+                        gsdl_path = argument_value + File.separator;
+                    }
+                }
+                // Specify a collection to load initially. Could be used for file associations.
+                else if(argument_name.equals(StaticStrings.LOAD_ARGUMENT)) {
+                    filename = argument_value;
+                    no_load = false;
+                }
+                // Parse the url to a running web server, or a file path to the local library server.
+                else if(argument_name.equals(StaticStrings.LIBRARY_ARGUMENT)) {
+                    exec_path = argument_value;
+                    // If there is no colon in first five characters of the exec_path (which would either be an existing protocol, or a windows file path to say a local library), we can append the protocol http://.
+                    if(argument_value.lastIndexOf(StaticStrings.COLON_CHARACTER, 5) == -1) {
+                        exec_path = StaticStrings.HTTP_PROTOCOL_STR + argument_value;
+                    }
+                    else {
+                        exec_path = argument_value;
+                    }
+                    // If the user has given us an address, but it ends with a '/' we assume we're using the greenstone library.cgi
+                    if(exec_path.startsWith(StaticStrings.HTTP_PROTOCOL_STR) && exec_path.endsWith(StaticStrings.URL_SEPARATOR_CHARACTER)) {
+                        exec_path = exec_path + StaticStrings.LIBRARY_STR;
+                    }
+                }
+                // Parse the path to PERL. If not provided its assumes perl should be availble on the PATH.
+                else if(argument_name.equals(StaticStrings.PERL_ARGUMENT)) {
+                    perl_path = argument_value;
+                    // Test whether this points to the Perl bin directory or the Perl executable itself.
+                    File perl_file = new File(perl_path);
+                    if(perl_file.isDirectory()) {
+                        // If this is windows we create a child file perl.exe, otherwise we create perl
+                        if(Utility.isWindows()) {
+                        perl_file = new File(perl_file, Utility.PERL_EXECUTABLE_WINDOWS);
+                        }
+                        else {
+                        perl_file = new File(perl_file, Utility.PERL_EXECUTABLE_UNIX);
+                        }
+                        // And store this new path.
+                        perl_path = perl_file.getAbsolutePath();
+                        perl_file = null;
+                    }
+                    // Otherwise its fine as it is
+                }
+            }
+        }
+        // Argument name was null, nothing to be done.
+    }
+    next_token = null;
+    // Arguments all parsed.
 
     // Splash screen.
@@ -509 +576 @@
     // We take appropriate action when an empty gsdl_path is detected.
     if(gsdl_path == null) {
-                // Check for the presence of the path.cfg file.
+        // Check for the presence of the path.cfg file.
         File path_file = new File("path.cfg");
         if(path_file.exists()) {
@@ -664 +731 @@
 
     private void startServerEXE() {
-    if(config.exec_file != null && config.exec_address == null && Utility.isWindows()) {
-        // First of all we create a GSDLSiteCFG object and check if a URL is already present, in which case the server is already running.
-        gsdlsite_cfg = new GSDLSiteConfig(config.exec_file);
-        String url = gsdlsite_cfg.getURL();
-        // If its already running then set exec address.
-        if(url != null) {
-        try {
-            config.exec_address = new URL(url);
-        }
-        catch(Exception error) {
-        }
-        }
-        // Otherwise its time to run the server in a spawned process.
-        if(config.exec_address == null && config.exec_file.exists()) {
-        // Configure for immediate entry. Note that this only works if the gsdlsite.cfg file exists.
-        gsdlsite_cfg.set();
-        // Spawn server
-        String[] command = new String[2];
-        command[0] = config.exec_file.getAbsolutePath();
-        command[1] = gsdlsite_cfg.getSiteConfigFilename();
-        server = new ExternalApplication(command);
-        server.start();
-        command = null;
-        // Now we have to wait until program has started. We do this by reloading and checking
-        try {
-            gsdlsite_cfg.load();
-            while((url = gsdlsite_cfg.getURL()) == null) {
-            synchronized(this) {
-                wait(1000);
+        if(config.exec_file != null && config.exec_address == null && Utility.isWindows()) {
+            // First of all we create a GSDLSiteCFG object and check if a URL is already present, in which case the server is already running.
+            gsdlsite_cfg = new GSDLSiteConfig(config.exec_file);
+            String url = gsdlsite_cfg.getURL();
+            // If its already running then set exec address.
+            if(url != null) {
+                try {
+                    config.exec_address = new URL(url);
+                }
+                catch(Exception error) {
+                }
+            }
+            // Otherwise its time to run the server in a spawned process.
+            if(config.exec_address == null && config.exec_file.exists()) {
+                // Configure for immediate entry. Note that this only works if the gsdlsite.cfg file exists.
+                gsdlsite_cfg.set();
+                // Spawn server
+                String[] command = new String[2];
+                command[0] = config.exec_file.getAbsolutePath();
+                command[1] = gsdlsite_cfg.getSiteConfigFilename();
+                server = new ExternalApplication(command);
+                server.start();
+                command = null;
+                // Now we have to wait until program has started. We do this by reloading and checking
+                ///ystem.err.print("Waiting until the local library has loaded");
+                try {
+                    gsdlsite_cfg.load();
+
+                    int try_again = JOptionPane.YES_OPTION;
+                    int attempt_count = 0;
+                    while(gsdlsite_cfg.getURL() == null && try_again == JOptionPane.YES_OPTION) {
+                        ///ystem.err.print(".");
+                        if(attempt_count == 60) {
+                            try_again = JOptionPane.showConfirmDialog(Gatherer.g_man, dictionary.get("Server.QuitTimeOut"), dictionary.get("General.Warning"), JOptionPane.YES_NO_OPTION);
+                        }
+                        else {
+                            synchronized(this) {
+                                wait(1000); // Wait one second (give or take)
+                            }
+                            gsdlsite_cfg.load();
+                            attempt_count++;
+                        }
+                    }
+
+                    if(gsdlsite_cfg.getURL() != null) {
+                        // Ta-da. Now the url should be available.
+                        config.exec_address = new URL(url);
+
+                        // A quick test involves opening a connection to get the home page  for this collection. If this fails then we try changing the url to be localhost.
+                        try {
+                            Gatherer.println("Try connecting to server on config url.");
+                            URLConnection connection = config.exec_address.openConnection();
+                            connection.getContent();
+                        }
+                        catch(IOException bad_url_connection) {
+                            try {
+                                Gatherer.println("Try connecting to server on local host.");
+                                config.exec_address = new URL(gsdlsite_cfg.getLocalHostURL  ());
+                                URLConnection connection = config.exec_address.openConnection();
+                                connection.getContent();
+                            }
+                            catch(IOException worse_url_connection) {
+                                Gatherer.println("Can't connect to server on either address.");
+                                config.exec_address = null;
+                                config.exec_file = null;
+                            }
+                        }
+                    }
+                    // Unable to start local library. Show appropriate message.
+                    else {
+                        missingEXEC(dictionary);
+                    }
+                }
+                catch (Exception error) {
+                    error.printStackTrace();
+                }
             }
-            gsdlsite_cfg.load();
-            }
-            // Ta-da. Now the url should be available.
-            config.exec_address = new URL(url);
-
-            // A quick test involves opening a connection to get the home page for this collection. If this fails then we try changing the url to be localhost.
-            try {
-            Gatherer.println("Try connecting to server on config url.");
-            URLConnection connection = config.exec_address.openConnection();
-            connection.getContent();
-            }
-            catch(IOException bad_url_connection) {
-            try {
-                Gatherer.println("Try connecting to server on local host.");
-                config.exec_address = new URL(gsdlsite_cfg.getLocalHostURL());
-                URLConnection connection = config.exec_address.openConnection();
-                connection.getContent();
-            }
-            catch(IOException worse_url_connection) {
-                Gatherer.println("Can't connect to server on either address.");
-                config.exec_address = null;
-                config.exec_file = null;
-            }
-            }
-        }
-        catch (Exception error) {
-            error.printStackTrace();
-        }
-        }
         // Can't do a damb thing.
-    }
-    Gatherer.println("Having started server.exe, exec_address is: " + config.exec_address);
+        }
+        Gatherer.println("Having started server.exe, exec_address is: " + config.exec_address);
     }
 
@@ -739 +824 @@
             gsdlsite_cfg.load();
             int try_again = JOptionPane.YES_OPTION;
-            while(try_again == JOptionPane.YES_OPTION) {
             int attempt_count = 0;
-            while(gsdlsite_cfg.getURL() != null && attempt_count < 60) {
-                synchronized(this) {
-                wait(1000); // Wait one second (give or take)
-                }
-                gsdlsite_cfg.load();
-                attempt_count++;
+            while(gsdlsite_cfg.getURL() != null && try_again == JOptionPane.YES_OPTION) {
+                if(attempt_count == 60) {
+                    try_again = JOptionPane.showConfirmDialog(Gatherer.g_man, dictionary.get("Server.QuitTimeOut"), dictionary.get("General.Warning"), JOptionPane.YES_NO_OPTION);
+                }
+                else {
+                    synchronized(this) {
+                        wait(1000); // Wait one second (give or take)
+                    }
+                    gsdlsite_cfg.load();
+                    attempt_count++;
+                }
             }
-            if(attempt_count == 60) {
-                try_again = JOptionPane.showConfirmDialog(Gatherer.g_man, dictionary.get("Server.QuitTimeOut"), dictionary.get("General.Warning"), JOptionPane.YES_NO_OPTION);
-            }
-            else {
-                try_again = JOptionPane.NO_OPTION;
-            }
-            }
-            if(gsdlsite_cfg.getURL() != null) {
-            JOptionPane.showMessageDialog(Gatherer.g_man, dictionary.get("Server.QuitManual"), dictionary.get("General.Error"), JOptionPane.ERROR_MESSAGE);
-            }
+            //if(gsdlsite_cfg.getURL() != null) {
+            //JOptionPane.showMessageDialog(Gatherer.g_man, dictionary.get("Server.QuitManual"), dictionary.get("General.Error"), JOptionPane.ERROR_MESSAGE);
+            //}
         }
         catch (Exception error) {