/*
* Copyright 2000-2005 The Apache Software Foundation
*
* Licensed 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.jmeld.tools.ant;
import org.apache.jmeld.tools.ant.taskdefs.condition.*;
import org.apache.jmeld.tools.ant.types.*;
import org.apache.jmeld.tools.ant.types.selectors.*;
import org.apache.jmeld.tools.ant.util.*;
import org.jmeld.ui.*;
import org.jmeld.util.node.*;
import java.io.*;
import java.util.*;
/**
* Class for scanning a directory for files/directories which match certain
* criteria.
* <p/>
* 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.
* <p/>
* 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.
* <p/>
* 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.
* <p/>
* 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
* <code>File.separator</code> ('/' 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.
* <p/>
* 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.
* <p/>
* There is a special case regarding the use of <code>File.separator</code>s
* at the beginning of the pattern and the string to match:<br>
* When a pattern starts with a <code>File.separator</code>, the string
* to match must also start with a <code>File.separator</code>.
* When a pattern does not start with a <code>File.separator</code>, the
* string to match may not start with a <code>File.separator</code>.
* When one of these rules is not obeyed, the string will not
* match.
* <p/>
* When a name path segment is matched against a pattern path segment, the
* following special characters can be used:<br>
* '*' matches zero or more characters<br>
* '?' matches one character.
* <p/>
* Examples:
* <p/>
* "**\*.class" matches all .class files/dirs in a directory tree.
* <p/>
* "test\a??.java" matches all files/dirs which start with an 'a', then two
* more characters and then ".java", in a directory called test.
* <p/>
* "**" matches everything in a directory tree.
* <p/>
* "**\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").
* <p/>
* Case sensitivity may be turned off if necessary. By default, it is
* turned on.
* <p/>
* Example of usage:
* <pre>
* List includes = Arrays.asList("**\\*.class");
* List excludes = Arrays.asList("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]);
* }
* </pre>
* 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 SelectorScanner, ResourceFactory {
/**
* Is OpenVMS the operating system we're running on?
*/
private static final boolean ON_VMS = Os.isFamily("openvms");
/**
* Helper.
*/
private static final FileUtils FILE_UTILS = FileUtils.getFileUtils();
/**
* iterations for case-sensitive scanning.
*/
private static final boolean[] CS_SCAN_ONLY = new boolean[]{true};
/**
* iterations for non-case-sensitive scanning.
*/
private static final boolean[] CS_THEN_NON_CS = new boolean[]{true, false};
/**
* Show state information in the statusbar.
*/
private boolean showStateOn;
/**
* The base directory to be scanned.
*/
protected File basedir;
/**
* The patterns for the files to be included.
*/
protected List<String> includes = Arrays.asList("**");
/**
* The patterns for the files to be excluded.
*/
protected List<String> excludes = new ArrayList<String>();
/**
* Selectors that will filter which files are in our candidate list.
*/
protected FileSelector[] selectors = null;
/**
* The files which matched at least one include and no excludes
* and were selected.
*/
protected List filesIncluded;
protected Map<String, FileNode> filesIncludedMap;
/**
* The files which did not match any includes or selectors.
*/
protected List filesNotIncluded;
/**
* The files which matched at least one include and at least
* one exclude.
*/
protected List filesExcluded;
/**
* The directories which matched at least one include and no excludes
* and were selected.
*/
protected List<String> dirsIncluded;
protected Map<String, FileNode> dirsIncludedMap;
/**
* The directories which were found and did not match any includes.
*/
protected List<String> dirsNotIncluded;
/**
* The directories which matched at least one include and at least one
* exclude.
*/
protected List<String> dirsExcluded;
/**
* The files which matched at least one include and no excludes and
* which a selector discarded.
*/
protected List<String> filesDeselected;
/**
* The directories which matched at least one include and no excludes
* but which a selector discarded.
*/
protected List<String> dirsDeselected;
/**
* Whether or not our results were built by a slow scan.
*/
protected boolean haveSlowResults = false;
/**
* Whether or not the file system should be treated as a case sensitive
* one.
*/
protected boolean isCaseSensitive = true;
/**
* Whether or not symbolic links should be followed.
*
* @since Ant 1.5
*/
private boolean followSymlinks = true;
/**
* Whether or not everything tested so far has been included.
*/
protected boolean everythingIncluded = true;
/**
* Temporary table to speed up the various scanning methods.
*
* @since Ant 1.6
*/
private Map fileListMap = new HashMap();
/**
* List of all scanned directories.
*
* @since Ant 1.6
*/
private Set scannedDirs = new HashSet();
/**
* Set of all include patterns that are full file names and don't
* contain any wildcards.
* <p/>
* <p>If this instance is not case sensitive, the file names get
* turned to lower case.</p>
* <p/>
* <p>Gets lazily initialized on the first invocation of
* isIncluded or isExcluded and cleared at the end of the scan
* method (cleared in clearCaches, actually).</p>
*
* @since Ant 1.6.3
*/
private List<String> includeNonPatterns = new ArrayList<String>();
/**
* Set of all include patterns that are full file names and don't
* contain any wildcards.
* <p/>
* <p>If this instance is not case sensitive, the file names get
* turned to lower case.</p>
* <p/>
* <p>Gets lazily initialized on the first invocation of
* isIncluded or isExcluded and cleared at the end of the scan
* method (cleared in clearCaches, actually).</p>
*
* @since Ant 1.6.3
*/
private List<String> excludeNonPatterns = new ArrayList<String>();
/**
* Array of all include patterns that contain wildcards.
* <p/>
* <p>Gets lazily initialized on the first invocation of
* isIncluded or isExcluded and cleared at the end of the scan
* method (cleared in clearCaches, actually).</p>
*
* @since Ant 1.6.3
*/
private List<String> includePatterns;
/**
* Array of all exclude patterns that contain wildcards.
* <p/>
* <p>Gets lazily initialized on the first invocation of
* isIncluded or isExcluded and cleared at the end of the scan
* method (cleared in clearCaches, actually).</p>
*
* @since Ant 1.6.3
*/
private List<String> 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 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 Object slowScanLock = new Object();
/**
* Exception thrown during scan.
*
* @since Ant 1.6.3
*/
private IllegalStateException illegal = null;
/**
* Sole constructor.
*/
public DirectoryScanner() {
}
/**
* Test whether or not a given path matches the start of a given
* pattern up to the first "**".
* <p/>
* This is not a general purpose test and should only be used if you
* can live with false positives. For example, <code>pattern=**\a</code>
* and <code>str=b</code> will yield <code>true</code>.
*
* @param pattern The pattern to match against. Must not be
* <code>null</code>.
* @param str The path to match, as a String. Must not be
* <code>null</code>.
* @return whether or not a given path matches the start of a given
* pattern up to the first "**".
*/
protected static boolean matchPatternStart(String pattern, 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 "**".
* <p/>
* This is not a general purpose test and should only be used if you
* can live with false positives. For example, <code>pattern=**\a</code>
* and <code>str=b</code> will yield <code>true</code>.
*
* @param pattern The pattern to match against. Must not be
* <code>null</code>.
* @param str The path to match, as a String. Must not be
* <code>null</code>.
* @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(String pattern, String str,
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
* <code>null</code>.
* @param str The path to match, as a String. Must not be
* <code>null</code>.
* @return <code>true</code> if the pattern matches against the string,
* or <code>false</code> otherwise.
*/
protected static boolean matchPath(String pattern, 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
* <code>null</code>.
* @param str The path to match, as a String. Must not be
* <code>null</code>.
* @param isCaseSensitive Whether or not matching should be performed
* case sensitively.
* @return <code>true</code> if the pattern matches against the string,
* or <code>false</code> otherwise.
*/
protected static boolean matchPath(String pattern, String str,
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:<br>
* '*' means zero or more characters<br>
* '?' means one and only one character
*
* @param pattern The pattern to match against.
* Must not be <code>null</code>.
* @param str The string which must be matched against the pattern.
* Must not be <code>null</code>.
* @return <code>true</code> if the string matches against the pattern,
* or <code>false</code> otherwise.
*/
public static boolean match(String pattern, String str) {
return SelectorUtils.match(pattern, str);
}
/**
* Test whether or not a string matches against a pattern.
* The pattern may contain two special characters:<br>
* '*' means zero or more characters<br>
* '?' means one and only one character
*
* @param pattern The pattern to match against.
* Must not be <code>null</code>.
* @param str The string which must be matched against the pattern.
* Must not be <code>null</code>.
* @param isCaseSensitive Whether or not matching should be performed
* case sensitively.
* @return <code>true</code> if the string matches against the pattern,
* or <code>false</code> otherwise.
*/
protected static boolean match(String pattern, String str,
boolean isCaseSensitive) {
return SelectorUtils.match(pattern, str, isCaseSensitive);
}
/**
* Set the base directory to be scanned. This is the directory which is
* scanned recursively. All '/' and '\' characters are replaced by
* <code>File.separatorChar</code>, so the separator used need not match
* <code>File.separatorChar</code>.
*
* @param basedir The base directory to scan.
* Must not be <code>null</code>.
*/
public void setBasedir(String basedir) {
setBasedir(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.
* Should not be <code>null</code>.
*/
public synchronized void setBasedir(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(boolean isCaseSensitive) {
this.isCaseSensitive = isCaseSensitive;
}
/**
* 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(boolean followSymlinks) {
this.followSymlinks = followSymlinks;
}
/**
* Set the list of include patterns to use. All '/' and '\' characters
* are replaced by <code>File.separatorChar</code>, so the separator used
* need not match <code>File.separatorChar</code>.
* <p/>
* When a pattern ends with a '/' or '\', "**" is appended.
*
* @param includes A list of include patterns.
* May be <code>null</code>, indicating that all files
* should be included. If a non-<code>null</code>
* list is given, all elements must be
* non-<code>null</code>.
*/
public synchronized void setIncludes(List<String> includes) {
if (includes == null || includes.size() == 0) {
this.includes = Arrays.asList("**");
} else {
this.includes = new ArrayList<String>(includes.size());
for (String include : includes) {
this.includes.add(normalizePattern(include));
}
}
}
/**
* Set the list of exclude patterns to use. All '/' and '\' characters
* are replaced by <code>File.separatorChar</code>, so the separator used
* need not match <code>File.separatorChar</code>.
* <p/>
* When a pattern ends with a '/' or '\', "**" is appended.
*
* @param excludes A list of exclude patterns.
* May be <code>null</code>, indicating that no files
* should be excluded. If a non-<code>null</code> list is
* given, all elements must be non-<code>null</code>.
*/
public synchronized void setExcludes(List<String> excludes) {
if (excludes == null) {
this.excludes = new ArrayList<String>();
} else {
this.excludes = new ArrayList<String>(excludes.size());
for (String exclude : excludes) {
this.excludes.add(normalizePattern(exclude));
}
}
}
/**
* Add to the list of exclude patterns to use. All '/' and '\'
* characters are replaced by <code>File.separatorChar</code>, so
* the separator used need not match <code>File.separatorChar</code>.
* <p/>
* When a pattern ends with a '/' or '\', "**" is appended.
*
* @param excludes A list of exclude patterns.
* May be <code>null</code>, in which case the
* exclude patterns don't get changed at all.
* @since Ant 1.6.3
*/
public synchronized void addExcludes(List<String> excludes) {
if (excludes != null && excludes.size() > 0) {
this.excludes.addAll(excludes);
}
}
/**
* All '/' and '\' characters are replaced by
* <code>File.separatorChar</code>, so the separator used need not
* match <code>File.separatorChar</code>.
* <p/>
* <p> When a pattern ends with a '/' or '\', "**" is appended.
*
* @since Ant 1.6.3
*/
private static String normalizePattern(String p) {
String pattern = p.replace('/', File.separatorChar).replace('\\',
File.separatorChar);
if (pattern.endsWith(File.separator)) {
pattern += "**";
}
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(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 <code>true</code> if all files and directories which have
* been found so far have been included.
*/
public synchronized boolean isEverythingIncluded() {
return everythingIncluded;
}
/**
* Scan the base directory 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.
*
* @throws IllegalStateException if the base directory was set
* incorrectly (i.e. if it is <code>null</code>, doesn't exist,
* or isn't a directory).
*/
public void scan()
throws IllegalStateException {
//NOTA: Añade "" para escanear todo, es como un include pattern ""
synchronized (scanLock) {
if (scanning) {
while (scanning) {
try {
scanLock.wait();
} catch (InterruptedException e) {
continue;
}
}
if (illegal != null) {
throw illegal;
}
return;
}
scanning = true;
}
try {
synchronized (this) {
illegal = null;
clearResults();
// set in/excludes to reasonable defaults if needed:
if (basedir == null) {
illegal = new IllegalStateException("No basedir set");
} else {
if (!basedir.exists()) {
illegal = new IllegalStateException("basedir " + basedir
+ " does not exist");
}
if (!basedir.isDirectory()) {
illegal = new IllegalStateException("basedir " + basedir
+ " is not a directory");
}
}
if (illegal != null) {
throw illegal;
}
if (isIncluded("")) {
if (!isExcluded("")) {
if (isSelected("", basedir)) {
dirsIncluded.add("");
} else {
dirsDeselected.add("");
}
} else {
dirsExcluded.add("");
}
} else {
dirsNotIncluded.add("");
}
checkIncludePatterns();
clearCaches();
}
} finally {
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() {
Hashtable newroots = new Hashtable();
// put in the newroots vector the include patterns without
// wildcard tokens
for (String include : includes) {
newroots.put(SelectorUtils.rtrimWildcardTokens(include), include);
}
if (newroots.containsKey("")) {
// we are going to scan everything anyway
scandir(basedir, "", true);
} else {
// only scan directories that can include matched files or
// directories
Enumeration enum2 = newroots.keys();
File canonBase = null;
try {
canonBase = basedir.getCanonicalFile();
} catch (IOException ex) {
throw new BuildException(ex);
}
while (enum2.hasMoreElements()) {
String currentelement = (String) enum2.nextElement();
String originalpattern = (String) newroots.get(currentelement);
File myfile = new File(basedir, currentelement);
if (myfile.exists()) {
// may be on a case insensitive file system. We want
// the results to show what's really on the disk, so
// we need to double check.
try {
File canonFile = myfile.getCanonicalFile();
String path = FILE_UTILS.removeLeadingPath(canonBase, canonFile);
if (!path.equals(currentelement) || ON_VMS) {
myfile = findFile(basedir, currentelement, true);
if (myfile != null) {
currentelement = FILE_UTILS.removeLeadingPath(basedir, myfile);
}
}
} catch (IOException ex) {
throw new BuildException(ex);
}
}
if ((myfile == null || !myfile.exists()) && !isCaseSensitive()) {
File f = findFile(basedir, currentelement, false);
if (f != null && f.exists()) {
// adapt currentelement to the case we've
// actually found
currentelement = FILE_UTILS.removeLeadingPath(basedir, f);
myfile = f;
}
}
if (myfile != null && myfile.exists()) {
if (!followSymlinks && isSymlink(basedir, currentelement)) {
continue;
}
if (myfile.isDirectory()) {
if (isIncluded(currentelement) && currentelement.length() > 0) {
accountForIncludedDir(currentelement, myfile, true);
} else {
if (currentelement.length() > 0) {
if (currentelement.charAt(currentelement.length() - 1) != File.separatorChar) {
currentelement = currentelement + File.separatorChar;
}
}
scandir(myfile, currentelement, true);
}
} else {
boolean included = isCaseSensitive() ? originalpattern
.equals(currentelement) : originalpattern
.equalsIgnoreCase(currentelement);
if (included) {
accountForIncludedFile(currentelement, myfile, null);
}
}
}
}
}
}
/**
* Clear the result caches for a scan.
*/
protected synchronized void clearResults() {
filesIncluded = new ArrayList<String>();
filesIncludedMap = new HashMap<String, FileNode>();
filesNotIncluded = new ArrayList<String>();
filesExcluded = new ArrayList<String>();
filesDeselected = new ArrayList<String>();
dirsIncluded = new ArrayList<String>();
dirsIncludedMap = new HashMap<String, FileNode>();
dirsNotIncluded = new ArrayList<String>();
dirsExcluded = new ArrayList<String>();
dirsDeselected = new ArrayList<String>();
everythingIncluded = (basedir != null);
scannedDirs.clear();
}
/**
* Top level invocation for a slow scan. A slow scan builds up a full
* list of excluded/included files/directories, whereas a fast scan
* will only have full results for included files, as it ignores
* directories which can't possibly hold any included files/directories.
* <p/>
* 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 (InterruptedException e) {
}
}
return;
}
slowScanning = true;
}
try {
synchronized (this) {
for (String excluded : dirsExcluded) {
if (!couldHoldIncluded(excluded)) {
scandir(new File(basedir, excluded), excluded + File.separator,
false);
}
}
for (String notIncluded : dirsNotIncluded) {
if (!couldHoldIncluded(notIncluded)) {
scandir(new File(basedir, notIncluded), notIncluded
+ File.separator, false);
}
}
clearCaches();
}
} finally {
synchronized (slowScanLock) {
haveSlowResults = true;
slowScanning = false;
slowScanLock.notifyAll();
}
}
}
/**
* 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 <code>null</code>.
* @param vpath The path relative to the base directory (needed to
* prevent problems with an absolute path when using
* dir). Must not be <code>null</code>.
* @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(File dir, String vpath, boolean fast) {
if (dir == null) {
throw new BuildException("dir must not be null.");
} else if (!dir.exists()) {
throw new BuildException(dir + " doesn't exists.");
} else if (!dir.isDirectory()) {
throw new BuildException(dir + " is not a directory.");
}
// avoid double scanning of directories, can only happen in fast mode
if (fast && hasBeenScanned(dir)) {
return;
}
setState("Scan directory: %s", vpath);
String[] newfiles = dir.list();
if (newfiles == null) {
/*
* two reasons are mentioned in the API docs for File.list
* (1) dir is not a directory. This is impossible as
* we wouldn't get here in this case.
* (2) an IO error occurred (why doesn't it throw an exception
* then???)
*/
throw new BuildException("IO error scanning directory "
+ dir.getAbsolutePath());
}
if (!followSymlinks) {
List<String> noLinks = new ArrayList<String>();
for (int i = 0; i < newfiles.length; i++) {
try {
if (FILE_UTILS.isSymbolicLink(dir, newfiles[i])) {
String name = vpath + newfiles[i];
File file = new File(dir, newfiles[i]);
(file.isDirectory() ? dirsExcluded : filesExcluded).add(name);
} else {
noLinks.add(newfiles[i]);
}
} catch (IOException ioe) {
String msg = "IOException caught while checking "
+ "for links, couldn't get canonical path!";
// will be caught and redirected to Ant's logging system
System.err.println(msg);
noLinks.add(newfiles[i]);
}
}
newfiles = noLinks.toArray(new String[noLinks.size()]);
}
for (int i = 0; i < newfiles.length; i++) {
String name = vpath + newfiles[i];
File file = new File(dir, newfiles[i]);
if (file.isDirectory()) {
if (isIncluded(name)) {
accountForIncludedDir(name, file, fast);
} else {
everythingIncluded = false;
dirsNotIncluded.add(name);
if (fast && couldHoldIncluded(name) && !contentsExcluded(name)) {
scandir(file, name + File.separator, fast);
}
}
if (!fast) {
scandir(file, name + File.separator, fast);
}
} else if (file.isFile()) {
if (isIncluded(name)) {
accountForIncludedFile(name, file, dir);
} else {
everythingIncluded = false;
filesNotIncluded.add(name);
}
}
}
}
/**
* Process included file.
*
* @param name path of the file relative to the directory of the FileSet.
* @param file included File.
*/
private void accountForIncludedFile(String name, File file, File dir) {
if (filesIncludedMap.get(name) != null || filesExcluded.contains(name)
|| filesDeselected.contains(name)) {
return;
}
boolean included = false;
if (isExcluded(name)) {
filesExcluded.add(name);
} else if (isSelected(name, file)) {
included = true;
filesIncluded.add(name);
filesIncludedMap.put(name, new FileNode(name, file));
} else {
filesDeselected.add(name);
}
everythingIncluded &= included;
}
/**
* Process included directory.
*
* @param name path of the directory relative to the directory of
* the FileSet.
* @param file directory as File.
* @param fast whether to perform fast scans.
*/
private void accountForIncludedDir(String name, File file, boolean fast) {
if (dirsIncluded.contains(name) || dirsExcluded.contains(name)
|| dirsDeselected.contains(name)) {
return;
}
boolean included = false;
if (isExcluded(name)) {
dirsExcluded.add(name);
} else if (isSelected(name, file)) {
included = true;
dirsIncluded.add(name);
dirsIncludedMap.put(name, new FileNode(name, file));
} else {
dirsDeselected.add(name);
}
everythingIncluded &= included;
if (fast && couldHoldIncluded(name) && !contentsExcluded(name)) {
scandir(file, name + File.separator, fast);
}
}
/**
* Test whether or not a name matches against at least one include
* pattern.
*
* @param name The name to match. Must not be <code>null</code>.
* @return <code>true</code> when the name matches against at least one
* include pattern, or <code>false</code> otherwise.
*/
protected boolean isIncluded(String name) {
ensureNonPatternSetsReady();
if (isCaseSensitive() ? includeNonPatterns.contains(name)
: includeNonPatterns.contains(name.toUpperCase())) {
return true;
}
for (String includePattern : includePatterns) {
if (matchPath(includePattern, name, 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 <code>null</code>.
* @return <code>true</code> when the name matches against the start of at
* least one include pattern, or <code>false</code> otherwise.
*/
protected boolean couldHoldIncluded(String name) {
if (!isMorePowerfulThanExcludes(name, null)) {
return false;
}
for (String include : includes) {
if (matchPatternStart(include, name, isCaseSensitive())
&& isMorePowerfulThanExcludes(name, include)
&& isDeeper(include, name)) {
return true;
}
}
return false;
}
/**
* 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(String pattern, String name) {
List p = SelectorUtils.tokenizePath(pattern);
List n = SelectorUtils.tokenizePath(name);
return p.contains("**") || p.size() > n.size();
}
/**
* 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.
* <p/>
* IMPORTANT : this function should return false "with care".
*
* @param name the relative path to test.
* @param includepattern one include pattern.
* @return true if there is no exclude pattern more powerful than this include pattern.
* @since Ant 1.6
*/
private boolean isMorePowerfulThanExcludes(String name, String includepattern) {
String soughtexclude = name + File.separator + "**";
for (String exclude : excludes) {
if (exclude.equals(soughtexclude)) {
return false;
}
}
return true;
}
/**
* Test whether all contents of the specified directory must be excluded.
*
* @param name the directory name to check.
* @return whether all the specified directory's contents are excluded.
*/
private boolean contentsExcluded(String name) {
name = (name.endsWith(File.separator)) ? name : name + File.separator;
for (String exclude : excludes) {
if (exclude.endsWith("**")
&& SelectorUtils
.matchPath(exclude.substring(0, exclude.length() - 2), name,
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 <code>null</code>.
* @return <code>true</code> when the name matches against at least one
* exclude pattern, or <code>false</code> otherwise.
*/
protected boolean isExcluded(String name) {
ensureNonPatternSetsReady();
if (isCaseSensitive() ? excludeNonPatterns.contains(name)
: excludeNonPatterns.contains(name.toUpperCase())) {
return true;
}
for (String excludePattern : excludePatterns) {
if (matchPath(excludePattern, 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 <code>false</code> when the selectors says that the file
* should not be selected, <code>true</code> otherwise.
*/
protected boolean isSelected(String name, 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 synchronized List<String> getIncludedFiles() {
if (filesIncluded == null) {
throw new IllegalStateException();
}
Collections.sort(filesIncluded);
return filesIncluded;
}
public synchronized Map<String, FileNode> getIncludedFilesMap() {
return filesIncludedMap;
}
/**
* Return the count of included files.
*
* @return <code>int</code>.
* @since Ant 1.6.3
*/
public synchronized int getIncludedFilesCount() {
if (filesIncluded == null) {
throw new IllegalStateException();
}
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 List<String> getNotIncludedFiles() {
slowScan();
return filesNotIncluded;
}
/**
* 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 List<String> getExcludedFiles() {
slowScan();
return filesExcluded;
}
/**
* <p>Return the names of the files which were selected out and
* therefore not ultimately included.</p>
* <p/>
* <p>The names are relative to the base directory. This involves
* performing a slow scan if one has not already been completed.</p>
*
* @return the names of the files which were deselected.
* @see #slowScan
*/
public synchronized String[] getDeselectedFiles() {
slowScan();
return filesDeselected.toArray(new String[filesDeselected.size()]);
}
/**
* Return the names of the directories 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 directories which matched at least one of the
* include patterns and none of the exclude patterns.
*/
public synchronized List<String> getIncludedDirectories() {
if (dirsIncluded == null) {
throw new IllegalStateException();
}
Collections.sort(dirsIncluded);
return dirsIncluded;
}
public synchronized Map<String, FileNode> getIncludedDirectoriesMap() {
return dirsIncludedMap;
}
/**
* Return the count of included directories.
*
* @return <code>int</code>.
* @since Ant 1.6.3
*/
public synchronized int getIncludedDirsCount() {
if (dirsIncluded == null) {
throw new IllegalStateException();
}
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 List<String> getNotIncludedDirectories() {
slowScan();
return dirsNotIncluded;
}
/**
* 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 List<String> getExcludedDirectories() {
slowScan();
return dirsExcluded;
}
/**
* <p>Return the names of the directories which were selected out and
* therefore not ultimately included.</p>
* <p/>
* <p>The names are relative to the base directory. This involves
* performing a slow scan if one has not already been completed.</p>
*
* @return the names of the directories which were deselected.
* @see #slowScan
*/
public synchronized String[] getDeselectedDirectories() {
slowScan();
return dirsDeselected.toArray(new String[dirsDeselected.size()]);
}
/**
* Get the named resource.
*
* @param name path name of the file relative to the dir attribute.
* @return the resource with the given name.
* @since Ant 1.5.2
*/
public synchronized Resource getResource(String name) {
File f = FILE_UTILS.resolveFile(basedir, name);
return new Resource(name, f.exists(), f.lastModified(), f.isDirectory(), f
.length());
}
/**
* Return a cached result of list performed on file, if
* available. Invokes the method and caches the result otherwise.
*
* @param file File (dir) to list.
* @since Ant 1.6
*/
private String[] list(File file) {
String[] files = (String[]) fileListMap.get(file);
if (files == null) {
files = file.list();
if (files != null) {
fileListMap.put(file, files);
}
}
return files;
}
/**
* From <code>base</code> traverse the filesystem in order to find
* a file that matches the given name.
*
* @param base base File (dir).
* @param path file path.
* @param cs whether to scan case-sensitively.
* @return File object that points to the file in question or null.
* @since Ant 1.6.3
*/
private File findFile(File base, String path, boolean cs) {
return findFile(base, SelectorUtils.tokenizePath(path), cs);
}
/**
* From <code>base</code> traverse the filesystem in order to find
* a file that matches the given stack of names.
*
* @param base base File (dir).
* @param pathElements ArrayList of path elements (dirs...file).
* @param cs whether to scan case-sensitively.
* @return File object that points to the file in question or null.
* @since Ant 1.6.3
*/
private File findFile(File base, List pathElements, boolean cs) {
if (pathElements.size() == 0) {
return base;
}
if (!base.isDirectory()) {
return null;
}
String[] files = list(base);
if (files == null) {
throw new BuildException("IO error scanning directory "
+ base.getAbsolutePath());
}
String current = (String) pathElements.remove(0);
boolean[] matchCase = cs ? CS_SCAN_ONLY : CS_THEN_NON_CS;
for (int i = 0; i < matchCase.length; i++) {
for (int j = 0; j < files.length; j++) {
if (matchCase[i] ? files[j].equals(current) : files[j]
.equalsIgnoreCase(current)) {
return findFile(new File(base, files[j]), pathElements, cs);
}
}
}
return null;
}
/**
* Do we have to traverse a symlink when trying to reach path from
* basedir?
*
* @param base base File (dir).
* @param path file path.
* @since Ant 1.6
*/
private boolean isSymlink(File base, String path) {
return isSymlink(base, SelectorUtils.tokenizePath(path));
}
/**
* Do we have to traverse a symlink when trying to reach path from
* basedir?
*
* @param base base File (dir).
* @param pathElements ArrayList of path elements (dirs...file).
* @since Ant 1.6
*/
private boolean isSymlink(File base, List pathElements) {
if (pathElements.size() > 0) {
String current = (String) pathElements.remove(0);
try {
return FILE_UTILS.isSymbolicLink(base, current)
|| isSymlink(new File(base, current), pathElements);
} catch (IOException ioe) {
String msg = "IOException caught while checking "
+ "for links, couldn't get canonical path!";
// will be caught and redirected to Ant's logging system
System.err.println(msg);
}
}
return false;
}
/**
* Has the directory with the given path relative to the base
* directory already been scanned?
* <p/>
* <p>Registers the given directory as scanned as a side effect.</p>
*
* @since Ant 1.6
*/
private boolean hasBeenScanned(File dir) {
try {
return !scannedDirs.add(dir.getCanonicalFile());
} catch (IOException ex) {
return true;
}
}
/**
* This method is of interest for testing purposes. The returned
* Set is live and should not be modified.
*
* @return the Set of relative directory names that have been scanned.
*/
/* package-private */Set getScannedDirs() {
return scannedDirs;
}
/**
* Clear internal caches.
*
* @since Ant 1.6
*/
private synchronized void clearCaches() {
fileListMap.clear();
includeNonPatterns.clear();
excludeNonPatterns.clear();
includePatterns = new ArrayList<String>();
excludePatterns = new ArrayList<String>();
areNonPatternSetsReady = false;
}
/**
* Ensure that the in|exclude "patterns"
* have been properly divided up.
*
* @since Ant 1.6.3
*/
private synchronized void ensureNonPatternSetsReady() {
if (!areNonPatternSetsReady) {
includePatterns = fillNonPatternSet(includeNonPatterns, includes);
excludePatterns = fillNonPatternSet(excludeNonPatterns, excludes);
areNonPatternSetsReady = true;
}
}
/**
* Add all patterns that are not real patterns (do not contain
* wildcards) to the set and returns the real patterns.
*
* @param set Set to populate.
* @param patterns String[] of patterns.
* @since Ant 1.6.3
*/
private List<String> fillNonPatternSet(List<String> set, List<String> patterns) {
List<String> al;
al = new ArrayList<String>(patterns.size());
for (String pattern : patterns) {
if (!SelectorUtils.hasWildcards(pattern)) {
set.add(isCaseSensitive() ? pattern : pattern.toUpperCase());
} else {
al.add(pattern);
}
}
return set.size() == 0 ? patterns : al;
}
private void setState(String format, Object... args) {
if (showStateOn) {
StatusBar.getInstance().setState(format, args);
}
}
public void setShowStateOn(boolean showStateOn) {
this.showStateOn = showStateOn;
}
}