View Javadoc
1   /**
2    * This file Copyright (c) 2003-2015 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 info.magnolia.cms.beans.config.MIMEMapping;
37  import info.magnolia.cms.util.ServletUtils;
38  import info.magnolia.context.MgnlContext;
39  import info.magnolia.context.WebContext;
40  import info.magnolia.jcr.util.NodeUtil;
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  
46  import java.util.Map;
47  
48  import javax.inject.Inject;
49  import javax.jcr.Node;
50  import javax.servlet.http.HttpServletRequest;
51  import javax.servlet.http.HttpServletResponse;
52  
53  /**
54   * Renders templates by dispatching to the servlet container.
55   */
56  public class JspRenderer extends AbstractRenderer {
57  
58      /**
59       * @deprecated since 5.0.2, use {@link #JspRenderer(RenderingEngine)}
60       */
61      public JspRenderer() {
62      }
63  
64      @Inject
65      public JspRenderer(RenderingEngine renderingEngine) {
66          super(renderingEngine);
67      }
68  
69      @Override
70      protected void onRender(Node content, RenderableDefinition definition, RenderingContext renderingCtx, Map<String, Object> ctx, String templateScript) throws RenderException {
71          HttpServletRequest request = MgnlContext.getWebContext().getRequest();
72          HttpServletResponse response = MgnlContext.getWebContext().getResponse();
73          response.setContentType(MIMEMapping.getMIMEType(MIMEMapping.DEFAULT_EXTENSION));
74  
75          try {
76              if (response.isCommitted() || (ServletUtils.isForward(request) || ServletUtils.isInclude(request)) || !NodeUtil.isSame(content, renderingCtx.getMainContent())) {
77                  ((WebContext) ctx).include(templateScript, renderingCtx.getAppendable());
78              } else {
79                  // we can't do an include() because the called template might want to set cookies or call response.sendRedirect()
80                  request.getRequestDispatcher(templateScript).forward(request, response);
81              }
82          } catch (Exception e) {
83              throw new RenderException("Can't render template " + templateScript, e);
84          }
85      }
86  
87      // TODO this is copied from the old rendering, need to go or be adapted
88  
89      /**
90       * We expose nodes as Map instances in JSPs.
91       *
92       * @Override protected Node wrapNodeForTemplate(Node currentContent, Node mainContent) {
93       * final Node wrapped = super.wrapNodeForTemplate(currentContent, mainContent);
94       * return new NodeMapWrapper(wrapped, mainContent.getHandle());
95       * }
96       */
97      @Override
98      protected Map newContext() {
99          return MgnlContext.getWebContext("JspRenderer can only be used with a WebContext");
100     }
101 
102 }