Issue #27 - A website now takes a number of file/directory filters th…

…at are ignored on pushing or pulling
javaswift · May 10, 2013 · e404f3c · e404f3c
1 parent e07dcfe
commit e404f3c
Show file tree

Hide file tree

Showing 8 changed files with 99 additions and 10 deletions.
diff --git a/src/main/java/org/javaswift/joss/client/website/AbstractFileObjects.java b/src/main/java/org/javaswift/joss/client/website/AbstractFileObjects.java
@@ -1,13 +1,21 @@
 package org.javaswift.joss.client.website;
 
-import java.util.Collection;
-import java.util.Map;
-import java.util.TreeMap;
+import java.util.*;
 
 public abstract class AbstractFileObjects implements FileObjects {
 
     private final Map<String, FileObject> fileObjects = new TreeMap<String, FileObject>();
 
+    private final String[] ignoreFilters;
+
+    public AbstractFileObjects() {
+        this(new String[]{});
+    }
+
+    public AbstractFileObjects(final String[] ignoreFilters) {
+        this.ignoreFilters = ignoreFilters;
+    }
+
     protected void add(String path, FileObject fileObject) {
         this.fileObjects.put(path, fileObject);
     }
@@ -22,4 +30,14 @@ public FileObject get(String path) {
         return this.fileObjects.get(path);
     }
 
+    @Override
+    public boolean ignore(String path) {
+        for (String ignoreFilter : ignoreFilters) {
+            if (path.equals(ignoreFilter)) {
+                return true;
+            }
+        }
+        return false;
+    }
+
 }
diff --git a/src/main/java/org/javaswift/joss/client/website/AbstractWebsite.java b/src/main/java/org/javaswift/joss/client/website/AbstractWebsite.java
@@ -12,10 +12,18 @@
 
 public abstract class AbstractWebsite extends AbstractContainer implements Website {
 
+    private String[] ignoreFilters = new String[] {};
+
     public AbstractWebsite(Account account, String name, boolean allowCaching) {
         super(account, name, allowCaching);
     }
 
+    @Override
+    public Website setIgnoreFilters(String[] ignoreFilters) {
+        this.ignoreFilters = ignoreFilters;
+        return this;
+    }
+
     @Override
     /**
     * Websites are made public by default. If this is not desirable, the Website can be made private again
@@ -90,15 +98,15 @@ public void setListing(boolean listing) {
     @Override
     public void pushDirectory(File directory) {
         syncDirectory(
-                new LocalFileObjects(directory),    // source
+                new LocalFileObjects(directory, ignoreFilters),    // source
                 new ObjectStoreFileObjects(this));  // target
     }
 
     @Override
     public void pullDirectory(File directory) {
         syncDirectory(
                 new ObjectStoreFileObjects(this),   // target
-                new LocalFileObjects(directory));   // source
+                new LocalFileObjects(directory, ignoreFilters ));   // source
     }
 
     protected void syncDirectory(FileObjects source, FileObjects target) {
@@ -112,6 +120,9 @@ protected void syncDirectory(FileObjects source, FileObjects target) {
 
     private void deleteObjects(FileObjects source, FileObjects target) {
         for (String targetPath : target.keys()) {
+            if (target.ignore(targetPath)) {
+                continue;
+            }
             FileObject targetObject = target.get(targetPath);
             if (source.get(targetPath) == null) {
                 targetObject.delete();

diff --git a/src/main/java/org/javaswift/joss/client/website/FileObjects.java b/src/main/java/org/javaswift/joss/client/website/FileObjects.java
@@ -12,4 +12,6 @@ public interface FileObjects {
 
     void cleanup();
 
+    public boolean ignore(String path);
+
 }
diff --git a/src/main/java/org/javaswift/joss/client/website/LocalFileObjects.java b/src/main/java/org/javaswift/joss/client/website/LocalFileObjects.java
@@ -4,14 +4,17 @@
 import org.javaswift.joss.util.FileReference;
 
 import java.io.File;
+import java.util.ArrayList;
+import java.util.List;
 
 public class LocalFileObjects extends AbstractFileObjects {
 
     private final File rootDirectory;
 
-    public LocalFileObjects(File rootDirectory) {
+    public LocalFileObjects(File rootDirectory, final String[] ignoreFilters) {
+        super(ignoreFilters);
         this.rootDirectory = rootDirectory;
-        for (FileReference file : FileAction.listFiles(this.rootDirectory)) {
+        for (FileReference file : FileAction.listFiles(this.rootDirectory, ignoreFilters)) {
             add(file.getPath(), new LocalFileObject(file));
         }
     }
@@ -32,6 +35,7 @@ public void cleanup() {
         deleteEmptyDirectories(rootDirectory);
     }
 
+    @SuppressWarnings({"ConstantConditions", "ResultOfMethodCallIgnored"})
     protected void deleteEmptyDirectories(File directory) {
         for (File file : directory.listFiles()) {
             if (file.isDirectory()) {

diff --git a/src/main/java/org/javaswift/joss/model/Website.java b/src/main/java/org/javaswift/joss/model/Website.java
@@ -91,4 +91,12 @@ public interface Website extends Container {
     */
     public void pullDirectory(File directory);
 
+    /**
+    * Passes a number of files and directories that must be ignored by the push/pull mechanism. Use normal
+    * path notation using the root directory as the root path.
+    * @param ignoreFilters files/directories to be ignored
+    * @return instance of Website
+    */
+    public Website setIgnoreFilters(String[] ignoreFilters);
+
 }
