package bboss.org.apache.velocity.util.introspection;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.lang.reflect.Array;
import java.lang.reflect.Method;
import java.util.Collection;
import java.util.Enumeration;
import java.util.Iterator;
import java.util.Map;
import bboss.org.apache.velocity.exception.VelocityException;
import bboss.org.apache.velocity.runtime.RuntimeLogger;
import bboss.org.apache.velocity.runtime.log.Log;
import bboss.org.apache.velocity.runtime.log.RuntimeLoggerLog;
import bboss.org.apache.velocity.runtime.parser.node.AbstractExecutor;
import bboss.org.apache.velocity.runtime.parser.node.BooleanPropertyExecutor;
import bboss.org.apache.velocity.runtime.parser.node.GetExecutor;
import bboss.org.apache.velocity.runtime.parser.node.MapGetExecutor;
import bboss.org.apache.velocity.runtime.parser.node.MapSetExecutor;
import bboss.org.apache.velocity.runtime.parser.node.PropertyExecutor;
import bboss.org.apache.velocity.runtime.parser.node.PutExecutor;
import bboss.org.apache.velocity.runtime.parser.node.SetExecutor;
import bboss.org.apache.velocity.runtime.parser.node.SetPropertyExecutor;
import bboss.org.apache.velocity.util.ArrayIterator;
import bboss.org.apache.velocity.util.ArrayListWrapper;
import bboss.org.apache.velocity.util.EnumerationIterator;
/**
* Implementation of Uberspect to provide the default introspective
* functionality of Velocity
*
* @author <a href="mailto:geirm@optonline.net">Geir Magnusson Jr.</a>
* @author <a href="mailto:henning@apache.org">Henning P. Schmiedehausen</a>
* @version $Id: UberspectImpl.java 898032 2010-01-11 19:51:03Z nbubna $
*/
public class UberspectImpl implements Uberspect, UberspectLoggable
{
/**
* Our runtime logger.
*/
protected Log log;
/**
* the default Velocity introspector
*/
protected Introspector introspector;
/**
* init - generates the Introspector. As the setup code
* makes sure that the log gets set before this is called,
* we can initialize the Introspector using the log object.
*/
public void init()
{
introspector = new Introspector(log);
}
/**
* Sets the runtime logger - this must be called before anything
* else.
*
* @param log The logger instance to use.
* @since 1.5
*/
public void setLog(Log log)
{
this.log = log;
}
/**
* @param runtimeLogger
* @deprecated Use setLog(Log log) instead.
*/
public void setRuntimeLogger(RuntimeLogger runtimeLogger)
{
// in the off chance anyone still uses this method
// directly, use this hack to keep it working
setLog(new RuntimeLoggerLog(runtimeLogger));
}
/**
* To support iterative objects used in a <code>#foreach()</code>
* loop.
*
* @param obj The iterative object.
* @param i Info about the object's location.
* @return An {@link Iterator} object.
*/
public Iterator getIterator(Object obj, Info i)
throws Exception
{
if (obj.getClass().isArray())
{
return new ArrayIterator(obj);
}
else if (obj instanceof Collection)
{
return ((Collection) obj).iterator();
}
else if (obj instanceof Map)
{
return ((Map) obj).values().iterator();
}
else if (obj instanceof Iterator)
{
if (log.isDebugEnabled())
{
log.debug("The iterative object in the #foreach() loop at " +
i + " is of type java.util.Iterator. Because " +
"it is not resettable, if used in more than once it " +
"may lead to unexpected results.");
}
return ((Iterator) obj);
}
else if (obj instanceof Enumeration)
{
if (log.isDebugEnabled())
{
log.debug("The iterative object in the #foreach() loop at " +
i + " is of type java.util.Enumeration. Because " +
"it is not resettable, if used in more than once it " +
"may lead to unexpected results.");
}
return new EnumerationIterator((Enumeration) obj);
}
else
{
// look for an iterator() method to support the JDK5 Iterable
// interface or any user tools/DTOs that want to work in
// foreach without implementing the Collection interface
Class type = obj.getClass();
try
{
Method iter = type.getMethod("iterator", null);
Class returns = iter.getReturnType();
if (Iterator.class.isAssignableFrom(returns))
{
try
{
return (Iterator)iter.invoke(obj, null);
}
catch (Exception e)
{
throw new VelocityException("Error invoking the method 'iterator' on class '"
+ obj.getClass().getName() +"'", e);
}
}
else
{
log.debug("iterator() method of reference in #foreach loop at "
+ i + " does not return a true Iterator.");
}
}
catch (NoSuchMethodException nsme)
{
// eat this one, but let all other exceptions thru
}
}
/* we have no clue what this is */
log.debug("Could not determine type of iterator in #foreach loop at " + i);
return null;
}
/**
* Method
* @param obj
* @param methodName
* @param args
* @param i
* @return A Velocity Method.
*/
public VelMethod getMethod(Object obj, String methodName, Object[] args, Info i)
throws Exception
{
if (obj == null)
{
return null;
}
Method m = introspector.getMethod(obj.getClass(), methodName, args);
if (m != null)
{
return new VelMethodImpl(m);
}
Class cls = obj.getClass();
// if it's an array
if (cls.isArray())
{
// check for support via our array->list wrapper
m = introspector.getMethod(ArrayListWrapper.class, methodName, args);
if (m != null)
{
// and create a method that knows to wrap the value
// before invoking the method
return new VelMethodImpl(m, true);
}
}
// watch for classes, to allow calling their static methods (VELOCITY-102)
else if (cls == Class.class)
{
m = introspector.getMethod((Class)obj, methodName, args);
if (m != null)
{
return new VelMethodImpl(m);
}
}
return null;
}
/**
* Property getter
* @param obj
* @param identifier
* @param i
* @return A Velocity Getter Method.
* @throws Exception
*/
public VelPropertyGet getPropertyGet(Object obj, String identifier, Info i)
throws Exception
{
if (obj == null)
{
return null;
}
Class claz = obj.getClass();
/*
* first try for a getFoo() type of property
* (also getfoo() )
*/
AbstractExecutor executor = new PropertyExecutor(log, introspector, claz, identifier);
/*
* Let's see if we are a map...
*/
if (!executor.isAlive())
{
executor = new MapGetExecutor(log, claz, identifier);
}
/*
* if that didn't work, look for get("foo")
*/
if (!executor.isAlive())
{
executor = new GetExecutor(log, introspector, claz, identifier);
}
/*
* finally, look for boolean isFoo()
*/
if (!executor.isAlive())
{
executor = new BooleanPropertyExecutor(log, introspector, claz,
identifier);
}
return (executor.isAlive()) ? new VelGetterImpl(executor) : null;
}
/**
* Property setter
* @param obj
* @param identifier
* @param arg
* @param i
* @return A Velocity Setter method.
* @throws Exception
*/
public VelPropertySet getPropertySet(Object obj, String identifier,
Object arg, Info i) throws Exception
{
if (obj == null)
{
return null;
}
Class claz = obj.getClass();
/*
* first try for a setFoo() type of property
* (also setfoo() )
*/
SetExecutor executor = new SetPropertyExecutor(log, introspector, claz, identifier, arg);
/*
* Let's see if we are a map...
*/
if (!executor.isAlive()) {
executor = new MapSetExecutor(log, claz, identifier);
}
/*
* if that didn't work, look for put("foo", arg)
*/
if (!executor.isAlive())
{
executor = new PutExecutor(log, introspector, claz, arg, identifier);
}
return (executor.isAlive()) ? new VelSetterImpl(executor) : null;
}
/**
* Implementation of VelMethod
*/
public static class VelMethodImpl implements VelMethod
{
final Method method;
Boolean isVarArg;
boolean wrapArray;
/**
* @param m
*/
public VelMethodImpl(Method m)
{
this(m, false);
}
/**
* @since 1.6
*/
public VelMethodImpl(Method method, boolean wrapArray)
{
this.method = method;
this.wrapArray = wrapArray;
}
private VelMethodImpl()
{
method = null;
}
/**
* @see VelMethod#invoke(java.lang.Object, java.lang.Object[])
*/
public Object invoke(Object o, Object[] actual)
throws Exception
{
// if we're pretending an array is a list...
if (wrapArray)
{
o = new ArrayListWrapper(o);
}
if (isVarArg())
{
Class[] formal = method.getParameterTypes();
int index = formal.length - 1;
if (actual.length >= index)
{
Class type = formal[index].getComponentType();
actual = handleVarArg(type, index, actual);
}
}
// call extension point invocation
return doInvoke(o, actual);
}
/**
* Offers an extension point for subclasses (in alternate Uberspects)
* to alter the invocation after any array wrapping or varargs handling
* has already been completed.
* @since 1.6
*/
protected Object doInvoke(Object o, Object[] actual) throws Exception
{
return method.invoke(o, actual);
}
/**
* @return true if this method can accept a variable number of arguments
* @since 1.6
*/
public boolean isVarArg()
{
if (isVarArg == null)
{
Class[] formal = method.getParameterTypes();
if (formal == null || formal.length == 0)
{
this.isVarArg = Boolean.FALSE;
}
else
{
Class last = formal[formal.length - 1];
// if the last arg is an array, then
// we consider this a varargs method
this.isVarArg = Boolean.valueOf(last.isArray());
}
}
return isVarArg.booleanValue();
}
/**
* @param type The vararg class type (aka component type
* of the expected array arg)
* @param index The index of the vararg in the method declaration
* (This will always be one less than the number of
* expected arguments.)
* @param actual The actual parameters being passed to this method
* @returns The actual parameters adjusted for the varargs in order
* to fit the method declaration.
*/
private Object[] handleVarArg(final Class type,
final int index,
Object[] actual)
{
// if no values are being passed into the vararg
if (actual.length == index)
{
// copy existing args to new array
Object[] newActual = new Object[actual.length + 1];
System.arraycopy(actual, 0, newActual, 0, actual.length);
// create an empty array of the expected type
newActual[index] = Array.newInstance(type, 0);
actual = newActual;
}
// if one value is being passed into the vararg
else if (actual.length == index + 1 && actual[index] != null)
{
// make sure the last arg is an array of the expected type
Class argClass = actual[index].getClass();
if (!argClass.isArray() &&
IntrospectionUtils.isMethodInvocationConvertible(type,
argClass,
false))
{
// create a 1-length array to hold and replace the last param
Object lastActual = Array.newInstance(type, 1);
Array.set(lastActual, 0, actual[index]);
actual[index] = lastActual;
}
}
// if multiple values are being passed into the vararg
else if (actual.length > index + 1)
{
// put the last and extra actual in an array of the expected type
int size = actual.length - index;
Object lastActual = Array.newInstance(type, size);
for (int i = 0; i < size; i++)
{
Array.set(lastActual, i, actual[index + i]);
}
// put all into a new actual array of the appropriate size
Object[] newActual = new Object[index + 1];
for (int i = 0; i < index; i++)
{
newActual[i] = actual[i];
}
newActual[index] = lastActual;
// replace the old actual array
actual = newActual;
}
return actual;
}
/**
* @see bboss.org.apache.velocity.util.introspection.VelMethod#isCacheable()
*/
public boolean isCacheable()
{
return true;
}
/**
* @see bboss.org.apache.velocity.util.introspection.VelMethod#getMethodName()
*/
public String getMethodName()
{
return method.getName();
}
/**
* @see bboss.org.apache.velocity.util.introspection.VelMethod#getReturnType()
*/
public Class getReturnType()
{
return method.getReturnType();
}
}
/**
*
*
*/
public static class VelGetterImpl implements VelPropertyGet
{
final AbstractExecutor getExecutor;
/**
* @param exec
*/
public VelGetterImpl(AbstractExecutor exec)
{
getExecutor = exec;
}
private VelGetterImpl()
{
getExecutor = null;
}
/**
* @see bboss.org.apache.velocity.util.introspection.VelPropertyGet#invoke(java.lang.Object)
*/
public Object invoke(Object o)
throws Exception
{
return getExecutor.execute(o);
}
/**
* @see bboss.org.apache.velocity.util.introspection.VelPropertyGet#isCacheable()
*/
public boolean isCacheable()
{
return true;
}
/**
* @see bboss.org.apache.velocity.util.introspection.VelPropertyGet#getMethodName()
*/
public String getMethodName()
{
return getExecutor.isAlive() ? getExecutor.getMethod().getName() : null;
}
}
/**
*
*/
public static class VelSetterImpl implements VelPropertySet
{
private final SetExecutor setExecutor;
/**
* @param setExecutor
*/
public VelSetterImpl(final SetExecutor setExecutor)
{
this.setExecutor = setExecutor;
}
private VelSetterImpl()
{
setExecutor = null;
}
/**
* Invoke the found Set Executor.
*
* @param o is the Object to invoke it on.
* @param value in the Value to set.
* @return The resulting Object.
* @throws Exception
*/
public Object invoke(final Object o, final Object value)
throws Exception
{
return setExecutor.execute(o, value);
}
/**
* @see bboss.org.apache.velocity.util.introspection.VelPropertySet#isCacheable()
*/
public boolean isCacheable()
{
return true;
}
/**
* @see bboss.org.apache.velocity.util.introspection.VelPropertySet#getMethodName()
*/
public String getMethodName()
{
return setExecutor.isAlive() ? setExecutor.getMethod().getName() : null;
}
}
}