Changeset 37700

Timestamp:

2023-04-21T21:24:08+12:00 (12 months ago)

Author:

anupama

Message:

Implemented 2nd of Dr Bainbridge's request: GLI collection tree should have rightclick > unzip option. This context menu is now available on single or multiple selection of only zip files, but not for remote GS. UnzipTools.unzip() is no longer a void function but returns boolean, so I can test which files have been unzipped successfully and can be deleted thereafter. Decompressed files were showing by calling refresh on the collection tree, but I couldn't initially get the deleted source zip files to disappear. And if I didn't call refresh, the deletes would show (but not the decompressed files). I couldn't work out what caused the tree to refresh on delete context menu or rubbish bin click, nor where (if anywhere) an event was fired to indicate deletion had completed and caused a refresh. Instead, I found that a commented out call to g_man.refreshCollectionTree in FileQueue::run() did the job of showing both decompressed files and not showing the deleted source zip files. The question remains: why was the refreshCollectionTree() call in FileQueue::run() commented out in the first place? It fixes things for my work here, but will it break something somewhere else?

Location:

main/trunk/gli

Files:

• classes/dictionary.properties (modified) (1 diff)
• src/org/greenstone/gatherer/collection/CollectionTree.java (modified) (7 diffs)
• src/org/greenstone/gatherer/collection/CollectionTreeNode.java (modified) (1 diff)
• src/org/greenstone/gatherer/file/FileQueue.java (modified) (1 diff)
• src/org/greenstone/gatherer/util/UnzipTools.java (modified) (3 diffs)

main/trunk/gli/classes/dictionary.properties

@@ -399 +399 @@
 CollectionPopupMenu.Rename:Rename
 CollectionPopupMenu.Replace:Replace...
+CollectionPopupMenu.Unzip:Unzip
 #*******************************
 #

main/trunk/gli/src/org/greenstone/gatherer/collection/CollectionTree.java

@@ -30 +30 @@
 import java.awt.dnd.DropTargetDropEvent;
 import java.awt.event.*;
+import java.io.File;
+import java.util.Vector;
 import javax.swing.*;
 import javax.swing.tree.*;
@@ -37 +39 @@
 import org.greenstone.gatherer.gui.tree.DragTree;
 import org.greenstone.gatherer.gui.tree.DragTreeCellRenderer;
+import org.greenstone.gatherer.util.UnzipTools;
 
 
@@ -148 +151 @@
     private JMenuItem explode_metadata_database = null;
     private JMenuItem replace_srcdoc_with_html = null;
+    private JMenuItem unzip_file = null;
     private JMenuItem delete = null;
     private JMenuItem metaaudit = null;
@@ -287 +291 @@
         }
 
-        // Meta-audit and delete options
+        // Meta-audit, delete and unzip options
         metaaudit = new JMenuItem(Dictionary.get("Menu.Metadata_View", collection_tree.getSelectionDetails()), KeyEvent.VK_A);
         metaaudit.addActionListener(this);
@@ -309 +313 @@
         } 
         }
