org.mycore.common.config.MCRConfigurationDir Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of mycore-base Show documentation
There is a newer version: 2024.05
/*
 * This file is part of ***  M y C o R e  ***
 * See http://www.mycore.de/ for details.
 *
 * MyCoRe is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * MyCoRe is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with MyCoRe.  If not, see .
 */

package org.mycore.common.config;

import java.io.File;
import java.io.IOException;
import java.net.MalformedURLException;
import java.net.URL;
import java.nio.file.Path;
import java.security.CodeSource;
import java.security.ProtectionDomain;
import java.util.Enumeration;
import java.util.List;
import java.util.Locale;
import java.util.Optional;

import javax.servlet.ServletContext;

import org.apache.logging.log4j.LogManager;
import org.mycore.common.MCRClassTools;
import org.mycore.common.MCRDeveloperTools;

/**
 * This helper class determines in which directory to look for addition configuration files.
 * 
 * The directory path is build this way:
 * 
 *  System property MCR.Home defined
 *      
 *          System.getProperty("MCR.Home")
 *          {prefix+'-'}{appName}
 *      
 *  
 *  Windows:
 *      
 *          %LOCALAPPDATA%
 *          MyCoRe
 *          {prefix+'-'}{appName}
 *      
 *  
 *  other systems
 *      
 *          $HOME
 *          .mycore
 *          {prefix+'-'}{appName}
 *      
 *  
 * 
 * 
 * {prefix} can be defined by setting System property MCR.DataPrefix.
 * {appName} is always lowercase String determined using this
 * 
 *  System property MCR.AppName
 *  System property MCR.NameOfProject
 *  Servlet Context Path (if not root context, {@link ServletContext#getContextPath()})
 *  Servlet Context Name ({@link ServletContext#getServletContextName()}) with space characters removed
 *  base name of jar including this class
 *  the String "default"
 * 
 * 
 * @author Thomas Scheffler (yagee)
 * @see System#getProperties()
 * @since 2013.12
 */
public class MCRConfigurationDir {

    public static final String DISABLE_CONFIG_DIR_PROPERTY = "MCR.DisableConfigDir";

    private static ServletContext SERVLET_CONTEXT = null;

    private static String APP_NAME = null;

    private static File getMyCoReDirectory() {
        String mcrHome = System.getProperty("MCR.Home");
        if (mcrHome != null) {
            return new File(mcrHome);
        }
        //Windows Vista onwards:
        String localAppData = isWindows() ? System.getenv("LOCALAPPDATA") : null;
        //on every other platform
        String userDir = System.getProperty("user.home");
        String parentDir = localAppData != null ? localAppData : userDir;
        return new File(parentDir, getConfigBaseName());
    }

    private static boolean isWindows() {
        return System.getProperty("os.name").toLowerCase(Locale.ROOT).contains("windows");
    }

    private static String getConfigBaseName() {
        return isWindows() ? "MyCoRe" : ".mycore";
    }

    private static String getSource(Class clazz) {
        if (clazz == null) {
            return null;
        }
        ProtectionDomain protectionDomain = clazz.getProtectionDomain();
        CodeSource codeSource = protectionDomain.getCodeSource();
        if (codeSource == null) {
            System.err.println("Cannot get CodeSource.");
            return null;
        }
        URL location = codeSource.getLocation();
        String fileName = location.getFile();
        File sourceFile = new File(fileName);
        return sourceFile.getName();
    }

    private static String getAppName() {
        if (APP_NAME == null) {
            APP_NAME = buildAppName();
        }
        return APP_NAME;
    }

    private static String buildAppName() {
        String appName = System.getProperty("MCR.AppName");
        if (appName != null) {
            return appName;
        }
        String nameOfProject = System.getProperty("MCR.NameOfProject");
        if (nameOfProject != null) {
            return nameOfProject;
        }
        if (SERVLET_CONTEXT != null) {
            String contextPath = SERVLET_CONTEXT.getContextPath();
            if (!contextPath.isEmpty()) {
                return contextPath.substring(1);//remove leading '/'
            }
            String servletContextName = SERVLET_CONTEXT.getServletContextName();
            if (servletContextName != null
                && !(servletContextName.trim().isEmpty() || servletContextName.contains("/"))) {
                return servletContextName.replaceAll("\\s", "");
            }
        }
        String sourceFileName = getSource(MCRConfigurationDir.class);
        if (sourceFileName != null) {
            int beginIndex = sourceFileName.lastIndexOf('.') - 1;
            if (beginIndex > 0) {
                sourceFileName = sourceFileName.substring(0, beginIndex);
            }
            return sourceFileName.replaceAll("-\\d.*", "");//strips version 
        }
        return "default";
    }

