/*
 *                 Sun Public License Notice
 * 
 * The contents of this file are subject to the Sun Public License
 * Version 1.0 (the "License"). You may not use this file except in
 * compliance with the License. A copy of the License is available at
 * http://www.sun.com/
 * 
 * The Original Code is NetBeans. The Initial Developer of the Original
 * Code is Sun Microsystems, Inc. Portions Copyright 1997-2003 Sun
 * Microsystems, Inc. All Rights Reserved.
 */

package org.netbeans;

import java.util.*;
import java.net.URL;
import java.io.IOException;
import java.security.AccessController;
import java.security.PrivilegedAction;

/**
 * A class loader that has multiple parents and uses them for loading
 * classes and resources. It can be used in tree hierarchy, where it
 * can exploit its capability to not throw ClassNotFoundException when
 * communicating with other ProxyClassLoader.
 * It itself doesn't load classes or resources, but allows subclasses
 * to add such functionality.
 *
 * @author  Petr Nejedly, Jesse Glick
 */
public class ProxyClassLoader extends ClassLoader {
    
    /** #38368: Allow disabling the default package warning */
    private static final boolean DO_NOT_WARN_DEFAULT_PACKAGE = Boolean.getBoolean("org.netbeans.do_not_warn_default_package"); // NOI18N
    
    /** empty enumeration */
    private static final Enumeration EMPTY = new ArrayEnumeration (new Object[0]);
    
    /**
     * All known package owners.
     * Packages are given in format org/netbeans/modules/foo/.
     * Of type Map<String,ClassLoader>.
     */
    private final Map domainsByPackage = new HashMap(); 
    /** All known packages, of type Map<String,Package> */
    private final Map packages = new HashMap();

    /** All parents of this classloader, including their parents recursively */
    private ClassLoader[] parents;

    /** if true, we have been destroyed */
    private boolean dead = false;
    
    private final boolean transitive;
    
    /** Create a multi-parented classloader.
     * Loads recursively from parents.
     * @param parents list of parent classloaders. 
     * @throws IllegalArgumentException if there are any nulls or duplicate
     * parent loaders or cycles.
     */
    public ProxyClassLoader( ClassLoader[] parents ) {
        this(parents, true);
    }
    
    /** Create a multi-parented classloader.
     * @param parents list of parent classloaders. 
     * @param transitive whether other PCLs depending on this one will
     *                   automatically search through its parent list
     * @throws IllegalArgumentException if there are any nulls or duplicate
     * parent loaders or cycles.
     * @since org.netbeans.core/1 > 1.6
     */
    public ProxyClassLoader(ClassLoader[] parents, boolean transitive) {
        if (parents.length == 0) {
            throw new IllegalArgumentException ("ProxyClassLoader must have a parent"); // NOI18N
        }
        
        this.transitive = transitive;
        
        Set check = new HashSet(Arrays.asList(parents)); // Set
        if (check.size() < parents.length) throw new IllegalArgumentException("duplicate parents"); // NOI18N
        if (check.contains(null)) throw new IllegalArgumentException("null parent in " + check); // NOI18N

        this.parents = coalesceParents(parents);
    }
    
    // this is used only by system classloader, maybe we can redesign it a bit
    // to live without this functionality, then destroy may also go away
    /** Add new parents dynamically.
     * @param parents the new parents to add (append to list)
     * @throws IllegalArgumentException in case of a null or cyclic parent (duplicate OK)
     */
    public synchronized void append(ClassLoader[] nueparents) throws IllegalArgumentException {
        // XXX should this be synchronized?
        if (nueparents == null) throw new IllegalArgumentException("null parents array"); // NOI18N
        for (int i = 0; i < nueparents.length; i++) {
            if (nueparents[i] == null) throw new IllegalArgumentException("null parent"); // NOI18N
        }
        
        parents = coalesceAppend(parents, nueparents);
    }

    
    
    /** Try to destroy this classloader.
     * Subsequent attempts to use it will log an error (at most one though).
     */
    public void destroy() {
        dead = true;
    }

