/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2000-2010 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.
 */

/*
 * @(#)Version.java	1.18 09/07/07
 */ 

package com.sun.messaging.jmq;

import java.util.*;
import java.io.*;
import com.sun.messaging.jmq.resources.SharedResources;

/**
 * This class provides the Version information about the product.
 * The information provided is only returning the version inofrmation for the client.
 * It is quite possible that the broker may be running at a different version level.
 * The version information such as Major release version , Minor release version 
 * service pack ,Product build date , JMS API version , Product name , Protocol version etc
 * can be obtained through the various helper methods exposed by this class.
 */

public class Version {

    /**
     * List of terms used to indicate a patch level. For example
     * 3.6sp2, 1.4.2_01, 5.0u1, 8.1ur1. Always list them in upper
     * case.
     */
    private static String  patchTermsList[] = {
        "SP", "UR", "_", "U", "PATCH", "UPDATE", 
    };

    /* A HashSet with the patch terms to allow fast lookup */
    private static HashSet patchTerms = new HashSet();

    static {
        /* Initialize HashSet with patch terms */
        for (int i = 0; i < patchTermsList.length; i++) {
            try {
                patchTerms.add(patchTermsList[i]);
            } catch (Exception e) {
                /* Should neverhappen */
                System.out.println("Version: Could not add patch term " + 
                    patchTermsList[i] + ": " + e);
            }
        }
    }

    /**
     *Private string representing the name and the path of the of the file which stores the version information 
     */
    private String propname = "/com/sun/messaging/jmq/version.properties";
    private String comm_propname = "/com/sun/messaging/jmq/brand_version.properties";

    /**
     *String representing the name of the property which is used for getting the home folder of the MQ product
     */
    private static String imqhome_propname = "imq.home";
    
    /**
     *String representing the variable name of the home folder of the MQ product
     */
    private static final String IMQ_HOME = System.getProperty(imqhome_propname,".");
    
    /**
     *String representing the location of the file that holds the pacth version of the product
     */
    private static final String PATCHIDFILE = IMQ_HOME + File.separator + 
					   "patches" + File.separator + "VERSION";
    /**
     * A private instance of the Properties object used to hold the properties read from the Version file.
     */
    private Properties props = null;

    /**
     *String representing the value of the mini copyright  of the product
     */
    private String miniCopyright =
        "Copyright (c) 2010, Oracle and/or its affiliates.  All rights reserved.";

    /**
     * String representing the shortCopyright of the product
     */
    private String shortCopyright =
        "Copyright (c) 2010, Oracle and/or its affiliates.  All rights reserved.";
/*
        "Copyright (c) 2010 Sun Microsystems, Inc. All rights reserved.\n" +
	"\n" +
        "Sun Microsystems, Inc. has intellectual property rights relating\n" +
        "to technology embodied in the product that is described in this\n" +
        "document.  In particular, and without limitation, these\n" +
        "intellectual property rights may include one or more of the U.S.\n" +
        "patents listed at http://www.sun.com/patents and one or more\n" +
        "additional patents or pending patent applications in the U.S.\n" +
        "and in other countries.\n" +
	"\n" +
        "U.S. Government Rights - Commercial software. Government users\n" +
        "are subject to the Sun Microsystems, Inc. standard license\n" +
        "agreement and applicable provisions of the FAR and its supplements.\n" +
	"\n" +
        "Use is subject to license terms.\n" +
	"\n" +
        "This distribution may include materials developed by third\n" +
        "parties.Sun, Sun Microsystems, the Sun logo, Java, Solaris,\n" +
        "SunTone, The Network is the Computer, We're the dot in .com,\n" +
        "iForce and Sun GlassFish Message Queue are trademarks or\n" +
        "registered trademarks of Sun Microsystems, Inc. in the U.S. and\n" +
        "other countries. All SPARC trademarks are used under license and\n" +
        "are trademarks or registered trademarks of SPARC International,\n" +
        "Inc. in the U.S. and other countries.\n" +
	"\n" +
        "UNIX is a registered trademark in the U.S. and other countries,\n" +
        "exclusively licensed through X/Open Company, Ltd.\n" +
	"\n" +
        "Sun Microsystems, Inc. d\u00e9tient les droits de propri\u00e9t\u00e9\n" +
        "intellectuels relatifs \u00e0 la technologie incorpor\u00e9e dans le\n" +
        "produit qui est d\u00e9crit dans ce document. En particulier, et ce\n" +
        "sans limitation, ces droits de propri\u00e9t\u00e9 intellectuelle peuvent\n" +
        "inclure un ou plus des brevets am\u00e9ricains list\u00e9s \u00e0 l'adresse\n" +
        "http://www.sun.com/patents et un ou les brevets suppl\u00e9mentaires\n" +
        "ou les applications de brevet en attente aux Etats - Unis et\n" +
        "dans les autres pays.\n" +
	"\n" +
        "L'utilisation est soumise aux termes du contrat de licence.\n" +
	"\n" +
        "Cette distribution peut comprendre des composants d\u00e9velopp\u00e9s par\n" +
        "des tierces parties.\n" +
	"\n" +
        "Sun, Sun Microsystems, le logo Sun, Java, Solaris, SunTone, The\n" +
        "Network is the Computer, We're the dot in .com, iForce et Sun\n" +
        "GlassFish Message Queue sont des marques de fabrique ou des\n" +
        "marques d\u00e9pos\u00e9es de Sun Microsystems, Inc. aux Etats-Unis et\n" +
        "dans d'autres pays.\n" +
	"\n" +
        "Toutes les marques SPARC sont utilis\u00e9es sous licence et sont des\n" +
        "marques de fabrique ou des marques d\u00e9pos\u00e9es de SPARC\n" +
        "International, Inc. aux Etats-Unis et dans d'autres pays.\n" +
	"\n" +
        "UNIX est une marque d\u00e9pos\u00e9e aux Etats-Unis et dans d'autres pays\n" +
        "et licenci\u00e9e exlusivement par X/Open Company, Ltd.\n";
*/

