Development documentation

The Bot

class sid.sid.MUCBot(jid, password, room, nick, log_level=20)

Bases: ClientXMPP

Parameters:

• jid (str) – jid to log with

• password (str) – jid password

• room (str) – conference room to join

• nick (str) – Nickname to use in the room

disconn(event)

disconnected handler

foreach_plugin(method, *args, **kwds)

help(message, args)

Returns a help string listing available options.

Automatically assigned to the “help” command.

message(msg)

Messages handler

Parses message received to detect prefix

muc_presences

Keep track of MUC presences: {‘nick’: presence}

prefix = '!'

Class attribute to define bot’s command prefix

Defaults to “!”

register_bot_plugin(plugin_cls)

Registers plugin, takes a class, the method instanciates the plugin

Parameters:

plugin_cls (sid.plugin.Plugin) – A sid.plugin.Plugin class

shutdown_plugins()

async start(event)

Process the session_start event.

Typical actions for the session_start event are requesting the roster and broadcasting an initial presence stanza.

Parameters:

event (dict) – An empty dictionary. The session_start event does not provide any additional data.

unregister_bot_plugin(plugin)

@sid.sid.botcmd(hidden, name)

Decorator for bot command functions

Parameters:

• hidden (bool) – is the command hidden in global help

• name (str) – command name, default to decorated function name

Plugin base

The plugin class to derive from.

class sid.plugin.Plugin(bot)

Simple Plugin object to derive from:

• Exposes the bot object and its logger

• Provides send helpers

Parameters:

bot (sid.sid.MUCBot) – bot the plugin is load from

add_handlers()

Add handlers declared in self.hanlders

async ban(jid, reason)

Coroutine to ban a jid from the room

Parameters:

• jid (str) – JID to ban

• reason (str) – Reason

handlers

list : List of tuples (event, handler)

log_level = None

Overriding bot log level for the plugin

reply(rcv, msg)

Smart reply to message received.

Replies msg in private or on the muc depending on rcv

Parameters:

• rcv – The received message (slixmpp object)

• msg (dict,str) – The message to reply, refer to sid.plugin.Plugin.send for msg format

rm_handlers()

Remove handlers declared in self.hanlders

send(dest, msg, mtype='chat')

Send msg to dest

Parameters:

• dest (str) – Message recipient

• msg (dict,str) – Message to send (use dict for xhtml-im)

Note

if msg is a dict to provide xhmlt-im massages:

msg = {
    mbody: 'text',
    mhtml: '<b>text</b>,  # optional'
}

shutdown()

Empty method to override. Called on bot shutdown

Available plugins

Generic plugins

class sid.echo.Echo(bot)

Bases: Plugin

Drops a message to be sent when someone gets online.

log_presence(pres)

Handler method registering MUC participants presence

tell(message, args)

Drops a message to be sent when someone gets online.

• !tell queue : messages in queue

• !tell <nick> <msg>: append <msg> to <nick> in queue

class sid.feeds.Feeds(bot)

Bases: Plugin

Note

Feeds plugin depends on external module: feedparser

FEEDS = ['https://www.debian.org/security/dsa', 'https://www.debian.org/News/news', 'https://tracker.debian.org/pkg/prosody/rss', 'https://tracker.debian.org/pkg/ejabberd/rss', 'https://planet.debian.org/atom.xml']

Default feeds to monitor

TEMPO = 60

Time between feeds check

feeds(rcv, args)

Monitors debian project related feeds.

• !feeds : registred feeds list

• !feeds last : last check time

shutdown()

Empty method to override. Called on bot shutdown

class sid.log.Log(bot)

Bases: Plugin

Logs group chat participant presence.

The account running the bot need at least room moderation right to log participants JIDs (fallback to nickname).

dump(message, args)

!dump : Dumps log as MUC message

write(message, args)

Dump/save room presences log

!write : Writes log to file (use mktemp and return file location as MUC message)

class sid.rtbl.RTBL(bot)

Bases: Plugin

Spam guard plugin for MUC.

async got_online(pres)

Handler method for new MUC participants

got_presence(pres)

Does bot have required permissions

node = 'muc_bans_sha256'

Pubsub server node to subscribe to

pubsub_server = 'example.org'

Pubsub server

async rtbl_ban(jid: JID)

Ban jid in RTBL

rtbl_info(rcv, _)

Show RTBL info

Debian plugins

Fetch packages info from the archive

>>> from sid.archive import Archive

class sid.archive.Archive(bot)

Bases: Plugin

Fetches package info from the archive

archive(rcv, args)

Fetches package info from the archive

!archive pkg-name : Returns package versions (by suite)

re_pkg = re.compile('(?P<package>[0-9a-z.+-]+)$')

Pakage name regexp

stable_codename = 'buster'

Current stable Suite

Intercepts bugs numbers in MUC messages and send info about it

>>> from sid.bts import Bugs

class sid.bts.Bugs(bot)

Bases: Plugin

Gets bugs info from the BTS

Note

This plugin depends on external module: python-debianbts

bugs(rcv, args)

Gets bugs info from the BTS

!bugs pkg-name : Returns latest bug reports if any

muc_message(msg)

Handler method dealing with MUC incoming messages.

Intercepts bugs number in MUC messages (as #629234), replies a bug summary.

re_bugs = re.compile('(?:(?<=#)|(?<=bugreport\\.cgi\\?bug=)|(?<=bugs\\.debian\\.org/))(\\d{6,7})')

Bug id regexp, intercepts bug id in strings : “#629234”, “bugs.debian.org/629234” and “bugreport.cgi?bug=629234”

re_pkg = re.compile('(?P<package>[0-9a-z.+-]+)$')

Package name regexp