/**
    * This file Copyright (c) 2014-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.config.source.yaml;
  
  import info.magnolia.config.registry.DefinitionProviderProblemLogger;
  import info.magnolia.config.registry.Registry;
  import info.magnolia.config.source.yaml.decoration.FilePathBasedYamlDefinitionDecoratorResolver;
  import info.magnolia.init.MagnoliaConfigurationProperties;
  import info.magnolia.map2bean.Map2BeanTransformer;
  import info.magnolia.module.ModuleRegistry;
  import info.magnolia.objectfactory.Components;
  import info.magnolia.resourceloader.Resource;
  import info.magnolia.resourceloader.ResourceOrigin;
  
  import java.util.regex.Pattern;
  
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  /**
   * Configuration source for yaml configuration files.
   *
   * @param <T> type the source will provide
   */
  public class YamlConfigurationSource<T> extends AbstractFileResourceConfigurationSource<T> {
  
      private static Logger log = LoggerFactory.getLogger(YamlConfigurationSource.class);
  
      private final Map2BeanTransformer map2BeanTransformer;
  
      private final YamlReader yamlReader;
  
      private final MagnoliaConfigurationProperties magnoliaConfigurationProperties;
  
      private final ModuleRegistry moduleRegistry;
  
      /**
       * @deprecated since 5.5 - use {@link #YamlConfigurationSource(ResourceOrigin, Map2BeanTransformer, Registry, Pattern, YamlReader, MagnoliaConfigurationProperties, ModuleRegistry)} instead.
       */
      @Deprecated
      public YamlConfigurationSource(ResourceOrigin origin, info.magnolia.config.map2bean.Map2BeanTransformer map2BeanTransformer, Registry<T> registry, Pattern pathPattern, YamlReader yamlReader) {
          this(origin, map2BeanTransformer, registry, pathPattern, yamlReader, Components.getComponent(MagnoliaConfigurationProperties.class), Components.getComponent(ModuleRegistry.class));
      }
  
      /**
       * @deprecated since 5.5.6 - use {@link #YamlConfigurationSource(ResourceOrigin, Map2BeanTransformer, Registry, Pattern, YamlReader, MagnoliaConfigurationProperties, ModuleRegistry)} instead.
       */
      @Deprecated
      public YamlConfigurationSource(ResourceOrigin origin, Map2BeanTransformer map2BeanTransformer, Registry<T> registry, Pattern pathPattern, YamlReader yamlReader, MagnoliaConfigurationProperties magnoliaConfigurationProperties) {
          this(origin, map2BeanTransformer, registry, pathPattern, yamlReader, magnoliaConfigurationProperties, Components.getComponent(ModuleRegistry.class));
      }
  
      /**
       * @param pathPattern a regular expression pattern used to determine whether a file should be considered by the source or not. If the pattern contains a group, it will be used to determine the name of the given object, if not explicitly configured.
       */
      public YamlConfigurationSource(ResourceOrigin origin, Map2BeanTransformer map2BeanTransformer, Registry<T> registry, Pattern pathPattern, YamlReader yamlReader, MagnoliaConfigurationProperties magnoliaConfigurationProperties, ModuleRegistry moduleRegistry) {
          super(origin, registry, pathPattern, moduleRegistry);
          this.map2BeanTransformer = map2BeanTransformer;
          this.yamlReader = yamlReader;
          this.magnoliaConfigurationProperties = magnoliaConfigurationProperties;
          this.moduleRegistry = moduleRegistry;
      }
  
      @Override
      protected void startDecoration() {
          registerDefinitionDecoratorResolver(new FilePathBasedYamlDefinitionDecoratorResolver(map2BeanTransformer, getRegistry(), magnoliaConfigurationProperties));
          super.startDecoration();
      }
 
     @Override
     public void loadAndRegister(Resource resource) {
         if (resource == null) {
             throw new IllegalStateException("Resource cannot be null");
         }
 
         final YamlDefinitionProvider<T> definitionProvider = new YamlDefinitionProvider<>(
                 this,
                 resource,
                 map2BeanTransformer,
                 yamlReader,
                 moduleRegistry);
 
         getRegistry().register(definitionProvider);
 
         log.info("Registered definition from YAML file [{}]: {}", resource.getPath(), definitionProvider.getMetadata());
 
         DefinitionProviderProblemLogger
                 .withLoggingContext(log, magnoliaConfigurationProperties.getBooleanProperty("magnolia.develop"))
                 .logProblems(definitionProvider);
     }
 }