View Javadoc
1   /**
2    * This file Copyright (c) 2016 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.site.renderer;
35  
36  import info.magnolia.beanmerger.BeanMergerUtil;
37  import info.magnolia.config.registry.Registry;
38  import info.magnolia.jcr.util.NodeTypes;
39  import info.magnolia.jcr.util.NodeUtil;
40  import info.magnolia.module.site.Site;
41  import info.magnolia.module.site.SiteManager;
42  import info.magnolia.module.site.templates.FallbackTemplateDefinition;
43  import info.magnolia.rendering.context.RenderingContext;
44  import info.magnolia.rendering.engine.RenderException;
45  import info.magnolia.rendering.renderer.Renderer;
46  import info.magnolia.rendering.renderer.registry.RendererRegistry;
47  import info.magnolia.rendering.template.RenderableDefinition;
48  
49  import java.util.Map;
50  
51  import javax.inject.Inject;
52  import javax.jcr.Node;
53  import javax.jcr.RepositoryException;
54  
55  import org.apache.jackrabbit.commons.JcrUtils;
56  
57  /**
58   * {@link Site}-aware wrapper for a {@link Renderer}.
59   */
60  public class SiteAwareRendererWrapper implements Renderer {
61  
62      private final SiteManager siteManager;
63      private final FallbackTemplateDefinition fallbackTemplateDefinition;
64      private final RendererRegistry rendererRegistry;
65  
66      private String wrappedRendererType;
67  
68      @Inject
69      public SiteAwareRendererWrapper(SiteManager siteManager, FallbackTemplateDefinition fallbackTemplateDefinition, RendererRegistry rendererRegistry) {
70          this.siteManager = siteManager;
71          this.fallbackTemplateDefinition = fallbackTemplateDefinition;
72          this.rendererRegistry = rendererRegistry;
73      }
74  
75      @Override
76      public void render(final RenderingContext renderingCtx, Map<String, Object> contextObjects) throws RenderException {
77          Node content = renderingCtx.getCurrentContent();
78  
79          try {
80              RenderableDefinition renderableDefinition = renderingCtx.getRenderableDefinition();
81  
82              // Merge in case of a page
83              if (content != null && NodeUtil.isNodeType(content, NodeTypes.Page.NAME)) {
84                  final Site site = getSite(content);
85  
86                  renderableDefinition = BeanMergerUtil.merge(renderableDefinition, site.getTemplates().getPrototype(), fallbackTemplateDefinition.getFallbackTemplateDefinition());
87              }
88  
89              renderingCtx.push(content, renderableDefinition);
90  
91              try {
92                  rendererRegistry.getProvider(wrappedRendererType).get().render(renderingCtx, contextObjects);
93              } catch (Registry.NoSuchDefinitionException e) {
94                  throw new RenderException("Render type '" + wrappedRendererType + "' does not exist.", e);
95              } finally {
96                  renderingCtx.pop();
97              }
98          } catch (RepositoryException e) {
99              throw new RenderException(String.format("Could not determine node type of node [%s]", content), e);
100         }
101     }
102 
103     protected Site getSite(Node node) {
104         final Site site = siteManager.getAssignedSite(node);
105         if (site == null) {
106             throw new IllegalStateException("No site configuration found for [" + JcrUtils.toString(node) + "]");
107         }
108         return site;
109     }
110 
111     public String getWrappedRendererType() {
112         return wrappedRendererType;
113     }
114 
115     public void setWrappedRendererType(String wrappedRendererType) {
116         this.wrappedRendererType = wrappedRendererType;
117     }
118 }