/**
    * This file Copyright (c) 2016 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.decoration;
  
  import static info.magnolia.config.registry.RegistryTypeNameUtil.pluralTypeNameOf;
  
  import info.magnolia.config.map2bean.Map2BeanTransformer;
  import info.magnolia.config.registry.DefaultDefinitionReference;
  import info.magnolia.config.registry.Registry;
  import info.magnolia.resourceloader.Resource;
  
  import java.util.regex.Matcher;
  import java.util.regex.Pattern;
  
  import javax.inject.Inject;
  
  import org.apache.commons.lang3.StringUtils;
  
  import com.google.common.base.Optional;
  
  /**
   * Checks if a {@link Resource resource} path matches a certain pattern ({@value #DECORATOR_FILE_PATH_CONVENTION}) which includes a specific reference id of
   * a single {@link info.magnolia.config.registry.DefinitionProvider target definition provider}.
   * <p>
   * In case of a match - produces an instance of {@link YamlDefinitionDecorator}.
   * </p>
   *
   * @see YamlDefinitionDecorator
   */
  public class FilePathBasedYamlDefinitionDecoratorResolver implements FileDefinitionDecoratorResolver {
  
      private static final String DECORATOR_FILE_PATH_CONVENTION = "^/(?<module>[a-zA-Z0-9-_]+)/decorations/(?<targetmodule>.*?)?/(?<deftype>%s)?/(?<relpath>.*/)?(?<refname>.+?)(\\.(?<decoratedpath>[a-zA-Z0-9-_\\.]*))*\\.yaml$";
  
      private final Map2BeanTransformer map2BeanTransformer;
  
      private Pattern decoratorFilePathPattern;
  
      private Registry registry;
  
      @Inject
      public FilePathBasedYamlDefinitionDecoratorResolver(Map2BeanTransformer map2BeanTransformer, Registry registry) {
          this.map2BeanTransformer = map2BeanTransformer;
          this.registry = registry;
          this.decoratorFilePathPattern = Pattern.compile(String.format(DECORATOR_FILE_PATH_CONVENTION, pluralTypeNameOf(registry)));
      }
  
      @Override
      public <T> Optional<FileDefinitionDecorator<T>> resolve(Resource resource) {
          final Matcher matcher = decoratorFilePathPattern.matcher(resource.getPath());
          if (matcher.matches()) {
  
              final String name = matcher.group("refname");
              final String relativeLocation = StringUtils.isBlank(matcher.group("relpath")) ? name : matcher.group("relpath") + name;
              final String targetModule = matcher.group("targetmodule");
              final String hostModule = matcher.group("module");
              final String decoratedPath = String.format("/%s", StringUtils.defaultIfBlank(matcher.group("decoratedpath"), "")).replaceAll("\\.", "/");
  
              //noinspection unchecked
              return Optional.<FileDefinitionDecorator<T>>of(
                  new YamlDefinitionDecorator<T>(
                      new YamlDefinitionDecoratorMetadata.Impl(
                              hostModule,
                              decoratedPath,
                              new DefaultDefinitionReference(targetModule, relativeLocation, name)),
                      registry,
                      resource,
                      map2BeanTransformer
              ));
         }
 
         return Optional.absent();
     }
 }