View Javadoc

1   /**
2    * This file Copyright (c) 2007-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.admininterface.setup.for4_0;
35  
36  import info.magnolia.cms.beans.config.ContentRepository;
37  import info.magnolia.cms.core.Content;
38  import info.magnolia.cms.core.HierarchyManager;
39  import info.magnolia.cms.core.ItemType;
40  import info.magnolia.cms.util.NodeDataUtil;
41  import info.magnolia.cms.util.QueryUtil;
42  import info.magnolia.module.InstallContext;
43  import info.magnolia.module.delta.AbstractRepositoryTask;
44  import info.magnolia.module.delta.TaskExecutionException;
45  import org.apache.commons.lang.StringUtils;
46  
47  import javax.jcr.RepositoryException;
48  import java.util.Collection;
49  import java.util.Iterator;
50  
51  /**
52   * In 4.0 and 4.1, we accidentally overrode the default uri mapping on public instances to the "Quickstart" page,
53   * even if templates were present.
54   * This task simply warns the user if that hasn't been fixed in the meantime.
55   */
56  public class UpdatedDefaultPublicURIWarning extends AbstractRepositoryTask {
57  
58      public UpdatedDefaultPublicURIWarning() {
59          super("Checks the default public URI is correct", "Warns the user if the URI has been changed wrongly.");
60      }
61  
62      protected void doExecute(InstallContext installContext) throws RepositoryException, TaskExecutionException {
63          if (templatesExist() && hasDefaultURI(installContext)) {
64              installContext.warn("Please set the default virtual URI mapping; it was incorrectly reset by a previous update.");
65          }
66      }
67  
68      /**
69       * Check if at least one template is visible in the system.
70       */
71      private boolean templatesExist() {
72          Collection nodeCollection = QueryUtil.query(ContentRepository.CONFIG, "select * from mgnl:content where jcr:path like '/modules/%/templates'");
73          Iterator nodesCollectionIt = nodeCollection.iterator();
74          while (nodesCollectionIt.hasNext()) {
75              Content templatesNode = (Content) nodesCollectionIt.next();
76              Iterator templatesCollectionIt = templatesNode.getChildren(ItemType.CONTENTNODE).iterator();
77              while (templatesCollectionIt.hasNext()) {
78                  Content template = (Content) templatesCollectionIt.next();
79                  if (NodeDataUtil.getBoolean(template, "visible", false)) {
80                      return true;
81                  }
82              }
83          }
84          return false;
85      }
86  
87      private boolean hasDefaultURI(InstallContext installContext) throws RepositoryException {
88          final String defaultURI = installContext.getCurrentModuleDefinition().getProperty("defaultPublicURI");
89  
90          final String defaultUriMappingPath = "/modules/adminInterface/virtualURIMapping/default/toURI";
91          final HierarchyManager hm = installContext.getConfigHierarchyManager();
92          if (hm.isExist(defaultUriMappingPath)) {
93              final String currentValue = hm.getNodeData(defaultUriMappingPath).getString();
94              if (StringUtils.equals(currentValue, defaultURI)) {
95                  return true;
96              }
97          }
98          return false;
99      }
100 
101 }