freenet.client.filter

Class HTMLFilter

java.lang.Object

freenet.client.filter.HTMLFilter

All Implemented Interfaces:

CharsetExtractor, ContentDataFilter

public class HTMLFilter
extends java.lang.Object
implements ContentDataFilter, CharsetExtractor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HTMLFilter.ParsedTag

Nested classes/interfaces inherited from interface freenet.client.filter.CharsetExtractor

CharsetExtractor.BOMDetection

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	embedM3uPlayer if true, embed m3u player.
static int	metaRefreshRedirectMinInterval -1 means don't allow it
static int	metaRefreshSamePageMinInterval -1 means don't allow it

Constructor Summary

Constructors

Constructor and Description
HTMLFilter()

Method Summary

Modifier and Type	Method and Description
static java.util.Set<java.lang.String>	getAllowedHTMLTags()
java.lang.String	getCharset(byte[] input, int length, java.lang.String parseCharset)
int	getCharsetBufferSize() How many bytes must be fed into the CharsetExtractor to figure out the charset
CharsetExtractor.BOMDetection	getCharsetByBOM(byte[] input, int length) Inspect the first few bytes of the file for any obvious but type-specific BOM.
void	readFilter(java.io.InputStream input, java.io.OutputStream output, java.lang.String charset, java.util.Map<java.lang.String,java.lang.String> otherParams, java.lang.String schemeHostAndPort, FilterCallback cb) Filter data for reading.
static java.lang.String[]	splitType(java.lang.String type)

Methods inherited from class java.lang.Object

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

Methods inherited from interface freenet.client.filter.ContentDataFilter

readFilter

Field Detail

embedM3uPlayer

public static boolean embedM3uPlayer

if true, embed m3u player. Enabled when fproxy javascript is enabled.

metaRefreshSamePageMinInterval

public static int metaRefreshSamePageMinInterval

-1 means don't allow it

metaRefreshRedirectMinInterval

public static int metaRefreshRedirectMinInterval

-1 means don't allow it

Constructor Detail

HTMLFilter

public HTMLFilter()

Method Detail

readFilter

public void readFilter(java.io.InputStream input,
                       java.io.OutputStream output,
                       java.lang.String charset,
                       java.util.Map<java.lang.String,java.lang.String> otherParams,
                       java.lang.String schemeHostAndPort,
                       FilterCallback cb)
                throws DataFilterException,
                       java.io.IOException

Description copied from interface: ContentDataFilter

Filter data for reading. Objective is to ensure the data is safe if rendered by e.g. a web browser, and to guarantee that it is of the correct type. Filters should usually be implemented as "white list", that is, they should parse everything, and when encountering anything they cannot parse, should delete it, or throw a DataFilterException. IMPORTANT Implementation note: The InputStream may be a PipedInputStream (or conceivably even a network stream). Implementations MUST NOT ASSUME that input.available() == 0 => EOF!

Specified by:

readFilter in interface ContentDataFilter

Parameters:

input - Stream to read potentially unsafe data from.

output - Stream to write safe (but possibly incomplete) data to.

charset - Character set of the data if appropriate for this MIME type.

otherParams - Other type parameters if appropriate.

schemeHostAndPort - Scheme, host and port of the node as seen in the request.

cb - Filter callback for modifying HTML tags. Irrelevant for most MIME types. In future we might need this for other types.

Throws:

DataFilterException - If the data cannot be filtered. Any data written so far should be discarded if possible.

java.io.IOException - If there was a failure to read from the input data or write to the output data. Implementations should not throw this if data is merely badly formatted - any such exceptions should be caught and converted to a DataFilterException.

getCharset

public java.lang.String getCharset(byte[] input,
                                   int length,
                                   java.lang.String parseCharset)
                            throws DataFilterException,
                                   java.io.IOException

Specified by:

getCharset in interface CharsetExtractor

Throws:

DataFilterException

java.io.IOException

getAllowedHTMLTags

public static java.util.Set<java.lang.String> getAllowedHTMLTags()

splitType

public static java.lang.String[] splitType(java.lang.String type)

getCharsetByBOM

public CharsetExtractor.BOMDetection getCharsetByBOM(byte[] input,
                                                     int length)
                                              throws DataFilterException

Description copied from interface: CharsetExtractor

Inspect the first few bytes of the file for any obvious but type-specific BOM. Don't try too hard, if we don't find anything we will call getCharset() with some specific charset families to try.

Specified by:

getCharsetByBOM in interface CharsetExtractor

Parameters:

input - The data.

Returns:

The BOM-detected charset family, this is essentially a guess which will have to be fed to getCharset(). (A true BOM would give an exact match, but the caller will have already tested for true BOMs by this point; we are looking for "@charset \"" encoded with the given format)

Throws:

DataFilterException

getCharsetBufferSize

public int getCharsetBufferSize()

Description copied from interface: CharsetExtractor

How many bytes must be fed into the CharsetExtractor to figure out the charset

Specified by:

getCharsetBufferSize in interface CharsetExtractor