Changeset 18363 for gli/branches/rtl-gli/src/org/greenstone/gatherer/Gatherer.java

Timestamp:

2009-01-12T11:19:54+13:00 (15 years ago)

Author:

kjdon

Message:

updated the rtl-gli branch with files from trunk. Result of a merge 14807:18318

File:

• gli/branches/rtl-gli/src/org/greenstone/gatherer/Gatherer.java (modified) (23 diffs)

gli/branches/rtl-gli/src/org/greenstone/gatherer/Gatherer.java

@@ -36 +36 @@
 import javax.swing.plaf.*;
 import javax.swing.text.*;
+
+
 import org.greenstone.gatherer.Configuration;
 import org.greenstone.gatherer.GAuthenticator;
+import org.greenstone.gatherer.FedoraInfo;
 import org.greenstone.gatherer.collection.CollectionManager;
 import org.greenstone.gatherer.feedback.ActionRecorderDialog;
@@ -51 +54 @@
 import org.greenstone.gatherer.gui.URLField;
 import org.greenstone.gatherer.gui.WarningDialog;
+import org.greenstone.gatherer.gui.FedoraLogin;
 import org.greenstone.gatherer.remote.RemoteGreenstoneServer;
 import org.greenstone.gatherer.util.JarTools;
@@ -74 +78 @@
         * in a line which maches this java regex:
         * ^(.*)String\s*PROGRAM_VERSION\s*=\s*"trunk";
-        * If change the daclaration and it no longer matches the regex, please
+        * If change the declaration and it no longer matches the regex, please
         * change the regex in the gs3-release-maker code and in this message
         */
+
     static final public String PROGRAM_VERSION = "trunk";
 
     static private Dimension size = new Dimension(800, 540);
+    static public RemoteGreenstoneServer remoteGreenstoneServer = null;
 
     /** Has the exit flag been set? */
@@ -165 +171 @@
         // We don't have a local Greenstone!
         go.gsdl_path = null;
+        go.gsdl3_path=null;
+        go.gsdl3_src_path=null;
 
         // We have to use our own collect directory since we can't use the Greenstone one
         setCollectDirectoryPath(getGLIUserDirectoryPath() + "collect" + File.separator);
-        if (go.run_gsdl3){   
-        GS3=true;
-        go.gsdl3_path=null;
-        go.gsdl3_src_path=null;
-        }
     }
     // No, we have a local Greenstone
@@ -186 +189 @@
     // More special code for running with a remote Greenstone
     if (isGsdlRemote) {
-        Configuration.TEMPLATE_CONFIG_XML = "xml/configRemote.xml";
-        if (!go.run_gsdl3){  
-        Configuration.CONFIG_XML = "configRemote.xml";
-        }else{
-        Configuration.GS3_CONFIG_XML = "config3Remote.xml";
-        }
+        if (go.fedora_info.isActive()) {
+        Configuration.TEMPLATE_CONFIG_XML = "xml/" + Configuration.FEDORA_CONFIG_PREFIX + "configRemote.xml";
+        }
+        else {
+        Configuration.TEMPLATE_CONFIG_XML = "xml/configRemote.xml";
+        }
+
+        Configuration.CONFIG_XML = "configRemote.xml"; 
 
         File collect_directory = new File(Gatherer.getCollectDirectoryPath());
@@ -198 +203 @@
         }
     }
