View Javadoc

1   /**
2    * This file Copyright (c) 2008-2012 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.templatingkit.renderers;
35  
36  import info.magnolia.beanmerger.BeanMergerUtil;
37  import info.magnolia.jcr.util.NodeUtil;
38  import info.magnolia.jcr.wrapper.HTMLEscapingNodeWrapper;
39  import info.magnolia.module.templatingkit.functions.STKTemplatingFunctions;
40  import info.magnolia.module.templatingkit.sites.Site;
41  import info.magnolia.module.templatingkit.templates.DefaultSTKTemplateConfiguration;
42  import info.magnolia.module.templatingkit.templates.pages.STKPage;
43  import info.magnolia.objectfactory.Components;
44  import info.magnolia.rendering.context.RenderingContext;
45  import info.magnolia.rendering.engine.RenderException;
46  import info.magnolia.rendering.renderer.FreemarkerRenderer;
47  import info.magnolia.rendering.template.RenderableDefinition;
48  
49  import java.util.Map;
50  
51  import javax.jcr.Node;
52  
53  import org.apache.jackrabbit.commons.JcrUtils;
54  
55  /**
56   * Default STK renderer.
57   * @author pbracher
58   * @version $Id$
59   */
60  public class STKRenderer extends FreemarkerRenderer {
61  
62      @Override
63      public void render(final RenderingContext renderingCtx, Map<String, Object> contextObjects) throws RenderException {
64          Node content = renderingCtx.getCurrentContent();
65  
66          // FIXME for the time being we only render pages and areas but not components
67          try {
68              final Site site = getSite(content);
69              RenderableDefinition renderableDefinition = renderingCtx.getRenderableDefinition();
70              // merge in case of a page
71              if (renderableDefinition instanceof STKPage) {
72                  renderableDefinition = (RenderableDefinition) BeanMergerUtil.merge(renderableDefinition, site.getTemplates().getPrototype(), DefaultSTKTemplateConfiguration.getInstance());
73              }
74              // FIXME we should not push() if the definition is not merged
75              renderingCtx.push(content, renderableDefinition);
76              try{
77                  super.render(renderingCtx, contextObjects);
78              } finally {
79                  renderingCtx.pop();
80              }
81          } catch (Exception e) {
82              throw new RenderException(e);
83          }
84      }
85  
86      protected Site getSite(Node node) {
87          final Site site = Components.getComponent(STKTemplatingFunctions.class).site();
88          if(site == null){
89              throw new IllegalStateException("No site configuration found for [" + JcrUtils.toString(node) + "]");
90          }
91          return site;
92      }
93  
94      /**
95       * Wraps the current content node before passing it to the model. Wrap the node with HTMLEscapingNodeWrapper before rendering (XSS protection)
96       * @param content the actual content
97       * @return the wrapped content
98       */
99      @Override
100     protected Node wrapNodeForModel(Node content) {
101         content = super.wrapNodeForModel(content);
102         content = wrapWithHTMLEscapingWrapper(content);
103         return content;
104     }
105 
106     protected Node wrapWithHTMLEscapingWrapper(Node content) {
107         if (!NodeUtil.isWrappedWith(content, HTMLEscapingNodeWrapper.class)) {
108             content = new HTMLEscapingNodeWrapper(content, true);
109         }
110         return content;
111     }
112 }