/**
    * This file Copyright (c) 2014-2015 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.cms.util.ExceptionUtil;
  import info.magnolia.config.NamedDefinition;
  import info.magnolia.config.map2bean.Map2BeanTransformer;
  import info.magnolia.config.registry.DefinitionMetadataBuilder;
  import info.magnolia.config.registry.DefinitionProvider;
  import info.magnolia.config.registry.DefinitionProviderBuilder;
  import info.magnolia.config.registry.DefinitionRawView;
  import info.magnolia.config.registry.Registry;
  import info.magnolia.config.source.raw.DefinitionRawViewMapWrapper;
  import info.magnolia.resourceloader.Resource;
  import info.magnolia.resourceloader.ResourceOrigin;
  
  import java.io.IOException;
  import java.util.Map;
  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;
  
      /**
       * @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) throws IOException {
          super(origin, registry, pathPattern);
          this.map2BeanTransformer = map2BeanTransformer;
          this.yamlReader = yamlReader;
      }
  
      @Override
      public void loadAndRegister(Resource resource) {
          if (resource == null) {
              throw new IllegalStateException("Resource path cannot be null");
          }
  
          final DefinitionProviderBuilder<T> builder = DefinitionProviderBuilder.newBuilder();
          final DefinitionMetadataBuilder metadataBuilder = createMetadata(resource);
          builder.metadata(metadataBuilder);
  
          try {
              // 1. Get map representation from yaml file
              final Map<String, Object> map = yamlReader.readToMap(resource);
              final DefinitionRawView raw = new DefinitionRawViewMapWrapper(map);
              builder.rawView(raw);
  
              // 2. Then transform it into the actual bean
              final T bean = map2BeanTransformer.toBean(map, getRootType());
              builder.definition(bean);
  
              // Override metadata name if needed
              if (bean instanceof NamedDefinition) {
                  final String definitionName = ((NamedDefinition) bean).getName();
                 if (definitionName != null) {
                     // Definition's name has priority
                     metadataBuilder.name(definitionName);
                 }
             }
         } catch (Throwable t) {
             // Here we're catching any exception, from reader (io) all the way down to map2BeanTransformer
             builder.addErrorMessage(ExceptionUtil.exceptionToWords(t));
             log.warn("Problem while registering {} from {}: {}", getRegistry().type(), resource, ExceptionUtil.exceptionToWords(t), t);
         }
 
         final DefinitionProvider<T> provider = builder.build();
         getRegistry().register(provider);
         log.info("Registered {} from {}", provider.getMetadata(), resource);
     }
 
 }