    /**
     *String representing the long copyright value of the product
     */
    private String longCopyright =
        "Copyright (c) 2010, Oracle and/or its affiliates.  All rights reserved.";
/*
        "Copyright (c) 2010 Sun Microsystems, Inc., 4150 Network Circle,\n" +
        "Santa Clara, California 95054, U.S.A.  All rights reserved.\n" +
	"\n" +
        "Sun Microsystems, Inc. has intellectual property rights relating\n" +
        "to technology embodied in the product that is described in this\n" +
        "document.  In particular, and without limitation, these\n" +
        "intellectual property rights may include one or more of the U.S.\n" +
        "patents listed at http://www.sun.com/patents and one or more\n" +
        "additional patents or pending patent applications in the U.S.\n" +
        "and in other countries.\n" +
	"\n" +
        "U.S. Government Rights - Commercial software.  Government users\n" +
        "are subject to the Sun Microsystems, Inc. standard license\n" +
        "agreement and applicable provisions of the FAR and its supplements.\n" +
	"\n" +
        "Use is subject to license terms.\n" +
	"\n" +
        "This distribution may include materials developed by third parties.\n" +
	"\n" +
        "Sun, Sun Microsystems, the Sun logo, Java, Solaris, SunTone, The\n" +
        "Network is the Computer, We're the dot in .com, iForce, Sun\n" +
        "GlassFish Message Queue , Sun Java Enterprise System and Sun Java\n" +
        "System are trademarks or registered trademarks of Sun\n" +
        "Microsystems, Inc. in the U.S. and other countries.\n" +
	"\n" +
        "All SPARC trademarks are used under license and are trademarks\n" +
        "or registered trademarks of SPARC International, Inc. in the\n" +
        "U.S. and other countries.  Products bearing SPARC trademarks are\n" +
        "based upon architecture developed by Sun Microsystems, Inc.\n" +
	"\n" +
        "UNIX is a registered trademark in the U.S. and other countries,\n" +
        "exclusively licensed through X/Open Company, Ltd.\n" +
	"\n" +
        "This product is covered and controlled by U.S. Export Control\n" +
        "laws and may be subject to the export or import laws in other\n" +
        "countries.  Nuclear, missile, chemical biological weapons or\n" +
        "nuclear maritime end uses or end users, whether direct or\n" +
        "indirect, are strictly prohibited.  Export or reexport to\n" +
        "countries subject to U.S. embargo or to entities identified on\n" +
        "U.S. export exclusion lists, including, but not limited to, the\n" +
        "denied persons and specially designated nationals lists is\n" +
        "strictly prohibited.\n" +
	"\n" +
        "Copyright (c) 2010 Sun Microsystems, Inc., 4150 Network Circle,\n" +
        "Santa Clara, California 95054, Etats-Unis.  Tous droits r\u00e9serv\u00e9s.\n" +
	"\n" +
        "Sun Microsystems, Inc. d\u00e9tient les droits de propri\u00e9t\u00e9\n" +
        "intellectuels relatifs \u00e0 la technologie incorpor\u00e9e dans le\n" +
        "produit qui est d\u00e9crit dans ce document.  En particulier, et ce\n" +
        "sans limitation, ces droits de propri\u00e9t\u00e9 intellectuelle peuvent\n" +
        "inclure un ou plus des brevets am\u00e9ricains list\u00e9s \u00e0 l'adresse\n" +
        "http://www.sun.com/patents et un ou les brevets suppl\u00e9mentaires\n" +
        "ou les applications de brevet en attente aux Etats - Unis et\n" +
        "dans les autres pays.\n" +
	"\n" +
        "L'utilisation est soumise aux termes de la Licence.\n" +
	"\n" +
        "Cette distribution peut comprendre des composants d\u00e9velopp\u00e9s par\n" +
        "des tierces parties.\n" +
	"\n" +
        "Sun, Sun Microsystems, le logo Sun, Java, Solaris, SunTone, The\n" +
        "Network is the Computer, We're the dot in .com, iForce, Sun Glassfish\n" +
        "Message Queue , Sun Java Enterprise System et Sun Java\n" +
        "System sont des marques de fabrique ou des marques d\u00e9pos\u00e9es de\n"+
        "Sun Microsystems, Inc. aux Etats-Unis et dans d'autres pays.\n" +
	"\n" +
        "Toutes les marques SPARC sont utilis\u00e9es sous licence et sont des\n" +
        "marques de fabrique ou des marques d\u00e9pos\u00e9es de SPARC\n" +
        "International, Inc. aux Etats-Unis et dans d'autres pays.  Les\n" +
        "produits portant les marques SPARC sont bas\u00e9s sur une\n" +
        "architecture d\u00e9velopp\u00e9e par Sun Microsystems, Inc.\n" +
	"\n" +
        "UNIX est une marque d\u00e9pos\u00e9e aux Etats-Unis et dans d'autres pays\n" +
        "et licenci\u00e9e exlusivement par X/Open Company, Ltd.\n" +
	"\n" +
        "Ce produit est soumis \u00e0 la l\u00e9gislation am\u00e9ricaine en mati\u00e8re de\n" +
        "contr\u00f4le des exportations et peut \u00eatre soumis \u00e0 la\n" +
        "r\u00e8glementation en vigueur dans d'autres pays dans le domaine des\n" +
        "exportations et importations.  Les utilisations, ou utilisateurs\n" +
        "finaux, pour des armes nucl\u00e9aires,des missiles, des armes\n" +
        "biologiques et chimiques ou du nucl\u00e9aire maritime, directement\n" +
        "ou indirectement, sont strictement interdites.  Les exportations\n" +
        "ou r\u00e9exportations vers les pays sous embargo am\u00e9ricain, ou vers\n" +
        "des entit\u00e9s figurant sur les listes d'exclusion d'exportation\n" +
        "am\u00e9ricaines, y compris, mais de mani\u00e8re non exhaustive, la liste\n" +
        "de personnes qui font objet d'un ordre de ne pas participer,\n" +
        "d'une fa\u00e7on directe ou indirecte, aux exportations des produits\n" +
        "ou des services qui sont r\u00e9gis par la l\u00e9gislation am\u00e9ricaine en\n" +
        "mati\u00e8re de contr\u00f4le des exportations et la liste de\n" +
        "ressortissants sp\u00e9cifiquement d\u00e9sign\u00e9s, sont rigoureusement\n" +
        "interdites.\n";
*/

