From 683a5f1433818fdfc1a68f50707870f581954510 Mon Sep 17 00:00:00 2001 From: Stefan Bodewig Date: Wed, 20 Sep 2000 14:49:37 +0000 Subject: [PATCH] New task that set's a property if a given target file is newer than a given set of source files. I've taken the freedom to merge ideas submitted by William and Hiroaki and to throw in some of my own. Submitted by: William Ferguson , Hiroaki Nakamura git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@268019 13f79535-47bb-0310-9956-ffa450edef68 --- WHATSNEW | 2 +- docs/index.html | 37 +++- .../tools/ant/taskdefs/CompileTask.java | 4 + .../apache/tools/ant/taskdefs/UpToDate.java | 162 ++++++++++++++++++ .../tools/ant/taskdefs/defaults.properties | 1 + 5 files changed, 204 insertions(+), 2 deletions(-) create mode 100644 src/main/org/apache/tools/ant/taskdefs/UpToDate.java diff --git a/WHATSNEW b/WHATSNEW index 0dc638bcc..c318b6575 100644 --- a/WHATSNEW +++ b/WHATSNEW @@ -46,7 +46,7 @@ Other changes: -------------- * New tasks: antstructure, cab, execon, fail, ftp, genkey, jlink, -junit, sql, javacc, jjtree, starteam, war, unwar. +junit, sql, javacc, jjtree, starteam, war, unwar, uptodate. * New tasks mparse pending documentation. diff --git a/docs/index.html b/docs/index.html index 4f831851d..d5cc00acc 100644 --- a/docs/index.html +++ b/docs/index.html @@ -25,7 +25,7 @@
  • Dave Walend (dwalend@cs.tufts.edu)
    • -

    Version 1.2 - 2000/09/19

    +

    Version 1.2 - 2000/09/20

    Table of Contents

    @@ -876,6 +876,7 @@ same patterns as the example before.

  • Taskdef
  • Touch
  • Tstamp
    • +
  • Uptodate
  • Unjar
  • Untar
  • Unwar
    • @@ -3758,6 +3759,40 @@ initialization target.

    Examples

      <tstamp/>
    +

    Uptodate

    +

    Description

    +

    Sets a property if a Target file is more up to date than a set of +Source files. Source files are specified by nested <srcfiles> +elements, these are FileSets.

    +

    The value part of the property being set is true if the timestamp of the +Target file is more recent than the timestamp of every Source file.

    +

    Normally, this task is used to set properties that are useful to avoid target +execution depending on the relative age of the specified files.

    +

    Parameters

    + + + + + + + + + + + + + + + + +
    AttributeDescriptionRequired
    propertythe name of the property to set.Yes
    targetfilethe file for which we want to determine the status.Yes
    +

    Examples

    +
      <uptodate property="xmlBuild.notRequired" targetfile="${deploy}\xmlClasses.jar" >
