Changeset 8586

Timestamp:

2004-11-17T13:20:30+13:00 (19 years ago)

Author:

mdewsnip

Message:

Made saving collections unthreaded -- this makes a lot of code, and at least one race condition, so away. Saving collections is quick enough that it doesn't matter if it is done on the main thread.

Location:

trunk/gli/src/org/greenstone/gatherer

Files:

• collection/Collection.java (modified) (1 diff)
• collection/CollectionManager.java (modified) (2 diffs)
• collection/SaveCollectionBox.java (deleted)
• collection/SaveCollectionTask.java (deleted)
• gui/GUIManager.java (modified) (14 diffs)

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

@@ -188 +188 @@
     public void save() {
     Utility.export(document, file);
+    saved = true;
     }
 

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

@@ -753 +753 @@
     public void importCollection() {
     importing = true;
-    if(!saved()) {
+
+    if (!saved()) {
         DebugStream.println("CollectionManager.importCollection().forcesave");
         import_monitor.saving();
-        // Force save.
-        try {
-        SaveCollectionTask save_task = new SaveCollectionTask(collection);
-        save_task.setImportAfter(true);
-        save_task.start();
-        }
-        catch(Exception error) {
-        DebugStream.printStackTrace(error);
-        }
+        saveCollection();
+    }
+
+    DebugStream.println("CollectionManager.importCollection()");
+    //check that we can remove the old index before starting import
+    File index_dir = new File(getCollectionIndex(), "temp.txt");
+    index_dir = index_dir.getParentFile();
+    if(index_dir.exists()) {
+        DebugStream.println("Old Index = " + index_dir.getAbsolutePath()+", testing for deletability");
+        if (!canDelete(index_dir)) {
+        // tell the user
+        JOptionPane.showMessageDialog(Gatherer.g_man, Dictionary.get("CollectionManager.Cannot_Delete_Index"), Dictionary.get("General.Error"), JOptionPane.ERROR_MESSAGE); 
+        // tell the gui manager
+        // a message for the building log 
+        GShellEvent event = new GShellEvent(this, 0, GShell.IMPORT, Dictionary.get("CollectionManager.Cannot_Delete_Index_Log"), GShell.ERROR);
+        Gatherer.g_man.create_pane.message(event);
+        event = new GShellEvent(this, 0, GShell.IMPORT, "", GShell.ERROR);
+        Gatherer.g_man.create_pane.processComplete(event);
+        importing = false;
+        return;
+        }
+    }
+
+    String collect_dir = getCollectDirectory();
+
+    String args[];
+    String lang = Configuration.getLanguage();
+    if((Utility.isWindows()) && (!Gatherer.isGsdlRemote)) {
+        args = new String[8];
+        args[0] = Configuration.perl_path;
+        args[1] = "-S";
+        args[2] = Configuration.getScriptPath() + "import.pl";
+        args[3] = "-gli";
+        args[4] = "-language";
+        args[5] = lang;
+        args[6] = "-collectdir";
+        args[7] = collect_dir;
     }
     else {
-        DebugStream.println("CollectionManager.importCollection()");
-        //check that we can remove the old index before starting import
-        File index_dir = new File(getCollectionIndex(), "temp.txt");
-        index_dir = index_dir.getParentFile();
-        if(index_dir.exists()) {
-        DebugStream.println("Old Index = " + index_dir.getAbsolutePath()+", testing for deletability");
-        if (!canDelete(index_dir)) {
-            // tell the user
-            JOptionPane.showMessageDialog(Gatherer.g_man, Dictionary.get("CollectionManager.Cannot_Delete_Index"), Dictionary.get("General.Error"), JOptionPane.ERROR_MESSAGE); 
-            // tell the gui manager
-            // a message for the building log 
-            GShellEvent event = new GShellEvent(this, 0, GShell.IMPORT, Dictionary.get("CollectionManager.Cannot_Delete_Index_Log"), GShell.ERROR);
-            Gatherer.g_man.create_pane.message(event);
-            event = new GShellEvent(this, 0, GShell.IMPORT, "", GShell.ERROR);
-            Gatherer.g_man.create_pane.processComplete(event);
-            importing = false;
-            return;
-        }
-        }
-
-        String collect_dir = getCollectDirectory();
-
-        String args[];
-        String lang = Configuration.getLanguage();
-        if((Utility.isWindows()) && (!Gatherer.isGsdlRemote)) {
-        args = new String[8];
-        args[0] = Configuration.perl_path;
-        args[1] = "-S";
-        args[2] = Configuration.getScriptPath() + "import.pl";
-        args[3] = "-gli";
-        args[4] = "-language";
-        args[5] = lang;
-        args[6] = "-collectdir";
-        args[7] = collect_dir;
-        }
-        else {
-        args = new String[6];
-        args[0] = Configuration.getScriptPath() + "import.pl";
-        args[1] = "-gli";
-        args[2] = "-language";
-        args[3] = lang;
-        args[4] = "-collectdir";
-        args[5] = collect_dir;
-        }
-        collect_dir = null;
-        args = ArrayTools.add(args, collection.build_options.getImportValues());
-        args = ArrayTools.add(args, collection.getName());
-
-        GShell shell = new GShell(args, GShell.IMPORT, BUILDING, this, import_monitor, GShell.GSHELL_IMPORT);
-        shell.addGShellListener(Gatherer.g_man.create_pane);
-        shell.start();
-        DebugStream.println("CollectionManager.importCollection().return");
-    }
+        args = new String[6];
+        args[0] = Configuration.getScriptPath() + "import.pl";
+        args[1] = "-gli";
+        args[2] = "-language";
+        args[3] = lang;
+        args[4] = "-collectdir";
+        args[5] = collect_dir;
+    }
+    collect_dir = null;
+    args = ArrayTools.add(args, collection.build_options.getImportValues());
+    args = ArrayTools.add(args, collection.getName());
+
+    GShell shell = new GShell(args, GShell.IMPORT, BUILDING, this, import_monitor, GShell.GSHELL_IMPORT);
+    shell.addGShellListener(Gatherer.g_man.create_pane);
+    shell.start();
+    DebugStream.println("CollectionManager.importCollection().return");
+
     importing = false;
     }
