View Javadoc

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