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.dialog;
35  
36  import info.magnolia.cms.security.MgnlUser;
37  import info.magnolia.cms.security.User;
38  import info.magnolia.context.Context;
39  import info.magnolia.context.MgnlContext;
40  import info.magnolia.context.WebContext;
41  import info.magnolia.module.blossom.annotation.TabFactory;
42  import info.magnolia.module.blossom.support.MethodInvocationUtils;
43  import info.magnolia.module.blossom.support.ParameterResolver;
44  import info.magnolia.ui.dialog.config.DialogBuilder;
45  import info.magnolia.ui.dialog.definition.ConfiguredFormDialogDefinition;
46  import info.magnolia.ui.dialog.definition.FormDialogDefinition;
47  import info.magnolia.ui.form.config.TabBuilder;
48  import info.magnolia.ui.form.definition.ConfiguredFormDefinition;
49  import info.magnolia.ui.form.definition.TabDefinition;
50  import info.magnolia.ui.framework.config.UiConfig;
51  
52  import java.lang.reflect.Method;
53  import java.util.Collections;
54  import java.util.Comparator;
55  
56  import javax.jcr.Node;
57  
58  import org.apache.commons.lang.ArrayUtils;
59  import org.apache.commons.lang.StringUtils;
60  import org.springframework.beans.BeanUtils;
61  import org.springframework.util.ClassUtils;
62  
63  import com.vaadin.data.Item;
64  
65  /**
66   * Default implementation of {@link info.magnolia.module.blossom.dialog.DialogCreator}.
67   *
68   * @since 0.5
69   */
70  public class DefaultDialogCreator implements DialogCreator {
71  
72      private static final String[] DAM_CONFIG_CLASS_NAMES = new String[]{
73              "info.magnolia.dam.app.ui.config.DamConfig", // DAM 2.0+
74              "info.magnolia.dam.asset.config.DamConfig" // DAM 1.x
75      };
76  
77      private Class damConfigClass;
78  
79      public DefaultDialogCreator() {
80          ClassLoader classLoader = this.getClass().getClassLoader();
81          for (String damConfigClassName : DAM_CONFIG_CLASS_NAMES) {
82              if (ClassUtils.isPresent(damConfigClassName, classLoader)) {
83                  damConfigClass = ClassUtils.resolveClassName(damConfigClassName, classLoader);
84                  break;
85              }
86          }
87      }
88  
89      @Override
90      public void createDialog(DialogFactoryMetaData metaData, final DialogCreationContext context) throws Exception {
91  
92          DialogBuilder dialogBuilder = new DialogBuilder(context.getId());
93          context.setDialog(dialogBuilder.definition());
94          context.getDialog().setForm(new ConfiguredFormDefinition());
95  
96          if (StringUtils.isNotEmpty(metaData.getLabel())) {
97              ConfiguredFormDefinition form = (ConfiguredFormDefinition) dialogBuilder.definition().getForm();
98              form.setLabel(metaData.getLabel());
99              dialogBuilder.label(metaData.getLabel());
100         }
101 
102         if (metaData.getFactoryMethod() != null) {
103             invokeMethodDialogFactory(metaData, context, dialogBuilder);
104         } else {
105             invokeClassDialogFactory(metaData, context, dialogBuilder);
106         }
107     }
108 
109     protected void invokeMethodDialogFactory(DialogFactoryMetaData metaData, DialogCreationContext context, DialogBuilder dialogBuilder) {
110 
111         if (StringUtils.isNotEmpty(metaData.getI18nBasename())) {
112             dialogBuilder.i18nBasename(metaData.getI18nBasename());
113         }
114 
115         ParameterResolver parameters = getDialogFactoryParameters(metaData, context, dialogBuilder);
116         MethodInvocationUtils.invoke(metaData.getFactoryMethod(), metaData.getFactoryObject(), parameters);
117 
118         if (metaData.getTabOrder() != null) {
119             sortTabs(context.getDialog(), metaData.getTabOrder());
120         }
121     }
122 
123     protected void invokeClassDialogFactory(DialogFactoryMetaData metaData, DialogCreationContext context, DialogBuilder dialogBuilder) {
124 
125         if (metaData.getI18nBasename() != null) {
126             dialogBuilder.i18nBasename(metaData.getI18nBasename());
127         }
128 
129         Object factoryObject = metaData.getFactoryObject();
130 
131         for (DialogFactoryClassMetaData classMetaData : metaData.getClassMetaData()) {
132 
133             int tabPosition = 0;
134 
135             for (Method tabFactory : classMetaData.getTabFactories()) {
136 
137                 TabFactory annotation = tabFactory.getAnnotation(TabFactory.class);
138                 TabBuilder tabBuilder = new TabBuilder(annotation.value()).label(annotation.value());
139                 dialogBuilder.form().definition().getTabs().add(tabPosition++, tabBuilder.definition());
140 
141                 ParameterResolver parameters = getTabFactoryParameters(metaData, context, tabBuilder);
142                 MethodInvocationUtils.invoke(tabFactory, metaData.getFactoryObject(), parameters);
143             }
144 
145             for (Method postCreateMethod : classMetaData.getPostCreateCallbacks()) {
146 
147                 ParameterResolver parameters = getPostCreateCallbackParameters(metaData, context, dialogBuilder);
148                 MethodInvocationUtils.invoke(postCreateMethod, factoryObject, parameters);
149             }
150         }
151 
152         for (Method postCreateMethod : metaData.getPostCreateCallbacks()) {
153 
154             ParameterResolver parameters = getPostCreateCallbackParameters(metaData, context, dialogBuilder);
155             MethodInvocationUtils.invoke(postCreateMethod, factoryObject, parameters);
156         }
157 
158         if (metaData.getTabOrder() != null) {
159             sortTabs(context.getDialog(), metaData.getTabOrder());
160         }
161     }
162 
163     protected void sortTabs(FormDialogDefinition dialog, final String[] order) {
164         Collections.sort(dialog.getForm().getTabs(), new Comparator<Object>() {
165 
166             @Override
167             public int compare(Object o1, Object o2) {
168                 switch (((o1 instanceof TabDefinition) ? 2 : 0) + ((o2 instanceof TabDefinition) ? 1 : 0)) {
169                 case 0:
170                     return 0;
171                 case 1:
172                     return -1;
173                 case 2:
174                     return 1;
175                 case 3:
176                     return ArrayUtils.indexOf(order, ((TabDefinition) o1).getLabel()) - ArrayUtils.indexOf(order, ((TabDefinition) o2).getLabel());
177                 }
178                 return 0; // Will never happen
179             }
180         });
181     }
182 
183     protected ParameterResolver getDialogFactoryParameters(DialogFactoryMetaData metaData, DialogCreationContext context, final DialogBuilder dialogBuilder) {
184         return new ParameterResolver(getStandardParameters(metaData, context)) {
185 
186             @Override
187             public Object resolveParameter(Class<?> parameterType) {
188                 if (parameterType.equals(DialogBuilder.class)) {
189                     return dialogBuilder;
190                 }
191                 return super.resolveParameter(parameterType);
192             }
193         };
194     }
195 
196     protected ParameterResolver getTabFactoryParameters(DialogFactoryMetaData metaData, DialogCreationContext context, final TabBuilder tabBuilder) {
197         return new ParameterResolver(getStandardParameters(metaData, context)) {
198 
199             @Override
200             public Object resolveParameter(Class<?> parameterType) {
201                 if (parameterType.equals(TabBuilder.class)) {
202                     return tabBuilder;
203                 }
204                 return super.resolveParameter(parameterType);
205             }
206         };
207     }
208 
209     protected ParameterResolver getPostCreateCallbackParameters(DialogFactoryMetaData metaData, DialogCreationContext context, final DialogBuilder dialogBuilder) {
210         return new ParameterResolver(getStandardParameters(metaData, context)) {
211 
212             @Override
213             public Object resolveParameter(Class<?> parameterType) {
214                 if (parameterType.isAssignableFrom(DialogBuilder.class)) {
215                     return dialogBuilder;
216                 }
217                 return super.resolveParameter(parameterType);
218             }
219         };
220     }
221 
222     protected ParameterResolver getStandardParameters(DialogFactoryMetaData metaData, final DialogCreationContext context) {
223         return new ParameterResolver() {
224 
225             @Override
226             public Object resolveParameter(Class<?> parameterType) {
227                 if (parameterType.isAssignableFrom(ConfiguredFormDialogDefinition.class)) {
228                     return context.getDialog();
229                 }
230                 if (parameterType.equals(DialogCreationContext.class)) {
231                     return context;
232                 }
233                 if (parameterType.equals(Node.class)) {
234                     return context.getContentNode();
235                 }
236                 if (parameterType.equals(Item.class)) {
237                     return context.getItem();
238                 }
239                 if (parameterType.equals(UiConfig.class)) {
240                     return new UiConfig();
241                 }
242                 if (damConfigClass != null && parameterType == damConfigClass) {
243                     return BeanUtils.instantiate(damConfigClass);
244                 }
245                 if (parameterType.isAssignableFrom(WebContext.class)) {
246                     return MgnlContext.getWebContext();
247                 }
248                 if (parameterType.isAssignableFrom(Context.class)) {
249                     return MgnlContext.getInstance();
250                 }
251                 if (parameterType.isAssignableFrom(User.class)) {
252                     return MgnlContext.getUser();
253                 }
254                 if (parameterType.isAssignableFrom(MgnlUser.class)) {
255                     return MgnlContext.getUser();
256                 }
257                 return super.resolveParameter(parameterType);
258             }
259         };
260     }
261 }