1 /**
2 * This file Copyright (c) 2003-2018 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.freemarker.models;
35
36 import info.magnolia.freemarker.FreemarkerConfig;
37
38 import java.util.ArrayList;
39 import java.util.List;
40
41 import freemarker.ext.util.ModelFactory;
42 import freemarker.template.DefaultObjectWrapper;
43 import freemarker.template.TemplateModel;
44 import freemarker.template.TemplateModelException;
45
46 /**
47 * A FreeMarker ObjectWrapper that knows about Magnolia specific objects.
48 */
49 public class MagnoliaObjectWrapper extends DefaultObjectWrapper {
50 private final static org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(MagnoliaObjectWrapper.class);
51
52 private final static List<MagnoliaModelFactory> DEFAULT_MODEL_FACTORIES = new ArrayList<MagnoliaModelFactory>() {{
53 add(NodeDataModelFactory.INSTANCE);
54 add(ContentModel.FACTORY);
55 add(ContentMapModel.FACTORY);
56 add(CalendarModel.FACTORY);
57 add(UserModel.FACTORY);
58 add(ContextModelFactory.INSTANCE);
59 }};
60
61 private final FreemarkerConfig freemarkerConfig;
62
63 public MagnoliaObjectWrapper(FreemarkerConfig freemarkerConfig) {
64 super();
65 this.freemarkerConfig = freemarkerConfig;
66 }
67
68 @Override
69 public TemplateModel wrap(Object obj) throws TemplateModelException {
70
71 if (obj == null) {
72 return super.wrap(null);
73 }
74
75 // wrap enums
76 // can't do this later, as the Class instance passed to getModelFactory() lost the information about its enum.
77 if ((obj instanceof Class) && ((Class) obj).isEnum()) {
78 final String enumClassName = ((Class) obj).getName();
79 return getEnumModels().get(enumClassName);
80 }
81
82 // We let our own model factories have precedence over freemarker defaults, typically used to prevent classes
83 // implementing Map or Collection from being wrapped as SimpleHash and SimpleSequence. We intentionally don't
84 // consider model factories created in the super class method getModelFactory(Class) here because that would
85 // side step default wrapping in super.wrap(Object). I.e. the model factory returned for Map is a MapModel
86 // instead of SimpleHash returned by super.wrap(Object).
87 Class<?> clazz = obj.getClass();
88 ModelFactory modelFactory = getModelFactory(clazz, freemarkerConfig.getModelFactories());
89 if (modelFactory == null) {
90 modelFactory = getModelFactory(clazz, DEFAULT_MODEL_FACTORIES);
91 }
92 if (modelFactory != null) {
93 return handleUnknownType(obj);
94 }
95
96 return super.wrap(obj);
97 }
98
99 /**
100 * Checks the ModelFactory instances registered in FreemarkerConfig, then
101 * the default ones. If no appropriate ModelFactory was found, delegates to
102 * Freemarker's implementation. This is called by {@link freemarker.ext.beans.BeansModelCache},
103 * which is itself called by {@link freemarker.ext.beans.BeansWrapper#wrap}.
104 * These factories are cached by Freemarker, so this method only gets called
105 * once per type of object.
106 *
107 * @see #DEFAULT_MODEL_FACTORIES
108 * @see info.magnolia.freemarker.FreemarkerConfig
109 */
110 @Override
111 protected ModelFactory getModelFactory(Class clazz) {
112 final List<MagnoliaModelFactory> registeredModelFactories = freemarkerConfig.getModelFactories();
113 ModelFactory modelFactory = getModelFactory(clazz, registeredModelFactories);
114
115 if (modelFactory == null) {
116 modelFactory = getModelFactory(clazz, DEFAULT_MODEL_FACTORIES);
117 }
118 if (modelFactory == null) {
119 modelFactory = super.getModelFactory(clazz);
120 }
121 return modelFactory;
122 }
123
124 private ModelFactory getModelFactory(Class clazz, List<MagnoliaModelFactory> factories) {
125 for (MagnoliaModelFactory factory : factories) {
126 if (factory.factoryFor().isAssignableFrom(clazz)) {
127 return factory;
128 }
129 }
130 return null;
131 }
132 }