/**
    * This file Copyright (c) 2019 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.browser;
  
  import info.magnolia.config.registry.Registry.NoSuchDefinitionException;
  import info.magnolia.i18nsystem.I18nizer;
  import info.magnolia.registry.RegistrationException;
  import info.magnolia.rendering.template.assignment.TemplateDefinitionAssignment;
  import info.magnolia.ui.UIComponent;
  import info.magnolia.ui.ValueContext;
  import info.magnolia.ui.api.i18n.I18NAuthoringSupport;
  import info.magnolia.ui.dialog.DialogDefinition;
  import info.magnolia.ui.dialog.DialogDefinitionRegistry;
  import info.magnolia.ui.dialog.actions.OpenDialogAction;
  import info.magnolia.ui.dialog.actions.OpenDialogActionDefinition;
  import info.magnolia.ui.editor.LocaleContext;
  import info.magnolia.ui.form.definition.DefinitionConverter;
  
  import javax.inject.Inject;
  import javax.jcr.Node;
  
  /**
   * Allows editing page properties defined in the dialog definition of the page. If the page dialog is
   * legacy (UI 5), it converts the dialog definition compatible to new UI 6 framework
   * before presenting the form dialog.
   */
  public class EditPagePropertiesAction extends OpenDialogAction<Node> {
  
      private final TemplateDefinitionAssignment templateDefinitionAssignment;
  
      @Inject
      public EditPagePropertiesAction(OpenDialogActionDefinition definition, LocaleContext localeContext,
                                      ValueContext<Node> valueContext, UIComponent parentView,
                                      I18NAuthoringSupport<Node> i18NAuthoringSupport, DialogDefinitionRegistry dialogDefinitionRegistry,
                                      TemplateDefinitionAssignment templateDefinitionAssignment,
                                      I18nizer i18nizer) {
          super(definition, localeContext, valueContext, parentView, i18NAuthoringSupport, dialogDefinitionRegistry, i18nizer);
          this.templateDefinitionAssignment = templateDefinitionAssignment;
      }
  
      @Override
      protected DialogDefinition getDialogDefinition(DialogDefinitionRegistry dialogDefinitionRegistry, I18nizer i18nizer) {
          // Fetch the selected page for editing its properties
          Node page = getValueContext().getSingleOrThrow();
  
          try {
              // Fetch page dialog for presenting page properties for editing
              String dialog = templateDefinitionAssignment.getAssignedTemplateDefinition(page).getDialog();
  
              // Fetch the dialog definition from registry and localize it using i18nizer
              DialogDefinition localizedDialogDefinition = i18nizer.decorate(dialogDefinitionRegistry.getProvider(dialog).get());
  
              // If dialog definition is legacy (UI 5) convert it to UI 6 compatible dialog
              return localizedDialogDefinition instanceof info.magnolia.ui.dialog.definition.FormDialogDefinition
                      ? DefinitionConverter.DIALOG.convert((info.magnolia.ui.dialog.definition.FormDialogDefinition) localizedDialogDefinition)
                      : localizedDialogDefinition;
          } catch (RegistrationException e) {
              throw new NoSuchDefinitionException(e.getMessage());
          }
      }
  }