View Javadoc

1   /**
2    * This file Copyright (c) 2009-2011 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.sites;
35  
36  import info.magnolia.context.MgnlContext;
37  import info.magnolia.jcr.util.MetaDataUtil;
38  import info.magnolia.module.templatingkit.templates.category.TemplateCategory;
39  import info.magnolia.module.templatingkit.templates.category.TemplateCategoryUtil;
40  import info.magnolia.module.templatingkit.templates.pages.STKPage;
41  import info.magnolia.repository.RepositoryConstants;
42  
43  import java.util.Collection;
44  import java.util.LinkedHashMap;
45  import java.util.Map;
46  
47  import javax.jcr.Node;
48  import javax.jcr.RepositoryException;
49  import javax.jcr.Workspace;
50  
51  import org.apache.commons.collections.CollectionUtils;
52  import org.slf4j.Logger;
53  import org.slf4j.LoggerFactory;
54  
55  
56  /**
57   * Wrapper class containing the list of available templates.
58   * It contains also the hierarchy of content for site creation:
59   * Root can only be Home or functional, can not add a Root to a Root, .....
60   *
61   * @version $Id$
62   */
63  public class TemplateAvailability {
64  
65      private static final Logger log = LoggerFactory.getLogger(TemplateAvailability.class);
66  
67      private Map<String, TemplateConfig> templates = new LinkedHashMap<String, TemplateConfig>();
68  
69      public Map<String, TemplateConfig> getTemplates() {
70          return this.templates;
71      }
72  
73      public void setTemplates(Map<String, TemplateConfig> availableTemplates) {
74          this.templates = availableTemplates;
75      }
76  
77      public void addTemplate(String name, TemplateConfig templateConfig) {
78          templates.put(name, templateConfig);
79      }
80  
81      public boolean isAvailable(Node node, STKPage template) {
82  
83          Workspace workspace;
84          try {
85              workspace = node.getSession().getWorkspace();
86              if(!RepositoryConstants.WEBSITE.equals(workspace.getName())){
87                  return false;
88              }
89          } catch (RepositoryException e) {
90              log.error("Not able to access the Node's session or workspace.", e);
91              return false;
92          }
93  
94  
95          if(!getTemplates().containsKey(template.getName())){
96              return false;
97          }
98  
99          TemplateConfig templateConfig = getTemplates().get(template.getName());
100 
101         // check roles
102         final Collection<String> roles = templateConfig.getRoles();
103         if(!roles.isEmpty()){
104             if(!CollectionUtils.containsAny(MgnlContext.getUser().getAllRoles(), roles)){
105                 return false;
106             }
107         }
108 
109         try {
110             // only home or functional can be the root node
111             final String category = template.getCategory();
112             if(node.getDepth() == 1){
113                 return category.equals(TemplateCategory.HOME) || category.equals(TemplateCategory.FUNCTIONAL);
114             }
115             // section and functional pages are structural pages
116             final String parentTemplateCategory = TemplateCategoryUtil.getTemplateCategory(node.getParent());
117             //if home category was already used it should be no longer available
118             if(category.equals(TemplateCategory.HOME) && TemplateCategoryUtil.findParentWithTemplateCategory(node, TemplateCategory.HOME) != null){
119                 return false;
120             }
121             if(category.equals(TemplateCategory.SECTION) || category.equals(TemplateCategory.HOME) || category.equals(TemplateCategory.FUNCTIONAL)){
122                 return parentTemplateCategory.equals(TemplateCategory.HOME) || parentTemplateCategory.equals(TemplateCategory.SECTION) || parentTemplateCategory.equals(TemplateCategory.FEATURE) || parentTemplateCategory.equals(TemplateCategory.FUNCTIONAL);
123             }
124             // only section pages can have content
125             if(category.equals(TemplateCategory.CONTENT)){
126                 return parentTemplateCategory.equals(TemplateCategory.SECTION) || parentTemplateCategory.equals(TemplateCategory.CONTENT) || parentTemplateCategory.equals(TemplateCategory.FEATURE) || parentTemplateCategory.equals(TemplateCategory.FUNCTIONAL);
127             }
128             if(category.equals(TemplateCategory.FEATURE)){
129                 if("form".equals(template.getSubcategory())){
130                     //stkFormStep is available only as child of form
131                     if("stkFormStep".equals(template.getName())) {
132                         return node.getParent() != null && MetaDataUtil.getTemplate(node.getParent()).endsWith("stkForm");
133                     }
134                 }
135                 return true;
136             }
137         }
138         catch (RepositoryException e) {
139             throw new IllegalStateException("Can't verify availability of the template", e);
140         }
141         return false;
142     }
143 }