datastore module

Sputnik Datastore Implementation

This module provides the Sputnik Datastore implementation. It implements a thin wrapper around Redis, which is required in order to persist data across Bouncer restarts or network disconnections. This functionality is required due to the ephemeral filesystems typical to most Platform-as-a-Service Providers (PaaS).

class datastore.Datastore(hostname, port)

Bases: object

A singleton that provides a thin wrapper to Redis.

The Datastore is responsible for persisting networks and channels in the event of an unexpected crash by either the Bouncer or a connected network. It also holds persistent, shared variables, such as the Bouncer password.

database

redis.Redis

A Redis database connection.

add_channel(network, channel, password='')

Adds a channel to the Redis.

Parameters:

• network (str) – The name of a network.
• channel (str) – The name of a channel.
• password (str, optional) – The channel password. Defaults to "".

add_network(network, hostname, port, nickname, username, realname, password=None, usermode=0)

Adds a network to the Redis instance.

Parameters:

• network (str) – The name of the IRC network to connect to.
• hostname (str) – The hostname of the IRC network to connect to.
• port (int) – The port to connect using.
• nickname (str) – The IRC nickname to use when connecting.
• username (str) – The IRC ident to use when connecting.
• realname (str) – The real name of the user.
• password (str, optional) – Bouncer password. Defaults to None.
• usermode (int, optional) – The IRC usermode. Defaults to 0.

check_password(password_attempt)

Checks a password attempt against the Bouncer password.

Parameters:password_attempt (str) – The password attempt. Returns:Whether the password matched. Return type:bool

get_channels(network='')

Retrieves all connected channels from Redis.

This gets credentials for all connected channels, where credentials are of the form { “<network/channel>” : “<password>” }. If the network argument is specified, then the output is filtered to only include channels from the indicated network.

Parameters:network (str, optional) – The name of a network. Defaults to "". Returns:A dictionary of channel credentials. Return type:dict

get_networks()

Retrieves all connected networks from Redis.

This gets credentials for all connected networks, where credentials contain all values necessary to reconstruct a network connection, where networks are of the form { “<network_name>” : “<credentials>” }.

Returns:A dictionary of network credentials. Return type:dict

get_password()

Retrieves the Bouncer password from Redis.

Returns:The encrypted Bouncer password. Return type:str

remove_channel(network, channel)

Removes a channel from Redis.

Parameters:

• network (str) – The name of a network.
• channel (str) – The name of a channel.

remove_network(network, hard=True)

Removes a network from Redis.

Parameters:

• network (str) – The name of a network to remove.
• hard (bool) – When True, clears all associated channels.

set_password(password='cosmonaut')

Saves a new Bouncer password to Redis.

Parameters:password (str, optional) – The new password for the Bouncer.