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.ui.contentapp.action;
35  
36  import info.magnolia.i18nsystem.SimpleTranslator;
37  import info.magnolia.i18nsystem.util.MessageFormatterUtils;
38  import info.magnolia.ui.api.action.AbstractAction;
39  import info.magnolia.ui.api.action.ActionExecutionException;
40  import info.magnolia.ui.api.context.UiContext;
41  import info.magnolia.ui.api.overlay.ConfirmationCallback;
42  import info.magnolia.ui.contentapp.browser.ActionExecutionService;
43  import info.magnolia.ui.ValueContext;
44  import info.magnolia.ui.vaadin.overlay.MessageStyleTypeEnum;
45  
46  import java.util.Collection;
47  import java.util.stream.Stream;
48  
49  import javax.inject.Inject;
50  
51  import org.slf4j.Logger;
52  import org.slf4j.LoggerFactory;
53  
54  import lombok.AccessLevel;
55  import lombok.Getter;
56  
57  /**
58   * Configurable confirmation action. Can be used to intercept the actual action with user feedback.
59   * Allows configuration of a success action and a cancel action.
60   *
61   * @param <D> {@link ConfirmationActionDefinition}.
62   * @param <T> item type.
63   */
64  @Getter(AccessLevel.PROTECTED)
65  public class ConfirmationAction<D extends ConfirmationActionDefinition, T> extends AbstractAction<D> {
66  
67      private static final Logger log = LoggerFactory.getLogger(ConfirmationAction.class);
68  
69      private final SimpleTranslator simpleTranslator;
70      private final ValueContext<T> valueContext;
71      private final UiContext uiContext;
72      private final ActionExecutionService actionExecutionService;
73  
74      @Inject
75      public ConfirmationAction(D definition, UiContext uiContext, ActionExecutionService actionExecutionService, SimpleTranslator i18n, ValueContext valueContext) {
76          super(definition);
77          this.valueContext = valueContext;
78          this.uiContext = uiContext;
79          this.actionExecutionService = actionExecutionService;
80          this.simpleTranslator = i18n;
81      }
82  
83      @Override
84      public void execute() throws ActionExecutionException {
85          try {
86              uiContext.openConfirmation(
87                      MessageStyleTypeEnum.WARNING, getConfirmationHeader(), getConfirmationMessage(), getDefinition().getProceedLabel(), getDefinition().getCancelLabel(), getDefinition().isDefaultCancel(),
88                      new ConfirmationCallback() {
89                          @Override
90                          public void onSuccess() {
91                              if (getDefinition().getSuccessActionName() != null) {
92                                  actionExecutionService.executeAction(getDefinition().getSuccessActionName(), valueContext.current().nullableValue());
93                              }
94                          }
95  
96                          @Override
97                          public void onCancel() {
98                              if (getDefinition().getCancelActionName() != null) {
99                                  actionExecutionService.executeAction(getDefinition().getCancelActionName(), valueContext.current().nullableValue());
100                             }
101                         }
102                     });
103         } catch (Exception e) {
104             throw new ActionExecutionException(e);
105         }
106     }
107 
108     protected String getConfirmationHeader() {
109         return formatMessage(getDefinition().getConfirmationHeader());
110     }
111 
112     protected String getConfirmationMessage() {
113         return formatMessage(getDefinition().getConfirmationMessage());
114     }
115 
116     private String formatMessage(final String message) {
117         long howMany = valueContext.current().value().map(Collection::stream).map(Stream::count).orElse(0L);
118         return MessageFormatterUtils.format(message, howMany, howMany);
119     }
120 }