View Javadoc
1   /**
2    * This file Copyright (c) 2017-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;
35  
36  import info.magnolia.registry.RegistrationException;
37  import info.magnolia.task.Task;
38  import info.magnolia.task.definition.TaskDefinition;
39  import info.magnolia.task.definition.registry.TaskDefinitionRegistry;
40  import info.magnolia.ui.api.ioc.AdmincentralScoped;
41  
42  import java.text.MessageFormat;
43  
44  import javax.inject.Inject;
45  
46  import org.apache.commons.lang3.BooleanUtils;
47  import org.apache.commons.lang3.StringUtils;
48  import org.slf4j.Logger;
49  import org.slf4j.LoggerFactory;
50  
51  /**
52   * A helper class to determine some task specific properties.
53   */
54  @AdmincentralScoped
55  public class TaskTypeHelper {
56  
57      private static final Logger log = LoggerFactory.getLogger(TaskTypeHelper.class);
58  
59      private TaskDefinitionRegistry taskDefinitionRegistry;
60  
61      @Inject
62      public TaskTypeHelper(TaskDefinitionRegistry taskDefinitionRegistry) {
63          this.taskDefinitionRegistry = taskDefinitionRegistry;
64      }
65  
66      /**
67       * Depending on the task type returns its title. Default strategy gets the title from {@link TaskDefinition#getTitle()}.
68       */
69      public String getTitle(Task task) {
70  
71          String title = task.getName();
72  
73          if(title == null) {
74              return null;
75          }
76  
77          try {
78              TaskDefinition definition = taskDefinitionRegistry.get(task.getName());
79              if (definition != null) {
80                  title = definition.getTitle();
81                  // this logic can only be hardcoded as long as Task itself won't expose a getTitle() method finally delegating to
82                  // the task itself how to determine its title.
83                  if("publish".equals(task.getName())) {
84                      boolean isDeletion = BooleanUtils.toBooleanDefaultIfNull((Boolean) task.getContent().get("isDeletion"), false);
85                      title = MessageFormat.format(title, BooleanUtils.toInteger(isDeletion));
86                  }
87              }
88          } catch (RegistrationException e) {
89              log.error("Could not get task definition for {}.", task.getName(), e);
90          }
91          String comment = (StringUtils.isNotEmpty(task.getComment())) ? "|" + task.getComment() : "";
92          return title + comment;
93      }
94  }