Changeset 8620

Timestamp:

2004-11-23T09:29:02+13:00 (19 years ago)

Author:

mdewsnip

Message:

Moved all the local library server code in a new LocalLibraryServer class. This will make things a lot cleaner and more easily allow a few bugs and features to be done.

Location:

trunk/gli/src/org/greenstone/gatherer

Files:

• Configuration.java (modified) (3 diffs)
• Gatherer.java (modified) (11 diffs)
• GathererApplet.java (modified) (1 diff)
• GathererProg.java (modified) (1 diff)
• GetOpt.java (modified) (1 diff)
• LocalLibraryServer.java (added)
• cdm/CollectionDesignManager.java (modified) (4 diffs)
• collection/CollectionManager.java (modified) (4 diffs)
• collection/DeleteCollectionPrompt.java (modified) (3 diffs)
• collection/ExportCollectionPrompt.java (modified) (1 diff)

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

@@ -97 +97 @@
     static public Configuration self = null;
 
-    static public File exec_file;
     /** The path (or url) to the webserver which is serving the Greenstone collection. */
     static public String exec_path = null;
@@ -163 +162 @@
         }
     }
-    // If the above failed, then its up to us to try and figure out what to do.
-    if(exec_address == null) {
-        // Try building a file from the given exec_path
-        try {
-        File local_file = new File(exec_path);
-        if(local_file.exists()) {
-            // All good. I hope.
-            exec_file = local_file;
-        }
-        else {
-            DebugStream.println("No local library at given file path.");
-        }
-        }
-        // All sorts of errors might be thrown by a bogus file path.
-        catch (Exception error) {
-        DebugStream.println("Libary url does not indicate the server.exe file.");
-        ///atherer.printStackTrace(error);
-        }
-        // We can generate the path to where the local library should be and use that if it is there.
-        if(exec_file == null) {
-        File server_exe = new File(gsdl_path + Utility.SERVER_EXE);
-        if(server_exe.exists()) {
-            exec_file = server_exe;
-        }
-        else {
-            DebugStream.println("No local library.");
-        }
-        }
-        // If we get to here with no exec_address nor an exec_file its just plain not going to work.
-    }
-    else {
-        DebugStream.println("exec_address != null -> " + exec_address);
-    }
 
     this.perl_path = perl_path;
@@ -290 +256 @@
         }
     }
-    DebugStream.println("EXEC_FILE = " + exec_file);
+
     DebugStream.println("EXEC_ADDRESS = " + exec_address);
     }

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

@@ -49 +49 @@
 import org.greenstone.gatherer.gui.URLField;
 import org.greenstone.gatherer.gui.WarningDialog;
-import org.greenstone.gatherer.util.GSDLSiteConfig;
 import org.greenstone.gatherer.util.StaticStrings;
 import org.greenstone.gatherer.util.Utility;
@@ -116 +115 @@
     /** the action recorder dialog */
     static public ActionRecorderDialog feedback_dialog = null;
-    /** Extra environment information which must be set before shell processes will run properly. Should always be null if the startup script/program has done its job properly. */
-    static public String extra_env[] = null;
-    private GSDLSiteConfig gsdlsite_cfg = null;
-    private ExternalApplication server = null;
+
 
     /** Magic to allow Enter to fire the default button. */