    private void zombieCheck(String hint) {
        if (/*dead*/false/* suppress this warning for now, more confusing than useful */) {
            IllegalStateException ise = new IllegalStateException("WARNING - attempting to use a zombie classloader " + this + " on " + hint + ". This means classes from a disabled module are still active. May or may not be a problem."); // NOI18N
            JarClassLoader.notify(0, ise);
            // don't warn again for same loader... this was enough
            dead = false;
        }
    }

    /**
     * Loads the class with the specified name.  The implementation of
     * this method searches for classes in the following order:

     * 

     * 
 Calls {@link #findLoadedClass(String)} to check if the class has
     *      already been loaded.
     * 
 Checks the caches whether another class from the same package
     *      was already loaded and uses the same classloader
     * 
 Tries to find the class using parent loaders in their order.
     * 
 Calls the {@link #simpleFindClass} method to find
     *      the class using this class loader.
     * 
     *
     * @param     name the name of the class
     * @param     resolve if true then resolve the class
     * @return	  the resulting Class object
     * @exception ClassNotFoundException if the class could not be found
     */
    protected synchronized final Class loadClass(String name, boolean resolve)
                                            throws ClassNotFoundException {
        zombieCheck(name);
        String filename = name.replace('.', '/').concat(".class"); // NOI18N
        int idx = filename.lastIndexOf('/'); // NOI18N
        if (idx == -1) throw new ClassNotFoundException("Will not load classes from default package"); // NOI18N
        String pkg = filename.substring(0, idx + 1); // "org/netbeans/modules/foo/"
        Class c = smartLoadClass(name, filename, pkg);
        if(c == null) throw new ClassNotFoundException(name);
        if (resolve) resolveClass(c);
        return c;
    }
    
    /** This ClassLoader can't load anything itself. Subclasses
     * may override this method to do some class loading themselves. The
     * implementation should not throw any exception, just return
     * null if it can't load required class.
     *
     * @param  name the name of the class
     * @param  fileName the expected filename of the classfile, like
     *      java/lang/Object.class for java.lang.Object
     *      The ClassLoader implementation may or may not use it, depending
     *      whether it is usefull to it.
     * @param pkg the package name, in the format org/netbeans/modules/foo/
     * @return the resulting Class object or null
     */
    protected Class simpleFindClass(String name, String fileName, String pkg) {
        return null;
    }
    

    /**
     * Finds the resource with the given name. The implementation of
     * this method searches for resources in the following order:

     * 

     * 
 Checks the caches whether another resource or class from the same
     *      package was already loaded and uses the same classloader.
     * 
 Tries to find the resources using parent loaders in their order.
     * 
 Calls the {@link #findResource(String)} method to find
     *      the resources using this class loader.
     * 
     *
     * @param  name a "/"-separated path name that identifies the resource.
     * @return a URL for reading the resource, or null if
     *      the resource could not be found.
     * @see #findResource(String)
     */
    public final URL getResource(final String name) {
        zombieCheck(name);
        
        final int slashIdx = name.lastIndexOf('/');
        if (slashIdx == -1) {
            printDefaultPackageWarning(name);
        }
        final String pkg = name.substring(0, slashIdx + 1);

        if (isSpecialResource(pkg)) {
            // Disable domain cache for this one, do a simple check.
            for (int i = 0; i < parents.length; i++) {
                if (!shouldDelegateResource(pkg, parents[i])) continue;
                URL u;
                if (parents[i] instanceof ProxyClassLoader) {
                    u = ((ProxyClassLoader)parents[i]).findResource(name);
                } else {
                    u = parents[i].getResource(name);
                }
                if (u != null) return u;
            }
            return findResource(name);
        }
        
        ClassLoader owner = (ClassLoader)domainsByPackage.get(pkg);

        if (owner != null) { // known package
            // Note that shouldDelegateResource should already be true for this!
            if (owner instanceof ProxyClassLoader) {
                return ((ProxyClassLoader)owner).findResource(name); // we have its parents, skip them
	    } else {
                return owner.getResource(name);     // know nothing about this loader and his structure
            }
        } 
        
        // virgin package
        URL retVal = null;
        for (int i = 0; i < parents.length; i++) {
            owner = parents[i];
            if (!shouldDelegateResource(pkg, owner)) continue;
            if (owner instanceof ProxyClassLoader) {
                retVal = ((ProxyClassLoader)owner).findResource(name); // skip parents (checked already)
            } else {
                retVal = owner.getResource(name); // know nothing about this loader and his structure
            }
            if (retVal != null) {
                domainsByPackage.put(pkg, owner);
                return retVal;
            }
        }
        
        // try it ourself
        retVal = findResource(name);
        if (retVal != null) {
            domainsByPackage.put(pkg, this);
        }
        return retVal;
    }

