/*
Copyright (c) 2003-2009 ITerative Consulting Pty Ltd. All Rights Reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted
provided that the following conditions are met:
o Redistributions of source code must retain the above copyright notice, this list of conditions and
the following disclaimer.
o 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.
o This jcTOOL Helper Class software, whether in binary or source form may not be used within,
or to derive, any other product without the specific prior written permission of the copyright holder
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS "AS IS" AND ANY EXPRESS 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 COPYRIGHT OWNER OR 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.
*/
package HTTP;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.beans.PropertyChangeSupport;
import java.io.IOException;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.util.Enumeration;
import java.util.Hashtable;
import java.util.Iterator;
import javax.servlet.RequestDispatcher;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.jsp.PageContext;
import org.apache.log4j.Logger;
import Framework.Array_Of_NamedElement;
import Framework.DataValue;
import Framework.ErrorMgr;
import Framework.GenericException;
import Framework.NamedElement;
import Framework.ParameterHolder_NamedElement_Array;
import Framework.Stream;
import Framework.TextData;
/**
* The HTMLScanner class defines a template scanner service,
* and contains the methods used to process UDS HTML templates
* and generate Web pages.
*/
public class HTMLScanner implements TagHandlerIFace, PropertyChangeListener, IHTMLScanner
{
protected String documentRoot = "";
protected String handlerConfigFile = "";
protected Hashtable<String, TagHandlerIFace> handlers;
protected static final String qq_DefaultHandler = "qq_DefaultHandler";
protected static final String qq_DefaultErrorPage = "/DefaultErrorPage.jsp";
/* (non-Javadoc)
* @see HTTP.IHTMLScanner#getDocumentRoot()
*/
public String getDocumentRoot() {
return documentRoot;
}
/* (non-Javadoc)
* @see HTTP.IHTMLScanner#setDocumentRoot(java.lang.String)
*/
public void setDocumentRoot(String documentRoot) {
this.documentRoot = documentRoot;
}
/* (non-Javadoc)
* @see HTTP.IHTMLScanner#getHandlerConfigFile()
*/
public String getHandlerConfigFile() {
return handlerConfigFile;
}
/* (non-Javadoc)
* @see HTTP.IHTMLScanner#setHandlerConfigFile(java.lang.String)
*/
public void setHandlerConfigFile(String handlerConfigFile) {
this.handlerConfigFile = handlerConfigFile;
}
public HTMLScanner() {
handlers = new Hashtable<String, TagHandlerIFace>();
//registerTagHandler(qq_DefaultHandler, this);
}
/* (non-Javadoc)
* @see HTTP.IHTMLScanner#registerTagHandler(java.lang.String, HTTP.TagHandlerIFace)
*/
public void registerTagHandler(String className, TagHandlerIFace handlerRef){
this.handlers.put(className, handlerRef);
}
/* (non-Javadoc)
* @see HTTP.IHTMLScanner#registerTagHandler(HTTP.TagHandlerIFace)
*/
public void registerTagHandler(TagHandlerIFace handlerRef) {
String className = handlerRef.getClass().getName();
int end = className.lastIndexOf(".") + 1;
className = className.substring(end).toUpperCase();
this.registerTagHandler(className, handlerRef);
}
/* (non-Javadoc)
* @see HTTP.IHTMLScanner#getCondition(java.lang.String, java.lang.String, HTTP.ExecContext)
*/
public boolean getCondition(String handler, String Condition, ExecContext context ){
return this.getCondition(handler, Condition, context, null);
}
/* (non-Javadoc)
* @see HTTP.IHTMLScanner#getCondition(java.lang.String, java.lang.String, HTTP.ExecContext, HTTP.ParameterList)
*/
public boolean getCondition(String handler, String Condition, ExecContext context, ParameterList parameters ){
if (handler == null) {
return this.getCondition(Condition, context, parameters);
}
else {
handler = handler.toUpperCase();
TagHandlerIFace iface = ((TagHandlerIFace)this.handlers.get(handler));
if (iface != null){
return iface.handleCondition(new TextData(Condition), context.getRequest(), context.getResponse(), parameters, context);
}
return false;
}
}
/* (non-Javadoc)
* @see HTTP.IHTMLScanner#getCondition(java.lang.String, HTTP.ExecContext)
*/
public boolean getCondition(String Condition, ExecContext context){
return this.getCondition(Condition, context, null);
}
/* (non-Javadoc)
* @see HTTP.IHTMLScanner#getCondition(java.lang.String, HTTP.ExecContext, HTTP.ParameterList)
*/
public boolean getCondition(String Condition, ExecContext context, ParameterList parameters){
return this.handleCondition(new TextData(Condition), context.getRequest(), context.getResponse(), parameters, context);
}
/* (non-Javadoc)
* @see HTTP.IHTMLScanner#getTag(java.lang.String, java.lang.String, HTTP.ExecContext)
*/
public void getTag(String handler, String Condition, ExecContext context ){
this.getTag(handler, Condition, context, null, null);
}
/* (non-Javadoc)
* @see HTTP.IHTMLScanner#getTag(java.lang.String, java.lang.String, HTTP.ExecContext, HTTP.ResultSet, HTTP.ParameterList)
*/
public void getTag(String handler, String Condition, ExecContext context, ResultSet rset, ParameterList parameters ){
if (handler == null) {
this.getTag(Condition, context, rset, parameters);
}
else {
handler = handler.toUpperCase();
TagHandlerIFace iface = ((TagHandlerIFace)this.handlers.get(handler));
if (iface != null){
iface.handleTag(new TextData(Condition), context.getRequest(), context.getResponse(), parameters, rset, context);
}
}
}
/* (non-Javadoc)
* @see HTTP.IHTMLScanner#getTag(java.lang.String, java.lang.String, HTTP.ExecContext, HTTP.ResultSet)
*/
public void getTag(String handler, String Condition, ExecContext context, ResultSet rset ){
this.getTag(handler, Condition, context, rset, null);
}
/* (non-Javadoc)
* @see HTTP.IHTMLScanner#getTag(java.lang.String, HTTP.ExecContext, HTTP.ResultSet)
*/
public void getTag(String Condition, ExecContext context, ResultSet rset){
this.getTag(Condition, context, rset, null);
}
/* (non-Javadoc)
* @see HTTP.IHTMLScanner#getTag(java.lang.String, HTTP.ExecContext, HTTP.ResultSet, HTTP.ParameterList)
*/
public void getTag(String Condition, ExecContext context, ResultSet resultSet, ParameterList parameters){
this.handleTag(new TextData(Condition), context.getRequest(), context.getResponse(), parameters, resultSet, context);
}
/* (non-Javadoc)
* @see HTTP.IHTMLScanner#handleCondition(Framework.TextData, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, HTTP.ParameterList, HTTP.ExecContext)
*/
public boolean handleCondition(TextData condName,
HttpServletRequest request,
HttpServletResponse response,
ParameterList parameters,
ExecContext context) {
return false;
}
/* (non-Javadoc)
* @see HTTP.IHTMLScanner#handleTag(Framework.TextData, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, HTTP.ParameterList, HTTP.ResultSet, HTTP.ExecContext)
*/
public void handleTag(TextData tag, HttpServletRequest request,
HttpServletResponse response, ParameterList parameters,
ResultSet rset, ExecContext context) {
}
/* (non-Javadoc)
* @see HTTP.IHTMLScanner#handleTemplate(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
*/
public HttpServletResponse handleTemplate(HttpServletRequest request, HttpServletResponse response){
HttpServletResponse result = response;
try {
String templateName = HTMLScanner.getParameter(request, "TemplateName", false);
request.setAttribute("qq_HTMLScanner", this);
ExecContext ex = new ExecContext(request, response);
request.setAttribute("qq_ExecContext", ex);
//ServletContext sc = ((ServletContext)request.getAttribute("qq_ServletContext"));
//String absolute = request.getServletPath();
String absolutePath = getAbsolutePathRelativeToContext(request, templateName);
RequestDispatcher rd = request.getRequestDispatcher(absolutePath);
rd.include(request, response);
} catch (IOException e) {
Logger.getLogger("HTMLScanner").debug("IOException caught in handleTemplate", e);
HTTPAccessException errorVar = new HTTPAccessException(e);
ErrorMgr.addError(errorVar);
throw errorVar;
} catch (ServletException e){
Logger.getLogger("HTMLScanner").debug("ServletException caught in handleTemplate", e);
HTTPAccessException errorVar = new HTTPAccessException(e);
ErrorMgr.addError(errorVar);
throw errorVar;
}
return result;
}
private String getAbsolutePathRelativeToContext(HttpServletRequest request, String relativeUrlPath) {
String path = relativeUrlPath;
if (!path.startsWith("/")) {
String uri = ((HttpServletRequest) request).getServletPath();
String baseURI = uri.substring(0, uri.lastIndexOf('/'));
path = baseURI+'/'+path;
}
return path;
}
@SuppressWarnings("unchecked")
public static String getParameter(HttpServletRequest pRequest, String pName, boolean pIgnoreCase) {
if (pIgnoreCase) {
for (Enumeration e = pRequest.getParameterNames(); e.hasMoreElements();) {
String thisParameter = (String)e.nextElement();
if (thisParameter.equalsIgnoreCase(pName)) {
return pRequest.getParameter(thisParameter);
}
}
}
else {
return pRequest.getParameter(pName);
}
return null;
}
/* (non-Javadoc)
* @see HTTP.IHTMLScanner#registerHandler(HTTP.TagHandlerIFace)
*/
public void registerHandler(TagHandlerIFace handlerRef){
UnsupportedOperationException errorVar = new UnsupportedOperationException("HTMLScanner.registerHandler() is not implemented");
ErrorMgr.addError(errorVar);
throw errorVar;
}
public void duplicateIntoTarget(HTMLScanner pTarget, boolean pDeep) {
pTarget = ((HTMLScanner)this);
}
public void clearPageCache() {
throw new UnsupportedOperationException(
"HTMLScanner.clearPageCache() is not implemented");
}
public void dumpStatus(Stream ostream) {
throw new UnsupportedOperationException(
"HTMLScanner.dumpStatus() is not implemented");
}
/* (non-Javadoc)
* @see HTTP.IHTMLScanner#getErrorTemplate(Framework.GenericException, javax.servlet.http.HttpServletRequest, Framework.ParameterHolder_NamedElement_Array)
*/
public TextData getErrorTemplate(GenericException e,
HttpServletRequest request,
ParameterHolder_NamedElement_Array customParameters) {
//throw new UnsupportedOperationException("HTMLScanner.getErrorTemplate() is not implemented");
return new TextData(HTMLScanner.qq_DefaultErrorPage);
}
/* (non-Javadoc)
* @see HTTP.IHTMLScanner#getErrorPageForward(javax.servlet.jsp.PageContext, java.lang.Throwable)
*/
@SuppressWarnings("unchecked")
public String getErrorPageForward(PageContext pageContext, Throwable error) {
TextData destination = new TextData(HTMLScanner.qq_DefaultErrorPage);
Array_Of_NamedElement<NamedElement> parameters;
Exception exception = (Exception)error;
ParameterHolder_NamedElement_Array parameterHolder = new ParameterHolder_NamedElement_Array();
if (error instanceof GenericException) {
GenericException ge = (GenericException)error;
destination = this.getErrorTemplate( ge,
(HttpServletRequest)pageContext.getRequest(),
parameterHolder);
}
parameters = (Array_Of_NamedElement<NamedElement>)parameterHolder.getObject();
ResultSet rs = (ResultSet)pageContext.getAttribute("FORTE", PageContext.REQUEST_SCOPE);
if (parameters != null) {
for (Iterator<NamedElement> it = parameters.iterator(); it.hasNext();) {
NamedElement anElement = it.next();
Object anObject = anElement.getObject();
if (anObject instanceof DataValue) {
rs.add(anElement.getName(), (DataValue)anElement.getObject());
}
else {
rs.add(anElement.getName(), anElement.getObject().toString());
}
}
}
if (!rs.isMemberSet("ExceptionClass")) {
rs.add( "ExceptionClass", exception.getClass().toString() );
}
if (!rs.isMemberSet("Message")) {
rs.add( "Message", exception.getMessage() );
}
if (!rs.isMemberSet("ExceptionTraceback")) {
StringWriter sw = new StringWriter();
try {
exception.printStackTrace(new PrintWriter(sw));
rs.add( "ExceptionTraceback", sw.toString() );
}
finally {
try {
sw.close();
}
catch (Exception err) {}
}
}
return destination.toString();
}
public void printStats() {
throw new UnsupportedOperationException(
"HTMLScanner.printStats() is not implemented");
}
/* (non-Javadoc)
* @see HTTP.IHTMLScanner#reloadDynHandlers()
*/
public void reloadDynHandlers() {
throw new UnsupportedOperationException(
"HTMLScanner.reloadDynHandlers() is not implemented");
}
public transient PropertyChangeSupport qq_Listeners = new PropertyChangeSupport(this);
public synchronized void addPropertyChangeListener(String property, PropertyChangeListener listener) {
if (qq_Listeners == null)
qq_Listeners = new PropertyChangeSupport(this);
qq_Listeners.addPropertyChangeListener(property, listener);
}
public synchronized void removePropertyChangeListener(PropertyChangeListener listener) {
if (qq_Listeners == null)
qq_Listeners = new PropertyChangeSupport(this);
qq_Listeners.removePropertyChangeListener(listener);
}
public synchronized PropertyChangeSupport getPropertyListeners() {
if (qq_Listeners == null)
qq_Listeners = new PropertyChangeSupport(this);
return this.qq_Listeners;
}
public synchronized void propertyChange(PropertyChangeEvent pcEvt) {
}
} // end class HTMLScanner