freenet.clients.http

Class ToadletContextImpl

java.lang.Object

freenet.clients.http.ToadletContextImpl

All Implemented Interfaces:

ToadletContext

public class ToadletContextImpl
extends java.lang.Object
implements ToadletContext

ToadletContext implementation, including all the icky HTTP parsing etc. An actual ToadletContext object represents a request, after we have parsed the headers. It provides methods to send replies.

Constructor Summary

Constructors

Constructor and Description
ToadletContextImpl(java.net.Socket sock, MultiValueTable<java.lang.String,java.lang.String> headers, BucketFactory bf, PageMaker pageMaker, ToadletContainer container, UserAlertManager userAlertManager, BookmarkManager bookmarkManager, java.net.URI uri, long uniqueID)

Method Summary

Modifier and Type	Method and Description
Toadlet	activeToadlet()
HTMLNode	addFormChild(HTMLNode parentNode, java.lang.String target, java.lang.String name) Add a form node to an HTMLNode under construction.
boolean	checkFormPassword(HTTPRequest request) Check a request for the form password, and send an error to the client if the password is not valid.
boolean	checkFormPassword(HTTPRequest request, java.lang.String redirectTo) Check a request for the form password, and send an error to the client if the password is not valid.
boolean	checkFullAccess(Toadlet toadlet) Check a context for whether ToadletContext.isAllowedFullAccess() is true.
boolean	disableProgressPage()
boolean	doRobots() Return a robots.txt excluding all spiders and other non-browser HTTP clients?
void	forceDisconnect() Force a disconnection after handling this request.
UserAlertManager	getAlertManager() Get the user alert manager.
BookmarkManager	getBookmarkManager() Get the bookmark manager.
BucketFactory	getBucketFactory()
ToadletContainer	getContainer()
ReceivedCookie	getCookie(java.net.URI domain, java.net.URI path, java.lang.String name) Get an existing Cookie (sent by the client) from the headers.
java.lang.String	getFormPassword() Get the form password required for "dangerous" operations.
MultiValueTable<java.lang.String,java.lang.String>	getHeaders()
PageMaker	getPageMaker() Get the page maker object.
FProxyFetchInProgress.REFILTER_POLICY	getReFilterPolicy() What to do when we find cached data on the global queue but it's already been filtered, and we want a filtered copy.
java.lang.String	getUniqueId() Returns the unique id of this request
java.net.URI	getUri()
static void	handle(java.net.Socket sock, ToadletContainer container, PageMaker pageMaker, UserAlertManager userAlertManager, BookmarkManager bookmarkManager) Handle an incoming connection.
boolean	hasFormPassword(HTTPRequest request) Check a request for the form password.
boolean	isAdvancedModeEnabled() Is the web interface in advanced mode?
boolean	isAllowedFullAccess() Is this Toadlet allowed full access to the node, including the ability to reconfigure it, restart it etc?
static java.util.Date	parseHTTPDate(java.lang.String httpDate)
void	sendReplyHeaders(int code, java.lang.String desc, MultiValueTable<java.lang.String,java.lang.String> mvt, java.lang.String mimeType, long length) Write reply headers for generated content (web interface pages) and redirects etc.
void	sendReplyHeaders(int code, java.lang.String desc, MultiValueTable<java.lang.String,java.lang.String> mvt, java.lang.String mimeType, long length, boolean forceDisableJavascript) Write reply headers for generated content (web interface pages) and redirects etc.
void	sendReplyHeaders(int code, java.lang.String desc, MultiValueTable<java.lang.String,java.lang.String> mvt, java.lang.String mimeType, long length, java.util.Date mTime) Deprecated.
void	sendReplyHeadersFProxy(int replyCode, java.lang.String replyDescription, MultiValueTable<java.lang.String,java.lang.String> mvt, java.lang.String mimeType, long contentLength) Write reply headers for content downloaded from Freenet.
void	sendReplyHeadersStatic(int replyCode, java.lang.String replyDescription, MultiValueTable<java.lang.String,java.lang.String> mvt, java.lang.String mimeType, long contentLength, java.util.Date mTime) Write reply headers with a customised modification time for static content.
void	setCookie(Cookie newCookie) Set a Cookie, it will be sent with the reply headers to the client.
void	writeData(Bucket data) Write data from a bucket.
void	writeData(byte[] data) Convenience method that simply calls ToadletContext.writeData(byte[], int, int).
void	writeData(byte[] data, int offset, int length) Write data.

