--- Stefan Bodewig <[EMAIL PROTECTED]> wrote:
> Thanks for the explanation Diane, I'll have a second look at this
> task(s) later - seems I've forgotten a lot of things they could do.
(I'd forgotten not only the things it does, but that it even existed at
all :)
Thanks for taking a look at it. I've attached the latest version I have,
which is Nico's + some minor mods I've made. I think the only thing left
to do for it is to bring the logging stuff up-to-date.
Diane
=====
([EMAIL PROTECTED])
__________________________________________________
Do You Yahoo!?
Yahoo! Messenger - Talk while you surf! It's FREE.
http://im.yahoo.com/
/*
* The Apache Software License, Version 1.1
*
* Copyright (c) 1999 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 [EMAIL PROTECTED]
*
* 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/>.
*/
/*
**PropertyFile task uses java.util.Properties to modify integer, String and
**Date settings in a property file.
**
**
**The following is an example of its usage:
** <target name="setState">
** <property
** name="header"
** value="##Generated file - do not modify!"/>
** <propertyfile file="${state.file}" message="${header}"/>
** <entry key="product.version.major" type="int" value="5"/>
** <entry key="product.version.minor" type="int" value="0"/>
** <entry key="product.build.major" type="int" value="0" />
** <entry key="product.build.minor" type="int" operation="+" />
** <entry key="product.build.date" type="date" operation="now" />
** <entry key="intInc" type="int" operation="=" value="681"/>
** <entry key="intDec" type="int" operation="-"/>
** <entry key="NeverDate" type="date" operation="never"/>
** <entry key="StringEquals" type="string" value="testValue"/>
** <entry key="NowDate" type="date" operation="now"/>
** </propertyfile>
** </target>
**
**The <propertyfile> task must have:
** key, type, file
**Other parameters are:
** operation, value, message
**
**Parameter values:
** operation:
** "=" (set -- default)
** "-" (dec)
** "+" (inc)
** "now" (date and time)
** "never" (empty string)
**
** type:
** "int"
** "date"
** "string"
**
**String property types can only use the "=" operation.
**Date property types can only use the "never" or "now" operations.
**Int property types can only use the "=", "-" or "+" operations.
**
**The message property is used for the property file header, with "\\" being
**a newline delimiter charater. (This should be '\n' but I couldn't quite get
**it right).
**
*/
package org.apache.tools.ant.taskdefs.optional;
import org.apache.tools.ant.*;
import java.io.*;
import java.util.*;
/**
* <code>PropertyFile</code> provides a mechanism for updating a
* java.util.Properties object via Ant.
* @author Jeremy Mawson <[EMAIL PROTECTED]>
*/
public class PropertyFile extends Task
{
/* ========================================================================
*
* Static variables.
*/
private static final String NEWLINE = System.getProperty("line.separator");
/* ========================================================================
*
* Instance variables.
*/
// Use this to prepend a message to the properties file
private String m_comment;
private Properties m_properties;
private File m_propertyfile;
private Vector entries = new Vector();
private Entry mainEntry = new Entry();
/* ========================================================================
*
* Constructors
*/
/* ========================================================================
*
* Methods
*/
public void execute() throws BuildException
{
checkParameters();
readFile();
executeOperation();
writeFile();
}
public Entry createEntry()
{
Entry e = new Entry();
entries.addElement(e);
return e;
}
private void executeOperation() throws BuildException
{
// mainEntry.executeOn(m_properties);
for (Enumeration e = entries.elements(); e.hasMoreElements(); )
{
Entry entry = (Entry)e.nextElement();
entry.executeOn(m_properties);
}
}
private void readFile() throws BuildException
{
// Create the PropertyFile
m_properties = new Properties();
try
{
if (m_propertyfile.exists())
{
log("Updating property file:
"+m_propertyfile.getAbsolutePath());
m_properties.load(new BufferedInputStream(
new FileInputStream(m_propertyfile)));
}
else
{
log("Creating new property file: "+
m_propertyfile.getAbsolutePath());
FileOutputStream out = new
FileOutputStream(m_propertyfile.getAbsolutePath());
out.flush();
out.close();
}
}
catch(IOException ioe)
{
throw new BuildException(ioe.toString());
}
}
private void checkParameters() throws BuildException
{
if (!checkParam(m_propertyfile))
{
throw new BuildException("file token must not be null.", location);
}
}
public void setOperation(String op)
{
mainEntry.setOperation(op);
}
public void setType(String type)
{
mainEntry.setType(type);
}
public void setValue(String value)
{
mainEntry.setValue(value);
}
public void setKey(String key)
{
mainEntry.setKey(key);
}
public void setFile(String file)
{
m_propertyfile = new File(file);
}
public void setComment(String hdr)
{
m_comment = hdr;
}
/*
* Writes the properties to a file. Writes the file manually, rather than
* using Properties.store method, so that special characters are not escaped.
*/
private void writeFile() throws BuildException
{
try
{
BufferedOutputStream bos = new BufferedOutputStream(
new FileOutputStream(m_propertyfile));
// Write the message if we have one.
if (m_comment != null)
{
// FIXME: would like to use \n as the newline rather than \\.
StringTokenizer tok = new StringTokenizer(m_comment, "\\");
while (tok.hasMoreTokens())
{
bos.write("# ".getBytes());
bos.write(((String)tok.nextToken()).getBytes());
bos.write(NEWLINE.getBytes());
}
bos.write(NEWLINE.getBytes());
bos.flush();
}
Enumeration enumValues = m_properties.elements();
Enumeration enumKeys = m_properties.keys();
while (enumKeys.hasMoreElements())
{
bos.write(((String)enumKeys.nextElement()).getBytes());
bos.write("=".getBytes());
bos.write(((String)enumValues.nextElement()).getBytes());
bos.write(NEWLINE.getBytes());
bos.flush();
}
bos.close();
}
catch (IOException ioe)
{
throw new BuildException(ioe.toString());
}
}
/*
* Returns whether the given parameter has been defined.
*/
private boolean checkParam(String param)
{
return !((param == null) || (param.equals("null")));
}
private boolean checkParam(File param)
{
return !(param == null);
}
public static class Entry
{
// Property types
private static final String INTEGER_TYPE = "int";
private static final String DATE_TYPE = "date";
private static final String STRING_TYPE = "string";
// Property type operations
private static final String INCREMENT_OPER = "+";
private static final String DECREMENT_OPER = "-";
private static final String EQUALS_OPER = "=";
// Special values
private static final String NOW_VALUE = "now";
private static final String NULL_VALUE = "never";
private static final int DEFAULT_INT_VALUE = 1;
private static final GregorianCalendar
DEFAULT_DATE_VALUE = new GregorianCalendar();
private String m_key;
private String m_type = null;
private String m_operation = null;
private String m_value;
private int m_intValue = DEFAULT_INT_VALUE;
private GregorianCalendar m_dateValue = DEFAULT_DATE_VALUE;
public void setKey(String value)
{
this.m_key = value;
}
public void setValue(String value)
{
this.m_value = value;
this.setOperation(EQUALS_OPER);
}
public void setOperation(String value)
{
this.m_operation = value;
}
public void setType(String value)
{
this.m_type = value;
}
protected void executeOn(Properties props) throws BuildException
{
// Fork off process per the operation type requested
if (m_type.equals(INTEGER_TYPE))
{
executeInteger((String)props.get(m_key));
}
else if (m_type.equals(DATE_TYPE))
{
executeDate((String)props.get(m_key));
}
else if (m_type.equals(STRING_TYPE))
{
}
else
{
throw new BuildException("Unknown operation type: "+m_type+"");
}
props.put(m_key, m_value);
}
/*
* Continue execution for Date values
* TODO: Modify for different locales and formats
*/
private void executeDate(String oldValue) throws BuildException
{
StringBuffer dateString = new StringBuffer();
// If value is defined then interpret what's given
if (m_operation.equals(NULL_VALUE))
{
m_dateValue = null;
}
else
{
Date now = new Date();
m_dateValue.setTime(now);
dateString.append(m_dateValue.get(Calendar.YEAR));
dateString.append("/");
dateString.append((m_dateValue.get(Calendar.MONTH)+1 < 10) ?
"0" : "");
dateString.append(m_dateValue.get(Calendar.MONTH)+1);
dateString.append("/");
dateString.append((m_dateValue.get(Calendar.DATE) < 10) ? "0" :
"");
dateString.append(m_dateValue.get(Calendar.DATE));
dateString.append(" ");
dateString.append((m_dateValue.get(Calendar.HOUR_OF_DAY) < 10)
? "0" : "");
dateString.append(m_dateValue.get(Calendar.HOUR_OF_DAY));
dateString.append(":");
dateString.append((m_dateValue.get(Calendar.MINUTE) < 10) ? "0"
: "");
dateString.append(m_dateValue.get(Calendar.MINUTE));
m_value = dateString.toString();
}
m_value = dateString.toString();
}
/*
* Continue execution for int values
*/
private void executeInteger(String oldValue) throws BuildException
{
String newValue = "";
int currentValue = 0;
try
{
currentValue = new Integer(oldValue).intValue();
}
catch (NumberFormatException nfe)
{
// Do nothing
}
if (m_operation.equals(EQUALS_OPER))
{
m_value = new String(""+currentValue);
}
else if (m_operation.equals(INCREMENT_OPER))
{
currentValue++;
m_value = new String(""+currentValue);
}
else if (m_operation.equals(DECREMENT_OPER))
{
currentValue--;
m_value = new String(""+currentValue);
}
}
}
}
