1. /*

  2.  * Copyright  2002-2004 The Apache Software Foundation

  3.  *

  4.  *  Licensed under the Apache License, Version 2.0 (the "License");

  5.  *  you may not use this file except in compliance with the License.

  6.  *  You may obtain a copy of the License at

  7.  *

  8.  *      http://www.apache.org/licenses/LICENSE-2.0

  9.  *

  10.  *  Unless required by applicable law or agreed to in writing, software

  11.  *  distributed under the License is distributed on an "AS IS" BASIS,

  12.  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  13.  *  See the License for the specific language governing permissions and

  14.  *  limitations under the License.

  15.  *

  16.  */

  17. package org.apache.tools.ant.util;

  18. 

  19. import java.io.File;

  20. import java.util.Vector;

  21. import org.apache.tools.ant.taskdefs.condition.Os;

  22. 

  23. /**

  24.  * A set of helper methods related to locating executables or checking

  25.  * conditons of a given Java installation.

  26.  *

  27.  *

  28.  * @since Ant 1.5

  29.  */

  30. public class JavaEnvUtils {

  31. 

  32.     /** Are we on a DOS-based system */

  33.     private static final boolean isDos = Os.isFamily("dos");

  34.     /** Are we on Novell NetWare */

  35.     private static final boolean isNetware = Os.isName("netware");

  36.     /** Are we on AIX */

  37.     private static final boolean isAix = Os.isName("aix");

  38. 

  39.     /** shortcut for System.getProperty("java.home") */

  40.     private static final String javaHome = System.getProperty("java.home");

  41. 

  42.     /** FileUtils instance for path normalization */

  43.     private static final FileUtils fileUtils = FileUtils.newFileUtils();

  44. 

  45.     /** Version of currently running VM. */

  46.     private static String javaVersion;

  47. 

  48.     /** floating version of the JVM */

  49.     private static int javaVersionNumber;

  50. 

  51.     /** Version constant for Java 1.0 */

  52.     public static final String JAVA_1_0 = "1.0";

  53.     /** Version constant for Java 1.1 */

  54.     public static final String JAVA_1_1 = "1.1";

  55.     /** Version constant for Java 1.2 */

  56.     public static final String JAVA_1_2 = "1.2";

  57.     /** Version constant for Java 1.3 */

  58.     public static final String JAVA_1_3 = "1.3";

  59.     /** Version constant for Java 1.4 */

  60.     public static final String JAVA_1_4 = "1.4";

  61.     /** Version constant for Java 1.5 */

  62.     public static final String JAVA_1_5 = "1.5";

  63. 

  64.     /** array of packages in the runtime */

  65.     private static Vector jrePackages;

  66. 

  67. 

  68.     static {

  69. 

  70.         // Determine the Java version by looking at available classes

  71.         // java.lang.Readable was introduced in JDK 1.5

  72.         // java.lang.CharSequence was introduced in JDK 1.4

  73.         // java.lang.StrictMath was introduced in JDK 1.3

  74.         // java.lang.ThreadLocal was introduced in JDK 1.2

  75.         // java.lang.Void was introduced in JDK 1.1

  76.         // Count up version until a NoClassDefFoundError ends the try

  77. 

  78.         try {

  79.             javaVersion = JAVA_1_0;

  80.             javaVersionNumber = 10;

  81.             Class.forName("java.lang.Void");

  82.             javaVersion = JAVA_1_1;

  83.             javaVersionNumber++;

  84.             Class.forName("java.lang.ThreadLocal");

  85.             javaVersion = JAVA_1_2;

  86.             javaVersionNumber++;

  87.             Class.forName("java.lang.StrictMath");

  88.             javaVersion = JAVA_1_3;

  89.             javaVersionNumber++;

  90.             Class.forName("java.lang.CharSequence");

  91.             javaVersion = JAVA_1_4;

  92.             javaVersionNumber++;

  93.             Class.forName("java.lang.Readable");

  94.             javaVersion = JAVA_1_5;

  95.             javaVersionNumber++;

  96.         } catch (Throwable t) {

  97.             // swallow as we've hit the max class version that

  98.             // we have

  99.         }

  100.     }

  101. 

  102.     /**

  103.      * Returns the version of Java this class is running under.

  104.      * @return the version of Java as a String, e.g. "1.1"

  105.      */

  106.     public static String getJavaVersion() {

  107.         return javaVersion;

  108.     }

  109. 

  110.     /**

  111.      * Compares the current Java version to the passed in String -

  112.      * assumes the argument is one of the constants defined in this

  113.      * class.

  114.      * @return true if the version of Java is the same as the given

  115.      * version.

  116.      * @since Ant 1.5

  117.      */

  118.     public static boolean isJavaVersion(String version) {

  119.         return javaVersion == version;

  120.     }

  121. 

  122.     /**

  123.      * Finds an executable that is part of a JRE installation based on

  124.      * the java.home system property.

  125.      *

  126.      * <p><code>java</code>, <code>keytool</code>,

  127.      * <code>policytool</code>, <code>orbd</code>, <code>rmid</code>,

  128.      * <code>rmiregistry</code>, <code>servertool</code> and

  129.      * <code>tnameserv</code> are JRE executables on Sun based

  130.      * JRE's.</p>

  131.      *

  132.      * <p>You typically find them in <code>JAVA_HOME/jre/bin</code> if

  133.      * <code>JAVA_HOME</code> points to your JDK installation.  JDK

  134.      * < 1.2 has them in the same directory as the JDK

  135.      * executables.</p>

  136.      *

  137.      * @since Ant 1.5

  138.      */

  139.     public static String getJreExecutable(String command) {

  140.         if (isNetware) {

  141.             // Extrapolating from:

  142.             // "NetWare may have a "java" in that directory, but 99% of

  143.             // the time, you don't want to execute it" -- Jeff Tulley

  144.             // <JTULLEY@novell.com>

  145.             return command;

  146.         }

  147. 

  148.         File jExecutable = null;

  149. 

  150.         if (isAix) {

  151.             // On IBM's JDK 1.2 the directory layout is different, 1.3 follows

  152.             // Sun's layout.

  153.             jExecutable = findInDir(javaHome + "/sh", command);

  154.         }

  155. 

  156.         if (jExecutable == null) {

  157.             jExecutable = findInDir(javaHome + "/bin", command);

  158.         }

  159. 

  160.         if (jExecutable != null) {

  161.             return jExecutable.getAbsolutePath();

  162.         } else {

  163.             // Unfortunately on Windows java.home doesn't always refer

  164.             // to the correct location, so we need to fall back to

  165.             // assuming java is somewhere on the PATH.

  166.             return addExtension(command);

  167.         }

  168.     }

  169. 

  170.     /**

  171.      * Finds an executable that is part of a JDK installation based on

  172.      * the java.home system property.

  173.      *

  174.      * <p>You typically find them in <code>JAVA_HOME/bin</code> if

  175.      * <code>JAVA_HOME</code> points to your JDK installation.</p>

  176.      *

  177.      * @since Ant 1.5

  178.      */

  179.     public static String getJdkExecutable(String command) {

  180.         if (isNetware) {

  181.             // Extrapolating from:

  182.             // "NetWare may have a "java" in that directory, but 99% of

  183.             // the time, you don't want to execute it" -- Jeff Tulley

  184.             // <JTULLEY@novell.com>

  185.             return command;

  186.         }

  187. 

  188.         File jExecutable = null;

  189. 

  190.         if (isAix) {

  191.             // On IBM's JDK 1.2 the directory layout is different, 1.3 follows

  192.             // Sun's layout.

  193.             jExecutable = findInDir(javaHome + "/../sh", command);

  194.         }

  195. 

  196.         if (jExecutable == null) {

  197.             jExecutable = findInDir(javaHome + "/../bin", command);

  198.         }

  199. 

  200.         if (jExecutable != null) {

  201.             return jExecutable.getAbsolutePath();

  202.         } else {

  203.             // fall back to JRE bin directory, also catches JDK 1.0 and 1.1

  204.             // where java.home points to the root of the JDK and Mac OS X where

  205.             // the whole directory layout is different from Sun's

  206.             return getJreExecutable(command);

  207.         }

  208.     }

  209. 

  210.     /**

  211.      * Adds a system specific extension to the name of an executable.

  212.      *

  213.      * @since Ant 1.5

  214.      */

  215.     private static String addExtension(String command) {

  216.         // This is the most common extension case - exe for windows and OS/2,

  217.         // nothing for *nix.

  218.         return command + (isDos ? ".exe" : "");

  219.     }

  220. 

  221.     /**

  222.      * Look for an executable in a given directory.

  223.      *

  224.      * @return null if the executable cannot be found.

  225.      */

  226.     private static File findInDir(String dirName, String commandName) {

  227.         File dir = fileUtils.normalize(dirName);

  228.         File executable = null;

  229.         if (dir.exists()) {

  230.             executable = new File(dir, addExtension(commandName));

  231.             if (!executable.exists()) {

  232.                 executable = null;

  233.             }

  234.         }

  235.         return executable;

  236.     }

  237. 

  238.     /**

  239.      * demand creation of the package list.

  240.      * When you add a new package, add a new test below

  241.      */

  242. 

  243.     private static void buildJrePackages() {

  244.         jrePackages = new Vector();

  245.         switch(javaVersionNumber) {

  246.             case 15:

  247.             case 14:

  248.                 jrePackages.addElement("org.apache.crimson");

  249.                 jrePackages.addElement("org.apache.xalan");

  250.                 jrePackages.addElement("org.apache.xml");

  251.                 jrePackages.addElement("org.apache.xpath");

  252.                 jrePackages.addElement("org.ietf.jgss");

  253.                 jrePackages.addElement("org.w3c.dom");

  254.                 jrePackages.addElement("org.xml.sax");

  255.                 // fall through

  256.             case 13:

  257.                 jrePackages.addElement("org.omg");

  258.                 jrePackages.addElement("com.sun.corba");

  259.                 jrePackages.addElement("com.sun.jndi");

  260.                 jrePackages.addElement("com.sun.media");

  261.                 jrePackages.addElement("com.sun.naming");

  262.                 jrePackages.addElement("com.sun.org.omg");

  263.                 jrePackages.addElement("com.sun.rmi");

  264.                 jrePackages.addElement("sunw.io");

  265.                 jrePackages.addElement("sunw.util");

  266.                 // fall through

  267.             case 12:

  268.                 jrePackages.addElement("com.sun.java");

  269.                 jrePackages.addElement("com.sun.image");

  270.                 // are there any here that we forgot?

  271.                 // fall through

  272.             case 11:

  273.             default:

  274.                 //things like sun.reflection, sun.misc, sun.net

  275.                 jrePackages.addElement("sun");

  276.                 jrePackages.addElement("java");

  277.                 jrePackages.addElement("javax");

  278.                 break;

  279.         }

  280.     }

  281. 

  282.     /**

  283.      * Testing helper method; kept here for unification of changes.

  284.      */

  285.     public static Vector getJrePackageTestCases() {

  286.         Vector tests = new Vector();

  287.         tests.addElement("java.lang.Object");

  288.         switch(javaVersionNumber) {

  289.             case 15:

  290.             case 14:

  291.                 tests.addElement("sun.audio.AudioPlayer");

  292.                 tests.addElement("org.apache.crimson.parser.ContentModel");

  293.                 tests.addElement("org.apache.xalan.processor.ProcessorImport");

  294.                 tests.addElement("org.apache.xml.utils.URI");

  295.                 tests.addElement("org.apache.xpath.XPathFactory");

  296.                 tests.addElement("org.ietf.jgss.Oid");

  297.                 tests.addElement("org.w3c.dom.Attr");

  298.                 tests.addElement("org.xml.sax.XMLReader");

  299.                 // fall through

  300.             case 13:

  301.                 tests.addElement("org.omg.CORBA.Any");

  302.                 tests.addElement("com.sun.corba.se.internal.corba.AnyImpl");

  303.                 tests.addElement("com.sun.jndi.ldap.LdapURL");

  304.                 tests.addElement("com.sun.media.sound.Printer");

  305.                 tests.addElement("com.sun.naming.internal.VersionHelper");

  306.                 tests.addElement("com.sun.org.omg.CORBA.Initializer");

  307.                 tests.addElement("sunw.io.Serializable");

  308.                 tests.addElement("sunw.util.EventListener");

  309.                 // fall through

  310.             case 12:

  311.                 tests.addElement("javax.accessibility.Accessible");

  312.                 tests.addElement("sun.misc.BASE64Encoder");

  313.                 tests.addElement("com.sun.image.codec.jpeg.JPEGCodec");

  314.                 // fall through

  315.             case 11:

  316.             default:

  317.                 //things like sun.reflection, sun.misc, sun.net

  318.                 tests.addElement("sun.reflect.SerializationConstructorAccessorImpl");

  319.                 tests.addElement("sun.net.www.http.HttpClient");

  320.                 tests.addElement("sun.audio.AudioPlayer");

  321.                 break;

  322.         }

  323.         return tests;

  324.     }

  325.     /**

  326.      * get a vector of strings of packages built into

  327.      * that platforms runtime jar(s)

  328.      * @return list of packages

  329.      */

  330.     public static Vector getJrePackages() {

  331.         if (jrePackages == null) {

  332.             buildJrePackages();

  333.         }

  334.         return jrePackages;

  335.     }

  336. }