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