org.protege.osgi.framework.BundleSearchPath Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of protege-launcher Show documentation
The Protege Launcher
There is a newer version: 5.6.5
package org.protege.osgi.framework;

import com.google.common.base.MoreObjects;
import org.osgi.framework.Constants;
import org.osgi.framework.Version;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.File;
import java.io.FileInputStream;
import java.util.*;
import java.util.jar.Attributes;
import java.util.jar.JarInputStream;
import java.util.jar.Manifest;
import java.util.stream.Collectors;

import static com.google.common.base.MoreObjects.toStringHelper;

public class BundleSearchPath {

    private Logger logger = LoggerFactory.getLogger(BundleSearchPath.class.getCanonicalName());

    public static final String USER_HOME = "user.home";

    public static final String USER_HOME_VAR = "${" + USER_HOME + "}/";


    private List path = new ArrayList<>();

    private List allowedBundles = new ArrayList<>();

    public BundleSearchPath() {
    }

    public void addSearchPath(String dir) {
        if (dir.startsWith(USER_HOME_VAR)) {
            String homeDirectory = System.getProperty(USER_HOME);
            dir = dir.substring(USER_HOME_VAR.length());
            path.add(new File(homeDirectory, dir));
        }
        else {
            path.add(new File(dir));
        }
    }


    public List getPath() {
        return path;
    }

    public List getAllowedBundles() {
        return allowedBundles;
    }

    public void addAllowedBundle(String bundle) {
        allowedBundles.add(bundle);
    }

    public Collection search() {
        Map nameToFileMap = new LinkedHashMap<>();
        for (File dir : path) {
            if (!dir.exists() || !dir.isDirectory()) {
                continue;
            }
            File[] contents = dir.listFiles();
            if (contents != null) {
                for (File jar : contents) {
                    String jarName = jar.getName();
                    if (jar.getName().endsWith(".jar") && isAllowedBundle(jarName)) {
                        Optional parseBundleInfo = toBundleInfo(jar);
                        if (parseBundleInfo.isPresent()) {
                            addJar(parseBundleInfo.get(), nameToFileMap);
                        }
                    }
                }
            }
        }
        return nameToFileMap.values().stream().map(BundleInfo::getBundleFile).collect(Collectors.toList());
    }

    private boolean isAllowedBundle(String jarName) {
        return allowedBundles.isEmpty() || allowedBundles.contains(jarName);
    }

    private void addJar(BundleInfo bundleInfo, Map nameToFileMap) {
        SymbolicName symbolicName = bundleInfo.getSymbolicName();
        BundleInfo existingBundleInfo = nameToFileMap.get(symbolicName);
        if (existingBundleInfo == null) {
            nameToFileMap.put(symbolicName, bundleInfo);
            return;
        }

        if (bundleInfo.isNewerVersionThan(existingBundleInfo)) {
            nameToFileMap.put(symbolicName, bundleInfo);
            logger.warn("Found duplicate plugin/bundle.  " +
                            "Using the latest version, {} and ignoring the previous version, {}.",
                    bundleInfo.getBundleFile().getName(),
                    existingBundleInfo.getBundleFile().getName());
        }
        else if (bundleInfo.isNewerTimestampThan(existingBundleInfo)) {
            nameToFileMap.put(symbolicName, bundleInfo);
            logger.warn("Found duplicate plugin/bundle. " +
                            "Using the most recent, {} (modified {}) " +
                            "and ignoring the older copy, {} (modified {}).",
                    bundleInfo.getBundleFile().getName(),
                    String.format("%tc", bundleInfo.getBundleFile().lastModified()),
                    existingBundleInfo.getBundleFile().getName(),
                    String.format("%tc", existingBundleInfo.getBundleFile().lastModified())

            );
        }
        else {
            logger.warn(
                    "Ignoring plugin/bundle ({}) because it is a duplicate of {}.",
                    existingBundleInfo.getBundleFile().getName(),
                    bundleInfo.getBundleFile().getName()
            );
        }

    }

    private Optional toBundleInfo(File file) {
        try (JarInputStream is = new JarInputStream(new FileInputStream(file))) {
            Manifest mf = is.getManifest();
            if(mf == null) {
                logger.warn("Could not parse {} as plugin/bundle because the manifest.mf file is not present.", file);
                return Optional.empty();
            }
            Attributes attributes = mf.getMainAttributes();
            String symbolicName = attributes.getValue(Constants.BUNDLE_SYMBOLICNAME);
            if (symbolicName == null) {
                return Optional.empty();
            }
            String versionString = attributes.getValue(Constants.BUNDLE_VERSION);
            Optional version =
                    versionString == null ? Optional.empty() : Optional.of(new Version(versionString));
            return Optional.of(new BundleInfo(file, new SymbolicName(symbolicName), version));
        } catch (Exception e) {
            logger.warn("Could not parse {} as plugin/bundle. Error: ", file, e);
            return Optional.empty();
        }
    }


    @Override
    public String toString() {
        MoreObjects.ToStringHelper ts = toStringHelper("BundleSearchPath");
        for(File path : getPath()) {
            ts.add("path", path.getAbsolutePath());
        }
        for(String allowedBundle : allowedBundles) {
            ts.add("allowedBundle", allowedBundle);
        }
        return ts.toString();
    }
}