Changeset 5796 for trunk

Timestamp:

2003-11-07T11:50:28+13:00 (20 years ago)

Author:

kjdon

Message:

major changes to loadCollection - now it can load in non-gatherer collections. it does an import of the metadata like when you drag files into a collection, and the gdm loading just does a dummy run, not actualy using the existing metadata.xml files, which we can then get rid of.

File:

• trunk/gli/src/org/greenstone/gatherer/collection/CollectionManager.java (modified) (4 diffs)

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

@@ -53 +53 @@
 import org.greenstone.gatherer.gui.LockFileDialog;
 import org.greenstone.gatherer.gui.NewCollectionMetadataPrompt;
+import org.greenstone.gatherer.gui.ExternalCollectionPrompt;
+import org.greenstone.gatherer.gui.NewMetaSetPrompt;
 import org.greenstone.gatherer.msm.ElementWrapper;
 import org.greenstone.gatherer.msm.GDMManager;
@@ -764 +766 @@
     args2[0] = location;
     boolean result = false;
+    boolean non_gatherer_collection = false;
     // Check we have actually been given a .col file.
-    if(location.endsWith(".col")) {
-        File collection_file = new File(location);
-        // Ensure that the directory exists.
-        File collection_directory = collection_file.getParentFile();
-        if(collection_directory.exists()) {
-        // Special case of a user trying to open an old greenstone collection. One day this will be supported, but for now complain, and explain how to actually re-build this collection
-        File metadata_directory = new File(collection_directory, Utility.META_DIR);
-        if(!metadata_directory.exists()) {
-            JOptionPane.showMessageDialog(Gatherer.g_man, Dictionary.get("CollectionManager.Old_Collection", args2), Dictionary.get("General.Warning"), JOptionPane.INFORMATION_MESSAGE);
-        }
-        // Normal GLI collection
-        else {
-            String name = collection_directory.getName();
-            File lock_file = new File(collection_file.getParentFile(), LOCK_FILE);
-            // Now determine if a lock already exists on this collection.
-            int choice = LockFileDialog.YES_OPTION;
-            if(lock_file.exists()) {
-            LockFileDialog dialog = new LockFileDialog(Gatherer.g_man, name, lock_file);
-            choice = dialog.getChoice();
-            dialog.dispose();
-            dialog = null;
-            }
-            if(choice == LockFileDialog.YES_OPTION) {
-            try {
-                if(lock_file.exists()) {
-                lock_file.delete();
-                }
-                // Create a lock file.
-                createLockFile(lock_file);
-                // Open the collection file
-                collection = new Collection(collection_file);
-                ///ystem.err.println("In CollectionManager::loadCollection(), collection: " + collection);
-                collection.msm = new MetadataSetManager();
-                msm = collection.msm; // Legacy
-                collection.msm.load();
-                collection.cdm = new CollectionDesignManager(new File(collection_file.getParent(), Utility.CONFIG_DIR));
-                collection.gdm = new GDMManager();
-                // Tell everyone that it worked.
-                String[] args = new String[1];
-                args[0] = name;
-                Gatherer.println(Dictionary.get("CollectionManager.Loading_Successful", args));
-                // Now we need to hook up classes that depend on messages from the metadata set manager to keep their content fresh.
-                collection.msm.addMSMListener(this);
-                // We're done. Let everyone know.
-                if(Gatherer.g_man != null) {
-                workspace_model = null;
-                Gatherer.g_man.collectionChanged(ready());
-                }
-                result = true;
-                ///ystem.err.println("Done loadCollection().");
-            } catch (Exception error) {
-                // There is obviously no existing collection present.
-                Gatherer.printStackTrace(error);
-                JOptionPane.showMessageDialog(Gatherer.g_man, Dictionary.get("CollectionManager.Cannot_Open", args2), Dictionary.get("General.Error"), JOptionPane.ERROR_MESSAGE);
-            }
-            }
+    if(!location.endsWith(".col")) {
+        JOptionPane.showMessageDialog(Gatherer.g_man, Dictionary.get("CollectionManager.Not_Col_File", args2), Dictionary.get("General.Error"), JOptionPane.ERROR_MESSAGE);
+        Gatherer.println("CollectionManager.loadCollection: Haven't been given a .col file.");
+        return false;
+    }
+    File collection_file = new File(location);
+    // Ensure that the directory exists.
+    File collection_directory = collection_file.getParentFile();
+    if(!collection_directory.exists()) {
+        // we cant open this
+        collection_directory = null;
+        return false;
+    }
+
+    // Special case of a user trying to open an old greenstone collection. 
+    File metadata_directory = new File(collection_directory, Utility.META_DIR);
+    if(!metadata_directory.exists()) {
+            
+        Gatherer.println("CollectionManager.loadCollection: trying to load up a non-gatherer collection");
+        non_gatherer_collection = true;
+    }
+
+    String name = collection_directory.getName();
+    File lock_file = new File(collection_file.getParentFile(), LOCK_FILE);
+    // Now determine if a lock already exists on this collection.
+    int choice = LockFileDialog.YES_OPTION;
+    if(lock_file.exists()) {
+        LockFileDialog dialog = new LockFileDialog(Gatherer.g_man, name, lock_file);
+        choice = dialog.getChoice();
+        dialog.dispose();
+        dialog = null;
+    }
+    
+    if(choice != LockFileDialog.YES_OPTION) {
+        // user has cancelled
+        lock_file = null;
+        collection_directory = null;
+        return false;
+    }
+
+    
+    try {
+        if(lock_file.exists()) {
+        lock_file.delete();
+        }
+        // Create a lock file.
+        createLockFile(lock_file);
+        // Open the collection file
+        collection = new Collection(collection_file);
+        collection.msm = new MetadataSetManager();
+        msm = collection.msm; // Legacy
+        collection.msm.load();
+        
+        // if non-gatherer collection, need to add some metadata sets
+        if (non_gatherer_collection) {
+        if (!addSomeMetadataSets(collection_directory)) {
+            // for now - return of false means its been cancelled. Any error messages should be sent from the function itself
             lock_file = null;
-        }
-        }
-        else {
-        JOptionPane.showMessageDialog(Gatherer.g_man, Dictionary.get("CollectionManager.File_Not_Found", args2), Dictionary.get("General.Error"), JOptionPane.ERROR_MESSAGE);
-        }
-        collection_directory = null;
-    }
-    else {
-        JOptionPane.showMessageDialog(Gatherer.g_man, Dictionary.get("CollectionManager.Not_Col_File", args2), Dictionary.get("General.Error"), JOptionPane.ERROR_MESSAGE);
-        Gatherer.println("Not a Gatherer Collection.");
-    }
+            collection_directory = null;
+            closeCollection();
+            return false;
+        }
+        }
+            
+        collection.cdm = new CollectionDesignManager(new File(collection_file.getParent(), Utility.CONFIG_DIR));
+        if (non_gatherer_collection) {
+        // do a dummy load of GDMManager - so we don't load in the old 
+        // metadata.xml files, we just create new empty ones.
+        collection.gdm = new GDMManager(true);
+        if (findAndLoadExistingMetadata(collection_directory)==false) {
+            lock_file = null;
+            collection_directory = null;
+            closeCollection();
+            return false;
+        }
+        } else {
+        collection.gdm = new GDMManager();
+        }
+        
+        // Tell everyone that it worked.
+        String[] args = new String[1];
+        args[0] = name;
+        Gatherer.println(Dictionary.get("CollectionManager.Loading_Successful", args));
+        // Now we need to hook up classes that depend on messages from the metadata set manager to keep their content fresh.
+        collection.msm.addMSMListener(this);
+        // We're done. Let everyone know.
+        if(Gatherer.g_man != null) {
+        workspace_model = null;
+        Gatherer.g_man.collectionChanged(ready());
+        }
+        result = true;
+        ///ystem.err.println("Done loadCollection().");
+    } catch (Exception error) {
+        // There is obviously no existing collection present.
+        Gatherer.printStackTrace(error);
+        JOptionPane.showMessageDialog(Gatherer.g_man, Dictionary.get("CollectionManager.Cannot_Open", args2), Dictionary.get("General.Error"), JOptionPane.ERROR_MESSAGE);
+    }
+    
+    lock_file = null;
+    collection_directory = null;
+    
     args2 = null;
     return result;
