View Javadoc

1   /**
2    * This file Copyright (c) 2007-2010 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.setup.for3_6;
35  
36  import info.magnolia.cms.core.Content;
37  import info.magnolia.cms.core.HierarchyManager;
38  import info.magnolia.module.InstallContext;
39  import info.magnolia.module.delta.AbstractTask;
40  import info.magnolia.module.delta.TaskExecutionException;
41  
42  import java.util.Iterator;
43  
44  import javax.jcr.RepositoryException;
45  import javax.jcr.nodetype.NodeType;
46  
47  import org.slf4j.Logger;
48  import org.slf4j.LoggerFactory;
49  
50  
51  /**
52   * Checks nodes for occurrence of mix:versionable supertype.
53   * @author had
54   * @version $Id: $
55   *
56   */
57  public class CheckNodesForMixVersionable extends AbstractTask {
58  
59      private static Logger log = LoggerFactory.getLogger(CheckNodesForMixVersionable.class);
60  
61      public static final String UPDATE_PATH= "server/install/3_6";
62      public static final String CONTENT_CHECK_FLAG = "contentMigrated";
63  
64      public CheckNodesForMixVersionable() {
65          super("Check existing top level nodes", "Checks existing top level nodes for existence of mix:versionable.");
66      }
67  
68      public void execute(InstallContext installContext)
69              throws TaskExecutionException {
70          HierarchyManager hm = installContext.getHierarchyManager("website");
71          try {
72              // fast track for EE users
73              HierarchyManager chm = installContext.getConfigHierarchyManager();
74              if (chm.getRoot().hasContent(CheckNodesForMixVersionable.UPDATE_PATH)) {
75                  Content c = chm.getRoot().getContent(CheckNodesForMixVersionable.UPDATE_PATH);
76                  if (c.hasNodeData(CheckNodesForMixVersionable.CONTENT_CHECK_FLAG) && c.getNodeData(CheckNodesForMixVersionable.CONTENT_CHECK_FLAG).getBoolean()) {
77                      return;
78                  }
79              }
80  
81              Iterator iter = hm.getRoot().getChildren().iterator();
82              while (iter.hasNext()) {
83                  NodeType[] nt = ((Content) iter.next()).getMixinNodeTypes();
84                  for (int i = 0; i < nt.length; i++) {
85                      if ("mix:versionable".equals(nt[i].getName())) {
86                          installContext.warn("There are nodes in your repository that contain unnecessary mix:versionable. Please replace all mix:versionable with mix:referenceable supertype to achieve optimal repository performance. Refer to Magnolia Documentation at http://documentation.magnolia-cms.com/releases/3-6.html for details. An executable is provided for Enterprise Customers.");
87                          return;
88                      }
89                  }
90              }
91          } catch (RepositoryException e) {
92              log.error(e.getMessage(), e);
93              //installContext.error(e.getMessage(), e);
94              throw new TaskExecutionException("Failed to execute content node super type check.", e);
95          }
96      }
97  }