Changeset 6325

Timestamp:

2003-12-19T14:54:25+13:00 (20 years ago)

Author:

jmt12

Message:

Rewrote GImportProgressMonitor to use the new GLI argument based messages from the import script - which are separate from multilingual issues. This required several changes to GShell, GShellEvents, and everything that makes use of them

Location:

trunk/gli/src/org/greenstone/gatherer

Files:

• collection/Collection.java (modified) (1 diff)
• collection/CollectionManager.java (modified) (2 diffs)
• msm/GreenstoneArchiveParser.java (modified) (1 diff)
• shell/GBasicProgressMonitor.java (modified) (2 diffs)
• shell/GBuildProgressMonitor.java (modified) (2 diffs)
• shell/GImportProgressMonitor.java (modified) (6 diffs)
• shell/GShell.java (modified) (13 diffs)
• shell/GShellEvent.java (modified) (2 diffs)
• shell/GShellProgressMonitor.java (modified) (2 diffs)

trunk/gli/src/org/greenstone/gatherer/collection/Collection.java

@@ -309 +309 @@
         count++;
     }
-    for(int i = 0; i < node.getChildCount(); i++) {
+    for(int i = 0; !file.getName().equals("CVS") && i < node.getChildCount(); i++) {
         count = count + getCount(node.getChildAt(i), count_folders, count_files);
     }

trunk/gli/src/org/greenstone/gatherer/collection/CollectionManager.java

@@ -745 +745 @@
         String args[];
         if(Utility.isWindows()) {
-        args = new String[6];
+        args = new String[7];
         args[0] = Gatherer.config.perl_path;
         args[1] = "-S";
         args[2] = Gatherer.config.getScriptPath() + "import.pl";
-        args[3] = "-importdir";
-        args[4] = collection_import;
-        args[5] = collection.getName();
+        args[3] = "-gli";
+        args[4] = "-importdir";
+        args[5] = collection_import;
+        args[6] = collection.getName();
         }
         else {
-        args = new String[4];
+        args = new String[5];
         args[0] = Gatherer.config.getScriptPath() + "import.pl";
-        args[1] = "-importdir";
-        args[2] = collection_import;
-        args[3] = collection.getName();
+        args[1] = "-gli";
+        args[2] = "-importdir";
+        args[3] = collection_import;
+        args[4] = collection.getName();
         }
         collection_import = null;
@@ -1091 +1093 @@
         }
         WarningDialog collection_built_warning_dialog = new WarningDialog("warning.CollectionBuilt", false);
+        collection_built_warning_dialog.setMessageOnly(true); // Not a warning
         collection_built_warning_dialog.display();
         collection_built_warning_dialog.dispose();

trunk/gli/src/org/greenstone/gatherer/msm/GreenstoneArchiveParser.java

@@ -88 +88 @@
             args[0] = document_directories[i].getName();
             args[1] = String.valueOf(count);
-            shell.fireMessage(GShell.IMPORT, shell.typeAsString(GShell.IMPORT) + "> " + Dictionary.get("GShell.Extracted", args), GShell.OK);
+            shell.fireMessage(GShell.IMPORT, shell.typeAsString(GShell.IMPORT) + "> " + Dictionary.get("GShell.Extracted", args), GShell.OK, null);
             args = null;
             progress.increment();

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

@@ -49 +49 @@
 import java.awt.Component;
 import javax.swing.JProgressBar;
+import org.greenstone.gatherer.shell.GShellEvent;
 import org.greenstone.gatherer.shell.GShellProgressMonitor;
 
@@ -91 +92 @@
     }
     /** The parse method is how more complex progress bars figure out how far they have progressed. However we don't.
-     * @param line A String representing the latest line of output from
-     * the external process we are monitoring.
+     * @param event a GShellEvent containing information from the GShell
      */
