jdk/src/share/classes/sun/net/www/protocol/jar/URLJarFile.java - platform/libcore - Git at Google

 /*
  * Copyright 2001-2006 Sun Microsystems, Inc.  All Rights Reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
  * under the terms of the GNU General Public License version 2 only, as
  * published by the Free Software Foundation.  Sun designates this
  * particular file as subject to the "Classpath" exception as provided
  * by Sun in the LICENSE file that accompanied this code.
  *
  * This code is distributed in the hope that it will be useful, but WITHOUT
  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  * version 2 for more details (a copy is included in the LICENSE file that
  * accompanied this code).
  *
  * You should have received a copy of the GNU General Public License version
  * 2 along with this work; if not, write to the Free Software Foundation,
  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  *
  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  * CA 95054 USA or visit www.sun.com if you need additional information or
  * have any questions.
  */

 package sun.net.www.protocol.jar;

 import java.io.*;
 import java.net.*;
 import java.util.*;
 import java.util.jar.*;
 import java.util.zip.ZipFile;
 import java.util.zip.ZipEntry;
 import java.security.CodeSigner;
 import java.security.cert.Certificate;
 import java.security.AccessController;
 import java.security.PrivilegedAction;
 import java.security.PrivilegedExceptionAction;
 import java.security.PrivilegedActionException;
 import sun.net.www.ParseUtil;

 /* URL jar file is a common JarFile subtype used for JarURLConnection */
 public class URLJarFile extends JarFile {

     /*
      * Interface to be able to call retrieve() in plugin if
      * this variable is set.
      */
     private static URLJarFileCallBack callback = null;

     /* Controller of the Jar File's closing */
     private URLJarFileCloseController closeController = null;

     private static int BUF_SIZE = 2048;

     private Manifest superMan;
     private Attributes superAttr;
     private Map<String, Attributes> superEntries;

     static JarFile getJarFile(URL url) throws IOException {
         return getJarFile(url, null);
     }

     static JarFile getJarFile(URL url, URLJarFileCloseController closeController) throws IOException {
         if (isFileURL(url))
             return new URLJarFile(url, closeController);
         else {
             return retrieve(url, closeController);
         }
     }

     /*
      * Changed modifier from private to public in order to be able
      * to instantiate URLJarFile from sun.plugin package.
      */
     public URLJarFile(File file) throws IOException {
         this(file, null);
     }

     /*
      * Changed modifier from private to public in order to be able
      * to instantiate URLJarFile from sun.plugin package.
      */
     public URLJarFile(File file, URLJarFileCloseController closeController) throws IOException {
         super(file, true, ZipFile.OPEN_READ | ZipFile.OPEN_DELETE);
         this.closeController = closeController;
     }

     private URLJarFile(URL url, URLJarFileCloseController closeController) throws IOException {
         super(ParseUtil.decode(url.getFile()));
         this.closeController = closeController;
     }

     private static boolean isFileURL(URL url) {
         if (url.getProtocol().equalsIgnoreCase("file")) {
             /*
              * Consider this a 'file' only if it's a LOCAL file, because
              * 'file:' URLs can be accessible through ftp.
              */
             String host = url.getHost();
             if (host == null || host.equals("") || host.equals("~") ||
                 host.equalsIgnoreCase("localhost"))
                 return true;
         }
         return false;
     }

     /*
      * close the jar file.
      */
     protected void finalize() throws IOException {
         close();
     }

     /**
      * Returns the <code>ZipEntry</code> for the given entry name or
      * <code>null</code> if not found.
      *
      * @param name the JAR file entry name
      * @return the <code>ZipEntry</code> for the given entry name or
      *         <code>null</code> if not found
      * @see java.util.zip.ZipEntry
      */
     public ZipEntry getEntry(String name) {
         ZipEntry ze = super.getEntry(name);
         if (ze != null) {
             if (ze instanceof JarEntry)
                 return new URLJarFileEntry((JarEntry)ze);
             else
                 throw new InternalError(super.getClass() +
                                         " returned unexpected entry type " +
                                         ze.getClass());
         }
         return null;
     }

     public Manifest getManifest() throws IOException {

         if (!isSuperMan()) {
             return null;
         }

         Manifest man = new Manifest();
         Attributes attr = man.getMainAttributes();
         attr.putAll((Map)superAttr.clone());

         // now deep copy the manifest entries
         if (superEntries != null) {
             Map<String, Attributes> entries = man.getEntries();
             for (String key : superEntries.keySet()) {
                 Attributes at = superEntries.get(key);
                 entries.put(key, (Attributes) at.clone());
             }
         }

         return man;
     }

     /* If close controller is set the notify the controller about the pending close */
     public void close() throws IOException {
         if (closeController != null) {
                 closeController.close(this);
         }
         super.close();
     }

     // optimal side-effects
     private synchronized boolean isSuperMan() throws IOException {

         if (superMan == null) {
             superMan = super.getManifest();
         }

         if (superMan != null) {
             superAttr = superMan.getMainAttributes();
             superEntries = superMan.getEntries();
             return true;
         } else
             return false;
     }

     /**
      * Given a URL, retrieves a JAR file, caches it to disk, and creates a
      * cached JAR file object.
      */
     private static JarFile retrieve(final URL url) throws IOException {
         return retrieve(url, null);
     }

     /**
      * Given a URL, retrieves a JAR file, caches it to disk, and creates a
      * cached JAR file object.
      */
      private static JarFile retrieve(final URL url, final URLJarFileCloseController closeController) throws IOException {
         /*
          * See if interface is set, then call retrieve function of the class
          * that implements URLJarFileCallBack interface (sun.plugin - to
          * handle the cache failure for JARJAR file.)
          */
         if (callback != null)
         {
             return callback.retrieve(url);
         }

         else
         {

             JarFile result = null;

             /* get the stream before asserting privileges */
             final InputStream in =  url.openConnection().getInputStream();

             try {
                 result = AccessController.doPrivileged(
                     new PrivilegedExceptionAction<JarFile>() {
                         public JarFile run() throws IOException {
                             OutputStream out = null;
                             File tmpFile = null;
                             try {
                                 tmpFile = File.createTempFile("jar_cache", null);
                                 tmpFile.deleteOnExit();
                                 out  = new FileOutputStream(tmpFile);
                                 int read = 0;
                                 byte[] buf = new byte[BUF_SIZE];
                                 while ((read = in.read(buf)) != -1) {
                                     out.write(buf, 0, read);
                                 }
                                 out.close();
                                 out = null;
                                 return new URLJarFile(tmpFile, closeController);
                             } catch (IOException e) {
                                 if (tmpFile != null) {
                                     tmpFile.delete();
                                 }
                                 throw e;
                             } finally {
                                 if (in != null) {
                                     in.close();
                                 }
                                 if (out != null) {
                                     out.close();
                                 }
                             }
                         }
                     });
             } catch (PrivilegedActionException pae) {
                 throw (IOException) pae.getException();
             }

             return result;
         }
     }

     /*
      * Set the call back interface to call retrive function in sun.plugin
      * package if plugin is running.
      */
     public static void setCallBack(URLJarFileCallBack cb)
     {
         callback = cb;
     }


     private class URLJarFileEntry extends JarEntry {
         private JarEntry je;

         URLJarFileEntry(JarEntry je) {
             super(je);
             this.je=je;
         }

         public Attributes getAttributes() throws IOException {
             if (URLJarFile.this.isSuperMan()) {
                 Map<String, Attributes> e = URLJarFile.this.superEntries;
                 if (e != null) {
                     Attributes a = e.get(getName());
                     if (a != null)
                         return  (Attributes)a.clone();
                 }
             }
             return null;
         }

         public java.security.cert.Certificate[] getCertificates() {
             Certificate[] certs = je.getCertificates();
             return certs == null? null: certs.clone();
         }

         public CodeSigner[] getCodeSigners() {
             CodeSigner[] csg = je.getCodeSigners();
             return csg == null? null: csg.clone();
         }
     }

     public interface URLJarFileCloseController {
         public void close(JarFile jarFile);
     }
 }
	/*
	* Copyright 2001-2006 Sun Microsystems, Inc. All Rights Reserved.
	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
	*
	* This code is free software; you can redistribute it and/or modify it
	* under the terms of the GNU General Public License version 2 only, as
	* published by the Free Software Foundation. Sun designates this
	* particular file as subject to the "Classpath" exception as provided
	* by Sun in the LICENSE file that accompanied this code.
	*
	* This code is distributed in the hope that it will be useful, but WITHOUT
	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
	* version 2 for more details (a copy is included in the LICENSE file that
	* accompanied this code).
	*
	* You should have received a copy of the GNU General Public License version
	* 2 along with this work; if not, write to the Free Software Foundation,
	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
	*
	* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
	* CA 95054 USA or visit www.sun.com if you need additional information or
	* have any questions.
	*/

	package sun.net.www.protocol.jar;

	import java.io.*;
	import java.net.*;
	import java.util.*;
	import java.util.jar.*;
	import java.util.zip.ZipFile;
	import java.util.zip.ZipEntry;
	import java.security.CodeSigner;
	import java.security.cert.Certificate;
	import java.security.AccessController;
	import java.security.PrivilegedAction;
	import java.security.PrivilegedExceptionAction;
	import java.security.PrivilegedActionException;
	import sun.net.www.ParseUtil;

	/* URL jar file is a common JarFile subtype used for JarURLConnection */
	public class URLJarFile extends JarFile {

	/*
	* Interface to be able to call retrieve() in plugin if
	* this variable is set.
	*/
	private static URLJarFileCallBack callback = null;

	/* Controller of the Jar File's closing */
	private URLJarFileCloseController closeController = null;

	private static int BUF_SIZE = 2048;

	private Manifest superMan;
	private Attributes superAttr;
	private Map<String, Attributes> superEntries;

	static JarFile getJarFile(URL url) throws IOException {
	return getJarFile(url, null);
	}

	static JarFile getJarFile(URL url, URLJarFileCloseController closeController) throws IOException {
	if (isFileURL(url))
	return new URLJarFile(url, closeController);
	else {
	return retrieve(url, closeController);
	}
	}

	/*
	* Changed modifier from private to public in order to be able
	* to instantiate URLJarFile from sun.plugin package.
	*/
	public URLJarFile(File file) throws IOException {
	this(file, null);
	}

	/*
	* Changed modifier from private to public in order to be able
	* to instantiate URLJarFile from sun.plugin package.
	*/
	public URLJarFile(File file, URLJarFileCloseController closeController) throws IOException {
	super(file, true, ZipFile.OPEN_READ \| ZipFile.OPEN_DELETE);
	this.closeController = closeController;
	}

	private URLJarFile(URL url, URLJarFileCloseController closeController) throws IOException {
	super(ParseUtil.decode(url.getFile()));
	this.closeController = closeController;
	}

	private static boolean isFileURL(URL url) {
	if (url.getProtocol().equalsIgnoreCase("file")) {
	/*
	* Consider this a 'file' only if it's a LOCAL file, because
	* 'file:' URLs can be accessible through ftp.
	*/
	String host = url.getHost();
	if (host == null \|\| host.equals("") \|\| host.equals("~") \|\|
	host.equalsIgnoreCase("localhost"))
	return true;
	}
	return false;
	}

	/*
	* close the jar file.
	*/
	protected void finalize() throws IOException {
	close();
	}

	/**
	* Returns the <code>ZipEntry</code> for the given entry name or
	* <code>null</code> if not found.
	*
	* @param name the JAR file entry name
	* @return the <code>ZipEntry</code> for the given entry name or
	* <code>null</code> if not found
	* @see java.util.zip.ZipEntry
	*/
	public ZipEntry getEntry(String name) {
	ZipEntry ze = super.getEntry(name);
	if (ze != null) {
	if (ze instanceof JarEntry)
	return new URLJarFileEntry((JarEntry)ze);
	else
	throw new InternalError(super.getClass() +
	" returned unexpected entry type " +
	ze.getClass());
	}
	return null;
	}

	public Manifest getManifest() throws IOException {

	if (!isSuperMan()) {
	return null;
	}

	Manifest man = new Manifest();
	Attributes attr = man.getMainAttributes();
	attr.putAll((Map)superAttr.clone());

	// now deep copy the manifest entries
	if (superEntries != null) {
	Map<String, Attributes> entries = man.getEntries();
	for (String key : superEntries.keySet()) {
	Attributes at = superEntries.get(key);
	entries.put(key, (Attributes) at.clone());
	}
	}

	return man;
	}

	/* If close controller is set the notify the controller about the pending close */
	public void close() throws IOException {
	if (closeController != null) {
	closeController.close(this);
	}
	super.close();
	}

	// optimal side-effects
	private synchronized boolean isSuperMan() throws IOException {

	if (superMan == null) {
	superMan = super.getManifest();
	}

	if (superMan != null) {
	superAttr = superMan.getMainAttributes();
	superEntries = superMan.getEntries();
	return true;
	} else
	return false;
	}

	/**
	* Given a URL, retrieves a JAR file, caches it to disk, and creates a
	* cached JAR file object.
	*/
	private static JarFile retrieve(final URL url) throws IOException {
	return retrieve(url, null);
	}

	/**
	* Given a URL, retrieves a JAR file, caches it to disk, and creates a
	* cached JAR file object.
	*/
	private static JarFile retrieve(final URL url, final URLJarFileCloseController closeController) throws IOException {
	/*
	* See if interface is set, then call retrieve function of the class
	* that implements URLJarFileCallBack interface (sun.plugin - to
	* handle the cache failure for JARJAR file.)
	*/
	if (callback != null)
	{
	return callback.retrieve(url);
	}

	else
	{

	JarFile result = null;

	/* get the stream before asserting privileges */
	final InputStream in = url.openConnection().getInputStream();

	try {
	result = AccessController.doPrivileged(
	new PrivilegedExceptionAction<JarFile>() {
	public JarFile run() throws IOException {
	OutputStream out = null;
	File tmpFile = null;
	try {
	tmpFile = File.createTempFile("jar_cache", null);
	tmpFile.deleteOnExit();
	out = new FileOutputStream(tmpFile);
	int read = 0;
	byte[] buf = new byte[BUF_SIZE];
	while ((read = in.read(buf)) != -1) {
	out.write(buf, 0, read);
	}
	out.close();
	out = null;
	return new URLJarFile(tmpFile, closeController);
	} catch (IOException e) {
	if (tmpFile != null) {
	tmpFile.delete();
	}
	throw e;
	} finally {
	if (in != null) {
	in.close();
	}
	if (out != null) {
	out.close();
	}
	}
	}
	});
	} catch (PrivilegedActionException pae) {
	throw (IOException) pae.getException();
	}

	return result;
	}
	}

	/*
	* Set the call back interface to call retrive function in sun.plugin
	* package if plugin is running.
	*/
	public static void setCallBack(URLJarFileCallBack cb)
	{
	callback = cb;
	}


	private class URLJarFileEntry extends JarEntry {
	private JarEntry je;

	URLJarFileEntry(JarEntry je) {
	super(je);
	this.je=je;
	}

	public Attributes getAttributes() throws IOException {
	if (URLJarFile.this.isSuperMan()) {
	Map<String, Attributes> e = URLJarFile.this.superEntries;
	if (e != null) {
	Attributes a = e.get(getName());
	if (a != null)
	return (Attributes)a.clone();
	}
	}
	return null;
	}

	public java.security.cert.Certificate[] getCertificates() {
	Certificate[] certs = je.getCertificates();
	return certs == null? null: certs.clone();
	}

	public CodeSigner[] getCodeSigners() {
	CodeSigner[] csg = je.getCodeSigners();
	return csg == null? null: csg.clone();
	}
	}

	public interface URLJarFileCloseController {
	public void close(JarFile jarFile);
	}
	}