Methods inherited from class java.lang.Object

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

Constructor Detail

ToadletContextImpl

public ToadletContextImpl(java.net.Socket sock,
                          MultiValueTable<java.lang.String,java.lang.String> headers,
                          BucketFactory bf,
                          PageMaker pageMaker,
                          ToadletContainer container,
                          UserAlertManager userAlertManager,
                          BookmarkManager bookmarkManager,
                          java.net.URI uri,
                          long uniqueID)
                   throws java.io.IOException

Throws:

java.io.IOException

Method Detail

sendReplyHeaders

public void sendReplyHeaders(int code,
                             java.lang.String desc,
                             MultiValueTable<java.lang.String,java.lang.String> mvt,
                             java.lang.String mimeType,
                             long length)
                      throws ToadletContextClosedException,
                             java.io.IOException

Description copied from interface: ToadletContext

Write reply headers for generated content (web interface pages) and redirects etc.

Specified by:

sendReplyHeaders in interface ToadletContext

Parameters:

code - HTTP code.

desc - HTTP code description.

mvt - Any extra headers. Can be null.

mimeType - The MIME type of the reply.

length - The length of the reply.

Throws:

ToadletContextClosedException

java.io.IOException

sendReplyHeaders

public void sendReplyHeaders(int code,
                             java.lang.String desc,
                             MultiValueTable<java.lang.String,java.lang.String> mvt,
                             java.lang.String mimeType,
                             long length,
                             boolean forceDisableJavascript)
                      throws ToadletContextClosedException,
                             java.io.IOException

Description copied from interface: ToadletContext

Write reply headers for generated content (web interface pages) and redirects etc.

Specified by:

sendReplyHeaders in interface ToadletContext

Parameters:

code - HTTP code.

desc - HTTP code description.

mvt - Any extra headers. Can be null.

mimeType - The MIME type of the reply.

length - The length of the reply.

forceDisableJavascript - Disable javascript even if it is enabled for the web interface as a whole.

Throws:

ToadletContextClosedException

java.io.IOException

sendReplyHeaders

@Deprecated
public void sendReplyHeaders(int code,
                                         java.lang.String desc,
                                         MultiValueTable<java.lang.String,java.lang.String> mvt,
                                         java.lang.String mimeType,
                                         long length,
                                         java.util.Date mTime)
                                  throws ToadletContextClosedException,
                                         java.io.IOException

Deprecated.

Specified by:

sendReplyHeaders in interface ToadletContext

Throws:

ToadletContextClosedException

java.io.IOException

sendReplyHeadersStatic

public void sendReplyHeadersStatic(int replyCode,
                                   java.lang.String replyDescription,
                                   MultiValueTable<java.lang.String,java.lang.String> mvt,
                                   java.lang.String mimeType,
                                   long contentLength,
                                   java.util.Date mTime)
                            throws ToadletContextClosedException,
                                   java.io.IOException

Description copied from interface: ToadletContext

Write reply headers with a customised modification time for static content.

Specified by:

sendReplyHeadersStatic in interface ToadletContext

Parameters:

replyCode - HTTP code.

replyDescription - HTTP code description.

mvt - Any extra headers. Can be null.

mimeType - The MIME type of the reply.

contentLength - The length of the reply.

mTime - The modification time of the data being sent.

Throws:

ToadletContextClosedException

java.io.IOException

sendReplyHeadersFProxy

public void sendReplyHeadersFProxy(int replyCode,
                                   java.lang.String replyDescription,
                                   MultiValueTable<java.lang.String,java.lang.String> mvt,
                                   java.lang.String mimeType,
                                   long contentLength)
                            throws ToadletContextClosedException,
                                   java.io.IOException

Description copied from interface: ToadletContext

