org.rundeck.storage.conf.TreeStack Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rundeck-storage-conf Show documentation
Rundeck
There is a newer version: 5.8.0-20241205
/*
 * Copyright 2016 SimplifyOps, Inc. (http://simplifyops.com)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.rundeck.storage.conf;

import org.rundeck.storage.api.*;
import org.rundeck.storage.impl.DelegateTree;
import org.rundeck.storage.impl.ResourceBase;

import java.util.*;

/**
 * tree that uses an ordered list of TreeHandlers to determine which underlying storage to use, and falls back to a
 * delegate if there is no match
 */
public class TreeStack extends DelegateTree {
    private List> treeHandlerList;

    public TreeStack(List> treeHandlerList, Tree delegate) {
        super(delegate);
        validatePaths(treeHandlerList);
        this.treeHandlerList = sorted(treeHandlerList);
    }

    private void validatePaths(final List> treeHandlerList) {
        HashSet paths = new HashSet<>();
        for (SelectiveTree tSelectiveTree : treeHandlerList) {
            if (!paths.contains(tSelectiveTree.getSubPath().getPath())) {
                paths.add(tSelectiveTree.getSubPath().getPath());
            } else {
                throw new IllegalArgumentException(String.format(
                    "Cannot create TreeStack: multiple subpaths defined for: %s",
                    tSelectiveTree.getSubPath()
                ));
            }
        }
    }

    private List> sorted(final List> treeHandlerList) {
        ArrayList> list = new ArrayList<>(treeHandlerList);
        //sort by path length longest to shortest
        list.sort(new Comparator>() {
            @Override
            public int compare(final SelectiveTree o1, final SelectiveTree o2) {
                return o2.getSubPath().getPath().length() - o1.getSubPath().getPath().length();
            }
        });
        return list;
    }

    @Override
    public Resource getResource(Path path) {
        return getContentStorage(path).getResource(path);
    }

    @Override
    public Resource getPath(Path path) {
        return getContentStorage(path).getPath(path);
    }

    @Override
    public Set> listDirectoryResources(Path path) {
        return getContentStorage(path).listDirectoryResources(path);
    }

    @Override
    public Set> listDirectory(Path path) {
        //find substorage which are children of the given path
        return merge(listDirectoryIfFound(path), listStackDirectory(path));
    }

    private Set> listDirectoryIfFound(Path path) {
        if(getContentStorage(path).hasDirectory(path)){
            return getContentStorage(path).listDirectory(path);
        }
        return null;
    }

    private Map> asMap(Set> matchedList) {
        HashMap> map = new HashMap<>();
        for (Resource tResource : matchedList) {
            map.put(tResource.getPath().getPath(), tResource);
        }
        return map;
    }

    private Set> merge(Set>... matchedList) {
        HashMap> merge = new HashMap<>();
        if (null != matchedList && matchedList.length > 0) {
            for (Set> resources : matchedList) {
                if (resources != null && resources.size() > 0) {
                    merge.putAll(asMap(resources));
                }
            }
        }
        return new HashSet<>(merge.values());
    }

    @Override
    public Set> listDirectorySubdirs(Path path) {
        return merge(listDirectoryIfFound(path), listStackDirectory(path));
    }

    @Override
    public boolean deleteResource(Path path) {
        return getContentStorage(path).deleteResource(path);
    }

    @Override
    public Resource createResource(Path path, T content) {
        return getContentStorage(path).createResource(path, content);
    }

    @Override
    public Resource updateResource(Path path, T content) {
        return getContentStorage(path).updateResource(path, content);
    }

    @Override
    public boolean hasPath(Path path) {
        return getContentStorage(path).hasPath(path);
    }

   public static boolean matchesPath(Path path, SelectiveTree tree) {
        return path.equals(tree.getSubPath()) || PathUtil.hasRoot(path, tree.getSubPath());
    }

    /**
     * @param path parent path
     * @param tree tree with a subpath
     * @return true if the subpath is directly under the path
     */
    public static boolean hasParentPath(Path path, SubPath tree) {
        return path.equals(PathUtil.parentPath(tree.getSubPath()));
    }


    /**
     * List all treeHandlers as directories which have the given path as a parent
     * @param path path
     * @return
     */
    private Set> listStackDirectory(Path path) {
        HashSet> merge = new HashSet>();
        if (treeHandlerList.size() > 0) {
            for (SelectiveTree treeHandler : treeHandlerList) {
                if (PathUtil.hasRoot(treeHandler.getSubPath(), path) && !PathUtil.equals(
                    treeHandler.getSubPath(),
                    path
                )) {
                    String relativePath = PathUtil.removePrefix(path.getPath(), treeHandler.getSubPath().getPath());
                    String[] components = PathUtil.componentsFromPathString(relativePath);
                    Path subpath = PathUtil.appendPath(path, components[0]);
                    merge.add(new ResourceBase(subpath, null, true));
                }
            }
        }
        return merge;
    }

    private Tree getContentStorage(Path path) {
        if (treeHandlerList.size() > 0) {
            for (SelectiveTree treeHandler : treeHandlerList) {
                if (matchesPath(path, treeHandler)) {
                    return treeHandler;
                }
            }
        }
        return getDelegate();
    }

    public boolean hasResource(Path path) {
        return getContentStorage(path).hasResource(path);
    }

    public boolean hasDirectory(Path path) {
        return getContentStorage(path).hasDirectory(path);
    }
}