/*
* JBoss, Home of Professional Open Source
* Copyright 2006, JBoss Inc., and individual contributors as indicated
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.virtual;
import java.io.IOException;
import java.net.URISyntaxException;
import java.net.URL;
import java.util.List;
import java.util.regex.Pattern;
import org.jboss.virtual.plugins.context.jar.JarUtils;
import org.jboss.virtual.plugins.context.vfs.AssembledContextFactory;
import org.jboss.virtual.plugins.context.vfs.AssembledDirectoryHandler;
import org.jboss.virtual.plugins.context.vfs.AssembledFileHandler;
import org.jboss.virtual.plugins.context.vfs.ByteArrayHandler;
import org.jboss.virtual.plugins.vfs.helpers.FilterVirtualFileVisitor;
import org.jboss.virtual.plugins.vfs.helpers.PathTokenizer;
import org.jboss.virtual.plugins.vfs.helpers.SuffixesExcludeFilter;
/**
* Extension of VirtualFile that represents a virtual directory that can be composed of arbitrary files and resources
* spread throughout the file system or embedded in jar files.
*
* @author <a href="bill@jboss.com">Bill Burke</a>
* @author <a href="ales.justin@jboss.com">Ales Justin</a>
* @version $Revision: 1.1 $
*/
public class AssembledDirectory extends VirtualFile
{
private static final long serialVersionUID = 1L;
/** No jars file filter */
private static final VirtualFileFilter noJars = new SuffixesExcludeFilter(JarUtils.getSuffixes());
/** The directory */
private AssembledDirectoryHandler directory;
public AssembledDirectory(AssembledDirectoryHandler handler)
{
super(handler);
directory = handler;
}
/**
* Create assembled directory.
*
* @param name context's name
* @param rootName root name
* @return new assembled directory instance
* @throws IOException for any IO error
* @throws URISyntaxException for any URI error
*/
public static AssembledDirectory createAssembledDirectory(String name, String rootName) throws IOException, URISyntaxException
{
return AssembledContextFactory.getInstance().create(name, rootName);
}
/**
* Remove assembled directory.
*
* @param directory the directory to remove
*/
public static void removeAssembledDirectory(AssembledDirectory directory)
{
try
{
if (directory.getParent() != null)
throw new RuntimeException("This is not the root of assembly");
}
catch (IOException e)
{
throw new RuntimeException(e);
}
removeDirectory(directory);
}
/**
* Remove directory, w/o check.
*
* @param directory the directory to remove
*/
protected static void removeDirectory(AssembledDirectory directory)
{
String name = directory.directory.getVFSContext().getName();
AssembledContextFactory.getInstance().remove(name);
}
@Override
public void cleanup()
{
try
{
if (getParent() == null)
removeDirectory(this);
}
catch (Exception ignored)
{
}
finally
{
super.cleanup();
}
}
/**
* Add files recursively from root, using the no jars filter.
*
* @param root the root
* @throws IOException for any error
*/
public void addPath(VirtualFile root) throws IOException
{
addPath(root, noJars);
}
/**
* Add files recursively from root, using the filter.
*
* @param root the root
* @param recurseFilter the recurse filter
* @throws IOException for any error
*/
public void addPath(VirtualFile root, VirtualFileFilter recurseFilter) throws IOException
{
final VisitorAttributes va = new VisitorAttributes();
va.setLeavesOnly(true);
va.setRecurseFilter(recurseFilter);
VirtualFileVisitor visitor = new VirtualFileVisitor()
{
public VisitorAttributes getAttributes()
{
return va;
}
public void visit(VirtualFile virtualFile)
{
mkdirs(virtualFile.getPathName()).addChild(virtualFile);
}
};
root.visit(visitor);
}
/**
* Find the underlying .class file representing this class and create it within this directory, along with
* its packages.
*
* So, if you added com.acme.Customer class, then a directory structure com/acme would be created
* and an entry in the acme directory would be the .class file.
*
* @param clazz the class
*/
public void addClass(Class<?> clazz)
{
if (clazz == null)
throw new IllegalArgumentException("Null clazz");
addClass(clazz.getName(), clazz.getClassLoader());
}
/**
* Find the underlying .class file representing this class and create it within this directory, along with
* its packages.
*
* So, if you added com.acme.Customer class, then a directory structure com/acme would be created
* and an entry in the acme directory would be the .class file.
*
* @param className the class name
*/
public void addClass(String className)
{
addClass(className, Thread.currentThread().getContextClassLoader());
}
/**
* Find the underlying .class file representing this class and create it within this directory, along with
* its packages.
*
* So, if you added com.acme.Customer class, then a directory structure com/acme would be created
* and an entry in the acme directory would be the .class file.
*
* @param className the class name
* @param loader ClassLoader to look for class resource
*/
public void addClass(String className, ClassLoader loader)
{
if (className == null)
throw new IllegalArgumentException("Null className");
if (loader == null)
throw new IllegalArgumentException("Null loader");
String resource = className.replace('.', '/') + ".class";
URL url = loader.getResource(resource);
if (url == null)
throw new RuntimeException("Could not find resource: " + resource);
AssembledDirectory p = mkdirs(resource);
p.addResource(resource, loader);
}
/**
* Make any directories for the give path to a file.
*
* @param path must be a path to a file as last element in path does not have a directory created
* @return directory file will live in
*/
public AssembledDirectory mkdirs(String path)
{
if (path == null)
throw new IllegalArgumentException("Null path");
List<String> pkgs = PathTokenizer.getTokens(path);
AssembledDirectoryHandler dir = directory;
for (int i = 0; i < pkgs.size() - 1; i++)
{
AssembledDirectoryHandler next = (AssembledDirectoryHandler) dir.findChild(pkgs.get(i));
if (next == null)
{
try
{
next = new AssembledDirectoryHandler(dir.getVFSContext(), dir, pkgs.get(i));
}
catch (IOException e)
{
throw new RuntimeException(e);
}
dir.addChild(next);
}
dir = next;
}
return dir.getVirtualFile();
}
/**
* Locate the .class resource of baseResource. From this resource, determine the base of the resource
* i.e. what jar or classpath directory it lives in.
*
* Once the base of the resource is found, scan all files recursively within the base using the include and exclude
* patterns. A mirror file structure will be created within this AssembledDirectory. Ths is very useful when you
* want to create a virtual jar that contains a subset of .class files in your classpath.
*
* The include/exclude patterns follow the Ant file pattern matching syntax. See ant.apache.org for more details.
*
* @param baseResource the base resource
* @param includes the includes
* @param excludes the excludes
*/
public void addResources(Class<?> baseResource, String[] includes, String[] excludes)
{
if (baseResource == null)
throw new IllegalArgumentException("Null base resource");
String resource = baseResource.getName().replace('.', '/') + ".class";
addResources(resource, includes, excludes, baseResource.getClassLoader());
}
/**
* From the baseResource, determine the base of that resource
* i.e. what jar or classpath directory it lives in. The Thread.currentThread().getContextClassloader() will be used
*
* Once the base of the resource is found, scan all files recursively within the base using the include and exclude
* patterns. A mirror file structure will be created within this AssembledDirectory. Ths is very useful when you
* want to create a virtual jar that contains a subset of .class files in your classpath.
*
* The include/exclude patterns follow the Ant file pattern matching syntax. See ant.apache.org for more details.
*
* @param baseResource the base resource
* @param includes the includes
* @param excludes the excludes
*/
public void addResources(String baseResource, final String[] includes, final String[] excludes)
{
if (baseResource == null)
throw new IllegalArgumentException("Null base resource");
addResources(baseResource, includes, excludes, Thread.currentThread().getContextClassLoader());
}
/**
* From the baseResource, determine the base of that resource
* i.e. what jar or classpath directory it lives in. The loader parameter will be used to find the resource.
*
* Once the base of the resource is found, scan all files recursively within the base using the include and exclude
* patterns. A mirror file structure will be created within this AssembledDirectory. Ths is very useful when you
* want to create a virtual jar that contains a subset of .class files in your classpath.
*
* The include/exclude patterns follow the Ant file pattern matching syntax. See ant.apache.org for more details.
*
* @param baseResource the base resource
* @param includes the includes
* @param excludes the excludes
* @param loader the loader
*/
public void addResources(String baseResource, final String[] includes, final String[] excludes, ClassLoader loader)
{
if (baseResource == null)
throw new IllegalArgumentException("Null baseResource");
if (loader == null)
throw new IllegalArgumentException("Null loader");
URL url = loader.getResource(baseResource);
if (url == null)
throw new RuntimeException("Could not find baseResource: " + baseResource);
String urlString = url.toString();
int idx = urlString.lastIndexOf(baseResource);
urlString = urlString.substring(0, idx);
try
{
url = new URL(urlString);
VirtualFile parent = VFS.getRoot(url);
VisitorAttributes va = new VisitorAttributes();
va.setLeavesOnly(true);
va.setRecurseFilter(noJars);
VirtualFileFilter filter = new VirtualFileFilter()
{
public boolean accepts(VirtualFile file)
{
boolean matched = false;
String path = file.getPathName();
for (String include : includes)
{
if (antMatch(path, include))
{
matched = true;
break;
}
}
if (matched == false)
return false;
if (excludes != null)
{
for (String exclude : excludes)
{
if (antMatch(path, exclude))
return false;
}
}
return true;
}
};
FilterVirtualFileVisitor visitor = new FilterVirtualFileVisitor(filter, va);
parent.visit(visitor);
List<VirtualFile> files = visitor.getMatched();
for (VirtualFile vf : files)
{
mkdirs(vf.getPathName()).addChild(vf);
}
}
catch (IOException e)
{
throw new RuntimeException(e);
}
}
/**
* Create a regular expression pattern from an Ant file matching pattern
*
* @param matcher the matcher pattern
* @return the pattern instance
*/
public static Pattern getPattern(String matcher)
{
if (matcher == null)
throw new IllegalArgumentException("Null matcher");
matcher = matcher.replace(".", "\\.");
matcher = matcher.replace("*", ".*");
matcher = matcher.replace("?", ".{1}");
return Pattern.compile(matcher);
}
/**
* Determine whether a given file path matches an Ant pattern.
*
* @param path the path
* @param expression the expression
* @return true if we match
*/
public static boolean antMatch(String path, String expression)
{
if (path == null)
throw new IllegalArgumentException("Null path");
if (expression == null)
throw new IllegalArgumentException("Null expression");
if (path.startsWith("/")) path = path.substring(1);
if (expression.endsWith("/")) expression += "**";
String[] paths = path.split("/");
String[] expressions = expression.split("/");
int x = 0, p;
Pattern pattern = getPattern(expressions[0]);
for (p = 0; p < paths.length && x < expressions.length; p++)
{
if (expressions[x].equals("**"))
{
do
{
x++;
} while (x < expressions.length && expressions[x].equals("**"));
if (x == expressions.length)
return true; // "**" with nothing after it
pattern = getPattern(expressions[x]);
}
String element = paths[p];
if (pattern.matcher(element).matches())
{
x++;
if (x < expressions.length)
{
pattern = getPattern(expressions[x]);
}
}
else if (!(x > 0 && expressions[x - 1].equals("**"))) // our previous isn't "**"
{
return false;
}
}
return p >= paths.length && x >= expressions.length;
}
/**
* Add a VirtualFile as a child to this AssembledDirectory.
*
* @param vf the virtual file
* @return the file
*/
public VirtualFile addChild(VirtualFile vf)
{
if (vf == null)
throw new IllegalArgumentException("Null virtual file");
return directory.addChild(vf.getHandler()).getVirtualFile();
}
/**
* Add a VirtualFile as a child to this AssembledDirectory. This file will be added
* under a new aliased name.
*
* @param vf the virtual file
* @param newName the new name
* @return new file
*/
public VirtualFile addChild(VirtualFile vf, String newName)
{
try
{
AssembledFileHandler handler = new AssembledFileHandler(directory.getVFSContext(), directory, newName, vf.getHandler());
directory.addChild(handler);
return handler.getVirtualFile();
}
catch (IOException e)
{
throw new RuntimeException(e);
}
}
/**
* Add a classloader found resource to as a child to this AssembledDirectory. The base file name of the
* resource will be used as the child's name.
*
* Thread.currentThread.getCOntextClassLoader() will be used to load the resource.
*
* @param resource the resource
* @return the file
*/
public VirtualFile addResource(String resource)
{
return addResource(resource, Thread.currentThread().getContextClassLoader());
}
/**
* Add a classloader found resource to as a child to this AssembledDirectory. The newName parameter will be used
* as the name of the child.
*
* Thread.currentThread.getCOntextClassLoader() will be used to load the resource.
*
* @param resource the resource
* @param newName the new name
* @return the file
*/
public VirtualFile addResource(String resource, String newName)
{
return addResource(resource, Thread.currentThread().getContextClassLoader(), newName);
}
/**
* Add a classloader found resource to as a child to this AssembledDirectory. The base file name of the
* resource will be used as the child's name.
*
* The loader parameter will be used to load the resource.
*
* @param resource the resource
* @param loader the loader
* @return the file
*/
public VirtualFile addResource(String resource, ClassLoader loader)
{
if (resource == null)
throw new IllegalArgumentException("Null resource");
if (loader == null)
throw new IllegalArgumentException("Null loader");
URL url = loader.getResource(resource);
if (url == null)
throw new RuntimeException("Could not find resource: " + resource);
return addResource(url);
}
/**
* Add a resource identified by the URL as a child to this AssembledDirectory.
*
* @param url the url
* @return the file
*/
public VirtualFile addResource(URL url)
{
if (url == null)
throw new IllegalArgumentException("Null url");
try
{
VirtualFile vf = VFS.getRoot(url);
return addChild(vf);
}
catch (IOException e)
{
throw new RuntimeException(e);
}
}
/**
* Add a classloader found resource to as a child to this AssembledDirectory. The newName parameter will be used
* as the name of the child.
*
* The loader parameter will be used to load the resource.
*
* @param resource the resource
* @param loader the loader
* @param newName the new name
* @return the file
*/
public VirtualFile addResource(String resource, ClassLoader loader, String newName)
{
if (resource == null)
throw new IllegalArgumentException("Null resource");
if (loader == null)
throw new IllegalArgumentException("Null loader");
if (newName == null)
throw new IllegalArgumentException("Null newName");
URL url = loader.getResource(resource);
if (url == null)
throw new RuntimeException("Could not find resource: " + resource);
try
{
VirtualFile vf = VFS.getRoot(url);
return addChild(vf, newName);
}
catch (IOException e)
{
throw new RuntimeException(e);
}
}
/**
* Add raw bytes as a file to this assembled directory
*
* @param bytes the bytes
* @param name the name
* @return the file
*/
public VirtualFile addBytes(byte[] bytes, String name)
{
if (bytes == null)
throw new IllegalArgumentException("Null bytes");
if (name == null)
throw new IllegalArgumentException("Null name");
ByteArrayHandler handler;
try
{
handler = new ByteArrayHandler(directory.getVFSContext(), directory, name, bytes);
}
catch (IOException e)
{
throw new RuntimeException(e);
}
directory.addChild(handler);
return handler.getVirtualFile();
}
/**
* Create a directory within this directory.
*
* @param name the name
* @return the directory
*/
public AssembledDirectory mkdir(String name)
{
if (name == null)
throw new IllegalArgumentException("Null name");
try
{
AssembledDirectoryHandler handler = new AssembledDirectoryHandler(directory.getVFSContext(), directory, name);
directory.addChild(handler);
return new AssembledDirectory(handler);
}
catch (IOException e)
{
throw new RuntimeException(e);
}
}
/**
* Remove path.
*
* @param path the path to remove
*/
public void remove(String path)
{
directory.removeChild(path);
}
/**
* Clear directory.
*/
public void clear()
{
directory.cleanup();
}
@Override
public boolean equals(Object obj)
{
return (obj instanceof AssembledDirectory) && super.equals(obj);
}
}