View Javadoc
1   /**
2    * This file Copyright (c) 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.ui.framework;
35  
36  import static net.bytebuddy.dynamic.loading.ClassLoadingStrategy.Default.WRAPPER;
37  import static net.bytebuddy.implementation.FixedValue.value;
38  import static net.bytebuddy.implementation.MethodCall.invoke;
39  import static net.bytebuddy.implementation.MethodDelegation.to;
40  import static net.bytebuddy.matcher.ElementMatchers.*;
41  
42  import java.io.Serializable;
43  import java.lang.reflect.Constructor;
44  import java.lang.reflect.Method;
45  import java.lang.reflect.Modifier;
46  import java.util.HashMap;
47  import java.util.Map;
48  
49  import org.reflections.ReflectionUtils;
50  
51  import lombok.SneakyThrows;
52  import net.bytebuddy.ByteBuddy;
53  import net.bytebuddy.dynamic.scaffold.subclass.ConstructorStrategy;
54  import net.bytebuddy.implementation.bind.annotation.Origin;
55  import net.bytebuddy.implementation.bind.annotation.RuntimeType;
56  import net.bytebuddy.implementation.bind.annotation.This;
57  
58  /**
59   * ByteBuddy-based proxy implementation of an interface derived from {@link ViewContext}.
60   * By convention, generates the boilerplate for the methods that return {@link ContextProperty}.
61   */
62  public final class ViewContextProxy {
63  
64      @SneakyThrows
65      public <T extends ViewContext> T createViewContext(Class<T> clazz) {
66          return createViewContext(clazz, new HashMap<>());
67      }
68  
69      @SneakyThrows
70      public <T extends ViewContext> T createViewContext(Class<T> clazz, Map<String, ContextProperty> properties) {
71          if (!clazz.isInterface()) {
72              throw new RuntimeException("Context type has to be an interface");
73          }
74  
75          return generateViewContextProxy(clazz, properties);
76      }
77  
78      private <T extends ViewContext> T generateViewContextProxy(Class<T> clazz, Map<String, ContextProperty> properties) throws InstantiationException, IllegalAccessException, NoSuchMethodException {
79          final Constructor<ViewContextBase> targetCtor = ViewContextBase.class.getConstructor(Map.class);
80          return clazz.cast(new ByteBuddy()
81                  .subclass(ViewContextBase.class, ConstructorStrategy.Default.NO_CONSTRUCTORS)
82                  .implement(clazz, Serializable.class)
83                  .method(named("getViewContextType")).intercept(value(clazz))
84                  .method(returns(ContextProperty.class))
85                      .intercept(to(new StatePropertyGetterDelegate()))
86                  .defineConstructor(Modifier.PUBLIC)
87                      .intercept(invoke(targetCtor)
88                      .with(properties)
89                      .andThen(to(new ContextInitializer())))
90                  .make()
91                  .load(getClass().getClassLoader(), WRAPPER)
92                  .getLoaded()
93                  .newInstance());
94      }
95  
96      /**
97       * Initialises {@link ContextProperty} for this view.
98       */
99      public static class ContextInitializer {
100 
101         @SuppressWarnings("unchecked")
102         public void init(@This ViewContextBase that) {
103             ReflectionUtils.getMethods(that.getClass()).stream()
104                     .filter(method -> ContextProperty.class.isAssignableFrom(method.getReturnType()))
105                     .filter(method -> !that.properties().containsKey(method.getName()))
106                     .forEach(method -> that.properties().put(method.getName(), new ContextProperty.Impl()));
107         }
108     }
109 
110     /**
111      * Delegates a getter method call to a look-up in the property map.
112      */
113     public static class StatePropertyGetterDelegate {
114 
115         @RuntimeType
116         public ContextProperty getter(@Origin Method method, @This ViewContextBase that) {
117             return that.properties().get(method.getName());
118         }
119     }
120 }