/**
* @param context the Servlet context.
* @deprecated Now handled in TdsContext.init().
*/
public static void initContext(ServletContext context) {
// setContextPath(context);
if (contextPath == null) {
// Servlet 2.5 allows the following.
// contextPath = servletContext.getContextPath();
String tmpContextPath =
context.getInitParameter("ContextPath"); // cannot be overridden in the ThreddsConfig file
if (tmpContextPath == null) tmpContextPath = "thredds";
contextPath = "/" + tmpContextPath;
}
// setRootPath(context);
if (rootPath == null) {
rootPath = context.getRealPath("/");
rootPath = rootPath.replace('\\', '/');
}
// setContentPath();
if (contentPath == null) {
String tmpContentPath = "../../content" + getContextPath() + "/";
File cf = new File(getRootPath(), tmpContentPath);
try {
contentPath = cf.getCanonicalPath() + "/";
contentPath = contentPath.replace('\\', '/');
} catch (IOException e) {
throw new RuntimeException(e.getMessage());
}
}
// initDebugging(context);
initDebugging(context);
}
private Element getDescription(String task) {
if (task != null) {
if (task.equals("define")) return definer.getDescription();
if (task.equals("compare")) return comparer.getDescription();
if (task.equals("search")) return searcher.getDescription();
if (task.equals("wikify")) return wikifier.getDescription();
}
Element description = doc.createElement("Description");
description.appendChild(
createElement(
"Details",
"<p>This servlet provides a range of services for mining information from Wikipedia. Further details depend on what you want to do.</p>"
+ "<p>You can <a href=\""
+ context.getInitParameter("service_name")
+ "?task=search&help\">search for pages</a>, <a href=\""
+ context.getInitParameter("service_name")
+ "?task=compare&help\">measure how terms or articles related to each other</a>, <a href=\""
+ context.getInitParameter("service_name")
+ "?task=define&help\">obtain short definitions from articles</a>, and <a href=\""
+ context.getInitParameter("service_name")
+ "?task=wikify&help\">detect topics in web pages</a>.</p>"));
Element paramTask =
createElement(
"Parameter",
"Specifies what you want to do: can be <em>search</em>, <em>compare</em>, <em>define</em>, or <em>wikify</em>");
paramTask.setAttribute("name", "task");
description.appendChild(paramTask);
Element paramId = doc.createElement("Parameter");
paramId.setAttribute("name", "help");
paramId.appendChild(doc.createTextNode("Specifies that you want help about the service."));
description.appendChild(paramId);
return description;
}
public static void initDebugging(ServletContext webapp) {
if (isDebugInit) return;
isDebugInit = true;
String debugOn = webapp.getInitParameter("DebugOn");
if (debugOn != null) {
StringTokenizer toker = new StringTokenizer(debugOn);
while (toker.hasMoreTokens()) Debug.set(toker.nextToken(), true);
}
}
private void servletEnv() {
if (!log.isDebugEnabled()) return;
try {
java.net.URL url = servletContext.getResource("/");
log.trace("Joseki base directory: " + url);
} catch (Exception ex) {
}
if (servletConfig != null) {
String tmp = servletConfig.getServletName();
log.trace("Servlet = " + (tmp != null ? tmp : "<null>"));
@SuppressWarnings("unchecked")
Enumeration<String> en = servletConfig.getInitParameterNames();
for (; en.hasMoreElements(); ) {
String s = en.nextElement();
log.trace("Servlet parameter: " + s + " = " + servletConfig.getInitParameter(s));
}
}
if (servletContext != null) {
// Name of webapp
String tmp = servletContext.getServletContextName();
// msg(Level.FINE, "Webapp = " + (tmp != null ? tmp : "<null>"));
log.debug("Webapp = " + (tmp != null ? tmp : "<null>"));
// NB This servlet may not have been loaded as part of a web app
@SuppressWarnings("unchecked")
Enumeration<String> en = servletContext.getInitParameterNames();
for (; en.hasMoreElements(); ) {
String s = en.nextElement();
log.debug("Webapp parameter: " + s + " = " + servletContext.getInitParameter(s));
}
}
/*
for ( Enumeration enum = servletContext.getAttributeNames() ; enum.hasMoreElements() ; )
{
String s = (String)enum.nextElement() ;
logger.log(LEVEL, "Webapp attribute: "+s+" = "+context.getAttribute(s)) ;
}
*/
}
/**
* Initializes the servlet context, based on the servlet context. Parses all context parameters
* and passes them on to the database context.
*
* @param sc servlet context
* @throws IOException I/O exception
*/
static synchronized void init(final ServletContext sc) throws IOException {
// skip process if context has already been initialized
if (context != null) return;
// set servlet path as home directory
final String path = sc.getRealPath("/");
System.setProperty(Prop.PATH, path);
// parse all context parameters
final HashMap<String, String> map = new HashMap<String, String>();
// store default web root
map.put(MainProp.HTTPPATH[0].toString(), path);
final Enumeration<?> en = sc.getInitParameterNames();
while (en.hasMoreElements()) {
final String key = en.nextElement().toString();
if (!key.startsWith(Prop.DBPREFIX)) continue;
// only consider parameters that start with "org.basex."
String val = sc.getInitParameter(key);
if (eq(key, DBUSER, DBPASS, DBMODE, DBVERBOSE)) {
// store servlet-specific parameters as system properties
System.setProperty(key, val);
} else {
// prefix relative paths with absolute servlet path
if (key.endsWith("path") && !new File(val).isAbsolute()) {
val = path + File.separator + val;
}
// store remaining parameters (without project prefix) in map
map.put(key.substring(Prop.DBPREFIX.length()).toUpperCase(Locale.ENGLISH), val);
}
}
context = new Context(map);
if (SERVER.equals(System.getProperty(DBMODE))) {
new BaseXServer(context);
} else {
context.log = new Log(context);
}
}
public static void showServletInfo(HttpServlet servlet, PrintStream out) {
out.println("Servlet Info");
out.println(" getServletName(): " + servlet.getServletName());
out.println(" getRootPath(): " + getRootPath());
out.println(" Init Parameters:");
Enumeration params = servlet.getInitParameterNames();
while (params.hasMoreElements()) {
String name = (String) params.nextElement();
out.println(" " + name + ": " + servlet.getInitParameter(name));
}
out.println();
ServletContext context = servlet.getServletContext();
out.println("Context Info");
try {
out.println(" context.getResource('/'): " + context.getResource("/"));
} catch (java.net.MalformedURLException e) {
} // cant happen
out.println(" context.getServerInfo(): " + context.getServerInfo());
out.println(" name: " + getServerInfoName(context.getServerInfo()));
out.println(" version: " + getServerInfoVersion(context.getServerInfo()));
out.println(" context.getInitParameterNames():");
params = context.getInitParameterNames();
while (params.hasMoreElements()) {
String name = (String) params.nextElement();
out.println(" " + name + ": " + context.getInitParameter(name));
}
out.println(" context.getAttributeNames():");
params = context.getAttributeNames();
while (params.hasMoreElements()) {
String name = (String) params.nextElement();
out.println(" context.getAttribute(\"" + name + "\"): " + context.getAttribute(name));
}
out.println();
}
/**
* Initializes the database context, based on the initial servlet context. Parses all context
* parameters and passes them on to the database context.
*
* @param sc servlet context
* @throws IOException I/O exception
*/
public static synchronized void init(final ServletContext sc) throws IOException {
// check if HTTP context has already been initialized
if (init) return;
init = true;
// set web application path as home directory and HTTPPATH
final String webapp = sc.getRealPath("/");
Options.setSystem(Prop.PATH, webapp);
Options.setSystem(GlobalOptions.WEBPATH, webapp);
// bind all parameters that start with "org.basex." to system properties
final Enumeration<String> en = sc.getInitParameterNames();
while (en.hasMoreElements()) {
final String key = en.nextElement();
if (!key.startsWith(Prop.DBPREFIX)) continue;
String val = sc.getInitParameter(key);
if (key.endsWith("path") && !new File(val).isAbsolute()) {
// prefix relative path with absolute servlet path
Util.debug(key.toUpperCase(Locale.ENGLISH) + ": " + val);
val = new IOFile(webapp, val).path();
}
Options.setSystem(key, val);
}
// create context, update options
if (context == null) {
context = new Context(false);
} else {
context.globalopts.setSystem();
context.options.setSystem();
}
// start server instance
if (!context.globalopts.get(GlobalOptions.HTTPLOCAL)) new BaseXServer(context);
}
public void init(ServletConfig config) throws ServletException {
super.init(config);
ctx = config.getServletContext();
// set the response content type
if (ctx.getInitParameter("responseContentType") != null) {
responseContentType = ctx.getInitParameter("responseContentType");
}
// allow for resources dir over-ride at the xhp level otherwise allow
// for the jmaki level resources
if (ctx.getInitParameter("jmaki-xhp-resources") != null) {
resourcesDir = ctx.getInitParameter("jmaki-xhp-resources");
} else if (ctx.getInitParameter("jmaki-resources") != null) {
resourcesDir = ctx.getInitParameter("jmaki-resources");
}
// allow for resources dir over-ride
if (ctx.getInitParameter("jmaki-classpath-resources") != null) {
classpathResourcesDir = ctx.getInitParameter("jmaki-classpath-resources");
}
String requireSessionString = ctx.getInitParameter("requireSession");
if (requireSessionString != null) {
if ("false".equals(requireSessionString)) {
requireSession = false;
getLogger().severe("XmlHttpProxyServlet: intialization. Session requirement disabled.");
} else if ("true".equals(requireSessionString)) {
requireSession = true;
getLogger().severe("XmlHttpProxyServlet: intialization. Session requirement enabled.");
}
}
String xdomainString = ctx.getInitParameter("allowXDomain");
if (xdomainString != null) {
if ("true".equals(xdomainString)) {
allowXDomain = true;
getLogger().severe("XmlHttpProxyServlet: intialization. xDomain access is enabled.");
} else if ("false".equals(xdomainString)) {
allowXDomain = false;
getLogger().severe("XmlHttpProxyServlet: intialization. xDomain access is disabled.");
}
}
// if there is a proxyHost and proxyPort specified create an HttpClient with the proxy
String proxyHost = ctx.getInitParameter("proxyHost");
String proxyPortString = ctx.getInitParameter("proxyPort");
if (proxyHost != null && proxyPortString != null) {
int proxyPort = 8080;
try {
proxyPort = new Integer(proxyPortString).intValue();
xhp = new XmlHttpProxy(proxyHost, proxyPort);
} catch (NumberFormatException nfe) {
getLogger()
.severe("XmlHttpProxyServlet: intialization error. The proxyPort must be a number");
throw new ServletException(
"XmlHttpProxyServlet: intialization error. The proxyPort must be a number");
}
} else {
xhp = new XmlHttpProxy();
}
}
public void init(ServletConfig config) throws ServletException {
super.init(config);
context = config.getServletContext();
TextProcessor tp = new CaseFolder();
try {
wikipedia =
new Wikipedia(
context.getInitParameter("mysql_server"),
context.getInitParameter("mysql_database"),
context.getInitParameter("mysql_user"),
context.getInitParameter("mysql_password"));
} catch (Exception e) {
throw new ServletException("Could not connect to wikipedia database.");
}
// Escaper escaper = new Escaper() ;
definer = new Definer(this);
comparer = new Comparer(this);
searcher = new Searcher(this);
try {
wikifier = new Wikifier(this, tp);
} catch (Exception e) {
System.err.println("Could not initialize wikifier");
}
try {
File dataDirectory = new File(context.getInitParameter("data_directory"));
if (!dataDirectory.exists() || !dataDirectory.isDirectory()) {
throw new Exception();
}
cachingThread = new CacherThread(dataDirectory, tp);
cachingThread.start();
} catch (Exception e) {
throw new ServletException("Could not locate wikipedia data directory.");
}
try {
TransformerFactory tf = TransformerFactory.newInstance();
transformersByName = new HashMap<String, Transformer>();
transformersByName.put(
"help", buildTransformer("help", new File("/research/wikipediaminer/web/xsl"), tf));
transformersByName.put(
"loading", buildTransformer("loading", new File("/research/wikipediaminer/web/xsl"), tf));
transformersByName.put(
"search", buildTransformer("search", new File("/research/wikipediaminer/web/xsl"), tf));
transformersByName.put(
"compare", buildTransformer("compare", new File("/research/wikipediaminer/web/xsl"), tf));
transformersByName.put(
"wikify", buildTransformer("wikify", new File("/research/wikipediaminer/web/xsl"), tf));
Transformer serializer = TransformerFactory.newInstance().newTransformer();
serializer.setOutputProperty(OutputKeys.INDENT, "yes");
serializer.setOutputProperty(OutputKeys.METHOD, "xml");
serializer.setOutputProperty("{http://xml.apache.org/xslt}indent-amount", "3");
transformersByName.put("serializer", serializer);
} catch (Exception e) {
throw new ServletException("Could not load xslt library.");
}
}
public void doGet(HttpServletRequest request, HttpServletResponse response)
throws IOException, ServletException {
try {
response.setHeader("Cache-Control", "no-cache");
response.setCharacterEncoding("UTF-8");
String task = request.getParameter("task");
Element data = null;
// process help request
if (request.getParameter("help") != null) data = getDescription(task);
// redirect to home page if there is no task
if (data == null && task == null) {
response.setContentType("text/html");
response
.getWriter()
.append(
"<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.0 Transitional//EN\"><html><head><meta http-equiv=\"REFRESH\" content=\"0;url="
+ context.getInitParameter("server_path")
+ "></head><body></body></html>");
return;
}
// process definition request
if (data == null && task.equals("define")) {
int id = resolveIntegerArg(request.getParameter("id"), -1);
int length = resolveIntegerArg(request.getParameter("length"), definer.getDefaultLength());
int format = resolveIntegerArg(request.getParameter("format"), definer.getDefaultFormat());
int maxImageWidth =
resolveIntegerArg(
request.getParameter("maxImageWidth"), definer.getDefaultMaxImageWidth());
int maxImageHeight =
resolveIntegerArg(
request.getParameter("maxImageHeight"), definer.getDefaultMaxImageHeight());
int linkDestination =
resolveIntegerArg(
request.getParameter("linkDestination"), definer.getDefaultLinkDestination());
boolean getImages = resolveBooleanArg(request.getParameter("getImages"), false);
data =
definer.getDefinition(
id, length, format, linkDestination, getImages, maxImageWidth, maxImageHeight);
}
// all of the remaining tasks require data to be cached, so lets make sure that is finished
// before continuing.
if (!cachingThread.isOk()) throw new ServletException("Could not cache wikipedia data");
double progress = cachingThread.getProgress();
if (data == null && (progress < 1 || task.equals("progress"))) {
// still caching up data, not ready to return a response yet.
data = doc.createElement("loading");
data.setAttribute("progress", df.format(progress));
task = "loading";
}
// process search request
if (data == null && task.equals("search")) {
String term = request.getParameter("term");
String id = request.getParameter("id");
int linkLimit =
resolveIntegerArg(request.getParameter("linkLimit"), searcher.getDefaultMaxLinkCount());
int senseLimit =
resolveIntegerArg(
request.getParameter("senseLimit"), searcher.getDefaultMaxSenseCount());
if (id == null) data = searcher.doSearch(term, linkLimit, senseLimit);
else data = searcher.doSearch(Integer.parseInt(id), linkLimit);
}
// process compare request
if (data == null && task.equals("compare")) {
String term1 = request.getParameter("term1");
String term2 = request.getParameter("term2");
int linkLimit =
resolveIntegerArg(request.getParameter("linkLimit"), comparer.getDefaultMaxLinkCount());
boolean details =
resolveBooleanArg(request.getParameter("details"), comparer.getDefaultShowDetails());
data = comparer.getRelatedness(term1, term2, details, linkLimit);
}
// process wikify request
if (data == null && task.equals("wikify")) {
if (this.wikifier == null)
throw new ServletException(
"Wikifier is not available. You must configure the servlet so that it has access to link detection and disambiguation models.");
String source = request.getParameter("source");
int sourceMode =
resolveIntegerArg(request.getParameter("sourceMode"), Wikifier.SOURCE_AUTODETECT);
String linkColor = request.getParameter("linkColor");
String baseColor = request.getParameter("baseColor");
double minProb =
resolveDoubleArg(
request.getParameter("minProbability"), wikifier.getDefaultMinProbability());
int repeatMode =
resolveIntegerArg(request.getParameter("repeatMode"), wikifier.getDefaultRepeatMode());
boolean showTooltips =
resolveBooleanArg(
request.getParameter("showTooltips"), wikifier.getDefaultShowTooltips());
String bannedTopics = request.getParameter("bannedTopics");
boolean wrapInXml = resolveBooleanArg(request.getParameter("wrapInXml"), true);
if (wrapInXml) {
data =
wikifier.wikifyAndWrapInXML(
source,
sourceMode,
minProb,
repeatMode,
bannedTopics,
baseColor,
linkColor,
showTooltips);
} else {
response.setContentType("text/html");
response
.getWriter()
.append(
wikifier.wikify(
source,
sourceMode,
minProb,
repeatMode,
bannedTopics,
baseColor,
linkColor,
showTooltips));
return;
}
}
if (data == null) throw new Exception("Unknown Task");
// wrap data
Element wrapper = doc.createElement("WikipediaMinerResponse");
wrapper.setAttribute("server_path", context.getInitParameter("server_path"));
wrapper.setAttribute("service_name", context.getInitParameter("service_name"));
wrapper.appendChild(data);
data = wrapper;
// Transform or serialize xml data as appropriate
Transformer tf = null;
if (request.getParameter("xml") == null) {
// we need to transform the data into html
tf = transformersByName.get(task);
if (request.getParameter("help") != null) tf = transformersByName.get("help");
}
if (tf == null) {
// we need to serialize the data as xml
tf = transformersByName.get("serializer");
response.setContentType("application/xml");
} else {
// output will be transformed to html
response.setContentType("text/html");
response
.getWriter()
.append(
"<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01//EN\" \"http://www.w3.org/TR/html4/strict.dtd\">\n");
}
tf.transform(new DOMSource(data), new StreamResult(response.getWriter()));
} catch (Exception error) {
response.reset();
response.setContentType("application/xml");
response.setHeader("Cache-Control", "no-cache");
response.setCharacterEncoding("UTF8");
Element xmlError = doc.createElement("Error");
if (error.getMessage() != null) xmlError.setAttribute("message", error.getMessage());
Element xmlStackTrace = doc.createElement("StackTrace");
xmlError.appendChild(xmlStackTrace);
for (StackTraceElement ste : error.getStackTrace()) {
Element xmlSte = doc.createElement("StackTraceElement");
xmlSte.setAttribute("message", ste.toString());
xmlStackTrace.appendChild(xmlSte);
}
try {
transformersByName
.get("serializer")
.transform(new DOMSource(xmlError), new StreamResult(response.getWriter()));
} catch (Exception e) {
// TODO: something for when an error is thrown processing an error????
}
;
}
}
@Override
public String getInitParameter(String s) {
return proxy.getInitParameter(s);
}
/** {@inheritDoc} */
public String getParameter(String pName) {
return servletContext.getInitParameter(pName);
}
public String getInitParameter(String arg0) {
return servletContext.getInitParameter(arg0);
}
