zip can exclude some sub file / folder.

Author: HydrolienF

src/main/java/fr/formiko/utils/FLUFiles.java

@@ -9,9 +9,11 @@
 import java.nio.file.Files;
 import java.nio.file.Paths;
 import java.nio.file.StandardOpenOption;
+import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.LinkedList;
 import java.util.List;
+import java.util.stream.Collectors;
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipFile;
 import java.util.zip.ZipInputStream;
@@ -71,7 +73,10 @@ private static void setDownloadingMessage(String message) {
     public static List<String> listFiles(String path) { return internal.listFiles(path); }
     public static List<String> listFilesRecursively(String path) { return internal.listFilesRecursively(path); }
 
-    public static boolean zip(String source, String destination) { return internal.zip(source, destination); }
+    public static boolean zip(String source, String destination) { return zip(source, destination, new ArrayList<>()); }
+    public static boolean zip(String source, String destination, List<String> excluded) {
+        return internal.zip(source, destination, excluded);
+    }
     /**
      * @param directoryInsideZipToGet If it's a/b/ then b/ will be created. To have only b content, use a/b/*
      */
@@ -94,6 +99,8 @@ public static boolean downloadAndUnzip(String url, String destination, String di
 
     public static boolean openWebLinkInBrowser(String url) { return false; }
 
+    public static String toStandardPath(String path) { return path.replace('\\', '/'); }
+
     // Internal class to hide implementation
     private static class FLUFilesInternal {
         private FLUFilesInternal() {} // hide constructor
@@ -291,16 +298,25 @@ private List<String> listFilesRecursively(String path) {
             }
         }
 
-        private boolean zip(String source, String destination) {
+        private boolean zip(String sourceIn, String destination, List<String> excluded) {
+            final String source = toStandardPath(sourceIn);
+            destination = toStandardPath(destination);
+            excluded = excluded.stream().map(FLUFiles::toStandardPath).map(s -> FLUStrings.addAtTheBeginningIfNeeded(s, source)).distinct()
+                    .collect(Collectors.toCollection(ArrayList::new));
+            excluded.add(destination);
+
+            System.out.println(excluded);
+
             if (isAValidePath(source) && isAValidePath(destination)) {
                 destination = FLUStrings.addAtTheEndIfNeeded(destination, ".zip");
                 createParents(destination);
+
                 File sourceFile = new File(source);
                 if (!sourceFile.exists()) {
                     return false;
                 }
                 try (ZipOutputStream zos = new ZipOutputStream(Files.newOutputStream(Paths.get(destination)))) {
-                    zipFile(sourceFile, sourceFile.getName(), destination, zos);
+                    zipFile(sourceFile, sourceFile.getName(), destination, zos, excluded);
                     return true;
                 } catch (IOException e) {
                     return false;
@@ -309,15 +325,21 @@ private boolean zip(String source, String destination) {
                 return false;
             }
         }
-        private void zipFile(File fileToZip, String fileName, String destination, ZipOutputStream zos) throws IOException {
+        private void zipFile(File fileToZip, String fileName, String destination, ZipOutputStream zos, List<String> excluded)
+                throws IOException {
+            for (String exclude : excluded) {
+                if (toStandardPath(fileToZip.getAbsolutePath() + (fileToZip.isDirectory() ? FILE_SEPARATOR : "")).equals(exclude)) {
+                    return;
+                }
+            }
             if (fileToZip.isDirectory()) {
                 final String finalfileName = FLUStrings.addAtTheEndIfNeeded(fileName, FILE_SEPARATOR);
                 zos.putNextEntry(new ZipEntry(finalfileName));
                 zos.closeEntry();
                 List<Boolean> allOk = Arrays.asList(true);
                 Arrays.stream(fileToZip.listFiles()).forEach(file -> {
                     try {
-                        zipFile(file, finalfileName + file.getName(), destination, zos);
+                        zipFile(file, finalfileName + file.getName(), destination, zos, excluded);
                     } catch (IOException e) {
                         allOk.set(0, false);
                     }

src/test/java/fr/formiko/utils/FLUFilesTest.java

@@ -270,7 +270,8 @@ void testListFiles(String path, boolean shouldWork, List<String> expectedFiles)
 
     private static Stream<Arguments> testListFilesSource() {
         return Stream.of(
-                Arguments.of(TEST_PATH, true, List.of("existingDir/", "existingFile.x", "existingFile2", "existingFile3", "existingFile4")),
+                Arguments.of(TEST_PATH, true,
+                        List.of("existingDir/", "dir1/", "existingFile.x", "existingFile2", "existingFile3", "existingFile4")),
                 Arguments.of(TEST_PATH + "existingDir/", true, List.of("subDir/")),
                 Arguments.of(TEST_PATH + "existingDir/subDir/", true, List.of("existingFile.txt")), Arguments.of(null, false, null),
                 Arguments.of(TEST_PATH + "unexistingDirectory", false, null));
@@ -295,6 +296,34 @@ private static Stream<Arguments> testZipSource() {
                 Arguments.of("existingDir", false, null, null), Arguments.of(null, false, null, null));
     }
 
+    @ParameterizedTest
+    @MethodSource("testZipWithExclusionSource")
+    void testZipWithExclusion(String path, boolean shouldWork, String destination, String realDestination, List<String> exclusion,
+            List<String> subItems) {
+        assertEquals(shouldWork, FLUFiles.zip(path, destination, exclusion));
+        if (shouldWork) {
+            // unzip
+            assertEquals(shouldWork, FLUFiles.unzip(destination, TEST_PATH_TEMPORARY + "TMP/", ""));
+            // check if the files are here
+            for (String s : subItems) {
+                assertTrue(new File(TEST_PATH_TEMPORARY + "TMP/dir1/" + s).exists());
+                assertTrue(FLUFiles.delete(TEST_PATH_TEMPORARY + "TMP/dir1/" + s));
+
+            }
+            assertTrue(FLUFiles.delete(realDestination));
+        }
+    }
+
+    private static Stream<Arguments> testZipWithExclusionSource() {
+        return Stream.of(
+                Arguments.of(TEST_PATH + "existingDir/", true, TEST_PATH_TEMPORARY + "existingDir.zip",
+                        TEST_PATH_TEMPORARY + "existingDir.zip", List.of(), List.of()),
+                Arguments.of(TEST_PATH + "dir1/", true, TEST_PATH_TEMPORARY + "dir1.zip", TEST_PATH_TEMPORARY + "dir1.zip",
+                        List.of("nonExistingFile.txt"), List.of("dir2/", "dir3/", "file4.md")),
+                Arguments.of(TEST_PATH + "dir1/", true, TEST_PATH_TEMPORARY + "dir1.zip", TEST_PATH_TEMPORARY + "dir1.zip",
+                        List.of("dir2/"), List.of("dir3/", "file4.md")));
+    }
+
     @ParameterizedTest
     @MethodSource("testUnzipSource")
     void testUnzip(String pathToBeZip, boolean shouldWork, String zipedFile, String pathToDownloadIntoZip, String fileToCheck) {
@@ -389,6 +418,11 @@ public static void main(String[] args) {
 
         clean();
         // FLUFiles.zip("../teavm/", "teavm.zip");
-        FLUFiles.unzip("teavm.zip", TEST_PATH_TEMPORARY, "teavm/jso/*");
+        // FLUFiles.unzip("teavm.zip", TEST_PATH_TEMPORARY, "teavm/jso/*");
+        // FLUFiles.zip("C:\\Users\\Hydrolien\\git\\paper.1.21\\", "C:\\Users\\Hydrolien\\git\\paper.1.21\\saves\\1.zip",
+        // List.of("saves/", "cache/"));
+        // FLUFiles.zip("C:/Users/Hydrolien/git/paper.1.21/", "C:/Users/Hydrolien/git/paper.1.21/save/1.zip");
+        FLUFiles.zip("C:/Users/Hydrolien/git/paper.1.21/", "C:/Users/Hydrolien/git/paper.1.21/saves/" + FLUTime.currentTime() + ".zip",
+                List.of("saves/", "cache/"));
     }
 }

src/test/resources/dir1/dir2/existingFile.txt

@@ -0,0 +1,3 @@
+ipnzéfl
+zgrebinoa
+rez bzn,

src/test/resources/dir1/dir3/existingFile.txt

@@ -0,0 +1,3 @@
+ipnzéfl
+zgrebinoa
+rez bzn,