    /**
     * Represents the mini copyright value for the product
     */
    public final static int MINI_COPYRIGHT	= 0;
    
    /**
     *Represents the short copyright value for the product
     */
    public final static int SHORT_COPYRIGHT	= 1;
    
    /**
     *Represents the long copyright value for the product
     */
    public final static int LONG_COPYRIGHT	= 2;

    /**
     *String representing the pacakgae value of the Version class
     */
    private static String thisPackage="com.sun.messaging";

    /**
     *Reference of the SharedResource object instance
     */
    private static SharedResources rb = SharedResources.getResources();

    private boolean isJar = false;

    /**
     *Constructor for this class  
     */
    public Version() {
        this(true);
    }

    public Version(boolean isJar) {
      this.isJar = isJar;
      try {
	InputStream is = getClass().getResourceAsStream(propname);
	if (is == null) {
	    System.err.println(rb.getString(rb.E_VERSION_PROPS));
	}
	props = new Properties();
	props.load(is);

	/*
	 * Load commercial version of property file if it exists.
	 * XXX might want to add version checks here prior to loading it.
	 */
	is = getClass().getResourceAsStream(comm_propname);
	if (is != null) {
	    props.load(is);
	}

      } catch (Exception ex) {
	    System.err.println(rb.getString(rb.E_VERSION_LOAD));
	    ex.printStackTrace();
      }

    }

    /**
     *Returns the properties object that holds the various version properties and their values.
     *This is a private method , not for general use.This method may be removed in the future release without
     *further warning
     *@return Properties object holding the name value pair of the version property name and it's 
     *corresponding values
     */
    public Properties getProps() {
	return props;
    }

