View Javadoc
1   /**
2    * This file Copyright (c) 2013-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.module.templatingkit.setup.for2_7;
35  
36  import info.magnolia.module.InstallContext;
37  import info.magnolia.module.delta.ArrayDelegateTask;
38  import info.magnolia.module.delta.NodeExistsDelegateTask;
39  import info.magnolia.module.delta.OrderNodeAfterTask;
40  import info.magnolia.module.delta.OrderNodeToFirstPositionTask;
41  import info.magnolia.module.delta.TaskExecutionException;
42  import info.magnolia.repository.RepositoryConstants;
43  
44  /**
45   * This task ensures proper ordering of the STK apps (those added by {@link info.magnolia.module.templatingkit.setup.STKLegacyUiToMagnolia5AppProviderTask}) in the STK group of the applauncher.
46   * Since magnolia 5.2, inplace-templating and resources modules bootstrap their respective app in STK group on their own, i.e. before STK,
47   * hence resulting in STK apps being incorrectly positioned after these two.<br>
48   * Additionally, channels and dialog apps have now been swapped.<br>
49   */
50  public class ReorderSTKAppsTask extends NodeExistsDelegateTask {
51  
52      private static final ArrayDelegateTask ORDER_STK_APPS_TASK = new ArrayDelegateTask("Order STK apps in applauncher",
53              new OrderNodeToFirstPositionTask("1: stkSiteApp", "This task orders Site definitions as first in STK app group.", RepositoryConstants.CONFIG, "modules/ui-admincentral/config/appLauncherLayout/groups/stk/apps/stkSiteApp"),
54              new OrderNodeAfterTask("2: stkThemesApp", "This task orders Themes after Site definitions in STK app group.", RepositoryConstants.CONFIG, "/modules/ui-admincentral/config/appLauncherLayout/groups/stk/apps/stkThemesApp", "stkSiteApp"),
55              new OrderNodeAfterTask("3: stkChannelsApp", "This task orders Channels after Themes in STK app group.", RepositoryConstants.CONFIG, "/modules/ui-admincentral/config/appLauncherLayout/groups/stk/apps/stkChannelsApp", "stkThemesApp"),
56              new OrderNodeAfterTask("4: stkDialogsApp", "This task orders Dialogs after Channels in STK app group.", RepositoryConstants.CONFIG, "/modules/ui-admincentral/config/appLauncherLayout/groups/stk/apps/stkDialogsApp", "stkChannelsApp"),
57              new OrderNodeAfterTask("5: stkTemplateDefsApp", "This task orders Template defs after Dialogs in STK app group.", RepositoryConstants.CONFIG, "/modules/ui-admincentral/config/appLauncherLayout/groups/stk/apps/stkTemplateDefsApp", "stkDialogsApp")
58      );
59  
60      public ReorderSTKAppsTask() {
61          super("Order STK apps in applauncher", "This task ensures proper ordering of the STK apps in the STK group of the applauncher.",
62                  RepositoryConstants.CONFIG, "/modules/ui-admincentral/config/appLauncherLayout/groups/stk/apps/stkSiteApp", ORDER_STK_APPS_TASK);
63      }
64  
65      @Override
66      public void execute(InstallContext ctx) throws TaskExecutionException {
67          super.execute(ctx);
68      }
69  
70  }