Class WebPlugin

java.lang.Object

com.biglybt.ui.webplugin.WebPlugin

All Implemented Interfaces:

Plugin, TrackerWebPageGenerator

Direct Known Subclasses:

ManagerUtils.UnloadableWebPlugin, RSSGeneratorPlugin, SimpleAPIPlugin

public class WebPlugin
extends Object
implements Plugin, TrackerWebPageGenerator

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONFIG_ACCESS
String	CONFIG_ACCESS_DEFAULT
static final String	CONFIG_BIND_IP
String	CONFIG_BIND_IP_DEFAULT
static final String	CONFIG_ENABLE
boolean	CONFIG_ENABLE_DEFAULT
static final String	CONFIG_HOME_PAGE
String	CONFIG_HOME_PAGE_DEFAULT
static final String	CONFIG_I2P_ENABLE
boolean	CONFIG_I2P_ENABLE_DEFAULT
static final String	CONFIG_MODE
static final String	CONFIG_MODE_DEFAULT
static final String	CONFIG_MODE_FULL
private BasicPluginConfigModel	config_model
static final String	CONFIG_NO_PW_WHITELIST
static final String	CONFIG_NO_PW_WHITELIST_DEFAULT
static final String	CONFIG_PAIRING_AUTO_AUTH
static final boolean	CONFIG_PAIRING_AUTO_AUTH_DEFAULT
static final String	CONFIG_PAIRING_ENABLE
static final boolean	CONFIG_PAIRING_ENABLE_DEFAULT
static final String	CONFIG_PASSWORD
static final byte[]	CONFIG_PASSWORD_DEFAULT
static final String	CONFIG_PASSWORD_ENABLE
static final boolean	CONFIG_PASSWORD_ENABLE_DEFAULT
static final String	CONFIG_PORT
int	CONFIG_PORT_DEFAULT
static final String	CONFIG_PORT_OVERRIDE
static final String	CONFIG_PROTOCOL
static final String	CONFIG_PROTOCOL_DEFAULT
static final String	CONFIG_REVERSE_PROXY
boolean	CONFIG_REVERSE_PROXY_DEFAULT
static final String	CONFIG_ROOT_DIR
String	CONFIG_ROOT_DIR_DEFAULT
static final String	CONFIG_ROOT_RESOURCE
String	CONFIG_ROOT_RESOURCE_DEFAULT
static final String	CONFIG_TOR_ENABLE
boolean	CONFIG_TOR_ENABLE_DEFAULT
static final String	CONFIG_UPNP_ENABLE
boolean	CONFIG_UPNP_ENABLE_DEFAULT
static final String	CONFIG_USER
static final String	CONFIG_USER_DEFAULT
private File	file_root
private static final String	GRACE_PERIOD_MARKER
private String	home_page
private boolean	ip_range_all
private List<IPRange>	ip_ranges
private LoggerChannel	log
private static final int	LOGOUT_GRACE_MILLIS
private Map<String,Long>	logout_timer
private boolean	na_intf_listener_added
private static final AsyncDispatcher	network_dispatcher
protected static final String	NL
private StringParameter	p_no_pw_whitelist
private PasswordParameter	p_password
private BooleanParameter	p_reverse_proxy
private String	p_sid
private BooleanParameter	p_upnp_enable
private StringParameter	p_user_name
private String	pairing_access_code
private PairingManagerListener	pairing_listener
static final String	PAIRING_MIGRATED
private String	pairing_session_code
static final String	PAIRING_SESSION_KEY
private StringParameter	param_access
private BooleanParameter	param_auto_auth
private StringParameter	param_bind
private StringParameter	param_home
private InfoParameter	param_i2p_dest
private BooleanParameter	param_i2p_enable
private IntParameter	param_port
private IntParameter	param_port_or
private StringListParameter	param_protocol
private StringParameter	param_rootdir
private StringParameter	param_rootres
private InfoParameter	param_tor_dest
private BooleanParameter	param_tor_enable
private PluginConfig	plugin_config
private boolean	plugin_enabled
protected PluginInterface	plugin_interface
static final String	PR_ACCESS
static final String	PR_BIND_IP
static final String	PR_CONFIG_MODEL
static final String	PR_CONFIG_MODEL_PARAMS
static final String	PR_DISABLABLE
static final String	PR_ENABLE
static final String	PR_ENABLE_I2P
static final String	PR_ENABLE_KEEP_ALIVE
static final String	PR_ENABLE_PAIRING
static final String	PR_ENABLE_TOR
static final String	PR_ENABLE_UPNP
static final String	PR_HIDE_RESOURCE_CONFIG
static final String	PR_HOME_PAGE
static final String	PR_LOG
static final String	PR_NON_BLOCKING
static final String	PR_PAIRING_SID
static final String	PR_PORT
static final String	PR_REVERSE_PROXY
static final String	PR_ROOT_DIR
static final String	PR_ROOT_RESOURCE
static final String	PR_VIEW_MODEL
private Properties	properties
static final String	PROPERTIES_MIGRATED
private BooleanParameter	pw_enable
private String	resource_root
private String	root_dir
private boolean	setting_auto_auth
private static ThreadLocal<String>	tls
private TrackerWebContext	tracker_context
private boolean	unloaded
private UPnPMapping	upnp_mapping
private BasicPluginViewModel	view_model
protected static File[]	welcome_files
protected static final String[]	welcome_pages

