View Javadoc
1   /**
2    * This file Copyright (c) 2013-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.templating.renderers;
35  
36  import info.magnolia.jcr.util.ContentMap;
37  import info.magnolia.objectfactory.Components;
38  import info.magnolia.rendering.context.RenderingContext;
39  import info.magnolia.rendering.engine.RenderException;
40  import info.magnolia.rendering.engine.RenderingEngine;
41  import info.magnolia.rendering.renderer.AbstractRenderer;
42  import info.magnolia.rendering.template.RenderableDefinition;
43  import info.magnolia.templating.elements.AreaElement;
44  import info.magnolia.templating.elements.ComponentElement;
45  
46  import java.util.ArrayList;
47  import java.util.HashMap;
48  import java.util.List;
49  import java.util.Map;
50  
51  import javax.inject.Inject;
52  import javax.jcr.Node;
53  
54  import org.slf4j.Logger;
55  import org.slf4j.LoggerFactory;
56  
57  
58  /**
59   * The renderer for definitions without template script.
60   * Renders ContentMaps from "components" or "component" attribute from contextObjects.
61   */
62  public class NoScriptRenderer extends AbstractRenderer {
63  
64      public static final String NO_SCRIPT_RENDERER = "noscript";
65      private final Logger log = LoggerFactory.getLogger(getClass());
66  
67      /**
68       * @deprecated since 5.0.2, use {@link #NoScriptRenderer(RenderingEngine)}
69       */
70      public NoScriptRenderer() {
71      }
72  
73      @Inject
74      public NoScriptRenderer(RenderingEngine renderingEngine) {
75          super(renderingEngine);
76      }
77  
78      @Override
79      public void render(RenderingContext renderingCtx, Map<String, Object> contextObjects) throws RenderException {
80          onRender(null, null, renderingCtx, contextObjects, null);
81      }
82  
83      @Override
84      protected void onRender(Node content, RenderableDefinition definition, RenderingContext renderingCtx, Map<String, Object> ctx, String templateScript) throws RenderException {
85  
86          List<ContentMap> components = null;
87          if (ctx.get(AreaElement.ATTRIBUTE_COMPONENT) instanceof ContentMap) {
88              components = new ArrayList<ContentMap>();
89              components.add((ContentMap) ctx.get(AreaElement.ATTRIBUTE_COMPONENT));
90          } else if (ctx.get(AreaElement.ATTRIBUTE_COMPONENTS) instanceof List) {
91              components = (List<ContentMap>) ctx.get(AreaElement.ATTRIBUTE_COMPONENTS);
92          } else {
93              return; // nothing to render
94          }
95  
96          try {
97              Appendable out = renderingCtx.getOutputProvider().getAppendable();
98  
99              for (ContentMap component : components) {
100                 ComponentElement componentElement = Components.newInstance(ComponentElement.class);
101                 componentElement.setContent(component.getJCRNode());
102                 componentElement.begin(out);
103                 componentElement.end(out);
104             }
105         } catch (Exception e) {
106             throw new RenderException(e);
107         }
108     }
109 
110     @Override
111     protected Map<String, Object> newContext() {
112         return new HashMap<String, Object>();
113     }
114 
115 }