View Javadoc
1   /**
2    * This file Copyright (c) 2010-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.module.blossom.web;
35  
36  import info.magnolia.cms.core.AggregationState;
37  import info.magnolia.cms.core.Channel;
38  import info.magnolia.cms.security.MgnlUser;
39  import info.magnolia.cms.security.User;
40  import info.magnolia.context.Context;
41  import info.magnolia.context.MgnlContext;
42  import info.magnolia.context.WebContext;
43  import info.magnolia.module.blossom.template.BlossomAreaDefinition;
44  import info.magnolia.module.blossom.template.BlossomTemplateDefinition;
45  import info.magnolia.module.site.Site;
46  import info.magnolia.module.site.SiteManager;
47  import info.magnolia.module.site.functions.SiteFunctions;
48  import info.magnolia.module.site.theme.Theme;
49  import info.magnolia.objectfactory.Components;
50  import info.magnolia.rendering.context.RenderingContext;
51  import info.magnolia.rendering.template.AreaDefinition;
52  import info.magnolia.rendering.template.TemplateDefinition;
53  
54  import javax.jcr.Node;
55  
56  import org.springframework.beans.factory.InitializingBean;
57  import org.springframework.core.MethodParameter;
58  import org.springframework.web.bind.support.WebArgumentResolver;
59  import org.springframework.web.context.request.NativeWebRequest;
60  
61  /**
62   * Enables use of {@link Node}, {@link info.magnolia.cms.core.AggregationState},
63   * {@link info.magnolia.context.WebContext} and {@link info.magnolia.context.Context} as arguments in methods
64   * annotated with @RequestMapping.
65   * <p/>
66   * To use it configure it on your {@link org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter}.
67   *
68   * @since 1.2
69   */
70  public class BlossomWebArgumentResolver implements WebArgumentResolver, InitializingBean {
71  
72      private SiteManager siteManager;
73      private SiteFunctions siteFunctions;
74  
75      public void setSiteManager(SiteManager siteManager) {
76          this.siteManager = siteManager;
77      }
78  
79      public void setSiteFunctions(SiteFunctions siteFunctions) {
80          this.siteFunctions = siteFunctions;
81      }
82  
83      @Override
84      public Object resolveArgument(MethodParameter methodParameter, NativeWebRequest webRequest) throws Exception {
85  
86          if (methodParameter.getParameterType().isAssignableFrom(Node.class)) {
87              RenderingContext renderingContext = Components.getComponent(RenderingContext.class);
88              if (hasSubsequentParametersOfType(methodParameter, Node.class)) {
89                  return renderingContext.getMainContent();
90              }
91              Node currentContent = renderingContext.getCurrentContent();
92              return currentContent != null ? currentContent : renderingContext.getMainContent();
93          }
94  
95          if (methodParameter.getParameterType().isAssignableFrom(TemplateDefinition.class)) {
96              return Components.getComponent(RenderingContext.class).getRenderableDefinition();
97          }
98          if (methodParameter.getParameterType().isAssignableFrom(BlossomTemplateDefinition.class)) {
99              return Components.getComponent(RenderingContext.class).getRenderableDefinition();
100         }
101         if (methodParameter.getParameterType().isAssignableFrom(AreaDefinition.class)) {
102             return Components.getComponent(RenderingContext.class).getRenderableDefinition();
103         }
104         if (methodParameter.getParameterType().isAssignableFrom(BlossomAreaDefinition.class)) {
105             return Components.getComponent(RenderingContext.class).getRenderableDefinition();
106         }
107         if (methodParameter.getParameterType().isAssignableFrom(AggregationState.class)) {
108             return MgnlContext.getAggregationState();
109         }
110         if (methodParameter.getParameterType().isAssignableFrom(WebContext.class)) {
111             return MgnlContext.getWebContext();
112         }
113         if (methodParameter.getParameterType().isAssignableFrom(Context.class)) {
114             return MgnlContext.getInstance();
115         }
116         if (methodParameter.getParameterType().isAssignableFrom(User.class)) {
117             return MgnlContext.getUser();
118         }
119         if (methodParameter.getParameterType().isAssignableFrom(MgnlUser.class)) {
120             return MgnlContext.getUser();
121         }
122         if (methodParameter.getParameterType().isAssignableFrom(Channel.class)) {
123             return MgnlContext.getAggregationState().getChannel();
124         }
125         if (methodParameter.getParameterType().isAssignableFrom(Theme.class)) {
126             Site site = siteManager.getCurrentSite();
127             if (site == null) {
128                 return null;
129             }
130             return siteFunctions.theme(site);
131         }
132         if (methodParameter.getParameterType().isAssignableFrom(Site.class)) {
133             return siteManager.getCurrentSite();
134         }
135 
136         return UNRESOLVED;
137     }
138 
139     private boolean hasSubsequentParametersOfType(MethodParameter methodParameter, Class<?> clazz) {
140         Class<?>[] parameterTypes = methodParameter.getMethod().getParameterTypes();
141         for (int i = methodParameter.getParameterIndex() + 1; i < parameterTypes.length; i++) {
142             Class<?> parameterType = parameterTypes[i];
143             if (parameterType.equals(clazz)) {
144                 return true;
145             }
146         }
147         return false;
148     }
149 
150     @Override
151     public void afterPropertiesSet() throws Exception {
152         if (siteFunctions == null) {
153             this.siteFunctions = Components.getComponent(SiteFunctions.class);
154         }
155         if (siteManager == null) {
156             this.siteManager = Components.getComponent(SiteManager.class);
157         }
158     }
159 }