freenet.clients.http

Class SimpleToadletServer

java.lang.Object

freenet.clients.http.SimpleToadletServer

All Implemented Interfaces:

LinkFilterExceptionProvider, ToadletContainer, java.lang.Runnable

public final class SimpleToadletServer
extends java.lang.Object
implements ToadletContainer, java.lang.Runnable, LinkFilterExceptionProvider

The Toadlet (HTTP) Server Provide a HTTP server for FProxy

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SimpleToadletServer.SocketHandler

Field Summary

Fields

Modifier and Type	Field and Description
BookmarkManager	bookmarkManager
static int	DEFAULT_FPROXY_PORT
IntervalPusherManager	intervalPushManager The IntervalPusherManager handles interval pushing
PushDataManager	pushDataManager The PushDataManager handles all the pushing tasks
StartupToadlet	startupToadlet

Constructor Summary

Constructors

Constructor and Description
SimpleToadletServer(SubConfig fproxyConfig, BucketFactory bucketFactory, Executor executor, Node node) Create a SimpleToadletServer, using the settings from the SubConfig (the fproxy.* config).

Method Summary

Modifier and Type	Method and Description
HTMLNode	addFormChild(HTMLNode parentNode, java.lang.String target, java.lang.String id)
boolean	allowPosts() Can we deal with POSTs yet?
void	createFproxy()
boolean	disableProgressPage()
boolean	doRobots() Whether to tell spiders to go away
boolean	enableActivelinks()
boolean	enableCachingForChkAndSskKeys()
boolean	enableExtendedMethodHandling()
void	enableFProxyJavascript(boolean b)
void	enableFProxyWebPushing(boolean b)
boolean	enableInlinePrefetch()
boolean	enablePersistentConnections()
Toadlet	findToadlet(java.net.URI uri) Find a Toadlet by URI.
void	finishStart()
boolean	fproxyHasCompletedWizard()
long	generateUniqueID() Create a unique ID for a ToadletContext
BookmarkManager	getBookmarks()
FreenetURI[]	getBookmarkURIs()
BucketFactory	getBucketFactory() Get the BucketFactory
NodeClientCore	getCore()
java.lang.String	getFormPassword() Get the form password
java.io.File	getOverrideFile()
PageMaker	getPageMaker()
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.
StartupToadlet	getStartupToadlet()
PageMaker.THEME	getTheme() Get the name of the theme to be used by all the Toadlets
Ticker	getTicker()
java.lang.String	getURL()
java.lang.String	getURL(java.lang.String host)
UserAlertManager	getUserAlertManager()
boolean	isAdvancedModeEnabled()
boolean	isAllowedFullAccess(java.net.InetAddress remoteAddr) Is the given IP address allowed full access to the node?
boolean	isEnabled()
boolean	isFProxyJavascriptEnabled()
boolean	isFProxyWebPushingEnabled()
boolean	isLinkExcepted(java.net.URI link) Returns whether the given should be excepted from being filtered.
boolean	isSSL()
boolean	publicGatewayMode() Was public-gateway mode enabled on startup? (Changing it won't take effect until restart because of bookmark-related issues).
void	register(Toadlet t, java.lang.String menu, java.lang.String urlPrefix, boolean atFront, boolean fullOnly) Register a Toadlet.
void	register(Toadlet t, java.lang.String menu, java.lang.String urlPrefix, boolean atFront, java.lang.String name, java.lang.String title, boolean fullOnly, LinkEnabledCallback cb) Registers a Toadlet and optionally adds a navigation link to the menu.
void	register(Toadlet t, java.lang.String menu, java.lang.String urlPrefix, boolean atFront, java.lang.String name, java.lang.String title, boolean fullOnly, LinkEnabledCallback cb, FredPluginL10n l10n) Registers a Toadlet and optionally adds a navigation link to the menu.
void	registerMenu(java.lang.String link, java.lang.String name, java.lang.String title, FredPluginL10n plugin)
void	removeStartupToadlet()
void	run()
boolean	sendAllThemes()
void	setAdvancedMode(boolean enabled)
void	setBucketFactory(BucketFactory tempBucketFactory)
void	setCore(NodeClientCore core)
void	setCSSName(PageMaker.THEME theme)
void	start()
void	unregister(Toadlet t)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FPROXY_PORT

public static final int DEFAULT_FPROXY_PORT

See Also:

Constant Field Values

bookmarkManager

public BookmarkManager bookmarkManager

pushDataManager

public PushDataManager pushDataManager

The PushDataManager handles all the pushing tasks

intervalPushManager

public IntervalPusherManager intervalPushManager

The IntervalPusherManager handles interval pushing

startupToadlet

public StartupToadlet startupToadlet

Constructor Detail

SimpleToadletServer

public SimpleToadletServer(SubConfig fproxyConfig,
                           BucketFactory bucketFactory,
                           Executor executor,
                           Node node)
                    throws java.io.IOException,
                           InvalidConfigValueException

Create a SimpleToadletServer, using the settings from the SubConfig (the fproxy.* config).

Throws:

java.io.IOException

InvalidConfigValueException

Method Detail

createFproxy

public void createFproxy()

setCore

public void setCore(NodeClientCore core)

removeStartupToadlet

public void removeStartupToadlet()

doRobots

public boolean doRobots()

Description copied from interface: ToadletContainer

Whether to tell spiders to go away

Specified by:

doRobots in interface ToadletContainer

publicGatewayMode

public boolean publicGatewayMode()

Description copied from interface: ToadletContainer

Was public-gateway mode enabled on startup? (Changing it won't take effect until restart because of bookmark-related issues). If so, users with full access will still be able to configure the node etc, but everyone else will not have access to the download queue or anything else that might conceivably result in a DoS.

Specified by:

publicGatewayMode in interface ToadletContainer

start

public void start()

finishStart

public void finishStart()

register

public void register(Toadlet t,
                     java.lang.String menu,
                     java.lang.String urlPrefix,
                     boolean atFront,
                     boolean fullOnly)

Description copied from interface: ToadletContainer

Register a Toadlet. All requests whose URL starts with the given prefix will be passed to this toadlet.

Specified by:

register in interface ToadletContainer

Parameters:

t - the toadlet to register

menu - the menu category to register a navigation link with with. It is most likely also a l10n key, though that is irrelevant to this method.

urlPrefix - the prefix that the Toadlet will serve; should be a path like /foo/bar/baz, most likely the string returned by the toadlet's path() method

atFront - If true, this Toadlet will take precedence over any other previously-registered Toadlet whose urlPrefix also matches. Otherwise, the other matching Toadlet is used instead.

register

public void register(Toadlet t,
                     java.lang.String menu,
                     java.lang.String urlPrefix,
                     boolean atFront,
                     java.lang.String name,
                     java.lang.String title,
                     boolean fullOnly,
                     LinkEnabledCallback cb)

Description copied from interface: ToadletContainer

Registers a Toadlet and optionally adds a navigation link to the menu. All requests whose URL starts with the given prefix will be given to this Toadlet. If either the menu or the name parameter is null, then no navigation link is be registered for the Toadlet and the title, fullOnly, cb, and l10n parameters are ignored.

Specified by:

register in interface ToadletContainer

Parameters:

t - the toadlet to register

menu - the menu category to register a navigation link with with. It is most likely also a l10n key, though that is irrelevant to this method.

urlPrefix - the prefix that the Toadlet will serve; should be a path like /foo/bar/baz, most likely the string returned by the toadlet's path() method

atFront - If true, this Toadlet will take precedence over any other previously-registered Toadlet whose urlPrefix also matches. Otherwise, the other matching Toadlet is used instead.

name - A l10n key used for the navigation link label.

title - A l10n key used for the navigation link tooltip.

fullOnly - Whether or not the navigation link is shown when the http client does not have full security access. Note that passing false does not prevent the Toadlet from receiving requests under urlPrefix, so Toadlet authors are advised to check for full access themselves, possibly returning a 403 error code.

cb - A LinkEnabledCalback, allowing fine control of when the navigation link is visible and when it isn't. Passing null means it is always visible.

register

public void register(Toadlet t,
                     java.lang.String menu,
                     java.lang.String urlPrefix,
                     boolean atFront,
                     java.lang.String name,
                     java.lang.String title,
                     boolean fullOnly,
                     LinkEnabledCallback cb,
                     FredPluginL10n l10n)

Description copied from interface: ToadletContainer

Registers a Toadlet and optionally adds a navigation link to the menu. All requests whose URL starts with the given prefix will be given to this Toadlet. If either the menu or the name parameter is null, then no navigation link is be registered for the Toadlet and the title, fullOnly, cb, and l10n parameters are ignored.

Specified by:

register in interface ToadletContainer

Parameters:

t - the toadlet to register

menu - the menu category to register a navigation link with with. It is most likely also a l10n key, though that is irrelevant to this method.

urlPrefix - the prefix that the Toadlet will serve; should be a path like /foo/bar/baz, most likely the string returned by the toadlet's path() method

atFront - If true, this Toadlet will take precedence over any other previously-registered Toadlet whose urlPrefix also matches. Otherwise, the other matching Toadlet is used instead.

name - A l10n key used for the navigation link label.

title - A l10n key used for the navigation link tooltip.

fullOnly - Whether or not the navigation link is shown when the http client does not have full security access. Note that passing false does not prevent the Toadlet from receiving requests under urlPrefix, so Toadlet authors are advised to check for full access themselves, possibly returning a 403 error code.

cb - A LinkEnabledCalback, allowing fine control of when the navigation link is visible and when it isn't. Passing null means it is always visible.

l10n - A FredPluginL10n instance for translating the name and title parameters. May be null.

registerMenu

public void registerMenu(java.lang.String link,
                         java.lang.String name,
                         java.lang.String title,
                         FredPluginL10n plugin)

unregister

public void unregister(Toadlet t)

Specified by:

unregister in interface ToadletContainer

getStartupToadlet

public StartupToadlet getStartupToadlet()

fproxyHasCompletedWizard

public boolean fproxyHasCompletedWizard()

Specified by:

fproxyHasCompletedWizard in interface ToadletContainer

findToadlet

public Toadlet findToadlet(java.net.URI uri)
                    throws PermanentRedirectException

Description copied from interface: ToadletContainer

Find a Toadlet by URI.

Specified by:

findToadlet in interface ToadletContainer

Throws:

PermanentRedirectException

run

public void run()

Specified by:

run in interface java.lang.Runnable

getTheme

public PageMaker.THEME getTheme()

Description copied from interface: ToadletContainer

Get the name of the theme to be used by all the Toadlets

Specified by:

getTheme in interface ToadletContainer

getUserAlertManager

public UserAlertManager getUserAlertManager()

setCSSName

public void setCSSName(PageMaker.THEME theme)

sendAllThemes

public boolean sendAllThemes()

Specified by:

sendAllThemes in interface ToadletContainer

isAdvancedModeEnabled

public boolean isAdvancedModeEnabled()

Specified by:

isAdvancedModeEnabled in interface ToadletContainer

setAdvancedMode

public void setAdvancedMode(boolean enabled)

Specified by:

setAdvancedMode in interface ToadletContainer

isFProxyJavascriptEnabled

public boolean isFProxyJavascriptEnabled()

Specified by:

isFProxyJavascriptEnabled in interface ToadletContainer

enableFProxyJavascript

public void enableFProxyJavascript(boolean b)

isFProxyWebPushingEnabled

public boolean isFProxyWebPushingEnabled()

Specified by:

isFProxyWebPushingEnabled in interface ToadletContainer

enableFProxyWebPushing

public void enableFProxyWebPushing(boolean b)

getFormPassword

public java.lang.String getFormPassword()

Description copied from interface: ToadletContainer

Get the form password

Specified by:

getFormPassword in interface ToadletContainer

isAllowedFullAccess

public boolean isAllowedFullAccess(java.net.InetAddress remoteAddr)

Description copied from interface: ToadletContainer

Is the given IP address allowed full access to the node?

Specified by:

isAllowedFullAccess in interface ToadletContainer

addFormChild

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

Specified by:

addFormChild in interface ToadletContainer

setBucketFactory

public void setBucketFactory(BucketFactory tempBucketFactory)

isEnabled

public boolean isEnabled()

getBookmarks

public BookmarkManager getBookmarks()

getBookmarkURIs

public FreenetURI[] getBookmarkURIs()

enablePersistentConnections

public boolean enablePersistentConnections()

Specified by:

enablePersistentConnections in interface ToadletContainer

enableInlinePrefetch

public boolean enableInlinePrefetch()

Specified by:

enableInlinePrefetch in interface ToadletContainer

enableExtendedMethodHandling

public boolean enableExtendedMethodHandling()

Specified by:

enableExtendedMethodHandling in interface ToadletContainer

enableCachingForChkAndSskKeys

public boolean enableCachingForChkAndSskKeys()

Specified by:

enableCachingForChkAndSskKeys in interface ToadletContainer

allowPosts

public boolean allowPosts()

Description copied from interface: ToadletContainer

Can we deal with POSTs yet?

Specified by:

allowPosts in interface ToadletContainer

getBucketFactory

public BucketFactory getBucketFactory()

Description copied from interface: ToadletContainer

Get the BucketFactory

Specified by:

getBucketFactory in interface ToadletContainer

enableActivelinks

public boolean enableActivelinks()

Specified by:

enableActivelinks in interface ToadletContainer

disableProgressPage

public boolean disableProgressPage()

Specified by:

disableProgressPage in interface ToadletContainer

getPageMaker

public PageMaker getPageMaker()

Specified by:

getPageMaker in interface ToadletContainer

getTicker

public Ticker getTicker()

getCore

public NodeClientCore getCore()

getReFilterPolicy

public FProxyFetchInProgress.REFILTER_POLICY getReFilterPolicy()

Description copied from interface: ToadletContainer

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 ToadletContainer

getOverrideFile

public java.io.File getOverrideFile()

Specified by:

getOverrideFile in interface ToadletContainer

getURL

public java.lang.String getURL()

Specified by:

getURL in interface ToadletContainer

getURL

public java.lang.String getURL(java.lang.String host)

Specified by:

getURL in interface ToadletContainer

isSSL

public boolean isSSL()

Specified by:

isSSL in interface ToadletContainer

isLinkExcepted

public boolean isLinkExcepted(java.net.URI link)

Returns whether the given should be excepted from being filtered.

Specified by:

isLinkExcepted in interface LinkFilterExceptionProvider

Parameters:

link - The link to check

Returns:

true if the link should not be filtered, false if it should be filtered

generateUniqueID

public long generateUniqueID()

Description copied from interface: ToadletContainer

Create a unique ID for a ToadletContext

Specified by:

generateUniqueID in interface ToadletContainer