/* * Licensed to the Apache Software Foundation (ASF) under one or more * contributor license agreements. See the NOTICE file distributed with * this work for additional information regarding copyright ownership. * The ASF licenses this file to You under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. * */ package org.apache.tools.ant; import java.io.File; import java.io.IOException; import java.util.ArrayList; import java.util.Arrays; import java.util.HashMap; import java.util.HashSet; import java.util.Iterator; import java.util.LinkedList; import java.util.Map; import java.util.Set; import java.util.Vector; import org.apache.tools.ant.taskdefs.condition.Os; import org.apache.tools.ant.types.Resource; import org.apache.tools.ant.types.ResourceFactory; import org.apache.tools.ant.types.resources.FileResource; import org.apache.tools.ant.types.selectors.FileSelector; import org.apache.tools.ant.types.selectors.SelectorScanner; import org.apache.tools.ant.types.selectors.SelectorUtils; import org.apache.tools.ant.types.selectors.TokenizedPath; import org.apache.tools.ant.types.selectors.TokenizedPattern; import org.apache.tools.ant.util.CollectionUtils; import org.apache.tools.ant.util.FileUtils; import org.apache.tools.ant.util.SymbolicLinkUtils; import org.apache.tools.ant.util.VectorSet; /** * Class for scanning a directory for files/directories which match certain * criteria. *
* These criteria consist of selectors and patterns which have been specified. * With the selectors you can select which files you want to have included. * Files which are not selected are excluded. With patterns you can include * or exclude files based on their filename. *
* The idea is simple. A given directory is recursively scanned for all files * and directories. Each file/directory is matched against a set of selectors, * including special support for matching against filenames with include and * and exclude patterns. Only files/directories which match at least one * pattern of the include pattern list or other file selector, and don't match * any pattern of the exclude pattern list or fail to match against a required * selector will be placed in the list of files/directories found. *
* When no list of include patterns is supplied, "**" will be used, which * means that everything will be matched. When no list of exclude patterns is * supplied, an empty list is used, such that nothing will be excluded. When * no selectors are supplied, none are applied. *
* The filename pattern matching is done as follows:
* The name to be matched is split up in path segments. A path segment is the
* name of a directory or file, which is bounded by
* File.separator
('/' under UNIX, '\' under Windows).
* For example, "abc/def/ghi/xyz.java" is split up in the segments "abc",
* "def","ghi" and "xyz.java".
* The same is done for the pattern against which should be matched.
*
* The segments of the name and the pattern are then matched against each * other. When '**' is used for a path segment in the pattern, it matches * zero or more path segments of the name. *
* There is a special case regarding the use of File.separator
s
* at the beginning of the pattern and the string to match:
* When a pattern starts with a File.separator
, the string
* to match must also start with a File.separator
.
* When a pattern does not start with a File.separator
, the
* string to match may not start with a File.separator
.
* When one of these rules is not obeyed, the string will not
* match.
*
* When a name path segment is matched against a pattern path segment, the
* following special characters can be used:
* '*' matches zero or more characters
* '?' matches one character.
*
* Examples: *
* "**\*.class" matches all .class files/dirs in a directory tree. *
* "test\a??.java" matches all files/dirs which start with an 'a', then two * more characters and then ".java", in a directory called test. *
* "**" matches everything in a directory tree. *
* "**\test\**\XYZ*" matches all files/dirs which start with "XYZ" and where * there is a parent directory called test (e.g. "abc\test\def\ghi\XYZ123"). *
* Case sensitivity may be turned off if necessary. By default, it is * turned on. *
* Example of usage: *
* String[] includes = {"**\\*.class"}; * String[] excludes = {"modules\\*\\**"}; * ds.setIncludes(includes); * ds.setExcludes(excludes); * ds.setBasedir(new File("test")); * ds.setCaseSensitive(true); * ds.scan(); * * System.out.println("FILES:"); * String[] files = ds.getIncludedFiles(); * for (int i = 0; i < files.length; i++) { * System.out.println(files[i]); * } ** This will scan a directory called test for .class files, but excludes all * files in all proper subdirectories of a directory called "modules". * */ public class DirectoryScanner implements FileScanner, SelectorScanner, ResourceFactory { /** Is OpenVMS the operating system we're running on? */ private static final boolean ON_VMS = Os.isFamily("openvms"); /** * Patterns which should be excluded by default. * *
Note that you can now add patterns to the list of default * excludes. Added patterns will not become part of this array * that has only been kept around for backwards compatibility * reasons.
* * @deprecated since 1.6.x. * Use the {@link #getDefaultExcludes getDefaultExcludes} * method instead. */ @Deprecated protected static final String[] DEFAULTEXCLUDES = { // Miscellaneous typical temporary files SelectorUtils.DEEP_TREE_MATCH + "/*~", SelectorUtils.DEEP_TREE_MATCH + "/#*#", SelectorUtils.DEEP_TREE_MATCH + "/.#*", SelectorUtils.DEEP_TREE_MATCH + "/%*%", SelectorUtils.DEEP_TREE_MATCH + "/._*", // CVS SelectorUtils.DEEP_TREE_MATCH + "/CVS", SelectorUtils.DEEP_TREE_MATCH + "/CVS/" + SelectorUtils.DEEP_TREE_MATCH, SelectorUtils.DEEP_TREE_MATCH + "/.cvsignore", // SCCS SelectorUtils.DEEP_TREE_MATCH + "/SCCS", SelectorUtils.DEEP_TREE_MATCH + "/SCCS/" + SelectorUtils.DEEP_TREE_MATCH, // Visual SourceSafe SelectorUtils.DEEP_TREE_MATCH + "/vssver.scc", // Subversion SelectorUtils.DEEP_TREE_MATCH + "/.svn", SelectorUtils.DEEP_TREE_MATCH + "/.svn/" + SelectorUtils.DEEP_TREE_MATCH, // Git SelectorUtils.DEEP_TREE_MATCH + "/.git", SelectorUtils.DEEP_TREE_MATCH + "/.git/" + SelectorUtils.DEEP_TREE_MATCH, SelectorUtils.DEEP_TREE_MATCH + "/.gitattributes", SelectorUtils.DEEP_TREE_MATCH + "/.gitignore", SelectorUtils.DEEP_TREE_MATCH + "/.gitmodules", // Mercurial SelectorUtils.DEEP_TREE_MATCH + "/.hg", SelectorUtils.DEEP_TREE_MATCH + "/.hg/" + SelectorUtils.DEEP_TREE_MATCH, SelectorUtils.DEEP_TREE_MATCH + "/.hgignore", SelectorUtils.DEEP_TREE_MATCH + "/.hgsub", SelectorUtils.DEEP_TREE_MATCH + "/.hgsubstate", SelectorUtils.DEEP_TREE_MATCH + "/.hgtags", // Bazaar SelectorUtils.DEEP_TREE_MATCH + "/.bzr", SelectorUtils.DEEP_TREE_MATCH + "/.bzr/" + SelectorUtils.DEEP_TREE_MATCH, SelectorUtils.DEEP_TREE_MATCH + "/.bzrignore", // Mac SelectorUtils.DEEP_TREE_MATCH + "/.DS_Store" }; /** * default value for {@link #maxLevelsOfSymlinks maxLevelsOfSymlinks} * @since Ant 1.8.0 */ public static final int MAX_LEVELS_OF_SYMLINKS = 5; /** * The end of the exception message if something that should be * there doesn't exist. */ public static final String DOES_NOT_EXIST_POSTFIX = " does not exist."; /** Helper. */ private static final FileUtils FILE_UTILS = FileUtils.getFileUtils(); /** Helper. */ private static final SymbolicLinkUtils SYMLINK_UTILS = SymbolicLinkUtils.getSymbolicLinkUtils(); /** * Patterns which should be excluded by default. * * @see #addDefaultExcludes() */ private static final SetMaps pattern string to TokenizedPath.
* *If this instance is not case sensitive, the file names get * turned to upper case.
* *Gets lazily initialized on the first invocation of * isIncluded or isExcluded and cleared at the end of the scan * method (cleared in clearCaches, actually).
* * @since Ant 1.8.0 */ private final MapMaps pattern string to TokenizedPath.
* *If this instance is not case sensitive, the file names get * turned to upper case.
* *Gets lazily initialized on the first invocation of * isIncluded or isExcluded and cleared at the end of the scan * method (cleared in clearCaches, actually).
* * @since Ant 1.8.0 */ private final MapGets lazily initialized on the first invocation of * isIncluded or isExcluded and cleared at the end of the scan * method (cleared in clearCaches, actually).
*/ private TokenizedPattern[] includePatterns; /** * Array of all exclude patterns that contain wildcards. * *Gets lazily initialized on the first invocation of * isIncluded or isExcluded and cleared at the end of the scan * method (cleared in clearCaches, actually).
*/ private TokenizedPattern[] excludePatterns; /** * Have the non-pattern sets and pattern arrays for in- and * excludes been initialized? * * @since Ant 1.6.3 */ private boolean areNonPatternSetsReady = false; /** * Scanning flag. * * @since Ant 1.6.3 */ private boolean scanning = false; /** * Scanning lock. * * @since Ant 1.6.3 */ private final Object scanLock = new Object(); /** * Slow scanning flag. * * @since Ant 1.6.3 */ private boolean slowScanning = false; /** * Slow scanning lock. * * @since Ant 1.6.3 */ private final Object slowScanLock = new Object(); /** * Exception thrown during scan. * * @since Ant 1.6.3 */ private IllegalStateException illegal = null; /** * The maximum number of times a symbolic link may be followed * during a scan. * * @since Ant 1.8.0 */ private int maxLevelsOfSymlinks = MAX_LEVELS_OF_SYMLINKS; /** * Absolute paths of all symlinks that haven't been followed but * would have been if followsymlinks had been true or * maxLevelsOfSymlinks had been higher. * * @since Ant 1.8.0 */ private final Set
* This is not a general purpose test and should only be used if you
* can live with false positives. For example, pattern=**\a
* and str=b
will yield true
.
*
* @param pattern The pattern to match against. Must not be
* null
.
* @param str The path to match, as a String. Must not be
* null
.
*
* @return whether or not a given path matches the start of a given
* pattern up to the first "**".
*/
protected static boolean matchPatternStart(final String pattern, final String str) {
return SelectorUtils.matchPatternStart(pattern, str);
}
/**
* Test whether or not a given path matches the start of a given
* pattern up to the first "**".
*
* This is not a general purpose test and should only be used if you
* can live with false positives. For example, pattern=**\a
* and str=b
will yield true
.
*
* @param pattern The pattern to match against. Must not be
* null
.
* @param str The path to match, as a String. Must not be
* null
.
* @param isCaseSensitive Whether or not matching should be performed
* case sensitively.
*
* @return whether or not a given path matches the start of a given
* pattern up to the first "**".
*/
protected static boolean matchPatternStart(final String pattern, final String str,
final boolean isCaseSensitive) {
return SelectorUtils.matchPatternStart(pattern, str, isCaseSensitive);
}
/**
* Test whether or not a given path matches a given pattern.
*
* @param pattern The pattern to match against. Must not be
* null
.
* @param str The path to match, as a String. Must not be
* null
.
*
* @return true
if the pattern matches against the string,
* or false
otherwise.
*/
protected static boolean matchPath(final String pattern, final String str) {
return SelectorUtils.matchPath(pattern, str);
}
/**
* Test whether or not a given path matches a given pattern.
*
* @param pattern The pattern to match against. Must not be
* null
.
* @param str The path to match, as a String. Must not be
* null
.
* @param isCaseSensitive Whether or not matching should be performed
* case sensitively.
*
* @return true
if the pattern matches against the string,
* or false
otherwise.
*/
protected static boolean matchPath(final String pattern, final String str,
final boolean isCaseSensitive) {
return SelectorUtils.matchPath(pattern, str, isCaseSensitive);
}
/**
* Test whether or not a string matches against a pattern.
* The pattern may contain two special characters:
* '*' means zero or more characters
* '?' means one and only one character
*
* @param pattern The pattern to match against.
* Must not be null
.
* @param str The string which must be matched against the pattern.
* Must not be null
.
*
* @return true
if the string matches against the pattern,
* or false
otherwise.
*/
public static boolean match(final String pattern, final String str) {
return SelectorUtils.match(pattern, str);
}
/**
* Test whether or not a string matches against a pattern.
* The pattern may contain two special characters:
* '*' means zero or more characters
* '?' means one and only one character
*
* @param pattern The pattern to match against.
* Must not be null
.
* @param str The string which must be matched against the pattern.
* Must not be null
.
* @param isCaseSensitive Whether or not matching should be performed
* case sensitively.
*
*
* @return true
if the string matches against the pattern,
* or false
otherwise.
*/
protected static boolean match(final String pattern, final String str,
final boolean isCaseSensitive) {
return SelectorUtils.match(pattern, str, isCaseSensitive);
}
/**
* Get the list of patterns that should be excluded by default.
*
* @return An array of String
based on the current
* contents of the defaultExcludes
* Set
.
*
* @since Ant 1.6
*/
public static String[] getDefaultExcludes() {
synchronized (defaultExcludes) {
return defaultExcludes.toArray(new String[defaultExcludes
.size()]);
}
}
/**
* Add a pattern to the default excludes unless it is already a
* default exclude.
*
* @param s A string to add as an exclude pattern.
* @return true
if the string was added;
* false
if it already existed.
*
* @since Ant 1.6
*/
public static boolean addDefaultExclude(final String s) {
synchronized (defaultExcludes) {
return defaultExcludes.add(s);
}
}
/**
* Remove a string if it is a default exclude.
*
* @param s The string to attempt to remove.
* @return true
if s
was a default
* exclude (and thus was removed);
* false
if s
was not
* in the default excludes list to begin with.
*
* @since Ant 1.6
*/
public static boolean removeDefaultExclude(final String s) {
synchronized (defaultExcludes) {
return defaultExcludes.remove(s);
}
}
/**
* Go back to the hardwired default exclude patterns.
*
* @since Ant 1.6
*/
public static void resetDefaultExcludes() {
synchronized (defaultExcludes) {
defaultExcludes.clear();
for (int i = 0; i < DEFAULTEXCLUDES.length; i++) {
defaultExcludes.add(DEFAULTEXCLUDES[i]);
}
}
}
/**
* Set the base directory to be scanned. This is the directory which is
* scanned recursively. All '/' and '\' characters are replaced by
* File.separatorChar
, so the separator used need not match
* File.separatorChar
.
*
* @param basedir The base directory to scan.
*/
public void setBasedir(final String basedir) {
setBasedir(basedir == null ? (File) null
: new File(basedir.replace('/', File.separatorChar).replace(
'\\', File.separatorChar)));
}
/**
* Set the base directory to be scanned. This is the directory which is
* scanned recursively.
*
* @param basedir The base directory for scanning.
*/
public synchronized void setBasedir(final File basedir) {
this.basedir = basedir;
}
/**
* Return the base directory to be scanned.
* This is the directory which is scanned recursively.
*
* @return the base directory to be scanned.
*/
public synchronized File getBasedir() {
return basedir;
}
/**
* Find out whether include exclude patterns are matched in a
* case sensitive way.
* @return whether or not the scanning is case sensitive.
* @since Ant 1.6
*/
public synchronized boolean isCaseSensitive() {
return isCaseSensitive;
}
/**
* Set whether or not include and exclude patterns are matched
* in a case sensitive way.
*
* @param isCaseSensitive whether or not the file system should be
* regarded as a case sensitive one.
*/
public synchronized void setCaseSensitive(final boolean isCaseSensitive) {
this.isCaseSensitive = isCaseSensitive;
}
/**
* Sets whether or not a missing base directory is an error
*
* @param errorOnMissingDir whether or not a missing base directory
* is an error
* @since Ant 1.7.1
*/
public void setErrorOnMissingDir(final boolean errorOnMissingDir) {
this.errorOnMissingDir = errorOnMissingDir;
}
/**
* Get whether or not a DirectoryScanner follows symbolic links.
*
* @return flag indicating whether symbolic links should be followed.
*
* @since Ant 1.6
*/
public synchronized boolean isFollowSymlinks() {
return followSymlinks;
}
/**
* Set whether or not symbolic links should be followed.
*
* @param followSymlinks whether or not symbolic links should be followed.
*/
public synchronized void setFollowSymlinks(final boolean followSymlinks) {
this.followSymlinks = followSymlinks;
}
/**
* The maximum number of times a symbolic link may be followed
* during a scan.
*
* @since Ant 1.8.0
*/
public void setMaxLevelsOfSymlinks(final int max) {
maxLevelsOfSymlinks = max;
}
/**
* Set the list of include patterns to use. All '/' and '\' characters
* are replaced by File.separatorChar
, so the separator used
* need not match File.separatorChar
.
*
* When a pattern ends with a '/' or '\', "**" is appended.
*
* @param includes A list of include patterns.
* May be null
, indicating that all files
* should be included. If a non-null
* list is given, all elements must be
* non-null
.
*/
public synchronized void setIncludes(final String[] includes) {
if (includes == null) {
this.includes = null;
} else {
this.includes = new String[includes.length];
for (int i = 0; i < includes.length; i++) {
this.includes[i] = normalizePattern(includes[i]);
}
}
}
/**
* Set the list of exclude patterns to use. All '/' and '\' characters
* are replaced by File.separatorChar
, so the separator used
* need not match File.separatorChar
.
*
* When a pattern ends with a '/' or '\', "**" is appended.
*
* @param excludes A list of exclude patterns.
* May be null
, indicating that no files
* should be excluded. If a non-null
list is
* given, all elements must be non-null
.
*/
public synchronized void setExcludes(final String[] excludes) {
if (excludes == null) {
this.excludes = null;
} else {
this.excludes = new String[excludes.length];
for (int i = 0; i < excludes.length; i++) {
this.excludes[i] = normalizePattern(excludes[i]);
}
}
}
/**
* Add to the list of exclude patterns to use. All '/' and '\'
* characters are replaced by File.separatorChar
, so
* the separator used need not match File.separatorChar
.
*
* When a pattern ends with a '/' or '\', "**" is appended.
*
* @param excludes A list of exclude patterns.
* May be null
, in which case the
* exclude patterns don't get changed at all.
*
* @since Ant 1.6.3
*/
public synchronized void addExcludes(final String[] excludes) {
if (excludes != null && excludes.length > 0) {
if (this.excludes != null && this.excludes.length > 0) {
final String[] tmp = new String[excludes.length
+ this.excludes.length];
System.arraycopy(this.excludes, 0, tmp, 0,
this.excludes.length);
for (int i = 0; i < excludes.length; i++) {
tmp[this.excludes.length + i] =
normalizePattern(excludes[i]);
}
this.excludes = tmp;
} else {
setExcludes(excludes);
}
}
}
/**
* All '/' and '\' characters are replaced by
* File.separatorChar
, so the separator used need not
* match File.separatorChar
.
*
*
When a pattern ends with a '/' or '\', "**" is appended.
*
* @since Ant 1.6.3
*/
private static String normalizePattern(final String p) {
String pattern = p.replace('/', File.separatorChar)
.replace('\\', File.separatorChar);
if (pattern.endsWith(File.separator)) {
pattern += SelectorUtils.DEEP_TREE_MATCH;
}
return pattern;
}
/**
* Set the selectors that will select the filelist.
*
* @param selectors specifies the selectors to be invoked on a scan.
*/
public synchronized void setSelectors(final FileSelector[] selectors) {
this.selectors = selectors;
}
/**
* Return whether or not the scanner has included all the files or
* directories it has come across so far.
*
* @return
* Returns immediately if a slow scan has already been completed.
*/
protected void slowScan() {
synchronized (slowScanLock) {
if (haveSlowResults) {
return;
}
if (slowScanning) {
while (slowScanning) {
try {
slowScanLock.wait();
} catch (final InterruptedException e) {
// Empty
}
}
return;
}
slowScanning = true;
}
try {
synchronized (this) {
// set in/excludes to reasonable defaults if needed:
final boolean nullIncludes = (includes == null);
includes = nullIncludes
? new String[] {SelectorUtils.DEEP_TREE_MATCH} : includes;
final boolean nullExcludes = (excludes == null);
excludes = nullExcludes ? new String[0] : excludes;
final String[] excl = new String[dirsExcluded.size()];
dirsExcluded.copyInto(excl);
final String[] notIncl = new String[dirsNotIncluded.size()];
dirsNotIncluded.copyInto(notIncl);
ensureNonPatternSetsReady();
processSlowScan(excl);
processSlowScan(notIncl);
clearCaches();
includes = nullIncludes ? null : includes;
excludes = nullExcludes ? null : excludes;
}
} finally {
synchronized (slowScanLock) {
haveSlowResults = true;
slowScanning = false;
slowScanLock.notifyAll();
}
}
}
private void processSlowScan(final String[] arr) {
for (int i = 0; i < arr.length; i++) {
final TokenizedPath path = new TokenizedPath(arr[i]);
if (!couldHoldIncluded(path) || contentsExcluded(path)) {
scandir(new File(basedir, arr[i]), path, false);
}
}
}
/**
* Scan the given directory for files and directories. Found files and
* directories are placed in their respective collections, based on the
* matching of includes, excludes, and the selectors. When a directory
* is found, it is scanned recursively.
*
* @param dir The directory to scan. Must not be Return the names of the files which were selected out and
* therefore not ultimately included. The names are relative to the base directory. This involves
* performing a slow scan if one has not already been completed. Return the names of the directories which were selected out and
* therefore not ultimately included. The names are relative to the base directory. This involves
* performing a slow scan if one has not already been completed. Registers the given directory as scanned as a side effect. Can only happen if the given directory has been seen at
* least more often than allowed during the current scan and it is
* a symbolic link and enough other occurrences of the same name
* higher up are symbolic links that point to the same place.true
if all files and directories which have
* been found so far have been included.
*/
public synchronized boolean isEverythingIncluded() {
return everythingIncluded;
}
/**
* Scan for files which match at least one include pattern and don't match
* any exclude patterns. If there are selectors then the files must pass
* muster there, as well. Scans under basedir, if set; otherwise the
* include patterns without leading wildcards specify the absolute paths of
* the files that may be included.
*
* @exception IllegalStateException if the base directory was set
* incorrectly (i.e. if it doesn't exist or isn't a directory).
*/
public void scan() throws IllegalStateException {
synchronized (scanLock) {
if (scanning) {
while (scanning) {
try {
scanLock.wait();
} catch (final InterruptedException e) {
continue;
}
}
if (illegal != null) {
throw illegal;
}
return;
}
scanning = true;
}
final File savedBase = basedir;
try {
synchronized (this) {
illegal = null;
clearResults();
// set in/excludes to reasonable defaults if needed:
final boolean nullIncludes = (includes == null);
includes = nullIncludes
? new String[] {SelectorUtils.DEEP_TREE_MATCH} : includes;
final boolean nullExcludes = (excludes == null);
excludes = nullExcludes ? new String[0] : excludes;
if (basedir != null && !followSymlinks
&& SYMLINK_UTILS.isSymbolicLink(basedir)) {
notFollowedSymlinks.add(basedir.getAbsolutePath());
basedir = null;
}
if (basedir == null) {
// if no basedir and no includes, nothing to do:
if (nullIncludes) {
return;
}
} else {
if (!basedir.exists()) {
if (errorOnMissingDir) {
illegal = new IllegalStateException("basedir "
+ basedir
+ DOES_NOT_EXIST_POSTFIX);
} else {
// Nothing to do - basedir does not exist
return;
}
} else if (!basedir.isDirectory()) {
illegal = new IllegalStateException("basedir "
+ basedir
+ " is not a"
+ " directory.");
}
if (illegal != null) {
throw illegal;
}
}
if (isIncluded(TokenizedPath.EMPTY_PATH)) {
if (!isExcluded(TokenizedPath.EMPTY_PATH)) {
if (isSelected("", basedir)) {
dirsIncluded.addElement("");
} else {
dirsDeselected.addElement("");
}
} else {
dirsExcluded.addElement("");
}
} else {
dirsNotIncluded.addElement("");
}
checkIncludePatterns();
clearCaches();
includes = nullIncludes ? null : includes;
excludes = nullExcludes ? null : excludes;
}
} catch (final IOException ex) {
throw new BuildException(ex);
} finally {
basedir = savedBase;
synchronized (scanLock) {
scanning = false;
scanLock.notifyAll();
}
}
}
/**
* This routine is actually checking all the include patterns in
* order to avoid scanning everything under base dir.
* @since Ant 1.6
*/
private void checkIncludePatterns() {
ensureNonPatternSetsReady();
final Mapnull
.
* @param vpath The path relative to the base directory (needed to
* prevent problems with an absolute path when using
* dir). Must not be null
.
* @param fast Whether or not this call is part of a fast scan.
*
* @see #filesIncluded
* @see #filesNotIncluded
* @see #filesExcluded
* @see #dirsIncluded
* @see #dirsNotIncluded
* @see #dirsExcluded
* @see #slowScan
*/
protected void scandir(final File dir, final String vpath, final boolean fast) {
scandir(dir, new TokenizedPath(vpath), fast);
}
/**
* Scan the given directory for files and directories. Found files and
* directories are placed in their respective collections, based on the
* matching of includes, excludes, and the selectors. When a directory
* is found, it is scanned recursively.
*
* @param dir The directory to scan. Must not be null
.
* @param path The path relative to the base directory (needed to
* prevent problems with an absolute path when using
* dir). Must not be null
.
* @param fast Whether or not this call is part of a fast scan.
*
* @see #filesIncluded
* @see #filesNotIncluded
* @see #filesExcluded
* @see #dirsIncluded
* @see #dirsNotIncluded
* @see #dirsExcluded
* @see #slowScan
*/
private void scandir(final File dir, final TokenizedPath path, final boolean fast) {
if (dir == null) {
throw new BuildException("dir must not be null.");
}
final String[] newfiles = dir.list();
if (newfiles == null) {
if (!dir.exists()) {
throw new BuildException(dir + DOES_NOT_EXIST_POSTFIX);
} else if (!dir.isDirectory()) {
throw new BuildException(dir + " is not a directory.");
} else {
throw new BuildException("IO error scanning directory '"
+ dir.getAbsolutePath() + "'");
}
}
scandir(dir, path, fast, newfiles, new LinkedListnull
.
* @return true
when the name matches against at least one
* include pattern, or false
otherwise.
*/
protected boolean isIncluded(final String name) {
return isIncluded(new TokenizedPath(name));
}
/**
* Test whether or not a name matches against at least one include
* pattern.
*
* @param name The name to match. Must not be null
.
* @return true
when the name matches against at least one
* include pattern, or false
otherwise.
*/
private boolean isIncluded(final TokenizedPath path) {
ensureNonPatternSetsReady();
if (isCaseSensitive()
? includeNonPatterns.containsKey(path.toString())
: includeNonPatterns.containsKey(path.toString().toUpperCase())) {
return true;
}
for (int i = 0; i < includePatterns.length; i++) {
if (includePatterns[i].matchPath(path, isCaseSensitive())) {
return true;
}
}
return false;
}
/**
* Test whether or not a name matches the start of at least one include
* pattern.
*
* @param name The name to match. Must not be null
.
* @return true
when the name matches against the start of at
* least one include pattern, or false
otherwise.
*/
protected boolean couldHoldIncluded(final String name) {
return couldHoldIncluded(new TokenizedPath(name));
}
/**
* Test whether or not a name matches the start of at least one include
* pattern.
*
* @param tokenizedName The name to match. Must not be null
.
* @return true
when the name matches against the start of at
* least one include pattern, or false
otherwise.
*/
private boolean couldHoldIncluded(final TokenizedPath tokenizedName) {
for (int i = 0; i < includePatterns.length; i++) {
if (couldHoldIncluded(tokenizedName, includePatterns[i])) {
return true;
}
}
for (final Iteratornull
.
* @return true
when the name matches against the start of the
* include pattern, or false
otherwise.
*/
private boolean couldHoldIncluded(final TokenizedPath tokenizedName,
final TokenizedPattern tokenizedInclude) {
return tokenizedInclude.matchStartOf(tokenizedName, isCaseSensitive())
&& isMorePowerfulThanExcludes(tokenizedName.toString())
&& isDeeper(tokenizedInclude, tokenizedName);
}
/**
* Verify that a pattern specifies files deeper
* than the level of the specified file.
* @param pattern the pattern to check.
* @param name the name to check.
* @return whether the pattern is deeper than the name.
* @since Ant 1.6.3
*/
private boolean isDeeper(final TokenizedPattern pattern, final TokenizedPath name) {
return pattern.containsPattern(SelectorUtils.DEEP_TREE_MATCH)
|| pattern.depth() > name.depth();
}
/**
* Find out whether one particular include pattern is more powerful
* than all the excludes.
* Note: the power comparison is based on the length of the include pattern
* and of the exclude patterns without the wildcards.
* Ideally the comparison should be done based on the depth
* of the match; that is to say how many file separators have been matched
* before the first ** or the end of the pattern.
*
* IMPORTANT : this function should return false "with care".
*
* @param name the relative path to test.
* @return true if there is no exclude pattern more powerful than
* this include pattern.
* @since Ant 1.6
*/
private boolean isMorePowerfulThanExcludes(final String name) {
final String soughtexclude =
name + File.separatorChar + SelectorUtils.DEEP_TREE_MATCH;
for (int counter = 0; counter < excludePatterns.length; counter++) {
if (excludePatterns[counter].toString().equals(soughtexclude)) {
return false;
}
}
return true;
}
/**
* Test whether all contents of the specified directory must be excluded.
* @param path the path to check.
* @return whether all the specified directory's contents are excluded.
*/
/* package */ boolean contentsExcluded(final TokenizedPath path) {
for (int i = 0; i < excludePatterns.length; i++) {
if (excludePatterns[i].endsWith(SelectorUtils.DEEP_TREE_MATCH)
&& excludePatterns[i].withoutLastToken()
.matchPath(path, isCaseSensitive())) {
return true;
}
}
return false;
}
/**
* Test whether or not a name matches against at least one exclude
* pattern.
*
* @param name The name to match. Must not be null
.
* @return true
when the name matches against at least one
* exclude pattern, or false
otherwise.
*/
protected boolean isExcluded(final String name) {
return isExcluded(new TokenizedPath(name));
}
/**
* Test whether or not a name matches against at least one exclude
* pattern.
*
* @param name The name to match. Must not be null
.
* @return true
when the name matches against at least one
* exclude pattern, or false
otherwise.
*/
private boolean isExcluded(final TokenizedPath name) {
ensureNonPatternSetsReady();
if (isCaseSensitive()
? excludeNonPatterns.containsKey(name.toString())
: excludeNonPatterns.containsKey(name.toString().toUpperCase())) {
return true;
}
for (int i = 0; i < excludePatterns.length; i++) {
if (excludePatterns[i].matchPath(name, isCaseSensitive())) {
return true;
}
}
return false;
}
/**
* Test whether a file should be selected.
*
* @param name the filename to check for selecting.
* @param file the java.io.File object for this filename.
* @return false
when the selectors says that the file
* should not be selected, true
otherwise.
*/
protected boolean isSelected(final String name, final File file) {
if (selectors != null) {
for (int i = 0; i < selectors.length; i++) {
if (!selectors[i].isSelected(basedir, name, file)) {
return false;
}
}
}
return true;
}
/**
* Return the names of the files which matched at least one of the
* include patterns and none of the exclude patterns.
* The names are relative to the base directory.
*
* @return the names of the files which matched at least one of the
* include patterns and none of the exclude patterns.
*/
public String[] getIncludedFiles() {
String[] files;
synchronized (this) {
if (filesIncluded == null) {
throw new IllegalStateException("Must call scan() first");
}
files = new String[filesIncluded.size()];
filesIncluded.copyInto(files);
}
Arrays.sort(files);
return files;
}
/**
* Return the count of included files.
* @return int
.
* @since Ant 1.6.3
*/
public synchronized int getIncludedFilesCount() {
if (filesIncluded == null) {
throw new IllegalStateException("Must call scan() first");
}
return filesIncluded.size();
}
/**
* Return the names of the files which matched none of the include
* patterns. The names are relative to the base directory. This involves
* performing a slow scan if one has not already been completed.
*
* @return the names of the files which matched none of the include
* patterns.
*
* @see #slowScan
*/
public synchronized String[] getNotIncludedFiles() {
slowScan();
final String[] files = new String[filesNotIncluded.size()];
filesNotIncluded.copyInto(files);
return files;
}
/**
* Return the names of the files which matched at least one of the
* include patterns and at least one of the exclude patterns.
* The names are relative to the base directory. This involves
* performing a slow scan if one has not already been completed.
*
* @return the names of the files which matched at least one of the
* include patterns and at least one of the exclude patterns.
*
* @see #slowScan
*/
public synchronized String[] getExcludedFiles() {
slowScan();
final String[] files = new String[filesExcluded.size()];
filesExcluded.copyInto(files);
return files;
}
/**
* int
.
* @since Ant 1.6.3
*/
public synchronized int getIncludedDirsCount() {
if (dirsIncluded == null) {
throw new IllegalStateException("Must call scan() first");
}
return dirsIncluded.size();
}
/**
* Return the names of the directories which matched none of the include
* patterns. The names are relative to the base directory. This involves
* performing a slow scan if one has not already been completed.
*
* @return the names of the directories which matched none of the include
* patterns.
*
* @see #slowScan
*/
public synchronized String[] getNotIncludedDirectories() {
slowScan();
final String[] directories = new String[dirsNotIncluded.size()];
dirsNotIncluded.copyInto(directories);
return directories;
}
/**
* Return the names of the directories which matched at least one of the
* include patterns and at least one of the exclude patterns.
* The names are relative to the base directory. This involves
* performing a slow scan if one has not already been completed.
*
* @return the names of the directories which matched at least one of the
* include patterns and at least one of the exclude patterns.
*
* @see #slowScan
*/
public synchronized String[] getExcludedDirectories() {
slowScan();
final String[] directories = new String[dirsExcluded.size()];
dirsExcluded.copyInto(directories);
return directories;
}
/**
*