View Javadoc

1   /**
2    * This file Copyright (c) 2011-2013 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.rendering.renderer;
35  
36  import freemarker.template.TemplateException;
37  
38  import info.magnolia.context.MgnlContext;
39  import info.magnolia.freemarker.FreemarkerHelper;
40  import info.magnolia.objectfactory.Components;
41  import info.magnolia.rendering.context.RenderingContext;
42  import info.magnolia.rendering.engine.RenderException;
43  import info.magnolia.rendering.engine.RenderingEngine;
44  import info.magnolia.rendering.template.RenderableDefinition;
45  import info.magnolia.rendering.util.AppendableWriter;
46  
47  import java.io.IOException;
48  import java.util.HashMap;
49  import java.util.Locale;
50  import java.util.Map;
51  
52  import javax.inject.Inject;
53  import javax.jcr.Node;
54  
55  import org.slf4j.Logger;
56  import org.slf4j.LoggerFactory;
57  
58  /**
59   * Uses FreeMarker to render the content.
60   * 
61   * @version $Id$
62   */
63  public class FreemarkerRenderer extends AbstractRenderer {
64  
65      private final Logger log = LoggerFactory.getLogger(getClass());
66  
67      private final FreemarkerHelper fmHelper;
68  
69      /**
70       * Constructs a FreemarkerTemplateRenderer that uses the default (singleton)
71       * instance of FreemarkerHelper.
72       * 
73       * @deprecated since 5.0.2, use {@link #FreemarkerRenderer(FreemarkerHelper, RenderingEngine)}
74       */
75      public FreemarkerRenderer() {
76          this(Components.getComponent(FreemarkerHelper.class));
77      }
78  
79      /**
80       * @deprecated since 5.0.2, use {@link #FreemarkerRenderer(FreemarkerHelper, RenderingEngine)}
81       */
82      FreemarkerRenderer(FreemarkerHelper fmRenderer) {
83          this.fmHelper = fmRenderer;
84      }
85  
86      @Inject
87      public FreemarkerRenderer(FreemarkerHelper fmRenderer, RenderingEngine renderingEngine) {
88          super(renderingEngine);
89          this.fmHelper = fmRenderer;
90      }
91  
92      @Override
93      protected void onRender(Node content, RenderableDefinition definition, RenderingContext renderingCtx, Map<String, Object> ctx, String templateScript) throws RenderException {
94          final Locale locale = MgnlContext.getAggregationState().getLocale();
95  
96          try {
97              AppendableWriter out = renderingCtx.getAppendable();
98              fmHelper.render(templateScript, locale, definition.getI18nBasename(), ctx, out);
99          } catch (TemplateException e) {
100             throw new RenderException(e);
101         } catch (IOException e) {
102             throw new RenderException(e);
103         }
104     }
105 
106     @Override
107     protected Map<String, Object> newContext() {
108         return new HashMap<String, Object>();
109     }
110 
111     public FreemarkerHelper getFmHelper() {
112         return fmHelper;
113     }
114 
115 }