    /**
     *Returns the product version as a string 
     *The returned string has the information about the major release, minor release and service packs if any example 3.6 SP1
     *This is a private method , not for general use.This method may be removed in the future release without further warning
     *@return String representing the product version 
     */
    public String getProductVersion() {
        return props.getProperty("imq.product.version");
    }

    /**
     *Returns the Major release of the Product version for example if the 
     *release value is 3.6.1 then the major version value will be 3.
     *@return an integer representing the major release version value 
     *        if there is an exception returns -1
     */
    public int getMajorVersion() {
      try {
	return Integer.parseInt(props.getProperty("imq.product.major"));
      } catch (Exception ex) {
        return -1;
      }

    }

    /**
     *Returns the Minor release of the Product version for example if 
     *the release value is 3.6.1 then the returned value of minor version will be 6 
     *@return an integer representing the minor release version value
     *        if there is an exception returns -1
     */
    public int getMinorVersion() {
       try {
	return Integer.parseInt(props.getProperty("imq.product.minor"));
      } catch (Exception ex) {
        return -1;
      }
   }

    /**
     *Returns the value of the particular version property
     *for example if the requested property is 'imq.product.version' the returned value will be 3.6
     *This is a private method , not for general use.This method may be removed in the future release without
     *further warning
     *@param name String representing the name of the property whose value is desired
     *@return String representing the value of the desired property  
     */
    public String getVersionProperty(String name) {
	return props.getProperty(name);
    }

    /**
     *Returns the Build Mile Stone value of the product being used for example 'Beta'
     *This is a private method , not for general use.This method may be removed in the future release without
     *further warning
     *@return String representing the Milestone Build value of the product 
     */
    public String getBuildMilestone() {
	String milestone = props.getProperty("imq.build.milestone");
        if ("FCS".equals(milestone)) {
            return ""; 
        } else {
            return milestone;
        }
    }

   /**
     *Returns the Build date value of the product in the following format 
     *'Day Month Date Time Year' example Mon June  1 09:03:29 IST 2007
     *This is a private method , not for general use.This method may be removed in the future release without
     *further warning
     *@return String representing the date of the build of the product being used
     */ 
    public String getBuildDate() {
	return props.getProperty("imq.build.date");
    }

    /**
     *Returns the Build version value of the product
     *The returned string is the concatnated value of the product version,build number and promoted build.   
     *This is a private method , not for general use.This method may be removed in the future release without
     *further warning
     *@return String representing the Build Version of the product being used
     */
    public String getBuildVersion() {
	return (props.getProperty("imq.product.version") + " " +
                getBuildMilestone() + " (Build " + props.getProperty("imq.build.number") +
                "-" + props.getProperty("imq.build.letter") + ")" );
    }

    /**
     *Returns the product name example Oracle GlassFish(tm) Server Message Queue
     *@return String representing the name of the product
     */
    public String getProductName() {
        if (isJar)
            return props.getProperty("imq.product.jarname");
	return props.getProperty("imq.product.name");
    }
    /**
     *Returns the product release qtr ID example 2004Q4
     *@return String representing the release quarter ID
     */
    public String getReleaseQID() {
	return props.getProperty("imq.product.releaseqid");
    }


   /**
    *Returns the abbreviated name of the product, for example "MQ".
    *This is a private method , not for general use.This method may be removed in the future release without
    *further warning
    *@return String representing the abbreviated name of the product
    */
    public String getAbbreviatedProductName() {
	return props.getProperty("imq.product.name.abbrev");
    }

   /**
    *Returns the lower case of the abbreviated name of the product,
    *for example "mq".
    *This is a private method , not for general use.This method may be removed in the future release without
    *further warning
    *@return String representing the abbreviated name of the product
    */
    public String getLowerCaseAbbreviatedProductName() {
	return props.getProperty("imq.product.name.abbrev.lowercase");
    }

    /**
    *Returns the short name of the product, for example "Message Queue".
    *This is a private method , not for general use.This method may be removed in the future release without
    *further warning
    *@return String representing the short name of the product
    */
    public String getShortProductName() {
	return props.getProperty("imq.product.name.short");
    }

    /**
     *Returns the copyright date of the product example copyright 2007
     *This is a private method , not for general use.This method may be removed in the future release without
     *further warning
     *@return String representing the copyright date of the product
     */
    public String getProductCopyrightDate() {
	return props.getProperty("imq.product.copyright.date");
    }

    /**
     *Returns the product company's name example Sun Microsystems Inc
     *This is a private method , not for general use.This method may be removed in the future release without
     *further warning
     *@return String representing the Product Company's name 
     */
    public String getProductCompanyName() {
	return  props.getProperty("imq.product.companyname");
    }