Constructor Summary

Constructors

Constructor	Description
WebPlugin()
WebPlugin(Properties defaults)

Method Summary

Modifier and Type	Method	Description
boolean	generate(TrackerWebPageRequest request, TrackerWebPageResponse response)
private boolean	generate2(TrackerWebPageRequest request, TrackerWebPageResponse response, boolean is_tunnel)
boolean	generateSupport(TrackerWebPageRequest request, TrackerWebPageResponse response)
private String	getArgumentFromURL(URL url, String argument)
protected BasicPluginConfigModel	getConfigModel()
private String	getConnectionTestURL(String sid)
int	getPort()
String	getProtocol()
InetAddress	getServerBindIP()
int	getServerPort()
protected String	getServerURL()
protected BasicPluginViewModel	getViewModel()
private byte[]	handleTunnelRequest(InetAddress originator, String endpoint_url, byte[] request_bytes)
private boolean	hasOurCookie(String cookies)
void	initialize(PluginInterface _plugin_interface)	This method is called when the Plugin is loaded by the client
protected void	initStage(int num)
protected boolean	isPluginEnabled()
protected void	log(String str)
protected void	log(String str, Throwable e)
private void	recordAuthRequest(String client_ip, boolean good)
private void	recordRequest(TrackerWebPageRequest request, boolean good, boolean is_tunnel)
private boolean	returnJSON(TrackerWebPageResponse response, String str)
private boolean	returnStuff(TrackerWebPageResponse response, String content_type, String str)
private boolean	returnTextPlain(TrackerWebPageResponse response, String str)
private boolean	sameAddress(InetAddress a1, InetAddress a2)
private void	setupAccess()
protected void	setupAutoAuth()
protected void	setupPairing(String sid, boolean pairing_enabled)
private void	setupResources()
protected void	setupServer()
private void	setupSessionCode(String key)
protected void	setupUPnP()
void	setUserAndPassword(String user, String password)
protected void	unloadPlugin()
void	unsetUserAndPassword()
protected void	updatePairing(PairingConnectionData cd)
protected void	updatePairing(String sid, String reason)
protected boolean	useFile(TrackerWebPageRequest request, TrackerWebPageResponse response, File root, String relative_url)	this method can be over-ridden to handle custom file delivery
protected boolean	verifyReferrer()

Methods inherited from class Object

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

Methods inherited from interface Plugin

getInitialProperties

Field Details

PR_ENABLE

public static final String PR_ENABLE

See Also:

• Constant Field Values

PR_DISABLABLE

public static final String PR_DISABLABLE

See Also:

• Constant Field Values

PR_PORT

public static final String PR_PORT

See Also:

• Constant Field Values

PR_BIND_IP

public static final String PR_BIND_IP

See Also:

• Constant Field Values

PR_ROOT_RESOURCE

public static final String PR_ROOT_RESOURCE

See Also:

• Constant Field Values

PR_HOME_PAGE

public static final String PR_HOME_PAGE

See Also:

• Constant Field Values

PR_ROOT_DIR

public static final String PR_ROOT_DIR

See Also:

• Constant Field Values

PR_ACCESS

public static final String PR_ACCESS

See Also:

• Constant Field Values

PR_LOG

public static final String PR_LOG

See Also:

• Constant Field Values

