View Javadoc
1   /**
2    * This file Copyright (c) 2019 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.commands.CommandsManager;
37  import info.magnolia.context.Context;
38  import info.magnolia.ui.ValueContext;
39  import info.magnolia.ui.api.action.AbstractAction;
40  import info.magnolia.ui.api.action.CommandActionDefinition;
41  import info.magnolia.ui.contentapp.async.AsyncActionExecutor;
42  
43  import java.util.Collection;
44  import java.util.HashMap;
45  import java.util.Map;
46  import java.util.stream.Collectors;
47  
48  import javax.inject.Inject;
49  
50  import com.machinezoo.noexception.Exceptions;
51  
52  /**
53   * Base action supporting execution of commands.
54   *
55   * @param <T> type of the item.
56   * @param <D> {@link info.magnolia.ui.api.action.CommandActionDefinition}.
57   */
58  public class CommandAction<T, D extends CommandActionDefinition> extends AbstractAction<D> {
59  
60      private final CommandsManager commandsManager;
61      private final ValueContext<T> valueContext;
62      private final Context context;
63      private final AsyncActionExecutor asyncActionExecutor;
64  
65      @Inject
66      public CommandAction(D definition, CommandsManager commandsManager, ValueContext<T> valueContext, Context context, AsyncActionExecutor asyncActionExecutor) {
67          super(definition);
68          this.commandsManager = commandsManager;
69          this.valueContext = valueContext;
70          this.context = context;
71          this.asyncActionExecutor = asyncActionExecutor;
72      }
73  
74      @Override
75      public void execute() {
76          Collection<T> items = resolveTargetItems();
77          if (getDefinition().isAsynchronous()) {
78              executeAsynchronously(items);
79          } else {
80              executeSynchronously(items);
81          }
82      }
83  
84      protected Collection<T> resolveTargetItems() {
85          return valueContext.get().collect(Collectors.toList());
86      }
87  
88      protected Map<String, Object> buildParams(T item) {
89          Map<String, Object> params = new HashMap<>(getDefinition().getParams());
90          params.put(Context.ATTRIBUTE_USERNAME, context.getUser().getName());
91          return params;
92      }
93  
94      protected ValueContext<T> getValueContext() {
95          return valueContext;
96      }
97  
98      private void executeAsynchronously(Collection<T> items) {
99          asyncActionExecutor.execute(AsyncActionExecutor.AsyncAction.builder()
100                 .action(() -> executeSynchronously(items))
101                 .delaySeconds(getDefinition().getDelay())
102                 .timeToWaitMilliseconds(getDefinition().getTimeToWait())
103                 .description(String.format(getDefinition().getDescription(), items))
104                 .successMessage(getDefinition().isNotifyUser() ? getDefinition().getSuccessMessage() : null)
105                 .failureMessage(getDefinition().getFailureMessage())
106                 .build()
107         );
108     }
109 
110     private void executeSynchronously(Collection<T> items) {
111         items.forEach(Exceptions.wrap().consumer(
112                 item -> commandsManager.executeCommand(getDefinition().getCatalog(), getDefinition().getCommand(), buildParams(item))
113         ));
114     }
115 }