freenet.node.updater

Class NodeUpdateManager

java.lang.Object

freenet.node.updater.NodeUpdateManager

public class NodeUpdateManager
extends java.lang.Object

Supervises NodeUpdater's. Enables us to easily update multiple files, change the URI's on the fly, eliminates some messy code in the callbacks etc.

Procedure for updating the update key: Create a new key. Create a new build X, the "transition version". This must be UOM-compatible with the previous transition version. UOM-compatible means UOM should work from the older builds. This in turn means that it should support an overlapping set of connection setup negTypes (@link FNPPacketMangler.supportedNegTypes()). Similarly there may be issues with changes to the UOM messages, or to messages in general. Build X is inserted to both the old key and the new key. Build X's SSK URI (on the old auto-update key) will be hard-coded as the new transition version. Then the next build, X+1, can get rid of some of the back compatibility cruft (especially old connection setup types), and will be inserted only to the new key. Secure backups of the new key are required and are documented elsewhere.

FIXME: See bug #6009 for some current UOM compatibility issues.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	NodeUpdateManager.UpdateRevocationURICallback

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LEGACY_UPDATE_URI The URI for post-TRANSITION_VERSION builds' freenet.jar on EoL JVMs.
static long	MAX_IP_TO_COUNTRY_LENGTH
static long	MAX_JAVA_INSTALLER_LENGTH
static long	MAX_MAIN_JAR_LENGTH
static long	MAX_REVOCATION_KEY_BLOB_LENGTH
static long	MAX_REVOCATION_KEY_LENGTH
static long	MAX_REVOCATION_KEY_TEMP_LENGTH
static long	MAX_SEEDNODES_LENGTH
static long	MAX_WINDOWS_INSTALLER_LENGTH
Node	node
static java.lang.String	PREVIOUS_UPDATE_URI The URI for freenet.jar before the updater was rekeyed.
static java.lang.String	REVOCATION_URI
static int	TRANSITION_VERSION The last build on the previous key with Java 7 support.
java.io.File	transitionMainJarFile
static java.lang.String	transitionMainJarFilename
UpdateOverMandatoryManager	uom
static java.lang.String	UPDATE_URI The URI for post-TRANSITION_VERSION builds' freenet.jar on modern JVMs.

Constructor Summary

Constructors

Constructor and Description
NodeUpdateManager(Node node, Config config)

Method Summary

