src/main/org/apache/tools/ant/taskdefs/Property.java - ant - Git at Google

 /*
  * 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.taskdefs;

 import org.apache.tools.ant.Task;
 import org.apache.tools.ant.BuildException;
 import org.apache.tools.ant.Project;
 import org.apache.tools.ant.AntClassLoader;
 import org.apache.tools.ant.ProjectHelper;
 import org.apache.tools.ant.types.Path;
 import org.apache.tools.ant.types.Reference;
 import java.io.File;
 import java.io.FileInputStream;
 import java.io.IOException;
 import java.io.InputStream;
 import java.util.Properties;
 import java.util.Vector;
 import java.util.Enumeration;

 /**
  * Will set a Project property. Used to be a hack in ProjectHelper
  * Will not override values set by the command line or parent projects.
  *
  * @author costin@dnt.ro
  * @author <a href="mailto:rubys@us.ibm.com">Sam Ruby</a>
  * @author <a href="mailto:glennm@ca.ibm.com">Glenn McAllister</a>
  */
 public class Property extends Task {

     protected String name;
     protected String value;
     protected File file;
     protected String resource;
     protected Path classpath;
     protected String env;
     protected Reference ref;
     protected String prefix;

     protected boolean userProperty; // set read-only properties

     public Property() {
         super();
     }

     protected Property(boolean userProperty) {
         this.userProperty = userProperty;
     }

     public void setName(String name) {
         this.name = name;
     }

     public String getName() {
         return name;
     }

     public void setLocation(File location) {
         setValue(location.getAbsolutePath());
     }

     public void setValue(String value) {
         this.value = value;
     }

     public String getValue() {
         return value;
     }

     public void setFile(File file) {
         this.file = file;
     }

     public File getFile() {
         return file;
     }

     public void setPrefix(String prefix) {
         this.prefix = prefix;
         if (!prefix.endsWith(".")) {
           this.prefix += ".";
         }
     }

     public void setRefid(Reference ref) {
         this.ref = ref;
     }

     public Reference getRefid() {
         return ref;
     }

     public void setResource(String resource) {
         this.resource = resource;
     }

     public String getResource() {
         return resource;
     }

     public void setEnvironment(String env) {
         this.env = env;
     }

     public String getEnvironment() {
         return env;
     }

     public void setClasspath(Path classpath) {
         if (this.classpath == null) {
             this.classpath = classpath;
         } else {
             this.classpath.append(classpath);
         }
     }

     public Path createClasspath() {
         if (this.classpath == null) {
             this.classpath = new Path(project);
         }
         return this.classpath.createPath();
     }

     public void setClasspathRef(Reference r) {
         createClasspath().setRefid(r);
     }

     /**
      * @deprecated This was never a supported feature and has been deprecated without replacement
      */
     public void setUserProperty(boolean userProperty) {
         log("DEPRECATED: Ignoring request to set user property in Property task.",
             Project.MSG_WARN);
     }

     public String toString() {
         return value == null ? "" : value;
     }

     public void execute() throws BuildException {
         if (name != null) {
             if (value == null && ref == null) {
                 throw new BuildException("You must specify value, location or refid with the name attribute",
                                          location);
             }
         } else {
             if (file == null && resource == null && env == null) {
                 throw new BuildException("You must specify file, resource or environment when not using the name attribute",
                                          location);
             }
         }

         if (file == null && resource == null && prefix != null) {
             throw new BuildException("Prefix is only valid when loading from a file or resource", location);
         }

         if ((name != null) && (value != null)) {
             addProperty(name, value);
         }

         if (file != null) {
           loadFile(file);
         }

         if (resource != null) {
           loadResource(resource);
         }

         if (env != null) {
           loadEnvironment(env);
         }

         if ((name != null) && (ref != null)) {
             Object obj = ref.getReferencedObject(getProject());
             if (obj != null) {
                 addProperty(name, obj.toString());
             }
         }
     }

     protected void loadFile(File file) throws BuildException {
         Properties props = new Properties();
         log("Loading " + file.getAbsolutePath(), Project.MSG_VERBOSE);
         try {
             if (file.exists()) {
                 FileInputStream fis = new FileInputStream(file);
                 try {
                     props.load(fis);
                 } finally {
                     if (fis != null) {
                         fis.close();
                     }
                 }
                 addProperties(props);
             } else {
                 log("Unable to find property file: " + file.getAbsolutePath(),
                     Project.MSG_VERBOSE);
             }
         } catch(IOException ex) {
             throw new BuildException(ex, location);
         }
     }

     protected void loadResource(String name) {
         Properties props = new Properties();
         log("Resource Loading " + name, Project.MSG_VERBOSE);
         try {
             ClassLoader cL = null;
             InputStream is = null;

             if (classpath != null) {
                 cL = new AntClassLoader(project, classpath);
             } else {
                 cL = this.getClass().getClassLoader();
             }

             if (cL == null) {
                 is = ClassLoader.getSystemResourceAsStream(name);
             } else {
                 is = cL.getResourceAsStream(name);
             }

             if (is != null) {
                 props.load(is);
                 addProperties(props);
             } else {
                 log("Unable to find resource " + name, Project.MSG_WARN);
             }
         } catch (IOException ex) {
             throw new BuildException(ex, location);
         }
     }

     protected void loadEnvironment( String prefix ) {
         Properties props = new Properties();
         if (!prefix.endsWith(".")) {
           prefix += ".";
         }
         log("Loading Environment " + prefix, Project.MSG_VERBOSE);
         Vector osEnv = Execute.getProcEnvironment();
         for (Enumeration e = osEnv.elements(); e.hasMoreElements(); ) {
             String entry = (String)e.nextElement();
             int pos = entry.indexOf('=');
             if (pos == -1) {
                 log("Ignoring: " + entry, Project.MSG_WARN);
             } else {
                 props.put(prefix + entry.substring(0, pos),
                 entry.substring(pos + 1));
             }
         }
         addProperties(props);
     }

     protected void addProperties(Properties props) {
         resolveAllProperties(props);
         Enumeration e = props.keys();
         while (e.hasMoreElements()) {
             String name = (String) e.nextElement();
             String value = props.getProperty(name);

             String v = project.replaceProperties(value);

             if (prefix != null) {
                 name = prefix + name;
             }

             addProperty(name, v);
         }
     }

     protected void addProperty(String n, String v) {
         if( userProperty ) {
             if (project.getUserProperty(n) == null) {
                 project.setUserProperty(n, v);
             } else {
                 log("Override ignored for " + n, Project.MSG_VERBOSE);
             }
         } else {
             project.setNewProperty(n, v);
         }
     }

     private void resolveAllProperties(Properties props) throws BuildException {
         for (Enumeration e = props.keys(); e.hasMoreElements();) {
             String name = (String)e.nextElement();
             String value = props.getProperty(name);

             boolean resolved = false;
             while (!resolved) {
                 Vector fragments = new Vector();
                 Vector propertyRefs = new Vector();
                 ProjectHelper.parsePropertyString(value, fragments, propertyRefs);

                 resolved = true;
                 if (propertyRefs.size() != 0) {
                     StringBuffer sb = new StringBuffer();
                     Enumeration i = fragments.elements();
                     Enumeration j = propertyRefs.elements();
                     while (i.hasMoreElements()) {
                         String fragment = (String)i.nextElement();
                         if (fragment == null) {
                             String propertyName = (String)j.nextElement();
                             if (propertyName.equals(name)) {
                                 throw new BuildException("Property " + name + " was circularly defined.");
                             }
                             fragment = getProject().getProperty(propertyName);
                             if (fragment == null) {
                                 if (props.containsKey(propertyName)) {
                                     fragment = props.getProperty(propertyName);
                                     resolved = false;
                                 }
                                 else {
                                     fragment = "${" + propertyName + "}";
                                 }
                             }
                         }
                         sb.append(fragment);
                     }
                     value = sb.toString();
                     props.put(name, value);
                 }
             }
         }
     }
 }
	/*
	* 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.taskdefs;

	import org.apache.tools.ant.Task;
	import org.apache.tools.ant.BuildException;
	import org.apache.tools.ant.Project;
	import org.apache.tools.ant.AntClassLoader;
	import org.apache.tools.ant.ProjectHelper;
	import org.apache.tools.ant.types.Path;
	import org.apache.tools.ant.types.Reference;
	import java.io.File;
	import java.io.FileInputStream;
	import java.io.IOException;
	import java.io.InputStream;
	import java.util.Properties;
	import java.util.Vector;
	import java.util.Enumeration;

	/**
	* Will set a Project property. Used to be a hack in ProjectHelper
	* Will not override values set by the command line or parent projects.
	*
	* @author costin@dnt.ro
	* @author <a href="mailto:rubys@us.ibm.com">Sam Ruby</a>
	* @author <a href="mailto:glennm@ca.ibm.com">Glenn McAllister</a>
	*/
	public class Property extends Task {

	protected String name;
	protected String value;
	protected File file;
	protected String resource;
	protected Path classpath;
	protected String env;
	protected Reference ref;
	protected String prefix;

	protected boolean userProperty; // set read-only properties

	public Property() {
	super();
	}

	protected Property(boolean userProperty) {
	this.userProperty = userProperty;
	}

	public void setName(String name) {
	this.name = name;
	}

	public String getName() {
	return name;
	}

	public void setLocation(File location) {
	setValue(location.getAbsolutePath());
	}

	public void setValue(String value) {
	this.value = value;
	}

	public String getValue() {
	return value;
	}

	public void setFile(File file) {
	this.file = file;
	}

	public File getFile() {
	return file;
	}

	public void setPrefix(String prefix) {
	this.prefix = prefix;
	if (!prefix.endsWith(".")) {
	this.prefix += ".";
	}
	}

	public void setRefid(Reference ref) {
	this.ref = ref;
	}

	public Reference getRefid() {
	return ref;
	}

	public void setResource(String resource) {
	this.resource = resource;
	}

	public String getResource() {
	return resource;
	}

	public void setEnvironment(String env) {
	this.env = env;
	}

	public String getEnvironment() {
	return env;
	}

	public void setClasspath(Path classpath) {
	if (this.classpath == null) {
	this.classpath = classpath;
	} else {
	this.classpath.append(classpath);
	}
	}

	public Path createClasspath() {
	if (this.classpath == null) {
	this.classpath = new Path(project);
	}
	return this.classpath.createPath();
	}

	public void setClasspathRef(Reference r) {
	createClasspath().setRefid(r);
	}

	/**
	* @deprecated This was never a supported feature and has been deprecated without replacement
	*/
	public void setUserProperty(boolean userProperty) {
	log("DEPRECATED: Ignoring request to set user property in Property task.",
	Project.MSG_WARN);
	}

	public String toString() {
	return value == null ? "" : value;
	}

	public void execute() throws BuildException {
	if (name != null) {
	if (value == null && ref == null) {
	throw new BuildException("You must specify value, location or refid with the name attribute",
	location);
	}
	} else {
	if (file == null && resource == null && env == null) {
	throw new BuildException("You must specify file, resource or environment when not using the name attribute",
	location);
	}
	}

	if (file == null && resource == null && prefix != null) {
	throw new BuildException("Prefix is only valid when loading from a file or resource", location);
	}

	if ((name != null) && (value != null)) {
	addProperty(name, value);
	}

	if (file != null) {
	loadFile(file);
	}

	if (resource != null) {
	loadResource(resource);
	}

	if (env != null) {
	loadEnvironment(env);
	}

	if ((name != null) && (ref != null)) {
	Object obj = ref.getReferencedObject(getProject());
	if (obj != null) {
	addProperty(name, obj.toString());
	}
	}
	}

	protected void loadFile(File file) throws BuildException {
	Properties props = new Properties();
	log("Loading " + file.getAbsolutePath(), Project.MSG_VERBOSE);
	try {
	if (file.exists()) {
	FileInputStream fis = new FileInputStream(file);
	try {
	props.load(fis);
	} finally {
	if (fis != null) {
	fis.close();
	}
	}
	addProperties(props);
	} else {
	log("Unable to find property file: " + file.getAbsolutePath(),
	Project.MSG_VERBOSE);
	}
	} catch(IOException ex) {
	throw new BuildException(ex, location);
	}
	}

	protected void loadResource(String name) {
	Properties props = new Properties();
	log("Resource Loading " + name, Project.MSG_VERBOSE);
	try {
	ClassLoader cL = null;
	InputStream is = null;

	if (classpath != null) {
	cL = new AntClassLoader(project, classpath);
	} else {
	cL = this.getClass().getClassLoader();
	}

	if (cL == null) {
	is = ClassLoader.getSystemResourceAsStream(name);
	} else {
	is = cL.getResourceAsStream(name);
	}

	if (is != null) {
	props.load(is);
	addProperties(props);
	} else {
	log("Unable to find resource " + name, Project.MSG_WARN);
	}
	} catch (IOException ex) {
	throw new BuildException(ex, location);
	}
	}

	protected void loadEnvironment( String prefix ) {
	Properties props = new Properties();
	if (!prefix.endsWith(".")) {
	prefix += ".";
	}
	log("Loading Environment " + prefix, Project.MSG_VERBOSE);
	Vector osEnv = Execute.getProcEnvironment();
	for (Enumeration e = osEnv.elements(); e.hasMoreElements(); ) {
	String entry = (String)e.nextElement();
	int pos = entry.indexOf('=');
	if (pos == -1) {
	log("Ignoring: " + entry, Project.MSG_WARN);
	} else {
	props.put(prefix + entry.substring(0, pos),
	entry.substring(pos + 1));
	}
	}
	addProperties(props);
	}

	protected void addProperties(Properties props) {
	resolveAllProperties(props);
	Enumeration e = props.keys();
	while (e.hasMoreElements()) {
	String name = (String) e.nextElement();
	String value = props.getProperty(name);

	String v = project.replaceProperties(value);

	if (prefix != null) {
	name = prefix + name;
	}

	addProperty(name, v);
	}
	}

	protected void addProperty(String n, String v) {
	if( userProperty ) {
	if (project.getUserProperty(n) == null) {
	project.setUserProperty(n, v);
	} else {
	log("Override ignored for " + n, Project.MSG_VERBOSE);
	}
	} else {
	project.setNewProperty(n, v);
	}
	}

	private void resolveAllProperties(Properties props) throws BuildException {
	for (Enumeration e = props.keys(); e.hasMoreElements();) {
	String name = (String)e.nextElement();
	String value = props.getProperty(name);

	boolean resolved = false;
	while (!resolved) {
	Vector fragments = new Vector();
	Vector propertyRefs = new Vector();
	ProjectHelper.parsePropertyString(value, fragments, propertyRefs);

	resolved = true;
	if (propertyRefs.size() != 0) {
	StringBuffer sb = new StringBuffer();
	Enumeration i = fragments.elements();
	Enumeration j = propertyRefs.elements();
	while (i.hasMoreElements()) {
	String fragment = (String)i.nextElement();
	if (fragment == null) {
	String propertyName = (String)j.nextElement();
	if (propertyName.equals(name)) {
	throw new BuildException("Property " + name + " was circularly defined.");
	}
	fragment = getProject().getProperty(propertyName);
	if (fragment == null) {
	if (props.containsKey(propertyName)) {
	fragment = props.getProperty(propertyName);
	resolved = false;
	}
	else {
	fragment = "${" + propertyName + "}";
	}
	}
	}
	sb.append(fragment);
	}
	value = sb.toString();
	props.put(name, value);
	}
	}
	}
	}
	}