View Javadoc
1   /**
2    * This file Copyright (c) 2008-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.module.templatingkit.templates;
35  
36  import info.magnolia.module.resources.ResourcesModule;
37  import info.magnolia.module.resources.templates.ResourceTemplate;
38  import info.magnolia.module.templatingkit.functions.STKTemplatingFunctions;
39  import info.magnolia.module.templatingkit.sites.Site;
40  import info.magnolia.module.templatingkit.templates.pages.STKPage;
41  import info.magnolia.objectfactory.Components;
42  import info.magnolia.rendering.template.TemplateAvailability;
43  import info.magnolia.rendering.template.TemplateDefinition;
44  
45  import javax.jcr.Node;
46  import javax.jcr.RepositoryException;
47  
48  import org.slf4j.Logger;
49  import org.slf4j.LoggerFactory;
50  
51  /**
52   * Template availability for STK that takes settings from the site configuration into account.
53   */
54  public class STKTemplateAvailability implements TemplateAvailability {
55  
56      private static final Logger log = LoggerFactory.getLogger(STKTemplateAvailability.class);
57  
58      @Override
59      public boolean isAvailable(Node node, TemplateDefinition templateDefinition) {
60  
61          final String workspaceName = getNodeWorkspaceName(node);
62  
63          if (ResourcesModule.DEFAULT_WORKSPACE.equals(workspaceName) && !(templateDefinition instanceof ResourceTemplate)) {
64              return false;
65          }
66  
67          if (!(templateDefinition instanceof STKPage)) {
68              return true;
69          }
70  
71          Site site = Components.getComponent(STKTemplatingFunctions.class).site(node);
72  
73          if (site == null || site.getTemplates() == null || site.getTemplates().getAvailability() == null) {
74              // don't fail with NPE just because there is no site defined or
75              // there are no templates defined for this particular site
76              return false;
77          }
78  
79          return site.getTemplates().getAvailability().isAvailable(node, (STKPage) templateDefinition);
80      }
81  
82      private String getNodeWorkspaceName(final Node node) {
83          try {
84              return node.getSession().getWorkspace().getName();
85          } catch (RepositoryException e) {
86              log.error("An error occurred while trying to access session for jcr node {}", node, e);
87              return null;
88          }
89      }
90  }