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.contentapp;
35  
36  import static java.util.stream.Collectors.*;
37  
38  import info.magnolia.objectfactory.ComponentProvider;
39  import info.magnolia.objectfactory.Components;
40  import info.magnolia.ui.api.i18n.I18NAuthoringSupport;
41  import info.magnolia.ui.availability.AvailabilityChecker;
42  import info.magnolia.ui.contentapp.browser.TreePresenter;
43  import info.magnolia.ui.contentapp.browser.TreeView;
44  import info.magnolia.ui.contentapp.configuration.TreeViewDefinition;
45  import info.magnolia.ui.contentapp.configuration.column.ColumnDefinition;
46  import info.magnolia.ui.contentapp.observation.JcrDataSourceObservation;
47  import info.magnolia.ui.datasource.DatasourceDefinition;
48  import info.magnolia.ui.datasource.jcr.JcrDatasource;
49  import info.magnolia.ui.datasource.jcr.JcrDatasourceDefinition;
50  import info.magnolia.ui.editor.JcrItemPropertySet;
51  import info.magnolia.ui.filter.DataFilter;
52  
53  import java.util.ArrayList;
54  import java.util.List;
55  import java.util.Optional;
56  import java.util.stream.Stream;
57  
58  import javax.inject.Inject;
59  import javax.jcr.Item;
60  import javax.jcr.Node;
61  
62  import com.machinezoo.noexception.Exceptions;
63  import com.vaadin.data.PropertySet;
64  import com.vaadin.data.provider.DataProvider;
65  
66  /**
67   *
68   * JCR specific presenter implementation backing up {@link TreeView}.
69   */
70  public class JcrTreePresenter extends TreePresenter<Item> {
71  
72      private final JcrItemInteractionAvailability interactionAvailability;
73      private final I18NAuthoringSupport<Item> i18NAuthoringSupport;
74      private final JcrDatasourceDefinition datasourceDefinition;
75  
76      @Inject
77      JcrTreePresenter(
78              TreeViewDefinition<Item> definition,
79              ComponentProvider componentProvider,
80              AvailabilityChecker<Node> availabilityChecker,
81              JcrDatasource datasource,
82              JcrDataSourceObservation datasourceObservation, I18NAuthoringSupport<Item> i18NAuthoringSupport, JcrDatasourceDefinition datasourceDefinition) {
83          super(definition, componentProvider, availabilityChecker, datasource, datasourceObservation);
84          this.interactionAvailability = new JcrItemInteractionAvailability(datasource);
85          this.i18NAuthoringSupport = i18NAuthoringSupport;
86          this.datasourceDefinition = datasourceDefinition;
87      }
88  
89      /**
90       * @deprecated since 6.2.4. Use {@link info.magnolia.ui.contentapp.JcrTreePresenter#JcrTreePresenter(info.magnolia.ui.contentapp.configuration.TreeViewDefinition, info.magnolia.objectfactory.ComponentProvider, info.magnolia.ui.availability.AvailabilityChecker, info.magnolia.ui.datasource.jcr.JcrDatasource, info.magnolia.ui.contentapp.observation.JcrDataSourceObservation, info.magnolia.ui.api.i18n.I18NAuthoringSupport, info.magnolia.ui.datasource.jcr.JcrDatasourceDefinition)} instead.
91       */
92      @Deprecated
93      public JcrTreePresenter(TreeViewDefinition<Item> definition, ComponentProvider componentProvider, AvailabilityChecker availabilityChecker, JcrDatasource datasource, JcrDataSourceObservation datasourceObservation) {
94          this(definition, componentProvider, availabilityChecker, datasource, datasourceObservation, Components.getComponent(I18NAuthoringSupport.class), (JcrDatasourceDefinition) Components.getComponent(DatasourceDefinition.class));
95      }
96  
97      @Override
98      public Stream<Item> getParents(Item item) {
99          final List<Item> parents = new ArrayList<>();
100         Optional<Item> parent = getDirectParent(item);
101         while (parent.isPresent()) {
102             parents.add(parent.get());
103             parent = getDirectParent(parent.get());
104         }
105         return parents.stream();
106     }
107 
108     @Override
109     public FilterableHierarchicalDataProvider<Item> createDataProvider() {
110         final DataProvider<Item, DataFilter> filteringDataProvider = (DataProvider) componentProvider.newInstance(JcrDataProvider.class);
111         return FilterableHierarchicalDataProvider.wrap(componentProvider.newInstance(HierarchicalJcrDataProvider.class), filteringDataProvider);
112     }
113 
114     private Optional<Item> getDirectParent(Item item) {
115         return Exceptions.wrap().get(() -> {
116             if (item.isNode() && item.getDepth() == 0) {
117                 return Optional.empty();
118             }
119             return Optional.of(item.getParent());
120         });
121     }
122 
123     @Override
124     protected PropertySet<Item> createPropertySet() {
125         final List<JcrItemPropertySet.JcrPropertyDescriptor> propertyDescriptors = definition.getColumns().stream().collect(toMap(ColumnDefinition::getName, ColumnDefinition::getType))
126                 .entrySet().stream()
127                 .map(entry -> JcrItemPropertySet.JcrPropertyDescriptor.builder()
128                         .type((Class) entry.getValue())
129                         .name(entry.getKey())
130                         .nodeNameProperty(datasourceDefinition.getNodeNameProperty())
131                         .build())
132                 .collect(toList());
133         return new JcrItemPropertySet(propertyDescriptors, i18NAuthoringSupport);
134     }
135 
136     @Override
137     public boolean isItemAvailable(Item item) {
138         return this.interactionAvailability.isItemAvailable(item);
139     }
140 }