/**
    * This file Copyright (c) 2015 Magnolia International
    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
    *
    *
    * This file is dual-licensed under both the Magnolia
    * Network Agreement and the GNU General Public License.
    * You may elect to use one or the other of these licenses.
    *
   * This file is distributed in the hope that it will be
   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
   * implied warranty of MERCHANTABILITY or FITNESS FOR A
   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
   * Redistribution, except as permitted by whichever of the GPL
   * or MNA you select, is prohibited.
   *
   * 1. For the GPL license (GPL), you can redistribute and/or
   * modify this file under the terms of the GNU General
   * Public License, Version 3, as published by the Free Software
   * Foundation.  You should have received a copy of the GNU
   * General Public License, Version 3 along with this program;
   * if not, write to the Free Software Foundation, Inc., 51
   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   *
   * 2. For the Magnolia Network Agreement (MNA), this file
   * and the accompanying materials are made available under the
   * terms of the MNA which accompanies this distribution, and
   * is available at http://www.magnolia-cms.com/mna.html
   *
   * Any modifications to this file must keep this entire header
   * intact.
   *
   */
  package info.magnolia.cache.browser.app.action;
  
  import info.magnolia.i18nsystem.SimpleTranslator;
  import info.magnolia.ui.api.action.AbstractAction;
  import info.magnolia.ui.api.action.ActionDefinition;
  import info.magnolia.ui.api.action.ActionExecutionException;
  import info.magnolia.ui.api.context.UiContext;
  import info.magnolia.ui.vaadin.overlay.MessageStyleTypeEnum;
  
  import java.util.Collections;
  import java.util.LinkedHashMap;
  import java.util.List;
  import java.util.Map;
  
  import org.apache.commons.lang3.StringUtils;
  
  import com.vaadin.data.Item;
  
  /**
   * Base class that can work over multiple {@link Item}s.
   *
   * @param <D> Definition
   */
  public abstract class AbstractMultiItemAction<D extends ActionDefinition> extends AbstractAction<D> {
  
      private final D definition;
      private final List<Item> relatedItems;
      private final UiContext uiContext;
      private final SimpleTranslator i18n;
  
      public AbstractMultiItemAction(D definition, Item relatedItem, UiContext uiContext, SimpleTranslator i18n) {
          this(definition, Collections.singletonList(relatedItem), uiContext, i18n);
      }
  
      public AbstractMultiItemAction(D definition, List<Item> relatedItems, UiContext uiContext, SimpleTranslator i18n) {
          super(definition);
          this.definition = definition;
          this.relatedItems = relatedItems;
          this.uiContext = uiContext;
          this.i18n = i18n;
      }
  
      @Override
      public void execute() throws ActionExecutionException {
          Map<Item, String> failedItems = new LinkedHashMap<>();
          for (Item item : getItems()) {
              try {
                  executeOnItem(item);
              } catch (Exception e) {
                  failedItems.put(item, e.getMessage());
              }
          }
          if (failedItems.size() > 0 && StringUtils.isNotBlank(getFailureMessageKey())) {
              getUiContext().openNotification(MessageStyleTypeEnum.ERROR, false, getTranslator().translate(getFailureMessageKey(), formatFailedItemsForMessage(failedItems)));
          } else if (StringUtils.isNotBlank(getSuccessMessageKey())) {
              getUiContext().openNotification(MessageStyleTypeEnum.INFO, true, getTranslator().translate(getSuccessMessageKey()));
          }
      }
  
      protected abstract void executeOnItem(Item item) throws Exception;
  
      protected abstract String getSuccessMessageKey();
  
      protected abstract String getFailureMessageKey();
  
      protected abstract String itemToString(Item item);
 
     protected String formatFailedItemsForMessage(Map<Item, String> failedItems) {
         StringBuilder sb = new StringBuilder();
         sb.append("<ul>");
         for (Item item : failedItems.keySet()) {
             String error = failedItems.get(item);
             sb.append("<li>").append("<b>");
             sb.append(itemToString(item)).append("</b>: ").append(error);
             sb.append("</li>");
         }
         sb.append("</ul>");
         return sb.toString();
     }
 
     @Override
     public D getDefinition() {
         return definition;
     }
 
     public List<Item> getItems() {
         return relatedItems;
     }
 
     public UiContext getUiContext() {
         return uiContext;
     }
 
     public SimpleTranslator getTranslator() {
         return i18n;
     }
 }