    /** This ClassLoader can't load anything itself. Subclasses
     * may override this method to do some resource loading themselves.
     *
     * @param  name the resource name
     * @return a URL for reading the resource, or null
     *      if the resource could not be found.
     */
    protected URL findResource(String name) {
	return null;
    }

    /**
     * Finds all the resource with the given name. The implementation of
     * this method uses the {@link #simpleFindResources(String)} method to find
     * all the resources available from this classloader and adds all the 
     * resources from all the parents.
     *
     * @param  name the resource name
     * @return an Enumeration of URLs for the resources
     * @throws IOException if I/O errors occur
     */    
    protected final synchronized Enumeration findResources(String name) throws IOException {
        zombieCheck(name);
        final int slashIdx = name.lastIndexOf('/');
        if (slashIdx == -1) {
            printDefaultPackageWarning(name);
        }
        final String pkg = name.substring(0, slashIdx + 1);

        // Don't bother optimizing this call by domains.
        // It is mostly used for resources for which isSpecialResource would be true anyway.
        Enumeration[] es = new Enumeration[parents.length + 1];
        for (int i = 0; i < parents.length; i++) {
            if (!shouldDelegateResource(pkg, parents[i])) {
                es[i] = EMPTY;
                continue;
            }
            if (parents[i] instanceof ProxyClassLoader) {
                es[i] = ((ProxyClassLoader)parents[i]).simpleFindResources(name);
            } else {
                es[i] = parents[i].getResources(name);
            }
        }
        es[parents.length] = simpleFindResources(name);
        // Should not be duplicates, assuming the parent loaders are properly distinct
        // from one another and do not overlap in JAR usage, which they ought not.
        // Anyway MetaInfServicesLookup, the most important client of this method, does
        // its own duplicate filtering already.
        return new AAEnum (es);
    }

    /** This ClassLoader can't load anything itself. Subclasses
     * may override this method to do some resource loading themselves, this
     * implementation simply delegates to findResources method of the superclass
     * that should return empty Enumeration.
     *
     * @param  name the resource name
     * @return an Enumeration of URLs for the resources
     * @throws IOException if I/O errors occur
     */
    protected Enumeration simpleFindResources(String name) throws IOException {
        return super.findResources(name);
    }

    
    /**
     * Returns a Package that has been defined by this class loader or any
     * of its parents.
     *
     * @param  name the package name
     * @return the Package corresponding to the given name, or null if not found
     */
    protected Package getPackage(String name) {
        zombieCheck(name);
        return getPackageFast(name, name.replace('.', '/') + '/', true);
    }
    
    /**
     * Faster way to find a package.
     * @param name package name in org.netbeans.modules.foo format
     * @param sname package name in org/netbeans/modules/foo/ format
     * @param recurse whether to also ask parents
     */
    protected Package getPackageFast(String name, String sname, boolean recurse) {
        synchronized (packages) {
            Package pkg = (Package)packages.get(name);
            if (pkg != null) {
                return pkg;
            }
            if (!recurse) {
                return null;
            }
            for (int i = 0; i < parents.length; i++) {
                ClassLoader par = parents[i];
                if (par instanceof ProxyClassLoader && shouldDelegateResource(sname, par)) {
                    pkg = ((ProxyClassLoader)par).getPackageFast(name, sname, false);
                    if (pkg != null) {
                        break;
                    }
                }
            }
            if (pkg == null && /* #30093 */shouldDelegateResource(sname, getParent())) {
                // Cannot access either Package.getSystemPackage nor ClassLoader.getPackage
                // from here, so do the best we can though it will cause unnecessary
                // duplication of the package cache (PCL.packages vs. CL.packages):
                pkg = super.getPackage(name);
            }
            if (pkg != null) {
                packages.put(name, pkg);
            }
            return pkg;
        }
    }

