View Javadoc
1   /**
2    * This file Copyright (c) 2010-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.module.blossom.view;
35  
36  import java.util.Map;
37  import javax.jcr.Node;
38  import javax.servlet.ServletContext;
39  import javax.servlet.http.HttpServletRequest;
40  
41  import org.springframework.beans.factory.InitializingBean;
42  import org.springframework.context.MessageSource;
43  import org.springframework.context.MessageSourceAware;
44  import org.springframework.util.ClassUtils;
45  import org.springframework.web.context.ServletContextAware;
46  import org.springframework.web.servlet.support.JstlUtils;
47  import org.springframework.web.servlet.support.RequestContext;
48  
49  import info.magnolia.context.MgnlContext;
50  import info.magnolia.module.blossom.render.RenderContext;
51  import info.magnolia.rendering.context.RenderingContext;
52  import info.magnolia.rendering.model.RenderingModel;
53  import info.magnolia.rendering.renderer.ContextAttributeConfiguration;
54  import info.magnolia.rendering.renderer.JspRenderer;
55  import info.magnolia.rendering.template.RenderableDefinition;
56  
57  /**
58   * Renders JSP templates.
59   *
60   * @since 1.0
61   */
62  public class JspTemplateViewRenderer extends JspRenderer implements ServletContextAware, MessageSourceAware, InitializingBean {
63  
64      private static final boolean jstlPresent = ClassUtils.isPresent(
65              "javax.servlet.jsp.jstl.core.Config", TemplateViewResolver.class.getClassLoader());
66  
67      private ServletContext servletContext;
68      private MessageSource messageSource;
69  
70      public void addContextAttribute(String name, Class<?> componentClass) {
71          ContextAttributeConfiguration attributeConfiguration = new ContextAttributeConfiguration();
72          attributeConfiguration.setName(name);
73          attributeConfiguration.setComponentClass(componentClass);
74          addContextAttribute(name, attributeConfiguration);
75      }
76  
77      @Override
78      protected void setupContext(Map<String, Object> ctx, Node content, info.magnolia.rendering.template.RenderableDefinition definition, info.magnolia.rendering.model.RenderingModel<?> model, Object actionResult) {
79          super.setupContext(ctx, content, definition, model, actionResult);
80          ctx.putAll(RenderContext.get().getModel());
81      }
82  
83      @Override
84      protected void onRender(Node content, info.magnolia.rendering.template.RenderableDefinition definition, RenderingContext renderingCtx, Map<String, Object> ctx, String templateScript) throws info.magnolia.rendering.engine.RenderException {
85  
86          if (jstlPresent) {
87              HttpServletRequest request = MgnlContext.getWebContext().getRequest();
88              if (this.messageSource != null) {
89                  JstlUtils.exposeLocalizationContext(request, this.messageSource);
90              } else {
91                  JstlUtils.exposeLocalizationContext(new RequestContext(request, servletContext));
92              }
93          }
94  
95          super.onRender(content, definition, renderingCtx, ctx, templateScript);
96      }
97  
98      @Override
99      protected String resolveTemplateScript(Node content, RenderableDefinition definition, RenderingModel<?> model, String actionResult) {
100         return RenderContext.get().getTemplateScript();
101     }
102 
103     @Override
104     public void setServletContext(ServletContext servletContext) {
105         this.servletContext = servletContext;
106     }
107 
108     @Override
109     public void setMessageSource(MessageSource messageSource) {
110         this.messageSource = messageSource;
111     }
112 
113     @Override
114     public void afterPropertiesSet() throws Exception {
115         if (jstlPresent && this.messageSource != null) {
116             this.messageSource = JstlUtils.getJstlAwareMessageSource(servletContext, this.messageSource);
117         }
118     }
119 }