org.archive.wayback.archivalurl

Class FastArchivalUrlReplayParseEventHandler

java.lang.Object

org.archive.wayback.archivalurl.FastArchivalUrlReplayParseEventHandler

All Implemented Interfaces:

ParseEventHandler

public class FastArchivalUrlReplayParseEventHandler
extends Object
implements ParseEventHandler

Lean and mean ParseEventHandler implementing current best-known server-side HTML rewrite rules, and should be much faster than the fully configurable version.

This class has kludgy support for disabling JavaScript inclusion with <SCRIPT SRC=...> element. jsBlockTrans, whose primary use is translating JavaScript code block (inline <SCRIPT>, javascript: URI in HREF attribute, and event handler attributes), is also called with a value of SRC attribute of <SCRIPT> tag. If jsBlockTrans returns either null or an empty String, <SCRIPT> element is disabled by changing SRC to an empty value. Note that in this case jsBlockTrans is used only for a test, and its return value is simply discarded. URL translation is done by a subsequent call to URLStringTransformer for js_ context. This feature is very likely a subject of refactoring in the future.

Author:

brad

Field Summary

Fields

Modifier and Type	Field and Description
static String	FERRET_DONE_KEY
protected static String	FERRET_HEAD_INSERTED
protected static String	FERRET_IN_HEAD
protected String	headInsertJsp

Constructor Summary

Constructors

Constructor and Description
FastArchivalUrlReplayParseEventHandler() Constructor...

Method Summary

Methods

Modifier and Type	Method and Description
protected String	bodyInsertContent(ReplayParseContext context) return body-insert text.
protected boolean	checkAllowTag(ParseContext context, org.htmlparser.nodes.TagNode tagNode)
protected void	emit(ReplayParseContext context, String pre, org.htmlparser.Node node, String post)
protected void	emitHeadInsert(ReplayParseContext context, org.htmlparser.Node node, boolean postInsert)
AttributeRewriter	getAttributeRewriter()
String	getCommentJsp() Deprecated. use getEndJsp()
String	getEndJsp()
String	getHeadInsertJsp()
StringTransformer	getJsBlockTrans()
String	getJspInsertPath()
String	getStartsp()
void	handleNode(ParseContext pContext, org.htmlparser.Node node)
void	handleParseComplete(ParseContext pContext)
void	handleParseStart(ParseContext pContext)
void	init()
boolean	isUnescapeAttributeValues() Deprecated. 1.8.1/05-23-2014 moved to StandardAttributeRewriter.
void	setAttributeRewriter(AttributeRewriter attributeRewriter) set AttributeRewriter for rewriting attribute values.
void	setCommentJsp(String commentJsp) Deprecated. use setEndJsp()
void	setEndJsp(String endJsp)
void	setHeadInsertJsp(String headInsertJsp) servlet whose output will be inserted right after HEAD tag.
void	setJsBlockTrans(StringTransformer jsBlockTrans) StringTransformer used for rewriting JavaScript code block (<SCRIPT> and javascript: attribute).
void	setJspInsertPath(String jspInsertPath)
void	setStartJsp(String startJsp)
void	setUnescapeAttributeValues(boolean unescapeAttributeValues) Deprecated. 1.8.1/05-23-2014 property moved to StandardAttributeRewriter This property still works, but only with StandardAttributeRewriter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

FERRET_DONE_KEY

public static final String FERRET_DONE_KEY

FERRET_IN_HEAD

protected static final String FERRET_IN_HEAD

See Also:

Constant Field Values

FERRET_HEAD_INSERTED

protected static final String FERRET_HEAD_INSERTED

See Also:

Constant Field Values

headInsertJsp

protected String headInsertJsp

Constructor Detail

FastArchivalUrlReplayParseEventHandler

public FastArchivalUrlReplayParseEventHandler()

Constructor...

Method Detail

init

public void init()
          throws IOException

Throws:

IOException

handleNode

public void handleNode(ParseContext pContext,
              org.htmlparser.Node node)
                throws IOException

Specified by:

handleNode in interface ParseEventHandler

Parameters:

pContext -

node -

Throws:

IOException

checkAllowTag

protected boolean checkAllowTag(ParseContext context,
                    org.htmlparser.nodes.TagNode tagNode)