diff --git a/src/main/java/org/javaswift/joss/util/FileAction.java b/src/main/java/org/javaswift/joss/util/FileAction.java
@@ -40,26 +40,43 @@ protected static void close(Closeable closeable) throws IOException {
     }
 
     public static List<FileReference> listFiles(File root) {
+        return listFiles(root, new String[] {});
+    }
+
+    public static List<FileReference> listFiles(File root, String[] ignoreFilters) {
         List<FileReference> files = new ArrayList<FileReference>();
         List<String> path = new ArrayList<String>();
         if (root.isDirectory()) {
-            listFiles(files, path, root);
+            listFiles(files, path, root, ignoreFilters);
         }
         return files;
     }
 
     @SuppressWarnings("ConstantConditions")
-    protected static void listFiles(List<FileReference> files, List<String> path, File directoryFile) {
+    protected static void listFiles(List<FileReference> files, List<String> path, File directoryFile, String[] ignoreFilters) {
         for (File currentFile : directoryFile.listFiles()) {
+            if (ignore(path, ignoreFilters)) {
+                continue;
+            }
             List<String> currentPath = getPath(path, currentFile.getName());
             if (currentFile.isDirectory()) {
-                listFiles(files, currentPath, currentFile);
+                listFiles(files, currentPath, currentFile, ignoreFilters);
             } else {
                 files.add(new FileReference(currentFile, currentPath));
             }
         }
     }
 
+    protected static boolean ignore(List<String> pathAndFile, String[] ignoreFilters) {
+        String path = FileReference.getPath(0, pathAndFile);
+        for (String ignoreFilter : ignoreFilters) {
+            if (path.equals(ignoreFilter)) {
+                return true;
+            }
+        }
+        return false;
+    }
+
     protected static List<String> getPath(List<String> currentPath, String extension) {
         List<String> path = new ArrayList<String>();
         path.addAll(currentPath);

diff --git a/src/main/java/org/javaswift/joss/util/FileReference.java b/src/main/java/org/javaswift/joss/util/FileReference.java
@@ -27,6 +27,10 @@ public String getPath() {
     }
 
     public String getPath(int startFrom) {
+        return getPath(startFrom, pathAndFile);
+    }
+
+    public static String getPath(int startFrom, List<String> pathAndFile) {
         StringBuilder path = new StringBuilder();
         int count = 0;
         for (String currentPart : pathAndFile) {

diff --git a/src/test/java/org/javaswift/joss/client/mock/WebsiteMockTest.java b/src/test/java/org/javaswift/joss/client/mock/WebsiteMockTest.java
@@ -161,6 +161,31 @@ public void deleteEmptyFolders() throws IOException, URISyntaxException {
         assertFalse(new File(writeDir.getPath()+"/script/modb").exists());
     }
 
+    @Test
+    public void ignoreFoldersOnPushing() throws IOException, URISyntaxException {
+        Swift swift = new Swift()
+                .setOnFileObjectStore("websites");
+        website = new WebsiteMock(new AccountMock(swift), "website")
+                .setIgnoreFilters(new String[] {"script"} );
+        website.pushDirectory(FileAction.getFile("websites/website"));
+        assertEquals(4, website.list().size());
+    }
+
+    @SuppressWarnings("ConstantConditions")
+    @Test
+    public void ignoreFileOnPulling() throws IOException, URISyntaxException {
+        Swift swift = new Swift()
+                .setOnFileObjectStore("object-store");
+        website = new WebsiteMock(new AccountMock(swift), "container1");
+        website.pullDirectory(this.writeDir);
+        assertEquals(2, writeDir.listFiles().length); // 2 files
+        website = new WebsiteMock(new AccountMock(swift), "container2")
+                .setIgnoreFilters(new String[] {"checkmark.png"});
+        website.pullDirectory(this.writeDir);
+        assertEquals(6, writeDir.listFiles().length); // 6 files, checkmark.png has not been removed
+    }
+
+
     @Test
     public void getHost() {
         Swift swift = new Swift()