remove operating system forbidden chars from suggested file name (#83)

* remove operating system forbidden chars from suggested file name

* adapt functionality to work differently for windows and unix based operating systems

build.gradle

@@ -19,6 +19,7 @@ dependencies {
 
     // util
     implementation 'commons-io:commons-io:2.15.1'
+    implementation 'org.apache.commons:commons-lang3:3.14.0'
     implementation 'uk.co.conoregan:themoviedbapi:2.1.1'
 }
 

src/main/java/module-info.java

@@ -4,6 +4,7 @@
     requires javafx.fxml;
     requires javafx.controls;
     requires org.apache.commons.io;
+    requires org.apache.commons.lang3;
     requires org.slf4j;
 
     opens uk.co.conoregan.showrenamer to javafx.fxml, javafx.graphics;

src/main/java/uk/co/conoregan/showrenamer/suggestion/FileSuggestionProvider.java

@@ -22,6 +22,7 @@
 import java.util.Optional;
 
 import org.apache.commons.io.FilenameUtils;
+import org.apache.commons.lang3.SystemUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import uk.co.conoregan.showrenamer.api.ShowResultProvider;
@@ -124,6 +125,13 @@ public Optional<File> getImprovedName(final File file) {
                     .replace("{year}", String.valueOf(showResult.get().date().getYear()));
         }
 
+        if (SystemUtils.IS_OS_WINDOWS) {
+            newFileName = StringUtils.removeForbiddenCharsWindows(newFileName);
+        }
+        else if (SystemUtils.IS_OS_UNIX) {
+            newFileName = StringUtils.removeForbiddenCharsUnix(newFileName);
+        }
+
         return Optional.of(new File(StringUtils.replaceLastOccurrence(file.getAbsolutePath(), fileName, newFileName)));
     }
 }

src/main/java/uk/co/conoregan/showrenamer/util/StringUtils.java

@@ -41,4 +41,26 @@ public static String replaceLastOccurrence(final String original, final String t
 
         return original;
     }
+
+    /**
+     * Removes forbidden chars from the text. For Windows based Operating Systems.
+     * A forbidden char in this context is a char that is not allowed to be used within a filename.
+     *
+     * @param text the text to remove forbidden chars from.
+     * @return the text with forbidden chars removed.
+     */
+    public static String removeForbiddenCharsWindows(final String text) {
+        return text.replaceAll("[<>:\"/\\\\|?*]", "");
+    }
+
+    /**
+     * Removes forbidden chars from the text. For Unix based Operating Systems.
+     * A forbidden char in this context is a char that is not allowed to be used within a filename.
+     *
+     * @param text the text to remove forbidden chars from.
+     * @return the text with forbidden chars removed.
+     */
+    public static String removeForbiddenCharsUnix(final String text) {
+        return text.replaceAll("/", "");
+    }
 }

src/test/java/uk/co/conoregan/showrenamer/util/StringUtilsTest.java

@@ -45,4 +45,30 @@ public void testReplaceLastOccurrenceToReplaceNotExisting() {
 
         Assertions.assertEquals("TestTest", result);
     }
+
+    @Test
+    public void testRemoveForbiddenCharsWindows() {
+        String testString = "test <>:\"/\\|?*";
+
+        Assertions.assertTrue(StringUtils.removeForbiddenCharsWindows(testString).contains("test"));
+
+        Assertions.assertFalse(StringUtils.removeForbiddenCharsWindows(testString).contains("<"));
+        Assertions.assertFalse(StringUtils.removeForbiddenCharsWindows(testString).contains(">"));
+        Assertions.assertFalse(StringUtils.removeForbiddenCharsWindows(testString).contains(":"));
+        Assertions.assertFalse(StringUtils.removeForbiddenCharsWindows(testString).contains("\""));
+        Assertions.assertFalse(StringUtils.removeForbiddenCharsWindows(testString).contains("/"));
+        Assertions.assertFalse(StringUtils.removeForbiddenCharsWindows(testString).contains("\\"));
+        Assertions.assertFalse(StringUtils.removeForbiddenCharsWindows(testString).contains("|"));
+        Assertions.assertFalse(StringUtils.removeForbiddenCharsWindows(testString).contains("?"));
+        Assertions.assertFalse(StringUtils.removeForbiddenCharsWindows(testString).contains("*"));
+    }
+
+    @Test
+    public void testRemoveForbiddenCharsUnix() {
+        String testString = "test /";
+
+        Assertions.assertTrue(StringUtils.removeForbiddenCharsWindows(testString).contains("test"));
+
+        Assertions.assertFalse(StringUtils.removeForbiddenCharsWindows(testString).contains("/"));
+    }
 }