/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2010-2013 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
// Portions Copyright [2016] [Payara Foundation]
package com.sun.appserv.server.util;
import java.io.File;
import java.io.FileFilter;
import java.io.FileReader;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Properties;
/**
*
* This class provides static methods to make accessible the version as well as
* the individual parts that make up the version
*
*/
public class Version {
private static final String INSTALL_ROOT_PROP_NAME = "com.sun.aas.installRoot";
private static final String PRODUCT_NAME_KEY = "product_name";
private static final String BRIEF_PRODUCT_NAME_KEY = "brief_product_name";
private static final String ABBREV_PRODUCT_NAME_KEY = "abbrev_product_name";
private static final String MAJOR_VERSION_KEY = "major_version";
private static final String MINOR_VERSION_KEY = "minor_version";
private static final String UPDATE_VERSION_KEY = "update_version";
private static final String PAYARA_VERSION_KEY = "payara_version";
private static final String PAYARA_UPDATE_VERSION_KEY = "payara_update_version";
private static final String BUILD_ID_KEY = "build_id";
private static final String VERSION_PREFIX_KEY = "version_prefix";
private static final String VERSION_SUFFIX_KEY = "version_suffix";
private static final String BASED_ON_KEY = "based_on";
private static final String DEFAULT_DOMAIN_TEMPLATE_NAME = "default_domain_template";
private static final String DEFAULT_DOMAIN_TEMPLATE_JAR = "nucleus-domain.jar";
private static final String ADMIN_CLIENT_COMMAND_NAME_KEY = "admin_client_command_name";
private static final String INITIAL_ADMIN_GROUPS_KEY = "initial_admin_user_groups";
private static List<Properties> versionProps = new ArrayList<Properties>();
private static Map<String,Properties> versionPropsMap = new HashMap<String,Properties>();
private static Properties versionProp = getVersionProp();
private static Properties getVersionProp() {
String installRoot = System.getProperty(INSTALL_ROOT_PROP_NAME);
if (installRoot != null) {
File ir = new File(installRoot);
File bd = new File(new File(ir, "config"), "branding");
if (bd.isDirectory()) {
for (File f : bd.listFiles(new FileFilter() {
@Override
public boolean accept(File f) {
return f.getName().endsWith(".properties") && f.canRead();
}
})) {
FileReader fr = null;
try {
fr = new FileReader(f);
Properties p = new Properties();
p.load(fr);
versionProps.add(p);
String apn = p.getProperty(ABBREV_PRODUCT_NAME_KEY);
if (apn != null) {
versionPropsMap.put(apn, p);
}
fr.close();
} catch (IOException ex) {
// ignore files that cannot be read
} finally {
if (fr != null) {
try {
fr.close();
} catch (IOException ex) {
// nothing to do
}
}
}
}
}
// sort the list based on the based-on property. If a is based on b,
// then a is earlier then b in the list.
Collections.sort(versionProps, new Comparator<Properties>() {
@Override
public int compare(Properties p1, Properties p2) {
String abp1 = p1.getProperty(ABBREV_PRODUCT_NAME_KEY);
String bo1 = p1.getProperty(BASED_ON_KEY);
String abp2 = p2.getProperty(ABBREV_PRODUCT_NAME_KEY);
String bo2 = p2.getProperty(BASED_ON_KEY);
if (bo1 != null && abp2 != null && bo1.contains(abp2)) {
return -1;
}
if (bo2 != null && abp1 != null && bo2.contains(abp1)) {
return 1;
}
return 0;
}
});
// save the first element in the list for later use
if (versionProps.size() > 0) {
return versionProps.get(0);
}
} else {
System.out.println("installRoot is null");
}
return null;
}
/**
* Returns version
*/
public static String getVersion() {
StringBuilder sb = new StringBuilder(getProductName());
sb.append(" ").append(getVersionPrefix());
sb.append(" ").append(getVersionNumber());
sb.append(".").append(getPayaraVersionNumber());
sb.append(" ").append(getVersionSuffix());
return sb.toString();
}
/**
* Return major_version [. minor_version [. update_version]]
*/
public static String getVersionNumber() {
// construct version number
String maj = getMajorVersion();
String min = getMinorVersion();
String upd = getUpdateVersion();
String v;
try {
if (min != null && min.length() > 0 && Integer.parseInt(min) >= 0) {
if (upd != null && upd.length() > 0 && Integer.parseInt(upd) >= 0) {
v = maj + "." + min + "." + upd;
} else {
v = maj + "." + min;
}
} else {
if (upd != null && upd.length() > 0 && Integer.parseInt(upd) >= 0) {
v = maj + ".0." + upd;
} else {
v = maj;
}
}
} catch (NumberFormatException nfe) {
v = maj;
}
return v;
}
/**
* Constructs and returns the full Payara version number
* @return The full Payara version number
*/
public static String getPayaraVersionNumber()
{
// Construct Version Number
String payaraVersion = getPayaraVersion();
String payaraUpdateVersion = getPayaraUpdateVersion();
String fullPayaraVersionNumber;
try
{
if (payaraUpdateVersion != null && payaraUpdateVersion.length() > 0
&& Integer.parseInt(payaraUpdateVersion) >= 0)
{
fullPayaraVersionNumber = payaraVersion + "."
+ payaraUpdateVersion;
}
else
{
fullPayaraVersionNumber = payaraVersion;
}
}
catch (NumberFormatException nfe)
{
fullPayaraVersionNumber = payaraVersion;
}
return fullPayaraVersionNumber;
}
/**
* Returns full version including build id
*/
public static String getFullVersion() {
return (getVersion() + " (build " + getBuildVersion() + ")");
}
/**
* Returns abbreviated version.
*/
public static String getAbbreviatedVersion() {
return getMajorVersion();
}
/**
* Returns Major version
*/
public static String getMajorVersion() {
return getProperty(MAJOR_VERSION_KEY, "0");
}
/**
* Returns Minor version
*/
public static String getMinorVersion() {
return getProperty(MINOR_VERSION_KEY, "0");
}
/**
* Returns Update version
*/
public static String getUpdateVersion() {
return getProperty(UPDATE_VERSION_KEY, "0");
}
/**
* Gets the Payara version from the properties file
* @return The Payara version number
*/
public static String getPayaraVersion()
{
return getProperty(PAYARA_VERSION_KEY, "0");
}
/**
* Gets the Payara update version from the properties file
* @return The Payara update number
*/
public static String getPayaraUpdateVersion()
{
return getProperty(PAYARA_UPDATE_VERSION_KEY, "0");
}
/**
* Returns Build version
*/
public static String getBuildVersion() {
return getProperty(BUILD_ID_KEY, "0");
}
/**
* Returns version prefix
*/
public static String getVersionPrefix() {
return getProperty(VERSION_PREFIX_KEY, "");
}
/**
* Returns version suffix
*/
public static String getVersionSuffix() {
return getProperty(VERSION_SUFFIX_KEY, "");
}
/**
* Returns Proper Product Name
*/
public static String getProductName() {
return getProperty(PRODUCT_NAME_KEY,
"Undefined Product Name - define product and version info in config/branding");
}
/**
* Returns Brief Product Name (used in manual pages)
*/
public static String getBriefProductName() {
return getProperty(BRIEF_PRODUCT_NAME_KEY, "Undefined Product Name");
}
/**
* Returns Abbreviated Product Name
*/
public static String getAbbrevProductName() {
return getProperty(ABBREV_PRODUCT_NAME_KEY, "undefined");
}
/**
* Returns template name use to create default domain.
*/
public static String getDefaultDomainTemplate() {
return getProperty(DEFAULT_DOMAIN_TEMPLATE_NAME, DEFAULT_DOMAIN_TEMPLATE_JAR);
}
/**
* Returns the admin client command string which represents the name of the
* command use for performing admin related domain tasks.
*/
public static String getAdminClientCommandName() {
return getProperty(ADMIN_CLIENT_COMMAND_NAME_KEY, "nadmin");
}
public static String getInitialAdminGroups() {
return getProperty(INITIAL_ADMIN_GROUPS_KEY, "asadmin");
}
/*
* Fetch the value for the property identified by key
* from the first Properties object in the list. If it doesn't exist
* look in the based on Properties, recursively. If still not found,
* return the default, def.
*/
private static String getProperty(String key, String def) {
return getProperty(versionProp, key, def);
}
private static String getProperty(Properties p, String key, String def) {
if (p == null) {
return def;
}
String v = p.getProperty(key);
if (v != null) {
return v;
}
String basedon = p.getProperty(BASED_ON_KEY);
if (basedon != null) {
Properties bp = versionPropsMap.get(basedon);
if (bp != null) {
return getProperty(bp, key, def);
}
}
return def;
}
}