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.admincentral.shellapp.pulse.task.action.availability;
35
36 import info.magnolia.context.Context;
37 import info.magnolia.context.MgnlContext;
38 import info.magnolia.objectfactory.Components;
39 import info.magnolia.task.Task;
40 import info.magnolia.task.TasksManager;
41 import info.magnolia.ui.api.availability.AbstractAvailabilityRule;
42 import info.magnolia.ui.vaadin.integration.NullItem;
43
44 import javax.inject.Inject;
45
46 import org.slf4j.Logger;
47 import org.slf4j.LoggerFactory;
48
49 /**
50 * Availability rule used for {@link Task task} related actions. Based on the {@link TaskAvailabilityRuleDefinition definition}
51 * the following criteria normally applies:
52 * <ul>
53 * <li>{@link Task.Status status} of the considered task matches the one configured in definition</li>
54 * <li>task's actor id matches the current user or definition claims the action should be available not for assignee only (see {@link TaskAvailabilityRuleDefinition#isAssignee})</li>
55 * </ul>
56 */
57 public class TaskAvailabilityRule extends AbstractAvailabilityRule {
58
59 private static final Logger log = LoggerFactory.getLogger(TaskAvailabilityRule.class);
60
61 private final TaskAvailabilityRuleDefinition definition;
62 private final TasksManager tasksManager;
63 private final Context context;
64
65 /**
66 * @deprecated since 5.4.3, use {@link TaskAvailabilityRule#TaskAvailabilityRule(TaskAvailabilityRuleDefinition, TasksManager, Context)} instead.
67 */
68 @Deprecated
69 public TaskAvailabilityRule(TaskAvailabilityRuleDefinition definition) {
70 this(definition, Components.getComponent(TasksManager.class), MgnlContext.getInstance());
71 }
72
73 @Inject
74 public TaskAvailabilityRule(final TaskAvailabilityRuleDefinition definition, final TasksManager tasksManager, Context context) {
75 this.definition = definition;
76 this.tasksManager = tasksManager;
77 this.context = context;
78 }
79
80 @Override
81 public final boolean isAvailableForItem(Object itemId) {
82 if (itemId == null) {
83 log.warn("Got a null task. Availability rule will return false");
84 return false;
85 }
86
87 if (itemId instanceof NullItem) {
88 return false;
89 }
90
91 Task task = (itemId instanceof Task) ? (Task) itemId : tasksManager.getTaskById(itemId.toString());
92
93 if (task == null) {
94 return false;
95 }
96
97 boolean statusMatches = definition.getStatus().stream()
98 .anyMatch(status -> status.equals(task.getStatus()));
99
100 return statusMatches && isVisibleToUser(task);
101 }
102
103 protected boolean isVisibleToUser(Task task) {
104 return !definition.isAssignee() || context.getUser().getName().equals(task.getActorId());
105 }
106 }