-    public void parse(String line) {
+    public void process(GShellEvent event) {
     }
 

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

@@ -42 +42 @@
 import org.greenstone.gatherer.cdm.CollectionDesignManager;
 import org.greenstone.gatherer.shell.GImportProgressMonitor;
+import org.greenstone.gatherer.shell.GShellEvent;
 import org.greenstone.gatherer.shell.GShellProgressMonitor;
 /** This implementation of <i>GShellProgressMonitor</i> is designed to parse and translate the progress of a buildcol.pl call.
@@ -150 +151 @@
 
     /** This method is used to 'feed in' a line of text captured from the process.
-     * @param line A <strong>String</strong> of text captured from either standard out or standard error.
-     */
-    public void parse(String raw_line) {
-    String line = raw_line.toLowerCase();
+     * @param event a GShellEvent containing information from the GShell
+     */
+    public void process(GShellEvent event) {
+    String line = event.getMessage().toLowerCase();
     // We first check if we can parse, which depends on num_docs > 0 and num_indexes > 0.
     if(num_docs > 0 && num_indexes > 0) {

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

@@ -43 +43 @@
 import org.greenstone.gatherer.Gatherer;
 import org.greenstone.gatherer.shell.GShellProgressMonitor;
+import org.greenstone.gatherer.util.StaticStrings;
 
 /** This implementation of <i>GShellProgressMonitor</i> is designed to parse and translate the progress of a import.pl call.
@@ -50 +51 @@
 public class GImportProgressMonitor
     implements GShellProgressMonitor {
+    /** Indicates if the progress bar is currently showing a string. */
+    private boolean showing_string = false;
     /** Indicates if the GUI has asked the process this object monitors to stop. */
     private boolean stop = false;
-    private int file_num = 0;
+    /** A count of the extracted files processed so far. */
+    private int extracted_file_count;
+    /** The number of documents processed (or rejected) so far. */
+    private int file_count;
+    /** The next value to be set for the progress bar - I use this rather than a compounding progress measure to try to limit rounding inaccuracies (nothing looks worse than the progress bar having to jump the last 10-15%) */
+    private int next_progress_value;
     /** The number of files expected to be scanned by this import process. */
-    private int num_files = 0;
+    private int num_expected_docs;
     /** This holds the number of documents actually processed by the import command, as garnered from the final block of text output. */
-    private int num_docs = 0;
+    private int num_docs;
     /** The progress bar this monitor updates. */
     private JProgressBar progress_bar;
-    /** The maximum value for this progress bar. */
-    static final private int MAX = 1000000;
+    /** */
+    static final private String C = "c";
+    /** */
+    static final private String N = "n";
+    /** */
+    static final private String P = "p";
+    /** The fixed portion of the progress bar used for the calculating of file size and other pre-import functions. */
+    static final private int CALCULATION = 50000;
+    /** The fixed portion of the progress bar used for extracted metadata. */
+    static final private int EXTRACTED = 200000;
     /** The minimum value for this progress bar. */
     static final private int MIN = 0;
-    /** A String fragment which is used to determine if the current output process line is referring to the number of documents actually processed by the import script. */
-    static final private String NUM_DOCS_PROCESSED = "processed and included in the collection";
-    /** The Sentinel value is the String fragment an output process line must start with to be considered a milestone. In this case we are counting directories, so the fragment refers to a directory scan. */
-    static final private String SENTINEL = "recplug - ";
+    /** The fixed portion of the progress bar used for processed documents. */
+    static final private int PROCESSED = 750000;
+    /** The element name of a file detected message. */
+    static final private String FILE = "File";
+    /** The element name of a file processing message. */
+    static final private String FILE_PROCESSING = "Processing";
+    /** The element name of an import complete message. */
+    static final private String IMPORT_COMPLETE = "ImportComplete";
 
     public GImportProgressMonitor() {
     progress_bar = new JProgressBar();
     progress_bar.setIndeterminate(false);
-    progress_bar.setMaximum(MAX);
+    progress_bar.setMaximum(CALCULATION + PROCESSED + EXTRACTED);
     progress_bar.setMinimum(MIN);
     progress_bar.setStringPainted(true);
     progress_bar.setValue(MIN);
+    next_progress_value = CALCULATION;
     }
 
@@ -82 +103 @@
     public void addProgressBar(JProgressBar progress_bar) {
     this.progress_bar = progress_bar;
-    progress_bar.setMaximum(MAX);
+    progress_bar.setMaximum(CALCULATION + PROCESSED + EXTRACTED);
     progress_bar.setMinimum(MIN);
     progress_bar.setValue(MIN);
+    next_progress_value = CALCULATION;
     }
 
@@ -120 +142 @@
     /** Inform the progress bar that it should programatically increment progress by one step. This is only called during the metadata archive extraction so each step should be (1000000 / 5) / num_docs. */
     public void increment() {
-    if(num_docs > 0) {
-        progress_bar.setValue(progress_bar.getValue() + ((MAX / 5) / num_docs));
+    extracted_file_count++;
+    // The current progress is calculated to be:
+    // The fixed calculation value plus the fixed processed value plus some portion of the fixed extracted value. This portion is the extracted_file_count over the total number of documents available. Note that this breaks badly for bibliographical files (for now).
+    progress_bar.setValue(CALCULATION + PROCESSED + ((EXTRACTED * extracted_file_count) / num_docs));
+    }
+
+    /** This method is used to 'feed in' a line of text captured from the process.
+     * @param event the GShellEvent containing a message or other important shell information
+     */
+    public void process(GShellEvent event) {
+    // We're into parsing output, so we don't need the 'calculating file size' etc string.
+    if(showing_string) {
+        progress_bar.setString("");
+        showing_string = false;
     }
-    // else {
-    // progress_bar.setIndeterminate(true);
-    // }
-    }
-
-    /** This method is used to 'feed in' a line of text captured from the process.
-     * @param line A <strong>String</strong> of text captured from either standard out or standard error.
-     * TODO Everthing.
-     */
-    public void parse(String line_raw) {
-    progress_bar.setString("");
-    String line = line_raw.toLowerCase();
-    if (line.indexOf(SENTINEL) == 0) {
-        file_num = file_num + 1;
-        ///ystem.err.println("Done " + file_num + " of " + num_files + "...");
-        if (num_files > 0) {
-        int base_val = MAX / 10;
-        progress_bar.setValue(((((7 * MAX) / 10) * file_num) / num_files) + base_val);
+    // Remove 'import.pl> ' bit
+    String line = event.getMessage();
+    line = line.substring(line.indexOf(StaticStrings.GREATER_THAN_CHARACTER) + 1);
+    line = line.trim();
+    ///ystem.err.println("message = " + line);
+    if(line.startsWith(StaticStrings.LESS_THAN_CHARACTER) && line.endsWith(StaticStrings.GREATER_THAN_CHARACTER)) {
+        line = line.substring(1, line.length() - 1);
+        // We may be reading a file. Remember we have to offset process as we recieve this message 'before' a document is processed. Hence the use of 'next_progress_value'
+        if(line.startsWith(FILE)) {
+        file_count++;
+        ///ystem.err.println("File #" + file_count);
+        // Set the next progress
+        progress_bar.setValue(next_progress_value);
+        // Now we calculate the next progress value
+        next_progress_value = CALCULATION + ((PROCESSED * file_count) / num_expected_docs);
         }
-    }
-    else if (line.indexOf(NUM_DOCS_PROCESSED) != -1) {
-        num_docs = -1;
-        StringTokenizer tokenizer = new StringTokenizer(line);
-        while(num_docs == -1 && tokenizer.hasMoreTokens()) {
-        String pos_num_docs_str = tokenizer.nextToken();
-        try {
-            num_docs = Integer.parseInt(pos_num_docs_str);
+        // Or we're being told what plugin is actually processing the file
+        else if(line.startsWith(FILE_PROCESSING)) {
+        // If we are at lower mode settings fire a new 'dumbed down' event
+        /** @todo */
+        }
+        // Or the import complete element
+        else if(line.startsWith(IMPORT_COMPLETE)) {
+        // Set the next progress
+        progress_bar.setValue(next_progress_value);
+        // Determine the number of documents processed by using the 'p' attribute
+        StringTokenizer tokenizer = new StringTokenizer(line);
+        boolean found = false;
+        String token = tokenizer.nextToken(); // Drop the element name
+        while(tokenizer.hasMoreTokens() && !found) {
+            token = tokenizer.nextToken();
+            if(token.startsWith(P)) {
+            found = true;
+            try {
+                String num_docs_string = token.substring(3, token.length() - 1);
+                num_docs = Integer.parseInt(num_docs_string);
+            }
+            catch(Exception exception) {
+                Gatherer.println("Exception in GImportProgressMonitor.process() - Expected");
+                Gatherer.printStackTrace(exception);
+            }
+            }
         }
-        catch (Exception error) {
-        }
+        tokenizer = null;
+        // If we are at lower mode settings fire a new 'dumbed down' event
+        /** @todo */
         }
-        ///ystem.err.println("Parsed num_docs to be " + num_docs);
+
+
+        // We also veto this event to prevent other classes handling it (we ensure progress monitors are called first).
+        event.veto();
     }
     }
@@ -160 +213 @@
     public void saving() {
     progress_bar.setString(Dictionary.get("SaveProgressDialog.Title"));
-    progress_bar.setValue(MAX / (10 * 2));
+    showing_string = true;
     }
 
@@ -171 +224 @@
 
     /** This method resets this monitor to the start, reseting the process parsing and progress bar.
-     * TODO Everthing.
      */
     public void start() {
     progress_bar.setString(Dictionary.get("FileActions.Calculating_Size"));
-    progress_bar.setValue(MAX / 10);
-    num_files = Gatherer.c_man.getCollection().getDocumentCount();
-    ///ystem.err.println("Number of files: " + num_files);
-    file_num = 0;
+    showing_string = true;
+    extracted_file_count = 0;
+    file_count = 0;
+    next_progress_value = -1;
+    num_docs = -1;
+    num_expected_docs = Gatherer.c_man.getCollection().getCount();
     }
 
     /** This method indicates the process is complete. 
-     * TODO Everthing.
      */
     public void stop() {
-    progress_bar.setValue(MAX);
+    progress_bar.setValue(CALCULATION + PROCESSED + EXTRACTED);
     }
 }

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

@@ -145 +145 @@
     /** Any threaded class must include this method to allow the thread body to be run. */
     public void run() {
-    if(progress != null) {
-        progress.start();
-    }
     // Determine if the user has asked for an outfile.
     String out_name = null;
@@ -175 +172 @@
         }
         ///ystem.err.println("Command: " + command);
-        fireMessage(type, Dictionary.get("GShell.Command") + ": " + command, status);
+        fireMessage(type, Dictionary.get("GShell.Command") + ": " + command, status, null);
         
         Runtime rt = Runtime.getRuntime();
@@ -196 +193 @@
                 String eline = eline_buffer.toString();
                 ///atherer.println("* " + eline + " *");
-                if(progress != null) {
-                progress.parse(eline);
-                }
-                if(bos != null) {
-                try {
-                    bos.write(eline.getBytes(), 0, eline.length());
-                }
-                catch(Exception error) {
-                    Gatherer.printStackTrace(error);
-                }
-                }
-                fireMessage(type, typeAsString(type) + "> " + eline, status);
+                fireMessage(type, typeAsString(type) + "> " + eline, status, bos);
                 eline = null;
                 eline_buffer = new StringBuffer();
@@ -224 +210 @@
                 String stdline = stdline_buffer.toString();
                 ///atherer.println("+ " + stdline + " +");
-                fireMessage(type, typeAsString(type) + "> " + stdline, status);
+                fireMessage(type, typeAsString(type) + "> " + stdline, status, null);
                 stdline = null;
                 stdline_buffer = new StringBuffer();
@@ -250 +236 @@
             String eline = eline_buffer.toString();
             ///atherer.println("* " + eline + " *");
-            if(progress != null) {
-                progress.parse(eline);
-            }
-            if(bos != null) {
-                try {
-                bos.write(eline.getBytes(), 0, eline.length());
-                }
-                catch(Exception error) {
-                Gatherer.printStackTrace(error);
-                }
-            }
-            fireMessage(type, typeAsString(type) + "> " + eline, status);
+            fireMessage(type, typeAsString(type) + "> " + eline, status, bos);
             eline = null;
             eline_buffer = new StringBuffer();
@@ -277 +252 @@
             String stdline = stdline_buffer.toString();
             ///atherer.println("+ " + stdline + " +");
-            fireMessage(type, typeAsString(type) + "> " + stdline, status);
+            fireMessage(type, typeAsString(type) + "> " + stdline, status, null);
             stdline = null;
             stdline_buffer = new StringBuffer();
@@ -291 +266 @@
         String eline = eline_buffer.toString();
         ///atherer.println("Last bit of eline: " + eline);
-        if(progress != null) {
-            progress.parse(eline);
-        }
-        if(bos != null) {
-            try {
-            bos.write(eline.getBytes(), 0, eline.length());
-            }
-            catch(Exception error) {
-            Gatherer.printStackTrace(error);
-            }
-        }
-        fireMessage(type, typeAsString(type) + "> " + eline, status);
+        fireMessage(type, typeAsString(type) + "> " + eline, status, bos);
         eline = null;
         }
@@ -309 +273 @@
         String stdline = stdline_buffer.toString();
         ///atherer.println("Last bit of stdline: " + stdline);
-        fireMessage(type, typeAsString(type) + "> " + stdline, status);
+        fireMessage(type, typeAsString(type) + "> " + stdline, status, null);
         stdline = null;
         }
@@ -319 +283 @@
         if(prcs.exitValue() == 0) {
             status = OK;
-            fireMessage(type, typeAsString(type) + "> " + Dictionary.get("GShell.Success"), status);
+            fireMessage(type, typeAsString(type) + "> " + Dictionary.get("GShell.Success"), status, null);
         }
         else {
             status = ERROR;
-            fireMessage(type, typeAsString(type) + "> " + Dictionary.get("GShell.Failure"), status);
+            fireMessage(type, typeAsString(type) + "> " + Dictionary.get("GShell.Failure"), status, null);
         }
         }
@@ -336 +300 @@
     }
     // Exception
-    catch (Exception error) {
-        Gatherer.printStackTrace(error);
+    catch (Exception exception) {
+        Gatherer.println("Exception in GShell.run() - unexpected");
+        Gatherer.printStackTrace(exception);
         status = ERROR;
     }
     // 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) + "> " + Dictionary.get("GShell.Parsing_Metadata_Start"), status);
+        fireMessage(type, typeAsString(type) + "> " + Dictionary.get("GShell.Parsing_Metadata_Start"), status, null);
         new GreenstoneArchiveParser(progress, this);
-        fireMessage(type, typeAsString(type) + "> " + Dictionary.get("GShell.Parsing_Metadata_Complete"), status);
-    }
-    // Tidy up.
-    if(progress != null) {
-        progress.stop();
+        fireMessage(type, typeAsString(type) + "> " + Dictionary.get("GShell.Parsing_Metadata_Complete"), status, null);
     }
     // We're done.
@@ -368 +329 @@
      * @param status An <strong>int</strong> specifying the current status of the process.
      */
-    public void fireMessage(int type, String message, int status) {
+    public void fireMessage(int type, String message, int status, BufferedOutputStream bos) {
     GShellEvent event = new GShellEvent(this, 0, type, message, status);
-    Object[] concerned = listeners.getListenerList();
-    for(int i = 0; i < concerned.length ; i++) {
-        if(concerned[i] == GShellListener.class) {
-        ((GShellListener)concerned[i+1]).message(event);
-        }
-    }
+    // If there is a progress monitor attached, pass the event to it first
+    if(progress != null) {
+        progress.process(event);
+    }
+    // If the event hasn't been vetoed, pass it on to other listeners
+    if(!event.isVetoed()) {
+        Object[] concerned = listeners.getListenerList();
+        for(int i = 0; i < concerned.length ; i++) {
+        if(concerned[i] == GShellListener.class) {
+            ((GShellListener)concerned[i+1]).message(event);
+        }
+        }
+        concerned = null;
+        // And if we have a buffered output stream from error messages, send the message there
+        if(bos != null) {
+        try {
+            bos.write(message.getBytes(), 0, message.length());
+        }
+        catch(Exception exception) {
+            Gatherer.println("Exception in GShell.fireMessage() - unexpected");
+            Gatherer.printStackTrace(exception);
+        }
+        }
+    }
+    event = null;
     }
 
@@ -383 +363 @@
      */
     protected void fireProcessBegun(int type, int status) {
+    // Start the progres monitor if available
+    if(progress != null) {
+        progress.start();
+    }
+    // Fire an event
     GShellEvent event = new GShellEvent(this, 0, type, "", status);
     Object[] concerned = listeners.getListenerList();
@@ -396 +381 @@
      */
     protected void fireProcessComplete(int type, int status) {
+    // Tidy up by stopping the progress bar.
+    if(progress != null) {
+        progress.stop();
+    }
+    // And firing off an event
     GShellEvent event = new GShellEvent(this, 0, type, "", status);
     Object[] concerned = listeners.getListenerList();

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

@@ -51 +51 @@
 public class GShellEvent 
     extends AWTEvent {
+    /** Allows some part of the program to prevent this message being processed by other parts. */
+    private boolean vetoed = false;
     /** The status of the process at the completion of event. */
     private int status = -1;
@@ -93 +95 @@
     }
 
+    /** Determine if this event has been vetoed by some other part of the GLI
+     * @return true if the event has, and thus shouldn't be further processed, false otherwise.
+     */
+    public boolean isVetoed() {
+    return vetoed;
+    }
+
     public String toString() {
     return "org.greenstone.gatherer.shell.GShellEvent[" + message + "," + status + "," + type + "]";
     }
+
+    /** Prevent this event being processed by other parts of the GLI.
+     */
+    public void veto() {
+    vetoed = true;
+    }
 }

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

@@ -50 +50 @@
 import java.awt.Component;
 import javax.swing.JProgressBar;
+import org.greenstone.gatherer.shell.GShellEvent;
 
 /** When implemented, this interface allows another class to monitor the progress of a <strong>GShell</strong> process. Specifically implementing classes should be designed to take the textual output from the process and then translate that message into some quanitive measure of progress which can then be shown on the progress bar.
@@ -78 +79 @@
 
     /** This method is used to 'feed in' a line of text captured from the process.
-     * @param line A <strong>String</strong> of text captured from either standard out or standard error.
+     * @param event a GShellEvent containing information from the GShell
      */
-    public void parse(String line);
+    public void process(GShellEvent event);
 
     public void saving();