emit

protected void emit(ReplayParseContext context,
        String pre,
        org.htmlparser.Node node,
        String post)
             throws IOException

Throws:

IOException

handleParseComplete

public void handleParseComplete(ParseContext pContext)
                         throws IOException

Specified by:

handleParseComplete in interface ParseEventHandler

Parameters:

pContext -

Throws:

IOException

handleParseStart

public void handleParseStart(ParseContext pContext)
                      throws IOException

Specified by:

handleParseStart in interface ParseEventHandler

Parameters:

pContext -

Throws:

IOException

setAttributeRewriter

public void setAttributeRewriter(AttributeRewriter attributeRewriter)

set AttributeRewriter for rewriting attribute values. if not set, StandardAttributeRewriter will be used as default.

Parameters:

attributeRewriter - AttributeRewriter instance.

getAttributeRewriter

public AttributeRewriter getAttributeRewriter()

getJspInsertPath

public String getJspInsertPath()

Returns:

the jspInsertPath

setJspInsertPath

public void setJspInsertPath(String jspInsertPath)

Parameters:

jspInsertPath - the jspInsertPath to set

getCommentJsp

public String getCommentJsp()

Deprecated. use getEndJsp()

Returns:

the commentJsp

setCommentJsp

public void setCommentJsp(String commentJsp)

Deprecated. use setEndJsp()

Parameters:

commentJsp - the commentJsp to set

getStartsp

public String getStartsp()

Returns:

the path to the JSP to execute and include at the start of the document

setStartJsp

public void setStartJsp(String startJsp)

Parameters:

startJsp - The path to the JSP to execute and include at the start of the document

getEndJsp

public String getEndJsp()

Returns:

the path to the JSP to execute and include at the end of the document

setEndJsp

public void setEndJsp(String endJsp)

Parameters:

endJsp - the path to the JSP to execute and include at the end of the document

getJsBlockTrans

public StringTransformer getJsBlockTrans()

Returns:

the jsBlockTrans

setJsBlockTrans

public void setJsBlockTrans(StringTransformer jsBlockTrans)

StringTransformer used for rewriting JavaScript code block (<SCRIPT> and javascript: attribute). Also used (abused) as a test whether particular <SCRIPT SRC=...> should be disabled (See class-level javadoc for details).

Parameters:

jsBlockTrans - the jsBlockTrans to set

getHeadInsertJsp

public String getHeadInsertJsp()

setHeadInsertJsp

public void setHeadInsertJsp(String headInsertJsp)

servlet whose output will be inserted right after HEAD tag.

Parameters:

headInsertJsp - context-relative path

emitHeadInsert

protected void emitHeadInsert(ReplayParseContext context,
                  org.htmlparser.Node node,
                  boolean postInsert)
                       throws IOException

Throws:

IOException

bodyInsertContent

protected String bodyInsertContent(ReplayParseContext context)

return body-insert text.

Run jspInsertPath and return its output as String. if jspInsertPath is null, or body-insert should not be inserted into the resource being processed, returns null.

Parameters:

context - context for the resource being processed

Returns:

insert text as String, or null if no insertion shall be made.

isUnescapeAttributeValues

public boolean isUnescapeAttributeValues()

Deprecated. 1.8.1/05-23-2014 moved to StandardAttributeRewriter.

Returns:

true if attribute value unescape/re-escape is enabled.

setUnescapeAttributeValues

public void setUnescapeAttributeValues(boolean unescapeAttributeValues)

Deprecated. 1.8.1/05-23-2014 property moved to StandardAttributeRewriter This property still works, but only with StandardAttributeRewriter.

set this property false if you want to disable unescaping (and corresponding re-escaping) of attribute values.

By default, HTML entities (such as &) in attribute values are unescaped before translation attempt, and then escaped back before writing out. Although this is supposedly the right thing to do, it has a side-effect: all bare "&" (not escaped as "&") will be replaced by "&". Setting this property to false disables it.

As URL rewrite does neither parse nor modify query part, it should mostly work without unescaping. But there may be some corner cases where escaping is crucial. Don't set this to false unless it's absolutely necessary.

Parameters:

unescapeAttributeValues - false to disable unescaping