View Javadoc

1   /**
2    * This file Copyright (c) 2013 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.delta;
35  
36  import info.magnolia.jcr.util.NodeTypes;
37  import info.magnolia.module.InstallContext;
38  import info.magnolia.repository.RepositoryConstants;
39  
40  import javax.jcr.RepositoryException;
41  import javax.jcr.Session;
42  import javax.jcr.nodetype.NodeDefinition;
43  import javax.jcr.nodetype.NodeType;
44  import javax.jcr.nodetype.NodeTypeManager;
45  
46  import org.slf4j.Logger;
47  import org.slf4j.LoggerFactory;
48  
49  /**
50   * Install condition to verify that Magnolia node types don't allow same name siblings.
51   * The check is performed against the {@link RepositoryConstants#WEBSITE} workspace.
52   */
53  public class NoSameNameSiblingsCondition extends AbstractCondition {
54  
55      private static final Logger log = LoggerFactory.getLogger(NoSameNameSiblingsCondition.class);
56  
57      public static final String[] NODETYPES = new String[] {
58              NodeTypes.Content.NAME,
59              NodeTypes.ContentNode.NAME,
60              NodeTypes.Folder.NAME,
61              NodeTypes.Page.NAME,
62              NodeTypes.Area.NAME,
63              NodeTypes.Component.NAME,
64              NodeTypes.User.NAME,
65              NodeTypes.Role.NAME,
66              NodeTypes.Group.NAME,
67              "mgnl:reserve"
68      };
69  
70      public static final String[] WORKSPACES = new String[] {
71              RepositoryConstants.CONFIG,
72              RepositoryConstants.WEBSITE,
73              RepositoryConstants.USERS,
74              RepositoryConstants.USER_GROUPS,
75              RepositoryConstants.USER_ROLES,
76              RepositoryConstants.VERSION_STORE
77      };
78  
79      public NoSameNameSiblingsCondition() {
80          super("Same name siblings must be not allowed.", "Ensures that same name siblings are not allowed in Magnolia node types.");
81      }
82  
83      @Override
84      public boolean check(InstallContext installContext) {
85  
86          try {
87              for (String workspace : WORKSPACES) {
88                  Session session = installContext.getJCRSession(workspace);
89                  NodeTypeManager ntManager = session.getWorkspace().getNodeTypeManager();
90                  for (String nodetypeName : NODETYPES) {
91                      NodeType nodetype = ntManager.getNodeType(nodetypeName);
92                      for (NodeDefinition def : nodetype.getChildNodeDefinitions()) {
93                          if (def.allowsSameNameSiblings()) {
94                              log.error("Child definition of the [{}] node type in workspace [{}] allows same name siblings.", nodetypeName, workspace);
95                              return false;
96                          }
97                      }
98                  }
99              }
100         } catch (RepositoryException ex) {
101             log.error("Cannot verify that same name siblings are not allowed.", ex);
102             return false;
103         }
104         // everything OK
105         return true;
106     }
107 
108 }