/* * $RCSfile: JNLPAppletLauncher.java,v $ * * Copyright 2007 Sun Microsystems, Inc. All Rights Reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * - Redistribution of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * - Redistribution in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * * Neither the name of Sun Microsystems, Inc. or the names of * contributors may be used to endorse or promote products derived * from this software without specific prior written permission. * * This software is provided "AS IS," without a warranty of any * kind. ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND * WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY * EXCLUDED. SUN MICROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL * NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF * USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS * DERIVATIVES. IN NO EVENT WILL SUN OR ITS LICENSORS BE LIABLE FOR * ANY LOST REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL, * CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER CAUSED AND * REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF THE USE OF OR * INABILITY TO USE THIS SOFTWARE, EVEN IF SUN HAS BEEN ADVISED OF THE * POSSIBILITY OF SUCH DAMAGES. * * You acknowledge that this software is not designed, licensed or * intended for use in the design, construction, operation or * maintenance of any nuclear facility. * * $Revision: 1.4 $ * $Date: 2007/06/19 20:27:26 $ * $State: Exp $ */ package org.jdesktop.applet.util; import java.applet.Applet; import java.applet.AppletContext; import java.applet.AppletStub; import java.awt.BorderLayout; import java.io.BufferedInputStream; import java.io.BufferedOutputStream; import java.io.File; import java.io.FileOutputStream; import java.io.FilenameFilter; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import java.net.URL; import java.net.URLConnection; import java.nio.channels.FileChannel; import java.nio.channels.FileLock; import java.security.MessageDigest; import java.security.NoSuchAlgorithmException; import java.security.cert.Certificate; import java.util.ArrayList; import java.util.Collection; import java.util.Enumeration; import java.util.HashMap; import java.util.HashSet; import java.util.List; import java.util.Map; import java.util.Map.Entry; import java.util.Set; import java.util.jar.JarEntry; import java.util.jar.JarFile; import java.util.logging.Logger; import javax.swing.ImageIcon; import javax.swing.JLabel; import javax.swing.JPanel; import javax.swing.JProgressBar; import javax.swing.SwingUtilities; import javax.xml.parsers.ParserConfigurationException; import javax.xml.parsers.SAXParser; import javax.xml.parsers.SAXParserFactory; import org.xml.sax.Attributes; import org.xml.sax.SAXException; import org.xml.sax.helpers.DefaultHandler; /** * General purpose JNLP-based AppletLauncher class for deploying applets that use * extension libraries containing native code. It is based on JOGLAppletLauncher, * but uses an extension's .jnlp file to locate the native resources, so that * for a given extension, the application developer only needs to host the * platform-independent .jar files containing the .class files. The * platform-specific native .jar files are downloaded automatically from the same * server that hosts the extension web start binaries. * *

* Extensions that currently plan to support JNLPAppletLauncher include: * Java 3D, JOAL, and JOGL. More could be added later without needing to modify * JNLPAppletLauncher. * *

* The applet-launcher jar file containing the JNLPAppletLauncher class must be * signed with the same certificate as the extension's native resources, typically * "sun microsystems, inc.". The user will receive a ssecurity dialog and will * be prompted to accept the certificate for the JLNPAppletLauncher. * The applet being deployed may be either signed or * unsigned; if it is unsigned, it runs inside the security sandbox, * and if it is signed, the user receives a security dialog to accept * the certificate for the applet (in addition to the applet-launcher jar, * if it is signed by a different entity). * *

* The steps for deploying such applets are straightforward. First, * the "archive" parameter to the applet tag must contain applet-laucher.jar, * the extension .jar files, and any jar files associated with your * applet (in this case, "your_applet.jar"). * *

* Second, the codebase directory on the server, which contains the * applet's jar files, must also contain applet-laucher.jar and all of * the extension .jar files * files from the standard extension's runtime distributions * (TBD). * *

* TODO: List the Java 3D, JOGL, and JOAL jar files here. * *

* Sample applet code: *

 * <applet code="org.jdesktop.applet.util.JNLPAppletLauncher"
 *      width=640
 *      height=480
 *      codebase="http://download.java.net/media/java3d/applets/applet-test/"
 *      archive="applet-launcher.jar,j3d-examples.jar,j3dcore.jar,j3dutils.jar,vecmath.jar">
 *   <param name="subapplet.classname" value="org.jdesktop.j3d.examples.four_by_four.FourByFour">
 *   <param name="subapplet.displayname" value="Java 3D Four by Four Applet">
 *   <param name="jnlpNumExtensions" value="1">
 *   <param name="jnlpExtension1"
 *      value="http://download.java.net/media/java3d/webstart/early-access/java3d-1.5.1-exp.jnlp">
 *   <param name="progressbar" value="true">
 * </applet>
 * 
* * TODO: Finish this, borrowing from JOGLAppletLauncher where needed. */ public class JNLPAppletLauncher extends Applet { private static final boolean VERBOSE = false; private static final boolean DEBUG = true; // Indicated that the applet was successfully initialized private boolean isInitOk = false; // True the first time start is called, false afterwards private boolean firstStart = true; // Indicates that the applet was started successfully private boolean appletStarted = false; // The applet we have to start private Applet subApplet; // Class name of applet to load (required) private String subAppletClassName; // from applet PARAM subapplet.classname // String representing the name of the applet (optional) private String subAppletDisplayName; // from applet PARAM subapplet.displayname // URL to an image that we will display while installing (optional) private URL subAppletImageURL; // from applet PARAM subapplet.image // Panel that will hold the splash-screen image and progress bar while loading private JPanel loaderPanel; // Optional progress bar private JProgressBar progressBar; /* * The following variables are defined per-applet, but we can assert that * they will not differ for each applet that is loaded by the same * ClassLoader. This means we can just cache the values from the first * applet. We will check the values for subsequent applets and throw an * exception if there are any differences. */ // Flag indicating that this is the first applet private static boolean firstApplet = true; // List of extension JNLP files. This is saved for the first applet // and verified for each subsequent applet. private static List jnlpExtensions = null; // Code base and archive tag for all applets that use the same ClassLoader private static URL codeBase; private static String archive = null; // Persistent cache directory for storing native libraries and time stamps. // The directory is of the form: // // ${user.home}/.jnlp-applet/cache// // private static File cacheDir; // Set of jar files specified in the JNLP files. // Currently unused. private static Set jarFiles; // Set of native jar files to be loaded. We need to download these // native jars, verify the signatures, verify the security certificates, // and extract the native libraries from each jar. private static Set nativeJars; // Native library prefix (e.g., "lib") and suffix (e.g. ".dll" or ".so") private static String nativePrefix; private static String nativeSuffix; // A HashMap of native libraries that can be loaded with System.load() // The key is the string name of the library as passed into the loadLibrary // call; it is the file name without the directory or the platform-dependent // library prefix and suffix. The value is the absolute path name to the // unpacked library file in nativeTmpDir. private static Map nativeLibMap; /* * The following variables are per-ClassLoader static globals. */ // Flag indicating that we got a fatal error in the static initializer. // If this happens we will not attempt to start any applets. private static boolean staticInitError = false; // Base temp directory used by JNLPAppletLauncher. This is set to: // // ${java.io.tmpdir}/jnlp-applet // private static File tmpBaseDir; // String representing the name of the temp root directory relative to the // tmpBaseDir. Its value is "jlnNNNNN", which is the unique filename created // by File.createTempFile() without the ".tmp" extension. // private static String tmpRootPropValue; // Root temp directory for this JVM instance. Used to store the individual, // per-ClassLoader directories that will be used to load native code. The // directory name is: // // / // // Old temp directories are cleaned up the next time a JVM is launched that // uses JNLPAppletLauncher. // private static File tmpRootDir; // Temporary directory for loading native libraries for this instance of // the class loader. The directory name is: // // /jlnMMMMM // // where jlnMMMMM is the unique filename created by File.createTempFile() // without the ".tmp" extension. // private static File nativeTmpDir; /* * IMPLEMENTATION NOTES * * Assumptions: * * A. Multiple applets can be launched from the same class loader, and thus * share the same set of statics and same set of native library symbols. * This can only happen if the codebase and set of jar files as specified * in the archive tag are identical. Applets launched from different code * bases or whose set of jar files are different will always get a * different ClassLoader. If this assumption breaks, too many other * things wouldn't work properly, so we can be assured that it will hold. * However, we cannot assume that the converse is true; it is possible * that two applets with the same codebase and archive tag will be loaded * from a different ClassLoader. * * B. Given the above, this means that we must store the native libraries, * and keep track of which ones have already been loaded statically, that * is, per-ClassLoader rather than per-Applet. This is a good thing, * because it turns out to be difficult (at best) to find the instance of * the Applet at loadLibrary time. * * Our solution is as follows: * * Use the same criteria for determining the cache dir that JPI * uses to determine the class loader to use. More precisely, we will * create a directory based on the codebase and complete set of jar files * specified by the archive tag. To support the case where each applet is * in a unique class loader, we will copy the native libraries into a * unique-per-ClassLoader temp directory and do the System.load() from * there. For a robust solution, we need to lock the cache directory * during validation, since multiple threads, or even multiple processes, * can access it concurrently. * * We also considered, but rejected, the following solutions: * * 1. Use a temporary directory for native jars, download, verify, unpack, * and loadLibrary in this temp dir. No persistent cache. * * 2. Cache the native libraries in a directory based on the codebase and * the extension jars (i.e., the subset of the jars in the archive tag * that also appear in one of the extension JNLP files). Copy the native * libraries into a unique-per-ClassLoader temp directory and load from * there. Note that this has the potential problem of violating the * assertion that two different applets that share the same ClassLoader * must map to the same cache directory. * * 3. Use the exact criteria for determining the cache dir that JPI * uses to determine which class loader to use (as in our proposed * solution above), unpack the native jars into the cache directory and * load from there. This obviates the need for locking, but it will break * if the JPI ever isolates each applet into its own ClassLoader. */ /** * Constructs an instance of the JNLPAppletLauncher class. This is called by * Java Plug-in, and should not be called directly by an application or * applet. */ public JNLPAppletLauncher() { } @Override public void init() { if (VERBOSE) { System.err.println(); System.err.println("==========================================================================="); } if (DEBUG) { System.err.println("Applet.init"); } if (staticInitError) { return; } subAppletClassName = getParameter("subapplet.classname"); if (subAppletClassName == null) { displayError("Init failed : Missing subapplet.classname parameter"); return; } subAppletDisplayName = getParameter("subapplet.displayname"); if (subAppletDisplayName == null) { subAppletDisplayName = "Applet"; } subAppletImageURL = null; try { String subAppletImageStr = getParameter("subapplet.image"); if (subAppletImageStr != null && subAppletImageStr.length() > 0) { subAppletImageURL = new URL(subAppletImageStr); } } catch (IOException ex) { ex.printStackTrace(); // Continue with a null subAppletImageURL } if (DEBUG) { System.err.println("subapplet.classname = " + subAppletClassName); System.err.println("subapplet.displayname = " + subAppletDisplayName); if (subAppletImageURL != null) { System.err.println("subapplet.image = " + subAppletImageURL.toExternalForm()); } } initLoaderLayout(); isInitOk = true; } @Override public void start() { if (DEBUG) { System.err.println("Applet.start"); } if (isInitOk) { if (firstStart) { // first time firstStart = false; Thread startupThread = new Thread() { public void run() { initAndStartApplet(); } }; startupThread.setName("AppletLauncher-Startup"); startupThread.setPriority(Thread.NORM_PRIORITY - 1); startupThread.start(); } else if (appletStarted) { // TODO: checkNoDDrawAndUpdateDeploymentProperties(); // We have to start again the applet (start can be called multiple times, // e.g once per tabbed browsing subApplet.start(); } } } /** * This method is called by the static initializer to create / initialize * the temp root directory that will hold the temp directories for this * instance of the JVM. This is done as follows: * * 1. Synchronize on a global lock. Note that for this purpose we will * use System.out in the absence of a true global lock facility. * We are careful not to hold this lock too long. * * 2. Check for the existence of the "jnlp.applet.launcher.tmproot" * system property. * * a. If set, then some other thread in a different ClassLoader has * already created the tmprootdir, so we just need to * use it. The remaining steps are skipped. * * b. If not set, then we are the first thread in this JVM to run, * and we need to create the the tmprootdir. * * 3. Create the tmprootdir, along with the appropriate locks. * Note that we perform the operations in the following order, * prior to creating tmprootdir itself, to work around the fact that * the file creation and file lock steps are not atomic, and we need * to ensure that a newly-created tmprootdir isn't reaped by a * concurrently running JVM. * * create jlnNNNN.tmp using File.createTempFile() * lock jlnNNNN.tmp * create jlnNNNN.lck while holding the lock on the .tmp file * lock jlnNNNN.lck * * Since the Reaper thread will enumerate the list of *.lck files * before starting, we can guarantee that if there exists a *.lck file * for an active process, then the corresponding *.tmp file is locked * by that active process. This guarantee lets us avoid reaping an * active process' files. * * 4. Set the "jnlp.applet.launcher.tmproot" system property. * * 5. Add a shutdown hook to cleanup jlnNNNN.lck and jlnNNNN.tmp. We * don't actually expect that this shutdown hook will ever be called, * but the act of doing this, ensures that the locks never get * garbage-collected, which is necessary for correct behavior when * the first ClassLoader is later unloaded, while subsequent Applets * are still running. * * 6. Start the Reaper thread to cleanup old installations. */ private static void initTmpRoot() throws IOException { if (VERBOSE) { System.err.println("---------------------------------------------------"); } synchronized (System.out) { // Get the name of the tmpbase directory. String tmpBaseName = System.getProperty("java.io.tmpdir") + File.separator + "jnlp-applet"; tmpBaseDir = new File(tmpBaseName); // Get the value of the tmproot system property final String tmpRootPropName = "jnlp.applet.launcher.tmproot"; tmpRootPropValue = System.getProperty(tmpRootPropName); if (tmpRootPropValue == null) { // Create the tmpbase directory if it doesn't already exist tmpBaseDir.mkdir(); if (!tmpBaseDir.isDirectory()) { throw new IOException("Cannot create directory " + tmpBaseDir); } // Create ${tmpbase}/jlnNNNN.tmp then lock the file File tmpFile = File.createTempFile("jln", ".tmp", tmpBaseDir); if (VERBOSE) { System.err.println("tmpFile = " + tmpFile.getAbsolutePath()); } final FileOutputStream tmpOut = new FileOutputStream(tmpFile); final FileChannel tmpChannel = tmpOut.getChannel(); final FileLock tmpLock = tmpChannel.lock(); // Strip off the ".tmp" to get the name of the tmprootdir String tmpFileName = tmpFile.getAbsolutePath(); String tmpRootName = tmpFileName.substring(0, tmpFileName.lastIndexOf(".tmp")); // create ${tmpbase}/jlnNNNN.lck then lock the file String lckFileName = tmpRootName + ".lck"; File lckFile = new File(lckFileName); if (VERBOSE) { System.err.println("lckFile = " + lckFile.getAbsolutePath()); } lckFile.createNewFile(); final FileOutputStream lckOut = new FileOutputStream(lckFile); final FileChannel lckChannel = lckOut.getChannel(); final FileLock lckLock = lckChannel.lock(); // Create tmprootdir tmpRootDir = new File(tmpRootName); if (DEBUG) { System.err.println("tmpRootDir = " + tmpRootDir.getAbsolutePath()); } if (!tmpRootDir.mkdir()) { throw new IOException("Cannot create " + tmpRootDir); } // Add shutdown hook to cleanup the OutputStream, FileChannel, // and FileLock for the jlnNNNN.lck and jlnNNNN.lck files. // We do this so that the locks never get garbage-collected. Runtime.getRuntime().addShutdownHook(new Thread() { @Override public void run() { // NOTE: we don't really expect that this code will ever // be called. If it does, we will close the output // stream, which will in turn close the channel. // We will then release the lock. try { tmpOut.close(); tmpLock.release(); lckOut.close(); lckLock.release(); } catch (IOException ex) { // Do nothing } } }); // Set the system property... tmpRootPropValue = tmpRootName.substring(tmpRootName.lastIndexOf(File.separator) + 1); System.setProperty(tmpRootPropName, tmpRootPropValue); if (VERBOSE) { System.err.println("Setting " + tmpRootPropName + "=" + tmpRootPropValue); } // Start a new Reaper thread to do stuff... Thread reaperThread = new Thread() { @Override public void run() { deleteOldTempDirs(); } }; reaperThread.setName("AppletLauncher-Reaper"); reaperThread.start(); } else { // Make sure that the property is not set to an illegal value if (tmpRootPropValue.indexOf('/') >= 0 || tmpRootPropValue.indexOf(File.separatorChar) >= 0) { throw new IOException("Illegal value of: " + tmpRootPropName); } // Set tmpRootDir = ${tmpbase}/${jnlp.applet.launcher.tmproot} if (VERBOSE) { System.err.println("Using existing value of: " + tmpRootPropName + "=" + tmpRootPropValue); } tmpRootDir = new File(tmpBaseDir, tmpRootPropValue); if (DEBUG) { System.err.println("tmpRootDir = " + tmpRootDir.getAbsolutePath()); } if (!tmpRootDir.isDirectory()) { throw new IOException("Cannot access " + tmpRootDir); } } } } /** * Called by the Reaper thread to delete old temp directories * Only one of these threads will run per JVM invocation. */ private static void deleteOldTempDirs() { if (VERBOSE) { System.err.println("*** Reaper: deleteOldTempDirs in " + tmpBaseDir.getAbsolutePath()); } // enumerate list of jnl*.lck files, ignore our own jlnNNNN file final String ourLockFile = tmpRootPropValue + ".lck"; FilenameFilter lckFilter = new FilenameFilter() { @Override public boolean accept(File dir, String name) { return name.endsWith(".lck") && !name.equals(ourLockFile); } }; // For each file .lck in the list we will first try to lock // .tmp if that succeeds then we will try to lock .lck // (which should always succeed unless there is a problem). If we can // get the lock on both files, then it must be an old installation, and // we will delete it. String[] fileNames = tmpBaseDir.list(lckFilter); if (fileNames != null) { for (int i = 0; i < fileNames.length; i++) { String lckFileName = fileNames[i]; String tmpDirName = lckFileName.substring(0, lckFileName.lastIndexOf(".lck")); String tmpFileName = tmpDirName + ".tmp"; File lckFile = new File(tmpBaseDir, lckFileName); File tmpFile = new File(tmpBaseDir, tmpFileName); File tmpDir = new File(tmpBaseDir, tmpDirName); if (lckFile.exists() && tmpFile.exists() && tmpDir.isDirectory()) { FileOutputStream tmpOut = null; FileChannel tmpChannel = null; FileLock tmpLock = null; try { tmpOut = new FileOutputStream(tmpFile); tmpChannel = tmpOut.getChannel(); tmpLock = tmpChannel.tryLock(); } catch (Exception ex) { // Ignore exceptions if (DEBUG) { ex.printStackTrace(); } } if (tmpLock != null) { FileOutputStream lckOut = null; FileChannel lckChannel = null; FileLock lckLock = null; try { lckOut = new FileOutputStream(lckFile); lckChannel = lckOut.getChannel(); lckLock = lckChannel.tryLock(); } catch (Exception ex) { if (DEBUG) { ex.printStackTrace(); } } if (lckLock != null) { // Recursively remove the old tmpDir and all of // its contents removeAll(tmpDir); // Close the streams and delete the .lck and .tmp // files. Note that there is a slight race condition // in that another process could open a stream at // the same time we are trying to delete it, which will // prevent deletion, but we won't worry about it, since // the worst that will happen is we might have an // occasional 0-byte .lck or .tmp file left around try { lckOut.close(); } catch (IOException ex) { } lckFile.delete(); try { tmpOut.close(); } catch (IOException ex) { } tmpFile.delete(); } else { try { // Close the file and channel for the *.lck file if (lckOut != null) { lckOut.close(); } // Close the file/channel and release the lock // on the *.tmp file tmpOut.close(); tmpLock.release(); } catch (IOException ex) { if (DEBUG) { ex.printStackTrace(); } } } } } else { if (VERBOSE) { System.err.println(" Skipping: " + tmpDir.getAbsolutePath()); } } } } } /** * Remove the specified file or directory. If "path" is a directory, then * recursively remove all entries, then remove the directory itself. */ private static void removeAll(File path) { if (VERBOSE) { System.err.println("removeAll(" + path + ")"); } if (path.isDirectory()) { // Recursively remove all files/directories in this directory File[] list = path.listFiles(); if (list != null) { for (int i = 0; i < list.length; i++) { removeAll(list[i]); } } } path.delete(); } /** * This method is executed from outside the Event Dispatch Thread. It * initializes, downloads, and unpacks the required native libraries into * the cache, and then starts the applet on the EDT. */ private void initAndStartApplet() { // Parse the extension JNLP files and download the native resources try { initResources(); } catch (Exception ex) { ex.printStackTrace(); displayError(toErrorString(ex)); return; } // Indicate that we are starting the applet displayMessage("Starting applet " + subAppletDisplayName); setProgress(0); // Now schedule the starting of the subApplet on the EDT SwingUtilities.invokeLater(new Runnable() { public void run() { // start the subapplet startSubApplet(); } }); } /** * Initializes, downloads, and extracts the native resources needed by this * applet. */ private void initResources() throws IOException { synchronized (JNLPAppletLauncher.class) { if (firstApplet) { // Save codeBase and archive parameter for assertion checking codeBase = getCodeBase(); assert codeBase != null; archive = getParameter("archive"); if (archive == null || archive.length() == 0) { throw new IllegalArgumentException("Missing archive parameter"); } // Initialize the collections of resources jarFiles = new HashSet(); nativeJars = new HashSet(); nativeLibMap = new HashMap(); } else { // The following must hold for applets in the same ClassLoader assert getCodeBase().equals(codeBase); assert getParameter("archive").equals(archive); } int jnlpNumExt = -1; String numParamString = getParameter("jnlpNumExtensions"); if (numParamString != null) { try { jnlpNumExt = new Integer(numParamString); } catch (NumberFormatException ex) { } if (jnlpNumExt <= 0) { throw new IllegalArgumentException("Missing or invalid jnlpNumExtensions parameter"); } } List urls = new ArrayList(); for (int i = 1; i <= jnlpNumExt; i++) { String paramName = "jnlpExtension" + i; String urlString = getParameter(paramName); if (urlString == null || urlString.length() == 0) { throw new IllegalArgumentException("Missing " + paramName + " parameter"); } URL url = new URL(urlString); urls.add(url); } // If this is the first time, process the list of extensions and // save the results. Otherwise, verify that the list of extensions // is the same as the first applet. if (firstApplet) { jnlpExtensions = urls; parseJNLPExtensions(urls); if (VERBOSE) { System.err.println(); System.err.println("All files successfully parsed"); printResources(); } if (nativeJars.size() > 0) { // Create the cache directory if not already created. // Create the temporary directory that will hold a copy of // the extracted native libraries, then copy each native // library into the temp dir so we can call System.load(). createCacheDir(); createTmpDir(); // Download and validate the set of native jars, if the // cache is out of date. Then extract the native DLLs, // creating a list of native libraries to be loaded. for (URL url : nativeJars) { processNativeJar(url); } } // Set a system property that libraries can use to know when to call // JNLPAppletLauncher.loadLibrary instead of System.loadLibrary System.setProperty("sun.jnlp.applet.launcher", "true"); } else { // Verify that the list of jnlpExtensions is the same as the // first applet if (!jnlpExtensions.equals(urls)) { throw new IllegalArgumentException( "jnlpExtension parameters do not match previously loaded applet"); } } firstApplet = false; } } /** * Detemine the cache directory location based on the codebase and archive * tag. Create the cache directory if not already created. */ private void createCacheDir() throws IOException { StringBuffer cacheBaseName = new StringBuffer(); cacheBaseName.append(System.getProperty("user.home")).append(File.separator). append(".jnlp-applet").append(File.separator). append("cache"); File cacheBaseDir = new File(cacheBaseName.toString()); if (VERBOSE) { System.err.println("cacheBaseDir = " + cacheBaseDir.getAbsolutePath()); } cacheDir = new File(cacheBaseDir, getCacheDirName()); if (VERBOSE) { System.err.println("cacheDir = " + cacheDir.getAbsolutePath()); } // Create cache directory and load native library if (!cacheDir.isDirectory()) { if (!cacheDir.mkdirs()) { throw new IOException("Cannot create directory " + cacheDir); } } assert cacheBaseDir.isDirectory(); } /** * Returns a directory name of the form: hostname/hash(codebase,archive) */ private String getCacheDirName() { final String codeBasePath = getCodeBase().toExternalForm(); // Extract the host name; replace characters in the set ".:\[]" with "_" int hostIdx1 = -1; int hostIdx2 = -1; String hostNameDir = "UNKNOWN"; hostIdx1 = codeBasePath.indexOf("://"); if (hostIdx1 >= 0) { hostIdx1 += 3; // skip the "://" // Verify that the character immediately following the "://" // exists and is not a "/" if (hostIdx1 < codeBasePath.length() && codeBasePath.charAt(hostIdx1) != '/') { hostIdx2 = codeBasePath.indexOf('/', hostIdx1); if (hostIdx2 > hostIdx1) { hostNameDir = codeBasePath.substring(hostIdx1, hostIdx2). replace('.', '_'). replace(':', '_'). replace('\\', '_'). replace('[', '_'). replace(']', '_'); } } } // Now concatenate the codebase and the list of jar files in the archive // Separate them by an "out-of-band" character which cannot appear in // either the codeBasePath or archive list. StringBuffer key = new StringBuffer(); key.append(codeBasePath). append("\n"). append(getParameter("archive")); if (VERBOSE) { System.err.println("key = " + key); } StringBuffer result = new StringBuffer(); result.append(hostNameDir). append(File.separator). append(sha1Hash(key.toString())); if (VERBOSE) { System.err.println("result = " + result); } return result.toString(); } /** * Produces a 40-byte SHA-1 hash of the input string. */ private static String sha1Hash(String str) { MessageDigest sha1 = null; try { sha1 = MessageDigest.getInstance("SHA-1"); } catch (NoSuchAlgorithmException ex) { throw new RuntimeException(ex); } byte[] digest = sha1.digest(str.getBytes()); if (digest == null || digest.length == 0) { throw new RuntimeException("Error reading message digest"); } StringBuffer res = new StringBuffer(); for (int i = 0; i < digest.length; i++) { int val = (int)digest[i] & 0xFF; if (val < 0x10) { res.append("0"); } res.append(Integer.toHexString(val)); } return res.toString(); } /** * Create the temp directory in tmpRootDir. To do this, we create a temp * file with a ".tmp" extension, and then create a directory of the * same name but without the ".tmp". The temp file, directory, and all * files in the directory will be reaped the next time this is started. * We avoid deleteOnExit, because it doesn't work reliably. */ private void createTmpDir() throws IOException { if (VERBOSE) { System.err.println("---------------------------------------------------"); } File tmpFile = File.createTempFile("jln", ".tmp", tmpRootDir); String tmpFileName = tmpFile.getAbsolutePath(); String tmpDirName = tmpFileName.substring(0, tmpFileName.lastIndexOf(".tmp")); nativeTmpDir = new File(tmpDirName); if (VERBOSE) { System.err.println("tmpFile = " + tmpFile.getAbsolutePath() + " tmpDir = " + nativeTmpDir.getAbsolutePath()); } if (!nativeTmpDir.mkdir()) { throw new IOException("Cannot create " + nativeTmpDir); } } /** * Download, cache, verify, and unpack the specified native jar file. * Before downloading, check the cached time stamp for the jar file * against the server. If the time stamp is valid and matches that of the * server, then we will use the locally cached files. This method assumes * that cacheDir and nativeTmpDir both exist. * * An IOException is thrown if the files cannot loaded for some reason. */ private void processNativeJar(URL url) throws IOException { assert cacheDir.isDirectory(); assert nativeTmpDir.isDirectory(); String urlString = url.toExternalForm(); String nativeFileName = urlString.substring(urlString.lastIndexOf("/") + 1); String tmpStr = nativeFileName; int idx = nativeFileName.lastIndexOf("."); if (idx > 0) { tmpStr = nativeFileName.substring(0, idx); } String indexFileName = tmpStr + ".idx"; File nativeFile = new File(cacheDir, nativeFileName); File indexFile = new File(cacheDir, indexFileName); if (VERBOSE) { System.err.println("nativeFile = " + nativeFile); System.err.println("indexFile = " + indexFile); } displayMessage("Loading: " + nativeFileName); setProgress(0); URLConnection conn = url.openConnection(); conn.connect(); Map>headerFields = conn.getHeaderFields(); if (VERBOSE) { for (Entry>e : headerFields.entrySet()) { for (String s : e.getValue()) { if (e.getKey() != null) { System.err.print(e.getKey() + ": "); } System.err.print(s + " "); } System.err.println(); } System.err.println(); } // Validate the cache, download the jar if needed if (!validateCache(conn, nativeFile, indexFile)) { if (VERBOSE) { System.err.println("processNativeJar: downloading " + nativeFile.getAbsolutePath()); } indexFile.delete(); nativeFile.delete(); // Copy from URL to File int len = conn.getContentLength(); if (VERBOSE) { System.err.println("Content length = " + len + " bytes"); } int totalNumBytes = copyURLToFile(conn, nativeFile); if (DEBUG) { System.err.println("processNativeJar: " + conn.getURL().toString() + " --> " + nativeFile.getAbsolutePath() + " : " + totalNumBytes + " bytes written"); } // TODO: Write timestamp to index file. } else { if (DEBUG) { System.err.println("processNativeJar: using previously cached: " + nativeFile.getAbsolutePath()); } } displayMessage("Unpacking: " + nativeFileName); setProgress(0); // Enumerate the jar file looking for native libraries JarFile jarFile = new JarFile(nativeFile); Set nativeLibNames = getNativeLibNames(jarFile); // Validate certificates; throws exception upon validation error validateCertificates(jarFile, nativeLibNames); // Extract native libraries from the jar file extractNativeLibs(jarFile, nativeLibNames); if (VERBOSE) { System.err.println(); } } // Validate the cached file. If the cached file is valid, return true, else // return false. private boolean validateCache(URLConnection conn, File nativeFile, File indexFile) { // TODO: implement this for real return nativeFile.exists(); } // Copy the specified URL to the specified File private int copyURLToFile(URLConnection inConnection, File outFile) throws IOException { InputStream in = new BufferedInputStream(inConnection.getInputStream()); OutputStream out = new BufferedOutputStream(new FileOutputStream(outFile)); int totalNumBytes = copyStream(in, out, inConnection.getContentLength()); out.close(); in.close(); return totalNumBytes; } /** * Copy the specified input stream to the specified output stream. The total * number of bytes written is returned. If the close flag is set, both * streams are closed upon completeion. */ private int copyStream(InputStream in, OutputStream out, int totalNumBytes) throws IOException { int numBytes = 0; final int BUFFER_SIZE = 1000; final float pctScale = 100.0f / (float)totalNumBytes; byte[] buf = new byte[BUFFER_SIZE]; setProgress(0); while (true) { int count; if ((count = in.read(buf)) == -1) { break; } out.write(buf, 0, count); numBytes += count; if (totalNumBytes > 0) { setProgress((int)Math.round((float)numBytes * pctScale)); } } setProgress(100); return numBytes; } /** * Enumerate the list of entries in the jar file and return those that are * native library names. */ private Set getNativeLibNames(JarFile jarFile) { if (VERBOSE) { System.err.println("getNativeLibNames:"); } Set names = new HashSet(); Enumeration entries = jarFile.entries(); while (entries.hasMoreElements()) { JarEntry entry = entries.nextElement(); String nativeLibName = entry.getName(); if (VERBOSE) { System.err.println("JarEntry : " + nativeLibName); } // only look at entries with no "/" if (nativeLibName.indexOf('/') == -1 && nativeLibName.indexOf(File.separatorChar) == -1) { String lowerCaseName = nativeLibName.toLowerCase(); // Match entries with correct prefix and suffix (ignoring case) if (lowerCaseName.startsWith(nativePrefix) && nativeLibName.toLowerCase().endsWith(nativeSuffix)) { names.add(nativeLibName); } } } return names; } /** * Validate the certificates for each native Lib in the jar file. * Throws an IOException if any certificate is not valid. */ private void validateCertificates(JarFile jarFile, Set nativeLibNames) throws IOException { if (DEBUG) { System.err.println("validateCertificates:"); } byte[] buf = new byte[1000]; Enumeration entries = jarFile.entries(); while (entries.hasMoreElements()) { JarEntry entry = entries.nextElement(); String entryName = entry.getName(); if (VERBOSE) { System.err.println("JarEntry : " + entryName); } if (nativeLibNames.contains(entryName)) { if (DEBUG) { System.err.println("VALIDATE: " + entryName); } if (!checkNativeCertificates(jarFile, entry, buf)) { throw new IOException("Cannot validate certificate for " + entryName); } } } } /** * Check the native certificates with the ones in the jar file containing the * certificates for the JNLPAppletLauncher class (all must match). */ private boolean checkNativeCertificates(JarFile jar, JarEntry entry, byte[] buf) throws IOException { // API states that we must read all of the data from the entry's // InputStream in order to be able to get its certificates InputStream is = jar.getInputStream(entry); int totalLength = (int) entry.getSize(); int len; while ((len = is.read(buf)) > 0) { } is.close(); // locate JNLPAppletLauncher certificates Certificate[] appletLauncherCerts = JNLPAppletLauncher.class.getProtectionDomain(). getCodeSource().getCertificates(); if (appletLauncherCerts == null || appletLauncherCerts.length == 0) { throw new IOException("Cannot find certificates for JNLPAppletLauncher class"); } // Get the certificates for the JAR entry Certificate[] nativeCerts = entry.getCertificates(); if (nativeCerts == null || nativeCerts.length == 0) { return false; } int checked = 0; for (int i = 0; i < appletLauncherCerts.length; i++) { for (int j = 0; j < nativeCerts.length; j++) { if (nativeCerts[j].equals(appletLauncherCerts[i])){ checked++; break; } } } return (checked == appletLauncherCerts.length); } /** * Extract the specified set of native libraries in the given jar file. */ private void extractNativeLibs(JarFile jarFile, Set nativeLibNames) throws IOException { if (DEBUG) { System.err.println("extractNativeLibs:"); } Enumeration entries = jarFile.entries(); while (entries.hasMoreElements()) { JarEntry entry = entries.nextElement(); String entryName = entry.getName(); if (VERBOSE) { System.err.println("JarEntry : " + entryName); } if (nativeLibNames.contains(entryName)) { // strip prefix & suffix String libName = entryName.substring(nativePrefix.length(), entryName.length() - nativeSuffix.length()); if (DEBUG) { System.err.println("EXTRACT: " + entryName + "(" + libName + ")"); } File nativeLib = new File(nativeTmpDir, entryName); InputStream in = new BufferedInputStream(jarFile.getInputStream(entry)); OutputStream out = new BufferedOutputStream(new FileOutputStream(nativeLib)); int numBytesWritten = copyStream(in, out, -1); in.close(); out.close(); nativeLibMap.put(libName, nativeLib.getAbsolutePath()); } } } /** * The true start of the sub applet (invoked in the EDT) */ private void startSubApplet() { try { subApplet = (Applet)Class.forName(subAppletClassName).newInstance(); subApplet.setStub(new AppletStubProxy()); } catch (ClassNotFoundException ex) { ex.printStackTrace(); displayError("Class not found: " + subAppletClassName); return; } catch (Exception ex) { ex.printStackTrace(); displayError("Unable to start " + subAppletDisplayName); return; } add(subApplet, BorderLayout.CENTER); try { subApplet.init(); remove(loaderPanel); validate(); // TODO: checkNoDDrawAndUpdateDeploymentProperties(); subApplet.start(); appletStarted = true; } catch (Exception ex) { ex.printStackTrace(); } } /** * Method called by an extension such as JOGL or Java 3D to load the * specified library. Applications and applets should not call this method. * * @param libraryName name of the library to be loaded * * @throws SecurityException if the caller does not have permission to * call System.load */ public static void loadLibrary(String libraryName) { if (VERBOSE) { System.err.println("-----------"); Thread.dumpStack(); } if (DEBUG) { System.err.println("JNLPAppletLauncher.loadLibrary(\"" + libraryName + "\")"); } String fullLibraryName = nativeLibMap.get(libraryName); if (DEBUG) { System.err.println(" loading: " + fullLibraryName + ""); } System.load(fullLibraryName); } private static String toErrorString(Throwable throwable) { StringBuffer errStr = new StringBuffer(throwable.toString()); Throwable cause = throwable.getCause(); while (cause != null) { errStr.append(": ").append(cause); cause = cause.getCause(); } return errStr.toString(); } private void displayMessage(final String message) { SwingUtilities.invokeLater(new Runnable() { public void run() { progressBar.setString(message); } }); } private void displayError(final String errorMessage) { // Log message on Java console and display in applet progress bar Logger.getLogger("global").severe(errorMessage); SwingUtilities.invokeLater(new Runnable() { public void run() { progressBar.setString("Error : " + errorMessage); } }); } private void setProgress(final int value) { SwingUtilities.invokeLater(new Runnable() { public void run() { progressBar.setValue(value); } }); } private void initLoaderLayout() { setLayout(new BorderLayout()); loaderPanel = new JPanel(new BorderLayout()); progressBar = new JProgressBar(0, 100); progressBar.setBorderPainted(true); progressBar.setStringPainted(true); progressBar.setString("Loading..."); boolean includeImage = false; ImageIcon image = null; if (subAppletImageURL != null) { image = new ImageIcon(subAppletImageURL); includeImage = true; } add(loaderPanel, BorderLayout.SOUTH); if (includeImage) { loaderPanel.add(new JLabel(image), BorderLayout.CENTER); loaderPanel.add(progressBar, BorderLayout.SOUTH); } else { loaderPanel.add(progressBar, BorderLayout.CENTER); } } private void parseJNLPExtensions(List urls) throws IOException { for (URL url : urls) { JNLPParser parser = new JNLPParser(this, url); parser.parse(); } } private void addJarFile(URL jarFile) { jarFiles.add(jarFile); } private void addNativeJar(URL nativeJar) { nativeJars.add(nativeJar); } /* * Debug method to print out resources from the JNLP file */ private static void printResources() { System.err.println(" Resources:"); System.err.println(" Class Jars:"); doPrint(jarFiles); System.err.println(); System.err.println(" Native Jars:"); doPrint(nativeJars); } /* * Debug method to print out resources from the JNLP file */ private static void doPrint(Collection urls) { for (URL url : urls) { String urlString = url.toExternalForm(); System.err.println(" " + urlString); } } // Static initializer for JNLPAppletLauncher static { System.err.println("JNLPAppletLauncher: static initializer"); String systemOsName = System.getProperty("os.name").toLowerCase(); if (systemOsName.startsWith("mac")) { // Mac OS X nativePrefix = "lib"; nativeSuffix = ".jnilib"; } else if (systemOsName.startsWith("windows")) { // Microsoft Windows nativePrefix = ""; nativeSuffix = ".dll"; } else { // Unix of some variety nativePrefix = "lib"; nativeSuffix = ".so"; } if (DEBUG) { System.err.println("os.name = " + systemOsName); System.err.println("nativePrefix = " + nativePrefix + " nativeSuffix = " + nativeSuffix); } // Create / initialize the temp root directory, starting the Reaper // thread to reclaim old installations if necessary. If we get an // exception, set an error code so we don't try to start the applets. try { initTmpRoot(); } catch (Exception ex) { ex.printStackTrace(); staticInitError = true; } } // ----------------------------------------------------------------------- /** * Proxy implementation class of AppletStub. Delegates to the * JNLPAppletLauncher class. */ private class AppletStubProxy implements AppletStub { public boolean isActive() { return JNLPAppletLauncher.this.isActive(); } public URL getDocumentBase() { return JNLPAppletLauncher.this.getDocumentBase(); } public URL getCodeBase() { return JNLPAppletLauncher.this.getCodeBase(); } public String getParameter(String name) { return JNLPAppletLauncher.this.getParameter(name); } public AppletContext getAppletContext() { return JNLPAppletLauncher.this.getAppletContext(); } public void appletResize(int width, int height) { JNLPAppletLauncher.this.resize(width, height); } } /** * Parser class for JNLP files for the applet launcher. For simplicitly, we * assume that everything of interest is within a single "jnlp" tag and * that the "resources" tags are not nested. */ private static class JNLPParser { // The following represents the various states we can be in private enum State { INITIAL, STARTED, IN_JNLP, IN_RESOURCES, SKIP_ELEMENT, } private static SAXParserFactory factory; private static String systemOsName; private static String systemOsArch; private JNLPAppletLauncher launcher; private URL url; private InputStream in; private JNLPHandler handler; private String codebase = ""; private State state = State.INITIAL; private State prevState = State.INITIAL; private int depth = 0; private int skipDepth = -1; private JNLPParser(JNLPAppletLauncher launcher, URL url) throws IOException { this.launcher = launcher; this.url = url; this.handler = new JNLPHandler(); } private void parse() throws IOException { if (VERBOSE) { System.err.println("JNLPParser: " + url.toString()); } try { URLConnection conn = url.openConnection(); conn.connect(); InputStream in = new BufferedInputStream(conn.getInputStream()); SAXParser parser = factory.newSAXParser(); parser.parse(in, handler); in.close(); } catch (ParserConfigurationException ex) { throw (IOException) new IOException().initCause(ex); } catch (SAXException ex) { throw (IOException) new IOException().initCause(ex); } } // Static initializer for JNLPParser static { factory = SAXParserFactory.newInstance(); systemOsName = System.getProperty("os.name").toLowerCase(); systemOsArch = System.getProperty("os.arch").toLowerCase(); if (DEBUG) { System.err.println("os.name = " + systemOsName); System.err.println("os.arch = " + systemOsArch); } } /** * Handler class containing callback methods for the parser. */ private class JNLPHandler extends DefaultHandler { JNLPHandler() { } @Override public void startDocument() { if (VERBOSE) { System.err.println("START DOCUMENT: " + url); } state = State.STARTED; if (VERBOSE) { System.err.println("state = " + state); } } @Override public void endDocument() { if (VERBOSE) { System.err.println("END DOCUMENT"); } state = State.INITIAL; if (VERBOSE) { System.err.println("state = " + state); } } @Override public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException { ++depth; if (VERBOSE) { System.err.println("<" + qName + ">" + " : depth=" + depth); for (int i = 0; i < attributes.getLength(); i++) { System.err.println(" [" + i + "] " + attributes.getQName(i) + " = \"" + attributes.getValue(i) + "\""); } } // Parse qName based on current state switch (state) { case STARTED: if (qName.equals("jnlp")) { state = State.IN_JNLP; codebase = attributes.getValue("codebase"); if (codebase == null) { throw new SAXException(" unable to determine codebase"); } if (codebase.lastIndexOf('/') != codebase.length()-1) { codebase = codebase + "/"; } if (VERBOSE) { System.err.println("JNLP : codebase=" + codebase); } if (VERBOSE) { System.err.println("state = " + state); } } else if (qName.equals("resources")) { throw new SAXException(" tag not within tag"); } // Ignore all other tags break; case IN_JNLP: if (qName.equals("jnlp")) { throw new SAXException("Nested tags"); } else if (qName.equals("resources")) { String osName = attributes.getValue("os"); String osArch = attributes.getValue("arch"); if ((osName == null || systemOsName.startsWith(osName.toLowerCase())) && (osArch == null || systemOsArch.startsWith(osArch.toLowerCase()))) { if (VERBOSE) { System.err.println("Loading resources : os=" + osName + " arch=" + osArch); } state = State.IN_RESOURCES; } else { prevState = state; skipDepth = depth - 1; state = State.SKIP_ELEMENT; } if (VERBOSE) { System.err.println("Resources : os=" + osName + " arch=" + osArch + " state = " + state); } } break; case IN_RESOURCES: try { if (qName.equals("jnlp")) { throw new SAXException("Nested tags"); } else if (qName.equals("resources")) { throw new SAXException("Nested tags"); } else if (qName.equals("jar")) { String str = attributes.getValue("href"); if (str == null || str.length() == 0) { throw new SAXException(" tag missing href attribute"); } String jarFileStr = codebase + str; if (VERBOSE) { System.err.println("Jar: " + jarFileStr); } URL jarFile = new URL(jarFileStr); launcher.addJarFile(jarFile); } else if (qName.equals("nativelib")) { String str = attributes.getValue("href"); if (str == null || str.length() == 0) { throw new SAXException(" tag missing href attribute"); } String nativeLibStr = codebase + str; if (VERBOSE) { System.err.println("Native Lib: " + nativeLibStr); } URL nativeLib = new URL(nativeLibStr); launcher.addNativeJar(nativeLib); } else if (qName.equals("extension")) { String extensionURLString = attributes.getValue("href"); if (extensionURLString == null || extensionURLString.length() == 0) { throw new SAXException(" tag missing href attribute"); } if (VERBOSE) { System.err.println("Extension: " + extensionURLString); } URL extensionURL = new URL(extensionURLString); JNLPParser parser = new JNLPParser(launcher, extensionURL); parser.parse(); } else { prevState = state; skipDepth = depth - 1; state = State.SKIP_ELEMENT; if (VERBOSE) { System.err.println("state = " + state); } } } catch (IOException ex) { throw (SAXException) new SAXException().initCause(ex); } break; case INITIAL: case SKIP_ELEMENT: default: break; } } @Override public void endElement(String uri, String localName, String qName) throws SAXException { --depth; if (VERBOSE) { System.err.println(""); } // Parse qName based on current state switch (state) { case IN_JNLP: if (qName.equals("jnlp")) { state = State.STARTED; if (VERBOSE) { System.err.println("state = " + state); } } break; case IN_RESOURCES: if (qName.equals("resources")) { state = State.IN_JNLP; if (VERBOSE) { System.err.println("state = " + state); } } break; case SKIP_ELEMENT: if (depth == skipDepth) { state = prevState; skipDepth = -1; if (VERBOSE) { System.err.println("state = " + state); } } break; case INITIAL: case STARTED: default: break; } } } } }