costin 00/12/04 13:11:56
Added: src/share/org/apache/tomcat/modules/config
RelativePathFix.java
Log:
Added a new module, based on refactoring part of DefaultCMSetter.
This module will "fix" any relative path used in tomcat's configs,
using the same rules as before. The main difference is that all the "fixing" is
grouped in a single replaceable module - that should make the code
easier to read and fix.
The module will replace DefaultCMSetter after some more testing. It needs more
documentation of the rules ( based on what we think is the right way to
do that, not what happened to happen before )
Revision Changes Path
1.1
jakarta-tomcat/src/share/org/apache/tomcat/modules/config/RelativePathFix.java
Index: RelativePathFix.java
===================================================================
/*
* ====================================================================
*
* 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 [EMAIL PROTECTED]
*
* 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.tomcat.modules.config;
import org.apache.tomcat.core.*;
import org.apache.tomcat.request.*;
import org.apache.tomcat.util.*;
import java.io.*;
import java.net.*;
import java.util.*;
import java.security.*;
import org.apache.tomcat.util.log.*;
// based on DefaultCMSetter
/**
* Fix all paths in ContextManager and loaded Contexts. That includes:
* - ContextManager: home, installDir, loggers
* - Context: base dir, loggers
*
* If a path is absolute, do nothing.
* If a path is relative, make it absolute based on a set of rules:
* - the Context absolute path is based on CM.home
* -
*
* @author [EMAIL PROTECTED]
*/
public final class RelativePathFix extends BaseInterceptor {
public RelativePathFix() {
}
/** Adjust context manager paths
*/
public void engineInit( ContextManager cm )
throws TomcatException
{
initHome(cm);
initWorkDir(cm);
initLoggers(cm);
}
/** Adjust paths
*/
public void addContext( ContextManager cm, Context ctx)
throws TomcatException
{
initAbsolutePath( ctx );
initContextLoggers( ctx );
}
// -------------------- Implementation --------------------
private void initAbsolutePath( Context ctx ) {
String docBase=ctx.getDocBase();
String absPath=ctx.getAbsolutePath();
// if docBase ( user setting ) is absolute, use it
// Else, use it relative to cm.home
if( absPath==null ) {
if (FileUtil.isAbsolute( docBase ) )
absPath=docBase;
else
absPath = cm.getHome() + File.separator + docBase;
absPath = FileUtil.getCanonicalPath( absPath );
ctx.setAbsolutePath( absPath );
}
if( debug > 0 ) {
String h=ctx.getHost();
log( ((h==null) ? "":h) + ":" + ctx.getPath() + " " +
docBase + " " + absPath + " " +cm.getHome());
}
}
private void initContextLoggers( Context ctx ) {
// this would belong to a logger interceptor ?
Log loghelper=ctx.getLog();
Log loghelperServlet=ctx.getServletLog();
if( loghelper!=null && loghelper.getLogger() != null )
cm.addLogger( loghelper.getLogger() );
if( loghelperServlet != null &&
loghelperServlet.getLogger() != null)
cm.addLogger( loghelperServlet.getLogger() );
}
private void initHome( ContextManager cm ) {
String home=cm.getHome();
String installDir=cm.getInstallDir();
if( home==null ) {
home=System.getProperty(ContextManager.TOMCAT_HOME);
}
// Make it absolute
if( home!= null ) {
home=FileUtil.getCanonicalPath( home );
cm.setHome( home );
log( "Setting server home to " + home );
}
if( installDir!= null ) {
installDir=FileUtil.getCanonicalPath( installDir );
cm.setInstallDir( installDir );
log( "Setting server install dir to " + installDir );
}
// if only one is set home==installDir
if( home!=null && installDir == null )
cm.setInstallDir( home );
if( home==null && installDir != null )
cm.setHome( installDir );
// if neither home or install is set,
// and no system property, try "."
if( home==null && installDir==null ) {
home=FileUtil.getCanonicalPath( "." );
installDir=home;
cm.setHome( home );
cm.setInstallDir( home );
}
}
private void initWorkDir(ContextManager cm) {
String workDir=cm.getWorkDir();
if( workDir==null ) {
return; // let workdir interceptor set it
}
if( ! FileUtil.isAbsolute( workDir )) {
workDir=FileUtil.
getCanonicalPath(cm.getHome() + File.separator+
workDir);
}
cm.setWorkDir( workDir );
}
private void initLoggers(ContextManager cm){
Hashtable loggers=cm.getLoggers();
if( loggers!=null ){
Enumeration el=loggers.elements();
while( el.hasMoreElements()){
Logger l=(Logger)el.nextElement();
String path=l.getPath();
if( path!=null ) {
File f=new File( path );
if( ! f.isAbsolute() ) {
File wd= new File(cm.getHome(), f.getPath());
l.setPath( wd.getAbsolutePath() );
}
// create the files, ready to log.
}
l.open();
}
}
}
}
