com.axelor.common.VersionUtils.java Source code

Introduction

Here is the source code for com.axelor.common.VersionUtils.java

Source

/**
 * Axelor Business Solutions
 *
 * Copyright (C) 2005-2016 Axelor (<http://axelor.com>).
 *
 * This program is free software: you can redistribute it and/or  modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * This program 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package com.axelor.common;

import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import com.google.common.io.CharStreams;

/**
 * Provides helper methods to find version information of axelor projects.
 *
 */
public final class VersionUtils {

    private static Version version;

    private static final String VERSION_FILE = "axelor-version.txt";
    private static final Pattern VERSION_PATTERN = Pattern.compile("^(\\d+)\\.(\\d+)\\.(\\d+)(?:\\-rc(\\d+))?$");
    private static final Pattern VERSION_SPEC_PATTERN = Pattern
            .compile("(~)?((\\d+)\\.(\\d+)\\.(\\d+)(?:\\-rc(\\d+))?)");

    /**
     * This class stores version details of axelor modules.
     *
     */
    public static class Version {

        public final String version;

        // feature version (major.minor)
        public final String feature;

        public final int major;

        public final int minor;

        public final int patch;

        public final int rc;

        Version(String version) {
            final Matcher matcher = VERSION_PATTERN.matcher(version.trim());
            if (!matcher.matches()) {
                throw new IllegalStateException("Invalid version string.");
            }
            this.version = version.trim();
            this.major = Integer.parseInt(matcher.group(1));
            this.minor = Integer.parseInt(matcher.group(2));
            this.patch = Integer.parseInt(matcher.group(3));
            this.rc = matcher.group(4) != null ? Integer.parseInt(matcher.group(4)) : 0;
            this.feature = String.format("%s.%s", major, minor);
        }

        /**
         * Check whether the given version spec matches with current version.
         *
         * <p>
         * The version spec can be exact version number, or version number
         * prefixed with <code>~</code> it matches all subsequent patch
         * versions.
         * <p>
         * Giver a version <code>3.0.4<code> following holds:
         *
         * <ul>
         * <li> 3.0.4 (matches)</li>
         * <li> 3.0.0 (doesn't match)</li>
         * <li> ~3.0.0 (matches)</li>
         * <li> ~3.0.1 (matches)</li>
         * <li> ~3.0.5 (doesn't match)</li>
         * </ul>
         *
         * @param spec
         *            the version spec to test
         * @return true if matches false otherwise
         */
        public boolean matches(String spec) {
            if (spec == null || spec.trim().length() == 0) {
                return true;
            }
            Matcher matcher = VERSION_SPEC_PATTERN.matcher(spec);
            if (!matcher.matches()) {
                return false;
            }
            boolean all = matcher.group(1) != null;
            Version ver = new Version(matcher.group(2));
            if (ver.version.equals(version))
                return true;
            if (all && ver.major == major && ver.minor == minor && ver.patch <= patch) {
                return true;
            }
            return false;
        }

        @Override
        public String toString() {
            return version;
        }
    }

    /**
     * Get the Axelor SDK version.
     *
     * @return an instance of {@link Version}
     */
    public static Version getVersion() {
        if (version == null) {
            version = getVersion(VERSION_FILE);
        }
        return version;
    }

    private static Version getVersion(String file) {
        try (InputStream is = ClassUtils.getResourceStream(file)) {
            String version = CharStreams.toString(new InputStreamReader(is));
            return new Version(version);
        } catch (Exception e) {
            throw new IllegalStateException("Unable to read version details.", e);
        }
    }
}