    /** This is here just for locking serialization purposes.
     * Delegates to super.definePackage with proper locking.
     * Also tracks the package in our private cache, since
     * getPackageFast(...,...,false) will not call super.getPackage.
     */
    protected Package definePackage(String name, String specTitle,
                String specVersion, String specVendor, String implTitle,
		String implVersion, String implVendor, URL sealBase )
		throws IllegalArgumentException {
	synchronized (packages) {
            Package pkg = super.definePackage (name, specTitle, specVersion, specVendor, implTitle,
			implVersion, implVendor, sealBase);
            packages.put(name, pkg);
            return pkg;
	}
    }

    /**
     * Returns all of the Packages defined by this class loader and its parents.
     *
     * @return the array of Package objects defined by this
     * ClassLoader
     */
    protected synchronized Package[] getPackages() {
        zombieCheck(null);
        Map all = new HashMap(); // Map
        // XXX call shouldDelegateResource on each?
        addPackages(all, super.getPackages());
        for (int i = 0; i < parents.length; i++) {
            ClassLoader par = parents[i];
            if (par instanceof ProxyClassLoader) {
                // XXX should ideally use shouldDelegateResource here...
                addPackages(all, ((ProxyClassLoader)par).getPackages());
            }
        }
        synchronized (packages) {
            Iterator it = all.entrySet().iterator();
            while (it.hasNext()) {
                Map.Entry entry = (Map.Entry)it.next();
                Object name = entry.getKey();
                if (! packages.containsKey(name)) {
                    packages.put(name, entry.getValue());
                }
            }
        }
        return (Package[])all.values().toArray(new Package[all.size()]);
    }
    
    public Package getPackageAccessibly(String name) {
        return getPackage(name);
    }
    
    public Package[] getPackagesAccessibly() {
        return getPackages();
    }

    /**
     * #38368: Warn that the default package should not be used.
     */
    private static void printDefaultPackageWarning(String name) {
        if (! DO_NOT_WARN_DEFAULT_PACKAGE) {
            System.out.println("You are trying to access file: " + name + " from the default package."); // NOI18N
            System.out.println("Please see http://www.netbeans.org/download/dev/javadoc/OpenAPIs/org/openide/doc-files/classpath.html#default_package"); // NOI18N
        }
    }
    
    /** Coalesce parent classloaders into an optimized set.
     * This means that all parents of the specified classloaders
     * are also added recursively, removing duplicates along the way.
     * Search order should be preserved (parents before children, stable w.r.t. inputs).
     * @param loaders list of suggested parents (no nulls or duplicates permitted)
     * @return optimized list of parents (no nulls or duplicates)
     * @throws IllegalArgumentException if there are cycles
     */
    private ClassLoader[] coalesceParents(ClassLoader[] loaders) throws IllegalArgumentException {
        int likelySize = loaders.length * 5 + 10;
        Set resultingUnique = new HashSet(likelySize); // Set
        List resulting = new ArrayList(likelySize); // List
        for (int i = 0; i < loaders.length; i++) {
            addRec(resultingUnique, resulting, loaders[i]);
        }
        ClassLoader[] ret = (ClassLoader[])resulting.toArray(new ClassLoader[resulting.size()]);
        return ret;
    }
    
    /** Coalesce a new set of loaders into the existing ones.
     */
    private ClassLoader[] coalesceAppend(ClassLoader[] existing, ClassLoader[] appended) throws IllegalArgumentException {
        int likelySize = existing.length + 3;
        Set resultingUnique = new HashSet(likelySize);
        List existingL = Arrays.asList(existing);
        resultingUnique.addAll(existingL);
        if (resultingUnique.containsAll(Arrays.asList(appended))) {
            // No change required.
            return existing;
        }
        List resulting = new ArrayList(likelySize);
        resulting.addAll(existingL);
        for (int i = 0; i < appended.length; i++) {
            addRec(resultingUnique, resulting, appended[i]);
        }
        ClassLoader[] ret = (ClassLoader[])resulting.toArray(new ClassLoader[resulting.size()]);
        return ret;
    }
    
