Changeset 22605 for main/trunk/gli/src/org/greenstone/gatherer/gui/NewCollectionDetailsPrompt.java

Timestamp:

2010-08-11T21:28:34+12:00 (14 years ago)

Author:

ak19

Message:

Ticket #152: Allowing different paths to collect dir so that GLI can work with collect dirs on pen drives. NONE OF THESE CHANGES ARE FOR Client-GLI AS YET. 1. Preferences (Connection tab), Open and New Collection dialogs allow one to change the current collect directory containing the collections to select from. 2. New Collection dialog allows one to base a new collection on an existing collection in a collect dir other than the current collect dir. 3. Collections in the Documents in Greenstone Collections Workspace Tree Node now have two additional rightclick options: to move and copy these collections to another location.

File:

• main/trunk/gli/src/org/greenstone/gatherer/gui/NewCollectionDetailsPrompt.java (modified) (15 diffs)

main/trunk/gli/src/org/greenstone/gatherer/gui/NewCollectionDetailsPrompt.java

@@ -34 +34 @@
 import javax.swing.event.*;
 import javax.swing.text.*;
+import javax.swing.filechooser.FileFilter;
+import javax.swing.filechooser.FileView;
 import org.greenstone.gatherer.Configuration;
 import org.greenstone.gatherer.Dictionary;
@@ -39 +41 @@
 import org.greenstone.gatherer.collection.BasicCollectionConfiguration;
 import org.greenstone.gatherer.remote.RemoteGreenstoneServer;
+import org.greenstone.gatherer.util.JarTools;
 import org.greenstone.gatherer.util.StaticStrings;
 import org.greenstone.gatherer.util.Utility;
