Changeset 10242

Timestamp:

2005-07-13T14:10:18+12:00 (19 years ago)

Author:

mdewsnip

Message:

Moved a lot of the duplicated code out of GathererProg and GathererApplet and into Gatherer.

Location:

trunk/gli/src/org/greenstone/gatherer

Files:

• Gatherer.java (modified) (5 diffs)
• GathererApplet.java (modified) (6 diffs)
• GathererProg.java (modified) (3 diffs)
• GetOpt.java (modified) (1 diff)

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

@@ -63 +63 @@
 public class Gatherer
 {
+    static private Dimension size = new Dimension(800, 540);
+
     /** Has the exit flag been set? */
     public boolean exit = false;
@@ -79 +81 @@
     static public FileManager f_man;
     /** A public reference to the GUIManager. */
-    static public GUIManager g_man;
+    static public GUIManager g_man = null;
     static private boolean g_man_built = false;
 
@@ -88 +90 @@
 
     static public boolean isApplet = false;
-    static public boolean isGsdlRemote = false;
+    static public boolean isGsdlRemote = true;
     static public String cgiBase = "";
 
@@ -112 +114 @@
 
 
-    public Gatherer() 
+    public Gatherer(String[] args) 
     {
     this.self = this;
-
     JarTools.initialise(this); 
-    }
-
-
-    public GUIManager init(Dimension size, String gsdl_path, String gsdl3_path, String local_library_path,
-               String library_url_string, boolean debug_enabled, String perl_path, 
-               boolean no_load, String open_collection, 
-               String site_name, String servlet_path, String wget_path) 
+
+    GetOpt go = new GetOpt(args);
+
+    // If feedback is enabled, set up the recorder dialog
+    if (go.feedback_enabled) {
+        // Use the default locale for now - this will be changed by the Gatherer run method
+        feedback_enabled = true;
+        feedback_dialog = new ActionRecorderDialog(Locale.getDefault());
+    }
+
+    if (go.collect_directory_path != null) {
+        // Use non-standard collect directory (for when running one GLI in a network environment)
+        Gatherer.setCollectDirectoryPath(go.collect_directory_path);
+    }
+
+    // Special code for running with a remote Greenstone
+    if (isGsdlRemote) {
+        File gli_user_directory = Utility.getGLIUserFolder();
+
+        Utility.BASE_DIR = gli_user_directory.toString();
+        if (!Utility.BASE_DIR.endsWith(File.separator)) {
+        Utility.BASE_DIR += File.separator;
+        }
+
+        Utility.METADATA_DIR = Utility.BASE_DIR + "metadata" + File.separator;
+        Utility.TMP_DIR = Utility.BASE_DIR + "tmp" + File.separator;
+
+        Configuration.TEMPLATE_CONFIG_XML = "xml/configRemote.xml";
+        Configuration.CONFIG_XML = "configRemote.xml";
+        Configuration.GS3_CONFIG_XML = "config3Remote.xml";
+
+        Gatherer.setCollectDirectoryPath(go.gsdl_path + "collect" + File.separator);
+        File col_dir = new File(Gatherer.getCollectDirectoryPath());
+        if (!col_dir.exists()) {
+
+        if (JarTools.isInJar(Utility.COLLECT_ZIP)) {
+            // Dig out collect.zip from JAR file and unzip it (thereby
+            // creating collect directory and descendants.
+            //   This is done to seed gsdl home folder with config files
+            //   for documented example collections so "base this on
+            //   existing collection" works
+            Utility.unzipFromJar(Utility.COLLECT_ZIP, gli_user_directory.toString());
+        }
+        else {
+            // Prepare an empty collect dir for general use
+            if (!col_dir.mkdir()) {
+            System.err.println("Warning: Unable to make directory: " + col_dir.toString());
+            }
+        }
+        }
+
+        File tmp_dir = new File(Utility.TMP_DIR);
+        if (!tmp_dir.exists()) {
+        if (!tmp_dir.mkdir()) {
+            System.err.println("Warning: Unable to make directory: " + tmp_dir.toString());
+        }
+
+        String username = System.getProperty("user.name");
+        if ((username != null) && (username != "")) {
+            File user_tmp_dir = new File(Utility.TMP_DIR + File.separator + username);
+            if (!user_tmp_dir.exists()) {
+            if (!user_tmp_dir.mkdir()) {
+                System.err.println("Warning: Unable to make directory: " + user_tmp_dir.toString());
+            }
+            }
+        }
+        }
+
+        File metadata_directory = new File(Utility.METADATA_DIR);
+        if (!metadata_directory.exists()) {
+        // dig out metadata.zip from JAR file and unzip it
+        Utility.unzipFromJar(Utility.METADATA_ZIP, gli_user_directory.toString());
+        }
+
+        File plug_dat = new File(Utility.BASE_DIR + "plugins.dat");
+        if (!plug_dat.exists()) {
+        JarTools.extractFromJar("plugins.dat", Utility.BASE_DIR, false);
+        }
+
+        File class_dat = new File(Utility.BASE_DIR + "classifiers.dat");
+        if (!class_dat.exists()) {
+        JarTools.extractFromJar("classifiers.dat", Utility.BASE_DIR, false);
+        }
+    }
+
+    init(go.gsdl_path, go.gsdl3_path, go.local_library_path, go.library_url_string, go.debug,
+         go.perl_path, go.no_load, go.filename, go.site_name, go.servlet_path, go.wget_path);
+    }
+
+
+    public void init(String gsdl_path, String gsdl3_path, String local_library_path,
+             String library_url_string, boolean debug_enabled, String perl_path, 
+             boolean no_load, String open_collection, 
+             String site_name, String servlet_path, String wget_path) 
     {
     if (gsdl3_path != null && !gsdl3_path.equals("")) {
@@ -329 +417 @@
     // Create GUI Manager (last) or else suffer the death of a thousand NPE's
     g_man = new GUIManager(size);
-    return g_man;
-    }
-
-
-    public void run(Dimension size, GUIManager g_man) 
+    }
+
+
+    public void openGUI()
     {
     // Size and place the frame on the screen

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

@@ -34 +34 @@
 import javax.swing.JApplet;
 
-import java.awt.*;
 import java.io.*;
-import java.util.*;
 import javax.swing.*;
-import org.greenstone.gatherer.Configuration;
-import org.greenstone.gatherer.feedback.ActionRecorderDialog;
-import org.greenstone.gatherer.gui.GUIManager;
-import org.greenstone.gatherer.util.JarTools;
 import org.greenstone.gatherer.util.Utility;
-import org.greenstone.gatherer.shell.GShell;
 
 
 public class GathererApplet extends JApplet implements ActionListener
 {
-    Gatherer gatherer;
-    GUIManager g_man;
-    Dimension size = new Dimension(800, 540);
+    private Gatherer gatherer = null;
+
 
     protected String fullLibraryURL(String address) 
@@ -73 +65 @@
     }
 
+
+    /* This is the entry point for the GLI applet */
     public void init()
     {
+    // Check if the user has agreed to the requested security settings
     try {
         // Work-around to reduce number of 
@@ -81 +76 @@
         System.setProperty("java.util.prefs.syncInterval","2000000");
     }
-
     catch (Exception exception) {
-        // convenient way of finding out if user has agreed to
-        // to requested security settings
-
-        JLabel lab 
-        = new JLabel("Greenstone Librarian Interface Applet deactivated",
-                 JLabel.CENTER);
-        getContentPane().add(lab);
+        getContentPane().add(new JLabel("Greenstone Librarian Interface Applet deactivated", JLabel.CENTER));
         return;
     }
@@ -101 +89 @@
     }
 
-    String gwcgi = getParameter("gwcgi");
-    String library_cgi = fullLibraryURL(gwcgi);
-    int cgi_base_cut = library_cgi.lastIndexOf('/');
-    String cgi_base = library_cgi.substring(0,cgi_base_cut+1);
-
-        String windows_home = getParameter("windowsHome");
-        File gli_user_directory = Utility.setGLIUserFolder(windows_home);
-    if (!gli_user_directory.exists()) {
-        if (!gli_user_directory.mkdirs()) {
-            System.err.println("Warning: Unable to make directory: " + gli_user_directory.toString());
-        }
+    // Ensure the GLI user directory exists
+        File gli_user_directory = Utility.setGLIUserFolder(getParameter("windowsHome"));
+    if (!gli_user_directory.exists() && !gli_user_directory.mkdirs()) {
+        System.err.println("Error: Unable to make directory: " + gli_user_directory.toString());
     }
 
-    gatherer = new Gatherer();
+    // Set some global variables so we know how we're running
+    Gatherer.isApplet = true;
+    Gatherer.isGsdlRemote = true;
+    String library_cgi = fullLibraryURL(getParameter("gwcgi"));
+    Gatherer.cgiBase = library_cgi.substring(0, library_cgi.lastIndexOf('/') + 1);
+
+        // String debug_param = getParameter("debug");
+        // if ((debug_param != null) && (debug_param.matches("true"))) {
+        //     go.debug = true;
+        // }
 
     String[] args = { "-gsdl", gli_user_directory.toString(),
@@ -120 +110 @@
                     };
 
-    GetOpt go = new GetOpt(args);
+    // Create an instance of the Gatherer class, which will parse the args and prepare the rest of the GLI
+    gatherer = new Gatherer(args);
 
-        String debug_param = getParameter("debug");
-
-        if ((debug_param != null) && (debug_param.matches("true"))) {
-            go.debug = true;
-        }
-
-    if (go.feedback_enabled) {
-        // If feedback is enabled, set up the recorder dialog.  
-        // Use the default locale for now - this will be changed by the
-        // Gatherer run method
-        Locale currLocale = Locale.getDefault(); 
-        ActionRecorderDialog dlg = new ActionRecorderDialog (currLocale);
-        gatherer.feedback_enabled = true;
-        gatherer.feedback_dialog = dlg;
-    }
-
-    Gatherer.isApplet = true;
-    Gatherer.isGsdlRemote = true;
-    Gatherer.cgiBase = cgi_base;
-
-    Utility.BASE_DIR = go.gsdl_path;
-    if (!Utility.BASE_DIR.endsWith(File.separator)) {
-        Utility.BASE_DIR += File.separator;
-    }
-
-    Utility.METADATA_DIR = Utility.BASE_DIR + "metadata" + File.separator;
-    Utility.TMP_DIR = Utility.BASE_DIR + "tmp" + File.separator;
-
-    Configuration.TEMPLATE_CONFIG_XML = "xml/configRemote.xml";
-    Configuration.CONFIG_XML = "configRemote.xml";
-    Configuration.GS3_CONFIG_XML = "config3Remote.xml";
-
-    Gatherer.setCollectDirectoryPath(go.gsdl_path + "collect" + File.separator);
-    File col_dir = new File(Gatherer.getCollectDirectoryPath());
-    if (!col_dir.exists()) {
-
-        if (JarTools.isInJar(Utility.COLLECT_ZIP)) {
-        // Dig out collect.zip from JAR file and unzip it (thereby
-        // creating collect directory and descendants.
-        //   This is done to seed gsdl home folder with config files
-        //   for documented example collections so "base this on
-        //   existing collection" works
-        Utility.unzipFromJar(Utility.COLLECT_ZIP,gli_user_directory.toString());
-        }
-        else {
-        // Prepare an empty collect dir for general use
-        if (!col_dir.mkdir()) {
-            System.err.println("Warning: Unable to make directory: " + col_dir.toString());
-        }
-        }
-        }
-
-    
-        File tmp_dir = new File(Utility.TMP_DIR);
-        if (!tmp_dir.exists()) {
-            if (!tmp_dir.mkdir()) {
-        System.err.println("Warning: Unable to make directory: " + tmp_dir.toString());
-        }
-
-        String username = System.getProperty("user.name");
-        if ((username != null) && (username != "")) {
-        File user_tmp_dir = new File(Utility.TMP_DIR + File.separator + username);
-        if (!user_tmp_dir.exists()) {
-            if (!user_tmp_dir.mkdir()) {
-            System.err.println("Warning: Unable to make directory: " + user_tmp_dir.toString());
-            }
-        }
-        }
-        }
-
-    File metadata_directory = new File(Utility.METADATA_DIR);
-    if (!metadata_directory.exists()) {
-        // dig out metadata.zip from JAR file and unzip it
-        Utility.unzipFromJar(Utility.METADATA_ZIP, gli_user_directory.toString());
-    }
-
-    File plug_dat = new File(Utility.BASE_DIR + "plugins.dat");
-    if (!plug_dat.exists()) {
-        JarTools.extractFromJar("plugins.dat", Utility.BASE_DIR, false);
-    }
-
-    File class_dat = new File(Utility.BASE_DIR + "classifiers.dat");
-    if (!class_dat.exists()) {
-        JarTools.extractFromJar("classifiers.dat", Utility.BASE_DIR, false);
-    }
-    
-    g_man = gatherer.init(size, go.gsdl_path, go.gsdl3_path, go.local_library_path,
-                    go.library_url_string, go.debug, go.perl_path, 
-                    go.no_load, go.filename, go.site_name, 
-                    go.servlet_path, go.wget_path);
-
-    JButton bttn = new JButton("Launch Greenstone Librarian Interface ...");
-    bttn.addActionListener(this);
-    getContentPane().add(bttn);
+    // Create a button for the user to press to open the GLI GUI
+    JButton launch_GLI_button = new JButton("Launch Greenstone Librarian Interface ...");
+    launch_GLI_button.addActionListener(this);
+    getContentPane().add(launch_GLI_button);
     }
 
@@ -240 +141 @@
     }
 
