/**
    * This file Copyright (c) 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.rendering.registry.validator;
  
  import static info.magnolia.config.registry.DefinitionProvider.Problem.*;
  
  import info.magnolia.config.registry.DefinitionMetadata;
  import info.magnolia.config.registry.DefinitionProvider;
  import info.magnolia.rendering.renderer.registry.RendererRegistry;
  import info.magnolia.rendering.template.AreaDefinition;
  import info.magnolia.rendering.template.TemplateDefinition;
  import info.magnolia.rendering.template.registry.TemplateDefinitionRegistry;
  import info.magnolia.rendering.template.registry.validator.TemplateDefinitionValidator;
  import info.magnolia.resourceloader.ResourceOrigin;
  import info.magnolia.ui.dialog.DialogDefinitionRegistry;
  import info.magnolia.ui.dialog.registry.DefinitionTypes;
  import info.magnolia.util.DeprecationUtil;
  
  import java.util.Collection;
  import java.util.Optional;
  
  import javax.inject.Inject;
  import javax.inject.Provider;
  
  /**
   * Validates {@link info.magnolia.rendering.template.TemplateDefinition}'s reference to {@link info.magnolia.ui.dialog.definition.DialogDefinition}.
   */
  public class DialogAwareTemplateDefinitionValidator extends TemplateDefinitionValidator {
  
      private final DialogDefinitionRegistry dialogDefinitionRegistry;
  
      @Inject
      public DialogAwareTemplateDefinitionValidator(Provider<TemplateDefinitionRegistry> templateDefinitionRegistryProvider, RendererRegistry rendererRegistry, ResourceOrigin resourceOrigin, DialogDefinitionRegistry dialogDefinitionRegistry) {
          super(templateDefinitionRegistryProvider, rendererRegistry, resourceOrigin);
          this.dialogDefinitionRegistry = dialogDefinitionRegistry;
      }
  
      @Override
      protected void validateDefinition(Collection<DefinitionProvider.Problem> problems, DefinitionProvider<TemplateDefinition> definitionProvider) {
          super.validateDefinition(problems, definitionProvider);
          validateDialog(definitionProvider, problems, "", definitionProvider.get().getDialog());
      }
  
      @Override
      protected void validateArea(DefinitionProvider<TemplateDefinition> definitionProvider, Collection<DefinitionProvider.Problem> problems, String rootPath, AreaDefinition areaDefinition) {
          super.validateArea(definitionProvider, problems, rootPath, areaDefinition);
          final String areaPath = rootPath + "areas/" + areaDefinition.getName() + "/";
          validateDialog(definitionProvider, problems, areaPath, areaDefinition.getDialog());
      }
  
      private void validateDialog(DefinitionProvider definitionProvider, Collection<DefinitionProvider.Problem> problems, String rootPath, String dialog) {
          if (dialog != null) {
              Optional<DefinitionMetadata> definitionMetadataOptional = dialogDefinitionRegistry.getAllMetadata().stream().filter(metadata -> metadata.getReferenceId().equals(dialog)).findFirst();
              if (!definitionMetadataOptional.isPresent()) {
                  problems.add(major()
                          .withType(DefinitionProvider.Problem.DefaultTypes.REFERENCES)
                          .withTitle("Template dialog definition problem")
                          .withDetails("Dialog {" + dialog + "} is not registered.")
                          .withLocation(rootPath + dialog)
                          .build());
              } else if (definitionMetadataOptional.get().getDeprecation().isPresent() && !definitionProvider.getMetadata().getDeprecation().isPresent()) {
                  DefinitionMetadata definitionMetadata = definitionMetadataOptional.get();
                  definitionMetadata.getDeprecation().ifPresent(deprecation -> {
                      String deprecationMessage = DeprecationUtil.getDeprecationMessage(DefinitionTypes.DIALOG.getName(),
                              definitionMetadata.getName(), deprecation.since(), deprecation.description());
  
                      problems.add(deprecated()
                              .withTitle("Deprecated definition usage")
                             .withDetails(deprecationMessage)
                             .withLocation(rootPath + dialog)
                             .withType(DefinitionProvider.Problem.DefaultTypes.RESOLUTION)
                             .build());
                 });
             }
         }
     }
 }