-       
-        // Only meta-audit and delete (and possibly replace_srcdoc) are available if multiple items are selected...
+        
+        // Unzip menu option is available if not remote GS
+        // and when all selected files are of .zip extension
+        if(!Gatherer.isGsdlRemote && firstSelectedNode.isZipFile()) { // test 1st selected node
+        unzip_file = new JMenuItem(Dictionary.get("CollectionPopupMenu.Unzip"), KeyEvent.VK_U);
+        unzip_file.addActionListener(this);     
+        add(unzip_file);
+        
+        // Now the menu is there, grey it out if not all the files are of the same type
+        if(!selectedFilesOfSameType(selection_paths)) {
+            unzip_file.setEnabled(false);
+        } 
+        }
+        
+        // Only meta-audit and delete (and possibly replace_srcdoc and unzip_file)
+        // are available if multiple items are selected...
         if (selection_paths.length > 1) {
         return;
@@ -397 +415 @@
         // Replace source document with generated html (works with replace_srcdoc_with_html.pl)
         else if (source == replace_srcdoc_with_html) {
-        java.io.File[] source_files = new java.io.File[selection_paths.length];
+        File[] source_files = new File[selection_paths.length];
         for (int i = 0; i < selection_paths.length; i++) {
             CollectionTreeNode node = (CollectionTreeNode) selection_paths[i].getLastPathComponent(); 
@@ -405 +423 @@
         }
 
+        else if (source == unzip_file) {
+        Vector<CollectionTreeNode> sourceNodes = new Vector(selection_paths.length);
+        // all selected shall be zip files at this stage
+        for (int i = 0; i < selection_paths.length; i++) {
+            CollectionTreeNode node = (CollectionTreeNode) selection_paths[i].getLastPathComponent();
+            //System.err.println("Away to unzip file" + node.getFile().getPath());
+            
+            // unzip the zip file into its parent directory
+            // and maintain list of successfully unzipped files to delete
+            if(UnzipTools.unzipFile(node.getFile().getPath(), node.getFile().getParent()+File.separator)) {
+            sourceNodes.add(node);
+            }           
+        }
+
+        // refresh collection view - now done in file/FileQueue::run() in synchronized(this)
+        //Gatherer.g_man.refreshCollectionTree(DragTree.COLLECTION_CONTENTS_CHANGED);
+        
+        // for all zips that were successfully unzipped, delete the zip file itself
+        CollectionTreeNode[] unzippedNodes = new CollectionTreeNode[sourceNodes.size()];
+        unzippedNodes = sourceNodes.toArray(unzippedNodes);
+        // Fire a delete action - refreshes collection tree on its own iff refresh not
+        // called on the tree before or after. But then the unzipped files didn't show.
+        // So now refresh collection tree done in file/FileQueue::run() in synchronized(this)
+        Gatherer.f_man.action(collection_tree, unzippedNodes, Gatherer.recycle_bin, null);
+        }
+        
         // Delete
         else if (source == delete) {

main/trunk/gli/src/org/greenstone/gatherer/collection/CollectionTreeNode.java

@@ -84 +84 @@
     }
 
+    public boolean isZipFile() {
+    if(this.file != null) {
+        if(file.getPath().endsWith(".zip")) {
+        return true;
+        }
+    }
+
+    return false;
+    }
+    
     /** This method returns a string representation of the filenodes in the 
     * <i>Collection</i> Tree, that can then be displayed in the tree. If the 

main/trunk/gli/src/org/greenstone/gatherer/file/FileQueue.java

@@ -704 +704 @@
             if (Gatherer.g_man != null && Gatherer.c_man.ready()) {
             Gatherer.g_man.refreshWorkspaceTree(DragTree.COLLECTION_CONTENTS_CHANGED);
-            // Gatherer.g_man.refreshCollectionTree(DragTree.COLLECTION_CONTENTS_CHANGED);
+            // Need this next line back in to refresh the collection tree after
+            // rightclick>Unzip has finished unzipping and deleting the original zip file
+            // TODO: But why was it commented out originally? Should it not be active?
+             Gatherer.g_man.refreshCollectionTree(DragTree.COLLECTION_CONTENTS_CHANGED);
             }
 

main/trunk/gli/src/org/greenstone/gatherer/util/UnzipTools.java

@@ -35 +35 @@
 public class UnzipTools
 {
-    static public void unzipFile(String zip_file_path, String base_directory_path)
+    static public boolean unzipFile(String zip_file_path, String base_directory_path)
     {
+    boolean success = true;
     try {
         ZipFile zip_file = new ZipFile(new File(zip_file_path), ZipFile.OPEN_READ);
@@ -51 +52 @@
             if (!zip_entry_file.exists() && !zip_entry_file.mkdirs()) {
             System.err.println("Error: unable to create directory " + zip_entry_file);
+            success = false;
             }
         }
@@ -94 +96 @@
     catch (Exception exception) {
         exception.printStackTrace();
+        success = false;
     }
+
+    return success;
     }
 }