+
     public void actionPerformed(ActionEvent e)
     {
-    gatherer.run(size, g_man);
+    gatherer.openGUI();
 
-    // If there was an open collection last session, reopen it.
+    // If there was an open collection last session, reopen it
     if (Gatherer.open_collection_file_path != null) {
         Gatherer.c_man.loadCollection(Gatherer.open_collection_file_path);

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

@@ -6 +6 @@
  * University of Waikato, New Zealand.
  *
- * Author: John Thompson, Greenstone Digital Library, University of Waikato
+ * Author: John Thompson, NZDL Project, University of Waikato
  *
- * Copyright (C) 1999 New Zealand Digital Library Project
+ * Copyright (C) 2005 New Zealand Digital Library Project
  *
  * This program is free software; you can redistribute it and/or modify
@@ -28 +28 @@
 
 
-import java.awt.*;
 import java.io.*;
-import java.util.*;
 import javax.swing.*;
-import org.greenstone.gatherer.feedback.ActionRecorderDialog;
-import org.greenstone.gatherer.gui.GUIManager;
 import org.greenstone.gatherer.util.Utility;
 
 
-/** Containing the main() method for the Gatherer, this class is the
- * starting point for the rest of the application. Using GetOpt and
- * GathererBase it first parses the command line arguments, preparing to
- * update the configuration as required. Next it loads several important
- * support classes such as the Configuration and Dictionary. Finally it
- * creates the other important managers and sends them on their way.
- * @author John Thompson, Greenstone Digital Library, University of Waikato
- * @version 2.3
+/**
+ * Containing the main() method, this class is the entry point for the
+ * stand-alone (non-Applet) GLI. The main point of this class is to set
+ * some stand-alone specific properties and then create an instance of the
+ * Gatherer class.
+ * @author John Thompson, NZDL Project, University of Waikato
  */
 public class GathererProg
 {
-    /** The entry point into the Gatherer. Parses arguments.
+    /** The entry point into the stand-alone GLI.
      * @param args A collection of arguments that may include: initial screen size, dictionary, path to the GSDL etc.
-     * @see java.io.File
-     * @see java.io.FileInputStream
-     * @see java.lang.Exception
-     * @see java.util.Properties
-     * @see org.greenstone.gatherer.Dictionary
-     * @see org.greenstone.gatherer.Gatherer
      */
-    static public void main(String[] args) {
+    static public void main(String[] args)
+    {
     // A serious hack, but its good enough to stop crappy 'Could not
     // lock user prefs' error messages.  Thanks to Walter Schatz from
     // the java forums.
     System.setProperty("java.util.prefs.syncInterval","2000000"); 
-    // => results in One message every 600 hours!
+    // => results in one message every 600 hours!
 
     // Ensure platform specific LAF
@@ -73 +62 @@
 
     // Ensure the GLI user directory exists
-    File gli_user_directory = Utility.setGLIUserFolder(null); // # defaults to user's home area
-    if (!gli_user_directory.exists()) {
-        gli_user_directory.mkdirs();
+        File gli_user_directory = Utility.setGLIUserFolder(null);  // Defaults to user's home area
+    if (!gli_user_directory.exists() && !gli_user_directory.mkdirs()) {
+        System.err.println("Error: Unable to make directory: " + gli_user_directory.toString());
     }
 
-    Gatherer gatherer = new Gatherer();
+    // Create an instance of the Gatherer class, which will parse the args and prepare the rest of the GLI
+    Gatherer gatherer = new Gatherer(args);
 
-    Dimension size = new Dimension(800, 540);
+    // Display the GUI immediately
+    gatherer.openGUI();
 
-    GetOpt go = new GetOpt(args);
-
-    if (go.feedback_enabled) {
-        // If feedback is enabled, set up the recorder dialog.
-        // Use the default locale for now - this will be changed by the
-        // Gatherer run method
-        Locale currLocale = Locale.getDefault(); 
-        ActionRecorderDialog dlg = new ActionRecorderDialog (currLocale);
-        gatherer.feedback_enabled = true;
-        gatherer.feedback_dialog = dlg;
-    }
-
-    if (go.collect_directory_path != null) {
-        // Use non-standard collect directory (for when running one GLI in a network environment)
-        Gatherer.setCollectDirectoryPath(go.collect_directory_path);
-    }
-
-    GUIManager g_man 
-        = gatherer.init(size, go.gsdl_path, go.gsdl3_path, go.local_library_path,
-                 go.library_url_string, go.debug, go.perl_path, 
-                 go.no_load, go.filename, go.site_name, 
-                 go.servlet_path, go.wget_path);
-    gatherer.run(size, g_man);
-
-    // If there was an open collection last session, reopen it.
+    // If there was an open collection last session, reopen it
     if (Gatherer.open_collection_file_path != null) {
         Gatherer.c_man.loadCollection(Gatherer.open_collection_file_path);

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

@@ -39 +39 @@
 
     public String collect_directory_path = null;
-    public String extra = null;
     public String filename = null;
     public String gsdl_path = null;