org.mgnlconfig.yaml.dependency.DependencyTracker Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of light-yaml Show documentation
Enhances extension capabilities of Yaml configuration files (~ to JCR 'extends' property), provides connection to the JCR config workspace and to all the registries as well
The newest version!
/**
 * 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 org.mgnlconfig.yaml.dependency;

import info.magnolia.config.registry.Registry;
import info.magnolia.context.Context;
import info.magnolia.resourceloader.Resource;
import info.magnolia.resourceloader.ResourceOrigin;

import java.util.Collection;
import java.util.Map;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import com.google.common.base.Optional;
import com.google.common.collect.Maps;

public class DependencyTracker {

    private static final Pattern extensionPattern = Pattern.compile("!extend:(.+)");
    private static final Pattern legacyInclusionPattern = Pattern.compile("!include:(.+)");
    private static final Pattern jcrExtensionPattern = Pattern.compile("!extend-jcr:(.+)");
    private static final Pattern defExtensionPattern = Pattern.compile("!extend-def:(.+?):(.+)");

    private final Context context;
    private final ResourceOrigin resourceOrigin;
    private final Set registries;

    private final Map dependencies = Maps.newHashMap();

    public DependencyTracker(Context context, ResourceOrigin resourceOrigin, Set registries) {
        this.context = context;
        this.resourceOrigin = resourceOrigin;
        this.registries = registries;
    }

    public Collection getResolvedDependencies() {
        return dependencies.values();
    }

    public Optional resolveDependencyFromYamlTag(String tag) {
        if (dependencies.containsKey(tag)) {
            return Optional.of(dependencies.get(tag));
        }

        ConfigDependency dependency = null;

        final Matcher legacyYamlFileMatcher = legacyInclusionPattern.matcher(tag);
        if (legacyYamlFileMatcher.matches()) {
            final Resource dependentResource = resourceOrigin.getByPath(legacyYamlFileMatcher.group(1));
            dependency = new YamlFileConfigDependency(this, dependentResource);
        }

        final Matcher yamlFileMatcher = extensionPattern.matcher(tag);
        if (yamlFileMatcher.matches()) {
            final Resource dependentResource = resourceOrigin.getByPath(yamlFileMatcher.group(1));
            dependency = new YamlFileConfigDependency(this, dependentResource);
        }

        final Matcher jcrNodeDependencyMatcher = jcrExtensionPattern.matcher(tag);
        if (jcrNodeDependencyMatcher.matches()) {
            final String nodePath = jcrNodeDependencyMatcher.group(1);
            dependency = new JcrNodeConfigDependency(nodePath, context);
        }

        final Matcher defDependencyMatcher = defExtensionPattern.matcher(tag);
        if (defDependencyMatcher.matches()) {
            final Registry registry = resolveRegistry(defDependencyMatcher.group(1));
            final String refId = defDependencyMatcher.group(2);
            dependency = new DefinitionConfigDependency(refId, registry);
        }

        if (dependency != null) {
            dependencies.put(tag, dependency);
            return Optional.of(dependency);
        } else {
        }   return Optional.absent();

    }

    private Registry resolveRegistry(String definitionType) {
        for (final Registry registry : registries) {
            if (registry.type().name().equalsIgnoreCase(definitionType)) {
                return registry;
            }
        }

        throw new IllegalArgumentException("No registry found for " + definitionType);
    }
}