    /**
     *Returns the implementation package name of the product example (com.sun.messaging)
     *This is a private method , not for general use.This method may be removed in the future release without
     *further warning
     *@return String representing the pacakge name
    */
    public String getVersionPackageName() {
	return props.getProperty("imq.version.package");
    }

    /**
     *Returns the implementation version of the product example 3.6
     *@return String representing the implementation version of the product
    */
    public String getImplementationVersion() {
	return props.getProperty("imq.api.version");
    }

    /**
     * Returns the protocol version of the product. There is a properitory
     * protocol used to communicate with the broker and amongst the brokers.This value 
     * will tell which version is currently being used. If there are no change's then the previous value
     * will be carried forward and retuned. example 3.6
     *This is a private method , not for general use.This method may be removed in the future release without
     *further warning
     *@return String representing the protocol version of the product
    */
    public String getProtocolVersion() {
	return props.getProperty("imq.protocol.version");
    }

    /**
     *Returns the JMS API version the product implements example 1.1
     *@return String representing the JMS API version which the product is compliant to
    */
    public String getTargetJMSVersion() {
	return props.getProperty("imq.jms.api.version");
    }

    /**
     * Returns whether this is the commercial version of the product
     * @return boolean True if this is the commercial product (ie SJSMQ), false if this is not the 
     * commercial version (ie OpenMQ).
    */
    public boolean isCommercialProduct() {
	boolean ret = false;

	String val = props.getProperty("imq.product.brand");

	return (Boolean.parseBoolean(val));
    }

    /**
     * checks if the commercial product version matches the other jars
     *
     */
     public boolean isProductValid() {
         if (!isCommercialProduct()) return true;
         // ok, retrieve the major,micro,minor versions
         int major = getMajorVersion();
         int minor = getMinorVersion();

         // now get the product version in comm
         int major_comm = -1;
         int minor_comm = -1;
         try {
	        major_comm = Integer.parseInt(props.getProperty("imq.product.brand.major"));
	        minor_comm = Integer.parseInt(props.getProperty("imq.product.brand.minor"));
         } catch (Exception ex) { // bad value, oh well
         }
         return (major_comm == major) && (minor_comm == minor);

     }

    /**
     * Returns the User Agent value of the product. This is the concatnated string having 
     * values of Productversion, Operating System on which the product runs,
     * the version of the operating system and the operating system architecture
     * example : SJSMQ/3.6 (JMS; SunOS 5.9 sun4u)
     *This is a private method , not for general use.This method may be removed in the future release without
     *further warning
     * @return the String representing the value of the UserAgent 
     * 
     */
    public String getUserAgent() {
        return getShortProductName() + "/" + getProductVersion() + " " +
	"(JMS; " + System.getProperty("os.name") + " " +
	 System.getProperty("os.version") + " " +
	 System.getProperty("os.arch") + ")";
    }

    /**
     *Returns the banner for the product. The banner comprises of the Product name,Company name
     *Product version, Build value, Build Date, Copyright value in a formatted manner   
     *This is a private method , not for general use.This method may be removed in the future release without
     *further warning
     *@return String representing the banner 
     */
    public String toString() {
	return getBanner(false);
    }

/* banner:

==================================================================
Oracle GlassFish(tm) Server Message Queue
Sun Microsystems, Inc.
Version:  3.6 [Alpha] (Build 143-a)
Compile:  Thu Feb 27 11:48:41 PST 2007

<Short copyright notic>
==================================================================

*/
    /**
     *Returns the header value for the banner being used for the product
     *This header value will be for the SHORT_COPYRIGHT value by default.   
     *This is a private method , not for general use.This method may be removed in the future release without
     *further warning
     *@return a string reperesenting the header details 
     */
    public String getHeader() {
        return (getHeader(LONG_COPYRIGHT));
    }

    /**
     *Returns the header for the given copyright
     *This is a private method , not for general use.This method may be removed in the future release without
     *further warning
     *@param copyrightType an integer value of the valid copyright type MINI_COPYRIGHT, SHORT_COPYRIGHT, LONG_COPYRIGHT
     *@return String value of the header
     */
    public String getHeader(int copyrightType) {
	return 
	    rb.getString(rb.I_BANNER_LINE)
	    + getProductName() + " " + getReleaseQID() + rb.NL 

            + getProductCompanyName() + rb.NL

            + rb.getString(rb.I_VERSION) + getBuildVersion() + rb.NL

            + rb.getString(rb.I_COMPILE) + getBuildDate()  + rb.NL + rb.NL

	    + getCopyright(copyrightType) + rb.NL 
	    + rb.getString(rb.I_BANNER_LINE);
    }
    
