Changeset 5038

Timestamp:

2003-07-25T16:36:39+12:00 (21 years ago)

Author:

jmt12

Message:

Added some extra feedback about what is happening during import process. Also changed it so writing to the log textarea happens on its own thread.

File:

• trunk/gli/src/org/greenstone/gatherer/shell/GShell.java (modified) (14 diffs)

trunk/gli/src/org/greenstone/gatherer/shell/GShell.java

@@ -45 +45 @@
 import org.greenstone.gatherer.shell.GShellListener;
 import org.greenstone.gatherer.shell.GShellProgressMonitor;
+import org.greenstone.gatherer.util.StaticStrings;
 /** The <strong>GShell</strong> is reponsible for running a separately threaded process in the command shell. This is necessary for executing the Perl Scripts and also for other system related funcitonality.
  */
@@ -118 +119 @@
     /** Any threaded class must include this method to allow the thread body to be run.
       */
+    private MessageDispatcher dispatcher;
     public void run() {
+    // Create a new message dispatcher to merge then send off messages at a predetermined rate.
+    dispatcher = new MessageDispatcher(250);
+    dispatcher.start();
     // Setup
     if(progress != null) {
@@ -125 +130 @@
     // Determine if the user has asked for an outfile.
     String out_name = null;
-    FileOutputStream fos = null;
-    BufferedOutputStream bos = null;
     if(type == IMPORT || type == BUILD) {
         if(type == IMPORT) {
@@ -139 +142 @@
             if(out.exists()) {
             boolean append = true;
-            fos = new FileOutputStream(out, append);
-            bos = new BufferedOutputStream(fos);
+            dispatcher.setBOS(new BufferedOutputStream(new FileOutputStream(out, append)));
             }
         } 
@@ -151 +153 @@
     fireProcessBegun(type, status);
     try {
+
         String command = "";
         for(int i = 0; i < args.length; i++) {
         command = command + args[i] + " ";
         }
-                ///ystem.err.println("Command: " + command);
-        fireMessage(type, get("Command") + ": " + command, status);
-        message(Message.EVENT, get("Command") + ": " + command);
+        ///ystem.err.println("Command: " + command);
+        dispatcher.standardMessage(type, get("Command") + ": " + command, status);
                 
         Runtime rt = Runtime.getRuntime();
@@ -165 +167 @@
         BufferedReader ebr = new BufferedReader( eisr );
         BufferedReader stdinbr = new BufferedReader( stdinisr );
-                // Captures the std err of a program and pipes it into
-                // std in of java
+        // Captures the std err of a program and pipes it into std in of java
         String eline = null;
         String stdinline = null;
@@ -174 +175 @@
             progress.parse(eline);
             }
-            if(bos != null) {
-            bos.write(eline.getBytes(), 0, eline.length());
-            }
-            ///ystem.err.println("stderr: " + eline);
-            fireMessage(type, typeAsString(type) + "> " + eline, 
-                status);
-            message(Message.INFO, eline);
+            dispatcher.errorMessage(type, typeAsString(type) + "> " + eline, status);
         }
         if(stdinline != null) {
-            if(bos != null) {
-            //bos.write(stdinline.getBytes(), 0, stdinline.length());
-            }
-            ///ystem.err.println("stdin: " + stdinline);
-            fireMessage(type, typeAsString(type) + "> " + stdinline,
-                status);
-            message(Message.INFO, stdinline);
+            dispatcher.standardMessage(type, typeAsString(type) + "> " + stdinline, status);
+            
         }
         }
@@ -199 +189 @@
         if(prcs.exitValue() == 0) {
             status = OK;
-            fireMessage(type, typeAsString(type) + "> " + get("Success"), status);
-            message(Message.MAIN, get("Success"));
+            dispatcher.standardMessage(type, typeAsString(type) + "> " + get("Success"), status);
+            
         } else {
             status = ERROR;
-            fireMessage(type, typeAsString(type) + "> " + get("Failure"), status);
-            message(Message.ERROR, get("Failure"));
+            dispatcher.standardMessage(type, typeAsString(type) + "> " + get("Failure"), status);
+            
         }
         }
