blob: 1277f276018431660daa6160dab9d957913a8ac2 [file] [log] [blame]
/*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2000-2002 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Ant", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.tools.ant.util;
import org.apache.tools.ant.Project;
import org.apache.tools.ant.Task;
import org.apache.tools.ant.taskdefs.condition.Os;
import java.io.File;
import java.util.Vector;
/**
* Utility class that collects the functionality of the various
* scanDir methods that have been scattered in several tasks before.
*
* <p>The only method returns an array of source files. The array is a
* subset of the files given as a parameter and holds only those that
* are newer than their corresponding target files.</p>
*
* @author <a href="mailto:stefan.bodewig@epost.de">Stefan Bodewig</a>
*/
public class SourceFileScanner {
protected Task task;
private FileUtils fileUtils;
/**
* @param task The task we should log messages through
*/
public SourceFileScanner(Task task) {
this.task = task;
fileUtils = FileUtils.newFileUtils();
}
/**
* Restrict the given set of files to those that are newer than
* their corresponding target files.
*
* @param files the original set of files
* @param srcDir all files are relative to this directory
* @param destDir target files live here. if null file names
* returned by the mapper are assumed to be absolute.
* @param mapper knows how to construct a target file names from
* source file names.
*/
public String[] restrict(String[] files, File srcDir, File destDir,
FileNameMapper mapper) {
long now = (new java.util.Date()).getTime();
StringBuffer targetList = new StringBuffer();
/*
If we're on Windows, we have to munge the time up to 2 secs to
be able to check file modification times.
(Windows has a max resolution of two secs for modification times)
Actually this is a feature of the FAT file system, NTFS does
not have it, so if we could reliably passively test for an NTFS
file systems we could turn this off...
*/
if (Os.isFamily("windows")) {
now += 2000;
}
Vector v = new Vector();
for (int i = 0; i < files.length; i++) {
String[] targets = mapper.mapFileName(files[i]);
if (targets == null || targets.length == 0) {
task.log(files[i] + " skipped - don\'t know how to handle it",
Project.MSG_VERBOSE);
continue;
}
File src = fileUtils.resolveFile(srcDir, files[i]);
if (src.lastModified() > now) {
task.log("Warning: " + files[i] + " modified in the future.",
Project.MSG_WARN);
}
boolean added = false;
targetList.setLength(0);
for (int j = 0; !added && j < targets.length; j++) {
File dest = fileUtils.resolveFile(destDir, targets[j]);
if (!dest.exists()) {
task.log(files[i] + " added as " + dest.getAbsolutePath()
+ " doesn\'t exist.", Project.MSG_VERBOSE);
v.addElement(files[i]);
added = true;
} else if (src.lastModified() > dest.lastModified()) {
task.log(files[i] + " added as " + dest.getAbsolutePath()
+ " is outdated.", Project.MSG_VERBOSE);
v.addElement(files[i]);
added = true;
} else {
if (targetList.length() > 0) {
targetList.append(", ");
}
targetList.append(dest.getAbsolutePath());
}
}
if (!added) {
task.log(files[i] + " omitted as " + targetList.toString()
+ (targets.length == 1 ? " is" : " are ")
+ " up to date.", Project.MSG_VERBOSE);
}
}
String[] result = new String[v.size()];
v.copyInto(result);
return result;
}
/**
* Convinience layer on top of restrict that returns the source
* files as File objects (containing absolute paths if srcDir is
* absolute).
*/
public File[] restrictAsFiles(String[] files, File srcDir, File destDir,
FileNameMapper mapper) {
String[] res = restrict(files, srcDir, destDir, mapper);
File[] result = new File[res.length];
for (int i = 0; i < res.length; i++) {
result[i] = new File(srcDir, res[i]);
}
return result;
}
}