freenet.client.filter

Class ContentFilter

java.lang.Object

freenet.client.filter.ContentFilter

public class ContentFilter
extends java.lang.Object

Freenet content filter. This doesn't actually do any filtering, it organizes everything and maintains the database.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ContentFilter.FilterStatus

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	HTML_MIME_TYPES The HTML mime types are defined here, to allow other modules to identify it

Constructor Summary

Constructors

Constructor and Description
ContentFilter()

Method Summary

Modifier and Type	Method and Description
static UnsafeContentTypeException	checkMIMEType(java.lang.String expectedMIME) Check whether we can safely handle a specific MIME type.
static java.lang.String	detectCharset(byte[] input, int length, FilterMIMEType handler, java.lang.String maybeCharset)
static ContentFilter.FilterStatus	filter(java.io.InputStream input, java.io.OutputStream output, java.lang.String typeName, java.lang.String maybeCharset, FilterCallback filterCallback) Deprecated.
static ContentFilter.FilterStatus	filter(java.io.InputStream input, java.io.OutputStream output, java.lang.String typeName, java.lang.String maybeCharset, java.lang.String schemeHostAndPort, FilterCallback filterCallback) Filter some data.
static ContentFilter.FilterStatus	filter(java.io.InputStream input, java.io.OutputStream output, java.lang.String typeName, java.net.URI baseURI, FoundURICallback cb, TagReplacerCallback trc, java.lang.String maybeCharset) Deprecated.
static ContentFilter.FilterStatus	filter(java.io.InputStream input, java.io.OutputStream output, java.lang.String typeName, java.net.URI baseURI, java.lang.String schemeHostAndPort, FoundURICallback cb, TagReplacerCallback trc, java.lang.String maybeCharset) Filter some data.
static ContentFilter.FilterStatus	filter(java.io.InputStream input, java.io.OutputStream output, java.lang.String typeName, java.net.URI baseURI, java.lang.String schemeHostAndPort, FoundURICallback cb, TagReplacerCallback trc, java.lang.String maybeCharset, LinkFilterExceptionProvider linkFilterExceptionProvider) Filter some data.
static FilterMIMEType	getMIMEType(java.lang.String mimeType)
static void	init()
static java.lang.String	mimeTypeForSrc(java.lang.String uriold)
static void	register(FilterMIMEType mimeType)
static boolean	startsWith(byte[] data, byte[] cmp, int length)
static java.lang.String	stripMIMEType(java.lang.String mimeType)

Methods inherited from class java.lang.Object

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

Field Detail

HTML_MIME_TYPES

public static final java.lang.String[] HTML_MIME_TYPES

The HTML mime types are defined here, to allow other modules to identify it

Constructor Detail

ContentFilter

public ContentFilter()

Method Detail

init

public static void init()

register

public static void register(FilterMIMEType mimeType)

stripMIMEType

public static java.lang.String stripMIMEType(java.lang.String mimeType)

getMIMEType

public static FilterMIMEType getMIMEType(java.lang.String mimeType)

filter

@Deprecated
public static ContentFilter.FilterStatus filter(java.io.InputStream input,
                                                            java.io.OutputStream output,
                                                            java.lang.String typeName,
                                                            java.net.URI baseURI,
                                                            FoundURICallback cb,
                                                            TagReplacerCallback trc,
                                                            java.lang.String maybeCharset)
                                                     throws UnsafeContentTypeException,
                                                            java.io.IOException

Deprecated.

Compatibility for plugins: passes schemeHostAndPort null.

Throws:

UnsafeContentTypeException

java.io.IOException

filter

public static ContentFilter.FilterStatus filter(java.io.InputStream input,
                                                java.io.OutputStream output,
                                                java.lang.String typeName,
                                                java.net.URI baseURI,
                                                java.lang.String schemeHostAndPort,
                                                FoundURICallback cb,
                                                TagReplacerCallback trc,
                                                java.lang.String maybeCharset)
                                         throws UnsafeContentTypeException,
                                                java.io.IOException

