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