/**
    * This file Copyright (c) 2013-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.pages.app.detail.action;
  
  import info.magnolia.config.registry.DefinitionProvider;
  import info.magnolia.context.Context;
  import info.magnolia.i18nsystem.I18nizer;
  import info.magnolia.jcr.util.NodeNameHelper;
  import info.magnolia.jcr.util.NodeTypes;
  import info.magnolia.pages.app.data.NewRenderableNodeWrapper;
  import info.magnolia.pages.app.data.RenderableNodeMetadata;
  import info.magnolia.pages.app.detail.PageEditorStatus;
  import info.magnolia.rendering.template.TemplateDefinition;
  import info.magnolia.rendering.template.registry.TemplateDefinitionRegistry;
  import info.magnolia.ui.CloseHandler;
  import info.magnolia.ui.UIComponent;
  import info.magnolia.ui.ValueContext;
  import info.magnolia.ui.api.i18n.I18NAuthoringSupport;
  import info.magnolia.ui.datasource.optionlist.Option;
  import info.magnolia.ui.dialog.DialogDefinition;
  import info.magnolia.ui.dialog.DialogDefinitionRegistry;
  import info.magnolia.ui.editor.FormView;
  import info.magnolia.ui.editor.LocaleContext;
  import info.magnolia.ui.observation.DatasourceObservation;
  import info.magnolia.ui.vaadin.gwt.client.shared.AbstractElement;
  import info.magnolia.ui.vaadin.gwt.client.shared.ComponentElement;
  
  import java.util.Optional;
  
  import javax.inject.Inject;
  import javax.jcr.Node;
  import javax.jcr.Session;
  
  import com.machinezoo.noexception.Exceptions;
  import com.vaadin.data.BinderValidationStatus;
  import com.vaadin.ui.Window;
  
  /**
   * Adds a component underneath the area passed in {@link info.magnolia.ui.vaadin.gwt.client.shared.AreaElement}.
   * Gets a list of available components for this area and creates a select field.
   */
  public class CreateComponentAction extends EditElementAction {
  
      static final String NEW_COMPONENT_POSITION = "mgnl:position";
      /**
       * Represents position of a component within the area.
       */
      static final String COMPONENT_POSITION_TOP = "top";
  
      private AbstractElement parentElement;
  
      private final NodeNameHelper nodeNameHelper;
      private final FormView<Node> formView;
      private final TemplateDefinitionRegistry templateDefinitionRegistry;
      private final DatasourceObservation.Manual datasourceObservation;
      private final CloseHandler closeHandler;
  
      @Inject
      public CreateComponentAction(CreateComponentActionDefinition definition, UIComponent parentView, LocaleContext localeContext, I18NAuthoringSupport i18NAuthoringSupport, DialogDefinitionRegistry dialogDefinitionRegistry, I18nizer i18nizer, Context context, ValueContext<Node> valueContext, PageEditorStatus pageEditorStatus, NodeNameHelper nodeNameHelper, FormView<Node> formView, TemplateDefinitionRegistry templateDefinitionRegistry, DatasourceObservation.Manual datasourceObservation, CloseHandler closeHandler) {
          super(definition, parentView, localeContext, i18NAuthoringSupport, dialogDefinitionRegistry, i18nizer, context, valueContext, pageEditorStatus);
          this.nodeNameHelper = nodeNameHelper;
          this.formView = formView;
          this.templateDefinitionRegistry = templateDefinitionRegistry;
          this.datasourceObservation = datasourceObservation;
          this.closeHandler = closeHandler;
      }
  
      @Override
     public void execute() {
         if (formView.validate().stream().allMatch(BinderValidationStatus::isOk)) {
             Exceptions.wrap().run(() -> {
                 super.execute();
                 final Node parent = getValueContext().getSingleOrThrow();
                 final Session session = parent.getSession();
                 final String componentName = nodeNameHelper.getUniqueName(parent, "0");
                 final Node component = parent.addNode(componentName, NodeTypes.Component.NAME);
 
                 // Fetch form properties - template and whether component is to be placed on top.
                 final String templateId = formView.<String>getPropertyValue(NodeTypes.Renderable.TEMPLATE)
                         .orElseThrow(IllegalArgumentException::new);
 
                 final Boolean onTop = formView.<Option>getPropertyValue(NEW_COMPONENT_POSITION)
                         .map(Option::getValue)
                         .map(COMPONENT_POSITION_TOP::equals)
                         .orElse(false);
 
                 // Fetch the dialog from the component template
                 final String dialog = Optional.of(templateId)
                         .map(templateDefinitionRegistry::getProvider)
                         .map(DefinitionProvider::get)
                         .map(TemplateDefinition::getDialog)
                         .orElse(null);
 
                 this.parentElement = getPageEditorStatus().getSelectedElement();
                 getPageEditorStatus().setSelectedElement(new ComponentElement(session.getWorkspace().getName(), component.getPath(), dialog));
 
                 RenderableNodeMetadata renderableNodeMetadata = RenderableNodeMetadata.builder()
                         .templateId(templateId)
                         .orderToTop(onTop)
                         .build();
 
                 getValueContext().set(new NewRenderableNodeWrapper(component, renderableNodeMetadata)); //although existing node would be
 
                 // already correctly handled by pageEditorStatus#setSelected, here we need to set the unsaved node
                 // manually
                 closeHandler.close();
 
                 if (dialog == null) {
                     session.save();
                     datasourceObservation.trigger();
                 } else {
                     super.execute();
                 }
             });
         }
     }
 
     @Override
     protected DialogDefinition getDialogDefinition(DialogDefinitionRegistry dialogDefinitionRegistry, I18nizer i18nizer) {
         if (getPageEditorStatus().getSelectedElement() instanceof ComponentElement) {
             return super.getDialogDefinition(dialogDefinitionRegistry, i18nizer);
         }
         return null;
     }
 
     @Override
     protected CloseHandler getCloseHandler(Window dialog) {
         return () -> {
 
             getValueContext().getSingle()
                     .filter(Node::isNew) //creation was cancelled
                     .ifPresent(any -> getPageEditorStatus().setSelectedElement(parentElement));
 
             dialog.close();
         };
     }
 }