--- src/main/org/apache/tools/ant/taskdefs/optional/EchoProperties.java.orig 2002-05-02 17:40:31.220741000 +0200
+++ src/main/org/apache/tools/ant/taskdefs/optional/EchoProperties.java 2002-05-07 09:54:59.085239000 +0200
@@ -56,16 +56,27 @@
import org.apache.tools.ant.Project;
import org.apache.tools.ant.Task;
import org.apache.tools.ant.BuildException;
+import org.apache.tools.ant.util.DOMElementWriter;
+import org.apache.tools.ant.types.EnumeratedAttribute;
+
+import org.w3c.dom.Document;
+import org.w3c.dom.Element;
import java.util.Properties;
-import java.util.Hashtable;
import java.util.Enumeration;
import java.io.ByteArrayOutputStream;
import java.io.OutputStream;
+import java.io.OutputStreamWriter;
+import java.io.Writer;
import java.io.File;
-import java.io.IOException;
+import java.io.FileInputStream;
import java.io.FileOutputStream;
+import java.io.FileNotFoundException;
+import java.io.IOException;
+
+import javax.xml.parsers.DocumentBuilder;
+import javax.xml.parsers.DocumentBuilderFactory;
/**
* Displays all the current properties in the build. The output can be sent to
@@ -100,11 +111,38 @@
*
*@author Matt Albrecht
* groboclown@users.sourceforge.net
+ *@author Ingmar Stein
+ stein@xtramind.com
*@since Ant 1.5
*/
public class EchoProperties extends Task {
/**
+ * the properties element.
+ */
+ private static final String PROPERTIES = "properties";
+
+ /**
+ * the property element.
+ */
+ private static final String PROPERTY = "property";
+
+ /**
+ * name attribute for property, testcase and testsuite elements.
+ */
+ private static final String ATTR_NAME = "name";
+
+ /**
+ * value attribute for property elements.
+ */
+ private static final String ATTR_VALUE = "value";
+
+ /**
+ * the input file.
+ */
+ private File inFile = null;
+
+ /**
* File object pointing to the output file. If this is null, then we output
* to the project log, not to a file.
*/
@@ -123,6 +161,17 @@
private String prefix = null;
+ private String format = "text";
+
+ /**
+ * Sets the input file.
+ *
+ * @param file the input file
+ */
+ public void setSrcfile( File file ) {
+ inFile = file;
+ }
+
/**
* Set a file to store the property output. If this is never specified,
* then the output will be sent to the Ant log.
@@ -163,32 +212,121 @@
}
+ public void setFormat(FormatAttribute ea) {
+ format = ea.getValue();
+ }
+
+ public static class FormatAttribute extends EnumeratedAttribute {
+ private String [] formats = new String[]{"xml", "text"};
+
+ public String[] getValues() {
+ return formats;
+ }
+ }
+
/**
* Run the task.
*
*@exception BuildException trouble, probably file IO
*/
public void execute() throws BuildException {
- //copy the properties file
- Hashtable allProps = project.getProperties();
+ Properties props = new Properties();
- try {
- if (destfile == null) {
- ByteArrayOutputStream baos = new ByteArrayOutputStream();
- saveProperties(allProps, baos);
- log(baos.toString(), Project.MSG_INFO);
- } else {
- OutputStream os = new FileOutputStream(this.destfile);
- saveProperties(allProps, os);
- }
- } catch (IOException ioe) {
- String message =
- "Destfile " + destfile + " could not be written to.";
- if (failonerror) {
- throw new BuildException(message, ioe,
- location);
- } else {
- log(message, Project.MSG_INFO);
+ /* load properties from file if specified, otherwise
+ use Ant's properties */
+ if( inFile == null ) {
+ // add ant properties
+ props.putAll( project.getProperties() );
+ } else {
+ if (inFile.exists() && inFile.isDirectory()) {
+ String message = "srcfile is a directory!";
+ if (failonerror) {
+ throw new BuildException(message, location);
+ } else {
+ log( message, Project.MSG_ERR );
+ }
+ return;
+ }
+
+ if (inFile.exists() && !inFile.canRead()) {
+ String message = "Can not read from the specified srcfile!";
+ if( failonerror ) {
+ throw new BuildException( message, location );
+ } else {
+ log( message, Project.MSG_ERR );
+ }
+ return;
+ }
+
+ FileInputStream in = null;
+ try {
+ in = new FileInputStream( inFile );
+ props.load( in );
+ } catch( FileNotFoundException fnfe ) {
+ String message =
+ "Could not find file " + inFile.getAbsolutePath();
+ if (failonerror) {
+ throw new BuildException(message, fnfe, location);
+ } else {
+ log( message, Project.MSG_WARN );
+ }
+ return;
+ } catch( IOException ioe ) {
+ String message =
+ "Could not read file " + inFile.getAbsolutePath();
+ if (failonerror) {
+ throw new BuildException(message, ioe, location);
+ } else {
+ log( message, Project.MSG_WARN );
+ }
+ return;
+ } finally {
+ try {
+ if( null != in ) {
+ in.close();
+ }
+ } catch(IOException ioe) {}
+ }
+ }
+
+ if (destfile == null) {
+ ByteArrayOutputStream baos = new ByteArrayOutputStream();
+ try {
+ saveProperties(props, baos);
+ } catch( IOException ioe ) {}
+ log(baos.toString(), Project.MSG_INFO);
+ } else {
+ if (destfile.exists() && destfile.isDirectory()) {
+ String message = "destfile is a directory!";
+ if (failonerror) {
+ throw new BuildException(message, location);
+ } else {
+ log( message, Project.MSG_ERR );
+ }
+ return;
+ }
+
+ if (destfile.exists() && !destfile.canWrite()) {
+ String message = "Can not write to the specified destfile!";
+ if( failonerror ) {
+ throw new BuildException( message, location );
+ } else {
+ log( message, Project.MSG_ERR );
+ }
+ return;
+ }
+
+ try {
+ OutputStream os = new FileOutputStream(destfile);
+ saveProperties(props, os);
+ } catch (IOException ioe) {
+ String message =
+ "Destfile " + destfile + " could not be written to.";
+ if (failonerror) {
+ throw new BuildException(message, ioe, location);
+ } else {
+ log(message, Project.MSG_INFO);
+ }
}
}
}
@@ -204,7 +342,7 @@
*@param os output stream
*@exception IOException trouble
*/
- protected void saveProperties(Hashtable allProps, OutputStream os)
+ protected void saveProperties(Properties allProps, OutputStream os)
throws IOException, BuildException {
Properties props = new Properties();
Enumeration enum = allProps.keys();
@@ -216,13 +354,48 @@
}
}
try {
- jdkSaveProperties(props, os, "Ant properties");
+ if ("text".equals(format)) {
+ jdkSaveProperties(props, os, "Ant properties");
+ } else if ("xml".equals(format)) {
+ xmlSaveProperties(props, os );
+ }
} finally {
os.close();
}
}
-
-
+
+ protected void xmlSaveProperties(Properties props,
+ OutputStream os) throws IOException {
+ // create XML document
+ Document doc = getDocumentBuilder().newDocument();
+ Element rootElement = doc.createElement( PROPERTIES );
+
+ // output properties
+ String name;
+ Enumeration e = props.propertyNames();
+ while( e.hasMoreElements() ) {
+ name = (String)e.nextElement();
+ Element propElement = doc.createElement( PROPERTY );
+ propElement.setAttribute( ATTR_NAME, name );
+ propElement.setAttribute( ATTR_VALUE, props.getProperty( name ) );
+ rootElement.appendChild( propElement );
+ }
+
+ Writer wri = null;
+ try {
+ wri = new OutputStreamWriter( os, "UTF8" );
+ wri.write( "" );
+ ( new DOMElementWriter() ).write( rootElement, wri, 0, "\t" );
+ wri.flush();
+ } catch( IOException ioe ) {
+ throw new BuildException( "Unable to write XML file", ioe );
+ } finally {
+ if( wri != null ) {
+ wri.close();
+ }
+ }
+ }
+
/**
* JDK 1.2 allows for the safer method
* Properties.store( OutputStream, String ), which throws an
@@ -251,7 +424,7 @@
if (t instanceof RuntimeException) {
throw (RuntimeException) t;
}
-
+
// not an expected exception. Resort to JDK 1.0 to execute
// this method
jdk10SaveProperties(props, os, header);
@@ -264,8 +437,8 @@
jdk10SaveProperties(props, os, header);
}
}
-
-
+
+
/**
* Save the properties to the output stream using the JDK 1.0 compatible
* method. This won't throw an IOException on an output error.
@@ -278,5 +451,18 @@
String header) {
props.save(os, header);
}
+
+ /**
+ * Uses the DocumentBuilderFactory to get a DocumentBuilder instance.
+ *
+ * @return The DocumentBuilder instance
+ */
+ private static DocumentBuilder getDocumentBuilder() {
+ try {
+ return DocumentBuilderFactory.newInstance().newDocumentBuilder();
+ } catch( Exception e ) {
+ throw new ExceptionInInitializerError( e );
+ }
+ }
}