freemarker.ext.beans.BeansWrapper Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of cookcc Show documentation
Show all versions of cookcc Show documentation
CookCC - a Lexer / Parser (LALR(1)) Project
/*
* Copyright (c) 2003 The Visigoth Software Society. 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 acknowledgement:
* "This product includes software developed by the
* Visigoth Software Society (http://www.visigoths.org/)."
* Alternately, this acknowledgement may appear in the software itself,
* if and wherever such third-party acknowledgements normally appear.
*
* 4. Neither the name "FreeMarker", "Visigoth", nor any of the names of the
* project contributors may 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 "FreeMarker" or "Visigoth"
* nor may "FreeMarker" or "Visigoth" appear in their names
* without prior written permission of the Visigoth Software Society.
*
* 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 VISIGOTH SOFTWARE SOCIETY 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 Visigoth Software Society. For more
* information on the Visigoth Software Society, please see
* http://www.visigoths.org/
*/
package freemarker.ext.beans;
import java.beans.BeanInfo;
import java.beans.IndexedPropertyDescriptor;
import java.beans.IntrospectionException;
import java.beans.Introspector;
import java.beans.MethodDescriptor;
import java.beans.PropertyDescriptor;
import java.io.InputStream;
import java.lang.reflect.AccessibleObject;
import java.lang.reflect.Array;
import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Date;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.ResourceBundle;
import java.util.Set;
import java.util.StringTokenizer;
import freemarker.ext.util.IdentityHashMap;
import freemarker.ext.util.ModelCache;
import freemarker.ext.util.ModelFactory;
import freemarker.ext.util.WrapperTemplateModel;
import freemarker.log.Logger;
import freemarker.template.AdapterTemplateModel;
import freemarker.template.ObjectWrapper;
import freemarker.template.TemplateBooleanModel;
import freemarker.template.TemplateCollectionModel;
import freemarker.template.TemplateDateModel;
import freemarker.template.TemplateHashModel;
import freemarker.template.TemplateModel;
import freemarker.template.TemplateModelException;
import freemarker.template.TemplateNumberModel;
import freemarker.template.TemplateScalarModel;
import freemarker.template.TemplateSequenceModel;
import freemarker.template.utility.ClassUtil;
import freemarker.template.utility.Collections12;
import freemarker.template.utility.SecurityUtilities;
import freemarker.template.utility.UndeclaredThrowableException;
/**
* Utility class that provides generic services to reflection classes.
* It handles all polymorphism issues in the {@link #wrap(Object)} and {@link #unwrap(TemplateModel)} methods.
* @author Attila Szegedi
* @version $Id: BeansWrapper.java,v 1.91.2.13 2007/04/02 13:08:59 szegedia Exp $
*/
public class BeansWrapper implements ObjectWrapper
{
public static final Object CAN_NOT_UNWRAP = new Object();
private static final Class BIGINTEGER_CLASS = java.math.BigInteger.class;
private static final Class BOOLEAN_CLASS = Boolean.class;
private static final Class CHARACTER_CLASS = Character.class;
private static final Class COLLECTION_CLASS = Collection.class;
private static final Class DATE_CLASS = Date.class;
private static final Class HASHADAPTER_CLASS = HashAdapter.class;
private static final Class ITERABLE_CLASS;
private static final Class LIST_CLASS = List.class;
private static final Class MAP_CLASS = Map.class;
private static final Class NUMBER_CLASS = Number.class;
private static final Class OBJECT_CLASS = Object.class;
private static final Class SEQUENCEADAPTER_CLASS = SequenceAdapter.class;
private static final Class SET_CLASS = Set.class;
private static final Class SETADAPTER_CLASS = SetAdapter.class;
private static final Class STRING_CLASS = String.class;
static {
Class iterable;
try {
iterable = Class.forName("java.lang.Iterable");
}
catch(ClassNotFoundException e) {
// We're running on a pre-1.5 JRE
iterable = null;
}
ITERABLE_CLASS = iterable;
}
// When this property is true, some things are stricter. This is mostly to
// catch anomalous things in development that can otherwise be valid situations
// for our users.
private static final boolean DEVELOPMENT = "true".equals(SecurityUtilities.getSystemProperty("freemarker.development"));
private static final Constructor ENUMS_MODEL_CTOR = enumsModelCtor();
private static final Logger logger = Logger.getLogger("freemarker.beans");
private static final Set UNSAFE_METHODS = createUnsafeMethodsSet();
static final Object GENERIC_GET_KEY = new Object();
private static final Object CONSTRUCTORS = new Object();
private static final Object ARGTYPES = new Object();
private static final boolean javaRebelAvailable = isJavaRebelAvailable();
/**
* The default instance of BeansWrapper
*/
private static final BeansWrapper INSTANCE = new BeansWrapper();
// Cache of hash maps that contain already discovered properties and methods
// for a specified class. Each key is a Class, each value is a hash map. In
// that hash map, each key is a property/method name, each value is a
// MethodDescriptor or a PropertyDescriptor assigned to that property/method.
private final Map classCache = new HashMap();
private Set cachedClassNames = new HashSet();
private final StaticModels staticModels = new StaticModels(this);
private final ClassBasedModelFactory enumModels = createEnumModels(this);
private final ModelCache modelCache = new BeansModelCache(this);
private final BooleanModel FALSE = new BooleanModel(Boolean.FALSE, this);
private final BooleanModel TRUE = new BooleanModel(Boolean.TRUE, this);
/**
* At this level of exposure, all methods and properties of the
* wrapped objects are exposed to the template.
*/
public static final int EXPOSE_ALL = 0;
/**
* At this level of exposure, all methods and properties of the wrapped
* objects are exposed to the template except methods that are deemed
* not safe. The not safe methods are java.lang.Object methods wait() and
* notify(), java.lang.Class methods getClassLoader() and newInstance(),
* java.lang.reflect.Method and java.lang.reflect.Constructor invoke() and
* newInstance() methods, all java.lang.reflect.Field set methods, all
* java.lang.Thread and java.lang.ThreadGroup methods that can change its
* state, as well as the usual suspects in java.lang.System and
* java.lang.Runtime.
*/
public static final int EXPOSE_SAFE = 1;
/**
* At this level of exposure, only property getters are exposed.
* Additionally, property getters that map to unsafe methods are not
* exposed (i.e. Class.classLoader and Thread.contextClassLoader).
*/
public static final int EXPOSE_PROPERTIES_ONLY = 2;
/**
* At this level of exposure, no bean properties and methods are exposed.
* Only map items, resource bundle items, and objects retrieved through
* the generic get method (on objects of classes that have a generic get
* method) can be retrieved through the hash interface. You might want to
* call {@link #setMethodsShadowItems(boolean)} with false value to
* speed up map item retrieval.
*/
public static final int EXPOSE_NOTHING = 3;
private int exposureLevel = EXPOSE_SAFE;
private TemplateModel nullModel = null;
private boolean methodsShadowItems = true;
private boolean exposeFields = false;
private int defaultDateType = TemplateDateModel.UNKNOWN;
private ObjectWrapper outerIdentity = this;
private boolean simpleMapWrapper;
private boolean strict = false;
/**
* Creates a new instance of BeansWrapper. The newly created instance
* will use the null reference as its null object, it will use
* {@link #EXPOSE_SAFE} method exposure level, and will not cache
* model instances.
*/
public BeansWrapper() {
if(javaRebelAvailable) {
JavaRebelIntegration.registerWrapper(this);
}
}
/**
* @see #setStrict(boolean)
*/
public boolean isStrict() {
return strict;
}
/**
* Specifies if an attempt to read a bean property that doesn't exist in the
* wrapped object should throw an {@link InvalidPropertyException}.
*
* If this property is false (the default) then an attempt to read
* a missing bean property is the same as reading an existing bean property whose
* value is null. The template can't tell the difference, and thus always
* can use ?default('something') and ?exists and similar built-ins
* to handle the situation.
*
*
If this property is true then an attempt to read a bean propertly in
* the template (like myBean.aProperty) that doesn't exist in the bean
* object (as opposed to just holding null value) will cause
* {@link InvalidPropertyException}, which can't be suppressed in the template
* (not even with myBean.noSuchProperty?default('something')). This way
* ?default('something') and ?exists and similar built-ins can be used to
* handle existing properties whose value is null, without the risk of
* hiding typos in the property names. Typos will always cause error. But mind you, it
* goes against the basic approach of FreeMarker, so use this feature only if you really
* know what are you doing.
*/
public void setStrict(boolean strict) {
this.strict = strict;
}
/**
* When wrapping an object, the BeansWrapper commonly needs to wrap
* "sub-objects", for example each element in a wrapped collection.
* Normally it wraps these objects using itself. However, this makes
* it difficult to delegate to a BeansWrapper as part of a custom
* aggregate ObjectWrapper. This method lets you set the ObjectWrapper
* which will be used to wrap the sub-objects.
* @param outerIdentity the aggregate ObjectWrapper
*/
public void setOuterIdentity(ObjectWrapper outerIdentity)
{
this.outerIdentity = outerIdentity;
}
/**
* By default returns this.
* @see #setOuterIdentity(ObjectWrapper)
*/
public ObjectWrapper getOuterIdentity()
{
return outerIdentity;
}
/**
* By default the BeansWrapper wraps classes implementing
* java.util.Map using {@link MapModel}. Setting this flag will
* cause it to use a {@link SimpleMapModel} instead. The biggest
* difference is that when using a {@link SimpleMapModel}, the
* map will be visible as TemplateHashModelEx,
* and the subvariables will be the content of the map,
* without the other methods and properties of the map object.
* @param simpleMapWrapper enable simple map wrapping
*/
public void setSimpleMapWrapper(boolean simpleMapWrapper)
{
this.simpleMapWrapper = simpleMapWrapper;
}
/**
* Tells whether Maps are exposed as simple maps, without access to their
* method. See {@link #setSimpleMapWrapper(boolean)} for details.
* @return true if Maps are exposed as simple hashes, false if they're
* exposed as full JavaBeans.
*/
public boolean isSimpleMapWrapper()
{
return simpleMapWrapper;
}
/**
* Sets the method exposure level. By default, set to EXPOSE_SAFE.
* @param exposureLevel can be any of the EXPOSE_xxx
* constants.
*/
public void setExposureLevel(int exposureLevel)
{
if(exposureLevel < EXPOSE_ALL || exposureLevel > EXPOSE_NOTHING)
{
throw new IllegalArgumentException("Illegal exposure level " + exposureLevel);
}
this.exposureLevel = exposureLevel;
}
int getExposureLevel()
{
return exposureLevel;
}
/**
* Controls whether public instance fields of classes are exposed to
* templates.
* @param exposeFields if set to true, public instance fields of classes
* that do not have a property getter defined can be accessed directly by
* their name. If there is a property getter for a property of the same
* name as the field (i.e. getter "getFoo()" and field "foo"), then
* referring to "foo" in template invokes the getter. If set to false, no
* access to public instance fields of classes is given. Default is false.
*/
public void setExposeFields(boolean exposeFields)
{
this.exposeFields = exposeFields;
}
/**
* Returns whether exposure of public instance fields of classes is
* enabled. See {@link #setExposeFields(boolean)} for details.
* @return true if public instance fields are exposed, false otherwise.
*/
public boolean isExposeFields()
{
return exposeFields;
}
/**
* Sets whether methods shadow items in beans. When true (this is the
* default value), ${object.name} will first try to locate
* a bean method or property with the specified name on the object, and
* only if it doesn't find it will it try to call
* object.get(name), the so-called "generic get method" that
* is usually used to access items of a container (i.e. elements of a map).
* When set to false, the lookup order is reversed and generic get method
* is called first, and only if it returns null is method lookup attempted.
*/
public synchronized void setMethodsShadowItems(boolean methodsShadowItems)
{
this.methodsShadowItems = methodsShadowItems;
}
boolean isMethodsShadowItems()
{
return methodsShadowItems;
}
/**
* Sets the default date type to use for date models that result from
* a plain java.util.Date instead of java.sql.Date or
* java.sql.Time or java.sql.Timestamp. Default value is
* {@link TemplateDateModel#UNKNOWN}.
* @param defaultDateType the new default date type.
*/
public synchronized void setDefaultDateType(int defaultDateType) {
this.defaultDateType = defaultDateType;
}
/**
* Returns the default date type. See {@link #setDefaultDateType(int)} for
* details.
* @return the default date type
*/
protected int getDefaultDateType() {
return defaultDateType;
}
/**
* Sets whether this wrapper caches model instances. Default is false.
* When set to true, calling {@link #wrap(Object)} multiple times for
* the same object will likely return the same model (although there is
* no guarantee as the cache items can be cleared anytime).
*/
public void setUseCache(boolean useCache)
{
modelCache.setUseCache(useCache);
}
/**
* Sets the null model. This model is returned from the
* {@link #wrap(Object)} method whenever the underlying object
* reference is null. It defaults to null reference, which is dealt
* with quite strictly on engine level, however you can substitute an
* arbitrary (perhaps more lenient) model, such as
* {@link freemarker.template.TemplateScalarModel#EMPTY_STRING}.
*/
public void setNullModel(TemplateModel nullModel)
{
this.nullModel = nullModel;
}
/**
* Returns the default instance of the wrapper. This instance is used
* when you construct various bean models without explicitly specifying
* a wrapper. It is also returned by
* {@link freemarker.template.ObjectWrapper#BEANS_WRAPPER}
* and this is the sole instance that is used by the JSP adapter.
* You can modify the properties of the default instance (caching,
* exposure level, null model) to affect its operation. By default, the
* default instance is not caching, uses the EXPOSE_SAFE
* exposure level, and uses null reference as the null model.
*/
public static final BeansWrapper getDefaultInstance()
{
return INSTANCE;
}
/**
* Wraps the object with a template model that is most specific for the object's
* class. Specifically:
*
* - if the object is null, returns the {@link #setNullModel(TemplateModel) null model},
* - if the object is a Number returns a {@link NumberModel} for it,
* - if the object is a Date returns a {@link DateModel} for it,
* - if the object is a Boolean returns
* {@link freemarker.template.TemplateBooleanModel#TRUE} or
* {@link freemarker.template.TemplateBooleanModel#FALSE}
* - if the object is already a TemplateModel, returns it unchanged,
* - if the object is an array, returns a {@link ArrayModel} for it
*
- if the object is a Map, returns a {@link MapModel} for it
*
- if the object is a Collection, returns a {@link CollectionModel} for it
*
- if the object is an Iterator, returns a {@link IteratorModel} for it
*
- if the object is an Enumeration, returns a {@link EnumerationModel} for it
*
- if the object is a String, returns a {@link StringModel} for it
*
- otherwise, returns a generic {@link BeanModel} for it.
*
*/
public TemplateModel wrap(Object object) throws TemplateModelException
{
if(object == null)
return nullModel;
return modelCache.getInstance(object);
}
/**
* @deprecated override {@link #getModelFactory(Class)} instead. Using this
* method will now bypass wrapper caching (if it is enabled) and always
* result in creation of a new wrapper. This method will be removed in 2.4
* @param object
* @param factory
*/
protected TemplateModel getInstance(Object object, ModelFactory factory)
{
return factory.create(object, this);
}
private final ModelFactory BOOLEAN_FACTORY = new ModelFactory() {
public TemplateModel create(Object object, ObjectWrapper wrapper) {
return ((Boolean)object).booleanValue() ? TRUE : FALSE;
}
};
private static final ModelFactory ITERATOR_FACTORY = new ModelFactory() {
public TemplateModel create(Object object, ObjectWrapper wrapper) {
return new IteratorModel((Iterator)object, (BeansWrapper)wrapper);
}
};
private static final ModelFactory ENUMERATION_FACTORY = new ModelFactory() {
public TemplateModel create(Object object, ObjectWrapper wrapper) {
return new EnumerationModel((Enumeration)object, (BeansWrapper)wrapper);
}
};
protected ModelFactory getModelFactory(Class clazz) {
if(Map.class.isAssignableFrom(clazz)) {
return simpleMapWrapper ? SimpleMapModel.FACTORY : MapModel.FACTORY;
}
if(Collection.class.isAssignableFrom(clazz)) {
return CollectionModel.FACTORY;
}
if(Number.class.isAssignableFrom(clazz)) {
return NumberModel.FACTORY;
}
if(Date.class.isAssignableFrom(clazz)) {
return DateModel.FACTORY;
}
if(Boolean.class == clazz) { // Boolean is final
return BOOLEAN_FACTORY;
}
if(ResourceBundle.class.isAssignableFrom(clazz)) {
return ResourceBundleModel.FACTORY;
}
if(Iterator.class.isAssignableFrom(clazz)) {
return ITERATOR_FACTORY;
}
if(Enumeration.class.isAssignableFrom(clazz)) {
return ENUMERATION_FACTORY;
}
if(clazz.isArray()) {
return ArrayModel.FACTORY;
}
return StringModel.FACTORY;
}
/**
* Attempts to unwrap a model into underlying object. Generally, this
* method is the inverse of the {@link #wrap(Object)} method. In addition
* it will unwrap arbitrary {@link TemplateNumberModel} instances into
* a number, arbitrary {@link TemplateDateModel} instances into a date,
* {@link TemplateScalarModel} instances into a String, and
* {@link TemplateBooleanModel} instances into a Boolean.
* All other objects are returned unchanged.
*/
public Object unwrap(TemplateModel model) throws TemplateModelException
{
return unwrap(model, OBJECT_CLASS);
}
public Object unwrap(TemplateModel model, Class hint)
throws TemplateModelException
{
return unwrap(model, hint, null);
}
private Object unwrap(TemplateModel model, Class hint, Map recursionStops)
throws TemplateModelException
{
if(model == nullModel) {
return null;
}
boolean isBoolean = Boolean.TYPE == hint;
boolean isChar = Character.TYPE == hint;
// This is for transparent interop with other wrappers (and ourselves)
// Passing the hint allows i.e. a Jython-aware method that declares a
// PyObject as its argument to receive a PyObject from a JythonModel
// passed as an argument to TemplateMethodModelEx etc.
if(model instanceof AdapterTemplateModel) {
Object adapted = ((AdapterTemplateModel)model).getAdaptedObject(
hint);
if(hint.isInstance(adapted)) {
return adapted;
}
// Attempt numeric conversion
if(adapted instanceof Number && ((hint.isPrimitive() && !isChar &&
!isBoolean) || NUMBER_CLASS.isAssignableFrom(hint))) {
Number number = convertUnwrappedNumber(hint,
(Number)adapted);
if(number != null) {
return number;
}
}
}
if(model instanceof WrapperTemplateModel) {
Object wrapped = ((WrapperTemplateModel)model).getWrappedObject();
if(hint.isInstance(wrapped)) {
return wrapped;
}
// Attempt numeric conversion
if(wrapped instanceof Number && ((hint.isPrimitive() && !isChar &&
!isBoolean) || NUMBER_CLASS.isAssignableFrom(hint))) {
Number number = convertUnwrappedNumber(hint,
(Number)wrapped);
if(number != null) {
return number;
}
}
}
// Translation of generic template models to POJOs. First give priority
// to various model interfaces based on the hint class. This helps us
// select the appropriate interface in multi-interface models when we
// know what is expected as the return type.
if(STRING_CLASS == hint) {
if(model instanceof TemplateScalarModel) {
return ((TemplateScalarModel)model).getAsString();
}
// String is final, so no other conversion will work
return CAN_NOT_UNWRAP;
}
// Primitive numeric types & Number.class and its subclasses
if((hint.isPrimitive() && !isChar && !isBoolean)
|| NUMBER_CLASS.isAssignableFrom(hint)) {
if(model instanceof TemplateNumberModel) {
Number number = convertUnwrappedNumber(hint,
((TemplateNumberModel)model).getAsNumber());
if(number != null) {
return number;
}
}
}
if(isBoolean || BOOLEAN_CLASS == hint) {
if(model instanceof TemplateBooleanModel) {
return ((TemplateBooleanModel)model).getAsBoolean()
? Boolean.TRUE : Boolean.FALSE;
}
// Boolean is final, no other conversion will work
return CAN_NOT_UNWRAP;
}
if(MAP_CLASS == hint) {
if(model instanceof TemplateHashModel) {
return new HashAdapter((TemplateHashModel)model, this);
}
}
if(LIST_CLASS == hint) {
if(model instanceof TemplateSequenceModel) {
return new SequenceAdapter((TemplateSequenceModel)model, this);
}
}
if(SET_CLASS == hint) {
if(model instanceof TemplateCollectionModel) {
return new SetAdapter((TemplateCollectionModel)model, this);
}
}
if(COLLECTION_CLASS == hint
|| ITERABLE_CLASS == hint) {
if(model instanceof TemplateCollectionModel) {
return new CollectionAdapter((TemplateCollectionModel)model,
this);
}
if(model instanceof TemplateSequenceModel) {
return new SequenceAdapter((TemplateSequenceModel)model, this);
}
}
// TemplateSequenceModels can be converted to arrays
if(hint.isArray()) {
if(model instanceof TemplateSequenceModel) {
if(recursionStops != null) {
Object retval = recursionStops.get(model);
if(retval != null) {
return retval;
}
} else {
recursionStops =
new IdentityHashMap();
}
TemplateSequenceModel seq = (TemplateSequenceModel)model;
Class componentType = hint.getComponentType();
Object array = Array.newInstance(componentType, seq.size());
recursionStops.put(model, array);
try {
int size = seq.size();
for (int i = 0; i < size; i++) {
Object val = unwrap(model, componentType,
recursionStops);
if(val == CAN_NOT_UNWRAP) {
return CAN_NOT_UNWRAP;
}
Array.set(array, i, val);
}
} finally {
recursionStops.remove(model);
}
return array;
}
// array classes are final, no other conversion will work
return CAN_NOT_UNWRAP;
}
// Allow one-char strings to be coerced to characters
if(isChar || hint == CHARACTER_CLASS) {
if(model instanceof TemplateScalarModel) {
String s = ((TemplateScalarModel)model).getAsString();
if(s.length() == 1) {
return new Character(s.charAt(0));
}
}
// Character is final, no other conversion will work
return CAN_NOT_UNWRAP;
}
if(DATE_CLASS.isAssignableFrom(hint)) {
if(model instanceof TemplateDateModel) {
Date date = ((TemplateDateModel)model).getAsDate();
if(hint.isInstance(date)) {
return date;
}
}
}
// Translation of generic template models to POJOs. Since hint was of
// no help initially, now use an admittedly arbitrary order of
// interfaces. Note we still test for isInstance and isAssignableFrom
// to guarantee we return a compatible value.
if(model instanceof TemplateNumberModel) {
Number number = ((TemplateNumberModel)model).getAsNumber();
if(hint.isInstance(number)) {
return number;
}
}
if(model instanceof TemplateDateModel) {
Date date = ((TemplateDateModel)model).getAsDate();
if(hint.isInstance(date)) {
return date;
}
}
if(model instanceof TemplateScalarModel &&
hint.isAssignableFrom(STRING_CLASS)) {
return ((TemplateScalarModel)model).getAsString();
}
if(model instanceof TemplateBooleanModel &&
hint.isAssignableFrom(BOOLEAN_CLASS)) {
return ((TemplateBooleanModel)model).getAsBoolean()
? Boolean.TRUE : Boolean.FALSE;
}
if(model instanceof TemplateHashModel && hint.isAssignableFrom(
HASHADAPTER_CLASS)) {
return new HashAdapter((TemplateHashModel)model, this);
}
if(model instanceof TemplateSequenceModel
&& hint.isAssignableFrom(SEQUENCEADAPTER_CLASS)) {
return new SequenceAdapter((TemplateSequenceModel)model, this);
}
if(model instanceof TemplateCollectionModel &&
hint.isAssignableFrom(SETADAPTER_CLASS)) {
return new SetAdapter((TemplateCollectionModel)model, this);
}
// Last ditch effort - is maybe the model itself instance of the
// required type?
if(hint.isInstance(model)) {
return model;
}
return CAN_NOT_UNWRAP;
}
private static Number convertUnwrappedNumber(Class hint, Number number)
{
if(hint == Integer.TYPE || hint == Integer.class) {
return number instanceof Integer ? (Integer)number :
new Integer(number.intValue());
}
if(hint == Long.TYPE || hint == Long.class) {
return number instanceof Long ? (Long)number :
new Long(number.longValue());
}
if(hint == Float.TYPE || hint == Float.class) {
return number instanceof Float ? (Float)number :
new Float(number.longValue());
}
if(hint == Double.TYPE
|| hint == Double.class) {
return number instanceof Double ? (Double)number :
new Double(number.longValue());
}
if(hint == Byte.TYPE || hint == Byte.class) {
return number instanceof Byte ? (Byte)number :
new Byte(number.byteValue());
}
if(hint == Short.TYPE || hint == Short.class) {
return number instanceof Short ? (Short)number :
new Short(number.shortValue());
}
if(hint == BigInteger.class) {
return number instanceof BigInteger ? number :
new BigInteger(number.toString());
}
if(hint == BigDecimal.class) {
if(number instanceof BigDecimal) {
return number;
}
if(number instanceof BigInteger) {
return new BigDecimal((BigInteger)number);
}
if(number instanceof Long) {
// Because we can't represent long accurately as a
// double
return new BigDecimal(number.toString());
}
return new BigDecimal(number.doubleValue());
}
// Handle nonstandard Number subclasses as well as directly
// java.lang.Number too
if(hint.isInstance(number)) {
return number;
}
return null;
}
/**
* Invokes the specified method, wrapping the return value. The specialty
* of this method is that if the return value is null, and the return type
* of the invoked method is void, {@link TemplateModel#NOTHING} is returned.
* @param object the object to invoke the method on
* @param method the method to invoke
* @param args the arguments to the method
* @return the wrapped return value of the method.
* @throws InvocationTargetException if the invoked method threw an exception
* @throws IllegalAccessException if the method can't be invoked due to an
* access restriction.
* @throws TemplateModelException if the return value couldn't be wrapped
* (this can happen if the wrapper has an outer identity or is subclassed,
* and the outer identity or the subclass throws an exception. Plain
* BeansWrapper never throws TemplateModelException).
*/
TemplateModel invokeMethod(Object object, Method method, Object[] args)
throws
InvocationTargetException,
IllegalAccessException,
TemplateModelException
{
Object retval = method.invoke(object, args);
return
method.getReturnType() == Void.TYPE
? TemplateModel.NOTHING
: getOuterIdentity().wrap(retval);
}
/**
* Returns a hash model that represents the so-called class static models.
* Every class static model is itself a hash through which you can call
* static methods on the specified class. To obtain a static model for a
* class, get the element of this hash with the fully qualified class name.
* For example, if you place this hash model inside the root data model
* under name "statics", you can use i.e. statics["java.lang.
* System"]. currentTimeMillis() to call the {@link
* java.lang.System#currentTimeMillis()} method.
* @return a hash model whose keys are fully qualified class names, and
* that returns hash models whose elements are the static models of the
* classes.
*/
public TemplateHashModel getStaticModels()
{
return staticModels;
}
/**
* Returns a hash model that represents the so-called class enum models.
* Every class' enum model is itself a hash through which you can access
* enum value declared by the specified class, assuming that class is an
* enumeration. To obtain an enum model for a class, get the element of this
* hash with the fully qualified class name. For example, if you place this
* hash model inside the root data model under name "enums", you can use
* i.e. statics["java.math.RoundingMode"].UP to access the
* {@link java.math.RoundingMode#UP} value.
* @return a hash model whose keys are fully qualified class names, and
* that returns hash models whose elements are the enum models of the
* classes.
* @throws UnsupportedOperationException if this method is invoked on a
* pre-1.5 JRE, as Java enums aren't supported there.
*/
public TemplateHashModel getEnumModels() {
if(enumModels == null) {
throw new UnsupportedOperationException(
"Enums not supported on pre-1.5 JRE");
}
return enumModels;
}
public Object newInstance(Class clazz, List arguments)
throws
TemplateModelException
{
try
{
introspectClass(clazz);
Map classInfo = (Map)classCache.get(clazz);
Object ctors = classInfo.get(CONSTRUCTORS);
if(ctors == null)
{
throw new TemplateModelException("Class " + clazz.getName() +
" has no public constructors.");
}
Constructor ctor = null;
Object[] objargs;
if(ctors instanceof SimpleMemberModel)
{
SimpleMemberModel smm = (SimpleMemberModel)ctors;
ctor = (Constructor)smm.getMember();
objargs = smm.unwrapArguments(arguments, this);
}
else if(ctors instanceof MethodMap)
{
MethodMap methodMap = (MethodMap)ctors;
MemberAndArguments maa =
methodMap.getMemberAndArguments(arguments);
objargs = maa.getArgs();
ctor = (Constructor)maa.getMember();
}
else
{
// Cannot happen
throw new Error();
}
return ctor.newInstance(objargs);
}
catch (TemplateModelException e)
{
throw e;
}
catch (Exception e)
{
throw new TemplateModelException(
"Could not create instance of class " + clazz.getName(), e);
}
}
void introspectClass(Class clazz)
{
synchronized(classCache)
{
if(!classCache.containsKey(clazz))
{
introspectClassInternal(clazz);
}
}
}
void removeIntrospectionInfo(Class clazz) {
synchronized(classCache) {
classCache.remove(clazz);
staticModels.removeIntrospectionInfo(clazz);
if(enumModels != null) {
enumModels.removeIntrospectionInfo(clazz);
}
cachedClassNames.remove(clazz.getName());
synchronized(this) {
modelCache.clearCache();
}
}
}
private void introspectClassInternal(Class clazz)
{
String className = clazz.getName();
if(cachedClassNames.contains(className))
{
if(logger.isInfoEnabled())
{
logger.info("Detected a reloaded class [" + className +
"]. Clearing BeansWrapper caches.");
}
// Class reload detected, throw away caches
classCache.clear();
cachedClassNames = new HashSet();
synchronized(this)
{
modelCache.clearCache();
}
staticModels.clearCache();
if(enumModels != null) {
enumModels.clearCache();
}
}
classCache.put(clazz, populateClassMap(clazz));
cachedClassNames.add(className);
}
Map getClassKeyMap(Class clazz)
{
Map map;
synchronized(classCache)
{
map = (Map)classCache.get(clazz);
if(map == null)
{
introspectClassInternal(clazz);
map = (Map)classCache.get(clazz);
}
}
return map;
}
/**
* Returns the number of introspected methods/properties that should
* be available via the TemplateHashModel interface. Affected by the
* {@link #setMethodsShadowItems(boolean)} and {@link
* #setExposureLevel(int)} settings.
*/
int keyCount(Class clazz)
{
Map map = getClassKeyMap(clazz);
int count = map.size();
if (map.containsKey(CONSTRUCTORS))
count--;
if (map.containsKey(GENERIC_GET_KEY))
count--;
if (map.containsKey(ARGTYPES))
count--;
return count;
}
/**
* Returns the Set of names of introspected methods/properties that
* should be available via the TemplateHashModel interface. Affected
* by the {@link #setMethodsShadowItems(boolean)} and {@link
* #setExposureLevel(int)} settings.
*/
Set keySet(Class clazz)
{
Set set = new HashSet(getClassKeyMap(clazz).keySet());
set.remove(CONSTRUCTORS);
set.remove(GENERIC_GET_KEY);
set.remove(ARGTYPES);
return set;
}
/**
* Populates a map with property and method descriptors for a specified
* class. If any property or method descriptors specifies a read method
* that is not accessible, replaces it with appropriate accessible method
* from a superclass or interface.
*/
private Map populateClassMap(Class clazz)
{
// Populate first from bean info
Map map = populateClassMapWithBeanInfo(clazz);
// Next add constructors
try
{
Constructor[] ctors = clazz.getConstructors();
if(ctors.length == 1)
{
Constructor ctor = ctors[0];
map.put(CONSTRUCTORS, new SimpleMemberModel(ctor, ctor.getParameterTypes()));
}
else if(ctors.length > 1)
{
MethodMap ctorMap = new MethodMap("", this);
for (int i = 0; i < ctors.length; i++)
{
ctorMap.addMember(ctors[i]);
}
map.put(CONSTRUCTORS, ctorMap);
}
}
catch(SecurityException e)
{
logger.warn("Canont discover constructors for class " +
clazz.getName(), e);
}
switch(map.size())
{
case 0:
{
map = Collections12.EMPTY_MAP;
break;
}
case 1:
{
Map.Entry e = (Map.Entry)map.entrySet().iterator().next();
map = Collections12.singletonMap(e.getKey(), e.getValue());
break;
}
}
return map;
}
private Map populateClassMapWithBeanInfo(Class clazz)
{
Map classMap = new HashMap();
if(exposeFields)
{
Field[] fields = clazz.getFields();
for (int i = 0; i < fields.length; i++)
{
Field field = fields[i];
if((field.getModifiers() & Modifier.STATIC) == 0)
{
classMap.put(field.getName(), field);
}
}
}
Map accessibleMethods = discoverAccessibleMethods(clazz);
Method genericGet = getFirstAccessibleMethod(
MethodSignature.GET_STRING_SIGNATURE, accessibleMethods);
if(genericGet == null)
{
genericGet = getFirstAccessibleMethod(
MethodSignature.GET_OBJECT_SIGNATURE, accessibleMethods);
}
if(genericGet != null)
{
classMap.put(GENERIC_GET_KEY, genericGet);
}
if(exposureLevel == EXPOSE_NOTHING)
{
return classMap;
}
try
{
BeanInfo beanInfo = Introspector.getBeanInfo(clazz);
PropertyDescriptor[] pda = beanInfo.getPropertyDescriptors();
MethodDescriptor[] mda = beanInfo.getMethodDescriptors();
for(int i = pda.length - 1; i >= 0; --i) {
PropertyDescriptor pd = pda[i];
if(pd instanceof IndexedPropertyDescriptor) {
IndexedPropertyDescriptor ipd =
(IndexedPropertyDescriptor)pd;
Method readMethod = ipd.getIndexedReadMethod();
Method publicReadMethod = getAccessibleMethod(readMethod,
accessibleMethods);
if(publicReadMethod != null && isSafeMethod(publicReadMethod)) {
try {
if(readMethod != publicReadMethod) {
ipd = new IndexedPropertyDescriptor(
ipd.getName(), ipd.getReadMethod(),
ipd.getWriteMethod(), publicReadMethod,
ipd.getIndexedWriteMethod());
}
classMap.put(ipd.getName(), ipd);
getArgTypes(classMap).put(publicReadMethod,
publicReadMethod.getParameterTypes());
}
catch(IntrospectionException e) {
logger.warn("Couldn't properly perform introspection", e);
}
}
}
else {
Method readMethod = pd.getReadMethod();
Method publicReadMethod = getAccessibleMethod(readMethod, accessibleMethods);
if(publicReadMethod != null && isSafeMethod(publicReadMethod)) {
try {
if(readMethod != publicReadMethod) {
pd = new PropertyDescriptor(pd.getName(),
publicReadMethod, pd.getWriteMethod());
pd.setReadMethod(publicReadMethod);
}
classMap.put(pd.getName(), pd);
}
catch(IntrospectionException e)
{
logger.warn("Couldn't properly perform introspection", e);
}
}
}
}
if(exposureLevel < EXPOSE_PROPERTIES_ONLY)
{
for(int i = mda.length - 1; i >= 0; --i)
{
MethodDescriptor md = mda[i];
Method method = md.getMethod();
Method publicMethod = getAccessibleMethod(method, accessibleMethods);
if(publicMethod != null && isSafeMethod(publicMethod))
{
String name = md.getName();
Object previous = classMap.get(name);
if(previous instanceof Method)
{
// Overloaded method - replace method with a method map
MethodMap methodMap = new MethodMap(name, this);
methodMap.addMember((Method)previous);
methodMap.addMember(publicMethod);
classMap.put(name, methodMap);
// remove parameter type information
getArgTypes(classMap).remove(previous);
}
else if(previous instanceof MethodMap)
{
// Already overloaded method - add new overload
((MethodMap)previous).addMember(publicMethod);
}
else
{
// Simple method (this far)
classMap.put(name, publicMethod);
getArgTypes(classMap).put(publicMethod,
publicMethod.getParameterTypes());
}
}
}
}
return classMap;
}
catch(IntrospectionException e)
{
logger.warn("Couldn't properly perform introspection", e);
return new HashMap();
}
}
private static Map getArgTypes(Map classMap) {
Map argTypes = (Map)classMap.get(ARGTYPES);
if(argTypes == null) {
argTypes = new HashMap();
classMap.put(ARGTYPES, argTypes);
}
return argTypes;
}
static Class[] getArgTypes(Map classMap, AccessibleObject methodOrCtor) {
return (Class[])((Map)classMap.get(ARGTYPES)).get(methodOrCtor);
}
private static Method getFirstAccessibleMethod(MethodSignature sig, Map accessibles)
{
List l = (List)accessibles.get(sig);
if(l == null || l.isEmpty()) {
return null;
}
return (Method)l.iterator().next();
}
private static Method getAccessibleMethod(Method m, Map accessibles)
{
if(m == null) {
return null;
}
MethodSignature sig = new MethodSignature(m);
List l = (List)accessibles.get(sig);
if(l == null) {
return null;
}
for (Iterator iterator = l.iterator(); iterator.hasNext();)
{
Method am = (Method) iterator.next();
if(am.getReturnType() == m.getReturnType()) {
return am;
}
}
return null;
}
boolean isSafeMethod(Method method)
{
return exposureLevel < EXPOSE_SAFE || !UNSAFE_METHODS.contains(method);
}
/**
* Retrieves mapping of methods to accessible methods for a class.
* In case the class is not public, retrieves methods with same
* signature as its public methods from public superclasses and
* interfaces (if they exist). Basically upcasts every method to the
* nearest accessible method.
*/
private static Map discoverAccessibleMethods(Class clazz)
{
Map map = new HashMap();
discoverAccessibleMethods(clazz, map);
return map;
}
private static void discoverAccessibleMethods(Class clazz, Map map)
{
if(Modifier.isPublic(clazz.getModifiers()))
{
try
{
Method[] methods = clazz.getMethods();
for(int i = 0; i < methods.length; i++)
{
Method method = methods[i];
MethodSignature sig = new MethodSignature(method);
// Contrary to intuition, a class can actually have several
// different methods with same signature *but* different
// return types. These can't be constructed using Java the
// language, as this is illegal on source code level, but
// the compiler can emit synthetic methods as part of
// generic type reification that will have same signature
// yet different return type than an existing explicitly
// declared method. Consider:
// public interface I { T m(); }
// public class C implements I { Integer m() { return 42; } }
// C.class will have both "Object m()" and "Integer m()" methods.
List methodList = (List)map.get(sig);
if(methodList == null) {
methodList = new LinkedList();
map.put(sig, methodList);
}
methodList.add(method);
}
return;
}
catch(SecurityException e)
{
logger.warn("Could not discover accessible methods of class " +
clazz.getName() +
", attemping superclasses/interfaces.", e);
// Fall through and attempt to discover superclass/interface
// methods
}
}
Class[] interfaces = clazz.getInterfaces();
for(int i = 0; i < interfaces.length; i++)
{
discoverAccessibleMethods(interfaces[i], map);
}
Class superclass = clazz.getSuperclass();
if(superclass != null)
{
discoverAccessibleMethods(superclass, map);
}
}
private static final class MethodSignature
{
private static final MethodSignature GET_STRING_SIGNATURE =
new MethodSignature("get", new Class[] { STRING_CLASS });
private static final MethodSignature GET_OBJECT_SIGNATURE =
new MethodSignature("get", new Class[] { OBJECT_CLASS });
private final String name;
private final Class[] args;
private MethodSignature(String name, Class[] args)
{
this.name = name;
this.args = args;
}
MethodSignature(Method method)
{
this(method.getName(), method.getParameterTypes());
}
public boolean equals(Object o)
{
if(o instanceof MethodSignature)
{
MethodSignature ms = (MethodSignature)o;
return ms.name.equals(name) && Arrays.equals(args, ms.args);
}
return false;
}
public int hashCode()
{
return name.hashCode() ^ args.length;
}
}
private static final Set createUnsafeMethodsSet()
{
Properties props = new Properties();
InputStream in = BeansWrapper.class.getResourceAsStream("unsafeMethods.txt");
if(in != null)
{
String methodSpec = null;
try
{
try
{
props.load(in);
}
finally
{
in.close();
}
Set set = new HashSet(props.size() * 4/3, .75f);
Map primClasses = createPrimitiveClassesMap();
for (Iterator iterator = props.keySet().iterator(); iterator.hasNext();)
{
methodSpec = (String) iterator.next();
try {
set.add(parseMethodSpec(methodSpec, primClasses));
}
catch(ClassNotFoundException e) {
if(DEVELOPMENT) {
throw e;
}
}
catch(NoSuchMethodException e) {
if(DEVELOPMENT) {
throw e;
}
}
}
return set;
}
catch(Exception e)
{
throw new RuntimeException("Could not load unsafe method " + methodSpec + " " + e.getClass().getName() + " " + e.getMessage());
}
}
return Collections.EMPTY_SET;
}
private static Method parseMethodSpec(String methodSpec, Map primClasses)
throws
ClassNotFoundException,
NoSuchMethodException
{
int brace = methodSpec.indexOf('(');
int dot = methodSpec.lastIndexOf('.', brace);
Class clazz = ClassUtil.forName(methodSpec.substring(0, dot));
String methodName = methodSpec.substring(dot + 1, brace);
String argSpec = methodSpec.substring(brace + 1, methodSpec.length() - 1);
StringTokenizer tok = new StringTokenizer(argSpec, ",");
int argcount = tok.countTokens();
Class[] argTypes = new Class[argcount];
for (int i = 0; i < argcount; i++)
{
String argClassName = tok.nextToken();
argTypes[i] = (Class)primClasses.get(argClassName);
if(argTypes[i] == null)
{
argTypes[i] = ClassUtil.forName(argClassName);
}
}
return clazz.getMethod(methodName, argTypes);
}
private static Map createPrimitiveClassesMap()
{
Map map = new HashMap();
map.put("boolean", Boolean.TYPE);
map.put("byte", Byte.TYPE);
map.put("char", Character.TYPE);
map.put("short", Short.TYPE);
map.put("int", Integer.TYPE);
map.put("long", Long.TYPE);
map.put("float", Float.TYPE);
map.put("double", Double.TYPE);
return map;
}
/**
* Converts any {@link BigDecimal}s in the passed array to the type of
* the corresponding formal argument of the method.
*/
public static void coerceBigDecimals(AccessibleObject callable, Object[] args)
{
Class[] formalTypes = null;
for(int i = 0; i < args.length; ++i) {
Object arg = args[i];
if(arg instanceof BigDecimal) {
if(formalTypes == null) {
if(callable instanceof Method) {
formalTypes = ((Method)callable).getParameterTypes();
}
else if(callable instanceof Constructor) {
formalTypes = ((Constructor)callable).getParameterTypes();
}
else {
throw new IllegalArgumentException("Expected method or "
+ " constructor; callable is " +
callable.getClass().getName());
}
}
args[i] = coerceBigDecimal((BigDecimal)arg, formalTypes[i]);
}
}
}
/**
* Converts any {@link BigDecimal}s in the passed array to the type of
* the corresponding formal argument of the method.
*/
public static void coerceBigDecimals(Class[] formalTypes, Object[] args)
{
int typeLen = formalTypes.length;
int argsLen = args.length;
int min = Math.min(typeLen, argsLen);
for(int i = 0; i < min; ++i) {
Object arg = args[i];
if(arg instanceof BigDecimal) {
args[i] = coerceBigDecimal((BigDecimal)arg, formalTypes[i]);
}
}
if(argsLen > typeLen) {
Class varArgType = formalTypes[typeLen - 1];
for(int i = typeLen; i < argsLen; ++i) {
Object arg = args[i];
if(arg instanceof BigDecimal) {
args[i] = coerceBigDecimal((BigDecimal)arg, varArgType);
}
}
}
}
public static Object coerceBigDecimal(BigDecimal bd, Class formalType) {
// int is expected in most situations, so we check it first
if(formalType == Integer.TYPE || formalType == Integer.class) {
return new Integer(bd.intValue());
}
else if(formalType == Double.TYPE || formalType == Double.class) {
return new Double(bd.doubleValue());
}
else if(formalType == Long.TYPE || formalType == Long.class) {
return new Long(bd.longValue());
}
else if(formalType == Float.TYPE || formalType == Float.class) {
return new Float(bd.floatValue());
}
else if(formalType == Short.TYPE || formalType == Short.class) {
return new Short(bd.shortValue());
}
else if(formalType == Byte.TYPE || formalType == Byte.class) {
return new Byte(bd.byteValue());
}
else if(BIGINTEGER_CLASS.isAssignableFrom(formalType)) {
return bd.toBigInteger();
}
return bd;
}
private static ClassBasedModelFactory createEnumModels(BeansWrapper wrapper) {
if(ENUMS_MODEL_CTOR != null) {
try {
return (ClassBasedModelFactory)ENUMS_MODEL_CTOR.newInstance(
new Object[] { wrapper });
} catch(Exception e) {
throw new UndeclaredThrowableException(e);
}
} else {
return null;
}
}
private static Constructor enumsModelCtor() {
try {
// Check if Enums are available on this platform
Class.forName("java.lang.Enum");
// If they are, return the appropriate constructor for enum models
return Class.forName(
"freemarker.ext.beans.EnumModels").getDeclaredConstructor(
new Class[] { BeansWrapper.class });
}
catch(Exception e) {
// Otherwise, return null
return null;
}
}
private static boolean isJavaRebelAvailable() {
try {
JavaRebelIntegration.testAvailability();
return true;
}
catch(NoClassDefFoundError e) {
return false;
}
}
}