+    }
+    
+    /** I started giving the user the choice of using an existing meta set or creating a new one. The second option being so that they didn't have to add/merge/ignore each element, they could all be added automatically. However, I am not sure where the merge prompt gets called from, and it is not essential, so I am leaving it for now - it shoudl be added back in and finished. [kjdon] */
+    private boolean addSomeMetadataSets(File collection_dir) {
+    
+    
+    ExternalCollectionPrompt external_prompt = new ExternalCollectionPrompt();
+    int meta_choice = external_prompt.getMetadataChoice();
+    boolean cancelled = external_prompt.isCancelled();
+    if (cancelled) {
+        return false;
+    } 
+    
+    /*if (meta_choice == ExternalCollectionPrompt.NEW_META_SET) {
+        NewMetaSetPrompt nmsp = new NewMetaSetPrompt();     
+        if (nmsp.isCancelled()) {
+        return false;
+}
+        String namespace_str = nmsp.getNamespace();
+        String name_str = nmsp.getName();
+        MetadataSet set = Gatherer.c_man.msm.addSet(namespace_str, name_str);
+    } else if (meta_choice == ExternalCollectionPrompt.EXISTING_META_SET) {
+    */
+    // now we reuse the newcoll metadata prompt for the user to select metadata sets
+    NewCollectionMetadataPrompt ncm_prompt = new NewCollectionMetadataPrompt(true);
+    if (ncm_prompt.isCancelled()) {
+        return false;
+    }
+    ArrayList metadata_sets = ncm_prompt.getSets();
+    // Import default metadata sets if any.
+    for(int i = 0; metadata_sets != null && i < metadata_sets.size(); i++) {
+        MetadataSet metadata_set = (MetadataSet) metadata_sets.get(i);
+        collection.msm.importMDS(metadata_set.getFile(), false);
+    }
+    /*} else {
+      return false;
+      }*/
+    // Always import the extracted metadata set
+    collection.msm.importMDS(new File(Utility.METADATA_DIR + Utility.EXTRACTED_METADATA_NAMESPACE + StaticStrings.METADATA_SET_EXTENSION), false);
+
+    return true;
+    }
+    
+
+    // now try to load in existing metadata, delete the existing metadata.xml files, then save the new ones.
+    private boolean findAndLoadExistingMetadata(File collection_dir) {
+
+    TreeModel collection_tree = getRecordSet();
+    FileNode root_node = (FileNode)collection_tree.getRoot();
+    if (searchForMetadata(collection_tree, root_node)==false) {
+        return false;
+    }
+    removeOldMetadataFiles(collection_dir);
+    collection.gdm.save(root_node);
+    return true;
+    }
+
+    // this moves all the existing metadata files into a back up directory
+    public void removeOldMetadataFiles(File collection_dir) {
+    File import_dir = new File(collection_dir, Utility.IMPORT_DIR);
+    File import_bak_dir = new File(collection_dir, Utility.IMPORT_BAK_DIR);
+    import_bak_dir.mkdir();
+
+    moveMetadataFiles(import_dir, import_bak_dir);
+
+    }
+
+    private boolean moveMetadataFiles(File source_dir, File dest_dir) {
+
+    // find the metadata file in this dir
+    File meta_file = new File(source_dir, "metadata.xml");
+    if (meta_file.exists()) {
+        File new_meta_file = new File(dest_dir, "metadata.xml");
+        try {
+        dest_dir.mkdirs();
+        if (meta_file.renameTo(new_meta_file)== false) {
+            throw new Exception("");
+        }
+        } catch (Exception e) {
+        Gatherer.println("Exception: couldn't move the file "+meta_file.getPath() + e.getMessage());
+        }
+    }
+    
+    // now go through child directories
+    File [] children = source_dir.listFiles();
+    for (int i=0; i<children.length; i++) {
+        File child = children[i];
+        if (child.isDirectory()) {
+        moveMetadataFiles(child, new File(dest_dir, child.getName()));
+        }
+    }
+    return true;
+    }
+        
+
+    private boolean searchForMetadata(TreeModel collection_tree, FileNode current_node) {
+    File source_file = current_node.getFile();
+    String source_file_name = source_file.getName();
+    if (source_file_name.equals(Utility.METADATA_XML) || source_file_name.equals("CVS")) {
+        return true;
+    }
+    if (collection.msm.searchForMetadata(current_node, current_node, false)== false) {
+        return false;
+    }
+    int num_children = collection_tree.getChildCount(current_node);
+    for (int i=0; i<num_children; i++) {
+        FileNode child = (FileNode)collection_tree.getChild(current_node, i);
+        if (searchForMetadata(collection_tree, child)==false) {
+        return false;
+        }
+    }
+    return true;
     }
 