    /**
     * Return a version string suitable for use by the JMSRA resource adapter
     * This is something like 
     * "GlassFish MQ JMS Resource Adapter: Version:  4.5  (Build 23-k)Compile:  15/12/2010"
     * @return
     */
    public String getRAVersion(){
    	return rb.getString(rb.I_VERSION) + getBuildVersion()+ " "+ rb.getString(rb.I_COMPILE) + getBuildDate();
    }

    
    /**
     *Returns the copyright value for the desired copyright type passed as an argument 
     *This is a private method , not for general use.This method may be removed in the future release without
     *further warning
     *@param copyrightType an integer value of the copyright type valid values are MINI_COPYRIGHT, SHORT_COPYRIGHT, LONG_COPYRIGHT
     *@return String value of the copyright
     */
    public String getCopyright(int copyrightType) {
	switch (copyrightType)  {
	case MINI_COPYRIGHT:
	    return (miniCopyright);
	case SHORT_COPYRIGHT:
	    return (shortCopyright);
	case LONG_COPYRIGHT:
	    return (longCopyright);
	default:
	    return (shortCopyright);
	}
    }

    /**
     * Returns patch ID's for the product which will be an array of String comprising of all the patches for this product.
     * Each entry will be in the following format 'Major version.Minor Version_patchid number'
     * Can be used to format the patchids in your own app.
     *This is a private method , not for general use.This method may be removed in the future release without
     *further warning
     *@return array of String comprising the patchid's
     */
    public String[] getPatchIds() {
        File patchFile = new File(PATCHIDFILE);

	// Check if patch version file exists.
	if (!patchFile.exists()) {
	    return null;
        }

	// Check if patch version file can be read.
	if (!patchFile.canRead()) {
	    return null;
	}

	// Read the patch version file.
 	FileInputStream fis;
        Properties patchProps = new Properties();

        try {
	   fis = new FileInputStream(PATCHIDFILE);
	   patchProps.load(fis);
        } catch (Exception e) {
	   return null;	
        }

	// Parse any lines that start with "2.0".
	String propName = getMajorVersion() + "." + getMinorVersion();
/*
	String propValue = patchProps.getProperty(propName);

	if (propValue == null) {
	    return null;
	}

	// Parse out the patch ids and stuff then into array.
        // They can be in the format NNNNNN:DATE. 
	StringTokenizer toks = new StringTokenizer(propValue, ",");
	String[] patchids = new String[toks.countTokens()];
	int i = 0;

	while (toks.hasMoreTokens()) {
	    String fullString = toks.nextToken().trim();
	    int endIndex = fullString.indexOf(":");
	    if (endIndex == -1 && !fullString.equals(""))  // no :date 111111-01
	        patchids[i++] = fullString;
	    else if (endIndex == 0) {    // Nothing in front of :date
	   	continue; 
	    } else if (endIndex != -1) {
	        patchids[i++] = fullString.substring(0, endIndex);
	    }
	}
*/
	/* Find properties in the format:
	 * 		   2.0_1=111111-08
	 *                 2.0_2=222222-01
         */
	String[] patchids = new String[1000];

	int num = 0;
	for (int i = 1; i < patchids.length; i++) {
	    String propValue = patchProps.getProperty(propName + "_" + i);
	    if (propValue == null)
	        break;
	    patchids[num++] = propValue;
	}

	/*
	 * Return the actual length of the array.
	 */
	String[] retids = new String[num];
	for (int i = 0; i < num; i++) {
	    retids[i] = patchids[i];
	}

	return retids;
    }

    /**
     * Returns the patch string in the format:
     *    Installed Patch ID(s):           111111-01  
     * 					   222222-01   
     *                                     NNNNNN-NN
     *This is a private method , not for general use.This method may be removed in the future release without
     *further warning
     *@return a string representing all the patches for the product.
     */
    public String getPatchString() {

	String[] patchids = getPatchIds();
	String ret = "";

	if (patchids == null) {
	    ret = "";
	} else if (patchids.length == 0) {
	    ret = "";
	} else if (patchids.length >= 1) {
	    for (int j = 0; j < patchids.length; j++) {
		if (patchids[j] == null)
		    break;
		else if (ret.equals(""))  // first line, so prepend description.
	    	    ret += rb.getString(rb.I_PATCHES) + patchids[j] + rb.NL;
		else if (patchids[j] != null) {    // prepend indent 
		    ret += rb.getString(rb.I_PATCH_INDENT) + patchids[j] + rb.NL ;
		}
	    }
	}

	return ret;
    }

