null.
* @param dest the Resource to copy to.
* Must not be null.
*
* @throws IOException if the copying fails.
*
* @since Ant 1.7
*/
public static void copyResource(Resource source, Resource dest) throws IOException {
copyResource(source, dest, null);
}
/**
* Convenience method to copy content from one Resource to another.
* No filtering is performed.
*
* @param source the Resource to copy from.
* Must not be null.
* @param dest the Resource to copy to.
* Must not be null.
* @param project the project instance.
*
* @throws IOException if the copying fails.
*
* @since Ant 1.7
*/
public static void copyResource(Resource source, Resource dest, Project project)
throws IOException {
copyResource(source, dest, null, null, false,
false, null, null, project);
}
// CheckStyle:ParameterNumberCheck OFF - bc
/**
* Convenience method to copy content from one Resource to another
* specifying whether token filtering must be used, whether filter chains
* must be used, whether newer destination files may be overwritten and
* whether the last modified time of dest file should be made
* equal to the last modified time of source.
*
* @param source the Resource to copy from.
* Must not be null.
* @param dest the Resource to copy to.
* Must not be null.
* @param filters the collection of filters to apply to this copy.
* @param filterChains filterChains to apply during the copy.
* @param overwrite Whether or not the destination Resource should be
* overwritten if it already exists.
* @param preserveLastModified Whether or not the last modified time of
* the destination Resource should be set to that
* of the source.
* @param inputEncoding the encoding used to read the files.
* @param outputEncoding the encoding used to write the files.
* @param project the project instance.
*
* @throws IOException if the copying fails.
*
* @since Ant 1.7
*/
public static void copyResource(Resource source, Resource dest,
FilterSetCollection filters, Vector filterChains,
boolean overwrite, boolean preserveLastModified,
String inputEncoding, String outputEncoding,
Project project)
throws IOException {
copyResource(source, dest, filters, filterChains, overwrite, preserveLastModified, false, inputEncoding, outputEncoding, project);
}
// CheckStyle:ParameterNumberCheck OFF - bc
/**
* Convenience method to copy content from one Resource to another
* specifying whether token filtering must be used, whether filter chains
* must be used, whether newer destination files may be overwritten and
* whether the last modified time of dest file should be made
* equal to the last modified time of source.
*
* @param source the Resource to copy from.
* Must not be null.
* @param dest the Resource to copy to.
* Must not be null.
* @param filters the collection of filters to apply to this copy.
* @param filterChains filterChains to apply during the copy.
* @param overwrite Whether or not the destination Resource should be
* overwritten if it already exists.
* @param preserveLastModified Whether or not the last modified time of
* the destination Resource should be set to that
* of the source.
* @param append Whether to append to an Appendable Resource.
* @param inputEncoding the encoding used to read the files.
* @param outputEncoding the encoding used to write the files.
* @param project the project instance.
*
* @throws IOException if the copying fails.
*
* @since Ant 1.8
*/
public static void copyResource(Resource source, Resource dest,
FilterSetCollection filters, Vector filterChains,
boolean overwrite, boolean preserveLastModified,
boolean append,
String inputEncoding, String outputEncoding,
Project project)
throws IOException {
copyResource(source, dest, filters, filterChains, overwrite,
preserveLastModified, append, inputEncoding,
outputEncoding, project, /* force: */ false);
}
/**
* Convenience method to copy content from one Resource to another
* specifying whether token filtering must be used, whether filter chains
* must be used, whether newer destination files may be overwritten and
* whether the last modified time of dest file should be made
* equal to the last modified time of source.
*
* @param source the Resource to copy from.
* Must not be null.
* @param dest the Resource to copy to.
* Must not be null.
* @param filters the collection of filters to apply to this copy.
* @param filterChains filterChains to apply during the copy.
* @param overwrite Whether or not the destination Resource should be
* overwritten if it already exists.
* @param preserveLastModified Whether or not the last modified time of
* the destination Resource should be set to that
* of the source.
* @param append Whether to append to an Appendable Resource.
* @param inputEncoding the encoding used to read the files.
* @param outputEncoding the encoding used to write the files.
* @param project the project instance.
* @param force whether read-only target files will be overwritten
*
* @throws IOException if the copying fails.
*
* @since Ant 1.8.2
*/
public static void copyResource(Resource source, Resource dest,
FilterSetCollection filters, Vector filterChains,
boolean overwrite, boolean preserveLastModified,
boolean append,
String inputEncoding, String outputEncoding,
Project project, boolean force)
throws IOException {
if (!(overwrite || SelectorUtils.isOutOfDate(source, dest, FileUtils.getFileUtils()
.getFileTimestampGranularity()))) {
return;
}
final boolean filterSetsAvailable = (filters != null
&& filters.hasFilters());
final boolean filterChainsAvailable = (filterChains != null
&& filterChains.size() > 0);
String effectiveInputEncoding = null;
if (source instanceof StringResource) {
effectiveInputEncoding = ((StringResource) source).getEncoding();
} else {
effectiveInputEncoding = inputEncoding;
}
File destFile = null;
if (dest.as(FileProvider.class) != null) {
destFile = dest.as(FileProvider.class).getFile();
}
if (destFile != null && destFile.isFile() && !destFile.canWrite()) {
if (!force) {
throw new IOException("can't write to read-only destination "
+ "file " + destFile);
} else if (!FILE_UTILS.tryHardToDelete(destFile)) {
throw new IOException("failed to delete read-only "
+ "destination file " + destFile);
}
}
if (filterSetsAvailable) {
BufferedReader in = null;
BufferedWriter out = null;
try {
InputStreamReader isr = null;
if (effectiveInputEncoding == null) {
isr = new InputStreamReader(source.getInputStream());
} else {
isr = new InputStreamReader(source.getInputStream(),
effectiveInputEncoding);
}
in = new BufferedReader(isr);
OutputStream os = getOutputStream(dest, append, project);
OutputStreamWriter osw;
if (outputEncoding == null) {
osw = new OutputStreamWriter(os);
} else {
osw = new OutputStreamWriter(os, outputEncoding);
}
out = new BufferedWriter(osw);
if (filterChainsAvailable) {
ChainReaderHelper crh = new ChainReaderHelper();
crh.setBufferSize(FileUtils.BUF_SIZE);
crh.setPrimaryReader(in);
crh.setFilterChains(filterChains);
crh.setProject(project);
Reader rdr = crh.getAssembledReader();
in = new BufferedReader(rdr);
}
LineTokenizer lineTokenizer = new LineTokenizer();
lineTokenizer.setIncludeDelims(true);
String newline = null;
String line = lineTokenizer.getToken(in);
while (line != null) {
if (line.length() == 0) {
// this should not happen, because the lines are
// returned with the end of line delimiter
out.newLine();
} else {
newline = filters.replaceTokens(line);
out.write(newline);
}
line = lineTokenizer.getToken(in);
}
} finally {
FileUtils.close(out);
FileUtils.close(in);
}
} else if (filterChainsAvailable
|| (effectiveInputEncoding != null
&& !effectiveInputEncoding.equals(outputEncoding))
|| (effectiveInputEncoding == null && outputEncoding != null)) {
BufferedReader in = null;
BufferedWriter out = null;
try {
InputStreamReader isr = null;
if (effectiveInputEncoding == null) {
isr = new InputStreamReader(source.getInputStream());
} else {
isr = new InputStreamReader(source.getInputStream(),
effectiveInputEncoding);
}
in = new BufferedReader(isr);
OutputStream os = getOutputStream(dest, append, project);
OutputStreamWriter osw;
if (outputEncoding == null) {
osw = new OutputStreamWriter(os);
} else {
osw = new OutputStreamWriter(os, outputEncoding);
}
out = new BufferedWriter(osw);
if (filterChainsAvailable) {
ChainReaderHelper crh = new ChainReaderHelper();
crh.setBufferSize(FileUtils.BUF_SIZE);
crh.setPrimaryReader(in);
crh.setFilterChains(filterChains);
crh.setProject(project);
Reader rdr = crh.getAssembledReader();
in = new BufferedReader(rdr);
}
char[] buffer = new char[FileUtils.BUF_SIZE];
while (true) {
int nRead = in.read(buffer, 0, buffer.length);
if (nRead == -1) {
break;
}
out.write(buffer, 0, nRead);
}
} finally {
FileUtils.close(out);
FileUtils.close(in);
}
} else if (source.as(FileProvider.class) != null
&& destFile != null) {
File sourceFile =
source.as(FileProvider.class).getFile();
File parent = destFile.getParentFile();
if (parent != null && !parent.isDirectory()
&& !(parent.mkdirs() || parent.isDirectory())) {
throw new IOException("failed to create the parent directory"
+ " for " + destFile);
}
FileInputStream in = null;
FileOutputStream out = null;
FileChannel srcChannel = null;
FileChannel destChannel = null;
try {
in = new FileInputStream(sourceFile);
out = new FileOutputStream(destFile);
srcChannel = in.getChannel();
destChannel = out.getChannel();
long position = 0;
long count = srcChannel.size();
while (position < count) {
long chunk = Math.min(MAX_IO_CHUNK_SIZE, count - position);
position +=
destChannel.transferFrom(srcChannel, position, chunk);
}
} finally {
FileUtils.close(srcChannel);
FileUtils.close(destChannel);
FileUtils.close(out);
FileUtils.close(in);
}
} else {
InputStream in = null;
OutputStream out = null;
try {
in = source.getInputStream();
out = getOutputStream(dest, append, project);
byte[] buffer = new byte[FileUtils.BUF_SIZE];
int count = 0;
do {
out.write(buffer, 0, count);
count = in.read(buffer, 0, buffer.length);
} while (count != -1);
} finally {
FileUtils.close(out);
FileUtils.close(in);
}
}
if (preserveLastModified) {
Touchable t = dest.as(Touchable.class);
if (t != null) {
setLastModified(t, source.getLastModified());
}
}
}
// CheckStyle:ParameterNumberCheck ON
/**
* Set the last modified time of an object implementing
* org.apache.tools.ant.types.resources.Touchable .
*
* @param t the Touchable whose modified time is to be set.
* @param time the time to which the last modified time is to be set.
* if this is -1, the current time is used.
* @since Ant 1.7
*/
public static void setLastModified(Touchable t, long time) {
t.touch((time < 0) ? System.currentTimeMillis() : time);
}
/**
* Compares the contents of two Resources.
*
* @param r1 the Resource whose content is to be compared.
* @param r2 the other Resource whose content is to be compared.
* @param text true if the content is to be treated as text and
* differences in kind of line break are to be ignored.
*
* @return true if the content of the Resources is the same.
*
* @throws IOException if the Resources cannot be read.
* @since Ant 1.7
*/
public static boolean contentEquals(Resource r1, Resource r2, boolean text) throws IOException {
if (r1.isExists() != r2.isExists()) {
return false;
}
if (!r1.isExists()) {
// two not existing files are equal
return true;
}
// should the following two be switched? If r1 and r2 refer to the same file,
// isn't their content equal regardless of whether that file is a directory?
if (r1.isDirectory() || r2.isDirectory()) {
// don't want to compare directory contents for now
return false;
}
if (r1.equals(r2)) {
return true;
}
if (!text) {
long s1 = r1.getSize();
long s2 = r2.getSize();
if (s1 != Resource.UNKNOWN_SIZE && s2 != Resource.UNKNOWN_SIZE
&& s1 != s2) {
return false;
}
}
return compareContent(r1, r2, text) == 0;
}
/**
* Compare the content of two Resources. A nonexistent Resource's
* content is "less than" that of an existing Resource; a directory-type
* Resource's content is "less than" that of a file-type Resource.
* @param r1 the Resource whose content is to be compared.
* @param r2 the other Resource whose content is to be compared.
* @param text true if the content is to be treated as text and
* differences in kind of line break are to be ignored.
* @return a negative integer, zero, or a positive integer as the first
* argument is less than, equal to, or greater than the second.
* @throws IOException if the Resources cannot be read.
* @since Ant 1.7
*/
public static int compareContent(Resource r1, Resource r2, boolean text) throws IOException {
if (r1.equals(r2)) {
return 0;
}
boolean e1 = r1.isExists();
boolean e2 = r2.isExists();
if (!(e1 || e2)) {
return 0;
}
if (e1 != e2) {
return e1 ? 1 : -1;
}
boolean d1 = r1.isDirectory();
boolean d2 = r2.isDirectory();
if (d1 && d2) {
return 0;
}
if (d1 || d2) {
return d1 ? -1 : 1;
}
return text ? textCompare(r1, r2) : binaryCompare(r1, r2);
}
/**
* Convenience method to turn any fileProvider into a basic
* FileResource with the file's immediate parent as the basedir,
* for tasks that need one.
* @param fileProvider input
* @return fileProvider if it is a FileResource instance, or a new
* FileResource with fileProvider's file.
* @since Ant 1.8
*/
public static FileResource asFileResource(FileProvider fileProvider) {
if (fileProvider instanceof FileResource || fileProvider == null) {
return (FileResource) fileProvider;
}
FileResource result = new FileResource(fileProvider.getFile());
result.setProject(Project.getProject(fileProvider));
return result;
}
/**
* Binary compares the contents of two Resources.
* * simple but sub-optimal comparision algorithm. written for working * rather than fast. Better would be a block read into buffers followed * by long comparisions apart from the final 1-7 bytes. *
* * @param r1 the Resource whose content is to be compared. * @param r2 the other Resource whose content is to be compared. * @return a negative integer, zero, or a positive integer as the first * argument is less than, equal to, or greater than the second. * @throws IOException if the Resources cannot be read. * @since Ant 1.7 */ private static int binaryCompare(Resource r1, Resource r2) throws IOException { InputStream in1 = null; InputStream in2 = null; try { in1 = new BufferedInputStream(r1.getInputStream()); in2 = new BufferedInputStream(r2.getInputStream()); for (int b1 = in1.read(); b1 != -1; b1 = in1.read()) { int b2 = in2.read(); if (b1 != b2) { return b1 > b2 ? 1 : -1; } } return in2.read() == -1 ? 0 : -1; } finally { FileUtils.close(in1); FileUtils.close(in2); } } /** * Text compares the contents of two Resources. * Ignores different kinds of line endings. * @param r1 the Resource whose content is to be compared. * @param r2 the other Resource whose content is to be compared. * @return a negative integer, zero, or a positive integer as the first * argument is less than, equal to, or greater than the second. * @throws IOException if the Resources cannot be read. * @since Ant 1.7 */ private static int textCompare(Resource r1, Resource r2) throws IOException { BufferedReader in1 = null; BufferedReader in2 = null; try { in1 = new BufferedReader(new InputStreamReader(r1.getInputStream())); in2 = new BufferedReader(new InputStreamReader(r2.getInputStream())); String expected = in1.readLine(); while (expected != null) { String actual = in2.readLine(); if (!expected.equals(actual)) { if (actual == null) { return 1; } return expected.compareTo(actual); } expected = in1.readLine(); } return in2.readLine() == null ? 0 : -1; } finally { FileUtils.close(in1); FileUtils.close(in2); } } /** * Log which Resources (if any) have been modified in the future. * @param logTo the ProjectComponent to do the logging. * @param rc the collection of Resources to check. * @param granularity the timestamp granularity to use. * @since Ant 1.7 */ private static void logFuture(ProjectComponent logTo, ResourceCollection rc, long granularity) { long now = System.currentTimeMillis() + granularity; Date sel = new Date(); sel.setMillis(now); sel.setWhen(TimeComparison.AFTER); Restrict future = new Restrict(); future.add(sel); future.add(rc); for (Resource r : future) { logTo.log("Warning: " + r.getName() + " modified in the future.", Project.MSG_WARN); } } private static OutputStream getOutputStream(Resource resource, boolean append, Project project) throws IOException { if (append) { Appendable a = resource.as(Appendable.class); if (a != null) { return a.getAppendOutputStream(); } project.log("Appendable OutputStream not available for non-appendable resource " + resource + "; using plain OutputStream", Project.MSG_VERBOSE); } return resource.getOutputStream(); } public static interface ResourceSelectorProvider { ResourceSelector getTargetSelectorForSource(Resource source); } }