@@ -45 +48 @@
     extends ModalDialog {
 
-     
-    
-    static public boolean titleClashes(String title, File current_config_file) {
+    
+    static public boolean titleClashes(String collectDir, String title, File current_config_file) {
     // An empty collection title never clashes with anything. It may look ugly in the final collection but there is nothing wrong with having no title for a particular language.
     if(title == null || title.length() == 0) {
         return false;
     }
-    File collect_directory = new File(Gatherer.getCollectDirectoryPath());
+    File collect_directory = new File(collectDir);
     String file_name = (Gatherer.GS3)? Utility.CONFIG_GS3_FILE : Utility.CONFIG_FILE;
     File children[] = collect_directory.listFiles();
@@ -72 +74 @@
 
     private boolean cancelled;
+    private boolean collectDirChanged;
     private File base_final;
+    private JButton chdir_button;
     private JButton create_button;
     private JComboBox base_collection;
@@ -79 +83 @@
     private JTextArea description;
     private JTextField title;
+    private String collectBasePath;
+    private String newCollectPath;
     private String description_final;
     private String title_final="";
+
     static private Dimension COMPONENT_SIZE = new Dimension(230, 25);
     /** The size of this new collection dialog box. */
@@ -94 +101 @@
         this.setComponentOrientation(Dictionary.getOrientation());
     this.self = this;
+    newCollectPath = Gatherer.getCollectDirectoryPath();
+    collectBasePath = null;
+    collectDirChanged = false;
+
     // Setup
     setJMenuBar(new SimpleMenuBar("creatingacollection"));
@@ -101 +112 @@
     // Model building. Build a model of all of the collections in the gsdl collect directory with the appropriate directories.
     Vector base_collection_model = new Vector();
-    // need to modify this to base a coll on any collection from any site
-    if (Gatherer.GS3 && !Gatherer.isGsdlRemote) {
-        File sites_dir = new File(Gatherer.getSitesDirectoryPath());
-        File [] sites = sites_dir.listFiles();
-        for (int i=0; i<sites.length; i++) {
-        File collect_directory = new File(sites_dir + File.separator + sites[i].getName() + File.separator + "collect");
-        if (collect_directory.exists()) {
-            addCollectionsToModel(base_collection_model, collect_directory, sites[i].getName());
-        }
-        }
-    } else {
-       File collect_directory = new File(Gatherer.getCollectDirectoryPath());
-       addCollectionsToModel(base_collection_model, collect_directory, null);
-    }
-
-    // Sort the result.
-    Collections.sort(base_collection_model);
-    base_collection_model.add(0, new Item(null, Dictionary.get("NewCollectionPrompt.NewCollection")));
+    setupBaseCollections(base_collection_model, null); // if no collect directory passed in: use default collect directory
+
 
     // Creation
@@ -190 +185 @@
         button_pane.setComponentOrientation(Dictionary.getOrientation());
     create_button = new GLIButton(Dictionary.get("General.OK"), Dictionary.get("General.OK_Tooltip"));
+    chdir_button = new GLIButton(Dictionary.get("General.CD"), Dictionary.get("General.CD_Tooltip"));
     JButton cancel_button = new GLIButton(Dictionary.get("General.Cancel"), Dictionary.get("General.Cancel_Tooltip"));
 
     // Connection
+    chdir_button.addActionListener(new ChangeDirListener());
+    if(Gatherer.isGsdlRemote) { // for client GLI disable changing directories
+        chdir_button.setEnabled(false);     
+    } else { // can't base collections on any in OTHER collect dirs in client GLI
+        base_collection.addActionListener(new OtherCollectionsListener());
+    }
     cancel_button.addActionListener(new CancelListener());
     create_button.addActionListener(new CreateListener());
@@ -238 +240 @@
 
     button_pane.setBorder(BorderFactory.createEmptyBorder(5,0,0,0));
-    button_pane.setLayout(new GridLayout(1,2));
+    button_pane.setLayout(new GridLayout(1,3));
+    button_pane.add(chdir_button);
     button_pane.add(create_button);
     button_pane.add(cancel_button);
@@ -327 +330 @@
     public String getTitle() {
     return title_final;
+    }
+
+    private void setupBaseCollections(Vector base_collection_model, String collectDirectory) {
+
+    File collect_directory = null;
+    if(collectDirectory != null) {
+        collect_directory = new File(collectDirectory);
+    }
+
+    // need to modify this to base a coll on any collection from any site
+    if (Gatherer.GS3 && !Gatherer.isGsdlRemote) {
+        File sites_dir = new File(Gatherer.getSitesDirectoryPath());
+        File [] sites = sites_dir.listFiles();
+        for (int i=0; i<sites.length; i++) {        
+        if(collect_directory == null) {
+            collect_directory = new File(sites_dir + File.separator + sites[i].getName() + File.separator + "collect");
+        } 
+        if (collect_directory.exists()) {
+            addCollectionsToModel(base_collection_model, collect_directory, sites[i].getName());
+        }
+        }
+    } else {
+        if(collect_directory == null) { // if no collect directory passed in: use default collect directory
+        collect_directory = new File(Gatherer.getCollectDirectoryPath());
+        }
+       addCollectionsToModel(base_collection_model, collect_directory, null);
+    }
+
+    // Sort the result.
+    Collections.sort(base_collection_model);
+    base_collection_model.add(0, new Item(null, Dictionary.get("NewCollectionPrompt.NewCollection")));
+    
+    // last item allows one to open up collections from other collect folders to base the new one on
+    if(!Gatherer.isGsdlRemote) { // Not yet implemented for client GLI
+        base_collection_model.add(new Item(null, Dictionary.get("NewCollectionPrompt.OtherCollections")));
+    }
     }
 
@@ -363 +402 @@
     }
 
+    private class OtherCollectionsListener implements ActionListener {
+
+    // the JComboBox listener will receive an ActionEvent 
+    // when a selection has been made
+
+    public void actionPerformed(ActionEvent event) {
+
+        // If the Other Collections item was selected (which is the last one in the list)
+        if(base_collection.getSelectedIndex() == base_collection.getItemCount()-1) {
+
+        // open a filechooser in whatever is the current collect directory
+        // within the NewCollectionDetailsPrompt's settings
+        if(collectBasePath == null) {
+            collectBasePath = newCollectPath;
+        }
+
+        JFileChooser chooser = new JFileChooser(collectBasePath);
+        chooser.setFileView(new CollectionFileView());
+        chooser.setDialogTitle(Dictionary.get("NewCollectionPrompt.ChooseACollection"));
+        chooser.setApproveButtonText(Dictionary.get("NewCollectionPrompt.Select"));
+        
+        // to prevent the user from traversing into collection folders,
+        // need to:
+        // - NOT set the filechooser to Directories only, but files and directories
+        // (so that they can still select directories)
+        // - add a filefilter that accepts only directories (i.e. rejects files)
+        // - remove the accept all filter
+        chooser.setFileSelectionMode(JFileChooser.FILES_AND_DIRECTORIES);
+        //chooser.setFileSelectionMode(JFileChooser.DIRECTORIES_ONLY);
+        chooser.setFileFilter(new CollectionFileFilter());
+        chooser.setAcceptAllFileFilterUsed(false);
+
+        int returnVal = chooser.showOpenDialog(NewCollectionDetailsPrompt.this);
+        if(returnVal == JFileChooser.APPROVE_OPTION) {
+
+            File selectedFile = chooser.getSelectedFile(); 
+            
+            // don't bother reloading if nothing has changed
+            if(collectBasePath.equals(selectedFile.getAbsolutePath() + File.separator)) { 
+            // don't want Other Collections... selected
+            base_collection.setSelectedIndex(0);
+            } else {
+
+            // If the selected directory is a collection folder get its collect dir,
+            // make collectBasePath the collect dir, and select the collection itself
+            String cfg = (Gatherer.GS3)? Utility.CONFIG_GS3_FILE : Utility.CONFIG_FILE;
+            boolean isCollection = false;
+            while(new File(selectedFile, cfg).exists()) { // while loop handles collectgroup
+                selectedFile = selectedFile.getParentFile();
+                isCollection = true;
+            } // else may be a collect dir, in which case leave it as it is again
+
+            // found collect directory for base collections
+            collectBasePath = selectedFile.getAbsolutePath()+File.separator; 
+
+            // change the available collections to base this collection on
+            base_collection.removeAllItems();
+            Vector base_collection_model = new Vector();
+            setupBaseCollections(base_collection_model, collectBasePath);
+            for(int i = 0; i < base_collection_model.size(); i++) {
+                Item item = (Item)base_collection_model.get(i);
+                base_collection.addItem(item);
+
+                // select the originally chosen collection, if any, in the combobox
+                if(isCollection && chooser.getSelectedFile().equals(item.getFile())) {
+                base_collection.setSelectedIndex(i);
+                }
+            }
+            
+            // But if the user selected a collect group, set combobox to New Collection
+            if(!isCollection) {
+                // if it was a collectgroup, nothing new would be selected, set to New Coll             
+                if(base_collection.getSelectedIndex() == base_collection.getItemCount()-1) {
+                base_collection.setSelectedIndex(0);
+                }
+            }
+
+            } 
+
+        } else { // cancelled out of dialog, so jump to New Collection
+            base_collection.setSelectedIndex(0);
+        }       
+        }
+    }
+    }
+
+    private class ChangeDirListener implements ActionListener {
+    public void actionPerformed(ActionEvent event) {
+        String oldCollectPath = newCollectPath;
+        JFileChooser chooser = new JFileChooser(newCollectPath);
+        chooser.setFileSelectionMode(JFileChooser.DIRECTORIES_ONLY);
+        chooser.setDialogTitle(Dictionary.get("General.ChooseCollectDirectory"));
+
+        int returnVal = chooser.showOpenDialog(NewCollectionDetailsPrompt.this);
+        if(returnVal == JFileChooser.APPROVE_OPTION) {
+        newCollectPath = chooser.getSelectedFile().getAbsolutePath() + File.separator;
+
+        // Must NOT change the available collections to base this collection on here.
+        // It will change any collection the user previously chose to base the newcoll on.
+
+        // will be used to test for duplicate collection names in current collect dir
+        collectDirChanged = newCollectPath.equals(oldCollectPath) ? false : true;
+        }
+    }
+    }
+
     private class CancelListener
     implements ActionListener {
@@ -387 +532 @@
         // We must ensure that the collection title is unique. This is a pain in the nether regions as we are forced to load the collect.cfg of each other collection in turn looking for a conflicting title
         else {
-        if(titleClashes(title_final, null)) {
+        String collectDir = collectDirChanged ? newCollectPath : Gatherer.getCollectDirectoryPath();
+        if(titleClashes(collectDir, title_final, null)) {
             JOptionPane jOptionPane=new JOptionPane();
                     jOptionPane.setComponentOrientation(Dictionary.getOrientation());
@@ -395 +541 @@
             }
         }
+        }
+
+        // going through with collection creation
+        if(collectDirChanged) {     
+        Gatherer.collectDirectoryHasChanged(Gatherer.getCollectDirectoryPath(), newCollectPath); 
+        // will tell the server that the collect directory has changed and that
+        // the workspace needs to be refreshed (Documents in Greenstone Collections)
         }
 
@@ -435 +588 @@
     }
     public int compareTo(Object other) {
-        return toString().toLowerCase().compareTo(other.toString().toLowerCase());
+        if(this == null && other == null) {
+        return 0;
+        }
+        else if(other == null) { 
+        return 1; 
+        }
+        else if(this == null) {
+        return -1;
+        } 
+        else {
+        return toString().toLowerCase().compareTo(other.toString().toLowerCase());
+        }
     }
     public boolean equals(Object other) {
@@ -450 +614 @@
     }
     }
+
+    /** FileFilter for the Filechooser to choose the collection to base the new one on: 
+     * Only displays directories. */
+    private class CollectionFileFilter extends FileFilter { 
+    public boolean accept(File f) {
+        return f.isDirectory();
+    }
+    public String getDescription() {
+        return "greenstone collection view"; //return "directories only";
+    }
+    }
+
+    /** Folders that can be used as a base collection have a special icon */
+    private class CollectionFileView extends FileView {
+    final String configfile_name;   
+    final ImageIcon COLLECTION_ICON = JarTools.getImage("gsCollection.gif", true);
+    
+    private File previous = null;
+    private boolean previousWasCollection = false;
+
+    public CollectionFileView() {
+        configfile_name = (Gatherer.GS3)? Utility.CONFIG_GS3_FILE : Utility.CONFIG_FILE;
+    }
+
+    // A human readable description of the file.
+    public String getDescription(File f) {
+        if(!f.equals(previous)) {
+        previous = f;
+        // no idea if it's a collection or not, calculate this next time
+        previousWasCollection = false; 
+        }
+        return null; // FilewView superclass will handle it
+    }
+        
+    // The icon that represents this file in the JFileChooser.
+    public Icon getIcon(File f) {
+        
+        if(f.equals(previous) && previousWasCollection) {
+        return COLLECTION_ICON;
+        } 
+        
+        if(isCollectionBase(f)) {
+        return COLLECTION_ICON;
+        }       
+        
+        return null; // FileView superclass will do the default
+    }
+        
+    // The name of the file.
+    public String getName(File f) { 
+        if(!f.equals(previous)) {
+        previous = f;
+        // no idea if it's a collection or not, calculate this next time
+        previousWasCollection = false; 
+        }
+        return f.getName(); 
+    }
+
+    // A human readable description of the type of the file.
+    public String getTypeDescription(File f) {
+        if(f.equals(previous) && previousWasCollection) {
+        return "collection";
+        } 
+        if(isCollectionBase(f)) {
+        return "collection";
+        }
+        // else
+        return "not a collection";
+    }
+
+    // Whether the directory is traversable or not.
+    public Boolean isTraversable(File f) {
+        if(f.equals(previous) && previousWasCollection) {
+        return Boolean.FALSE;
+        }       
+        
+        if(isCollectionBase(f)) {
+        return Boolean.FALSE;
+        }
+
+        if(f.isFile()) { // not traversable
+        return Boolean.FALSE;
+        }
+        // any other kind of directory is traversable
+        return Boolean.TRUE;        
+    }
+
+    
+    /** returns false for collect groups and collect dirs. */
+    private boolean isCollectionBase(File f) {      
+        previous = f;
+        previousWasCollection = false;
+
+        if(!f.isFile()) {
+        // If the directory has a etc/collect.cfg file then it looks like a collection
+        File collect_cfg_file = new File(f, configfile_name);
+        if (collect_cfg_file.exists()) {
+            // Check for group coll: Check the collect.cfg for collectgroup=true
+            BasicCollectionConfiguration config = new BasicCollectionConfiguration(collect_cfg_file);
+            if (!config.getCollectGroup().equals("true")) {
+            previousWasCollection = true;
+            }       
+        }
+        }
+        return previousWasCollection;
+    }
+
+    }
 }