org.archive.wayback.replay.html

Class ReplayParseContext

java.lang.Object

org.archive.wayback.util.htmllex.ParseContext

org.archive.wayback.replay.html.ReplayParseContext

public class ReplayParseContext
extends ParseContext

ReplayParseContext holds context information shared among replay rewriter components.

2014-05-02 small behavior/interface changes:

• setJspExec(JSPExecutor) no longer copies CaptureSearchResult object from its UIResults object to result member. Use new constructor taking CaptureSearchResult object (recommended), or use setCaptureSearchResult(CaptureSearchResult) method.

TODO: consider replacing CaptureSearchResult reference with Capture.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANCHOR_PREFIX
static String	DATA_PREFIX
static String	JAVASCRIPT_PREFIX

Fields inherited from class org.archive.wayback.util.htmllex.ParseContext

baseUrl

Constructor Summary

Constructors

Constructor and Description
ReplayParseContext(ContextResultURIConverterFactory uriConverterFactory, CaptureSearchResult result) Constructs ReplayParseContext for rewriting a resource represented by result.
ReplayParseContext(ContextResultURIConverterFactory uriConverterFactory, URL baseUrl, String datespec) Deprecated. 2014-05-02 use ReplayParseContext(ContextResultURIConverterFactory, CaptureSearchResult)

Method Summary

Methods

Modifier and Type	Method and Description
void	addConverter(String flag, ResultURIConverter converter)
String	contextualizeUrl(String url) Rewrite URL url in accordance with current replay mode, not using replay context flags.
String	contextualizeUrl(String url, String flags) Rewrite URL url in accordance with current replay mode, taking replay context flags into account.
CaptureSearchResult	getCaptureSearchResult() return CaptureSearchResult being rendered.
ResultURIConverter	getConverter(String flags) returns ResultURIConverter for resource context flags.
Map<String,ResultURIConverter>	getConverters()
String	getDatespec()
int	getJSBlockCount()
JSPExecutor	getJspExec()
String	getOutputCharset()
OutputStream	getOutputStream()
int	getPhase()
void	incJSBlockCount()
boolean	isRewriteSupported(String url) return true if url needs rewrite in this replay.
void	setCaptureSearchResult(CaptureSearchResult result) Deprecated. 2014-11-05 Pass it to constructor
void	setConverters(Map<String,ResultURIConverter> converters)
void	setDatespec(String datespec)
void	setJspExec(JSPExecutor jspExec)
void	setOutputCharset(String outputCharset)
void	setOutputStream(OutputStream outputStream)
void	setPhase(int phase)
void	setRewriteHttpsOnly(boolean rewriteHttpsOnly)

Methods inherited from class org.archive.wayback.util.htmllex.ParseContext

getData, getMap, getOraclePolicy, isInCSS, isInHTML, isInJS, isInScriptText, putData, resolve, setBaseUrl, setBaseUrl, setInCSS, setInHTML, setInJS, setInScriptText, setOraclePolicy

Methods inherited from class java.lang.Object

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

Field Detail

JAVASCRIPT_PREFIX

public static final String JAVASCRIPT_PREFIX

See Also:

Constant Field Values

DATA_PREFIX

public static final String DATA_PREFIX

See Also:

Constant Field Values

ANCHOR_PREFIX

public static final String ANCHOR_PREFIX

See Also:

Constant Field Values

Constructor Detail

ReplayParseContext

public ReplayParseContext(ContextResultURIConverterFactory uriConverterFactory,
                  CaptureSearchResult result)
                   throws IOException

Constructs ReplayParseContext for rewriting a resource represented by result.

Initializes baseUrl and datespec from result's originalUrl and captureTimestamp, respectively.

Parameters:

uriConverterFactory -

result -

Throws:

IOException

ReplayParseContext

public ReplayParseContext(ContextResultURIConverterFactory uriConverterFactory,
                  URL baseUrl,
                  String datespec)

Deprecated. 2014-05-02 use ReplayParseContext(ContextResultURIConverterFactory, CaptureSearchResult)

constructor. CaptureSearchResult needs to be set via setCaptureSearchResult(org.archive.wayback.core.CaptureSearchResult).

Parameters:

uriConverterFactory -

baseUrl -

datespec -

Method Detail

setPhase

public void setPhase(int phase)

getPhase

public int getPhase()

setRewriteHttpsOnly

public void setRewriteHttpsOnly(boolean rewriteHttpsOnly)

isRewriteSupported

public boolean isRewriteSupported(String url)

return true if url needs rewrite in this replay.

As contextualizeUrl(String, String) runs this test, there's no real point doing this check outside of ReplayParseContext. this method may be changed to protected in the future.

Parameters:

url - URL to test. it must be free of escaping (i.e. no "https:\/\/".)

Returns:

true if url needs rewrite.

See Also:

setRewriteHttpsOnly(boolean)

getConverters

public Map<String,ResultURIConverter> getConverters()

Returns:

the converters

getCaptureSearchResult

public CaptureSearchResult getCaptureSearchResult()

return CaptureSearchResult being rendered.

intended for selecting site-specific rewrite rules.

TODO: what's really needed is its urlKey. add a method for it for better encapsulation.

Returns:

CaptureSearchResult in replay mode, or null otherwise.

setCaptureSearchResult

public void setCaptureSearchResult(CaptureSearchResult result)

Deprecated. 2014-11-05 Pass it to constructor

Set capture being rendered.

Parameters:

result -

setConverters

public void setConverters(Map<String,ResultURIConverter> converters)

Parameters:

converters - the converters to set

addConverter

public void addConverter(String flag,
                ResultURIConverter converter)

getConverter

public ResultURIConverter getConverter(String flags)

returns ResultURIConverter for resource context flags.

Parameters:

flags - resource context indicator such as "cs_", "im_".

Returns:

ResultURIConverter for translating URL

contextualizeUrl

public String contextualizeUrl(String url)

Rewrite URL url in accordance with current replay mode, not using replay context flags.

Overrides:

contextualizeUrl in class ParseContext

Parameters:

url - URL, candidate for rewrite. may contain escaping. must not be null.

Returns:

rewrittenURL, or url if no rewrite is necessary. never null.

contextualizeUrl

public String contextualizeUrl(String url,
                      String flags)

Rewrite URL url in accordance with current replay mode, taking replay context flags into account.

It is important to return the same String object url if no rewrite is necessary, so that caller can short-circuit to avoid expensive String operations.

Parameters:

url - URL, candidate for rewrite. may contain escaping. must not be null.

flags - context designator, such as "cs_". can be null.

Returns:

rewrittenURL, or url if no rewrite is necessary. never null.

getOutputCharset

public String getOutputCharset()

Returns:

the charset

setOutputCharset

public void setOutputCharset(String outputCharset)

Parameters:

outputCharset - the outputCharset to set

getOutputStream

public OutputStream getOutputStream()

Returns:

the outputStream

setOutputStream

public void setOutputStream(OutputStream outputStream)

Parameters:

outputStream - the outputStream to set

getJspExec

public JSPExecutor getJspExec()

Returns:

the jspExec

setJspExec

public void setJspExec(JSPExecutor jspExec)

Parameters:

jspExec - the jspExec to set

getDatespec

public String getDatespec()

Returns:

the datespec

setDatespec

public void setDatespec(String datespec)

Parameters:

datespec - the datespec to set

incJSBlockCount

public void incJSBlockCount()

getJSBlockCount

public int getJSBlockCount()