    private void addRec(Set resultingUnique, List resulting, ClassLoader loader) throws IllegalArgumentException {
        if (loader == this) throw new IllegalArgumentException("cycle in parents"); // NOI18N
        if (resultingUnique.contains(loader)) return;
        if (loader instanceof ProxyClassLoader && ((ProxyClassLoader)loader).transitive) {
            ClassLoader[] parents = ((ProxyClassLoader)loader).parents;
            for (int i = 0; i < parents.length; i++) {
                addRec(resultingUnique, resulting, parents[i]);
            }
        }
        resultingUnique.add(loader);
        resulting.add(loader);
    }

    /** A method that finds a class either in itself or in parents.
     * It uses dual signaling for class not found: it can either return null
     * or throw CNFE itself.
     * @param name class name, e.g. "org.netbeans.modules.foo.Clazz"
     * @param fileName resource name, e.g. "org/netbeans/modules/foo/Clazz.class"
     * @param pkg package component, e.g. "org/netbeans/modules/foo/"
     * @return a class or null if not found. It can also throw an exception.
     * @throws ClassNotFoundException in case it doesn't found a class
     * and a parent eglible for loading it thrown it already.
     */
    private final Class smartLoadClass(String name, String fileName, String pkg) throws ClassNotFoundException {
	// First, check if the class has already been loaded
	Class c = findLoadedClass(name);
	if(c != null) return c;
        
        final ClassLoader owner = isSpecialResource(pkg) ? null : (ClassLoader)domainsByPackage.get(pkg);
        if (owner == this) {
            return simpleFindClass(name, fileName, pkg);
        }
        if (owner != null) {
            // Note that shouldDelegateResource should already be true as we hit this pkg before.
            if (owner instanceof ProxyClassLoader) {
                return ((ProxyClassLoader)owner).fullFindClass(name, fileName, pkg);
            } else {
                return owner.loadClass(name); // May throw CNFE, will be propagated
            }
        }
        
        // Virgin package, do the parent scan 
        c = loadInOrder(name, fileName, pkg);

        if (c != null) {
            final ClassLoader owner2 = getClassClassLoader(c); // who got it?
            domainsByPackage.put(pkg, owner2);
        }
        return c;
    }

    // #29844 run as privileged as it may get called by loadClassInternal() used
    // during class resolving by JVM with arbitrary ProtectionDomain context stack
    private static ClassLoader getClassClassLoader(final Class c) {
        return (ClassLoader) AccessController.doPrivileged(new PrivilegedAction() {
            public Object run() {
                return c.getClassLoader();
            }
        });
    }

    private final Class loadInOrder( String name, String fileName, String pkg ) throws ClassNotFoundException {
        ClassNotFoundException cached = null;
        for (int i = 0; i < parents.length; i++) {
	    ClassLoader par = parents[i];
            if (!shouldDelegateResource(pkg, par)) continue;
	    if (par instanceof ProxyClassLoader) {
                ProxyClassLoader pcl = (ProxyClassLoader)par;
		Class c = pcl.fullFindClass(name, fileName, pkg);
                // pcl might have have c in its already-loaded classes even though
                // it was not the defining class loader. In that case, if pcl was
                // not transitive (should not expose its own parents), reject this.
                if (c != null && (pcl.transitive || getClassClassLoader(c) == pcl)) return c;
	    } else {
                // The following is an optimization, it should not affect semantics:
                boolean skip = false;
                if (name.startsWith("org.netbeans.") || // NOI18N
                        name.startsWith("org.openide.") || // NOI18N
                        name.endsWith(".Bundle") || // NOI18N
                        name.endsWith("BeanInfo") || // NOI18N
                        name.endsWith("Editor")) { // NOI18N
                    if (par.getResource(fileName) == null) {
                        // We would just throw CNFE anyway, don't bother!
                        // Avg. (over ten runs after primer, w/ netbeans.close):
                        // before: 13.87s after: 13.40s saved: 1.3%
                        skip = true;
                    }
                }
                if (!skip) {
                    try {
                        return par.loadClass(name);
                    } catch( ClassNotFoundException cnfe ) {
                        cached = cnfe;
                    }
                }
	    }
	}

        Class c = simpleFindClass(name, fileName, pkg); // Try it ourselves
        if (c != null) return c;
        if (cached != null) throw cached;
	return null;
    }