@@ -136 +132 @@
 
 
-    public GUIManager init(Dimension size, String gsdl_path, String gsdl3_path, 
+    public GUIManager init(Dimension size, String gsdl_path, String gsdl3_path, String local_library_path,
                String exec_path, boolean debug_enabled, String perl_path, 
                boolean no_load, String open_collection, 
@@ -143 +139 @@
                String wget_path) 
     {
-
     // 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 bloody sick of it working when the Gatherer hangs.
@@ -202 +197 @@
         }
 
-        // If we were given a server run it if neccessary.
-        if (!GS3 && Configuration.exec_file != null) {
-        startServerEXE();
+        // Start up the local library server, if that's what we want
+        if (Utility.isWindows() && local_library_path != null && !GS3) {
+        LocalLibraryServer.start(gsdl_path, local_library_path);
         }
 
         // Having loaded the configuration (necessary to determine if certain warnings have been disabled) and dictionary, we now check if the necessary path variables have been provided.
-        if (Configuration.exec_file == null && Configuration.exec_address == null) {
-        DebugStream.println("config.exec_file is null");
+        if (local_library_path == null && Configuration.exec_address == null) {
+        DebugStream.println("local_library_path is null");
         DebugStream.println("config.exec_address is null");
         missingEXEC();
@@ -433 +428 @@
 
     // If we started a server, we should try to stop it.
-    if(!GS3 && gsdlsite_cfg != null) {
-        stopServerEXE();
+    if (LocalLibraryServer.isRunning() == true) {
+        LocalLibraryServer.stop();
     }
 
@@ -445 +440 @@
         JOptionPane.showMessageDialog(g_man, Dictionary.get("General.Outstanding_Processes"), Dictionary.get("General.Outstanding_Processes_Title"), JOptionPane.ERROR_MESSAGE);
         g_man.setVisible(false);
-    }
-    }
-
-    // Used to send messages to the local library
-    // Warning: this has a lot of potential for nasty race conditions
-    // The response code is returned immediately -- but this does not mean the local
-    //   library action has finished!
-    static public void configServer(String command)
-    {
-    try {
-        String raw_url = Configuration.exec_address.toString() + command;
-        URL url = new URL(raw_url);
-        DebugStream.println("Action: " + raw_url);
-        HttpURLConnection library_connection = (HttpURLConnection) url.openConnection();
-        int response_code = library_connection.getResponseCode();
-        if(HttpURLConnection.HTTP_OK <= response_code && response_code < HttpURLConnection.HTTP_MULT_CHOICE) {
-        DebugStream.println("200 - Complete.");
-        }
-        else {
-        DebugStream.println("404 - Failed.");
-        }
-        url = null;
-    }
-    catch (Exception ex) {
-        DebugStream.printStackTrace(ex);
     }
     }
@@ -522 +492 @@
     }
     }
-    
+
+
+    public void spawnApplication(String command)
+    {
+    ExternalApplication app = new ExternalApplication(command);
+    apps.add(app);
+    app.start();
+    }
+
+
     /** Used to 'spawn' a new  browser application or reset an existing one when the preview button is clicked 
      * @param url The url to open the browser at
@@ -681 +660 @@
     }
 
-    private void startServerEXE() {
-    if(Configuration.exec_file != null && Configuration.exec_address == null && Utility.isWindows() && !GS3) {
-        // 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(Configuration.exec_file);
-        String url = gsdlsite_cfg.getURL();
-        // If its already running then set exec address.
-        if(url != null) {
-        try {
-            Configuration.exec_address = new URL(url);
-        }
-        catch(Exception error) {
-        }
-        }
-        // Otherwise its time to run the server in a spawned process.
-        if(Configuration.exec_address == null && Configuration.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 = Configuration.exec_file.getAbsolutePath() + " " + 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) {
-                attempt_count = 0;
-                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((url = gsdlsite_cfg.getURL()) != null) {
-            // Ta-da. Now the url should be available.
-            Configuration.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 {
-                DebugStream.println("Try connecting to server on config url: '" + Configuration.exec_address + "'");
-                URLConnection connection = Configuration.exec_address.openConnection();
-                connection.getContent();
-            }
-            catch(IOException bad_url_connection) {
-                try {
-                DebugStream.println("Try connecting to server on local host: '" + gsdlsite_cfg.getLocalHostURL() + "'");
-                Configuration.exec_address = new URL(gsdlsite_cfg.getLocalHostURL   ());
-                URLConnection connection = Configuration.exec_address.openConnection();
-                connection.getContent();
-                }
-                catch(IOException worse_url_connection) {
-                DebugStream.println("Can't connect to server on either address.");
-                Configuration.exec_address = null;
-                Configuration.exec_file = null;
-                }
-            }
-            }
-            // Unable to start local library. Show appropriate message.
-            else {
-            missingEXEC();
-            }
-        }
-        catch (Exception exception) {
-            DebugStream.printStackTrace(exception);
-        }
-        }
-        // Can't do a damb thing.
-    }
-    DebugStream.println("Having started server.exe, exec_address is: " + Configuration.exec_address);
-    }
-
-    private void stopServerEXE() {
-    if(server != null && Configuration.exec_address != null) {
-        // See if its already exited for some reason.
-        gsdlsite_cfg.load();
-        if(gsdlsite_cfg.getURL() != null) {
-        // Send the command for it to exit.
-        configServer(GSDLSiteConfig.QUIT_COMMAND);
-        // Wait until it exits.
-        try {
-            gsdlsite_cfg.load();
-            int try_again = JOptionPane.YES_OPTION;
-            int attempt_count = 0;
-            while(gsdlsite_cfg.getURL() != null && try_again == JOptionPane.YES_OPTION) {
-            if(attempt_count == 60) {
-                attempt_count = 0;
-                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) {
-            //JOptionPane.showMessageDialog(Gatherer.g_man, Dictionary.get("Server.QuitManual"), Dictionary.get("General.Error"), JOptionPane.ERROR_MESSAGE);
-            //}
-        }
-        catch (Exception exception) {
-            DebugStream.printStackTrace(exception);
-        }
-        }
-        // Restore the gsdlsite_cfg.
-        if(gsdlsite_cfg != null) {
-        gsdlsite_cfg.restore();
-        }
-        // If the local server is still running then our changed values will get overwritten.
-        if(gsdlsite_cfg.getURL() != null) {
-        JOptionPane.showMessageDialog(Gatherer.g_man, Dictionary.get("Server.QuitFailed"), Dictionary.get("General.Error"), JOptionPane.ERROR_MESSAGE);
-        }
-        gsdlsite_cfg = null;
-        server = null;
-    }
-    }
 
     // TODO fill this in
@@ -865 +717 @@
         apps.remove(this);
         // Call exit if we were the last outstanding child process thread.
-        if(apps.size() == 0 && exit == true) {
-        stopServerEXE();
+        if (apps.size() == 0 && exit == true) {
+        LocalLibraryServer.stop();
         System.exit(0);
         }
@@ -953 +805 @@
         apps.remove(this);
         // Call exit if we were the last outstanding child process thread.
-        if(apps.size() == 0 && exit == true) {
-        stopServerEXE();
+        if (apps.size() == 0 && exit == true) {
+        LocalLibraryServer.stop();
         System.exit(0);
         }

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

@@ -171 +171 @@
     
 
-    g_man = gatherer.init(size, go.gsdl_path, go.gsdl3_path, 
+    g_man = gatherer.init(size, go.gsdl_path, go.gsdl3_path, go.local_library_path,
                     go.exec_path, go.debug, go.perl_path, 
                     go.no_load, go.filename, go.site_name, 

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

@@ -108 +108 @@
     Splash splash = new Splash();
     GUIManager g_man 
-        = gatherer.init(size, go.gsdl_path, go.gsdl3_path, 
+        = gatherer.init(size, go.gsdl_path, go.gsdl3_path, go.local_library_path,
                  go.exec_path, go.debug, go.perl_path, 
                  go.no_load, go.filename, go.site_name, 

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

@@ -186 +186 @@
             // Parse the file path of the local library server
             else if (argument_name.equals(StaticStrings.LOCAL_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;
-            }
+            local_library_path = argument_value;
+
+//          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

trunk/gli/src/org/greenstone/gatherer/cdm/CollectionDesignManager.java

@@ -38 +38 @@
 import org.greenstone.gatherer.Gatherer;
 import org.greenstone.gatherer.GathererApplet;
-import org.greenstone.gatherer.util.GSDLSiteConfig;
+import org.greenstone.gatherer.LocalLibraryServer;
 import org.greenstone.gatherer.util.Utility;
 import org.w3c.dom.*;
@@ -200 +200 @@
     public void save() {
     // Release collection as necessary
+    String collection_name = Gatherer.c_man.getCollection().getName();
     boolean collection_released = false;
-    String col_name = Gatherer.c_man.getCollection().getName();
     boolean formats_changed = format_manager.formatsChanged();
 
-    if (formats_changed && Gatherer.c_man.built() && Configuration.exec_file != null) {
+    if (formats_changed && Gatherer.c_man.built() && LocalLibraryServer.isRunning() == true) {
         // Release the collection
-        Gatherer.configServer(GSDLSiteConfig.RELEASE_COMMAND + col_name);
-        // This is very important -- it ensures that the above command has finished
-        Gatherer.configServer("");
+        LocalLibraryServer.releaseCollection(collection_name);
         collection_released = true;
     }
@@ -218 +216 @@
         if (formats_changed && Gatherer.c_man.built()) {
         // upload etc/collect.cfg to server to reflect changes
-        Utility.zipup(col_name,Utility.CONFIG_FILE);
-        GathererApplet.upload_url_zip(col_name,"etc");
+        Utility.zipup(collection_name, Utility.CONFIG_FILE);
+        GathererApplet.upload_url_zip(collection_name, "etc");
         }
     }
@@ -226 +224 @@
     if (collection_released) {
         // Now re-add collection to server to force format commands to be processed
-        Gatherer.configServer(GSDLSiteConfig.ADD_COMMAND + col_name);
-        // This is very important -- it ensures that the above command has finished
-        Gatherer.configServer("");
+        LocalLibraryServer.addCollection(collection_name);
     }
 

trunk/gli/src/org/greenstone/gatherer/collection/CollectionManager.java

@@ -48 +48 @@
 import org.greenstone.gatherer.Dictionary;
 import org.greenstone.gatherer.Gatherer;
+import org.greenstone.gatherer.LocalLibraryServer;
 import org.greenstone.gatherer.ServletConfiguration;
 import org.greenstone.gatherer.cdm.CollectionDesignManager;
@@ -72 +73 @@
 import org.greenstone.gatherer.util.ArrayTools;
 import org.greenstone.gatherer.util.Codec;
-import org.greenstone.gatherer.util.GSDLSiteConfig;
 import org.greenstone.gatherer.util.StaticStrings;
 import org.greenstone.gatherer.util.Utility;
@@ -1152 +1152 @@
     else if(event.getType() == GShell.BUILD && event.getStatus() == GShell.OK) {
         if(installCollection()) {
-        // If we have a local library running (that we know about) then we ask it to add our newly create collection
-        if (Configuration.exec_file != null) {
-            Gatherer.configServer(GSDLSiteConfig.ADD_COMMAND + collection.getName());
-            // This is very important -- it ensures that the above command has finished
-            Gatherer.configServer("");
+        // If we have a local library running then ask it to add our newly create collection
+        if (LocalLibraryServer.isRunning() == true) {
+            LocalLibraryServer.addCollection(collection.getName());
         }
         else if (Gatherer.GS3) {
@@ -1356 +1354 @@
     try {
         // Ensure that the local library has released this collection so we can delete the index directory
-        if (!Gatherer.GS3 && Configuration.exec_file != null) {
-        Gatherer.configServer(GSDLSiteConfig.RELEASE_COMMAND + collection.getName());
-
-        // This is very important -- it ensures that the above command has finished
-        // This prevents the nasty "could not remove index directory" race condition!
-        Gatherer.configServer("");
+        if (LocalLibraryServer.isRunning() == true) {
+        LocalLibraryServer.releaseCollection(collection.getName());
         }
 

trunk/gli/src/org/greenstone/gatherer/collection/DeleteCollectionPrompt.java

@@ -47 +47 @@
 import org.greenstone.gatherer.Dictionary;
 import org.greenstone.gatherer.Gatherer;
+import org.greenstone.gatherer.LocalLibraryServer;
 import org.greenstone.gatherer.gui.GLIButton;
 import org.greenstone.gatherer.gui.ModalDialog;
@@ -52 +53 @@
 import org.greenstone.gatherer.gui.tree.WorkspaceTree;
 import org.greenstone.gatherer.util.ArrayTools;
-import org.greenstone.gatherer.util.GSDLSiteConfig;
 import org.greenstone.gatherer.util.StaticStrings;
 import org.greenstone.gatherer.util.Utility;
@@ -308 +308 @@
         // Delete the selected collection.
 
-        // first of all we must release it from the local library
-        if (Configuration.exec_file != null) {
-        Gatherer.configServer(GSDLSiteConfig.RELEASE_COMMAND + collection.getShortName());
-        // This is very important -- it ensures that the above command has finished
-        Gatherer.configServer("");
+        // First we must release it from the local library
+        if (LocalLibraryServer.isRunning() == true) {
+        LocalLibraryServer.releaseCollection(collection.getShortName());
         }
 

trunk/gli/src/org/greenstone/gatherer/collection/ExportCollectionPrompt.java

@@ -56 +56 @@
 import org.greenstone.gatherer.shell.GShellListener;
 import org.greenstone.gatherer.util.ArrayTools;
-import org.greenstone.gatherer.util.GSDLSiteConfig;
 import org.greenstone.gatherer.util.StaticStrings;
 import org.greenstone.gatherer.util.Utility;