Write reply headers for content downloaded from Freenet. Progress bars etc are not content downloaded from Freenet, so are rendered using sendReplyHeaders(). For content downloaded from Freenet we send headers which absolutely forbid Javascript, even if it somehow got through the content filter.

Specified by:

sendReplyHeadersFProxy in interface ToadletContext

Parameters:

replyCode - HTTP code.

replyDescription - HTTP code description.

mvt - Any extra headers. Can be null.

mimeType - The MIME type of the reply.

contentLength - The length of the reply.

Throws:

ToadletContextClosedException

java.io.IOException

getPageMaker

public PageMaker getPageMaker()

Description copied from interface: ToadletContext

Get the page maker object.

Specified by:

getPageMaker in interface ToadletContext

getFormPassword

public java.lang.String getFormPassword()

Description copied from interface: ToadletContext

Get the form password required for "dangerous" operations.

Specified by:

getFormPassword in interface ToadletContext

checkFormPassword

public boolean checkFormPassword(HTTPRequest request)
                          throws ToadletContextClosedException,
                                 java.io.IOException

Description copied from interface: ToadletContext

Check a request for the form password, and send an error to the client if the password is not valid.

Specified by:

checkFormPassword in interface ToadletContext

Parameters:

request - The request to check.

Returns:

Whether the request contains a valid form password

Throws:

ToadletContextClosedException

java.io.IOException

checkFormPassword

public boolean checkFormPassword(HTTPRequest request,
                                 java.lang.String redirectTo)
                          throws ToadletContextClosedException,
                                 java.io.IOException

Description copied from interface: ToadletContext

Check a request for the form password, and send an error to the client if the password is not valid.

Specified by:

checkFormPassword in interface ToadletContext

Parameters:

request - The request to check.

redirectTo - The location to redirect to if the password is not set.

Returns:

Whether the request contains a valid form password

Throws:

ToadletContextClosedException

java.io.IOException

checkFullAccess

public boolean checkFullAccess(Toadlet toadlet)
                        throws ToadletContextClosedException,
                               java.io.IOException

Description copied from interface: ToadletContext

Check a context for whether ToadletContext.isAllowedFullAccess() is true. If it is false, an error page is sent to the client, and false is returned. You can then abort processing of the request.

Specified by:

checkFullAccess in interface ToadletContext

Returns:

The return value of ToadletContext.isAllowedFullAccess().

Throws:

ToadletContextClosedException - See Toadlet.sendUnauthorizedPage(ToadletContext)

java.io.IOException - See Toadlet.sendUnauthorizedPage(ToadletContext)

See Also:

ToadletContext.checkFullAccess(Toadlet)

hasFormPassword

public boolean hasFormPassword(HTTPRequest request)
                        throws java.io.IOException

Description copied from interface: ToadletContext

Check a request for the form password. Some Toadlet's will want to e.g. send a confirmation page using the submitted data if the form password isn't present.

Specified by:

hasFormPassword in interface ToadletContext

Throws:

java.io.IOException

getAlertManager

public UserAlertManager getAlertManager()

Description copied from interface: ToadletContext

Get the user alert manager.

Specified by:

getAlertManager in interface ToadletContext

getBookmarkManager

public BookmarkManager getBookmarkManager()

Description copied from interface: ToadletContext

Get the bookmark manager.

Specified by:

getBookmarkManager in interface ToadletContext

getHeaders

public MultiValueTable<java.lang.String,java.lang.String> getHeaders()

Specified by:

getHeaders in interface ToadletContext

getCookie

public ReceivedCookie getCookie(java.net.URI domain,
                                java.net.URI path,
                                java.lang.String name)
                         throws java.text.ParseException

Description copied from interface: ToadletContext

Get an existing Cookie (sent by the client) from the headers.

Specified by:

getCookie in interface ToadletContext

Throws:

java.text.ParseException

setCookie

public void setCookie(Cookie newCookie)

Description copied from interface: ToadletContext

Set a Cookie, it will be sent with the reply headers to the client.

Specified by:

setCookie in interface ToadletContext

parseHTTPDate

public static java.util.Date parseHTTPDate(java.lang.String httpDate)
                                    throws java.text.ParseException

Throws:

java.text.ParseException

