View Javadoc
1   /**
2    * This file Copyright (c) 2019 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.availability;
35  
36  import info.magnolia.objectfactory.ComponentProvider;
37  import info.magnolia.ui.api.availability.AvailabilityDefinition;
38  import info.magnolia.ui.api.availability.AvailabilityRuleDefinition;
39  import info.magnolia.ui.availability.rule.AccessGrantedRuleDefinition;
40  import info.magnolia.ui.availability.rule.MultipleItemsRuleDefinition;
41  
42  import java.util.List;
43  import java.util.stream.Stream;
44  
45  import javax.inject.Inject;
46  
47  /**
48   * Implements {@link info.magnolia.ui.api.availability.AvailabilityChecker}.
49   */
50  public class DefaultAvailabilityChecker<T> implements AvailabilityChecker<T> {
51  
52      private final ComponentProvider componentProvider;
53  
54      @Inject
55      public DefaultAvailabilityChecker(ComponentProvider componentProvider) {
56          this.componentProvider = componentProvider;
57      }
58  
59      @Override
60      public boolean isAvailable(AvailabilityDefinition availabilityDefinition, List<T> items) {
61          // verify that all the rules pass
62          boolean rulesPass = Stream.concat(getDefaultRulesDefinitions(), availabilityDefinition.getRules().stream())
63                  .filter(ruleDefinition -> ruleDefinition.getImplementationClass() != null)
64                  .allMatch(ruleDefinition -> isAvailable(availabilityDefinition, ruleDefinition, items));
65  
66          // if the item set it empty and the rules are 'ok with that'
67          // check whether availability is generally configured to work with root
68          if (rulesPass && items.isEmpty()) {
69              return availabilityDefinition.isRoot();
70          }
71  
72          return rulesPass;
73      }
74  
75      protected Stream<AvailabilityRuleDefinition> getDefaultRulesDefinitions() {
76          return Stream.of(new AccessGrantedRuleDefinition(), new MultipleItemsRuleDefinition());
77      }
78  
79      private boolean isAvailable(AvailabilityDefinition availabilityDefinition, AvailabilityRuleDefinition ruleDefinition,  List<T> items) {
80          return componentProvider.newInstance(ruleDefinition.getImplementationClass(), availabilityDefinition, ruleDefinition).isAvailable(items);
81      }
82  }