View Javadoc
1   /**
2    * This file Copyright (c) 2015-2017 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.resourceloader.file;
35  
36  import java.io.IOException;
37  import java.nio.file.DirectoryStream;
38  import java.nio.file.Path;
39  import java.nio.file.PathMatcher;
40  import java.nio.file.Paths;
41  import java.util.ArrayList;
42  import java.util.List;
43  import java.util.regex.Pattern;
44  
45  import org.apache.commons.io.FilenameUtils;
46  
47  import com.google.common.base.Predicate;
48  
49  /**
50   * Predicate and DirectoryStream.Filter which checks a given Path is under the root and is able to exclude.
51   * <ul><li>directories</li>
52   * <li>file extensions</li>
53   * <li>any other pattern</li></ul>
54   * @see java.nio.file.DirectoryStream.Filter
55   */
56  public class ExclusionsFilter implements Predicate<Path>, DirectoryStream.Filter<Path> {
57  
58      private final Path rootPath;
59      private final List<String> excludePatterns;
60  
61      /**
62       * @param rootPath an absolute root path to evaluate paths against
63       * @param excludedDirectories directory names that will be excluded regardless of their location.
64       * @param excludedExtensions file extensions that will be excluded.
65       * @param otherPatterns regex or glob path patterns, relative to given <code>rootPath</code>. Defaults to regex: if no prefix is given.
66       * @see java.nio.file.FileSystem#getPathMatcher(java.lang.String)
67       */
68      public ExclusionsFilter(Path rootPath, List<String> excludedDirectories, List<String> excludedExtensions, List<String> otherPatterns) {
69          this.rootPath = validateRootPath(rootPath);
70          this.excludePatterns = new ArrayList<>();
71          addDirectoryExcludes(excludePatterns, excludedDirectories);
72          addExtensionExcludes(excludePatterns, excludedExtensions);
73          addPatternList(excludePatterns, otherPatterns);
74      }
75  
76      @Override
77      public boolean accept(Path entry) throws IOException {
78          return apply(entry);
79      }
80  
81      @Override
82      public boolean apply(Path dir) {
83          // is starting visiting from root directory
84          Path normalizedDir = Paths.get(FilenameUtils.normalize(dir.toString()));
85          if (!normalizedDir.isAbsolute() || !normalizedDir.startsWith(rootPath)) {
86              return false;
87          }
88  
89          Path rel = rootPath.relativize(normalizedDir);
90  
91          // is an excluded directory
92          for (String excludePattern : excludePatterns) {
93              //final PathMatcher matcher = dir.getFileSystem().getPathMatcher("regex:" + excludePattern.pattern());
94              final PathMatcher matcher = normalizedDir.getFileSystem().getPathMatcher(excludePattern);
95              if (matcher.matches(rel)) {
96                  return false;
97              }
98          }
99  
100         return true;
101     }
102 
103     private Path validateRootPath(Path rootPath) {
104         Path normalizedPath = Paths.get(FilenameUtils.normalize(rootPath.toString()));
105         if (!normalizedPath.isAbsolute()) {
106             throw new IllegalStateException(rootPath + " is not an absolute Path.");
107         }
108         return normalizedPath;
109     }
110 
111     private void addDirectoryExcludes(List<String> excludePatterns, List<String> excludedDirectories) {
112         for (String directory : excludedDirectories) {
113             excludePatterns.add("regex:(^|.*/)" + Pattern.quote(directory) + "($|/.*)");
114         }
115     }
116 
117     private void addExtensionExcludes(List<String> excludePatterns, List<String> excludedExtensions) {
118         for (String ext : excludedExtensions) {
119             excludePatterns.add("regex:.*\\." + Pattern.quote(ext) + "$");
120         }
121     }
122 
123     private void addPatternList(List<String> excludePatterns, List<String> stringPatterns) {
124         for (String pattern : stringPatterns) {
125             if (pattern.startsWith("glob:") || pattern.startsWith("regex:")) {
126                 excludePatterns.add(pattern);
127             } else {
128                 excludePatterns.add("regex:" + pattern);
129             }
130         }
131     }
132 
133 }