org.archive.wayback.replay.html.transformer

Class JSStringTransformer

java.lang.Object

org.archive.wayback.replay.html.transformer.JSStringTransformer

All Implemented Interfaces:

StringTransformer

public class JSStringTransformer
extends Object
implements StringTransformer

Translates absolute URLs found in JavaScript code block.

Looks for http/https absolute URLs in JavaScript code and translates them with ReplayParseContext.contextualizeUrl(String).

You can customize the pattern for finding URLs with regex property. Regular expression must have at least one capturing group, and the first capturing group is assumed to enclose URL to be rewritten. (new feature 2014-04-22) Any matching text preceding and following the first group will be preserved in the output.

For example: if you want to replace protocol-relative URL in addition to regular full URL in JavaScript, you could use conservative regex like:

 "[\"']((?:https?:)?//(?:[^/]+@)?[^@:/]+(?:\\.[^@:/]+)+(?:[0-9]+)?)"
 

Note single/double quote preceding URL is preserved in 2014-04-22 version and on.

TODO: org.archive.wayback.archivalurl.ArchivalUrlJSReplayRenderer has similar code. can be consolidated, like ArchivalURLJSStringTransformerReplayRenderer?

May 1, 2014: slight design change: Now JSStringTransformer does not run it's own should-rewrite check and sends all matching text to ReplayParseContext.contextualizeUrl(String). More specifically it no longer be affected by rewriteHttpsOnly flag. This is a design choice to keep StringTransformer detached from replay mode knowledge and focus on find-and-replace URLs

Author:

brad

Constructor Summary

Constructors

Constructor and Description
JSStringTransformer()

Method Summary

Methods

Modifier and Type	Method and Description
String	getRegex()
void	setRegex(String regex) a regular expression for searching URLs in the target resource.
String	transform(ReplayParseContext context, String input) transforms text with certain rewrite rules.

Methods inherited from class java.lang.Object

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

Constructor Detail

JSStringTransformer

public JSStringTransformer()

Method Detail

setRegex

public void setRegex(String regex)

a regular expression for searching URLs in the target resource.

Parameters:

regex -

getRegex

public String getRegex()

transform

public String transform(ReplayParseContext context,
               String input)

Description copied from interface: StringTransformer

transforms text with certain rewrite rules.

Refactoring: change input type to CharSequence.

Specified by:

transform in interface StringTransformer

Parameters:

context - ReplayParseContext

input - text data to be transformed

Returns:

transformed text