View Javadoc
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;
35  
36  import info.magnolia.freemarker.models.MagnoliaModelFactory;
37  import info.magnolia.freemarker.models.MagnoliaObjectWrapper;
38  
39  import java.util.ArrayList;
40  import java.util.HashMap;
41  import java.util.List;
42  import java.util.Map;
43  
44  import javax.inject.Singleton;
45  
46  import freemarker.cache.ClassTemplateLoader;
47  import freemarker.cache.MultiTemplateLoader;
48  import freemarker.cache.TemplateLoader;
49  import freemarker.template.ObjectWrapper;
50  import freemarker.template.TemplateExceptionHandler;
51  import freemarker.template.TemplateModel;
52  import freemarker.template.TemplateModelException;
53  
54  /**
55   * Observed bean holding Freemarker configuration. Not to be confused with
56   * Freemarker's own {@link freemarker.template.Configuration}. This only exposes the few
57   * properties that Magnolia allows to configure and is able to handle properly.
58   * It also provides a few additional methods used internally.
59   *
60   * @see info.magnolia.freemarker.FreemarkerHelper
61   * @see info.magnolia.freemarker.models.MagnoliaObjectWrapper
62   * @see info.magnolia.freemarker.models.MagnoliaModelFactory
63   */
64  @Singleton
65  public class FreemarkerConfig {
66  
67      /**
68       * The MagnoliaModelFactory implementations explicitly registered by modules.
69       */
70      private List<MagnoliaModelFactory> registeredModelFactories = new ArrayList<MagnoliaModelFactory>();
71      private List<TemplateLoader> templateLoaders = new ArrayList<TemplateLoader>();
72      private Map<String, TemplateModel> sharedVariables = new HashMap<String, TemplateModel>();
73      private TemplateExceptionHandler templateExceptionHandler = TemplateExceptionHandler.IGNORE_HANDLER;
74  
75      private ObjectWrapper objectWrapper;
76      private TemplateLoader multiTL;
77  
78      public FreemarkerConfig() {
79      }
80  
81      public ObjectWrapper getObjectWrapper() {
82          if (objectWrapper == null) {
83              objectWrapper = newObjectWrapper();
84          }
85          return objectWrapper;
86      }
87  
88      protected ObjectWrapper newObjectWrapper() {
89          return new MagnoliaObjectWrapper(this);
90      }
91  
92      public TemplateLoader getTemplateLoader() {
93          // multiTL will be null every time the config is changed, since node2bean instantiates a new FreemarkerConfig
94          if (multiTL == null) {
95              // using getTemplateLoaders() instead of the variable to make sure we go to the proxied object
96              final List<TemplateLoader> loaders = getTemplateLoaders();
97              // Fall back to ClassTemplateLoader
98              if (loaders.isEmpty()) {
99                  multiTL = new ClassTemplateLoader(getClass(), "/");
100             } else {
101                 final TemplateLoader[] tl = loaders.toArray(new TemplateLoader[loaders.size()]);
102                 multiTL = new MultiTemplateLoader(tl);
103             }
104         }
105         return multiTL;
106     }
107 
108     public List<MagnoliaModelFactory> getModelFactories() {
109         return registeredModelFactories;
110     }
111 
112     public void setModelFactories(List<MagnoliaModelFactory> registeredModelFactories) {
113         this.registeredModelFactories.addAll(registeredModelFactories);
114     }
115 
116     public List<TemplateLoader> getTemplateLoaders() {
117         return templateLoaders;
118     }
119 
120     public void setTemplateLoaders(List<TemplateLoader> templateLoaders) {
121         this.templateLoaders.addAll(templateLoaders);
122     }
123 
124     public Map<String, TemplateModel> getSharedVariables() {
125         return sharedVariables;
126     }
127 
128     public void setSharedVariables(Map<String, Object> configuredSharedVariables) throws TemplateModelException {
129         for (Map.Entry<String, Object> sv : configuredSharedVariables.entrySet()) {
130             sharedVariables.put(sv.getKey(), getObjectWrapper().wrap(sv.getValue()));
131         }
132     }
133 
134     // for tests
135     void addSharedVariable(String name, Object value) throws TemplateModelException {
136         sharedVariables.put(name, getObjectWrapper().wrap(value));
137     }
138 
139     public TemplateExceptionHandler getTemplateExceptionHandler() {
140         return templateExceptionHandler;
141     }
142 
143     public void setTemplateExceptionHandler(TemplateExceptionHandler templateExceptionHandler) {
144         this.templateExceptionHandler = templateExceptionHandler;
145     }
146 }