@@ -1026 +1174 @@
     public void registerBuildMonitor(GShellProgressMonitor monitor) {
     build_monitor = monitor;
-    }
+    } 
     /** This method associates the collection copy monitor with the copy monitor created in CreatePane.
      * @param monitor A <strong>GShellProgressMonitor</strong> which we will use as the copy monitor.
@@ -1212 +1360 @@
     }
 
-    private boolean searchForMetadata(File current_file) {
-    boolean cancelled = false;
-    if(current_file.isFile() && current_file.getName().equals(Utility.METADATA_XML)) {
-        cancelled = collection.msm.searchForMetadata(null, new FileNode(current_file), false, true); // A dummy run only.
-    }
-    else {
-        File[] children_files = current_file.listFiles();
-        for(int i = 0; !cancelled && children_files != null && i < children_files.length; i++) {
-        cancelled = searchForMetadata(children_files[i]);
-        }
-    }
-    return cancelled;
-    }
+     private boolean searchForMetadata(File current_file) {
+       boolean cancelled = false;
+       if(current_file.isFile() && current_file.getName().equals(Utility.METADATA_XML)) {
+           cancelled = collection.msm.searchForMetadata(null, new FileNode(current_file), false, true); // A dummy run only.
+       }
+       else {
+           File[] children_files = current_file.listFiles();
+           for(int i = 0; !cancelled && children_files != null && i < children_files.length; i++) {
+               cancelled = searchForMetadata(children_files[i]);
+           }
+       }
+       return cancelled;
+     }
 
     private void updateCollectionCFG(File base_cfg, File new_cfg, String description, String email, String title) {