/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.catalina.storeconfig;
import java.io.File;
import java.io.IOException;
import java.io.PrintWriter;
import org.apache.catalina.Container;
import org.apache.catalina.Globals;
import org.apache.catalina.core.StandardContext;
import org.apache.catalina.core.StandardHost;
/**
* store StandardContext Attributes ...
*/
public class StoreContextAppender extends StoreAppender {
/**
* {@inheritDoc} Adds special handling for <code>docBase</code>.
*/
@Override
protected void printAttribute(PrintWriter writer, int indent, Object bean, StoreDescription desc,
String attributeName, Object bean2, Object value) {
if (isPrintValue(bean, bean2, attributeName, desc)) {
if (attributeName.equals("docBase")) {
if (bean instanceof StandardContext) {
String docBase = ((StandardContext) bean).getOriginalDocBase();
if (docBase != null) {
value = docBase;
}
}
}
printValue(writer, indent, attributeName, value);
}
}
/**
* Print Context Values.
* <ul>
* <li>Special handling to default workDir.</li>
* <li>Don't save path at external context.xml</li>
* <li>Don't generate docBase for host.appBase webapps
* <LI>
* </ul>
* {@inheritDoc}
*/
@Override
public boolean isPrintValue(Object bean, Object bean2, String attrName, StoreDescription desc) {
boolean isPrint = super.isPrintValue(bean, bean2, attrName, desc);
if (isPrint) {
StandardContext context = ((StandardContext) bean);
if ("workDir".equals(attrName)) {
String defaultWorkDir = getDefaultWorkDir(context);
if (defaultWorkDir != null) {
isPrint = !defaultWorkDir.equals(context.getWorkDir());
}
} else if ("path".equals(attrName)) {
isPrint = desc.isStoreSeparate() && desc.isExternalAllowed() && context.getConfigFile() == null;
} else if ("docBase".equals(attrName)) {
Container host = context.getParent();
if (host instanceof StandardHost) {
File appBase = getAppBase(((StandardHost) host));
File docBase = getDocBase(context, appBase);
isPrint = !appBase.equals(docBase.getParentFile());
}
}
}
return isPrint;
}
protected File getAppBase(StandardHost host) {
File appBase;
File file = new File(host.getAppBase());
if (!file.isAbsolute()) {
file = new File(System.getProperty(Globals.CATALINA_BASE_PROP), host.getAppBase());
}
try {
appBase = file.getCanonicalFile();
} catch (IOException ioe) {
appBase = file;
}
return appBase;
}
protected File getDocBase(StandardContext context, File appBase) {
File docBase;
String contextDocBase = context.getOriginalDocBase();
if (contextDocBase == null) {
contextDocBase = context.getDocBase();
}
File file = new File(contextDocBase);
if (!file.isAbsolute()) {
file = new File(appBase, contextDocBase);
}
try {
docBase = file.getCanonicalFile();
} catch (IOException ioe) {
docBase = file;
}
return docBase;
}
/**
* Make default Work Dir.
*
* @param context The context
*
* @return The default working directory for the context.
*/
protected String getDefaultWorkDir(StandardContext context) {
String defaultWorkDir = null;
String contextWorkDir = context.getName();
if (contextWorkDir.isEmpty()) {
contextWorkDir = "_";
}
if (contextWorkDir.startsWith("/")) {
contextWorkDir = contextWorkDir.substring(1);
}
Container host = context.getParent();
if (host instanceof StandardHost) {
String hostWorkDir = ((StandardHost) host).getWorkDir();
if (hostWorkDir != null) {
defaultWorkDir = hostWorkDir + File.separator + contextWorkDir;
} else {
String engineName = context.getParent().getParent().getName();
String hostName = context.getParent().getName();
defaultWorkDir = "work" + File.separator + engineName + File.separator + hostName + File.separator +
contextWorkDir;
}
}
return defaultWorkDir;
}
/**
* Generate a real default StandardContext
* <p>
* TODO read and interpret the default context.xml and context.xml.default
* <p>
* TODO Cache a Default StandardContext ( with reloading strategy)
* <p>
* TODO remove really all elements, but detection is hard... To Listener or Valve from same class?
*
* @see org.apache.catalina.storeconfig.StoreAppender#defaultInstance(java.lang.Object)
*/
@Override
public Object defaultInstance(Object bean) throws ReflectiveOperationException {
if (bean instanceof StandardContext) {
// @formatter:off
/*
* if (!((StandardContext) bean).getOverride()) {
* defaultContext.setParent(((StandardContext)bean).getParent());
* ContextConfig contextConfig = new ContextConfig();
* defaultContext.addLifecycleListener(contextConfig);
* contextConfig.setContext(defaultContext);
* contextConfig.processContextConfig(new File(contextConfig.getBaseDir(), "conf/context.xml"));
* contextConfig.processContextConfig(new File(contextConfig.getConfigBase(), "context.xml.default"));
* }
*/
// @formatter:on
return new StandardContext();
} else {
return super.defaultInstance(bean);
}
}
}