View Javadoc
1   /**
2    * This file Copyright (c) 2015-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.availability;
35  
36  import info.magnolia.config.registry.DefinitionProvider;
37  import info.magnolia.config.registry.Registry;
38  import info.magnolia.config.registry.RegistryFacade;
39  import info.magnolia.jcr.util.NodeUtil;
40  import info.magnolia.jcr.util.SessionUtil;
41  import info.magnolia.ui.api.availability.AbstractAvailabilityRule;
42  import info.magnolia.ui.vaadin.integration.jcr.JcrItemId;
43  import info.magnolia.ui.vaadin.integration.jcr.JcrPropertyItemId;
44  
45  import java.util.Collection;
46  
47  import javax.inject.Inject;
48  import javax.jcr.Node;
49  
50  import org.slf4j.Logger;
51  import org.slf4j.LoggerFactory;
52  
53  /**
54   * This returns {@code true} if the item has {@link DefinitionProvider}.
55   */
56  public class IsDefinitionRule extends AbstractAvailabilityRule {
57  
58      private static final Logger log = LoggerFactory.getLogger(IsDefinitionRule.class);
59  
60      private final Collection<Registry> registries;
61  
62      @Inject
63      public IsDefinitionRule(RegistryFacade registryFacade) {
64          this.registries = registryFacade.all();
65      }
66  
67      @Override
68      protected boolean isAvailableForItem(Object itemId) {
69          if (itemId instanceof JcrItemId && !(itemId instanceof JcrPropertyItemId)) {
70              JcrItemId jcrItemId = (JcrItemId) itemId;
71              Node node = SessionUtil.getNodeByIdentifier(jcrItemId.getWorkspace(), jcrItemId.getUuid());
72              if (node != null) {
73                  try {
74                      String nodePath = node.getPath();
75                      return hasDefinitionFor(nodePath);
76                  } catch (Exception e) {
77                      log.warn("Error evaluating availability for node [{}], returning false: {}", NodeUtil.getPathIfPossible(node), e.getMessage());
78                  }
79              }
80          }
81          return false;
82      }
83  
84      @SuppressWarnings("unchecked")
85      private boolean hasDefinitionFor(String nodePath) {
86          // We're doing this stuff in a sub-optimal way unless the issue MAGNOLIA-6086 is fixed
87          for (Registry registry : registries) {
88              Collection<DefinitionProvider> providers = registry.getAllProviders();
89              for (DefinitionProvider provider : providers) {
90                  if (provider.getMetadata().getLocation().equals(nodePath)) {
91                      return true;
92                  }
93              }
94          }
95          return false;
96      }
97  }