Changeset 31582

Timestamp:

2017-04-06T19:15:55+12:00 (7 years ago)

Author:

ak19

Message:

In place of the Input- and OutputStreamGobbler classes, am now shifting GLI code to use SafeProcess too, copied across from GS3 src code. Class SafeProcess includes the two streamgobblers as static inner classes and some more functionality with safely running an external process from Java.

Location:

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

Files:

• gui/ConfigFileEditor.java (modified) (1 diff)
• gui/DownloadPane.java (modified) (2 diffs)
• gui/FormatConversionDialog.java (modified) (3 diffs)
• util/GS3ServerThread.java (modified) (1 diff)
• util/InputStreamGobbler.java (deleted)
• util/OutputStreamGobbler.java (deleted)
• util/SafeProcess.java (added)
• util/Utility.java (modified) (5 diffs)

main/trunk/gli/src/org/greenstone/gatherer/gui/ConfigFileEditor.java

@@ -29 +29 @@
 import org.greenstone.gatherer.Dictionary;
 import org.greenstone.gatherer.Gatherer;
-import org.greenstone.gatherer.cdm.CollectionConfigXMLReadWrite;
-import org.greenstone.gatherer.util.Codec;
-import org.greenstone.gatherer.util.InputStreamGobbler;
-import org.greenstone.gatherer.util.OutputStreamGobbler;
 import org.greenstone.gatherer.util.StaticStrings;
 import org.greenstone.gatherer.util.Utility;

main/trunk/gli/src/org/greenstone/gatherer/gui/DownloadPane.java

@@ -52 +52 @@
 import org.greenstone.gatherer.file.WorkspaceTree;
 import org.greenstone.gatherer.greenstone.LocalGreenstone;
+import org.greenstone.gatherer.util.SafeProcess;
 import org.greenstone.gatherer.util.StaticStrings;
 import org.greenstone.gatherer.util.Utility;
@@ -281 +282 @@
     } 
     finally {
-        Utility.closeProcess(process);
+        SafeProcess.closeProcess(process);
     }
 

main/trunk/gli/src/org/greenstone/gatherer/gui/FormatConversionDialog.java

@@ -31 +31 @@
 import org.greenstone.gatherer.cdm.CollectionConfigXMLReadWrite;
 import org.greenstone.gatherer.util.Codec;
-import org.greenstone.gatherer.util.InputStreamGobbler;
-import org.greenstone.gatherer.util.OutputStreamGobbler;
+import org.greenstone.gatherer.util.SafeProcess;
 import org.greenstone.gatherer.util.StaticStrings;
 import org.greenstone.gatherer.util.XMLTools;
@@ -317 +316 @@
       }*/
 
+    SafeProcess prcs = new SafeProcess(command_args);
+    prcs.setInputString(inputstr);
+    prcs.setSplitStdErrorNewLines(true);
+    prcs.runProcess();
+    // process done, now get process output
+    outputstr = prcs.getStdOutput();
+    String errmsg = prcs.getStdError();
+    if(!errmsg.equals("")) {
+        System.err.println("*** Process errorstream: \n" + errmsg + "\n****");
+    }
+
+    ///System.err.println("#### Got output: " + outputstr);
+
+    /*
     try {       
         
@@ -363 +376 @@
         //ie.printStackTrace();
     }
-
+    */
     return outputstr;
     }

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

@@ -86 +86 @@
             // And we'll catch the error and output streams to prevent them from blocking during waitFor()
             // (For normal input and output stream handling using the Gobblers, see FormatConversionDialog.java)
-            OutputStreamGobbler inputGobbler = new OutputStreamGobbler(p.getOutputStream(), null);          
-            InputStreamGobbler errorGobbler = new InputStreamGobbler(p.getErrorStream(), true);
-            InputStreamGobbler outputGobbler = new InputStreamGobbler(p.getInputStream());
+            SafeProcess.OutputStreamGobbler inputGobbler
+                = new SafeProcess.OutputStreamGobbler(p.getOutputStream(), null);           
+            SafeProcess.InputStreamGobbler errorGobbler
+                = new SafeProcess.InputStreamGobbler(p.getErrorStream(), true);
+            SafeProcess.InputStreamGobbler outputGobbler
+                = new SafeProcess.InputStreamGobbler(p.getInputStream());
             
             errorGobbler.start();

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

@@ -41 +41 @@
 // Don't even think about adding import java.awt.* here!
 // The functions in this class should not use any graphical classes. Put your function somewhere else buster!
-import java.io.Closeable;
 import java.io.*;
 import java.net.*;
@@ -50 +49 @@
 // Don't even think about adding import org.greenstone.gatherer.Gatherer in here!
 // The functions in this class should be independent of the Gatherer class. Put your function somewhere else buster!
-
+import org.greenstone.gatherer.util.SafeProcess; // for the closeResource() static method
 
 /** To provide a library of common methods, in a static context, for use in the Gatherer.
@@ -74 +73 @@
     static final public String PERL_EXECUTABLE_WINDOWS = "Perl.exe";
 
+    /** Platform independent NEWLINE character */
+    public static final String NEWLINE;    
+    
+    // NEWLINE related code copied across from GS3 src code
+    // Before Java 7, no System.lineSeparator() or System.getProperty("line.separator")
+    // And on local linux, am compiling with JDK 6, so need this.
+    // http://stackoverflow.com/questions/207947/how-do-i-get-a-platform-dependent-new-line-character
+    // http://stackoverflow.com/questions/2591083/getting-java-version-at-runtime
+    // https://www.tutorialspoint.com/java/lang/package_getspecificationversion.htm
+    // https://docs.oracle.com/javase/tutorial/essential/environment/sysprop.html
+    // Can initialise static final vars on declaration or in static initialisation code block
+    // http://stackoverflow.com/questions/2339932/java-can-final-variables-be-initialized-in-static-initialization-block
+    // Initialise object member final vars on declaration or in constructors
+    static {    
+    double java_version = Double.parseDouble(System.getProperty("java.specification.version"));
+    if(java_version >= 1.7) {
+        NEWLINE = System.getProperty("line.separator");
+    } else {
+        NEWLINE = isWindows() ? "\r\n" : "\n";
+    }   
+    }
 
     /** 
@@ -93 +113 @@
         System.err.println("*** Exception occurred: " + e.getMessage());
     } finally {
-        closeResource(fin);     
+        SafeProcess.closeResource(fin);     
     }
 
@@ -575 +595 @@
         System.err.println("Exception occurred: " + e.getMessage());
     } finally {
-        closeResource(fin);
-        closeResource(fout);        
+        SafeProcess.closeResource(fin);
+        SafeProcess.closeResource(fout);        
         
     }
     return oldValue;
     }
-
-    // For safely closing streams/handles/resources. 
-    // For examples of use look in the Input- and OutputStreamGobbler classes.
-    // http://docs.oracle.com/javase/tutorial/essential/exceptions/finally.html
-    // http://stackoverflow.com/questions/481446/throws-exception-in-finally-blocks
-    public static void closeResource(Closeable resourceHandle) {
-    try {
-        if(resourceHandle != null) {
-        resourceHandle.close();
-        resourceHandle = null;
-        }
-    } catch(Exception e) {
-        System.err.println("Exception closing resource: " + e.getMessage());
-        e.printStackTrace();
-        resourceHandle = null;
-    }
-    }
-
-    public static void closeProcess(Process prcs) {
-    if( prcs != null ) { 
-        closeResource(prcs.getErrorStream()); 
-        closeResource(prcs.getOutputStream()); 
-        closeResource(prcs.getInputStream()); 
-        prcs.destroy(); 
-    } 
-    }
 }