    /**
     *Returns the JMSAdmin SPI version value of the product. This is the Admin SPI implementation value.
     *The value is not the same as the Product API implementation or the JMS API version. example 2.0
     *This is a private method , not for general use.This method may be removed in the future release without
     *further warning
     *@return String value of the JMSAdmin SPI version  
     */
    public String getJMSAdminSpiVersion() {
	return  props.getProperty("imq.jmsadmin.spi.version");
    }


    /**
     *Returns the Version info of the product, this string is the concatanated value
     *of pacakage name, API version, Protocol version, JMS API version, and the patch information.
     *@return the String value of the product version info
     */
    public String getVersion() {
	return getVersionPackageName() + rb.getString(rb.I_VERSION_INFO) +
	          rb.getString(rb.I_IMPLEMENTATION) + getImplementationVersion() + rb.NL +
	          rb.getString(rb.I_PROTOCOL_VERSION) + getProtocolVersion() + rb.NL +
	          rb.getString(rb.I_TARGET_JMS_VERSION) + getTargetJMSVersion() + rb.NL +
		  getPatchString();
   }

    /**
     *Returns the banner details for the default copyright type: SHORT_COPYRIGHT
     *This is a private method , not for general use.This method may be removed in the future release without
     *further warning
     *@param alldata a boolean value indicating that is it desired to get a detailed info
     *@return a String representing the banner 
     */
    public String getBanner(boolean alldata) {
	return (getBanner(alldata, SHORT_COPYRIGHT));
    }

    /**Returns the banner details for a given copyright type.
     *This is a private method , not for general use.This method may be removed in the future release without
     *further warning
     *@param alldata  a boolean value indicating whether you want a detailed info(true) or not(false) 
     *@param copyrightType an integer representing the copyright for which the banner detail is required
     *valid values are SHORT_COPYRIGHT, MINI_COPYRIGHT, LONG_COPYRIGHT
     *@return the string representing the banner 
     */
    public String getBanner(boolean alldata, int copyrightType) {
 	if (props == null) {
		return rb.getString(rb.E_VERSION_INFO) + thisPackage;
	}
	if (alldata) return getHeader(copyrightType) + getVersion();
	return getHeader(copyrightType);
			
   }


    /**
     * Returns the Version info in the form of an array of integer. 
     * Parse a version string into four integers. The four integers
     * represent the major product version, minor product version,
     * micro product version and patch level.
     *
     * The parser supports a variey of patch level syntax convetions,
     * for example "sp2", "_01", "ur4", etc. These are listed in the
     * patchTerms() hashTable.
     *
     * Anything at the end of the version string that does not match
     * a patch syntax is ignored, so this handles the JDK convetion
     * of using a '-' to delimit a  milestone string. 
     * Examples:
     *
     * 3.0.1sp2     = 3 0 1 2 
     * 3.0.1 sp 2   = 3 0 1 2
     * 3.5 sp 2     = 3 5 0 2
     * 3.5.0.2      = 3 5 0 2
     * 1.4.1_02     = 1 4 1 2
     * 1.4_02       = 1.4 0 2
     * 2            = 2 0 0 0
     * 1.4.1-beta2  = 1 4 1 0
     * 8.1ur1       = 8 1 0 1
     * 5.0u1        = 5 0 0 1
     *
     * Note that this implementation has not been optimized for speed!
     *
     * @param str String representing the product version
     * 
     * @return array of integers where
     *    int[0] = major Version
     *    int[1] = minor version
     *    int[3] = micro version
     *    int[4] = patch level
     *
     */
    public static int[] getIntVersion(String str) throws NumberFormatException
    {
        int[] returnver = new int[4]; // major, minor, micro, patch

        // Remove any non-digits from the end of the string.
        String newstr = stripTrailingLetters(str.toUpperCase().trim());
        String spstr = null;


        StringTokenizer tkn = new StringTokenizer(newstr, ".");
        String token = "";

        int i = 0;
        while (tkn.hasMoreTokens() && i < 4) {
            token = tkn.nextToken();
            //System.out.println("token=" + token);
            try {
                // Normal '.' seperated version number
                returnver[i] = Integer.parseInt(token);
                i++;
            } catch (NumberFormatException e) {
                int pos = 0;

                // In the case of 3.6sp2 we are now at
                // "6sp2". We need to get the "6"
                if (Character.isDigit(token.charAt(pos))) {
                    String value = getNumber(token);
                    try {
                        returnver[i] = Integer.parseInt(value);
                        i++;
                    } catch (NumberFormatException ex) {
                        // Should never occur
                        System.out.println("Can't parse " + token + ": " + e);
                    }

                    pos += value.length();

                    token = token.substring(pos);
                }

                // Now at patch identifier (i.e. "sp2")
                // Scan until we hit a number
                for (pos = 0; pos < token.length(); pos++) {
                    if (Character.isDigit(token.charAt(pos))) {
                        break;
                    }
                }

                // Make sure patch string is something we recognize
                String patchString = token.substring(0, pos).trim();
                if (patchTerms.contains(patchString)) {
                    // Number follows patchstring.
                    String patchNumber = token.substring(pos);
                    patchNumber = getNumber(patchNumber);
                    try {
                        returnver[3] = Integer.parseInt(patchNumber);
                    } catch (NumberFormatException e2) {
                        // patch number is invalid
                    }
                } 

                break;
            }
        }
        return returnver;
    }

