1 /**
2 * This file Copyright (c) 2014-2015 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.resources.app.setup;
35
36 import info.magnolia.jcr.util.NodeTypes;
37 import info.magnolia.jcr.util.NodeUtil;
38 import info.magnolia.module.InstallContext;
39 import info.magnolia.module.delta.AbstractRepositoryTask;
40 import info.magnolia.module.delta.TaskExecutionException;
41
42 import javax.jcr.RepositoryException;
43 import javax.jcr.Session;
44
45 /**
46 * Move and update the resources app configuration.
47 * <p>
48 * Prior to 2.4, the resources app configuration took place under the resources module;
49 * it is now located under the resources-app module, and renamed to resources-legacy.
50 * In fact this pre-existing app is now replaced by a new 'resources' app, which is configured by file.
51 */
52 public class UpdateResourcesAppConfigurationTask extends AbstractRepositoryTask {
53
54 private final static String LEGACY_APP_PARENT_PATH = "/modules/resources/apps";
55 private final static String LEGACY_APP_PATH = LEGACY_APP_PARENT_PATH + "/resources";
56 private final static String NEW_APP_PARENT_PATH = "/modules/resources-app/apps";
57
58 public UpdateResourcesAppConfigurationTask() {
59 super("Migrate Resources App", "Migrate Resources App from resource module to resources-app module.");
60 }
61
62 @Override
63 public void doExecute(InstallContext installContext) throws RepositoryException {
64 Session session = installContext.getConfigJCRSession();
65
66 // move 'dialogs' and 'apps' nodes
67 moveModuleSubNode(session, "dialogs");
68
69 if (session.nodeExists(LEGACY_APP_PATH)) {
70 if (!session.nodeExists(NEW_APP_PARENT_PATH)) {
71 NodeUtil.createPath(session.getRootNode(), NEW_APP_PARENT_PATH, NodeTypes.Content.NAME);
72 }
73 // Move old app to new home and call it 'resources-legacy'
74 session.move(LEGACY_APP_PATH, NEW_APP_PARENT_PATH + "/resources-legacy");
75 // Make sure there are no other apps defined, otherwise do not proceed with install
76 if (session.getNode(LEGACY_APP_PARENT_PATH).hasNodes()) {
77 final String errorMsg = String.format("Was not expecting to find more than one app in '%s'", LEGACY_APP_PARENT_PATH);
78 installContext.error(errorMsg, new TaskExecutionException(errorMsg));
79 } else {
80 session.removeItem(LEGACY_APP_PARENT_PATH);
81 }
82 }
83 }
84
85 private void moveModuleSubNode(Session session, String node) throws RepositoryException {
86 if (session.nodeExists("/modules/resources/" + node)) {
87 session.move("/modules/resources/" + node, "/modules/resources-app/" + node);
88 }
89 }
90 }