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 java.util.stream.Collectors.joining;
37  import static net.bytebuddy.dynamic.loading.ClassLoadingStrategy.Default.WRAPPER;
38  import static net.bytebuddy.implementation.FixedValue.value;
39  import static net.bytebuddy.implementation.MethodCall.invoke;
40  import static net.bytebuddy.implementation.MethodDelegation.to;
41  import static net.bytebuddy.matcher.ElementMatchers.*;
42  
43  import java.io.Serializable;
44  import java.lang.reflect.Constructor;
45  import java.lang.reflect.Method;
46  import java.lang.reflect.Modifier;
47  import java.util.ArrayList;
48  import java.util.HashMap;
49  import java.util.List;
50  import java.util.Map;
51  
52  import org.reflections.ReflectionUtils;
53  
54  import lombok.SneakyThrows;
55  import net.bytebuddy.ByteBuddy;
56  import net.bytebuddy.TypeCache;
57  import net.bytebuddy.dynamic.scaffold.subclass.ConstructorStrategy;
58  import net.bytebuddy.implementation.bind.annotation.Origin;
59  import net.bytebuddy.implementation.bind.annotation.RuntimeType;
60  import net.bytebuddy.implementation.bind.annotation.This;
61  
62  /**
63   * ByteBuddy-based proxy implementation of an interface derived from {@link UiComponentContext}.
64   * By convention, generates the boilerplate for the methods that return {@link ContextProperty}.
65   */
66  public final class UiComponentContextProxy {
67  
68      static TypeCache<Class> proxyTypeCache = new TypeCache.WithInlineExpunction<>(TypeCache.Sort.WEAK);
69  
70      @SneakyThrows
71      public <T extends UiComponentContext> T createUiComponentContext(Class<T> clazz) {
72          return createUiComponentContext(clazz, new HashMap<>());
73      }
74  
75      @SneakyThrows
76      public <T extends UiComponentContext> T createUiComponentContext(Class<T> clazz, Map<String, ContextProperty> properties) {
77          if (!clazz.isInterface()) {
78              throw new RuntimeException("Context type has to be an interface");
79          }
80  
81          return (T) proxyTypeCache.findOrInsert(Thread.currentThread().getContextClassLoader(), clazz, () -> generateUiComponentContextProxy(clazz)).getConstructor(Map.class).newInstance(properties);
82      }
83      private <T extends UiComponentContext> Class<T> generateUiComponentContextProxy(Class<T> clazz) throws NoSuchMethodException {
84  
85          final Constructor<UiComponentContextBase> targetCtor = UiComponentContextBase.class.getConstructor(Map.class);
86          final Class<? extends UiComponentContextBase> uiComponentContextType = new ByteBuddy()
87                  .subclass(UiComponentContextBase.class, ConstructorStrategy.Default.NO_CONSTRUCTORS)
88                  .implement(clazz, Serializable.class)
89                  .method(named("getUiComponentContextType")).intercept(value(clazz))
90                  .method(returns(ContextProperty.class))
91                  .intercept(to(new StatePropertyGetterDelegate()))
92                  .method(isToString())
93                  .intercept(to(new DescribeContext()))
94                  .defineConstructor(Modifier.PUBLIC)
95                  .withParameters(Map.class)
96                  .intercept(invoke(targetCtor)
97                          .withAllArguments()
98                          .andThen(to(new ContextInitializer())))
99                  .make()
100                 .load(getClass().getClassLoader(), WRAPPER)
101                 .getLoaded();
102         return (Class<T>) uiComponentContextType;
103     }
104 
105     /**
106      * Initialises {@link ContextProperty} for this view.
107      */
108     public static class ContextInitializer {
109 
110         @SuppressWarnings("unchecked")
111         public void init(@This UiComponentContextBase that) {
112             ReflectionUtils.getMethods(that.getClass()).stream()
113                     .filter(method -> ContextProperty.class.isAssignableFrom(method.getReturnType()))
114                     .filter(method -> !that.properties().containsKey(method.getName()))
115                     .forEach(method-> that.properties().put(method.getName(), new ContextProperty.Impl()));
116         }
117     }
118 
119     /**
120      * Delegates a getter method call to a look-up in the property map.
121      */
122     public static class StatePropertyGetterDelegate {
123 
124         @RuntimeType
125         public ContextProperty getter(@Origin Method method, @This UiComponentContextBase that) {
126             return that.properties().get(method.getName());
127         }
128     }
129 
130     public static class DescribeContext {
131 
132         @RuntimeType
133         public String getter(@This UiComponentContextBase that) {
134             List<String> properties = new ArrayList<>();
135             that.properties().forEach((id, property) -> properties.add(String.format("%s -> %s", id, property.nullableValue())));
136             return properties.stream().collect(joining(
137                     ", ",
138                     that.getUiComponentContextType().getSimpleName() + " [",
139                     "]"));
140         }
141     }
142 }