RuntimeConstants.java

/*
 * This file is part of muCommander, http://www.mucommander.com
 *
 * muCommander 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.
 *
 * muCommander 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package com.mucommander;

import com.mucommander.commons.file.util.ResourceLoader;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.InputStream;
import java.util.jar.Attributes;
import java.util.jar.Manifest;

/**
 * Defines various generic muCommander constants.
 *
 * @author Nicolas Rinaudo
 */
public class RuntimeConstants {
    private static final Logger LOGGER = LoggerFactory.getLogger(RuntimeConstants.class);

    // - Constant paths ------------------------------------------------------------------------------------------------
    // -----------------------------------------------------------------------------------------------------------------
    /** Path to the themes directory. */
    public static final String THEMES_PATH = "/themes";
    /** Path to the muCommander license file. */
    public static final String LICENSE = "/license.txt";

    // - URLs ----------------------------------------------------------------------------------------------------------
    // -----------------------------------------------------------------------------------------------------------------
    /** Homepage URL. */
    public static final String HOMEPAGE_URL = "https://www.mucommander.com";
    /** GitHub URL */
    public static final String GITHUB_URL = "https://github.com/mucommander/mucommander";
    /** URL of the muCommander forums. */
    public static final String FORUMS_URL = GITHUB_URL + "/discussions/";
    /** URL at which to make a donation. */
    public static final String DONATION_URL = "https://github.com/sponsors/mucommander";
    /** URL at which to file a new bug. */
    public static final String REPORT_BUG_URL = GITHUB_URL + "/issues/new/";
    /** Documentation URL. */
    public static final String DOCUMENTATION_URL = GITHUB_URL + "/wiki/";

    // - Misc. ---------------------------------------------------------------------------------------------------------
    // -----------------------------------------------------------------------------------------------------------------
    /**
     * Release date to use in case the JAR file doesn't contain the information. This is guaranteed to trigger a
     * software update - the JAR file is corrupt, so we might as well get the latest version.
     */
    private static final String DEFAULT_RELEASE_DATE = "20020101";
    /** Current muCommander version (<code>MAJOR.MINOR.DEV</code>). */
    public static final String VERSION;
    /** Date at which the build was generated (<code>YYYYMMDD</code>). */
    public static final String BUILD_DATE;
    /** String describing the software (<code>muCommander vMAJOR.MINOR.DEV</code>). */
    public static final String APP_STRING;
    /** String describing the muCommander build number. */
    public static final String BUILD_NUMBER;
    /** Identifier of the last public commit that is included in the release. */
    public static final String GIT_HASH;

    // - Initialisation ------------------------------------------------------------------------------------------------
    // -----------------------------------------------------------------------------------------------------------------
    static {
        Attributes attributes = null; // JAR file's manifest's attributes.

        try (InputStream in = RuntimeConstants.class.getResourceAsStream("/META-INF/MANIFEST.MF")) {
            if (in != null) {
                Manifest manifest = new Manifest();
                manifest.read(in);
                attributes = manifest.getMainAttributes();
                LOGGER.info("muCommander version: {}", attributes.getValue("Specification-Version"));
            } else {
                LOGGER.warn("MANIFEST.MF not found, default values will be used");
            }
        } catch (Exception e) {
            LOGGER.warn("Failed to read MANIFEST.MF, default values will be used", e);
            // Ignore this, attributes is already set to null.
        }

        // No MANIFEST.MF found, use default values.
        if (attributes == null) {
            VERSION = "?";
            // We use a date that we are sure is later than the latest version to trigger the version checker.
            // After all, the JAR appears to be corrupt and should be upgraded.
            BUILD_DATE = DEFAULT_RELEASE_DATE;
            BUILD_NUMBER = "snapshot";
            GIT_HASH = "?";
        }

        // A MANIFEST.MF file was found, extract data from it.
        else {
            VERSION = getAttribute(attributes, "Specification-Version");
            BUILD_DATE = getAttribute(attributes, "Build-Date");
            BUILD_NUMBER = getAttribute(attributes, "Build-Number");
            GIT_HASH = getAttribute(attributes, "Implementation-Version");
        }
        APP_STRING = String.format("muCommander v%s", VERSION);
    }

    /**
     * Extract the requested attribute value.
     *
     * @param attributes
     *         attributes from which to extract the requested value.
     * @param name
     *         name of the attribute to retrieve.
     * @return the requested attribute value.
     */
    private static String getAttribute(Attributes attributes, String name) {
        String buffer;

        if ((buffer = attributes.getValue(name)) == null)
            return "?";
        return buffer;
    }
}