/**
    * This file Copyright (c) 2013-2017 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.action;
  
  import info.magnolia.event.EventBus;
  import info.magnolia.objectfactory.Components;
  import info.magnolia.pages.app.editor.PagesContentConnector;
  import info.magnolia.ui.api.action.AbstractAction;
  import info.magnolia.ui.api.action.ActionExecutionException;
  import info.magnolia.ui.api.app.SubAppContext;
  import info.magnolia.ui.api.app.SubAppDescriptor;
  import info.magnolia.ui.api.app.SubAppEventBus;
  import info.magnolia.ui.api.event.ContentChangedEvent;
  import info.magnolia.ui.contentapp.definition.ContentSubAppDescriptor;
  import info.magnolia.ui.dialog.formdialog.FormDialogPresenter;
  import info.magnolia.ui.dialog.formdialog.FormDialogPresenterFactory;
  import info.magnolia.ui.form.EditorCallback;
  import info.magnolia.ui.vaadin.gwt.client.shared.AbstractElement;
  import info.magnolia.ui.vaadin.integration.contentconnector.ContentConnectorDefinition;
  import info.magnolia.ui.vaadin.integration.jcr.JcrItemAdapter;
  
  import javax.inject.Inject;
  import javax.inject.Named;
  
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  /**
   * Opens a dialog for editing a {@link AbstractElement}. Reads the dialog-name from {@link AbstractElement#getDialog()}
   * which is extracted from the 'cms-comment' on client-side.
   */
  public class EditElementAction extends AbstractAction<EditElementActionDefinition> {
  
      private static final Logger log = LoggerFactory.getLogger(EditElementAction.class);
  
      private final FormDialogPresenterFactory dialogPresenterFactory;
      private final JcrItemAdapter item;
      private final AbstractElement element;
      private final SubAppContext subAppContext;
      private final EventBus eventBus;
  
      @Inject
      public EditElementAction(final JcrItemAdapter item, final EditElementActionDefinition definition, final AbstractElement element,
                               final SubAppContext subAppContext, final @Named(SubAppEventBus.NAME) EventBus eventBus,
                               final FormDialogPresenterFactory dialogPresenterFactory) {
          super(definition);
          this.item = item;
          this.element = element;
          this.subAppContext = subAppContext;
          this.eventBus = eventBus;
          this.dialogPresenterFactory = dialogPresenterFactory;
      }
  
      /**
       * @deprecated since 5.5, use {@link EditElementAction(JcrItemAdapter, EditElementActionDefinition, AbstractElement, SubAppContext, EventBus, FormDialogPresenterFactory)}
       */
      @Deprecated
      public EditElementAction(EditElementActionDefinition definition, AbstractElement element,
                               SubAppContext subAppContext, @Named(SubAppEventBus.NAME) EventBus eventBus, FormDialogPresenterFactory dialogPresenterFactory) {
          this(resolveItemForDeprecations(element, subAppContext, eventBus), definition, element, subAppContext, eventBus, dialogPresenterFactory);
      }
  
      /*
       * This is a work-around to resolve the content-connector from the subAppDescriptor.
       * Using {@link info.magnolia.objectfactory.Components.getComponent} does not work as it resides in the subapp-scope,
       * whereas Components is only bound to main-scope.
       */
      private static JcrItemAdapter resolveItemForDeprecations(AbstractElement element, SubAppContext subAppContext, EventBus eventBus) {
         SubAppDescriptor subAppDescriptor = subAppContext.getSubAppDescriptor();
         if (subAppDescriptor instanceof ContentSubAppDescriptor) {
             ContentConnectorDefinition contentConnectorDefinition = ((ContentSubAppDescriptor) subAppDescriptor).getContentConnector();
             if (contentConnectorDefinition != null) {
                 PagesContentConnector contentConnector = (PagesContentConnector) Components.newInstance(contentConnectorDefinition.getImplementationClass(), subAppContext, eventBus, contentConnectorDefinition);
                 return contentConnector.getItemByElement(element);
             } else {
                 log.warn("Sub-app descriptor {} ({}) expected a ContentConnectorDefinition, but no contentConnector is currently configured.", subAppDescriptor.getName(), subAppDescriptor.getClass().getSimpleName());
             }
         }
         log.warn("Not able to resolve the content-connector using the fallback mechanism in '{}'. Please omit the deprecated code. Return 'null'.",
                 EditElementAction.class.getName());
         return null;
     }
 
     @Override
     public void execute() throws ActionExecutionException {
         String dialogId = element.getDialog();
 
         final FormDialogPresenter formDialogPresenter = dialogPresenterFactory.createFormDialogPresenter(dialogId);
         formDialogPresenter.start(item, dialogId, subAppContext, new EditorCallback() {
 
             @Override
             public void onSuccess(String actionName) {
                 eventBus.fireEvent(new ContentChangedEvent(item.getItemId()));
                 formDialogPresenter.closeDialog();
             }
 
             @Override
             public void onCancel() {
                 formDialogPresenter.closeDialog();
             }
         });
     }
 }