Changeset 34261

Timestamp:

2020-07-11T08:00:38+12:00 (4 years ago)

Author:

ak19

Message:

1. Fixed the bug with GLI's Gather Rightclick > Replace when the replacement file and the file being replaced had the same name. Things mostly worked, including in the remote case: when the filenames were the same or different, the files would get correctly transferred, retaining meta, to the remote GS. But if the files were the same name, then in (client)GLI the file ends up lost unless it's client-GLI, in which case reopening the collection transferred the correct new file across with meta. This bugfix ensures that nothing is lost in GLI or client-GLI and that no reopening of client-GLI is necessary to fix it. The final fix ended up far easier than all my initial ways of solving it which failed to work (like renaming the src file temporarily while copying the identically named target across). 2. DebugStream error msg visibility can now be toggled on and off and prints START DEBUGGING to END DEBUGGING messages with caller name for the section of code where it's toggled on. This came in handy when debugging this time, so leaving it in for future use.

Location:

main/trunk/gli/src/org/greenstone/gatherer

Files:

• DebugStream.java (modified) (1 diff)
• file/FileManager.java (modified) (3 diffs)

main/trunk/gli/src/org/greenstone/gatherer/DebugStream.java

@@ -57 +57 @@
     }
 
+
+    static public void setDebugging(boolean isEnabled, String caller) {
+    if(isEnabled) {
+        System.err.println("**** START DEBUGGING (enabled by: " + caller + ")");
+    } else {
+        System.err.println("**** END DEBUGGING (called by: " + caller + ")");
+    }
+    debugging_enabled = isEnabled;
+    }
 
     static synchronized public boolean isDebuggingEnabled()

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

@@ -53 +53 @@
 import org.greenstone.gatherer.util.DragComponent;
 import org.greenstone.gatherer.util.Utility;
+import org.greenstone.gatherer.DebugStream;
 
 /** Manages the moving of files within a separate thread.
@@ -546 +547 @@
         WorkspaceTreeNode source_node = new WorkspaceTreeNode(new_file);
 
+        //DebugStream.setDebugging(true, "FileManager.ReplaceTask");
+
+        // Some different handling if the old and new tail file names are the same and target file goes into the same
+        // location in collection tree as source.
+        // This avoids past errors upon replacing with same filename (diff file contents) where the attached meta gets lost,
+        // or remote file gets updated but file gone missing in client-GLI view until collection reopened.
+        boolean isSameLeafName = false;
+        if(collection_tree_node.getFile().getName().equals(new_file.getName())) {
+        DebugStream.println(" @@@ File Replace: New file has the same name as existing.");
+        isSameLeafName = true;
+        }
+        
         File target_directory = collection_tree_node.getFile().getParentFile();
         CollectionTreeNode new_collection_tree_node = new CollectionTreeNode(new File(target_directory, new_file.getName()));
-        // copy the new file in - but don't bring metadata
-        file_queue.addJob(System.currentTimeMillis(), Gatherer.g_man.gather_pane.workspace_tree, new FileNode[] { source_node }, collection_tree, (FileNode)collection_tree_node.getParent(),  FileJob.COPY_FILE_ONLY);
+        
+        FileNode parent = (FileNode)collection_tree_node.getParent(); // store the original source's parent, need it several times after changing source
+       
+        if(!isSameLeafName) {
+        // If the file name of the replacing file is NOT the same as the one being replaced
+        // copy the new file in - but don't bring metadata
+        file_queue.addJob(System.currentTimeMillis(), Gatherer.g_man.gather_pane.workspace_tree, new FileNode[] { source_node }, collection_tree, parent, FileJob.COPY_FILE_ONLY);
+        }
+        
         if (Gatherer.isGsdlRemote) {
         String collection_name = CollectionManager.getLoadedCollectionName();
@@ -555 +575 @@
         Gatherer.remoteGreenstoneServer.uploadFilesIntoCollection(collection_name, new File[] { new_file }, target_directory);
         }
-        // do a replace of old file with new file
-        file_queue.addJob(System.currentTimeMillis(), collection_tree, new FileNode[] { collection_tree_node }, collection_tree, new_collection_tree_node, FileJob.REPLACE);
+
+        if(isSameLeafName) {
+        // If the file name of the replacing file IS the same as the one being replaced
+        // perform a COPY operation, which will copy across metadata too, after confirming whether the user really wants to replace the source with identically named targed
+        file_queue.addJob(System.currentTimeMillis(), Gatherer.g_man.gather_pane.workspace_tree, new FileNode[] { source_node }, collection_tree, parent, FileJob.COPY);
+        } else {
+        // If the file name of the replacing file is NOT the same as the one being replaced, final step to finish off:
+        // do a replace of old file with new file
+        file_queue.addJob(System.currentTimeMillis(), collection_tree, new FileNode[] { collection_tree_node }, collection_tree, new_collection_tree_node, FileJob.REPLACE);
+        }
+
+        //DebugStream.setDebugging(false, "FileManager.ReplaceTask");
+
     }
     }