1 /**
2 * This file Copyright (c) 2008-2011 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.module.templating.renderers;
35
36 import freemarker.template.TemplateException;
37 import info.magnolia.module.templating.RenderableDefinition;
38 import info.magnolia.cms.core.Content;
39 import info.magnolia.context.MgnlContext;
40 import info.magnolia.freemarker.FreemarkerHelper;
41 import info.magnolia.module.templating.RenderException;
42
43 import java.io.Writer;
44 import java.util.HashMap;
45 import java.util.Locale;
46 import java.util.Map;
47
48 import org.apache.commons.lang.exception.ExceptionUtils;
49
50 /**
51 * Template renderer for freemarker.
52 * @version $Revision: 14052 $ ($Author: gjoseph $)
53 */
54 public class FreemarkerTemplateRenderer extends AbstractTemplateRenderer {
55 private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(FreemarkerTemplateRenderer.class);
56
57 private final FreemarkerHelper fmHelper;
58
59 /**
60 * Constructs a FreemarkerTemplateRenderer that uses the default (singleton)
61 * instance of FreemarkerHelper.
62 */
63 public FreemarkerTemplateRenderer() {
64 this(FreemarkerHelper.getInstance());
65 }
66
67 FreemarkerTemplateRenderer(FreemarkerHelper fmRenderer) {
68 this.fmHelper = fmRenderer;
69 }
70
71 protected void onRender(Content content, RenderableDefinition definition, Writer out, Map ctx, String templatePath) throws RenderException {
72 final Locale locale = MgnlContext.getAggregationState().getLocale();
73
74 try {
75 fmHelper.render(templatePath, locale, definition.getI18nBasename(), ctx, out);
76 }
77 catch (TemplateException e) {
78 // TODO should be thrown?
79 }
80 catch (Exception e) {
81 //log.error("Failed to process Freemarker template with " + e.getMessage(), e);
82 throw new RenderException("Can't render template " + templatePath + ": " + ExceptionUtils.getRootCauseMessage(e), e);
83 }
84 }
85
86 protected Map newContext() {
87 return new HashMap();
88 }
89 }