/*
* $Header: /home/cvs/jakarta-tomcat-4.0/catalina/src/share/org/apache/catalina/core/StandardHostDeployer.java,v 1.14 2004/01/06 22:32:07 markt Exp $
* $Revision: 1.14 $
* $Date: 2004/01/06 22:32:07 $
*
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 1999 The Apache Software Foundation. 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.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED 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 THE APACHE SOFTWARE FOUNDATION OR
* ITS 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.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
* [Additional notices, if required by prior licensing conditions]
*
*/
package org.apache.catalina.core;
import java.io.File;
import java.io.InputStream;
import java.io.IOException;
import java.net.URL;
import org.apache.catalina.Container;
import org.apache.catalina.Context;
import org.apache.catalina.Deployer;
import org.apache.catalina.Globals;
import org.apache.catalina.Lifecycle;
import org.apache.catalina.LifecycleException;
import org.apache.catalina.LifecycleListener;
import org.apache.catalina.core.StandardContext;
import org.apache.catalina.startup.ContextRuleSet;
import org.apache.catalina.startup.ExpandWar;
import org.apache.catalina.startup.NamingRuleSet;
import org.apache.catalina.util.StringManager;
import org.apache.commons.digester.Digester;
/**
* <p>Implementation of <b>Deployer</b> that is delegated to by the
* <code>StandardHost</code> implementation class.</p>
*
* @author Craig R. McClanahan
* @version $Revision: 1.14 $ $Date: 2004/01/06 22:32:07 $
*/
public class StandardHostDeployer implements Deployer {
// ----------------------------------------------------------- Constructors
/**
* Create a new StandardHostDeployer associated with the specified
* StandardHost.
*
* @param host The StandardHost we are associated with
*/
public StandardHostDeployer(StandardHost host) {
super();
this.host = host;
}
// ----------------------------------------------------- Instance Variables
/**
* The <code>Context</code> that was added via a call to
* <code>addChild()</code> while parsing the configuration descriptor.
*/
private Context context = null;
/**
* The <code>Digester</code> instance to use for deploying web applications
* to this <code>Host</code>. <strong>WARNING</strong> - Usage of this
* instance must be appropriately synchronized to prevent simultaneous
* access by multiple threads.
*/
private Digester digester = null;
/**
* The <code>ContextRuleSet</code> associated with our
* <code>digester</code> instance.
*/
private ContextRuleSet contextRuleSet = null;
/**
* The <code>StandardHost</code> instance we are associated with.
*/
protected StandardHost host = null;
/**
* The <code>NamingRuleSet</code> associated with our
* <code>digester</code> instance.
*/
private NamingRuleSet namingRuleSet = null;
/**
* The document base which should replace the value specified in the
* <code>Context</code> being added in the <code>addChild()</code> method,
* or <code>null</code> if the original value should remain untouched.
*/
private String overrideDocBase = null;
/**
* The string manager for this package.
*/
protected static StringManager sm =
StringManager.getManager(Constants.Package);
// -------------------------------------------------------- Depoyer Methods
/**
* Return the name of the Container with which this Deployer is associated.
*/
public String getName() {
return (host.getName());
}
/**
* Install a new web application, whose web application archive is at the
* specified URL, into this container with the specified context path.
* A context path of "" (the empty string) should be used for the root
* application for this container. Otherwise, the context path must
* start with a slash.
* <p>
* If this application is successfully installed, a ContainerEvent of type
* <code>PRE_INSTALL_EVENT</code> will be sent to registered listeners
* before the associated Context is started, and a ContainerEvent of type
* <code>INSTALL_EVENT</code> will be sent to all registered listeners
* after the associated Context is started, with the newly created
* <code>Context</code> as an argument.
*
* @param contextPath The context path to which this application should
* be installed (must be unique)
* @param war A URL of type "jar:" that points to a WAR file, or type
* "file:" that points to an unpacked directory structure containing
* the web application to be installed
*
* @exception IllegalArgumentException if the specified context path
* is malformed (it must be "" or start with a slash)
* @exception IllegalStateException if the specified context path
* is already attached to an existing web application
* @exception IOException if an input/output error was encountered
* during installation
*/
public synchronized void install(String contextPath, URL war)
throws IOException {
// Validate the format and state of our arguments
if (contextPath == null)
throw new IllegalArgumentException
(sm.getString("standardHost.pathRequired"));
if (!contextPath.equals("") && !contextPath.startsWith("/"))
throw new IllegalArgumentException
(sm.getString("standardHost.pathFormat", contextPath));
if (findDeployedApp(contextPath) != null)
throw new IllegalStateException
(sm.getString("standardHost.pathUsed", contextPath));
if (war == null)
throw new IllegalArgumentException
(sm.getString("standardHost.warRequired"));
// Calculate the document base for the new web application
host.log(sm.getString("standardHost.installing",
contextPath, war.toString()));
String url = war.toString();
String docBase = null;
boolean isWAR = false;
if (url.startsWith("jar:")) {
url = url.substring(4, url.length() - 2);
if (!url.toLowerCase().endsWith(".war")) {
throw new IllegalArgumentException
(sm.getString("standardHost.warURL", url));
}
isWAR = true;
}
if (url.startsWith("file://"))
docBase = url.substring(7);
else if (url.startsWith("file:"))
docBase = url.substring(5);
else
throw new IllegalArgumentException
(sm.getString("standardHost.warURL", url));
// Determine if directory/war to install is in the host appBase
boolean isAppBase = false;
File appBase = new File(host.getAppBase());
if (!appBase.isAbsolute())
appBase = new File(System.getProperty("catalina.base"),
host.getAppBase());
File contextFile = new File(docBase);
File baseDir = contextFile.getParentFile();
if (appBase.getCanonicalPath().equals(baseDir.getCanonicalPath())) {
isAppBase = true;
}
// For security, if deployXML is false only allow directories
// and war files from the hosts appBase
if (!host.isDeployXML() && !isAppBase) {
throw new IllegalArgumentException
(sm.getString("standardHost.installBase", url));
}
// Make sure contextPath and directory/war names match when
// installing from the host appBase
if (isAppBase && (host.getAutoDeploy() || host.getLiveDeploy())) {
String filename = contextFile.getName();
if (isWAR) {
filename = filename.substring(0,filename.length()-4);
}
if (contextPath.length() == 0) {
if (!filename.equals("ROOT")) {
throw new IllegalArgumentException
(sm.getString("standardHost.pathMatch", "/", "ROOT"));
}
} else if (!filename.equals(contextPath.substring(1))) {
throw new IllegalArgumentException
(sm.getString("standardHost.pathMatch", contextPath, filename));
}
}
// Expand war file if host wants wars unpacked
if (isWAR && host.isUnpackWARs()) {
if (contextPath.equals("")) {
docBase = ExpandWar.expand(host,war,"/ROOT");
} else {
docBase = ExpandWar.expand(host,war,contextPath);
}
}
// Install the new web application
try {
Class clazz = Class.forName(host.getContextClass());
Context context = (Context) clazz.newInstance();
context.setPath(contextPath);
context.setDocBase(docBase);
if (context instanceof Lifecycle) {
clazz = Class.forName(host.getConfigClass());
LifecycleListener listener =
(LifecycleListener) clazz.newInstance();
((Lifecycle) context).addLifecycleListener(listener);
}
host.fireContainerEvent(PRE_INSTALL_EVENT, context);
host.addChild(context);
host.fireContainerEvent(INSTALL_EVENT, context);
} catch (Exception e) {
host.log(sm.getString("standardHost.installError", contextPath),
e);
throw new IOException(e.toString());
}
}
/**
* <p>Install a new web application, whose context configuration file
* (consisting of a <code><Context></code> element) and (optional)
* web application archive are at the specified URLs.</p>
*
* If this application is successfully installed, a ContainerEvent of type
* <code>PRE_INSTALL_EVENT</code> will be sent to registered listeners
* before the associated Context is started, and a ContainerEvent of type
* <code>INSTALL_EVENT</code> will be sent to all registered listeners
* after the associated Context is started, with the newly created
* <code>Context</code> as an argument.
*
* @param config A URL that points to the context configuration descriptor
* to be used for configuring the new Context
* @param war A URL of type "jar:" that points to a WAR file, or type
* "file:" that points to an unpacked directory structure containing
* the web application to be installed, or <code>null</code> to use
* the <code>docBase</code> attribute from the configuration descriptor
*
* @exception IllegalArgumentException if one of the specified URLs is
* null
* @exception IllegalStateException if the context path specified in the
* context configuration file is already attached to an existing web
* application
* @exception IOException if an input/output error was encountered
* during installation
*/
public synchronized void install(URL config, URL war) throws IOException {
// Validate the format and state of our arguments
if (config == null)
throw new IllegalArgumentException
(sm.getString("standardHost.configRequired"));
if (!host.isDeployXML())
throw new IllegalArgumentException
(sm.getString("standardHost.configNotAllowed"));
// Calculate the document base for the new web application (if needed)
String docBase = null; // Optional override for value in config file
if (war != null) {
String url = war.toString();
host.log(sm.getString("standardHost.installingWAR", url));
// Calculate the WAR file absolute pathname
if (url.startsWith("jar:")) {
url = url.substring(4, url.length() - 2);
}
if (url.startsWith("file://"))
docBase = url.substring(7);
else if (url.startsWith("file:"))
docBase = url.substring(5);
else
throw new IllegalArgumentException
(sm.getString("standardHost.warURL", url));
}
// Install the new web application
this.context = null;
this.overrideDocBase = docBase;
InputStream stream = null;
try {
stream = config.openStream();
Digester digester = createDigester();
digester.setDebug(host.getDebug());
digester.clear();
digester.push(this);
digester.parse(stream);
stream.close();
stream = null;
} catch (Exception e) {
host.log
(sm.getString("standardHost.installError", docBase), e);
throw new IOException(e.toString());
} finally {
if (stream != null) {
try {
stream.close();
} catch (Throwable t) {
;
}
}
}
}
/**
* Return the Context for the deployed application that is associated
* with the specified context path (if any); otherwise return
* <code>null</code>.
*
* @param contextPath The context path of the requested web application
*/
public Context findDeployedApp(String contextPath) {
return ((Context) host.findChild(contextPath));
}
/**
* Return the context paths of all deployed web applications in this
* Container. If there are no deployed applications, a zero-length
* array is returned.
*/
public String[] findDeployedApps() {
Container children[] = host.findChildren();
String results[] = new String[children.length];
for (int i = 0; i < children.length; i++)
results[i] = children[i].getName();
return (results);
}
/**
* Remove an existing web application, attached to the specified context
* path. If this application is successfully removed, a
* ContainerEvent of type <code>REMOVE_EVENT</code> will be sent to all
* registered listeners, with the removed <code>Context</code> as
* an argument.
*
* @param contextPath The context path of the application to be removed
*
* @exception IllegalArgumentException if the specified context path
* is malformed (it must be "" or start with a slash)
* @exception IllegalArgumentException if the specified context path does
* not identify a currently installed web application
* @exception IOException if an input/output error occurs during
* removal
*/
public void remove(String contextPath) throws IOException {
// Validate the format and state of our arguments
if (contextPath == null)
throw new IllegalArgumentException
(sm.getString("standardHost.pathRequired"));
if (!contextPath.equals("") && !contextPath.startsWith("/"))
throw new IllegalArgumentException
(sm.getString("standardHost.pathFormat", contextPath));
// Locate the context and associated work directory
Context context = findDeployedApp(contextPath);
if (context == null)
throw new IllegalArgumentException
(sm.getString("standardHost.pathMissing", contextPath));
// Remove this web application
host.log(sm.getString("standardHost.removing", contextPath));
try {
host.removeChild(context);
host.fireContainerEvent(REMOVE_EVENT, context);
} catch (Exception e) {
host.log(sm.getString("standardHost.removeError", contextPath), e);
throw new IOException(e.toString());
}
}
/**
* Remove an existing web application, attached to the specified context
* path. If this application is successfully removed, a
* ContainerEvent of type <code>REMOVE_EVENT</code> will be sent to all
* registered listeners, with the removed <code>Context</code> as
* an argument. Deletes the web application war file and/or directory
* if they exist in the Host's appBase.
*
* @param contextPath The context path of the application to be removed
* @param undeploy boolean flag to remove web application from server
*
* @exception IllegalArgumentException if the specified context path
* is malformed (it must be "" or start with a slash)
* @exception IllegalArgumentException if the specified context path does
* not identify a currently installed web application
* @exception IOException if an input/output error occurs during
* removal
*/
public void remove(String contextPath, boolean undeploy) throws IOException {
// Validate the format and state of our arguments
if (contextPath == null)
throw new IllegalArgumentException
(sm.getString("standardHost.pathRequired"));
if (!contextPath.equals("") && !contextPath.startsWith("/"))
throw new IllegalArgumentException
(sm.getString("standardHost.pathFormat", contextPath));
// Locate the context and associated work directory
Context context = findDeployedApp(contextPath);
if (context == null)
throw new IllegalArgumentException
(sm.getString("standardHost.pathMissing", contextPath));
// Remove this web application
host.log(sm.getString("standardHost.removing", contextPath));
try {
// Get the work directory for the Context
File workDir = (File)
context.getServletContext().getAttribute(Globals.WORK_DIR_ATTR);
host.removeChild(context);
if (undeploy) {
// Remove the web application directory and/or war file if it
// exists in the Host's appBase directory.
// Determine if directory/war to remove is in the host appBase
boolean isAppBase = false;
File appBase = new File(host.getAppBase());
if (!appBase.isAbsolute())
appBase = new File(System.getProperty("catalina.base"),
host.getAppBase());
File contextFile = new File(context.getDocBase());
File baseDir = contextFile.getParentFile();
if (appBase.getCanonicalPath().equals(baseDir.getCanonicalPath())) {
isAppBase = true;
}
boolean isWAR = false;
if (contextFile.getName().toLowerCase().endsWith(".war")) {
isWAR = true;
}
// Only remove directory and/or war if they are located in the
// Host's appBase and autoDeploy or liveDeploy are true
if (isAppBase && (host.getAutoDeploy() || host.getLiveDeploy())) {
String filename = contextFile.getName();
if (isWAR) {
filename = filename.substring(0,filename.length()-4);
}
if (contextPath.length() == 0 && filename.equals("ROOT") ||
filename.equals(contextPath.substring(1))) {
if (!isWAR) {
if (contextFile.isDirectory()) {
deleteDir(contextFile);
}
if (host.isUnpackWARs()) {
File contextWAR = new File(context.getDocBase() + ".war");
if (contextWAR.exists()) {
contextWAR.delete();
}
}
} else {
contextFile.delete();
}
}
if (host.isDeployXML()) {
File docBaseXml = new File(appBase,filename + ".xml");
docBaseXml.delete();
}
}
// Remove the work directory for the Context
if (workDir == null &&
context instanceof StandardContext &&
((StandardContext)context).getWorkDir() != null) {
workDir = new File(((StandardContext)context).getWorkDir());
if (!workDir.isAbsolute()) {
File catalinaHome = new File(System.getProperty("catalina.base"));
String catalinaHomePath = null;
try {
catalinaHomePath = catalinaHome.getCanonicalPath();
workDir = new File(catalinaHomePath,
((StandardContext)context).getWorkDir());
} catch (IOException e) {
}
}
}
if (workDir != null && workDir.exists()) {
deleteDir(workDir);
}
}
host.fireContainerEvent(REMOVE_EVENT, context);
} catch (Exception e) {
host.log(sm.getString("standardHost.removeError", contextPath), e);
throw new IOException(e.toString());
}
}
/**
* Start an existing web application, attached to the specified context
* path. Only starts a web application if it is not running.
*
* @param contextPath The context path of the application to be started
*
* @exception IllegalArgumentException if the specified context path
* is malformed (it must be "" or start with a slash)
* @exception IllegalArgumentException if the specified context path does
* not identify a currently installed web application
* @exception IOException if an input/output error occurs during
* startup
*/
public void start(String contextPath) throws IOException {
// Validate the format and state of our arguments
if (contextPath == null)
throw new IllegalArgumentException
(sm.getString("standardHost.pathRequired"));
if (!contextPath.equals("") && !contextPath.startsWith("/"))
throw new IllegalArgumentException
(sm.getString("standardHost.pathFormat", contextPath));
Context context = findDeployedApp(contextPath);
if (context == null)
throw new IllegalArgumentException
(sm.getString("standardHost.pathMissing", contextPath));
host.log("standardHost.start " + contextPath);
try {
((Lifecycle) context).start();
} catch (LifecycleException e) {
host.log("standardHost.start " + contextPath + ": ", e);
throw new IllegalStateException
("standardHost.start " + contextPath + ": " + e);
}
}
/**
* Stop an existing web application, attached to the specified context
* path. Only stops a web application if it is running.
*
* @param contextPath The context path of the application to be stopped
*
* @exception IllegalArgumentException if the specified context path
* is malformed (it must be "" or start with a slash)
* @exception IllegalArgumentException if the specified context path does
* not identify a currently installed web application
* @exception IOException if an input/output error occurs while stopping
* the web application
*/
public void stop(String contextPath) throws IOException {
// Validate the format and state of our arguments
if (contextPath == null)
throw new IllegalArgumentException
(sm.getString("standardHost.pathRequired"));
if (!contextPath.equals("") && !contextPath.startsWith("/"))
throw new IllegalArgumentException
(sm.getString("standardHost.pathFormat", contextPath));
Context context = findDeployedApp(contextPath);
if (context == null)
throw new IllegalArgumentException
(sm.getString("standardHost.pathMissing", contextPath));
host.log("standardHost.stop " + contextPath);
try {
((Lifecycle) context).stop();
} catch (LifecycleException e) {
host.log("standardHost.stop " + contextPath + ": ", e);
throw new IllegalStateException
("standardHost.stop " + contextPath + ": " + e);
}
}
// ------------------------------------------------------ Delegated Methods
/**
* Delegate a request to add a child Context to our associated Host.
*
* @param child The child Context to be added
*/
public void addChild(Container child) {
context = (Context) child;
String contextPath = context.getPath();
if (contextPath == null)
throw new IllegalArgumentException
(sm.getString("standardHost.pathRequired"));
else if (!contextPath.equals("") && !contextPath.startsWith("/"))
throw new IllegalArgumentException
(sm.getString("standardHost.pathFormat", contextPath));
if (host.findChild(contextPath) != null)
throw new IllegalStateException
(sm.getString("standardHost.pathUsed", contextPath));
if (this.overrideDocBase != null)
context.setDocBase(this.overrideDocBase);
host.fireContainerEvent(PRE_INSTALL_EVENT, context);
host.addChild(child);
host.fireContainerEvent(INSTALL_EVENT, context);
}
/**
* Delegate a request for the parent class loader to our associated Host.
*/
public ClassLoader getParentClassLoader() {
return (host.getParentClassLoader());
}
// ------------------------------------------------------ Protected Methods
/**
* Create (if necessary) and return a Digester configured to process the
* context configuration descriptor for an application.
*/
protected Digester createDigester() {
if (digester == null) {
digester = new Digester();
if (host.getDebug() > 0)
digester.setDebug(3);
digester.setValidating(false);
contextRuleSet = new ContextRuleSet("");
digester.addRuleSet(contextRuleSet);
namingRuleSet = new NamingRuleSet("Context/");
digester.addRuleSet(namingRuleSet);
}
return (digester);
}
/**
* Delete the specified directory, including all of its contents and
* subdirectories recursively.
*
* @param dir File object representing the directory to be deleted
*/
protected void deleteDir(File dir) {
String files[] = dir.list();
if (files == null) {
files = new String[0];
}
for (int i = 0; i < files.length; i++) {
File file = new File(dir, files[i]);
if (file.isDirectory()) {
deleteDir(file);
} else {
file.delete();
}
}
dir.delete();
}
}