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.web;
35  
36  import info.magnolia.cms.core.AggregationState;
37  import info.magnolia.cms.core.Content;
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.objectfactory.Components;
46  import info.magnolia.rendering.context.RenderingContext;
47  import info.magnolia.rendering.template.AreaDefinition;
48  import info.magnolia.rendering.template.TemplateDefinition;
49  
50  import java.util.HashSet;
51  import java.util.Set;
52  
53  import javax.jcr.Node;
54  
55  import org.springframework.core.MethodParameter;
56  import org.springframework.web.bind.support.WebDataBinderFactory;
57  import org.springframework.web.context.request.NativeWebRequest;
58  import org.springframework.web.method.support.HandlerMethodArgumentResolver;
59  import org.springframework.web.method.support.ModelAndViewContainer;
60  
61  /**
62   * Resolves parameters for a number of Magnolia objects including {@link Node}, {@link info.magnolia.cms.core.Content},
63   * {@link info.magnolia.cms.core.AggregationState}, {@link info.magnolia.context.WebContext} and {@link info.magnolia.context.Context}.
64   * <p/>
65   * To use it configure it on your {@link org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter}.
66   *
67   * @since 3.0.2
68   */
69  public class BlossomHandlerMethodArgumentResolver implements HandlerMethodArgumentResolver {
70  
71      private Set<Class<?>> supportedParameterTypes = new HashSet<Class<?>>();
72  
73      public BlossomHandlerMethodArgumentResolver() {
74          supportedParameterTypes.add(Node.class);
75          supportedParameterTypes.add(Content.class);
76          supportedParameterTypes.add(TemplateDefinition.class);
77          supportedParameterTypes.add(BlossomTemplateDefinition.class);
78          supportedParameterTypes.add(AreaDefinition.class);
79          supportedParameterTypes.add(BlossomAreaDefinition.class);
80          supportedParameterTypes.add(AggregationState.class);
81          supportedParameterTypes.add(WebContext.class);
82          supportedParameterTypes.add(Context.class);
83          supportedParameterTypes.add(User.class);
84          supportedParameterTypes.add(MgnlUser.class);
85      }
86  
87      @Override
88      public boolean supportsParameter(MethodParameter parameter) {
89          for (Class<?> supportedParameterType : supportedParameterTypes) {
90              if (parameter.getParameterType().isAssignableFrom(supportedParameterType)) {
91                  return true;
92              }
93          }
94          return false;
95      }
96  
97      @Override
98      public Object resolveArgument(MethodParameter methodParameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {
99  
100         if (methodParameter.getParameterType().isAssignableFrom(Node.class)) {
101             RenderingContext renderingContext = Components.getComponent(RenderingContext.class);
102             if (hasSubsequentParametersOfType(methodParameter, Node.class)) {
103                 return renderingContext.getMainContent();
104             }
105             Node currentContent = renderingContext.getCurrentContent();
106             return currentContent != null ? currentContent : renderingContext.getMainContent();
107         }
108         if (methodParameter.getParameterType().isAssignableFrom(Content.class)) {
109             AggregationState aggregationState = MgnlContext.getAggregationState();
110             if (hasSubsequentParametersOfType(methodParameter, Content.class)) {
111                 return aggregationState.getMainContent();
112             }
113             Content currentContent = aggregationState.getCurrentContent();
114             return currentContent != null ? currentContent : aggregationState.getMainContent();
115         }
116         if (methodParameter.getParameterType().isAssignableFrom(TemplateDefinition.class)) {
117             return Components.getComponent(RenderingContext.class).getRenderableDefinition();
118         }
119         if (methodParameter.getParameterType().isAssignableFrom(BlossomTemplateDefinition.class)) {
120             return Components.getComponent(RenderingContext.class).getRenderableDefinition();
121         }
122         if (methodParameter.getParameterType().isAssignableFrom(AreaDefinition.class)) {
123             return Components.getComponent(RenderingContext.class).getRenderableDefinition();
124         }
125         if (methodParameter.getParameterType().isAssignableFrom(BlossomAreaDefinition.class)) {
126             return Components.getComponent(RenderingContext.class).getRenderableDefinition();
127         }
128         if (methodParameter.getParameterType().isAssignableFrom(AggregationState.class)) {
129             return MgnlContext.getAggregationState();
130         }
131         if (methodParameter.getParameterType().isAssignableFrom(WebContext.class)) {
132             return MgnlContext.getWebContext();
133         }
134         if (methodParameter.getParameterType().isAssignableFrom(Context.class)) {
135             return MgnlContext.getInstance();
136         }
137         if (methodParameter.getParameterType().isAssignableFrom(User.class)) {
138             return MgnlContext.getUser();
139         }
140         if (methodParameter.getParameterType().isAssignableFrom(MgnlUser.class)) {
141             return MgnlContext.getUser();
142         }
143 
144         return null;
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 }