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.chooser.definition;
35  
36  import info.magnolia.config.MutableWrapper;
37  import info.magnolia.config.Mutator;
38  import info.magnolia.ui.api.app.registry.AppDescriptorRegistry;
39  import info.magnolia.ui.contentapp.configuration.BrowserDescriptor;
40  import info.magnolia.ui.contentapp.configuration.ContentViewDefinition;
41  import info.magnolia.ui.contentapp.configuration.WorkbenchDefinition;
42  
43  import java.util.Optional;
44  
45  import javax.inject.Inject;
46  
47  import lombok.AccessLevel;
48  import lombok.Getter;
49  import lombok.Setter;
50  
51  /**
52   * Workbench chooser definition auto-resolving properties based on an app name.
53   *
54   * @param <DD> type of datasource definition
55   * @param <T> type of items to be chosen
56   */
57  @Getter
58  @Setter
59  public class AppAwareWorkbenchChooserDefinition<DD, T> extends WorkbenchChooserDefinition<DD, T> {
60  
61      private String title;
62      private String appName;
63      private WorkbenchDefinition<T> workbenchDefinition;
64  
65      @Getter(AccessLevel.PRIVATE)
66      @Setter(AccessLevel.PRIVATE)
67      private AppDescriptorRegistry appDescriptorRegistry;
68  
69      @Inject
70      public AppAwareWorkbenchChooserDefinition(AppDescriptorRegistry appDescriptorRegistry) {
71          super();
72          this.appDescriptorRegistry = appDescriptorRegistry;
73      }
74  
75      /**
76       * @return the datasource definition for this Chooser. The datasource may come either from {@link #getDatasource()}
77       * or be resolved from {@link #getAppName()}.
78       *
79       * @see #resolveDatasourceFromAppName()
80       */
81      @Override
82      public DD getDatasource() {
83          return Optional.ofNullable(super.getDatasource()).orElseGet(() -> resolveDatasourceFromAppName()
84                  .orElseThrow(() -> new IllegalStateException("Could not resolve datasource from chooser definition")));
85      }
86  
87      @SuppressWarnings("unchecked")
88      private Optional<DD> resolveDatasourceFromAppName() {
89          return (Optional<DD>) resolveBrowserDescriptorFromAppName().map(BrowserDescriptor::getDatasource);
90      }
91  
92      @Override
93      public WorkbenchDefinition<T> getWorkbench() {
94          WorkbenchDefinition<T> workbenchFromAppOrDefault = resolveWorkbenchDefinitionFromAppName().orElse(super.getWorkbench());
95          final WorkbenchDefinition<T> workbenchDefinition = Optional.ofNullable(this.workbenchDefinition).orElse(workbenchFromAppOrDefault);
96          final WorkbenchDefinition<T> wrapped = MutableWrapper.wrap(workbenchDefinition);
97          wrapped.getContentViews().forEach(this::applySingleSelectAndReadOnly);
98          return wrapped;
99      }
100 
101     private void applySingleSelectAndReadOnly(ContentViewDefinition<T> viewDefinition) {
102         final TabularViewMutator tabularViewMutator = new TabularViewMutator<>(MutableWrapper.asMutable(viewDefinition));
103         if (!this.isMultiSelect()) {
104             tabularViewMutator.setSingleSelectMode();
105         }
106         tabularViewMutator.setReadOnly();
107     }
108 
109     private Optional<WorkbenchDefinition<T>> resolveWorkbenchDefinitionFromAppName() {
110         return resolveBrowserDescriptorFromAppName().map(BrowserDescriptor::getWorkbench);
111     }
112 
113     private Optional<BrowserDescriptor> resolveBrowserDescriptorFromAppName() {
114         return Optional.ofNullable(getAppName())
115                 .map(getAppDescriptorRegistry()::getProvider)
116                 .map(provider -> provider.get().getSubApps().values()
117                         .stream()
118                         .filter(BrowserDescriptor.class::isInstance)
119                         .map(BrowserDescriptor.class::cast)
120                         .findFirst()
121                         .orElseThrow(() -> new IllegalStateException("Could not resolve browser descriptor from app " + getAppName())));
122     }
123 
124     private static class TabularViewMutator<T> extends Mutator<ContentViewDefinition<T>> {
125 
126         TabularViewMutator(MutableWrapper.Mutable<ContentViewDefinition<T>> mutableObject) {
127             super(mutableObject);
128         }
129 
130         void setSingleSelectMode() {
131             setProperty("multiSelect", false);
132         }
133 
134         void setReadOnly() {
135             setProperty("readOnly", true);
136         }
137     }
138 }