freenet.client.filter

Class GenericReadFilterCallback

java.lang.Object

freenet.client.filter.GenericReadFilterCallback

All Implemented Interfaces:

FilterCallback, URIProcessor

public class GenericReadFilterCallback
extends java.lang.Object
implements FilterCallback, URIProcessor

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.HashSet<java.lang.String>	allowedProtocols
protected static java.lang.String	FRAGMENT
protected static java.lang.String	PCHAR
protected static java.lang.String	PCT_ENCODED
protected static java.lang.String	SUB_DELIMS
protected static java.lang.String	UNRESERVED

Constructor Summary

Constructors

Constructor and Description
GenericReadFilterCallback(FreenetURI uri, FoundURICallback cb, TagReplacerCallback trc, LinkFilterExceptionProvider linkFilterExceptionProvider)
GenericReadFilterCallback(java.net.URI uri, FoundURICallback cb, TagReplacerCallback trc, LinkFilterExceptionProvider linkFilterExceptionProvider)

Method Summary

Modifier and Type	Method and Description
java.lang.String	makeURIAbsolute(java.lang.String uri) Makes an URI absolute
java.lang.String	onBaseHref(java.lang.String baseHref) Process a base URI in the page.
void	onFinished()
void	onText(java.lang.String s, java.lang.String type) Process plain-text.
java.lang.String	processForm(java.lang.String method, java.lang.String action) Process a form.
java.lang.String	processTag(HTMLFilter.ParsedTag pt) Processes a tag.
java.lang.String	processURI(java.lang.String u, java.lang.String overrideType) Process a URI.
java.lang.String	processURI(java.lang.String u, java.lang.String overrideType, boolean forBaseHref, boolean inline) Process a URI.
java.lang.String	processURI(java.lang.String u, java.lang.String overrideType, java.lang.String forceSchemeHostAndPort, boolean inline) Process a URI forcing the host.

Methods inherited from class java.lang.Object

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

Field Detail

allowedProtocols

public static final java.util.HashSet<java.lang.String> allowedProtocols

UNRESERVED

protected static final java.lang.String UNRESERVED

See Also:

Constant Field Values

PCT_ENCODED

protected static final java.lang.String PCT_ENCODED

See Also:

Constant Field Values

SUB_DELIMS

protected static final java.lang.String SUB_DELIMS

See Also:

Constant Field Values

PCHAR

protected static final java.lang.String PCHAR

See Also:

Constant Field Values

FRAGMENT

protected static final java.lang.String FRAGMENT

See Also:

Constant Field Values

Constructor Detail

GenericReadFilterCallback

public GenericReadFilterCallback(java.net.URI uri,
                                 FoundURICallback cb,
                                 TagReplacerCallback trc,
                                 LinkFilterExceptionProvider linkFilterExceptionProvider)

GenericReadFilterCallback

public GenericReadFilterCallback(FreenetURI uri,
                                 FoundURICallback cb,
                                 TagReplacerCallback trc,
                                 LinkFilterExceptionProvider linkFilterExceptionProvider)

Method Detail

processURI

public java.lang.String processURI(java.lang.String u,
                                   java.lang.String overrideType)
                            throws CommentException

Description copied from interface: FilterCallback

Process a URI. If it cannot be turned into something sufficiently safe, then return null.

Specified by:

processURI in interface FilterCallback

overrideType - Force the return type.

Throws:

CommentException - If the URI is nvalid or unacceptable in some way.

processURI

public java.lang.String processURI(java.lang.String u,
                                   java.lang.String overrideType,
                                   boolean forBaseHref,
                                   boolean inline)
                            throws CommentException

Description copied from interface: FilterCallback

Process a URI. If it cannot be turned into something sufficiently safe, then return null.

Specified by:

processURI in interface FilterCallback

Specified by:

processURI in interface URIProcessor

overrideType - Force the return type.

forBaseHref - always turn into absolute URI, adding the baseUri if needed

inline - inline URIs may be prefetched while filtering

Throws:

CommentException - If the URI is nvalid or unacceptable in some way.

processURI

public java.lang.String processURI(java.lang.String u,
                                   java.lang.String overrideType,
                                   java.lang.String forceSchemeHostAndPort,
                                   boolean inline)
                            throws CommentException

Description copied from interface: FilterCallback

Process a URI forcing the host. If it cannot be turned into something sufficiently safe, then return null.

Specified by:

processURI in interface FilterCallback

overrideType - Force the return type.

inline - inline URIs may be prefetched while filtering

Throws:

CommentException - If the URI is nvalid or unacceptable in some way.

makeURIAbsolute

public java.lang.String makeURIAbsolute(java.lang.String uri)
                                 throws java.net.URISyntaxException

Description copied from interface: URIProcessor

Makes an URI absolute

Specified by:

makeURIAbsolute in interface URIProcessor

Parameters:

uri - - The uri to be absolutize

Returns:

The absolute URI

Throws:

java.net.URISyntaxException

onBaseHref

public java.lang.String onBaseHref(java.lang.String baseHref)

Description copied from interface: FilterCallback

Process a base URI in the page. Not only is this filtered, it affects all relative uri's on the page.

Specified by:

onBaseHref in interface FilterCallback

onText

public void onText(java.lang.String s,
                   java.lang.String type)

Description copied from interface: FilterCallback

Process plain-text. Notification only; can't modify. Type can be null, or can correspond, for example to HTML tag name around text (for example: "title"). Note that the string will have been fed through the relevant decoder if necessary (e.g. HTMLDecoder). It must be re-encoded if it is sent out as text to a browser.

Specified by:

onText in interface FilterCallback

processForm

public java.lang.String processForm(java.lang.String method,
                                    java.lang.String action)
                             throws CommentException

Process a form. Current strategy: - Both POST and GET forms are allowed to / Anything that is hazardous should be protected through formPassword.

Specified by:

processForm in interface FilterCallback

Parameters:

method - The form sending method. Normally GET or POST.

action - The URI to send the form to.

Returns:

The new action URI, or null if the form is not allowed.

Throws:

CommentException - If the form element could not be parsed and the user should be told.

processTag

public java.lang.String processTag(HTMLFilter.ParsedTag pt)

Processes a tag. It calls the TagReplacerCallback if present.

Specified by:

processTag in interface FilterCallback

Parameters:

pt - - The tag, that needs to be processed

Returns:

The replacement for the tag, or null, if no replacement needed

onFinished

public void onFinished()

Specified by:

onFinished in interface FilterCallback