Changeset 37677 for main

Timestamp:

2023-04-18T21:36:23+12:00 (12 months ago)

Author:

anupama

Message:

GLI now tries to set the linux file association launch command to the default linux open command that works for the linux distribution, out of a limited set of known possibilities that may or may not be installed. For ubuntu xdg-open comes pre-installed, but this is not true for all linux distributions. Now GLI tries to help a little to see if any common known command works out.

Location:

main/trunk/gli/src/org/greenstone/gatherer

Files:

• Gatherer.java (modified) (1 diff)
• GathererProg.java (modified) (1 diff)
• file/FileAssociationManager.java (modified) (2 diffs)
• util/StaticStrings.java (modified) (1 diff)

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

@@ -2056 +2056 @@
         }
     }
+
+    // Tests if a commandline program is installed
+    static public class ProgramInstalledTest implements SafeProcess.ExceptionHandler
+    {
+    private final String[] command;
+    private boolean returnValue = false;
+
+    public ProgramInstalledTest(String commandOnlyNoArgs) {
+        this.command = new String[]{ commandOnlyNoArgs, "--version" }; // --help also works for linux open commands   
+    }
     
-
+    public ProgramInstalledTest(String commandOnlyNoArgs, String basicTestParam) {
+        this.command = new String[]{ commandOnlyNoArgs, basicTestParam };
+    }
+    
+    public boolean found()
+    {
+        try {
+        SafeProcess file_open_test_process = new SafeProcess(command);
+        file_open_test_process.setExceptionHandler(this);
+        int exitValue = file_open_test_process.runBasicProcess();
+
+        // returns 0 if program installed and correct params passed in
+        // like --version/--help. Mostly returns 1 if wrong params passed in/launched wrong
+        // Both return values indicate the program is installed.
+        // e.g java --help or --version are wrong, as -help and -version are expected by java command.
+        // 127 is returned if program not installed     
+        this.returnValue = (exitValue == 0 || exitValue == 1); 
+        }
+        catch (Exception exception) {
+        this.returnValue = false;
+        }
+
+
+        // returnValue could have been set by an exception during SafeProcess.runBasicProcess()
+        // (see gotException()) so the returnValue is only being returned here at end of function
+        return this.returnValue;
+    }
+
+
+    public void gotException(Exception e) {
+        this.returnValue = false; // default program not found,
+        // or not working which works out the same for my purposes
+        
+        if (!(e instanceof IOException)) {
+        SafeProcess.log("Gatherer.ProgramInstalledTest: got exception" + e.getMessage(), e);
+        }
+    }
+    
+    public String toString() {
+        return command[0];
+    }
+    }
+    
     static public class WebswingAuthenticator
         extends GAuthenticator

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

@@ -114 +114 @@
         // creating and showing this application's GUI.
 
+
+    // Display all Java properties,
+    // https://stackoverflow.com/questions/228477/how-do-i-programmatically-determine-operating-system-in-java
+        //System.getProperties().list(System.out);
+
     SwingUtilities.invokeLater(new Runnable() {
             public void run() {

main/trunk/gli/src/org/greenstone/gatherer/file/FileAssociationManager.java

@@ -30 +30 @@
 import java.util.regex.*;
 import javax.swing.table.*;
+import org.greenstone.gatherer.Gatherer;
 import org.greenstone.gatherer.Configuration;
 import org.greenstone.gatherer.DebugStream;
@@ -74 +75 @@
             XMLTools.setValue(entry, StaticStrings.MAC_OPEN_COMMAND);
             }
-            //else { XMLTools.setValue(entry, StaticStrings.LINUX_OPEN_COMMAND); } // assume linux?
+            else { // On Linux, we need to discover which of a range of possible solutions
+            // works on this machine. If any works, we remember and use that choice
+            // for all file extensions for which no file association has been set yet.
+
+            // If we worked out the default linux file open command in a previous
+            // round of the FileAssociationManager loop, use it for the current file
+            // extension also
+
+            if(StaticStrings.LINUX_OPEN_COMMAND != null &&
+               !StaticStrings.LINUX_OPEN_COMMAND.equals("")) {
+
+                XMLTools.setValue(entry, StaticStrings.LINUX_OPEN_COMMAND);
+            } else if(StaticStrings.LINUX_OPEN_COMMAND == null) {
+                // StaticStrings.LINUX_OPEN_COMMAND not set yet: if we never tried to
+                // work out the default linux file launch command yet, then we'll test
+                // whether any known linux open command is available on this linux.
+
+                // xdg-open comes pre-installed on Ubuntu linux, but not on all linux
+                // https://www.cyberciti.biz/faq/unix-linux-command-to-view-file/
+                // Listing xdg-open 1st as it works on Ubuntu, reducing GLI load time
+                final String[] linux_open_cmds = {"xdg-open", "kde-open", "gnome-open"};
+                
+                for(String open_cmd : linux_open_cmds) {
+                Gatherer.ProgramInstalledTest installTest = new Gatherer.ProgramInstalledTest(open_cmd);
+                if(installTest.found()) {
+                    System.err.println("*********** Linux file open command " + installTest + " was found to be installed.");
+                    StaticStrings.LINUX_OPEN_COMMAND = open_cmd + " %1";
+                    XMLTools.setValue(entry, StaticStrings.LINUX_OPEN_COMMAND);
+                    break;
+                } else {
+                    System.err.println("*********** Linux file open command " + installTest + " was not installed.");
+                }
+                }
+
+                // either we have a default linux open command or not
+                // If we don't, set it to empty, so we don't work out
+                // linux value for each file extension (for each time
+                // FileAssociationManager is called) hereafter.
+                if(StaticStrings.LINUX_OPEN_COMMAND == null) {
+                StaticStrings.LINUX_OPEN_COMMAND = "";
+                }
+            }
+            // else StaticStrings.LINUX_OPEN_COMMAND = ""; which means
+            // we could never work out a feasible file open command on this linux
+            }
         }
         command = null;

main/trunk/gli/src/org/greenstone/gatherer/util/StaticStrings.java

@@ -193 +193 @@
     static final public String LEVELS_STR = "levels";
     static final public String LIBRARY_URL_ARGUMENT = "-library_url";
-    static final public String LINUX_OPEN_COMMAND = "xdg-open %1";
+    static public String LINUX_OPEN_COMMAND; // can't be final, set conditionally in FileAssociationManager
+    // to one of xdg-open/kde-open/gnome-open whichever worked, or "" if none
     static final public String LOCAL_LIBRARY_ARGUMENT = "-local_library";
     static final public String LOAD_ARGUMENT = "-load";