Enhancements / New utils: JarUtil, TempFileCache and TempJarCache

JarUtil:
  Utility to handle Jar files and it's content, incl. extracting it's entries

TempFileCache:
  Utility to have a save temporary file cache per JVM and per instance,
  eg. per ClassLoader.
  The temp cache is cleaned up with the next usage of TempFileCache,
  which solves the troubles of JVM bugs and situations where the JVM
  is not able to close and delete open temp files.

TempJarCache:
  Utility to cache Jar files temporary (using TempFileCache)
  and access it's content.
  This class is suitable to implement a URLClassLoader
  or similar resource loading facilities.

All tested w/ TestTempJarCache

1 files changed, 224 insertions, 0 deletions

diff --git a/src/java/com/jogamp/common/util/cache/TempJarCache.java b/src/java/com/jogamp/common/util/cache/TempJarCache.java
new file mode 100644
index 0000000..efdf113
--- /dev/null
+++ b/src/java/com/jogamp/common/util/cache/TempJarCache.java
@@ -0,0 +1,224 @@
+/**
+ * Copyright 2011 JogAmp Community. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification, are
+ * permitted provided that the following conditions are met:
+ *
+ *    1. Redistributions of source code must retain the above copyright notice, this list of
+ *       conditions and the following disclaimer.
+ *
+ *    2. Redistributions 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.
+ *
+ * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+ * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * The views and conclusions contained in the software and documentation are those of the
+ * authors and should not be interpreted as representing official policies, either expressed
+ * or implied, of JogAmp Community.
+ */
+package com.jogamp.common.util.cache;
+
+import java.io.File;
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.Map;
+import java.util.Set;
+import java.util.jar.JarFile;
+
+
+import com.jogamp.common.os.NativeLibrary;
+import com.jogamp.common.util.JarUtil;
+
+public class TempJarCache {
+    // 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<String, String> nativeLibMap;
+
+    // Set of native jar files added
+    private static Set<JarFile> nativeLibJars;
+    private static Set<JarFile> classFileJars;
+    private static Set<JarFile> resourceFileJars;
+
+    private static TempFileCache tmpFileCache;
+    
+    private static boolean staticInitError = false;
+    
+    static {
+        staticInitError = !TempFileCache.initSingleton();
+
+        if(!staticInitError) {
+            tmpFileCache = new TempFileCache();
+            staticInitError = !tmpFileCache.isValid(); 
+        }
+        
+        if(!staticInitError) {
+            // Initialize the collections of resources
+            nativeLibMap = new HashMap<String, String>();
+            nativeLibJars = new HashSet<JarFile>();
+            classFileJars = new HashSet<JarFile>();
+            resourceFileJars = new HashSet<JarFile>();
+        }
+    }
+    
+    /**
+     * Documented way to kick off static initialization
+     * @return true is static initialization was successful
+     */
+    public static boolean initSingleton() {
+        return isValid();        
+    }
+    
+    /**
+     * @return true is static initialization was successful
+     */
+    public static boolean isValid() {
+        return !staticInitError;
+    }
+    
+    public static TempFileCache getTempFileCache() {
+        return tmpFileCache;
+    }
+    
+    public static boolean contains(JarFile jarFile) throws IOException {
+        return nativeLibJars.contains(jarFile);
+    }    
+
+    /**
+     * Adds native libraries, if not yet added.
+     * 
+     * @param jarFile
+     * @return
+     * @throws IOException
+     */
+    public static boolean addNativeLibs(JarFile jarFile) throws IOException {        
+        if(!nativeLibJars.contains(jarFile)) {
+            JarUtil.extract(tmpFileCache.getTempDir(), nativeLibMap, jarFile, 
+                            true, false, false); 
+            nativeLibJars.add(jarFile);
+            return true;
+        }
+        return false;
+    }
+    
+    /**
+     * Adds native classes, if not yet added.
+     * 
+     * TODO class access pending
+     * needs Classloader.defineClass(..) access, ie. own derivation - will do when needed ..
+     *  
+     * @param jarFile
+     * @return
+     * @throws IOException
+     */
+    public static boolean addClasses(JarFile jarFile) throws IOException {        
+        if(!classFileJars.contains(jarFile)) {
+            JarUtil.extract(tmpFileCache.getTempDir(), null, jarFile, 
+                            false, true, false); 
+            classFileJars.add(jarFile);
+            return true;
+        }
+        return false;
+    }
+    
+    /**
+     * Adds native resources, if not yet added.
+     * 
+     * @param jarFile
+     * @return
+     * @throws IOException
+     */
+    public static boolean addResources(JarFile jarFile) throws IOException {        
+        if(!resourceFileJars.contains(jarFile)) {
+            JarUtil.extract(tmpFileCache.getTempDir(), null, jarFile, 
+                            false, false, true); 
+            resourceFileJars.add(jarFile);
+            return true;
+        }
+        return false;
+    }
+    
+    /**
+     * Adds all types, native libraries, class files and other files (resources),
+     * if not yet added.
+     *  
+     * TODO class access pending
+     * needs Classloader.defineClass(..) access, ie. own derivation - will do when needed ..
+     *  
+     * @param jarFile
+     * @return
+     * @throws IOException
+     */
+    public static boolean addAll(JarFile jarFile) throws IOException {        
+        if(!nativeLibJars.contains(jarFile) || 
+           !classFileJars.contains(jarFile) || 
+           !resourceFileJars.contains(jarFile)) {
+            final boolean extractNativeLibraries = !nativeLibJars.contains(jarFile);
+            final boolean extractClassFiles = !classFileJars.contains(jarFile);
+            final boolean extractOtherFiles = !resourceFileJars.contains(jarFile);
+            JarUtil.extract(tmpFileCache.getTempDir(), nativeLibMap, jarFile, 
+                            extractNativeLibraries, extractClassFiles, extractOtherFiles);
+            if(extractNativeLibraries) {
+                nativeLibJars.add(jarFile);
+            }
+            if(extractClassFiles) {
+                classFileJars.add(jarFile);
+            }
+            if(extractOtherFiles) {
+                resourceFileJars.add(jarFile);
+            }
+            return true;
+        }
+        return false;
+    }
+    
+    public static String findLibrary(String libName) {
+        // try with mapped library basename first
+        String path = nativeLibMap.get(libName);
+        if(null == path) {
+            // if valid library name, try absolute path in temp-dir
+            if(null != NativeLibrary.isValidNativeLibraryName(libName, false)) {    
+                final File f = new File(tmpFileCache.getTempDir(), libName);
+                if(f.exists()) {
+                    path = f.getAbsolutePath();
+                }
+            }
+        }
+        return path;
+    }
+    
+    /** TODO class access pending
+     * needs Classloader.defineClass(..) access, ie. own derivation - will do when needed .. 
+    public static Class<?> findClass(String name, ClassLoader cl) throws IOException, ClassFormatError {
+        final File f = new File(nativeTmpFileCache.getTempDir(), IOUtil.getClassFileName(name));
+        if(f.exists()) {
+            Class.forName(fname, initialize, loader)
+            URL url = new URL(f.getAbsolutePath());
+            byte[] b = IOUtil.copyStream2ByteArray(new BufferedInputStream( url.openStream() ));
+            MyClassLoader mcl = new MyClassLoader(cl);
+            return mcl.defineClass(name, b, 0, b.length);
+        }
+        return null;
+    } */
+    
+    public static String findResource(String name) {
+        final File f = new File(tmpFileCache.getTempDir(), name);
+        if(f.exists()) {
+            return f.getAbsolutePath();
+        }
+        return null;
+    }
+    
+}