1 /**
2 * This file Copyright (c) 2021 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.module.InstallContext;
37
38 /**
39 * A Task which delegates depending on whether a module is registered.
40 *
41 * <p>As opposed to {@link IsModuleInstalledOrRegistered}, it allows to perform uninstallation tasks
42 * if a module is no longer bundled (but its module node is still present).
43 */
44 public class IsModuleRegistered extends ConditionalDelegateTask {
45
46 private static final String MODULES_PATH = "/modules";
47 private final String moduleName;
48
49 public IsModuleRegistered(String taskName, String moduleName, Task ifTrue) {
50 this(taskName, moduleName, ifTrue, null);
51 }
52
53 public IsModuleRegistered(String taskName, String moduleName, Taskef="../../../../info/magnolia/module/delta/Task.html#Task">Task ifTrue, Task ifFalse) {
54 this(taskName, String.format("Execute task [%s] if module '%s' is registered or task [%s] if not.",
55 ifTrue == null ? DO_NOTHING : ifTrue.getDescription(),
56 moduleName,
57 ifFalse == null ? DO_NOTHING : ifFalse.getDescription()),
58 moduleName, ifTrue, ifFalse);
59 }
60
61 public IsModuleRegistered(String taskName, String taskDescription, String moduleName, Task ifTrue) {
62 this(taskName, taskDescription, moduleName, ifTrue, null);
63 }
64
65 public IsModuleRegistered(String taskName, String taskDescription, String moduleName, Taskef="../../../../info/magnolia/module/delta/Task.html#Task">Task ifTrue, Task ifFalse) {
66 super(taskName, taskDescription, ifTrue, ifFalse);
67 this.moduleName = moduleName;
68 }
69
70 @Override
71 protected boolean condition(InstallContext ctx) {
72 return ctx.isModuleRegistered(moduleName);
73 }
74 }