    private static String getPrefix() {
        String dataPrefix = System.getProperty("MCR.DataPrefix");
        return dataPrefix == null ? "" : dataPrefix + "-";
    }

    static void setServletContext(ServletContext servletContext) {
        SERVLET_CONTEXT = servletContext;
        APP_NAME = null;
    }

    /**
     * Returns the configuration directory for this MyCoRe instance.
     * @return null if System property {@value #DISABLE_CONFIG_DIR_PROPERTY} is set.
     */
    public static File getConfigurationDirectory() {
        if (!System.getProperties().containsKey(DISABLE_CONFIG_DIR_PROPERTY)) {
            return new File(getMyCoReDirectory(), getPrefix() + getAppName());
        }
        return null;
    }

    /**
     * Returns a File object, if {@link #getConfigurationDirectory()} does not return null
     * and directory exists.
     * @param relativePath relative path to file or directory with configuration directory as base.
     * @return null if configuration directory does not exist or is disabled.
     */
    public static File getConfigFile(String relativePath) {
        File configurationDirectory = getConfigurationDirectory();
        if (configurationDirectory == null || !configurationDirectory.isDirectory()) {
            return null;
        }
        return new File(configurationDirectory, relativePath);
    }

    /**
     * Returns URL of a config resource.
     * Same as {@link #getConfigResource(String, ClassLoader)} with second argument null.
     * @param relativePath as defined in {@link #getConfigFile(String)}
     */
    public static URL getConfigResource(String relativePath) {
        return getConfigResource(relativePath, null);
    }

    /**
     * Returns URL of a config resource.
     * If {@link #getConfigFile(String)} returns an existing file for "resources"+{relativePath}, its URL is returned.
     * In any other case this method returns the same as {@link ClassLoader#getResource(String)} 
     * @param relativePath as defined in {@link #getConfigFile(String)}
     * @param classLoader a classLoader to resolve the resource (see above), null defaults to this class' class loader
     */
    public static URL getConfigResource(String relativePath, ClassLoader classLoader) {
        if (MCRDeveloperTools.overrideActive()) {
            final Optional overriddenFilePath = MCRDeveloperTools.getOverriddenFilePath(relativePath, false);
            if (overriddenFilePath.isPresent()) {
                try {
                    return overriddenFilePath.get().toUri().toURL();
                } catch (MalformedURLException e) {
                    // Ignore
                }
            }
        }

        File resolvedFile = getConfigFile("resources/" + relativePath);
        if (resolvedFile != null && resolvedFile.exists()) {
            try {
                return resolvedFile.toURI().toURL();
            } catch (MalformedURLException e) {
                LogManager.getLogger(MCRConfigurationDir.class)
                    .warn("Exception while returning URL for file: {}", resolvedFile, e);
            }
        }
        return getClassPathResource(relativePath, classLoader == null ? MCRClassTools.getClassLoader() : classLoader);
    }

    private static URL getClassPathResource(String relativePath, ClassLoader classLoader) {
        URL currentUrl = classLoader.getResource(relativePath);
        if (SERVLET_CONTEXT != null && currentUrl != null) {
            Enumeration resources = null;
            try {
                resources = classLoader.getResources(relativePath);
            } catch (IOException e) {
                LogManager.getLogger(MCRConfigurationDir.class)
                    .error("Error while retrieving resource: {}", relativePath, e);
            }
            if (resources != null) {
                File configDir = getConfigurationDirectory();
                String configDirURL = configDir.toURI().toString();
                @SuppressWarnings("unchecked")
                List libsOrder = (List) SERVLET_CONTEXT.getAttribute(ServletContext.ORDERED_LIBS);
                int pos = Integer.MAX_VALUE;
                while (resources.hasMoreElements()) {
                    URL testURL = resources.nextElement();
                    String testURLStr = testURL.toString();
                    if (testURLStr.contains(configDirURL)) {
                        return testURL; //configuration directory always wins
                    }
                    if (testURLStr.startsWith("file:")) {
                        //local files should generally win
                        pos = -1;
                        currentUrl = testURL;
                    }
                    if (pos > 0 && libsOrder != null /*if  present in web.xml */) {
                        for (int i = 0; i < libsOrder.size(); i++) {
                            if (testURLStr.contains(libsOrder.get(i)) && i < pos) {
                                currentUrl = testURL;
                                pos = i;
                            }
                        }
                    }
                }
            }
        }
        return currentUrl;
    }
}