@@ -1280 +1273 @@
     return result;
     }
-    /** Saves a collection by serializing it to file.
-     * @param close_after <i>true</i> to cause the Gatherer to close the collection once save is complete, <i>false</i> otherwise.
-     * @param exit_after <i>true</i> to cause the Gatherer to exit once save is complete, <i>false</i> otherwise.
-     * @see org.greenstone.gatherer.Gatherer
-     * @see org.greenstone.gatherer.gui.GUIManager
-     * @see org.greenstone.gatherer.collection.Collection
-     */
-    public void saveCollection(boolean close_after, boolean exit_after) {
-    DebugStream.println("Save collection: " + collection.getName());
-    try {
-        SaveCollectionTask save_task = new SaveCollectionTask(collection, close_after, exit_after);
-        save_task.start();
-        // Run this in the same thread
-        //save_task.run();
-    }
-    catch(Exception error) {
-        DebugStream.printStackTrace(error);
-    }
-    }
+
+
+    /** Saves the currently loaded collection. */
+    public void saveCollection()
+    {
+    DebugStream.println("Saving collection " + collection.getName() + "...");
+
+    // Change cursor to hourglass
+    Gatherer.g_man.wait(true);
+
+    // Create a backup of the collection file, just in case anything goes wrong
+    File collection_file = new File(Gatherer.c_man.getCollectionFilename());
+    if (collection_file.exists()) {
+        File collection_file_backup = new File(collection_file.getAbsolutePath() + "~");
+        if (!collection_file.renameTo(collection_file_backup)) {
+        DebugStream.println("Error in CollectionManager.saveCollection(): could not create backup file.");
+        }
+        collection_file_backup.deleteOnExit();
+    }
+
+    // Write out the collection file
+    collection.save();
+
+    // Write out the collection configuration file
+    Gatherer.g_man.design_pane.saveConfiguration();
+
+    // Write hfiles for the loaded metadata elements into the collection "etc" directory
+    MetadataSetManager.writeHierarchyFiles(new File(Gatherer.c_man.getCollectionEtc()));
+
+    // Change cursor back to normal
+    Gatherer.g_man.wait(false);
+    }
+
 
     public void setClosingThread(boolean set) {

trunk/gli/src/org/greenstone/gatherer/gui/GUIManager.java

@@ -56 +56 @@
 import org.greenstone.gatherer.collection.DeleteCollectionPrompt;
 import org.greenstone.gatherer.collection.ExportCollectionPrompt;
-import org.greenstone.gatherer.collection.SaveCollectionBox;
 import org.greenstone.gatherer.file.FileNode;
 import org.greenstone.gatherer.file.FileOpenActionListener;
@@ -156 +155 @@
     // File Options.
     // *************
-    if(esrc == menu_bar.file_associations) {
+    if (esrc == menu_bar.file_associations) {
         Gatherer.assoc_man.edit();
     }
-    else if(esrc == menu_bar.file_close) {
-        boolean cont = showSaveCollectionBox(true, false);
-        // System.err.println("Here 1.");
-        if(cont) {
-        tab_pane.setSelectedComponent(gather_pane);
-        }
-    }
-    else if(esrc == menu_bar.file_delete) {
+    else if (esrc == menu_bar.file_close) {
+        Gatherer.c_man.saveCollection();
+        Gatherer.c_man.closeCollection();
+        tab_pane.setSelectedComponent(gather_pane);
+    }
+    else if (esrc == menu_bar.file_delete) {
         DeleteCollectionPrompt dcp = new DeleteCollectionPrompt();
-        if(dcp.display()) {
+        if (dcp.display()) {
         Gatherer.c_man.closeCollection();
         }
@@ -175 +172 @@
         System.gc();
     }
-    else if(esrc == menu_bar.file_export) {
+    else if (esrc == menu_bar.file_export) {
         ExportCollectionPrompt ecp = new ExportCollectionPrompt();
         ecp.display();
@@ -181 +178 @@
         ecp = null;
     }
-    else if(esrc == menu_bar.file_exit) {
+    else if (esrc == menu_bar.file_exit) {
         exit();
     }
-        else if(esrc == menu_bar.file_new) {
+        else if (esrc == menu_bar.file_new) {
         showNewCollectionPrompt();
     }
-    else if(esrc == menu_bar.file_open) {
+    else if (esrc == menu_bar.file_open) {
         if (showLoadCollectionBox()) {
         tab_pane.setSelectedComponent(gather_pane);
         }
     }
-    else if(esrc == menu_bar.file_options) {
+    else if (esrc == menu_bar.file_options) {
         // Just incase the user has edited the GeneralSettings of a collection without losing focus afterwards. Well I'm forever losing foc... ooh shiney.
         design_pane.loseFocus();
@@ -198 +195 @@
         new Preferences();
     }
-    else if(esrc == menu_bar.file_save) {
-        Gatherer.c_man.saveCollection(false, false);
+    else if (esrc == menu_bar.file_save) {
+        Gatherer.c_man.saveCollection();
     }
 
@@ -280 +277 @@
     }
 
+
     /** Any actions that should happen after the display of the Gatherer window can be called here. Currently only updates the browser pane if it is active to work around bug in Mozilla renderer implementation.
      */
@@ -288 +286 @@
     enrich_pane.afterDisplay();
     }
+
+
     public void closeCurrentCollection() {
-
-    boolean cont = showSaveCollectionBox(true, false);
-        
-    if(cont) {
-        tab_pane.setSelectedComponent(gather_pane);
-    }
-
-    }
+    Gatherer.c_man.saveCollection();
+    Gatherer.c_man.closeCollection();
+    tab_pane.setSelectedComponent(gather_pane);
+    }
+
 
     public void destroy() {
     // Destroying create pane ensures the latest log has been closed
-    if(create_pane != null) {
+    if (create_pane != null) {
         create_pane.destroy();
     }
     }
+
 
     /** Enabled events on the window to be trapped, creates all the visual components, then builds the tab and other layouts.
@@ -412 +410 @@
     }
     }
-    /** When called this method ensures that all the things needing saving are saved before Gatherer.exit() is called. This includes a save collection prompt if necessary.
+
+
+    /** This method ensures that all the things needing saving are saved before Gatherer.exit() is called.
      */
     public void exit() {
@@ -418 +418 @@
     DebugStream.println("**** GUIManager exit called!");
 
-    if(!Gatherer.c_man.ready() || design_pane.canSave()) {
-
+    if (!Gatherer.c_man.ready() || design_pane.canSave()) {
         if (Gatherer.isGsdlRemote) {            
         // consider saving???
@@ -425 +424 @@
         }
         else {
-
-        boolean cont = true;
-        if(Gatherer.c_man.ready() && !Gatherer.c_man.saved()) {
-            cont = showSaveCollectionBox(false, true);
-        }
-        else {
-            // Deal to help
-            if(help != null) {
-            help.destroy();
-            help = null;
-            }
-            DebugStream.println("**** Calling Gatherer.self.exit");
-            Gatherer.self.exit();
-        }
-        }
-    }
-    }
+        if (Gatherer.c_man.ready() && !Gatherer.c_man.saved()) {
+            Gatherer.c_man.saveCollection();
+        }
+
+        // Deal to help
+        if (help != null) {
+            help.destroy();
+            help = null;
+        }
+        DebugStream.println("**** Calling Gatherer.self.exit");
+        Gatherer.self.exit();
+        }
+    }
+    }
+
+
     /** Retrieve the filter, or if one already exists, spawn a linked copy. */
     public Filter getFilter(DragTree tree) {
@@ -687 +685 @@
     if(filename != null) {
         // If there is already a collection open, save and close it.
-        if(Gatherer.c_man.ready()) {
-        showSaveCollectionBox(true, false);
-        // Wait until it is closed.
-        try {
-            synchronized(this) {
-                while(Gatherer.c_man.reallyReady()) {
-                wait(10);
-                }
-            }
-        }
-        catch(Exception error) {
-                DebugStream.println("Exception: " + error);
-                DebugStream.printStackTrace(error);
-        }
+        if (Gatherer.c_man.ready()) {
+        Gatherer.c_man.saveCollection();
+        Gatherer.c_man.closeCollection();
         }
         
@@ -708 +695 @@
     return result;
     }
+
 
     /** When called this method causes the MetadataAuditTable to display a nice dialog box which contains all the metadata assigned in the collection.
@@ -727 +715 @@
     }
     // Create the new collection (if not cancelled) in a new thread.
-    if(!ncd_prompt.isCancelled() && (ncm_prompt == null || !ncm_prompt.isCancelled())) {
+    if (!ncd_prompt.isCancelled() && (ncm_prompt == null || !ncm_prompt.isCancelled())) {
         // If there is already a collection open, save and close it.
-        if(Gatherer.c_man.ready()) {
-        showSaveCollectionBox(true, false);
-        // Wait until it is closed.
-        try {
-            synchronized(this) {
-            while(Gatherer.c_man.reallyReady()) {
-                wait(10);
-            }
-            }
-        }
-        catch(Exception error) {
-            DebugStream.println("Exception: " + error);
-            DebugStream.printStackTrace(error);
-        }
+        if (Gatherer.c_man.ready()) {
+        Gatherer.c_man.saveCollection();
+        Gatherer.c_man.closeCollection();
         }
 
         // Create new collection.
         CreationTask task = new CreationTask(ncd_prompt, ncm_prompt);
-        // SwingUtilities.invokeLater(task);
         task.start();
-        // Close prompt.
     }
     // Done
@@ -784 +759 @@
     }
 
-
-    /** This method is used to open the save collection box/prompt on the screen.
-     * @return A <i>boolean</i> which is <i>true</i> if the collection was saved successfully, <i>false</i> otherwise.
-     */
-    private boolean showSaveCollectionBox(boolean close_after, boolean exit_after)
-    {
-    Gatherer.c_man.setClosingThread(true);
-    Gatherer.c_man.saveCollection(close_after, exit_after);
-
-    // Wait until it is closed.
-    try {
-        synchronized(this) {
-            while (Gatherer.c_man.reallyReady()) {
-            wait(10);
-            }
-        }
-    }
-    catch (Exception exception) {
-        DebugStream.printStackTrace(exception);
-    }
-
-    Gatherer.c_man.setClosingThread(false);
-    return true;
-    }
 
     /** Any implementation of ChangeListener must include this method so we can be informed when the state of one of the registered objects changes. In this case we are listening to view changes within the tabbed pane.