-
-    init(go.gsdl_path, go.gsdl3_path, go.gsdl3_src_path, go.local_library_path, go.library_url_string, 
+    else {      
+        if (go.fedora_info.isActive()) {
+        Configuration.TEMPLATE_CONFIG_XML = "xml/" + Configuration.FEDORA_CONFIG_PREFIX + Configuration.CONFIG_XML;
+        }
+        // else, the CONFIG_XML uses the default config file, which is for the local GS server
+    }
+
+    init(go.gsdl_path, go.gsdl3_path, go.gsdl3_src_path, 
+         go.fedora_info,
+         go.local_library_path, go.library_url_string, 
          go.gliserver_url_string, go.debug, go.perl_path, go.no_load, go.filename, go.site_name,
          go.servlet_path);
@@ -205 +218 @@
 
 
-    public void init(String gsdl_path, String gsdl3_path, String gsdl3_src_path, String local_library_path,
+    public void init(String gsdl_path, String gsdl3_path, String gsdl3_src_path, 
+             FedoraInfo fedora_info,
+             String local_library_path,
              String library_url_string, String gliserver_url_string, boolean debug_enabled,
              String perl_path, boolean no_load, String open_collection, 
@@ -245 +260 @@
     try {
         // Load GLI config file
-        new Configuration(getGLIUserDirectoryPath(), gsdl_path, gsdl3_path, gsdl3_src_path, site_name);
-
+        new Configuration(getGLIUserDirectoryPath(), gsdl_path, gsdl3_path, gsdl3_src_path, site_name,
+                  fedora_info);
+        
         // Check we know where Perl is
         Configuration.perl_path = perl_path;
@@ -278 +294 @@
         }
 
-        // Start up the local library server, if that's what we want
-        if (Utility.isWindows() && local_library_path != null && !isGsdlRemote && !GS3) {
-        LocalLibraryServer.start(gsdl_path, local_library_path);
-        }
-
+        if (fedora_info.isActive()) {
+        popupFedoraInfo();
+        }
+
+        // Finally, we're ready to find out the version of the remote Greenstone server 
+        if(isGsdlRemote) {
+        // instantiate the RemoteGreenstoneServer object first
+        remoteGreenstoneServer = new RemoteGreenstoneServer();
+
+        int greenstoneVersion = 2;
+        requestGLIServerURL();
+        gliserver_url_string = Configuration.gliserver_url.toString();
+        
+        greenstoneVersion = remoteGreenstoneServer.getGreenstoneVersion();
+        // Display the version to make error reports a lot more useful
+        System.err.println("Remote Greenstone server version: " + greenstoneVersion);
+        if(greenstoneVersion >= 3) {
+            this.GS3 = true;
+            Configuration.prepareForGS3();
+        } 
+        
+        if(fedora_info.isActive()) { 
+            // when GS server is remote, FEDORA_HOME resides on the remote server side,
+            // but we know the library URL from user-provided information
+            library_url_string = fedora_info.getLibraryURL();
+        } else {
+            library_url_string = remoteGreenstoneServer.getLibraryURL(Configuration.gliserver_url.toString());
+        }
+        }
+        else { // local greenstone: 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);
+        }
+        }
+        
         // The "-library_url" option overwrites anything in the config files
         if (library_url_string != null && library_url_string.length() > 0) {
@@ -293 +339 @@
         }
         }
+  
 
         // Check that we now know the Greenstone library URL, since we need this for previewing collections
@@ -298 +345 @@
         if (Configuration.library_url == null) {
         missingEXEC(); 
-        if ((Configuration.library_url!=null) && isGsdlRemote && (gliserver_url_string==null)){
-            if (GS3){
-            default_gliserver_url = new URL(Configuration.library_url.toString() + "/cgi-bin/gliserver4gs3.pl");
-            }else{
-            default_gliserver_url = new URL(Configuration.library_url.toString().substring(0,Configuration.library_url.toString().lastIndexOf("/library")) + "/gliserver.pl");
-            }
-            missingGLIServer();
-        }
         }
 
@@ -321 +360 @@
         // If we're using a remote Greenstone we need to know where the gliserver script is
         DebugStream.println("Configuration.gliserver_url = " + Configuration.gliserver_url);
-        if (isGsdlRemote) {
-        if (Configuration.gliserver_url == null) {
-            if (Configuration.library_url != null) {
-            if (GS3){
-                default_gliserver_url = new URL(Configuration.library_url.toString() + "/cgi-bin/gliserver4gs3.pl");
-            }else{
-                default_gliserver_url = new URL(Configuration.library_url.toString().substring(0,Configuration.library_url.toString().lastIndexOf("/library")) + "/gliserver.pl");
-            }
-            }
-            missingGLIServer();
-        }
-        if (Configuration.gliserver_url != null) {
-            gliserver_url_string = Configuration.gliserver_url.toString();
-        }
-        }
 
         if (GS3) {
@@ -348 +372 @@
         if (GS3 && Configuration.servlet_path == null) {
         Configuration.servlet_path = servlet_config.getServletPath(Configuration.site_name);
+        }
+         
+        // ensure that a directory called 'cache' exists in the GLI user directory  
+        File user_cache_dir = new File(Gatherer.getGLIUserCacheDirectoryPath());
+        System.err.println("User cache dir: " + Gatherer.getGLIUserCacheDirectoryPath());
+        if (!user_cache_dir.exists() && !user_cache_dir.mkdir()) {
+        System.err.println("Warning: Unable to make directory: " + user_cache_dir);
         }
 
@@ -424 +455 @@
         open_collection_file_path = open_collection;
         if (open_collection_file_path == null) {
-        open_collection_file_path = Configuration.getString("general.open_collection", true);
+        open_collection_file_path = Configuration.getString(
+            "general.open_collection"+Configuration.gliPropertyNameSuffix(), true);
         }
         if (no_load || open_collection_file_path.equals("")) {
@@ -434 +466 @@
     }
 
+    
     // Create GUI Manager (last) or else suffer the death of a thousand NPE's
     g_man = new GUIManager(size);
@@ -443 +476 @@
     // If using a remote Greenstone we need to download the collection configurations now
     if (Gatherer.isGsdlRemote) {
-        if (RemoteGreenstoneServer.downloadCollectionConfigurations().equals("")) {
+        if (remoteGreenstoneServer.downloadCollectionConfigurations().equals("")) {
         // !! Something went wrong downloading the collection configurations
         System.err.println("Error: Could not download collection configurations.");
-        System.exit(0);
-        }
-    }
-
-    }
+        if(!Gatherer.isApplet) { // don't close the browser if it is an applet!
+            System.exit(0);
+        }
+        }
+    }
+    }
+
+    
+    /** Returns the correct version of the (local or remote) Greenstone server if init() has already been called. */
+    public static int serverVersionNumber() { 
+    return GS3 ? 3 : 2;
+    } 
+
+    /** Returns "Server: version number" if init() has already been called. */
+    public static String getServerVersionAsString() { 
+    return "Server: v" + serverVersionNumber();
+    } 
 
     public void openGUI()
