Merge pull request #5620 from effective-webwork/rename-directory

Rename directories when changing process title
kitodo · May 2, 2023 · bbae957 · bbae957
2 parents 550c225 + 9dd076d
commit bbae957
Show file tree

Hide file tree

Showing 6 changed files with 51 additions and 6 deletions.
diff --git a/Kitodo-API/src/main/java/org/kitodo/api/filemanagement/FileManagementInterface.java b/Kitodo-API/src/main/java/org/kitodo/api/filemanagement/FileManagementInterface.java
@@ -94,7 +94,7 @@ public interface FileManagementInterface {
      *            the URI to the resource to rename
      * @param newName
      *            the new name of the resource
-     * @return true, if successful, false otherwise
+     * @return URI of renamed resource
      */
     URI rename(URI uri, String newName) throws IOException;
 

diff --git a/Kitodo-FileManagement/src/main/java/org/kitodo/filemanagement/FileManagement.java b/Kitodo-FileManagement/src/main/java/org/kitodo/filemanagement/FileManagement.java
@@ -157,6 +157,10 @@ public URI rename(URI uri, String newName) throws IOException {
             return null;
         }
 
+        if (isDirectory(uri)) {
+            return renameDirectory(uri, newName);
+        }
+
         String substring = uri.toString().substring(0, uri.toString().lastIndexOf('/') + 1);
         if (newName.contains("/")) {
             newName = newName.substring(newName.lastIndexOf('/') + 1);
@@ -179,6 +183,22 @@ public URI rename(URI uri, String newName) throws IOException {
         return performRename(mappedFileURI, mappedNewFileURI);
     }
 
+    private URI renameDirectory(URI directoryPath, String newDirectoryName) throws IOException {
+        File newDirectory = new File(KitodoConfig.getKitodoDataDirectory() + newDirectoryName);
+        File oldDirectory = new File(KitodoConfig.getKitodoDataDirectory() + directoryPath);
+
+        if (!oldDirectory.equals(newDirectory)) {
+            boolean success = oldDirectory.renameTo(newDirectory);
+            if (success) {
+                return newDirectory.toURI();
+            } else {
+                throw new IOException("Unable to rename directory '" + directoryPath + "'!");
+            }
+        } else {
+            return newDirectory.toURI();
+        }
+    }
+
     private URI performRename(URI mappedFileURI, URI mappedNewFileURI) throws IOException {
         File fileToRename = new File(mappedFileURI);
         File renamedFile = new File(mappedNewFileURI);

diff --git a/Kitodo-FileManagement/src/test/java/org/kitodo/filemanagement/FileManagementTest.java b/Kitodo-FileManagement/src/test/java/org/kitodo/filemanagement/FileManagementTest.java
@@ -43,7 +43,7 @@
 
 public class FileManagementTest {
 
-    private static FileManagement fileManagement = new FileManagement();
+    private static final FileManagement fileManagement = new FileManagement();
 
     private static final String FILE_TEST = "fileTest";
     private static final String DIRECTORY_SIZE = "directorySize";
@@ -150,6 +150,20 @@ public void shouldRenameFile() throws Exception {
         assertTrue(fileManagement.fileExist(newUri));
     }
 
+    @Test
+    public void shouldSkipRenamingDirectory() throws Exception {
+        String directoryName = "testDir";
+        URI resource = fileManagement.create(URI.create(""), directoryName, false);
+        assumeTrue(fileManagement.isDirectory(resource));
+        URI expectedUri = new File(KitodoConfig.getKitodoDataDirectory() + resource).toURI();
+        assertEquals("Renaming directory to the identical name should return identical URI", expectedUri,
+                fileManagement.rename(resource, directoryName));
+        String directoryWithTrailingSlash = directoryName + "/";
+        assertEquals("Renaming directory to the identical name with trailing slash should return identical URI",
+                expectedUri, fileManagement.rename(resource, directoryWithTrailingSlash));
+        fileManagement.delete(resource);
+    }
+
     @Test
     public void shouldCopyDirectory() throws Exception {
         URI resource = fileManagement.create(URI.create(FILE_TEST), "toCopy", false);

diff --git a/Kitodo/src/main/java/org/kitodo/production/forms/ProcessForm.java b/Kitodo/src/main/java/org/kitodo/production/forms/ProcessForm.java
@@ -312,8 +312,7 @@ private void renameDirectories(URI directory) throws IOException {
             List<URI> subDirs = fileService.getSubUris(directory);
             for (URI imageDir : subDirs) {
                 if (fileService.isDirectory(imageDir)) {
-                    fileService.renameFile(imageDir,
-                        fileService.getFileName(imageDir).replace(process.getTitle(), newProcessTitle));
+                    fileService.renameFile(imageDir, imageDir.toString().replace(process.getTitle(), newProcessTitle));
                 }
             }
         }

diff --git a/Kitodo/src/main/java/org/kitodo/production/services/file/FileService.java b/Kitodo/src/main/java/org/kitodo/production/services/file/FileService.java
@@ -374,7 +374,7 @@ public InputStream readMetadataFile(Process process, boolean forIndexingAll) thr
      * @param newFileName
      *            New file name / destination
      * @throws IOException
-     *             is thrown if the rename fails permanently
+     *             is thrown if renaming the file fails permanently
      */
     public URI renameFile(URI fileUri, String newFileName) throws IOException {
         return fileManagementModule.rename(fileUri, newFileName);

diff --git a/Kitodo/src/test/java/org/kitodo/production/services/file/FileServiceTest.java b/Kitodo/src/test/java/org/kitodo/production/services/file/FileServiceTest.java
@@ -47,8 +47,10 @@
 
 public class FileServiceTest {
 
-    private static FileService fileService = new FileService();
+    private static final FileService fileService = new FileService();
     private static final Logger logger = LogManager.getLogger(FileServiceTest.class);
+    private static final String OLD_DIRECTORY_NAME = "oldDirectoryName";
+    private static final String NEW_DIRECTORY_NAME = "newDirectoryName";
 
     @BeforeClass
     public static void setUp() throws IOException {
@@ -144,6 +146,16 @@ public void testRenameFile() throws IOException {
         assertTrue(fileService.fileExist(newUri));
     }
 
+    @Test
+    public void testRenameDirectory() throws Exception {
+        URI oldDirUri = fileService.createDirectory(URI.create(""), OLD_DIRECTORY_NAME);
+        assertTrue(fileService.isDirectory(oldDirUri));
+        URI newDirUri = fileService.renameFile(oldDirUri, NEW_DIRECTORY_NAME);
+        assertTrue(fileService.isDirectory(newDirUri));
+        assertFalse(fileService.isDirectory(oldDirUri));
+        fileService.delete(newDirUri);
+    }
+
     /**
      * Tests searchForMedia function if a MediaNotFoundException is thrown.
      *