/**
    * 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.ui.form.fieldtype.registry;
  
  import static info.magnolia.config.registry.DefinitionProvider.Problem.DefaultTypes.*;
  import static info.magnolia.config.registry.DefinitionProvider.Problem.*;
  import static info.magnolia.util.DeprecationUtil.getDeprecationMessage;
  
  import info.magnolia.config.registry.DefinitionMetadata;
  import info.magnolia.config.registry.DefinitionProvider;
  import info.magnolia.config.registry.validator.DefinitionValidator;
  import info.magnolia.ui.form.field.definition.ConfiguredFieldDefinition;
  import info.magnolia.ui.form.field.definition.FieldDefinition;
  import info.magnolia.ui.form.fieldtype.definition.FieldTypeDefinition;
  
  import java.util.ArrayList;
  import java.util.Collection;
  import java.util.Optional;
  
  import javax.inject.Inject;
  
  import org.apache.commons.lang3.StringUtils;
  
  import lombok.Getter;
  import net.sf.cglib.proxy.Enhancer;
  
  /**
   * Abstract validator for {@link FieldTypeDefinition}s.
   *
   * @param <T>
   */
  public abstract class AbstractFieldTypeDefinitionValidator<T> implements DefinitionValidator<T> {
  
      @Getter
      private final FieldTypeDefinitionRegistry fieldTypeDefinitionRegistry;
  
      @Inject
      public AbstractFieldTypeDefinitionValidator(FieldTypeDefinitionRegistry fieldTypeDefinitionRegistry) {
          this.fieldTypeDefinitionRegistry = fieldTypeDefinitionRegistry;
      }
  
      @Override
      public Collection<DefinitionProvider.Problem> validate(DefinitionProvider<T> provider) {
          final Collection<DefinitionProvider.Problem> problems = new ArrayList<>();
          if (provider.isValid()) {
              validateDefinition(problems, provider);
          }
          return problems;
      }
  
      protected abstract void validateDefinition(Collection<DefinitionProvider.Problem> problems, DefinitionProvider<T> provider);
  
      protected void validateFieldDefinition(Collection<DefinitionProvider.Problem> problems, FieldDefinition fieldDefinition, String path, DefinitionMetadata dialogMetadata) {
          Optional<DefinitionProvider<FieldTypeDefinition>> fieldTypeDefinitionDefinitionProvider = fieldTypeDefinitionRegistry
                  .getAllProviders()
                  .stream()
                  .filter(provider -> provider.isValid() && provider.get().getDefinitionClass() != null && provider.get().getDefinitionClass().equals(Enhancer.isEnhanced(fieldDefinition.getClass()) ? fieldDefinition.getClass().getSuperclass() : fieldDefinition.getClass()))
                  .findAny();
          if (!fieldTypeDefinitionDefinitionProvider.isPresent()) {
              reportMissingFieldTypeDefinition(problems, fieldDefinition, path);
          } else {
              validateFieldDefinition(problems, fieldTypeDefinitionDefinitionProvider.get(), path, dialogMetadata);
          }
      }
  
      protected void validateFieldDefinition(Collection<DefinitionProvider.Problem> problems, DefinitionProvider<FieldTypeDefinition> fieldTypeDefinitionDefinitionProvider, String path, DefinitionMetadata dialogMetadata) {
          if (!dialogMetadata.getDeprecation().isPresent() && Optional.ofNullable(fieldTypeDefinitionDefinitionProvider.getMetadata()).flatMap(DefinitionMetadata::getDeprecation).isPresent()) {
              DefinitionMetadata fieldTypeMetadata = fieldTypeDefinitionDefinitionProvider.getMetadata();
             fieldTypeMetadata.getDeprecation().ifPresent(deprecation -> {
                 String deprecationMessage = getDeprecationMessage(fieldTypeDefinitionRegistry.type().getName(), fieldTypeMetadata.getName(), deprecation.since(), deprecation.description());
 
                 problems.add(deprecated()
                         .withTitle("Deprecated definition usage")
                         .withDetails(deprecationMessage)
                         .withLocation(path)
                         .withType(RESOLUTION)
                         .build());
             });
         }
     }
 
     protected void reportMissingFieldTypeDefinition(Collection<DefinitionProvider.Problem> problems, FieldDefinition fieldDefinition, String path) {
         problems.add(major()
                 .withTitle("No field type definition found")
                 .withDetails(getDetails(fieldDefinition))
                 .withLocation(path)
                 .withType(REFERENCES)
                 .build());
     }
 
     private String getDetails(FieldDefinition fieldDefinition) {
         if (fieldDefinition instanceof ConfiguredFieldDefinition) {
             ConfiguredFieldDefinitionm/field/definition/ConfiguredFieldDefinition.html#ConfiguredFieldDefinition">ConfiguredFieldDefinition configuredFieldDefinition = (ConfiguredFieldDefinition) fieldDefinition;
             if (StringUtils.isNotBlank(configuredFieldDefinition.getFieldType())) {
                 return "Could not find fieldType for name " + configuredFieldDefinition.getFieldType();
             }
         }
         return "Could not find fieldType for definition " + fieldDefinition.getClass().getName();
     }
 }