Filter some data.

Parameters:

input - Source stream to read data from

output - Stream to write filtered data to

typeName - MIME type for input data

schemeHostAndPort - HOST and PORT from the request

maybeCharset - MIME type of the referring document, as a hint, some types, such as CSS, will inherit it if no other data is available.

Returns:

Throws:

java.io.IOException - If an internal error involving s occurred.

UnsafeContentTypeException - If the MIME type is declared unsafe (e.g. pdf files)

java.lang.IllegalStateException - If data is invalid (e.g. corrupted file) and the filter have no way to recover.

filter

public static ContentFilter.FilterStatus filter(java.io.InputStream input,
                                                java.io.OutputStream output,
                                                java.lang.String typeName,
                                                java.net.URI baseURI,
                                                java.lang.String schemeHostAndPort,
                                                FoundURICallback cb,
                                                TagReplacerCallback trc,
                                                java.lang.String maybeCharset,
                                                LinkFilterExceptionProvider linkFilterExceptionProvider)
                                         throws UnsafeContentTypeException,
                                                java.io.IOException

Filter some data.

Parameters:

input - Source stream to read data from

output - Stream to write filtered data to

typeName - MIME type for input data

schemeHostAndPort - HOST and PORT from the request

maybeCharset - MIME type of the referring document, as a hint, some types, such as CSS, will inherit it if no other data is available.

Returns:

Throws:

java.io.IOException - If an internal error involving s occurred.

UnsafeContentTypeException - If the MIME type is declared unsafe (e.g. pdf files)

java.lang.IllegalStateException - If data is invalid (e.g. corrupted file) and the filter have no way to recover.

filter

@Deprecated
public static ContentFilter.FilterStatus filter(java.io.InputStream input,
                                                            java.io.OutputStream output,
                                                            java.lang.String typeName,
                                                            java.lang.String maybeCharset,
                                                            FilterCallback filterCallback)
                                                     throws UnsafeContentTypeException,
                                                            java.io.IOException

Deprecated.

Compatibility for plugins: passes schemeHostAndPort null.

Throws:

UnsafeContentTypeException

java.io.IOException

filter

public static ContentFilter.FilterStatus filter(java.io.InputStream input,
                                                java.io.OutputStream output,
                                                java.lang.String typeName,
                                                java.lang.String maybeCharset,
                                                java.lang.String schemeHostAndPort,
                                                FilterCallback filterCallback)
                                         throws UnsafeContentTypeException,
                                                java.io.IOException

Filter some data.

Parameters:

input - Source stream to read data from

output - Stream to write filtered data to

typeName - MIME type for input data

maybeCharset - MIME type of the referring document, as a hint, some types, such as CSS, will inherit it if no other data is available.

schemeHostAndPort - HOST and PORT from the request

Throws:

java.io.IOException - If an internal error involving buckets occurred.

UnsafeContentTypeException - If the MIME type is declared unsafe (e.g. pdf files)

java.lang.IllegalStateException - If data is invalid (e.g. corrupted file) and the filter have no way to recover.

detectCharset

public static java.lang.String detectCharset(byte[] input,
                                             int length,
                                             FilterMIMEType handler,
                                             java.lang.String maybeCharset)
                                      throws java.io.IOException

Throws:

java.io.IOException

startsWith

public static boolean startsWith(byte[] data,
                                 byte[] cmp,
                                 int length)

mimeTypeForSrc

public static java.lang.String mimeTypeForSrc(java.lang.String uriold)

checkMIMEType

public static UnsafeContentTypeException checkMIMEType(java.lang.String expectedMIME)

Check whether we can safely handle a specific MIME type. Usually called when we haven't downloaded the data yet so can't filter it, so we can know whether there will be problems later.

Returns:

An UnsafeContentTypeException if there is a problem.