handle

public static void handle(java.net.Socket sock,
                          ToadletContainer container,
                          PageMaker pageMaker,
                          UserAlertManager userAlertManager,
                          BookmarkManager bookmarkManager)

Handle an incoming connection. Blocking, obviously.

activeToadlet

public Toadlet activeToadlet()

Specified by:

activeToadlet in interface ToadletContext

writeData

public void writeData(byte[] data,
                      int offset,
                      int length)
               throws ToadletContextClosedException,
                      java.io.IOException

Description copied from interface: ToadletContext

Write data. Note you must send reply headers first.

Specified by:

writeData in interface ToadletContext

Throws:

ToadletContextClosedException

java.io.IOException

writeData

public void writeData(byte[] data)
               throws ToadletContextClosedException,
                      java.io.IOException

Description copied from interface: ToadletContext

Convenience method that simply calls ToadletContext.writeData(byte[], int, int).

Specified by:

writeData in interface ToadletContext

Parameters:

data - The data to write

Throws:

ToadletContextClosedException - if the context has already been closed

java.io.IOException - if an I/O error occurs

writeData

public void writeData(Bucket data)
               throws ToadletContextClosedException,
                      java.io.IOException

Description copied from interface: ToadletContext

Write data from a bucket. You must send reply headers first.

Specified by:

writeData in interface ToadletContext

Parameters:

data - The Bucket which contains the reply data. This function assumes ownership of the Bucket, calling free() on it when done. If this behavior is undesired, callers can wrap their Bucket in a NoFreeBucket.

Throws:

ToadletContextClosedException

java.io.IOException

See Also:

NoFreeBucket

getBucketFactory

public BucketFactory getBucketFactory()

Specified by:

getBucketFactory in interface ToadletContext

addFormChild

public HTMLNode addFormChild(HTMLNode parentNode,
                             java.lang.String target,
                             java.lang.String name)

Description copied from interface: ToadletContext

Add a form node to an HTMLNode under construction. This will have the correct enctype and formPassword set already, so all the caller needs to do is add its specific fields.

Specified by:

addFormChild in interface ToadletContext

Parameters:

parentNode - The parent HTMLNode.

target - Where the form should be POSTed to.

name - HTML name for the form for stylesheet/script access. Will be added as both id and name.

Returns:

The form HTMLNode.

isAllowedFullAccess

public boolean isAllowedFullAccess()

Description copied from interface: ToadletContext

Is this Toadlet allowed full access to the node, including the ability to reconfigure it, restart it etc?

Specified by:

isAllowedFullAccess in interface ToadletContext

isAdvancedModeEnabled

public boolean isAdvancedModeEnabled()

Description copied from interface: ToadletContext

Is the web interface in advanced mode?

Specified by:

isAdvancedModeEnabled in interface ToadletContext

doRobots

public boolean doRobots()

Description copied from interface: ToadletContext

Return a robots.txt excluding all spiders and other non-browser HTTP clients?

Specified by:

doRobots in interface ToadletContext

forceDisconnect

public void forceDisconnect()

Description copied from interface: ToadletContext

Force a disconnection after handling this request. Used only when a throwable was thrown and we don't know what the state of the connection is. FIXME we could handle this better by remembering whether headers have been sent, how long the attached data should be, how much data has been sent etc.

Specified by:

forceDisconnect in interface ToadletContext

getContainer

public ToadletContainer getContainer()

Specified by:

getContainer in interface ToadletContext

disableProgressPage

public boolean disableProgressPage()

Specified by:

disableProgressPage in interface ToadletContext

getUniqueId

public java.lang.String getUniqueId()

Description copied from interface: ToadletContext

Returns the unique id of this request

Specified by:

getUniqueId in interface ToadletContext

Returns:

The unique id

getUri

public java.net.URI getUri()

Specified by:

getUri in interface ToadletContext

getReFilterPolicy

public FProxyFetchInProgress.REFILTER_POLICY getReFilterPolicy()

Description copied from interface: ToadletContext

What to do when we find cached data on the global queue but it's already been filtered, and we want a filtered copy.

Specified by:

getReFilterPolicy in interface ToadletContext