/**
    * This file Copyright (c) 2017-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.config.source.yaml.dependency;
  
  import static info.magnolia.config.registry.DefinitionProvider.Problem;
  
  import info.magnolia.cms.util.ExceptionUtil;
  import info.magnolia.config.source.yaml.MgnlYamlConstructor.YamlConfigurationDependencyAggregator;
  import info.magnolia.config.source.yaml.YamlReader;
  import info.magnolia.config.source.yaml.YamlReader.YamlConversionResult;
  import info.magnolia.resourceloader.Resource;
  import info.magnolia.resourceloader.ResourceOrigin;
  
  import java.io.IOException;
  import java.util.Collections;
  import java.util.Optional;
  import java.util.function.Consumer;
  
  import org.apache.commons.lang3.exception.ExceptionUtils;
  
  /**
   * A kind of {@link YamlConfigurationDependency} which represents another YAML file, possibly included or somehow referenced in another file.
   * Needs to be supplied with an instance of a {@link YamlReader} and {@link YamlConfigurationDependencyAggregator} in order to collect the
   * transitive dependencies.
   */
  public class YamlFileDependency extends AbstractYamlConfigurationDependency {
  
      private final ResourceOrigin resourceOrigin;
      private final String resourcePath;
      private final YamlReader yamlReader;
      private final YamlConfigurationDependencyAggregator dependencyAggregator;
  
      public YamlFileDependency(ResourceOrigin resourceOrigin, String resourcePath, YamlReader yamlReader, YamlConfigurationDependencyAggregator dependencyAggregator, Consumer<Problem> problemCollector) {
          super(problemCollector);
          this.resourceOrigin = resourceOrigin;
          this.resourcePath = resourcePath;
          this.yamlReader = yamlReader;
          this.dependencyAggregator = dependencyAggregator;
      }
  
      @Override
      public boolean exists() {
          return this.resourceOrigin.hasPath(this.resourcePath);
      }
  
      @Override
      public long getLastModified() {
          return getLastModified(() -> getResource().getLastModified());
      }
  
      @Override
      public Object readData() {
          try {
              final YamlConversionResult dependencyConversionResult = yamlReader.readWithDependencies(getResource());
              dependencyConversionResult.getDependencies().forEach(dependencyAggregator::addDependency);
              return dependencyConversionResult.getResult();
          } catch (IOException e) {
              reportProblem(Problem.major()
                      .withType(Problem.DefaultTypes.RESOLUTION)
                      .withTitle(String.format("Unable to open resource [%s]", this.resourcePath))
                      .withRelatedException(e)
                      .withDetails(ExceptionUtil.exceptionToWords(
                              Optional
                                  .ofNullable(ExceptionUtils.getRootCause(e))
                                  .orElse(e)))
                      .build());
              return Collections.emptyMap();
          }
     }
 
     private Resource getResource() {
         return this.resourceOrigin.getByPath(this.resourcePath);
     }
 
     @Override
     public String toString() {
         return String.format("YAML file dependency at [%s]", this.resourcePath);
     }
 }