PR_CONFIG_MODEL_PARAMS

public static final String PR_CONFIG_MODEL_PARAMS

See Also:

• Constant Field Values

PR_CONFIG_MODEL

public static final String PR_CONFIG_MODEL

See Also:

• Constant Field Values

PR_VIEW_MODEL

public static final String PR_VIEW_MODEL

See Also:

• Constant Field Values

PR_HIDE_RESOURCE_CONFIG

public static final String PR_HIDE_RESOURCE_CONFIG

See Also:

• Constant Field Values

PR_ENABLE_KEEP_ALIVE

public static final String PR_ENABLE_KEEP_ALIVE

See Also:

• Constant Field Values

PR_PAIRING_SID

public static final String PR_PAIRING_SID

See Also:

• Constant Field Values

PR_NON_BLOCKING

public static final String PR_NON_BLOCKING

See Also:

• Constant Field Values

PR_ENABLE_PAIRING

public static final String PR_ENABLE_PAIRING

See Also:

• Constant Field Values

PR_ENABLE_I2P

public static final String PR_ENABLE_I2P

See Also:

• Constant Field Values

PR_ENABLE_TOR

public static final String PR_ENABLE_TOR

See Also:

• Constant Field Values

PR_ENABLE_UPNP

public static final String PR_ENABLE_UPNP

See Also:

• Constant Field Values

PR_REVERSE_PROXY

public static final String PR_REVERSE_PROXY

See Also:

• Constant Field Values

PROPERTIES_MIGRATED

public static final String PROPERTIES_MIGRATED

See Also:

• Constant Field Values

PAIRING_MIGRATED

public static final String PAIRING_MIGRATED

See Also:

• Constant Field Values

PAIRING_SESSION_KEY

public static final String PAIRING_SESSION_KEY

See Also:

• Constant Field Values

CONFIG_PASSWORD_ENABLE

public static final String CONFIG_PASSWORD_ENABLE

See Also:

• Constant Field Values

CONFIG_PASSWORD_ENABLE_DEFAULT

public static final boolean CONFIG_PASSWORD_ENABLE_DEFAULT

See Also:

• Constant Field Values

CONFIG_NO_PW_WHITELIST

public static final String CONFIG_NO_PW_WHITELIST

See Also:

• Constant Field Values

CONFIG_NO_PW_WHITELIST_DEFAULT

public static final String CONFIG_NO_PW_WHITELIST_DEFAULT

See Also:

• Constant Field Values

CONFIG_PAIRING_ENABLE

public static final String CONFIG_PAIRING_ENABLE

See Also:

• Constant Field Values

CONFIG_PAIRING_ENABLE_DEFAULT

public static final boolean CONFIG_PAIRING_ENABLE_DEFAULT

See Also:

• Constant Field Values

CONFIG_PORT_OVERRIDE

public static final String CONFIG_PORT_OVERRIDE

See Also:

• Constant Field Values

CONFIG_PAIRING_AUTO_AUTH

public static final String CONFIG_PAIRING_AUTO_AUTH

See Also:

• Constant Field Values

CONFIG_PAIRING_AUTO_AUTH_DEFAULT

public static final boolean CONFIG_PAIRING_AUTO_AUTH_DEFAULT

See Also:

• Constant Field Values

CONFIG_ENABLE

public static final String CONFIG_ENABLE

See Also:

• Constant Field Values

CONFIG_ENABLE_DEFAULT

public boolean CONFIG_ENABLE_DEFAULT

CONFIG_USER

public static final String CONFIG_USER

See Also:

• Constant Field Values

CONFIG_USER_DEFAULT

public static final String CONFIG_USER_DEFAULT

See Also:

• Constant Field Values

CONFIG_PASSWORD

public static final String CONFIG_PASSWORD

See Also:

• Constant Field Values

CONFIG_PASSWORD_DEFAULT

public static final byte[] CONFIG_PASSWORD_DEFAULT

CONFIG_PORT

public static final String CONFIG_PORT

See Also:

• Constant Field Values

CONFIG_PORT_DEFAULT

public int CONFIG_PORT_DEFAULT

CONFIG_BIND_IP

public static final String CONFIG_BIND_IP

See Also:

• Constant Field Values

CONFIG_BIND_IP_DEFAULT

public String CONFIG_BIND_IP_DEFAULT

CONFIG_PROTOCOL