Modifier and Type	Method and Description
void	addChangelogLinks(long version, HTMLNode node) Add links to the changelog for the given version to the given node.
void	arm()
void	blow(java.lang.String msg, boolean disabledNotBlown)
boolean	brokenDependencies()
boolean	canUpdateImmediately() Is the node able to update *immediately*? (i.e.
boolean	canUpdateNow() Is the node able to update as soon as the revocation fetch has been completed?
void	deployPlugin(java.lang.String fn)
void	deployPluginWhenReady(java.lang.String fn)
void	disableThisSession()
void	disconnected(PeerNode pn)
boolean	dontAllowUOM()
boolean	fetchingFromUOM()
boolean	fetchingNewMainJar()
int	fetchingNewMainJarVersion()
FreenetURI	getChangelogURI()
java.io.File	getCurrentVersionBlobFile()
FreenetURI	getDeveloperChangelogURI()
int	getExtVersion()
java.io.File	getInstallerNonWindows()
FreenetURI	getInstallerNonWindowsURI()
java.io.File	getInstallerWindows()
FreenetURI	getInstallerWindowsURI()
FreenetURI	getIPv4ToCountryURI()
java.io.File	getMainBlob(int version)
int	getMainVersion() What version is the node currently running?
int	getRevocationDNFCounter()
FreenetURI	getRevocationURI()
FreenetURI	getSeednodesURI()
protected long	getStartedFetchingNextMainJarTimestamp()
java.io.File	getTransitionMainBlob()
FreenetURI	getURI() Get the URI for freenet.jar.
boolean	hasNewMainJar()
boolean	inFinalCheck()
boolean	isArmed()
boolean	isAutoUpdateAllowed()
boolean	isBlown() Has the private key been revoked?
boolean	isEnabled() Is auto-update enabled?
protected void	maybeBroadcastUOMAnnouncesNew()
static NodeUpdateManager	maybeCreate(Node node, Config config) Create a NodeUpdateManager.
void	maybeSendUOMAnnounce(PeerNode peer)
int	newMainJarVersion() What version has been fetched? This includes jar's fetched via UOM, because the UOM code feeds its results through the mainUpdater.
void	noRevocationFound() Called when the RevocationChecker has got 3 DNFs on the revocation key
void	notPeerClaimsKeyBlown() Called inside locks, so don't lock anything
void	onDependenciesReady(freenet.node.updater.MainJarDependenciesChecker.MainJarDependencies deps) Called when the dependencies have been verified and/or downloaded, and we can upgrade to the new build without dependency issues.
void	onStartFetchingUOM()
void	renderProgress(HTMLNode alertNode) Show the progress of individual dependencies if possible
void	setAutoUpdateAllowed(boolean val) Enable or disable auto-update.
void	setRevocationURI(FreenetURI uri) Set the revocation URI.
void	setURI(FreenetURI uri) Set the URfrenet.jar should be updated from.
void	start()
void	startPluginUpdater(java.lang.String plugName)
void	stopPluginUpdater(java.lang.String plugName)
long	timeRemainingOnCheck()
void	writeJarTo(java.io.File fNew)

Methods inherited from class java.lang.Object

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

Field Detail

TRANSITION_VERSION

public static final int TRANSITION_VERSION

The last build on the previous key with Java 7 support. Older nodes can update to this point via old UOM.

See Also:

Constant Field Values

UPDATE_URI

public static final java.lang.String UPDATE_URI

The URI for post-TRANSITION_VERSION builds' freenet.jar on modern JVMs.

LEGACY_UPDATE_URI

public static final java.lang.String LEGACY_UPDATE_URI

The URI for post-TRANSITION_VERSION builds' freenet.jar on EoL JVMs.

See Also:

Constant Field Values

PREVIOUS_UPDATE_URI

public static final java.lang.String PREVIOUS_UPDATE_URI

The URI for freenet.jar before the updater was rekeyed. Unless both the EoL and modern keys rekey this is LEGACY_UPDATE_URI.

See Also:

Constant Field Values

REVOCATION_URI

public static final java.lang.String REVOCATION_URI

See Also:

Constant Field Values

MAX_REVOCATION_KEY_LENGTH

public static final long MAX_REVOCATION_KEY_LENGTH

See Also:

Constant Field Values

MAX_REVOCATION_KEY_TEMP_LENGTH

public static final long MAX_REVOCATION_KEY_TEMP_LENGTH

See Also:

Constant Field Values

MAX_REVOCATION_KEY_BLOB_LENGTH

public static final long MAX_REVOCATION_KEY_BLOB_LENGTH

See Also:

Constant Field Values

MAX_MAIN_JAR_LENGTH

public static final long MAX_MAIN_JAR_LENGTH

See Also:

Constant Field Values

MAX_JAVA_INSTALLER_LENGTH

public static final long MAX_JAVA_INSTALLER_LENGTH

See Also:

Constant Field Values

MAX_WINDOWS_INSTALLER_LENGTH

public static final long MAX_WINDOWS_INSTALLER_LENGTH

See Also:

Constant Field Values

MAX_IP_TO_COUNTRY_LENGTH

public static final long MAX_IP_TO_COUNTRY_LENGTH

See Also:

Constant Field Values

MAX_SEEDNODES_LENGTH

public static final long MAX_SEEDNODES_LENGTH

See Also:

Constant Field Values

transitionMainJarFilename

public static final java.lang.String transitionMainJarFilename

See Also:

Constant Field Values

transitionMainJarFile

public final java.io.File transitionMainJarFile

node

public final Node node

uom

public final UpdateOverMandatoryManager uom

Constructor Detail

NodeUpdateManager

public NodeUpdateManager(Node node,
                         Config config)
                  throws InvalidConfigValueException

Throws:

InvalidConfigValueException

Method Detail

getInstallerWindows

public java.io.File getInstallerWindows()

getInstallerNonWindows

public java.io.File getInstallerNonWindows()

getSeednodesURI

public FreenetURI getSeednodesURI()

getInstallerNonWindowsURI

public FreenetURI getInstallerNonWindowsURI()

getInstallerWindowsURI

public FreenetURI getInstallerWindowsURI()

getIPv4ToCountryURI

public FreenetURI getIPv4ToCountryURI()

start

public void start()
           throws InvalidConfigValueException

Throws:

InvalidConfigValueException

maybeSendUOMAnnounce

public void maybeSendUOMAnnounce(PeerNode peer)

isEnabled

public boolean isEnabled()

Is auto-update enabled?

startPluginUpdater

public void startPluginUpdater(java.lang.String plugName)

Parameters:

plugName - The filename for loading/config purposes for an official plugin. E.g. "Library" (no .jar)

stopPluginUpdater

public void stopPluginUpdater(java.lang.String plugName)

maybeCreate

public static NodeUpdateManager maybeCreate(Node node,
                                            Config config)
                                     throws InvalidConfigValueException

Create a NodeUpdateManager. Called by node constructor.

Parameters:

node - The node object.

config - The global config object. Options will be added to a subconfig called node.updater.

Returns:

A new NodeUpdateManager

Throws:

InvalidConfigValueException - If there is an error in the config.

getURI

public FreenetURI getURI()

Get the URI for freenet.jar.

getChangelogURI

public FreenetURI getChangelogURI()

Returns:

URI for the user-facing changelog.

getDeveloperChangelogURI

public FreenetURI getDeveloperChangelogURI()

addChangelogLinks

public void addChangelogLinks(long version,
                              HTMLNode node)

Add links to the changelog for the given version to the given node.

Parameters:

version - USK edition to point to

node - to add links to

setURI

public void setURI(FreenetURI uri)

Set the URfrenet.jar should be updated from.

Parameters:

uri - The URI to set.

getRevocationURI

public FreenetURI getRevocationURI()

Returns:

The revocation URI.

setRevocationURI

public void setRevocationURI(FreenetURI uri)

Set the revocation URI.

Parameters:

uri - The new revocation URI.

isAutoUpdateAllowed

public boolean isAutoUpdateAllowed()

Returns:

Is auto-update currently enabled?

setAutoUpdateAllowed

public void setAutoUpdateAllowed(boolean val)

Enable or disable auto-update.

Parameters:

val - If true, enable auto-update (and immediately update if an update is ready). If false, disable it.

writeJarTo

public void writeJarTo(java.io.File fNew)
                throws java.io.IOException

Throws:

java.io.IOException

blow

public void blow(java.lang.String msg,
                 boolean disabledNotBlown)

Parameters:

msg -

disabledNotBlown - If true, the auto-updating system is broken, and should be disabled, but the problem *could* be local e.g. out of disk space and a node sends us a revocation certificate.

noRevocationFound

public void noRevocationFound()

Called when the RevocationChecker has got 3 DNFs on the revocation key

arm

public void arm()

maybeBroadcastUOMAnnouncesNew

protected void maybeBroadcastUOMAnnouncesNew()

isBlown

public boolean isBlown()

Has the private key been revoked?

hasNewMainJar

public boolean hasNewMainJar()

newMainJarVersion

public int newMainJarVersion()

What version has been fetched? This includes jar's fetched via UOM, because the UOM code feeds its results through the mainUpdater.

fetchingNewMainJar

public boolean fetchingNewMainJar()

fetchingNewMainJarVersion

public int fetchingNewMainJarVersion()

inFinalCheck

public boolean inFinalCheck()

getRevocationDNFCounter

public int getRevocationDNFCounter()

getMainVersion

public int getMainVersion()

What version is the node currently running?

getExtVersion

public int getExtVersion()

isArmed

public boolean isArmed()

canUpdateNow

public boolean canUpdateNow()

Is the node able to update as soon as the revocation fetch has been completed?

canUpdateImmediately

public boolean canUpdateImmediately()

Is the node able to update *immediately*? (i.e. not only is it ready in every other sense, but also a revocation fetch has completed recently enough not to need another one)

notPeerClaimsKeyBlown

public void notPeerClaimsKeyBlown()

Called inside locks, so don't lock anything

getMainBlob

public java.io.File getMainBlob(int version)

timeRemainingOnCheck

public long timeRemainingOnCheck()

disableThisSession

public void disableThisSession()

getStartedFetchingNextMainJarTimestamp

protected long getStartedFetchingNextMainJarTimestamp()

disconnected

public void disconnected(PeerNode pn)

deployPlugin

public void deployPlugin(java.lang.String fn)
                  throws java.io.IOException

Throws:

java.io.IOException

deployPluginWhenReady

public void deployPluginWhenReady(java.lang.String fn)
                           throws java.io.IOException

Throws:

java.io.IOException

dontAllowUOM

public boolean dontAllowUOM()

fetchingFromUOM

public boolean fetchingFromUOM()

onDependenciesReady

public void onDependenciesReady(freenet.node.updater.MainJarDependenciesChecker.MainJarDependencies deps)

Called when the dependencies have been verified and/or downloaded, and we can upgrade to the new build without dependency issues.

Parameters:

deps - The dependencies object. Used to rewrite wrapper.conf if necessary. Also contains the build number.

binaryBlob - The binary blob for this build, including the dependencies.

getTransitionMainBlob

public java.io.File getTransitionMainBlob()

renderProgress

public void renderProgress(HTMLNode alertNode)

Show the progress of individual dependencies if possible

brokenDependencies

public boolean brokenDependencies()

onStartFetchingUOM

public void onStartFetchingUOM()

getCurrentVersionBlobFile

public java.io.File getCurrentVersionBlobFile()