This implementation is based on Arnout Kuiper's initial design * document, the following mailing list discussions, and the * copyfile/copydir tasks.
* * @author Glenn McAllister * glennm@ca.ibm.com * @author Stefan Bodewig * @author Michael McCallum * @author Magesh Umasankar * * @version $Revision$ * * @since Ant 1.2 * * @ant.task category="filesystem" */ public class Copy extends Task { protected File file = null; // the source file protected File destFile = null; // the destination file protected File destDir = null; // the destination directory protected Vector filesets = new Vector(); private boolean enableMultipleMappings = false; protected boolean filtering = false; protected boolean preserveLastModified = false; protected boolean forceOverwrite = false; protected boolean flatten = false; protected int verbosity = Project.MSG_VERBOSE; protected boolean includeEmpty = true; private boolean failonerror = true; protected Hashtable fileCopyMap = new Hashtable(); protected Hashtable dirCopyMap = new Hashtable(); protected Hashtable completeDirMap = new Hashtable(); protected Mapper mapperElement = null; private Vector filterChains = new Vector(); private Vector filterSets = new Vector(); private FileUtils fileUtils; private String inputEncoding = null; private String outputEncoding = null; /** * Copy task constructor. */ public Copy() { fileUtils = FileUtils.newFileUtils(); } /** * @return the fileutils object */ protected FileUtils getFileUtils() { return fileUtils; } /** * Sets a single source file to copy. * @param file the file to copy */ public void setFile(File file) { this.file = file; } /** * Sets the destination file. * @param destFile the file to copy to */ public void setTofile(File destFile) { this.destFile = destFile; } /** * Sets the destination directory. * @param destDir the destination directory */ public void setTodir(File destDir) { this.destDir = destDir; } /** * Adds a FilterChain. * @return a filter chain object */ public FilterChain createFilterChain() { FilterChain filterChain = new FilterChain(); filterChains.addElement(filterChain); return filterChain; } /** * Adds a filterset. * @return a filter set object */ public FilterSet createFilterSet() { FilterSet filterSet = new FilterSet(); filterSets.addElement(filterSet); return filterSet; } /** * Give the copied files the same last modified time as the original files. * @param preserve a boolean string * @deprecated setPreserveLastModified(String) has been deprecated and * replaced with setPreserveLastModified(boolean) to * consistently let the Introspection mechanism work. */ public void setPreserveLastModified(String preserve) { setPreserveLastModified(Project.toBoolean(preserve)); } /** * Give the copied files the same last modified time as the original files. * @param preserve if true perserce the modified time, default is false */ public void setPreserveLastModified(boolean preserve) { preserveLastModified = preserve; } /** * Whether to give the copied files the same last modified time as * the original files. * @return the preserveLastModified attribute * @since 1.32, Ant 1.5 */ public boolean getPreserveLastModified() { return preserveLastModified; } /** * Get the filtersets being applied to this operation. * * @return a vector of FilterSet objects */ protected Vector getFilterSets() { return filterSets; } /** * Get the filterchains being applied to this operation. * * @return a vector of FilterChain objects */ protected Vector getFilterChains() { return filterChains; } /** * If true, enables filtering. * @param filtering if true enable filtering, default is false */ public void setFiltering(boolean filtering) { this.filtering = filtering; } /** * Overwrite any existing destination file(s). * @param overwrite if true force overwriting of destination file(s) * even if the destination file(s) are younger than * the corresponding source file. Default is false. */ public void setOverwrite(boolean overwrite) { this.forceOverwrite = overwrite; } /** * When copying directory trees, the files can be "flattened" * into a single directory. If there are multiple files with * the same name in the source directory tree, only the first * file will be copied into the "flattened" directory, unless * the forceoverwrite attribute is true. * @param flatten if true flatten the destination directory. Default * is false. */ public void setFlatten(boolean flatten) { this.flatten = flatten; } /** * Used to force listing of all names of copied files. * @param verbose output the names of copied files. Default is false. */ public void setVerbose(boolean verbose) { if (verbose) { this.verbosity = Project.MSG_INFO; } else { this.verbosity = Project.MSG_VERBOSE; } } /** * Used to copy empty directories. * @param includeEmpty if true copy empty directories. Default is true. */ public void setIncludeEmptyDirs(boolean includeEmpty) { this.includeEmpty = includeEmpty; } /** * Attribute to handle mappers that return multiple * mappings for a given source path. * @param enableMultipleMappings If true the task will * copy to all the mappings for a given source path, if * false, only the first file or directory is * processed. * By default, this setting is false to provide backward * compatibility with earlier releases. * @since 1.6 */ public void setEnableMultipleMappings(boolean enableMultipleMappings) { this.enableMultipleMappings = enableMultipleMappings; } /** * @return the value of the enableMultipleMapping attribute */ public boolean isEnableMultipleMapping() { return enableMultipleMappings; } /** * If false, note errors to the output but keep going. * @param failonerror true or false */ public void setFailOnError(boolean failonerror) { this.failonerror = failonerror; } /** * Adds a set of files to copy. * @param set a set of files to copy */ public void addFileset(FileSet set) { filesets.addElement(set); } /** * Defines the mapper to map source to destination files. * @return a mapper to be configured * @exception BuildException if more than one mapper is defined */ public Mapper createMapper() throws BuildException { if (mapperElement != null) { throw new BuildException("Cannot define more than one mapper", getLocation()); } mapperElement = new Mapper(getProject()); return mapperElement; } /** * Sets the character encoding * @param encoding the character encoding * @since 1.32, Ant 1.5 */ public void setEncoding(String encoding) { this.inputEncoding = encoding; if (outputEncoding == null) { outputEncoding = encoding; } } /** * @return the character encoding,null if not set.
*
* @since 1.32, Ant 1.5
*/
public String getEncoding() {
return inputEncoding;
}
/**
* Sets the character encoding for output files.
* @param encoding the character encoding
* @since Ant 1.6
*/
public void setOutputEncoding(String encoding) {
this.outputEncoding = encoding;
}
/**
* @return the character encoding for output files,
* null if not set.
*
* @since Ant 1.6
*/
public String getOutputEncoding() {
return outputEncoding;
}
/**
* Performs the copy operation.
* @exception BuildException if an error occurs
*/
public void execute() throws BuildException {
File savedFile = file; // may be altered in validateAttributes
File savedDestFile = destFile;
File savedDestDir = destDir;
FileSet savedFileSet = null;
if (file == null && destFile != null && filesets.size() == 1) {
// will be removed in validateAttributes
savedFileSet = (FileSet) filesets.elementAt(0);
}
// make sure we don't have an illegal set of options
validateAttributes();
try {
// deal with the single file
if (file != null) {
if (file.exists()) {
if (destFile == null) {
destFile = new File(destDir, file.getName());
}
if (forceOverwrite || !destFile.exists()
|| (file.lastModified() > destFile.lastModified())) {
fileCopyMap.put(file.getAbsolutePath(),
new String[] {destFile.getAbsolutePath()});
} else {
log(file + " omitted as " + destFile
+ " is up to date.", Project.MSG_VERBOSE);
}
} else {
String message = "Warning: Could not find file "
+ file.getAbsolutePath() + " to copy.";
if (!failonerror) {
log(message);
} else {
throw new BuildException(message);
}
}
}
// deal with the filesets
for (int i = 0; i < filesets.size(); i++) {
FileSet fs = (FileSet) filesets.elementAt(i);
DirectoryScanner ds = null;
try {
ds = fs.getDirectoryScanner(getProject());
} catch (BuildException e) {
if (failonerror
|| !e.getMessage().endsWith(" not found.")) {
throw e;
} else {
log("Warning: " + e.getMessage());
continue;
}
}
File fromDir = fs.getDir(getProject());
String[] srcFiles = ds.getIncludedFiles();
String[] srcDirs = ds.getIncludedDirectories();
boolean isEverythingIncluded = ds.isEverythingIncluded()
&& (!fs.hasSelectors() && !fs.hasPatterns());
if (isEverythingIncluded
&& !flatten && mapperElement == null) {
completeDirMap.put(fromDir, destDir);
}
scan(fromDir, destDir, srcFiles, srcDirs);
}
// do all the copy operations now...
try {
doFileOperations();
} catch (BuildException e) {
if (!failonerror) {
log("Warning: " + e.getMessage(), Project.MSG_ERR);
} else {
throw e;
}
}
} finally {
// clean up again, so this instance can be used a second
// time
file = savedFile;
destFile = savedDestFile;
destDir = savedDestDir;
if (savedFileSet != null) {
filesets.insertElementAt(savedFileSet, 0);
}
fileCopyMap.clear();
dirCopyMap.clear();
completeDirMap.clear();
}
}
/************************************************************************
** protected and private methods
************************************************************************/
/**
* Ensure we have a consistent and legal set of attributes, and set
* any internal flags necessary based on different combinations
* of attributes.
* @exception BuildException if an error occurs
*/
protected void validateAttributes() throws BuildException {
if (file == null && filesets.size() == 0) {
throw new BuildException("Specify at least one source "
+ "- a file or a fileset.");
}
if (destFile != null && destDir != null) {
throw new BuildException("Only one of tofile and todir "
+ "may be set.");
}
if (destFile == null && destDir == null) {
throw new BuildException("One of tofile or todir must be set.");
}
if (file != null && file.exists() && file.isDirectory()) {
throw new BuildException("Use a fileset to copy directories.");
}
if (destFile != null && filesets.size() > 0) {
if (filesets.size() > 1) {
throw new BuildException(
"Cannot concatenate multiple files into a single file.");
} else {
FileSet fs = (FileSet) filesets.elementAt(0);
DirectoryScanner ds = fs.getDirectoryScanner(getProject());
String[] srcFiles = ds.getIncludedFiles();
if (srcFiles.length == 0) {
throw new BuildException(
"Cannot perform operation from directory to file.");
} else if (srcFiles.length == 1) {
if (file == null) {
file = new File(ds.getBasedir(), srcFiles[0]);
filesets.removeElementAt(0);
} else {
throw new BuildException("Cannot concatenate multiple "
+ "files into a single file.");
}
} else {
throw new BuildException("Cannot concatenate multiple "
+ "files into a single file.");
}
}
}
if (destFile != null) {
destDir = fileUtils.getParentFile(destFile);
}
}
/**
* Compares source files to destination files to see if they should be
* copied.
*
* @param fromDir The source directory
* @param toDir The destination dirctory
* @param files A list of files to copy
* @param dirs A list of directories to copy
*/
protected void scan(File fromDir, File toDir, String[] files,
String[] dirs) {
FileNameMapper mapper = null;
if (mapperElement != null) {
mapper = mapperElement.getImplementation();
} else if (flatten) {
mapper = new FlatFileNameMapper();
} else {
mapper = new IdentityMapper();
}
buildMap(fromDir, toDir, files, mapper, fileCopyMap);
if (includeEmpty) {
buildMap(fromDir, toDir, dirs, mapper, dirCopyMap);
}
}
/**
* Add to a map of files/directories to copy
*
* @param fromDir the source directory
* @param toDir the destination directory
* @param names a list of filenames
* @param mapper a FileNameMapper value
* @param map a map of source file to array of destination files
*/
protected void buildMap(File fromDir, File toDir, String[] names,
FileNameMapper mapper, Hashtable map) {
String[] toCopy = null;
if (forceOverwrite) {
Vector v = new Vector();
for (int i = 0; i < names.length; i++) {
if (mapper.mapFileName(names[i]) != null) {
v.addElement(names[i]);
}
}
toCopy = new String[v.size()];
v.copyInto(toCopy);
} else {
SourceFileScanner ds = new SourceFileScanner(this);
toCopy = ds.restrict(names, fromDir, toDir, mapper);
}
for (int i = 0; i < toCopy.length; i++) {
File src = new File(fromDir, toCopy[i]);
String[] mappedFiles = mapper.mapFileName(toCopy[i]);
if (!enableMultipleMappings) {
map.put(src.getAbsolutePath(),
new String[] {new File(toDir, mappedFiles[0]).getAbsolutePath()});
} else {
// reuse the array created by the mapper
for (int k = 0; k < mappedFiles.length; k++) {
mappedFiles[k] = new File(toDir, mappedFiles[k]).getAbsolutePath();
}
map.put(src.getAbsolutePath(), mappedFiles);
}
}
}
/**
* Actually does the file (and possibly empty directory) copies.
* This is a good method for subclasses to override.
*/
protected void doFileOperations() {
if (fileCopyMap.size() > 0) {
log("Copying " + fileCopyMap.size()
+ " file" + (fileCopyMap.size() == 1 ? "" : "s")
+ " to " + destDir.getAbsolutePath());
Enumeration e = fileCopyMap.keys();
while (e.hasMoreElements()) {
String fromFile = (String) e.nextElement();
String[] toFiles = (String[]) fileCopyMap.get(fromFile);
for (int i = 0; i < toFiles.length; i++) {
String toFile = toFiles[i];
if (fromFile.equals(toFile)) {
log("Skipping self-copy of " + fromFile, verbosity);
continue;
}
try {
log("Copying " + fromFile + " to " + toFile, verbosity);
FilterSetCollection executionFilters =
new FilterSetCollection();
if (filtering) {
executionFilters
.addFilterSet(getProject().getGlobalFilterSet());
}
for (Enumeration filterEnum = filterSets.elements();
filterEnum.hasMoreElements();) {
executionFilters
.addFilterSet((FilterSet) filterEnum.nextElement());
}
fileUtils.copyFile(fromFile, toFile, executionFilters,
filterChains, forceOverwrite,
preserveLastModified, inputEncoding,
outputEncoding, getProject());
} catch (IOException ioe) {
String msg = "Failed to copy " + fromFile + " to " + toFile
+ " due to " + ioe.getMessage();
File targetFile = new File(toFile);
if (targetFile.exists() && !targetFile.delete()) {
msg += " and I couldn't delete the corrupt " + toFile;
}
throw new BuildException(msg, ioe, getLocation());
}
}
}
}
if (includeEmpty) {
Enumeration e = dirCopyMap.elements();
int createCount = 0;
while (e.hasMoreElements()) {
String[] dirs = (String[]) e.nextElement();
for (int i = 0; i < dirs.length; i++) {
File d = new File(dirs[i]);
if (!d.exists()) {
if (!d.mkdirs()) {
log("Unable to create directory "
+ d.getAbsolutePath(), Project.MSG_ERR);
} else {
createCount++;
}
}
}
}
if (createCount > 0) {
log("Copied " + dirCopyMap.size()
+ " empty director"
+ (dirCopyMap.size() == 1 ? "y" : "ies")
+ " to " + createCount
+ " empty director"
+ (createCount == 1 ? "y" : "ies") + " under "
+ destDir.getAbsolutePath());
}
}
}
}