public static final String CONFIG_PROTOCOL

See Also:

• Constant Field Values

CONFIG_PROTOCOL_DEFAULT

public static final String CONFIG_PROTOCOL_DEFAULT

See Also:

• Constant Field Values

CONFIG_UPNP_ENABLE

public static final String CONFIG_UPNP_ENABLE

See Also:

• Constant Field Values

CONFIG_UPNP_ENABLE_DEFAULT

public boolean CONFIG_UPNP_ENABLE_DEFAULT

CONFIG_REVERSE_PROXY

public static final String CONFIG_REVERSE_PROXY

See Also:

• Constant Field Values

CONFIG_REVERSE_PROXY_DEFAULT

public boolean CONFIG_REVERSE_PROXY_DEFAULT

CONFIG_I2P_ENABLE

public static final String CONFIG_I2P_ENABLE

See Also:

• Constant Field Values

CONFIG_I2P_ENABLE_DEFAULT

public boolean CONFIG_I2P_ENABLE_DEFAULT

CONFIG_TOR_ENABLE

public static final String CONFIG_TOR_ENABLE

See Also:

• Constant Field Values

CONFIG_TOR_ENABLE_DEFAULT

public boolean CONFIG_TOR_ENABLE_DEFAULT

CONFIG_HOME_PAGE

public static final String CONFIG_HOME_PAGE

See Also:

• Constant Field Values

CONFIG_HOME_PAGE_DEFAULT

public String CONFIG_HOME_PAGE_DEFAULT

CONFIG_ROOT_DIR

public static final String CONFIG_ROOT_DIR

See Also:

• Constant Field Values

CONFIG_ROOT_DIR_DEFAULT

public String CONFIG_ROOT_DIR_DEFAULT

CONFIG_ROOT_RESOURCE

public static final String CONFIG_ROOT_RESOURCE

See Also:

• Constant Field Values

CONFIG_ROOT_RESOURCE_DEFAULT

public String CONFIG_ROOT_RESOURCE_DEFAULT

CONFIG_MODE

public static final String CONFIG_MODE

See Also:

• Constant Field Values

CONFIG_MODE_FULL

public static final String CONFIG_MODE_FULL

See Also:

• Constant Field Values

CONFIG_MODE_DEFAULT

public static final String CONFIG_MODE_DEFAULT

See Also:

• Constant Field Values

CONFIG_ACCESS

public static final String CONFIG_ACCESS

See Also:

• Constant Field Values

CONFIG_ACCESS_DEFAULT

public String CONFIG_ACCESS_DEFAULT

NL

protected static final String NL

See Also:

• Constant Field Values

welcome_pages

protected static final String[] welcome_pages

welcome_files

protected static File[] welcome_files

network_dispatcher

private static final AsyncDispatcher network_dispatcher

plugin_interface

protected PluginInterface plugin_interface

log

private LoggerChannel log

plugin_config

private PluginConfig plugin_config

view_model

private BasicPluginViewModel view_model

config_model

private BasicPluginConfigModel config_model

p_sid

private String p_sid

param_home

private StringParameter param_home

param_rootdir

private StringParameter param_rootdir

param_rootres

private StringParameter param_rootres

param_port

private IntParameter param_port

param_protocol

private StringListParameter param_protocol

param_bind

private StringParameter param_bind

param_access

private StringParameter param_access

param_i2p_enable

private BooleanParameter param_i2p_enable

param_i2p_dest

private InfoParameter param_i2p_dest

param_tor_enable

private BooleanParameter param_tor_enable

param_tor_dest

private InfoParameter param_tor_dest

p_upnp_enable

private BooleanParameter p_upnp_enable

p_reverse_proxy

private BooleanParameter p_reverse_proxy

pw_enable

private BooleanParameter pw_enable

p_user_name

private StringParameter p_user_name

p_password

private PasswordParameter p_password

p_no_pw_whitelist

private StringParameter p_no_pw_whitelist

param_auto_auth

private BooleanParameter param_auto_auth

param_port_or

private IntParameter param_port_or

setting_auto_auth

private boolean setting_auto_auth

pairing_access_code

private String pairing_access_code

pairing_session_code

private String pairing_session_code

plugin_enabled

private boolean plugin_enabled

na_intf_listener_added

private boolean na_intf_listener_added

home_page

private String home_page

file_root

private File file_root