    /**
     * Get the number that starts a string
     */
    static String getNumber(String s) {

        int j;
        for (j = 0; j < s.length(); j++) {
            // Scan until we hit a non-digit
            if (! Character.isDigit(s.charAt(j))) {
                break;
            }
        }
        return s.substring(0, j);
    }

    /**
     * Strip any trailing non-digit characters from a string.
     * So
     *   1.4.2_02a becomes 1.4.2_02
     *   3.5 beta  becomes 3.5
     *   01b       becomes 01
     *   3.5 beta1 stays   3.5 beta1
     * 
     */
    private static String stripTrailingLetters(String s) {

        boolean stripping = false;

        // Scan from end of string
        int n = s.length() - 1;
        while (!Character.isDigit(s.charAt(n))) {
            // Skip over letters
            n--;
        }

        if (n == s.length() - 1) {
            // No letters
            return s;
        } else {
            return s.substring(0, n+1);
        }
    }

    /**
     *Returns the comparison result of the two versions of the product passed as argument
     *assuming service packs have no incompatibilities
     *This is a private method , not for general use.This method may be removed in the future release without
     *further warning
     *@param stra representing the version which need to be compared
     *@param strb representing the second version string that needs to be compared.
     *@return   -1 If stra is less than strB
     *           0 If stra is equal to strb
     *           1 If stra is greater than strbB
    */
    public static int compareVersions(String stra,String strb)
    {
        return compareVersions(stra, strb, true);

    }

    /**
     * Returns the Comparison results of the two product versions.
     * This is a private method , not for general use.This method may be removed in the future release without
     * further warning
     * @param   verA    First version string
     * @param   verB    Second version string
     * @param   ignoreServicePack   true to ignore the service pack or patch
     *                              level
     * @return  -1 If verA is less than verB
     *           0 If verA is equal to verB
     *           1 If verA is greater than verB
     */
    public static int compareVersions(String verA, String verB, boolean ignoreServicePack) throws NumberFormatException
    {
        int[] aver = getIntVersion(verA);
        int[] bver = getIntVersion(verB);
        if (ignoreServicePack) {
            aver[3] = 0;
            bver[3] = 0;
        }
        return compareVersions(aver, bver);

    }

    /**
     *Compares the two versions which are in the form of array,s. The array encapsulate's
     *the major,minor,micro and service pack details of each version string.
     *This is a private method , not for general use.This method may be removed in the future release without
     *further warning
     *@param s1 the first array of integer representing the versin info
     *@param s2 the second array of interger representing the version info that has to be compared
     *@return    -1 If s1 is less than s2
     *           0 If s1 is equal to s2
     *           1 If s1 is greater than s2
     */
    public static int compareVersions(int[] s1, int[] s2) {

        //OK compare the longest of the lengths
        // assume any missing length is 0
        int comparelen = (s1.length > s2.length ? s1.length : s2.length);

        int indx = 0;

        while (indx < comparelen) {
            int val1 = (s1.length >indx ? s1[indx] : 0);
            int val2 = (s2.length >indx ? s2[indx] : 0);
            if (val1 > val2)
                return 1;
            if (val1 < val2)
                return -1;
            indx ++;
        }
        
        return 0;
    }
    
    /**
     *Returns the Version String value of the version info passed as an array of integer
     *This is a private method , not for general use.This method may be removed in the future release without
     *further warning
     *@param ver an array of integer reperesenting the version info int[0]=major int[1]=minor int[2]=micro int[3]=service pack 
     *@return a String value of the data passed in the integer array
     *
    */
    public static String toVersionString(int[] ver) {
        String s = "";
        for (int i =0; i < ver.length; i ++) {
            s += ver[i];
            if (i+1 < ver.length)
               s += ".";
        }
        return s;
    }
   
    /**
     *This method makes the class executable. When the class is executed  the product banner
     *will be printed providing information comprising of product version , product name , organization name
     *build details and the short copyright info.
     *This is a private method , not for general use.This method may be removed in the future release without
     *further warning
     */
    public static void main(String[] args)
    {
      Version v = new Version();
      System.out.println(v);
    }
    
}

