Changeset 31776

Timestamp:

2017-07-05T20:43:44+12:00 (7 years ago)

Author:

ak19

Message:

Kathy described a problem on the mailing list about the AutoLoadConverters msg appearing before XML content when connecting with a client-GLI to a remote GS3, which breaks parsing of the XML. (I found it was present in my GS3 installation from 4 May 2016.) I've narrowed it down to running client-gli with the debug flag turned on, which seemed related to the same problem I'd seen when running gli -debug after the change to SafeProcess in Plugins.java, which I fixed by removing lines preceding XML content before parsing the XML. For client-gli, SafeProcess isn't used which is also why the problem with client-gli is much older, but I'm now using a common and existing solution for both: doing what Plugins.java used to do before the change to SafeProcess, which is call XMLTools.readXMLStream(), which would parse out content before XML. The RemoteGreenstoneServer should only call this method if it actually has some XML content it's dealing with. Could have solved this in RemoteGreenstoneServerAction.java's GetScriptOptions, but am solving it in RemoteGreenstoneServer's sendCommandToServerInternal, since there may be many Actions returning XML, not just GetScriptOptions.

Location:

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

Files:

• greenstone/Plugins.java (modified) (4 diffs)
• remote/RemoteGreenstoneServer.java (modified) (2 diffs)
• util/XMLTools.java (modified) (1 diff)

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

@@ -165 +165 @@
         // Create the process.
         SafeProcess process = new SafeProcess((String[]) args.toArray(new String[] { }));
+        process.setSplitStdErrorNewLines(true);
 
         // run the SafeProcess
@@ -174 +175 @@
         // get the result: We expect XML to have come out of the process std error stream.
         pluginfo_xml = process.getStdError();
+        // make sure to have parsed out any lines preceding the XML content
+        pluginfo_xml = XMLTools.readXMLStream(pluginfo_xml).toString();
         ///System.err.println("*********\nPluginInfo, got:\n" + pluginfo_xml + "\n**********\n");
         }
@@ -236 +239 @@
         args.add("-listall");
         args.add("-xml");
-
+        
         // Run the pluginfo.pl process:
         // Create the process.
         SafeProcess process = new SafeProcess((String[]) args.toArray(new String[] { }));
+        process.setSplitStdErrorNewLines(true);
 
         // run the SafeProcess
@@ -249 +253 @@
         // get the result: We expect XML to have come out of the process std error stream.  
         xml = process.getStdError();
-
+        // make sure to parse out any lines before the XML content, else running "gli -debug" results in an XML error:
         // for pluginfo.pl -listall, we see a "AutoloadConverters" (PDFBox) message
-        // before actual XML output, which breaks XML parsing. Get rid of output before "<?xml"
-        int startIndex = xml.indexOf("<?xml");
-        if(startIndex != 0) {
-            xml = xml.substring(startIndex);
-        }
+        // before actual XML output, which breaks XML parsing. 
+        // This gets rid of output before "<?xml" in the way that the code did before the change to SafeProcess
+        // Then we can call the same from method RemoteGreenstoneServer.java, so that running "client-gli -debug"
+        // will work too.
+        xml = XMLTools.readXMLStream(xml).toString();
+        
         ///System.err.println("*********\nPluginsList, got:\n" + xml + "\n**********\n");
         }

main/trunk/gli/src/org/greenstone/gatherer/remote/RemoteGreenstoneServer.java

@@ -44 +44 @@
 import org.greenstone.gatherer.util.UnzipTools;
 import org.greenstone.gatherer.util.Utility;
+import org.greenstone.gatherer.util.XMLTools;
 import org.apache.commons.httpclient.HttpClient;
 import org.apache.commons.httpclient.methods.PostMethod;
@@ -682 +683 @@
     gliserver_in.close();
 
+    
+    int startIndex = command_output_buffer.indexOf("<?xml");
+    if(startIndex > 0) { // not -1, so "<?xml" is present, and not 0, so not at start
+
+        // iff dealing with XML, make sure to parse out any lines preceding the XML content
+        command_output_buffer = XMLTools.readXMLStream(command_output_buffer.toString());
+        /*if(DebugStream.isDebuggingEnabled()) {
+        String prefix = command_output_buffer.substring(0, startIndex);
+        DebugStream.println("Removing the following found before start of XML:");
+        DebugStream.println("---------------------------------");
+        DebugStream.println(prefix);
+        DebugStream.println("---------------------------------");
+        }
+        // remove the prefix
+        return command_output_buffer.substring(startIndex); // remove anything before the start of XML
+        */
+    }
+    
     return command_output_buffer.toString();
     }

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

@@ -733 +733 @@
     static public StringBuffer readXMLStream(InputStream input_stream)
     {
+        StringBuffer xml = new StringBuffer("");
+        try {
+        InputStreamReader isr = new InputStreamReader(input_stream, "UTF-8");
+        xml = XMLTools.readXMLStream(new InputStreamReader(input_stream, "UTF-8"));
+        } catch (UnsupportedEncodingException error) {
+        System.err.println("Failed when trying to parse XML stream");
+        error.printStackTrace();
+        }
+        
+        return xml;
+    }
+
+    static public StringBuffer readXMLStream(String s) {
+    return XMLTools.readXMLStream(new StringReader(s));
+    }
+
+
+    static public StringBuffer readXMLStream(Reader reader)
+    {
         StringBuffer xml = new StringBuffer("");
 
         try
         {
-            InputStreamReader isr = new InputStreamReader(input_stream, "UTF-8");
-            BufferedReader buffered_in = new BufferedReader(isr);
+            BufferedReader buffered_in = new BufferedReader(reader);
 
             String line = "";