slidge.plugins.dummy#

A pseudo legacy network, to easily test things

Module Contents#

Classes#

Gateway

Must be subclassed by a plugin to set up various aspects of the XMPP

Session

Represents a gateway user logged in to the network and performing actions.

Attributes#

slidge.plugins.dummy.ASSETS_DIR[source]#
class slidge.plugins.dummy.Gateway[source]#

Bases: slidge.BaseGateway

Must be subclassed by a plugin to set up various aspects of the XMPP component behaviour, such as its display name or its registration process.

On slidge launch, a singleton is instantiated, and it will be made available to public classes such LegacyContact or BaseSession as the .xmpp attribute. Since it inherits from slixmpp.componentxmpp.ComponentXMPP, this gives you a hand on low-level XMPP interactions via slixmpp plugins, e.g.:

self.send_presence(
    pfrom="somebody@component.example.com",
    pto="someonwelse@anotherexample.com",
)

However, you should not need to do so often since the classes of the plugin API provides higher level abstractions around most commonly needed use-cases, such as sending messages, or displaying a custom status.

COMPONENT_NAME = The great legacy network (slidge)[source]#
COMPONENT_AVATAR[source]#
COMPONENT_TYPE = aim[source]#
REGISTRATION_INSTRUCTIONS = Multiline-String[source]#
Show Value
1Only username 'n' is accepted and only 'baba' and 'bibi' contacts exist.
2You can use any password you want.
REGISTRATION_FIELDS[source]#
async validate(user_jid, registration_form)[source]#

Validate a registration form from a user.

Since XEP-0077 is pretty limited in terms of validation, it is OK to validate anything that looks good here and continue the legacy auth process via direct messages to the user (using BaseGateway.input() for instance)

Parameters
class slidge.plugins.dummy.Session(user)[source]#

Bases: slidge.BaseSession[slidge.LegacyContact, slidge.LegacyRoster, Gateway]

Represents a gateway user logged in to the network and performing actions.

Will be instantiated automatically when a user sends an online presence to the gateway component, as per XEP-0100.

Must be subclassed for a functional slidge plugin.

async backfill()[source]#
async paused(c)[source]#

Triggered when the user pauses typing in the window of a legacy contact (XEP-0085)

Parameters

c (slidge.LegacyContact) –

async correct(text, legacy_msg_id, c)[source]#

Triggered when the user corrected a message using XEP-0308

This is only possible if a valid legacy_msg_id was passed when transmitting a message from a contact to the user in LegacyContact.send_text() or slidge.LegacyContact.send_file().

Parameters
async login()[source]#

Login the gateway user to the legacy network.

Triggered when the gateway start and on user registration. It is recommended that this function returns once the user is logged in, so if you need to await forever (for instance to listen to incoming events), it’s a good idea to wrap your listener in an asyncio.Task.

Returns

Optionally, a text to use as the gateway status, e.g., “Connected as ‘dude@legacy.network’”

async logout()[source]#

Logout the gateway user from the legacy network.

Called on user unregistration and gateway shutdown.

async send_text(t, c, *, reply_to_msg_id=None)[source]#

Triggered when the user sends a text message from xmpp to a bridged contact, e.g. to translated_user_name@slidge.example.com.

Override this and implement sending a message to the legacy network in this method.

Parameters
Returns

An ID of some sort that can be used later to ack and mark the message as read by the user

async crash()[source]#
async send_file(u, c, *, reply_to_msg_id=None)[source]#

Triggered when the user has sends a file using HTTP Upload (XEP-0363)

Parameters
Returns

An ID of some sort that can be used later to ack and mark the message as read by the user

Return type

int

async later(c, trigger_msg_id)[source]#
Parameters
async later_carbon_delete(c, trigger_msg_id)[source]#
Parameters
async active(c)[source]#

Triggered when the user sends an ‘active’ chat state to the legacy network (XEP-0085)

Parameters

c (slidge.LegacyContact) – Recipient of the active chat state

async inactive(c)[source]#

Triggered when the user sends an ‘inactive’ chat state to the legacy network (XEP-0085)

Parameters

c (slidge.LegacyContact) –

async composing(c)[source]#

Triggered when the user starts typing in the window of a legacy contact (XEP-0085)

Parameters

c (slidge.LegacyContact) –

async displayed(legacy_msg_id, c)[source]#

Triggered when the user reads a message sent by a legacy contact. (XEP-0333)

This is only possible if a valid legacy_msg_id was passed when transmitting a message from a contact to the user in LegacyContact.sent_text() or slidge.LegacyContact.send_file().

Parameters
async search(form_values)[source]#

Triggered when the user uses Jabber Search (XEP-0055) on the component

Form values is a dict in which keys are defined in BaseGateway.SEARCH_FIELDS

Parameters

form_values (dict[str, str]) – search query, defined for a specific plugin by overriding in BaseGateway.SEARCH_FIELDS

Returns

async react(legacy_msg_id, emojis, c)[source]#

Triggered when the user sends message reactions (XEP-0444).

Parameters
  • legacy_msg_id – ID of the message the user reacts to

  • emojis – Unicode characters representing reactions to the message legacy_msg_id. An empty string means “no reaction”, ie, remove all reactions if any were present before

  • c – Contact the reaction refers to

async retract(legacy_msg_id, c)[source]#

Triggered when the user retracts (XEP-0424) a message.

Parameters
  • legacy_msg_id – Legacy ID of the retracted message

  • c – The contact this retraction refers to

slidge.plugins.dummy.BUDDIES = ['baba', 'bibi'][source]#
slidge.plugins.dummy.AVATARS = [][source]#
slidge.plugins.dummy.log[source]#