    private synchronized Class fullFindClass(String name, String fileName, String pkg) {
	Class c = findLoadedClass(name);
	return (c == null) ? simpleFindClass(name, fileName, pkg) : c;
    }    

    private void addPackages(Map all, Package[] pkgs) {
        // Would be easier if Package.equals() was just defined sensibly...
        for (int i = 0; i < pkgs.length; i++) {
            all.put(pkgs[i].getName(), pkgs[i]);
        }
    }
    
    /** Test whether a given resource name is something that any JAR might
     * have, and for which the domain cache should be disabled.
     * The result must not change from one call to the next with the same argument.
     * By default the domain cache is disabled only for META-INF/* JAR information.
     * @param pkg the package component of the resource path ending with a slash,
     *        e.g. "org/netbeans/modules/foo/"
     * @return true if it is a special resource, false for normal domain-cached resource
     * @since org.netbeans.core/1 1.3
     */
    protected boolean isSpecialResource(String pkg) {
        if (pkg.startsWith("META-INF/")) return true; // NOI18N
        
        // #38368: do not cache the default package
        if (pkg.length() == 0) return true;
        
        return false;
    }
    
    /** Test whether a given resource request (for a class or not) should be
     * searched for in the specified parent classloader or not.
     * The result must not change from one call to the next with the same arguments.
     * By default, always true. Subclasses may override to "mask" certain
     * packages from view, possibly according to the classloader chain.
     * @param pkg the package component of the resource path ending with a slash,
     *        e.g. "org/netbeans/modules/foo/"
     * @param parent a classloader which is a direct or indirect parent of this one
     * @return true if the request should be delegated to this parent; false to
     *         only search elsewhere (other parents, this loader's own namespace)
     * @since org.netbeans.core/1 1.3
     */
    protected boolean shouldDelegateResource(String pkg, ClassLoader parent) {
        return true;
    }
    
    
    private static final class ArrayEnumeration implements Enumeration {
        /** The array */
        private Object[] array;
        /** Current index in the array */
        private int index = 0;

        /** Constructs a new ArrayEnumeration for specified array */
        public ArrayEnumeration (Object[] array) {
            this.array = array;
        }

        /** Tests if this enumeration contains more elements.
        * @return  true if this enumeration contains more elements;
        *          false otherwise.
        */
        public boolean hasMoreElements() {
            return (index < array.length);
        }

        /** Returns the next element of this enumeration.
        * @return     the next element of this enumeration.
        * @exception  NoSuchElementException  if no more elements exist.
        */
        public Object nextElement() {
            try {
                return array[index++];
            } catch (ArrayIndexOutOfBoundsException e) {
                throw new NoSuchElementException();
            }
        }
    }
    
    private static final class AAEnum implements Enumeration {
        /** The array */
        private Enumeration[] array;
        /** Current index in the array */
        private int index = 0;

        /** Constructs a new ArrayEnumeration for specified array */
        public AAEnum (Enumeration[] array) {
            this.array = array;
        }

        /** Tests if this enumeration contains more elements.
        * @return  true if this enumeration contains more elements;
        *          false otherwise.
        */
        public boolean hasMoreElements() {
            for (;;) {
                if (index == array.length) {
                    return false;
                }

                if (array[index].hasMoreElements ()) {
                    return true;
                }
                
                index++;
            }
        }

        /** Returns the next element of this enumeration.
        * @return     the next element of this enumeration.
        * @exception  NoSuchElementException  if no more elements exist.
        */
        public Object nextElement() {
            try {
                return array[index].nextElement ();
            } catch (NoSuchElementException ex) {
                if (hasMoreElements ()) {
                    // try once more
                    return nextElement ();
                }
                throw ex;
            } catch (ArrayIndexOutOfBoundsException e) {
                throw new NoSuchElementException();
            }
        }
    }
    
}