ConfigUpdateHandler

java.lang.Object

net.i2p.router.web.FormHandler

net.i2p.router.web.ConfigUpdateHandler

public class ConfigUpdateHandlerextends FormHandler

Handler for router update configuration.

Nested Class Summary
Nested classes/interfaces inherited from class FormHandler
FormHandler.Message, FormHandler.RateLimitEntry
Modifier and Type
Class
Description
static class
FormHandler.Message
Message class to encapsulate the message text and the canClose flag.
(package private) static class
FormHandler.RateLimitEntry
One window's POST count.
Field Summary
Modifier and Type
Field
Description
private String
_devSU3URL
The URL of the development stream.
private boolean
_newsThroughProxy
True to fetch the news through the proxy.
private String
_newsURL
The URL of the news feed.
private String
_proxyHost
The proxy host for the downloads.
private String
_proxyPort
The proxy port for the downloads.
private long
_refreshFrequency
Interval between the update checks.
private String
_trustedKeys
The signing keys trusted for the updates.
private boolean
_updateDevSU3
True to follow the development stream.
private String
_updatePolicy
The policy for applying the updates.
private boolean
_updateThroughProxy
True to download updates through the proxy.
private boolean
_updateUnsigned
True to accept the unsigned updates.
private String
_updateURL
The URL of the update stream.
private String
_zipURL
The URL of the i2pzip update stream.
static final String
DEFAULT_NEWS_URL_SU3
Current default, i2pnews.i2p, run by echelon
static final String
DEFAULT_PROXY_HOST
Default proxy host.
static final String
DEFAULT_PROXY_PORT
Default proxy port as String.
static final int
DEFAULT_PROXY_PORT_INT
Default proxy port as int.
static final long
DEFAULT_REFRESH_FREQ
Default refresh frequency (36 hours).
static final String
DEFAULT_REFRESH_FREQUENCY
Default refresh frequency as String.
static final boolean
DEFAULT_SHOULD_PROXY
Default for update through proxy.
static final boolean
DEFAULT_SHOULD_PROXY_NEWS
Default for fetching news through proxy.
static final String
DEFAULT_UPDATE_POLICY
Default update policy.
static final boolean
DEFAULT_UPDATE_UNSIGNED
Default false.
static final String
DEFAULT_UPDATE_URL
These are only for .sud and .su2.
static final String
PROP_DEV_SU3_URL
If true, the development SU3 URL; no default.
static final String
PROP_NEWS_URL
Property for news URL.
static final String
PROP_PROXY_HOST
Property for update proxy host.
static final String
PROP_PROXY_PORT
Property for update proxy port.
static final String
PROP_REFRESH_FREQUENCY
Property for news refresh frequency.
static final String
PROP_SHOULD_PROXY
Property for update through proxy.
static final String
PROP_SHOULD_PROXY_NEWS
Property for fetching news through proxy.
static final String
PROP_TRUSTED_KEYS
Property for trusted update keys.
static final String
PROP_UPDATE_DEV_SU3
If true, offer development SU3 builds; default false.
static final String
PROP_UPDATE_DISABLED
Default false - use for distros.
static final String
PROP_UPDATE_POLICY
Property for update policy.
static final String
PROP_UPDATE_UNSIGNED
Property for unsigned update flag.
static final String
PROP_UPDATE_URL
Property for update URL.
static final String
PROP_ZIP_URL
No default.
private static final String
SU3_CERT_DIR
Directory holding the trusted SU3 signing certificates.
static final boolean
USE_SU3_UPDATE
Only enabled if we have trusted public key certificates installed.
Fields inherited from class FormHandler
_action, _context, _log, _method, _out, _requestWrapper, _session, _settings, RATE_LIMIT_GLOBAL_KEY, RATE_LIMIT_MAP, RATE_LIMIT_MAX_POSTS, RATE_LIMIT_WINDOW_MS
Modifier and Type
Field
Description
protected String
_action
Form action.
protected RouterContext
_context
Router context.
protected Log
_log
Class logger.
protected String
_method
Request method.
protected Writer
_out
Output writer.
protected RequestWrapper
_requestWrapper
Only for multipart/form-data.
protected HttpSession
_session
HTTP session for nonce validation.
protected Map
_settings
Not for multipart/form-data, will be null.
(package private) static final String
RATE_LIMIT_GLOBAL_KEY
The single budget key the console charges POSTs to.
(package private) static final ConcurrentHashMap<String, FormHandler.RateLimitEntry>
RATE_LIMIT_MAP
Live budgets, keyed by the value passed to checkRateLimit().
(package private) static final int
RATE_LIMIT_MAX_POSTS
POSTs admitted per window per key before further ones are refused.
(package private) static final int
RATE_LIMIT_WINDOW_MS
Length of one rate-limit window, in ms.
Constructor Summary
Constructors
Constructor
Description
ConfigUpdateHandler()
ConfigUpdateHandler default constructor.
Method Summary
Modifier and Type
Method
Description
protected void
processForm()
Implement this to perform the final processing (in turn, adding formNotice and formError messages, etc)
static int
proxyPort(I2PAppContext ctx)
Convenience method for updaters.
void
setDevSU3URL(String url)
Set the development SU3 URL.
void
setNewsThroughProxy(String foo)
Set whether to fetch news through proxy.
void
setNewsURL(String url)
Record the news URL to fetch.
void
setProxyHost(String host)
Record the proxy host to fetch through.
void
setProxyPort(String port)
Record the proxy port to fetch through.
void
setRefreshFrequency(String freq)
Record the interval between update checks.
void
setTrustedKeys(String keys)
Record the signing keys accepted for update verification.
void
setUpdateDevSU3(String foo)
Set whether to update development SU3 builds.
void
setUpdatePolicy(String policy)
Record the policy to apply when an update is offered.
void
setUpdateThroughProxy(String foo)
Enable update proxying.
void
setUpdateUnsigned(String foo)
Allow updates to be installed without a signature.
void
setUpdateURL(String url)
Record the update URL to fetch.
void
setZipURL(String url)
Record the zip download URL used for unsigned updates.
Methods inherited from class FormHandler
_t, _t, _t, _x, addFormError, addFormError, addFormErrorNoEscape, addFormErrorNoEscape, addFormNotice, addFormNotice, addFormNoticeNoEscape, addFormNoticeNoEscape, checkRateLimit, cleanupRateLimits, getAllMessages, getErrors, getJettyString, getNotices, isAdvanced, resolveEffectiveAction, setAction, setContextId, setNonce, setRequestWrapper, setSettings, storeMethod, storeSession, storeWriter
Modifier and Type
Method
Description
String
_t(String s)
Translate a string.
String
_t(String s, Object o)
Translate a string with a parameter This is a lot more expensive than _t(s), so use sparingly.
String
_t(String s, Object o, Object o2)
Translate a string with two parameters.
static String
_x(String s)
Mark a string for extraction by xgettext and translation.
protected void
addFormError(String errorMsg)
Add an error message to display Use if it does not include a link.
protected void
addFormError(String errorMsg, boolean canClose)
Add an error message to display Use if it does not include a link.
protected void
addFormErrorNoEscape(String msg)
Add an error message to display Use if it includes a link or other formatting.
protected void
addFormErrorNoEscape(String msg, boolean canClose)
Add an error message to display Use if it includes a link or other formatting.
protected void
addFormNotice(String msg)
Add a non-error message to display Use if it does not include a link.
protected void
addFormNotice(String msg, boolean canClose)
Add a non-error message to display Use if it does not include a link.
protected void
addFormNoticeNoEscape(String msg)
Add a non-error message to display Use if it includes a link or other formatting.
protected void
addFormNoticeNoEscape(String msg, boolean canClose)
Add a non-error message to display Use if it includes a link or other formatting.
(package private) static boolean
checkRateLimit(String key, long now)
Check and record one form submission against the budget for key.
(package private) static void
cleanupRateLimits(long now)
Remove budgets that have seen no POST for two full windows.
String
getAllMessages()
Display everything, wrap it in a div for consistent presentation.
String
getErrors()
Display any error messages (processing the form if it hasn't been yet).
protected String
getJettyString(String key)
FormHandler.setSettings(Map) must have been called previously Curses Jetty for returning arrays.
String
getNotices()
Display any non-error messages (processing the form if it hasn't been yet).
boolean
isAdvanced()
Same as HelperBase.
static String
resolveEffectiveAction(String action, Map<?,?> settings)
Resolve which operation the user actually requested.
void
setAction(String val)
Action value.
void
setContextId(String contextId)
Configure this bean to query a particular router context.
void
setNonce(String val)
Nonce value.
void
setRequestWrapper(RequestWrapper rw)
Only set by formhandler.jsi for multipart/form-data.
void
setSettings(Map settings)
For many forms, it's easiest just to put all the parameters here.
void
storeMethod(String val)
Call this to prevent changes using GET.
void
storeSession(HttpSession session)
For nonce validation.
void
storeWriter(Writer out)
Store the output writer for inline form processing.
Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- _newsURL
  private String _newsURL
  The URL of the news feed.
- _refreshFrequency
  private long _refreshFrequency
  Interval between the update checks.
- _updateURL
  private String _updateURL
  The URL of the update stream.
- _updatePolicy
  private String _updatePolicy
  The policy for applying the updates.
- _proxyHost
  private String _proxyHost
  The proxy host for the downloads.
- _proxyPort
  private String _proxyPort
  The proxy port for the downloads.
- _updateThroughProxy
  private boolean _updateThroughProxy
  True to download updates through the proxy.
- _newsThroughProxy
  private boolean _newsThroughProxy
  True to fetch the news through the proxy.
- _trustedKeys
  private String _trustedKeys
  The signing keys trusted for the updates.
- _updateUnsigned
  private boolean _updateUnsigned
  True to accept the unsigned updates.
- _zipURL
  private String _zipURL
  The URL of the i2pzip update stream.
- _updateDevSU3
  private boolean _updateDevSU3
  True to follow the development stream.
- _devSU3URL
  private String _devSU3URL
  The URL of the development stream.
- PROP_NEWS_URL
  public static final String PROP_NEWS_URL
  Property for news URL.
  See Also:
  Constant Field Values
- DEFAULT_NEWS_URL_SU3
  public static final String DEFAULT_NEWS_URL_SU3
  Current default, i2pnews.i2p, run by echelon
  NOTE: If you change, also change in Android: app/src/main/java/net/i2p/android/apps/NewsFetcher.java.
  See Also:
  Constant Field Values
- PROP_REFRESH_FREQUENCY
  public static final String PROP_REFRESH_FREQUENCY
  Property for news refresh frequency.
  See Also:
  Constant Field Values
- DEFAULT_REFRESH_FREQ
  public static final long DEFAULT_REFRESH_FREQ
  Default refresh frequency (36 hours).
  See Also:
  Constant Field Values
- DEFAULT_REFRESH_FREQUENCY
  public static final String DEFAULT_REFRESH_FREQUENCY
  Default refresh frequency as String.
- PROP_UPDATE_POLICY
  public static final String PROP_UPDATE_POLICY
  Property for update policy.
  See Also:
  Constant Field Values
- DEFAULT_UPDATE_POLICY
  public static final String DEFAULT_UPDATE_POLICY
  Default update policy.
  See Also:
  Constant Field Values
- PROP_SHOULD_PROXY
  public static final String PROP_SHOULD_PROXY
  Property for update through proxy.
  See Also:
  Constant Field Values
- DEFAULT_SHOULD_PROXY
  public static final boolean DEFAULT_SHOULD_PROXY
  Default for update through proxy.
  See Also:
  Constant Field Values
- PROP_SHOULD_PROXY_NEWS
  public static final String PROP_SHOULD_PROXY_NEWS
  Property for fetching news through proxy.
  See Also:
  Constant Field Values
- DEFAULT_SHOULD_PROXY_NEWS
  public static final boolean DEFAULT_SHOULD_PROXY_NEWS
  Default for fetching news through proxy.
  See Also:
  Constant Field Values
- PROP_PROXY_HOST
  public static final String PROP_PROXY_HOST
  Property for update proxy host.
  See Also:
  Constant Field Values
- DEFAULT_PROXY_HOST
  public static final String DEFAULT_PROXY_HOST
  Default proxy host.
  See Also:
  Constant Field Values
- PROP_PROXY_PORT
  public static final String PROP_PROXY_PORT
  Property for update proxy port.
  See Also:
  Constant Field Values
- DEFAULT_PROXY_PORT_INT
  public static final int DEFAULT_PROXY_PORT_INT
  Default proxy port as int.
  See Also:
  Constant Field Values
- DEFAULT_PROXY_PORT
  public static final String DEFAULT_PROXY_PORT
  Default proxy port as String.
- DEFAULT_UPDATE_UNSIGNED
  public static final boolean DEFAULT_UPDATE_UNSIGNED
  Default false.
  See Also:
  Constant Field Values
- PROP_UPDATE_UNSIGNED
  public static final String PROP_UPDATE_UNSIGNED
  Property for unsigned update flag.
  See Also:
  Constant Field Values
- PROP_UPDATE_DISABLED
  public static final String PROP_UPDATE_DISABLED
  Default false - use for distros.
  See Also:
  Constant Field Values
- PROP_ZIP_URL
  public static final String PROP_ZIP_URL
  No default.
  See Also:
  Constant Field Values
- PROP_UPDATE_URL
  public static final String PROP_UPDATE_URL
  Property for update URL.
  See Also:
  Constant Field Values
- PROP_UPDATE_DEV_SU3
  public static final String PROP_UPDATE_DEV_SU3
  If true, offer development SU3 builds; default false.
  See Also:
  Constant Field Values
- PROP_DEV_SU3_URL
  public static final String PROP_DEV_SU3_URL
  If true, the development SU3 URL; no default.
  See Also:
  Constant Field Values
- DEFAULT_UPDATE_URL
  public static final String DEFAULT_UPDATE_URL
  These are only for .sud and .su2. Do NOT use this for .su3.
  See Also:
  Constant Field Values
- SU3_CERT_DIR
  private static final String SU3_CERT_DIR
  Directory holding the trusted SU3 signing certificates.
  See Also:
  Constant Field Values
- USE_SU3_UPDATE
  public static final boolean USE_SU3_UPDATE
  Only enabled if we have trusted public key certificates installed.
- PROP_TRUSTED_KEYS
  public static final String PROP_TRUSTED_KEYS
  Property for trusted update keys.
  See Also:
  Constant Field Values
Constructor Details
- ConfigUpdateHandler
  public ConfigUpdateHandler()
  ConfigUpdateHandler default constructor.
Method Details
- proxyPort
  public static int proxyPort(I2PAppContext ctx)
  Convenience method for updaters.
  Parameters:
  ctx - the context for retrieving configuration
  Returns:
  the configured value, else the registered HTTP proxy, else the default
- processForm
  protected void processForm()
  Description copied from class: FormHandler
  Implement this to perform the final processing (in turn, adding formNotice and formError messages, etc)
  Will only be called if _action is non-null and the nonce is valid.
  Specified by:
  processForm in class FormHandler
- setNewsURL
  public void setNewsURL(String url)
  Record the news URL to fetch.
  Parameters:
  url - the news URL
- setRefreshFrequency
  public void setRefreshFrequency(String freq)
  Record the interval between update checks.
  Parameters:
  freq - the interval in milliseconds; unparseable input is ignored
- setUpdateURL
  public void setUpdateURL(String url)
  Record the update URL to fetch.
  Parameters:
  url - the update URL
- setUpdatePolicy
  public void setUpdatePolicy(String policy)
  Record the policy to apply when an update is offered.
  Parameters:
  policy - the update policy
- setTrustedKeys
  public void setTrustedKeys(String keys)
  Record the signing keys accepted for update verification.
  Parameters:
  keys - the trusted keys
- setUpdateThroughProxy
  public void setUpdateThroughProxy(String foo)
  Enable update proxying.
  Parameters:
  foo - ignored; this setter only ever turns the option on
- setProxyHost
  public void setProxyHost(String host)
  Record the proxy host to fetch through.
  Parameters:
  host - the proxy host
- setProxyPort
  public void setProxyPort(String port)
  Record the proxy port to fetch through.
  Parameters:
  port - the proxy port
- setUpdateUnsigned
  public void setUpdateUnsigned(String foo)
  Allow updates to be installed without a signature.
  Parameters:
  foo - ignored; this setter only ever turns the option on
- setZipURL
  public void setZipURL(String url)
  Record the zip download URL used for unsigned updates.
  Parameters:
  url - the zip URL to download
- setNewsThroughProxy
  public void setNewsThroughProxy(String foo)
  Set whether to fetch news through proxy.
  Parameters:
  foo - ignored; the value only marks the setting as enabled
- setUpdateDevSU3
  public void setUpdateDevSU3(String foo)
  Set whether to update development SU3 builds.
  Parameters:
  foo - ignored; the value only marks the setting as enabled
- setDevSU3URL
  public void setDevSU3URL(String url)
  Set the development SU3 URL.
  Parameters:
  url - the development SU3 zip URL to download

Nested Class Summary

Nested classes/interfaces inherited from class FormHandler

Field Summary

Fields inherited from class FormHandler

Constructor Summary

Method Summary

Methods inherited from class FormHandler

Methods inherited from class Object

Field Details

_newsURL

_refreshFrequency

_updateURL

_updatePolicy

_proxyHost

_proxyPort

_updateThroughProxy

_newsThroughProxy

_trustedKeys

_updateUnsigned

_zipURL

_updateDevSU3

_devSU3URL

PROP_NEWS_URL

DEFAULT_NEWS_URL_SU3

PROP_REFRESH_FREQUENCY

DEFAULT_REFRESH_FREQ

DEFAULT_REFRESH_FREQUENCY

PROP_UPDATE_POLICY

DEFAULT_UPDATE_POLICY

PROP_SHOULD_PROXY

DEFAULT_SHOULD_PROXY

PROP_SHOULD_PROXY_NEWS

DEFAULT_SHOULD_PROXY_NEWS

PROP_PROXY_HOST

DEFAULT_PROXY_HOST

PROP_PROXY_PORT

DEFAULT_PROXY_PORT_INT

DEFAULT_PROXY_PORT

DEFAULT_UPDATE_UNSIGNED

PROP_UPDATE_UNSIGNED

PROP_UPDATE_DISABLED

PROP_ZIP_URL

PROP_UPDATE_URL

PROP_UPDATE_DEV_SU3

PROP_DEV_SU3_URL

DEFAULT_UPDATE_URL

SU3_CERT_DIR

USE_SU3_UPDATE

PROP_TRUSTED_KEYS

Constructor Details

Method Details

proxyPort

processForm

setNewsURL

setRefreshFrequency

setUpdateURL

setUpdatePolicy

setTrustedKeys

setUpdateThroughProxy

setProxyHost

setProxyPort

setUpdateUnsigned

setZipURL

setNewsThroughProxy

setUpdateDevSU3

setDevSU3URL