View Javadoc
1   /**
2    * This file Copyright (c) 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.task.app.view.column;
35  
36  import info.magnolia.i18nsystem.SimpleTranslator;
37  import info.magnolia.icons.MagnoliaIcons;
38  import info.magnolia.registry.RegistrationException;
39  import info.magnolia.task.Task;
40  import info.magnolia.task.definition.registry.TaskDefinitionRegistry;
41  import info.magnolia.ui.contentapp.configuration.column.ConfiguredColumnDefinition;
42  
43  import java.text.MessageFormat;
44  
45  import org.apache.commons.lang3.BooleanUtils;
46  import org.apache.commons.lang3.StringUtils;
47  import org.apache.commons.text.StringEscapeUtils;
48  import org.jsoup.Jsoup;
49  import org.jsoup.safety.Whitelist;
50  import org.slf4j.Logger;
51  import org.slf4j.LoggerFactory;
52  
53  import com.vaadin.data.ValueProvider;
54  import com.vaadin.ui.renderers.AbstractRenderer;
55  import com.vaadin.ui.renderers.HtmlRenderer;
56  
57  import lombok.AllArgsConstructor;
58  
59  /**
60   * Column definition showing combined task title and comment.
61   */
62  public class TaskDescriptionColumnDefinition extends ConfiguredColumnDefinition {
63  
64      private static final Logger log = LoggerFactory.getLogger(TaskDescriptionColumnDefinition.class);
65      public static final double MAX_TASK_DESC_WIDTH = 300.0;
66  
67      @Override
68      public Class<? extends AbstractRenderer> getRenderer() {
69          return HtmlRenderer.class;
70      }
71  
72      @Override
73      public Class<? extends ValueProvider> getValueProvider() {
74          return TaskTextValueProvider.class;
75      }
76  
77      @Override
78      public Double getLargeContentColumnWidth() {
79          return MAX_TASK_DESC_WIDTH;
80      }
81  
82      /**
83       * Provider for text value column.
84       */
85      @AllArgsConstructor
86      public class TaskTextValueProvider implements ValueProvider<Task, String> {
87  
88          private final TaskDefinitionRegistry taskDefinitionRegistry;
89          private final SimpleTranslator translator;
90  
91          @Override
92          public String apply(Task task) {
93  
94              String title = getTitle(task);
95              if (StringUtils.isNotBlank(title)) {
96  
97                  // prepare title and comment texts
98                  String escapedTitle = StringEscapeUtils.escapeXml11(title);
99                  String comment = translator.translate("tasks.nocomment");
100                 if (StringUtils.isNotEmpty(task.getComment())) {
101                     comment = StringEscapeUtils.escapeXml11(task.getComment());
102                 }
103 
104                 return "<div style='height:35px; padding-top:10px; vertical-align: middle'>" + MagnoliaIcons.WORK_ITEM.getHtml() +
105                         "</div>" +
106                         "<div style='padding-left:20px; vertical-align: middle; overflow: hidden;'>" +
107                         "<div style='line-height:normal; overflow: hidden; text-overflow: ellipsis;'>" + Jsoup.clean(escapedTitle, Whitelist.simpleText()) + "</div>" +
108                         "<div style='font-size:12px; line-height:normal; overflow: hidden; text-overflow: ellipsis;'>" + Jsoup.clean(comment, Whitelist.simpleText()) + "</div>" +
109                         "</div>";
110             }
111             return "";
112         }
113 
114         public String getTitle(Task task) {
115 
116             String title = task.getName();
117 
118             if (title == null) {
119                 return null;
120             }
121 
122             try {
123                 title = taskDefinitionRegistry.get(task.getName()).getTitle();
124                 // this logic can only be hardcoded as long as Task itself won't expose a getTitle() method finally delegating to
125                 // the task itself how to determine its title.
126                 if ("publish".equals(task.getName())) {
127                     boolean isDeletion = BooleanUtils.toBooleanDefaultIfNull((Boolean) task.getContent().get("isDeletion"), false);
128                     title = MessageFormat.format(title, BooleanUtils.toInteger(isDeletion));
129                 }
130             } catch (RegistrationException e) {
131                 log.error("Could not get task definition for {}.", task.getName(), e);
132             }
133             return title;
134         }
135     }
136 }