1 /**
2 * This file Copyright (c) 2014-2018 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.ui.framework.setup;
35
36 import info.magnolia.jcr.util.NodeTypes;
37 import info.magnolia.module.InstallContext;
38 import info.magnolia.module.delta.AbstractRepositoryTask;
39 import info.magnolia.module.delta.TaskExecutionException;
40
41 import javax.jcr.Node;
42 import javax.jcr.RepositoryException;
43
44 import org.slf4j.Logger;
45 import org.slf4j.LoggerFactory;
46
47 /**
48 * This task updates a given set of actions which need write permission to be executed, so that they are disabled if current user doesn't have such permission.
49 * <p>
50 * Concretely we set the additional action availability {@link info.magnolia.ui.api.availability.AvailabilityDefinition#isWritePermissionRequired() writePermissionRequired} criterion to <code>true</code> on the given actions.
51 */
52 public class SetWritePermissionForActionsTask extends AbstractRepositoryTask {
53
54 private static final Logger log = LoggerFactory.getLogger(SetWritePermissionForActionsTask.class);
55
56 private final String actionsPath;
57 private final String[] actionNames;
58
59 /**
60 * Instantiate a new update task to set write permission for a given set of actions.
61 *
62 * @param actionsPath an absolute config path to the <i>actions</i> node where the given actions should be updated
63 * @param actionNames an array of action node names relative to <code>actionsPath</code> which require write permission
64 */
65 public SetWritePermissionForActionsTask(String actionsPath, String... actionNames) {
66 super("Update actions which need write permission to be executed", "This task sets the availability 'writePermissionRequired' criterion to true on a set of actions at " + actionsPath + ".");
67 this.actionsPath = actionsPath;
68 this.actionNames = actionNames;
69 }
70
71 @Override
72 protected void doExecute(InstallContext ctx) throws RepositoryException, TaskExecutionException {
73
74 // e.g. /modules/pages/apps/pages/subApps/browser/actions
75 if (ctx.getConfigJCRSession().nodeExists(actionsPath)) {
76 Node actions = ctx.getConfigJCRSession().getNode(actionsPath);
77
78 for (String actionName : actionNames) {
79
80 if (actions.hasNode(actionName)) {
81 Node action = actions.getNode(actionName);
82
83 // configure availability if not present already
84 if (!action.hasNode("availability")) {
85 log.warn("Action {} has no availability configured, adding one now. Please check that default availability for root, nodes, properties or multiple selection is still accurate.", actionName);
86 action.addNode("availability", NodeTypes.ContentNode.NAME);
87 }
88
89 // set writePermissionRequired on availability
90 Node availability = action.getNode("availability");
91 availability.setProperty("writePermissionRequired", true);
92
93 } else {
94 log.warn("Action {} could not be found, permission checks will not be added.", actionName);
95 }
96 }
97 } else {
98 log.warn("Could not find actions at path {}, permission checks will not be added.", actionsPath);
99 }
100 }
101
102 }