@@ -511 +556 @@
     // If using a remote Greenstone we need to download the collection configurations now
     if (Gatherer.isGsdlRemote) {
-        if (RemoteGreenstoneServer.downloadCollectionConfigurations().equals("")) {
+        if (remoteGreenstoneServer.downloadCollectionConfigurations().equals("")) {
         // !! Something went wrong downloading the collection configurations
         System.err.println("Error: Could not download collection configurations.");
@@ -561 +606 @@
 
     // Get the gui to deallocate
-    g_man.destroy();
-    g_man_built = false;
+    if(g_man != null) {
+        g_man.destroy();
+        g_man_built = false;
+    }
 
     // Flush debug
@@ -574 +621 @@
     // If we're using a remote Greenstone server we need to make sure that all jobs have completed first
     if (isGsdlRemote) {
-        RemoteGreenstoneServer.exit();
+        remoteGreenstoneServer.exit();
     }
 
@@ -715 +762 @@
         url = null;
     }
+    catch(java.net.ConnectException connectException) {
+        JOptionPane.showMessageDialog(g_man, Dictionary.get("Preferences.Connection.Library_Path_Connection_Failure", Configuration.library_url.toString()), Dictionary.get("General.Warning"), JOptionPane.WARNING_MESSAGE);
+        DebugStream.println(connectException.getMessage());
+    }
     catch (Exception exception) {            
         DebugStream.printStackTrace(exception);
@@ -767 +818 @@
     static private void missingEXEC() {
     WarningDialog dialog;
+    String configPropertyName = "general.library_url"+Configuration.gliPropertyNameSuffix();
+
     if (GS3) {
-        dialog = new WarningDialog("warning.MissingEXEC", Dictionary.get("MissingEXEC_GS3.Title"), Dictionary.get("MissingEXEC_GS3.Message"), "general.library_url", false);
-    }else {
-        dialog = new WarningDialog("warning.MissingEXEC", Dictionary.get("MissingEXEC.Title"), Dictionary.get("MissingEXEC.Message"), "general.library_url", false);
-    }
-    dialog.setValueField(new URLField(Configuration.getColor("coloring.editable_foreground", false), Configuration.getColor("coloring.editable_background", false)));
+        // Warning dialog with no cancel button and no "turn off warning" checkbox 
+        dialog = new WarningDialog("warning.MissingEXEC", Dictionary.get("MissingEXEC_GS3.Title"), Dictionary.get("MissingEXEC_GS3.Message"), configPropertyName, false, false);
+    } else { // local case
+        dialog = new WarningDialog("warning.MissingEXEC", Dictionary.get("MissingEXEC.Title"), Dictionary.get("MissingEXEC.Message"), configPropertyName, false);
+    }
+
+    JTextField field = new URLField.Text(Configuration.getColor("coloring.editable_foreground", false), Configuration.getColor("coloring.editable_background", false));
+
+    // Set the default library URL to the tomcat server and port number
+    // specified in the build.properties located in the gsdl3_src_path 
+    if (GS3) {
+        String host = "localhost";
+        String port = "8080";
+        
+        File buildPropsFile = new File(Configuration.gsdl3_src_path + File.separator + "build.properties");
+        if(buildPropsFile.exists()) {
+        Properties props = new Properties();
+        try{
+            props.load(new FileInputStream(buildPropsFile));
+            host = props.getProperty("tomcat.server", host); 
+            port = props.getProperty("tomcat.port", port); 
+        }catch(Exception e){
+            DebugStream.println("Could not load build.properties file");
+            System.err.println("Could not load build.properties file");
+        }
+        props = null;
+        }
+        String defaultURL = "http://"+host+":"+port+"/"+"greenstone3/library";
+        field.setText(defaultURL);
+        field.selectAll();
+    }
+    dialog.setValueField(field);
     dialog.display();
     dialog.dispose();
     dialog = null;
 
-    String library_url_string = Configuration.getString("general.library_url", true);
+    String library_url_string = Configuration.getString(configPropertyName, true);
     if (!library_url_string.equals("")) {
         try {
+        // WarningDialog does not allow invalid URLs, so the following is ignored:
+        // make sure the URL the user provided contains the http:// prefix
+        // and then save the corrected URL
+        if(!library_url_string.startsWith("http://") 
+           && !library_url_string.startsWith("https://")) {
+            library_url_string = "http://"+library_url_string;
+            Configuration.setString(configPropertyName, true, configPropertyName);
+        }
         Configuration.library_url = new URL(library_url_string);
         }
@@ -789 +877 @@
 
 
-    static private void missingGLIServer()
+
+    /** Prints a warning message about a missing library path, which means the final collection cannot be previewed in the Gatherer.
+     */
+    static private void popupFedoraInfo() {
+
+    FedoraLogin dialog = new FedoraLogin("Fedora Login", false);
+
+    if (Configuration.library_url == null) {
+        
+        String library_url_string = dialog.getLibraryURL();
+        if (!library_url_string.equals("")) {
+        try {
+            Configuration.library_url = new URL(library_url_string);
+        }
+        catch (MalformedURLException exception) {
+            DebugStream.printStackTrace(exception);
+        }
+        }
+    }
+    
+    boolean showLogin = true;
+    do {
+        if(!dialog.loginRequested()) { // user pressed cancel to exit the FedoraLogin dialog
+        System.exit(0);
+        } else {
+        showLogin = dialog.loginRequested();
+        String hostname = dialog.getHostname();
+        String port     = dialog.getPort();
+        String username = dialog.getUsername();
+        String password = dialog.getPassword();
+        String protocol = dialog.getProtocol();
+        
+        Configuration.fedora_info.setHostname(hostname);
+        Configuration.fedora_info.setPort(port);
+        Configuration.fedora_info.setUsername(username);
+        Configuration.fedora_info.setPassword(password);
+        Configuration.fedora_info.setProtocol(protocol);
+        
+        String ping_url_str = protocol + "://" + hostname + ":" + port + "/fedora";
+        String login_str = username + ":" + password;
+        
+        String login_encoding = new sun.misc.BASE64Encoder().encode(login_str.getBytes());
+                
+        try {
+            URL ping_url = new URL(ping_url_str);
+            URLConnection uc = ping_url.openConnection();
+            uc.setRequestProperty  ("Authorization", "Basic " + login_encoding);
+            // Attempt to access some content ...
+            InputStream content = (InputStream)uc.getInputStream();
+            
+            // if no exception occurred in the above, we would have come here:
+            showLogin = false;
+            dialog.dispose();
+        }
+        catch (Exception exception) {
+            // TODO: move into dictionary
+            String[] errorMessage = {"Failed to connect to the Fedora server.", "It might not be running, or",
+                         "incorrect username and/or password."};
+            dialog.setErrorMessage(errorMessage);
+            //DebugStream.printStackTrace(exception);
+            // exception occurred, show the dialog again (do this after printing to
+            // debugStream, else the above does not get done for some reason).
+            dialog.setVisible(true);
+        }
+        } 
+    } while(showLogin);
+
+    dialog = null; // no more need of the dialog
+    
+    // Now we are connected.
+    }
+
+
+
+    static private void requestGLIServerURL()
     {
     WarningDialog dialog;
-    if (GS3) {
-        dialog = new WarningDialog("warning.MissingGLIServer", Dictionary.get("MissingGLIServer_GS3.Title"), Dictionary.get("MissingGLIServer_GS3.Message"), "general.gliserver_url", false);
-    }else {
-        dialog = new WarningDialog("warning.MissingGLIServer", Dictionary.get("MissingGLIServer.Title"), Dictionary.get("MissingGLIServer.Message"), "general.gliserver_url", false);
-    }
-    dialog.setValueField(new URLField(Configuration.getColor("coloring.editable_foreground", false), Configuration.getColor("coloring.editable_background", false)));
-    
+    String[] defaultURLs = {
+        "http://localhost:8080/greenstone3/cgi-bin/gliserver.pl", 
+        "http://localhost:8080/gsdl/cgi-bin/gliserver.pl"
+    };
+
+    // Warning dialog with no cancel button and no "turn off warning" checkbox 
+    // (since user-input of the gliserver script is mandatory)
+    dialog = new WarningDialog("warning.MissingGLIServer", Dictionary.get("MissingGLIServer.Title"), Dictionary.get("MissingGLIServer.Message"), "general.gliserver_url", false, false); 
+
+    dialog.setValueField(new URLField.DropDown(Configuration.getColor("coloring.editable_foreground", false), 
+                           Configuration.getColor("coloring.editable_background", false), 
+                           defaultURLs, "general.gliserver_url", 
+                           "general.open_collection"+Configuration.gliPropertyNameSuffix(), 
+                           "gliserver.pl")); 
+
     if (Gatherer.default_gliserver_url!=null){
         dialog.setValueField(Gatherer.default_gliserver_url.toString());
     }
+
+    // A WarningDialog cannot always be made to respond (let alone to exit the program) on close. We
+    // handle the response of this particular WarningDialog here: a URL for gliserver.pl is a crucial
+    // piece of user-provided data. Therefore, if no URL was entered for gliserver.pl, it'll exit safely.
+    dialog.addWindowListener(new WindowAdapter() {
+        public void windowClosing(WindowEvent e) {
+            Gatherer.exit();
+        }
+        });
     
     dialog.display();
     dialog.dispose();
     dialog = null;
+
     
     String gliserver_url_string = Configuration.getString("general.gliserver_url", true);
@@ -1045 +1225 @@
         //new way of detection of ImageMagick
         InputStreamReader isr = new InputStreamReader(image_magick_process.getInputStream());
+
             BufferedReader br = new BufferedReader(isr);
             // Capture the standard output stream and seach for two particular occurances: Version and ImageMagick.
-            String line = br.readLine().toLowerCase();
-        if (line.indexOf("version") != -1 || line.indexOf("imagemagick") != -1) {
+
+            String line = br.readLine();
+        if (line == null) {
+            return false;
+        }
+            String lc_line = line.toLowerCase();
+        if (lc_line.indexOf("version") != -1 || lc_line.indexOf("imagemagick") != -1) {
             return true;
         } else {
                 return false;
         }
+
         //return (image_magick_process.exitValue() == 0);
         }