org.mobicents.servlet.sip.catalina.SipHostConfig Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source
* Copyright 2011, Red Hat, Inc. and individual contributors
* 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.mobicents.servlet.sip.catalina;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Future;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;
import org.apache.catalina.Context;
import org.apache.catalina.core.StandardContext;
import org.apache.catalina.startup.HostConfig;
import org.apache.catalina.util.ContextName;
import org.apache.log4j.Logger;
import org.mobicents.servlet.sip.catalina.annotations.SipApplicationAnnotationUtils;
import org.mobicents.servlet.sip.core.SipContext;
/**
* @author Jean Deruelle
*
*/
public class SipHostConfig extends HostConfig {
private static final String WAR_EXTENSION = ".war";
private static final String SAR_EXTENSION = ".sar";
public static final String SIP_CONTEXT_CLASS = "org.mobicents.servlet.sip.startup.SipStandardContext";
public static final String SIP_CONTEXT_CONFIG_CLASS = "org.mobicents.servlet.sip.startup.SipContextConfig";
private static final Logger logger = Logger.getLogger(SipHostConfig.class);
/**
*
*/
public SipHostConfig() {
super();
}
@Override
protected void deployApps() {
super.deployApps();
}
//completely overwritten since jboss web in jboss as5 and as 4.2.3 are not based on tomcat 6.0.20
//tc 7.0.4 changed this method to getBaseName(String path). also this replace the getConfigFile(String path) method
// @Override
// protected String getDocBase(String path) {
// String basename = null;
// if (path.equals("")) {
// basename = "ROOT";
// } else {
// basename = path.substring(1).replace('/', '#');
// }
// return (basename);
// }
@Override
protected void deployApps(String name) {
File appBase = host.getAppBaseFile();
File configBase = host.getConfigBaseFile();
// String baseName = getBaseName(name);
ContextName cn = new ContextName(name, false);
String baseName = cn.getBaseName();
//No need for docBase, replace by baseName
//String docBase = getBaseName(name);
if (deploymentExists(baseName)) {
return;
}
// Deploy XML descriptors from configBase
File xml = new File(configBase, baseName + ".xml");
if (xml.exists()) {
deployDescriptor(cn, xml);
return;
}
// Deploy WARs, and loop if additional descriptors are found
File war = new File(appBase, baseName + ".war");
if (war.exists()) {
boolean isSipServletApplication = isSipServletArchive(war);
if(isSipServletApplication) {
if(logger.isDebugEnabled()) {
logger.debug(SipContext.APPLICATION_SIP_XML + " found in "
+ baseName + ". Enabling sip servlet archive deployment");
}
deploySAR(cn, war);
} else {
if(logger.isDebugEnabled()) {
logger.debug(SipContext.APPLICATION_SIP_XML + " not found in "
+ baseName + ". Not Enabling sip servlet archive deployment");
}
deployWAR(cn, war);
}
return;
}
// Deploy expanded folders
File dir = new File(appBase, baseName);
if (dir.exists()) {
deployDirectory(cn, dir);
}
// Deploy SARs, and loop if additional descriptors are found
File sar = new File(appBase, baseName + SAR_EXTENSION);
if (sar.exists()) {
deploySAR(cn, sar);
}
}
/**
*
* @param NAME
* @param sar
* @param string
*/
protected void deploySAR(ContextName cn, File sar) {
if (deploymentExists(cn.getName()))
return;
if(logger.isDebugEnabled()) {
logger.debug(SipContext.APPLICATION_SIP_XML + " found in "
+ sar + ". Enabling sip servlet archive deployment");
}
String initialConfigClass = host.getConfigClass();
String initialContextClass = contextClass;
host.setConfigClass(SIP_CONTEXT_CONFIG_CLASS);
//host.setConfigClass(SIP_CONTEXT_CONFIG_CLASS);
setContextClass(SIP_CONTEXT_CLASS);
deployWAR(cn, sar);
host.setConfigClass(initialConfigClass);
//configClass = initialConfigClass;
contextClass = initialContextClass;
}
@Override
protected void deployWAR(ContextName cn, File dir) {
if(logger.isDebugEnabled()) {
logger.debug("Context class used to deploy the WAR : " + contextClass);
logger.debug("Context config class used to deploy the WAR : " + host.getConfigClass());
}
super.deployWAR(cn, dir);
}
@Override
protected void deployDirectory(ContextName cn, File dir) {
if (deploymentExists(cn.getName()))
return;
boolean isSipServletApplication = isSipServletDirectory(dir);
if(isSipServletApplication) {
if(logger.isDebugEnabled()) {
logger.debug(SipContext.APPLICATION_SIP_XML + " found in "
+ dir + ". Enabling sip servlet archive deployment");
}
String initialConfigClass = host.getConfigClass();
String initialContextClass = contextClass;
host.setConfigClass(SIP_CONTEXT_CONFIG_CLASS);
//setConfigClass(SIP_CONTEXT_CONFIG_CLASS);
setContextClass(SIP_CONTEXT_CLASS);
super.deployDirectory(cn, dir);
host.setConfigClass(initialConfigClass);
//configClass = initialConfigClass;
contextClass = initialContextClass;
} else {
if(logger.isDebugEnabled()) {
logger.debug(SipContext.APPLICATION_SIP_XML + " not found in "
+ dir + ". Not Enabling sip servlet archive deployment");
}
// https://code.google.com/p/sipservlets/issues/detail?id=257 make sure the digester to parse directories
// containing META-INF/context.xml is the correct one
digester = createDigester(StandardContext.class.getName());
if(logger.isDebugEnabled()) {
logger.debug("Context class used to deploy the directory : " + contextClass);
logger.debug("Context config class used to deploy the directory : " + host.getConfigClass());
}
super.deployDirectory(cn, dir);
}
}
@Override
protected void deployDescriptor(ContextName cn, File contextXml) {
super.deployDescriptor(cn, contextXml);
}
@Override
protected void deployWARs(File appBase, String[] files) {
if (files == null)
return;
ExecutorService es = host.getStartStopExecutor();
List> results = new ArrayList<>();
for (int i = 0; i < files.length; i++) {
if (files[i].equalsIgnoreCase("META-INF"))
continue;
if (files[i].equalsIgnoreCase("WEB-INF"))
continue;
File war = new File(appBase, files[i]);
if (files[i].toLowerCase(Locale.ENGLISH).endsWith(".war") &&
war.isFile() && !invalidWars.contains(files[i]) ) {
boolean isSipServletApplication = isSipServletArchive(war);
if(isSipServletApplication) {
if(logger.isDebugEnabled()) {
logger.debug(SipContext.APPLICATION_SIP_XML + " found in "
+ files[i] + ". Enabling sip servlet archive deployment");
}
ContextName cn = new ContextName(files[i], true);
// Calculate the context path and make sure it is unique
// String contextPath = "/" + files[i];
// int period = contextPath.lastIndexOf(".");
// if (period >= 0)
// contextPath = contextPath.substring(0, period);
// if (contextPath.equals("/ROOT"))
// contextPath = "";
if (isServiced(cn.getName()))
continue;
if (deploymentExists(cn.getName())) {
DeployedApplication app = deployed.get(cn.getName());
if (!unpackWARs && app != null) {
// Need to check for a directory that should not be
// there
File dir = new File(appBase, cn.getBaseName());
if (dir.exists()) {
if (!app.loggedDirWarning) {
logger.warn(sm.getString(
"hostConfig.deployWar.hiddenDir",
dir.getAbsoluteFile(),
war.getAbsoluteFile()));
app.loggedDirWarning = true;
}
} else {
app.loggedDirWarning = false;
}
}
continue;
}
// Check for WARs with /../ /./ or similar sequences in the name
if (!validateContextPath(appBase, cn.getBaseName())) {
logger.error(sm.getString(
"hostConfig.illegalWarName", files[i]));
invalidWars.add(files[i]);
continue;
}
results.add(es.submit(new DeploySar(this, cn, war)));
// String initialConfigClass = configClass;
// String initialContextClass = contextClass;
// host.setConfigClass(SIP_CONTEXT_CONFIG_CLASS);
// setConfigClass(SIP_CONTEXT_CONFIG_CLASS);
// setContextClass(SIP_CONTEXT_CLASS);
// deploySAR(cn, dir);
// host.setConfigClass(initialConfigClass);
// configClass = initialConfigClass;
// contextClass = initialContextClass;
} else {
if(logger.isDebugEnabled()) {
logger.debug(SipContext.APPLICATION_SIP_XML + " not found in "
+ files[i] + ". Not Enabling sip servlet archive deployment");
}
setContextClass(StandardContext.class.getName());
}
}
for (Future result : results) {
try {
result.get();
} catch (Exception e) {
logger.error(sm.getString(
"hostConfig.deployWar.threaded.error"), e);
}
}
}
super.deployWARs(appBase, files);
}
private boolean validateContextPath(File appBase, String contextPath) {
// More complicated than the ideal as the canonical path may or may
// not end with File.separator for a directory
StringBuilder docBase;
String canonicalDocBase = null;
try {
String canonicalAppBase = appBase.getCanonicalPath();
docBase = new StringBuilder(canonicalAppBase);
if (canonicalAppBase.endsWith(File.separator)) {
docBase.append(contextPath.substring(1).replace(
'/', File.separatorChar));
} else {
docBase.append(contextPath.replace('/', File.separatorChar));
}
// At this point docBase should be canonical but will not end
// with File.separator
canonicalDocBase =
(new File(docBase.toString())).getCanonicalPath();
// If the canonicalDocBase ends with File.separator, add one to
// docBase before they are compared
if (canonicalDocBase.endsWith(File.separator)) {
docBase.append(File.separator);
}
} catch (IOException ioe) {
return false;
}
// Compare the two. If they are not the same, the contextPath must
// have /../ like sequences in it
return canonicalDocBase.equals(docBase.toString());
}
/**
* Check if the file given in parameter match a sip servlet application, i.e.
* if it contains a sip.xml in its WEB-INF directory
* @param file the file to check (war or sar)
* @return true if the file is a sip servlet application, false otherwise
*/
private boolean isSipServletArchive(File file) {
if (file.getName().toLowerCase().endsWith(SAR_EXTENSION)) {
return true;
} else if (file.getName().toLowerCase().endsWith(WAR_EXTENSION)) {
try{
JarFile jar = new JarFile(file);
JarEntry entry = jar.getJarEntry(SipContext.APPLICATION_SIP_XML);
if(entry != null) {
return true;
}
} catch (IOException e) {
if(logger.isInfoEnabled()) {
logger.info("couldn't find WEB-INF/sip.xml in " + file + " checking for package-info.class");
}
}
return SipApplicationAnnotationUtils.findPackageInfoInArchive(file);
}
return false;
}
/**
* Check if the file given in parameter match a sip servlet application, i.e.
* if it contains a sip.xml in its WEB-INF directory
* @param file the file to check (war or sar)
* @return true if the file is a sip servlet application, false otherwise
*/
private boolean isSipServletDirectory(File dir) {
if(dir.isDirectory()) {
//Fix provided by Thomas Leseney for exploded directory deployments
File sipXmlFile = new File(dir.getAbsoluteFile(), SipContext.APPLICATION_SIP_XML);
if(sipXmlFile.exists()) {
return true;
}
if(SipApplicationAnnotationUtils.findPackageInfoinDirectory(dir)) return true;
}
return false;
}
@Override
public void manageApp(Context arg0) {
super.manageApp(arg0);
}
private static class DeploySar implements Runnable {
private SipHostConfig config;
private ContextName cn;
private File war;
public DeploySar(SipHostConfig config, ContextName cn, File war) {
this.config = config;
this.cn = cn;
this.war = war;
}
@Override
public void run() {
config.deploySAR(cn, war);
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy