/**
    * This file Copyright (c) 2016-2018 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.security.app.tools;
  
  import info.magnolia.cms.security.AccessDeniedException;
  import info.magnolia.ui.api.context.UiContext;
  import info.magnolia.ui.dialog.formdialog.FormBuilder;
  import info.magnolia.ui.framework.tools.FormToolActionExecutor;
  import info.magnolia.ui.framework.tools.FormToolPresenter;
  import info.magnolia.ui.vaadin.overlay.MessageStyleTypeEnum;
  
  import java.io.Serializable;
  
  import javax.inject.Inject;
  
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  import com.vaadin.v7.data.Container;
  
  /**
   * Base implementation for security tools which help verifying the system's security setup and ACLs.
   */
  public abstract class AbstractSecurityToolPresenter extends FormToolPresenter {
  
      private static final Logger log = LoggerFactory.getLogger(AbstractSecurityToolPresenter.class);
  
      protected static final String VALUE_ID = "value";
      protected static final String TRANSITIVE_ID = "transitive";
  
      protected final UiContext uiContext;
  
      protected Container.Hierarchical container;
  
      @Inject
      public AbstractSecurityToolPresenter(SecurityToolView view, FormBuilder formBuilder, FormToolActionExecutor actionExecutor,
                                           UiContext uiContext) {
          super(view, formBuilder, actionExecutor);
          this.uiContext = uiContext;
      }
  
      @Override
      protected SecurityToolView getView() {
          return (SecurityToolView) super.getView();
      }
  
      public void showResult() {
          try {
              Container.Hierarchical container = buildContainer();
              getView().setDataSource(container);
              if (container == null) {
                  uiContext.openNotification(MessageStyleTypeEnum.ERROR, true, getErrorMessage());
                  return;
              }
          } catch (AccessDeniedException e) {
              log.error("Access denied:" + e.getMessage(), e);
              uiContext.openNotification(MessageStyleTypeEnum.ERROR, true, "Access denied:" + e.getMessage());
          }
      }
  
      protected Object addContainerItem(String itemProperty, String itemValue, Object parentId) {
          Object itemId = container.addItem();
          container.getItem(itemId).getItemProperty(itemProperty).setValue(itemValue);
          container.setParent(itemId, parentId);
          return itemId;
      }
  
      protected abstract Container.Hierarchical buildContainer() throws AccessDeniedException;
 
     protected abstract String getErrorMessage();
 
     /**
      * Base options for tools.
      */
     public static class ViewOption implements Serializable {
         private String name;
 
         public String getName() {
             return name;
         }
 
         public void setName(String name) {
             this.name = name;
         }
     }
 }