com.zebrunner.carina.utils.resources.Resources Maven / Gradle / Ivy

Go to download
/*******************************************************************************
 * Copyright 2020-2022 Zebrunner Inc (https://www.zebrunner.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 com.zebrunner.carina.utils.resources;

import java.io.File;
import java.io.IOException;
import java.lang.invoke.MethodHandles;
import java.net.MalformedURLException;
import java.net.URISyntaxException;
import java.net.URL;
import java.net.URLClassLoader;
import java.security.CodeSource;
import java.util.HashSet;
import java.util.Set;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public final class Resources {
    private static final Logger LOGGER = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());

    private Resources() {
    }

    private static void collectURL(ResourceURLFilter f, Set s, URL u) {
        if (f == null || f.accept(u)) {
            LOGGER.debug("adding resource url by filter: {}", u);
            s.add(u);
        }
    }

    private static void iterateFileSystem(File r, ResourceURLFilter f,
            Set s) {
        File[] files = r.listFiles();
        for (File file : files) {
            if (file.isDirectory()) {
                iterateFileSystem(file, f, s);
            } else if (file.isFile()) {
                try {
                    collectURL(f, s, file.toURI().toURL());
                } catch (MalformedURLException e) {
                    LOGGER.debug("Error while collecting urls!", e);
                }
            }
        }
    }

    private static void iterateEntry(File p, ResourceURLFilter f, Set s) {
        if (p.isDirectory()) {
            iterateFileSystem(p, f, s);
        }
    }

    // To scan the entire class path and return all its resources as URLs
    public static Set getResourceURLs() {
        return getResourceURLs((ResourceURLFilter) null);
    }

    // To scan the class path starting with the location from which a specific
    // class was loaded, provide the getResourceURLs method with the root-class
    @SuppressWarnings("rawtypes")
    public static Set getResourceURLs(Class rootClass) {
        return getResourceURLs(rootClass, null);
    }

    public static Set getResourceURLs(ResourceURLFilter filter) {
        Set collectedURLs = new HashSet<>();
        try (URLClassLoader ucl = new URLClassLoader(new URL[] { (ClassLoader.getSystemClassLoader()).getResource("L10N") },
                Resources.class.getClassLoader())) {
            for (URL url : ucl.getURLs()) {
                try {
                    iterateEntry(new File(url.toURI()), filter, collectedURLs);
                } catch (URISyntaxException e) {
                    LOGGER.debug("Error during creating URI from url!", e);
                }
            }
            return collectedURLs;
        } catch (IOException e) {
            LOGGER.debug("Error on creating URLClassLoader!", e);
        }
        return collectedURLs;
    }

    @SuppressWarnings("rawtypes")
    public static Set getResourceURLs(Class rootClass,
            ResourceURLFilter filter) {
        Set collectedURLs = new HashSet<>();
        CodeSource src = rootClass.getProtectionDomain().getCodeSource();
        try {
            iterateEntry(new File(src.getLocation().toURI()), filter,
                    collectedURLs);
        } catch (URISyntaxException e) {
            LOGGER.debug("Error during creating URI from url!", e);
        }
        return collectedURLs;
    }
}