@@ -216 +206 @@
     // Exception
     catch (Exception error) {
-        message(Message.ERROR, get("Failure"));
-        message(Message.ERROR, error.toString());
         Gatherer.printStackTrace(error);
         status = ERROR;
@@ -223 +211 @@
     // If no error occured, and this was an import process we now extract any new metadata from the archive directory.
     if(status == OK && type == IMPORT) {
-        fireMessage(type, typeAsString(type) + "> " + get("Parsing_Metadata_Start"), status);
+        dispatcher.standardMessage(type, typeAsString(type) + "> " + get("Parsing_Metadata_Start"), status);
         new GreenstoneArchiveParser(progress, this);
-        fireMessage(type, typeAsString(type) + "> " + get("Parsing_Metadata_Complete"), status);
+        dispatcher.standardMessage(type, typeAsString(type) + "> " + get("Parsing_Metadata_Complete"), status);
     }
     // Tidy up.
@@ -231 +219 @@
         progress.stop();
     }
-    if(bos != null) {
-        try {
-        bos.close();
-        }
-        catch (Exception e) {
-        }
-    }
     // We're done.
     fireProcessComplete(type, status);
+    dispatcher.processComplete();
+    dispatcher = null;
     }
     /** Method for firing a message to all interested listeners.
@@ -255 +238 @@
     }
     }
+
+    public void message(int type, String message, int status) {
+    if(dispatcher != null) {
+        dispatcher.standardMessage(type, message, status);
+    }
+    }
+
     /** Method for firing a process begun event which is called, strangly enough, when the process begins.
       * @param type An <strong>int</strong> indicating the process type.
@@ -301 +291 @@
     return has_signalled_stop;
     }
-    /** Creates and dispatches a message given the initial details.
-      * @param level An <strong>int</strong> indicating the message level for this message.
-      * @param message A <strong>String</strong> which contains the payload of this message.
-      */
-    private void message(int level, String message) {
-    Message msg = new Message(msg_type, level, message);
-    if(Gatherer.g_man != null) {
-        Gatherer.log.add(msg);
-    }
-    }
+
     /** Converts a type into a text representation.
       * @param type An <strong>int</strong> which maps to a shell process type.
@@ -332 +313 @@
     return name;
     }
+
+    /** Rather than bombard the progress logs with thousands of individual lines, which can actually slow build times by 200-1000%, we instead fire off quarter second updates with all of the strings retrieved in that time, if any. */
+    private class MessageDispatcher
+    extends Thread {
+    private boolean process_complete;
+    private BufferedOutputStream bos;
+    private int last_status;
+    private int last_type;
+    private int wait_time;
+    private StringBuffer bos_buffer;
+    private StringBuffer buffer;
+    public MessageDispatcher(int wait_time) {
+        this.bos = bos;
+        this.bos_buffer = new StringBuffer();
+        this.buffer = new StringBuffer();
+        this.process_complete = false;
+        this.wait_time = wait_time;
+    }
+
+    public synchronized void errorMessage(int type, String message, int status) {
+        buffer.append(message);
+        buffer.append(StaticStrings.NEW_LINE_CHARACTER);
+        if(bos != null) {
+        bos_buffer.append(message);
+        bos_buffer.append(StaticStrings.NEW_LINE_CHARACTER);
+        }
+        last_status = status;
+        last_type = type;
+    }
+
+    public void processComplete() {
+        process_complete = true;
+    }
+
+    public void run() {
+        while(!process_complete) {
+        try {
+            wait(wait_time);
+        }
+        catch(Exception error) {
+        }
+        message();
+        }
+        // If there is still something in buffer send it
+        message();
+        // Close bos if it exists
+        if(bos != null) {
+        try {
+            bos.close();
+        }
+        catch (Exception e) {
+        }
+        }
+    }
+
+    public void setBOS(BufferedOutputStream bos) {
+        this.bos = bos;
+    }
+
+    public synchronized void standardMessage(int type, String message, int status) {
+        buffer.append(message);
+        buffer.append(StaticStrings.NEW_LINE_CHARACTER);
+        last_status = status;
+        last_type = type;
+    }
+
+    private synchronized void message() {
+        if(bos != null && bos_buffer.length() > 0) {
+        try {
+            bos.write(bos_buffer.toString().getBytes(), 0, bos_buffer.length());
+        }
+        catch(Exception error) {
+            Gatherer.printStackTrace(error);
+        }
+        bos_buffer.delete(0, bos_buffer.length());
+        }
+        if(buffer.length() > 0) {
+        fireMessage(last_type, buffer.toString(), last_status);
+        buffer.delete(0, buffer.length());
+        }
+    }
+    }
 }