+    <srcfiles dir= "${src}/xml" includes="**/*.dtd" />
+  </uptodate>
    +

    sets the property xmlBuild.notRequired to the value "true" +if the ${deploy}/xmlClasses.jar is more up to date than any of the DTD files in the ${src}/xml directory.

    +

    Unjar/Unwar/Unzip

    Description

    Unzips a zip-, war- or jarfile.

    diff --git a/src/main/org/apache/tools/ant/taskdefs/CompileTask.java b/src/main/org/apache/tools/ant/taskdefs/CompileTask.java index 19d1a0119..ddc936c40 100644 --- a/src/main/org/apache/tools/ant/taskdefs/CompileTask.java +++ b/src/main/org/apache/tools/ant/taskdefs/CompileTask.java @@ -65,6 +65,8 @@ import java.util.*; * which otherwise would require multiple executions of Ant. * * @author Sam Ruby rubys@us.ibm.com + * + * @deprecated use <taskdef> elements nested into <target>s instead */ public class CompileTask extends Javac { @@ -84,6 +86,8 @@ public class CompileTask extends Javac { * do all the real work in init */ public void init() { + log("!! CompileTask is deprecated. !!"); + log("Use elements nested into s instead"); // create all the include entries from the task defs for (Enumeration e=taskList.elements(); e.hasMoreElements(); ) { diff --git a/src/main/org/apache/tools/ant/taskdefs/UpToDate.java b/src/main/org/apache/tools/ant/taskdefs/UpToDate.java new file mode 100644 index 000000000..9f515ba26 --- /dev/null +++ b/src/main/org/apache/tools/ant/taskdefs/UpToDate.java @@ -0,0 +1,162 @@ +/* + * The Apache Software License, Version 1.1 + * + * Copyright (c) 2000 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", "Tomcat", 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 + * . + */ + +package org.apache.tools.ant.taskdefs; + +import org.apache.tools.ant.*; +import org.apache.tools.ant.types.*; +import java.io.*; +import java.util.Enumeration; +import java.util.Date; +import java.util.Vector; + +/** + * Will set the given property if the specified target has a timestamp + * greater than all of the source files. + * + * @author William Ferguson williamf@mincom.com + * @author Hiroaki Nakamura hnakamur@mc.neweb.ne.jp + * @author Stefan Bodewig + */ + +public class UpToDate extends MatchingTask { + + private String _property; + private File _targetFile; + private Vector sourceFileSets = new Vector(); + + /** + * The property to set if the target file is more up to date than each of + * the source files. + * + * @param property the name of the property to set if Target is up to date. + */ + public void setProperty(String property) { + _property = property; + } + + /** + * The file which must be more up to date than each of the source files + * if the property is to be set. + * + * @param file the file which we are checking against. + */ + public void setTargetFile(File file) { + _targetFile = file; + } + + /** + * Nested element. + */ + public void addSrcfiles(FileSet fs) { + sourceFileSets.addElement(fs); + } + + /** + * Sets property to true if target file has a more recent timestamp than + * each of the source files. + */ + public void execute() throws BuildException { + + if (sourceFileSets.size() == 0) { + throw new BuildException("At least one element must be set"); + } + + if (_targetFile == null) { + throw new BuildException("The targetfile attribute must be set"); + } + + // if not there then it can't be up to date + if (!_targetFile.exists()) return; + + Enumeration enum = sourceFileSets.elements(); + boolean upToDate = true; + while (upToDate && enum.hasMoreElements()) { + FileSet fs = (FileSet) enum.nextElement(); + DirectoryScanner ds = fs.getDirectoryScanner(project); + upToDate = upToDate && scanDir(fs.getDir(project), _targetFile, + ds.getIncludedFiles()); + } + + if (upToDate) { + this.project.setProperty(_property, "true"); + log("File \"" + _targetFile.getAbsolutePath() + "\" is up to date.", + Project.MSG_VERBOSE); + } + } + + protected boolean scanDir(File srcDir, File destFile, String files[]) { + long destLastModified = destFile.lastModified(); + long now = (new Date()).getTime(); + if (destLastModified > now) { + log("Warning: destfile modified in the future: " + + destFile.getPath(), Project.MSG_WARN); + } + + for (int i = 0; i < files.length; i++) { + File srcFile = new File(srcDir, files[i]); + + long srcLastModified = srcFile.lastModified(); + if (srcLastModified > now) { + log("Warning: file modified in the future: " + + files[i], Project.MSG_WARN); + } + + if (srcLastModified > destLastModified) { + return false; + } + } + return true; + } +} diff --git a/src/main/org/apache/tools/ant/taskdefs/defaults.properties b/src/main/org/apache/tools/ant/taskdefs/defaults.properties index dca236bf8..f4804c0db 100644 --- a/src/main/org/apache/tools/ant/taskdefs/defaults.properties +++ b/src/main/org/apache/tools/ant/taskdefs/defaults.properties @@ -44,6 +44,7 @@ sql=org.apache.tools.ant.taskdefs.SQLExec mail=org.apache.tools.ant.taskdefs.SendEmail fail=org.apache.tools.ant.taskdefs.Exit war=org.apache.tools.ant.taskdefs.War +uptodate=org.apache.tools.ant.taskdefs.UpToDate # optional tasks script=org.apache.tools.ant.taskdefs.optional.Script