resource_root

private String resource_root

root_dir

private String root_dir

ip_range_all

private boolean ip_range_all

ip_ranges

private List<IPRange> ip_ranges

tracker_context

private TrackerWebContext tracker_context

upnp_mapping

private UPnPMapping upnp_mapping

pairing_listener

private PairingManagerListener pairing_listener

properties

private Properties properties

tls

private static ThreadLocal<String> tls

LOGOUT_GRACE_MILLIS

private static final int LOGOUT_GRACE_MILLIS

See Also:

• Constant Field Values

GRACE_PERIOD_MARKER

private static final String GRACE_PERIOD_MARKER

See Also:

• Constant Field Values

logout_timer

private Map<String,Long> logout_timer

unloaded

private boolean unloaded

Constructor Details

WebPlugin

public WebPlugin()

WebPlugin

public WebPlugin(Properties defaults)

Method Details

initialize

public void initialize(PluginInterface _plugin_interface)
                throws PluginException

Description copied from interface: Plugin

This method is called when the Plugin is loaded by the client

Specified by:

initialize in interface Plugin

Parameters:

_plugin_interface - the interface that the plugin must use to communicate with the client

Throws:

PluginException

initStage

protected void initStage(int num)

getConnectionTestURL

private String getConnectionTestURL(String sid)

isPluginEnabled

protected boolean isPluginEnabled()

unloadPlugin

protected void unloadPlugin()

setupResources

private void setupResources()

setupAccess

private void setupAccess()

verifyReferrer

protected boolean verifyReferrer()

setupServer

protected void setupServer()

hasOurCookie

private boolean hasOurCookie(String cookies)

sameAddress

private boolean sameAddress(InetAddress a1,
 InetAddress a2)

setupUPnP

protected void setupUPnP()

setupPairing

protected void setupPairing(String sid,
 boolean pairing_enabled)

setupSessionCode

private void setupSessionCode(String key)

setupAutoAuth

protected void setupAutoAuth()

updatePairing

protected void updatePairing(String sid,
 String reason)

updatePairing

protected void updatePairing(PairingConnectionData cd)

getServerBindIP

public InetAddress getServerBindIP()

getServerPort

public int getServerPort()

getServerURL

protected String getServerURL()

getPort

public int getPort()

getProtocol

public String getProtocol()

setUserAndPassword

public void setUserAndPassword(String user,
 String password)

unsetUserAndPassword

public void unsetUserAndPassword()

recordAuthRequest

private void recordAuthRequest(String client_ip,
 boolean good)

recordRequest

private void recordRequest(TrackerWebPageRequest request,
 boolean good,
 boolean is_tunnel)

generateSupport

public boolean generateSupport(TrackerWebPageRequest request,
 TrackerWebPageResponse response)
                        throws IOException

Throws:

IOException

handleTunnelRequest

private byte[] handleTunnelRequest(InetAddress originator,
 String endpoint_url,
 byte[] request_bytes)
                            throws IOException

Throws:

IOException

generate

public boolean generate(TrackerWebPageRequest request,
 TrackerWebPageResponse response)
                 throws IOException

Specified by:

generate in interface TrackerWebPageGenerator

Parameters:

request -

response -

Returns:

true if the request was handled

Throws:

IOException

generate2

private boolean generate2(TrackerWebPageRequest request,
 TrackerWebPageResponse response,
 boolean is_tunnel)
                   throws IOException

Throws:

IOException

useFile

protected boolean useFile(TrackerWebPageRequest request,
 TrackerWebPageResponse response,
 File root,
 String relative_url)
                   throws IOException

this method can be over-ridden to handle custom file delivery

Parameters:

request -

response -

root -

relative_url -

Returns:

Throws:

IOException

getArgumentFromURL

private String getArgumentFromURL(URL url,
 String argument)

returnTextPlain

private boolean returnTextPlain(TrackerWebPageResponse response,
 String str)

returnJSON

private boolean returnJSON(TrackerWebPageResponse response,
 String str)
                    throws IOException

Throws:

IOException

returnStuff

private boolean returnStuff(TrackerWebPageResponse response,
 String content_type,
 String str)

getConfigModel

protected BasicPluginConfigModel getConfigModel()

getViewModel

protected BasicPluginViewModel getViewModel()

log

protected void log(String str)

log

protected void log(String str,
 Throwable e)