slidge#

Most of slidge public API can be imported from this top level module.

Subpackages#

Package Contents#

Classes#

BaseGateway

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

BaseSession

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

Attributes#

user_store

class slidge.BaseGateway#

Must be subclassed by a legacy module 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.

REGISTRATION_FIELDS: Collection[slidge.command.base.FormField]#

Iterable of fields presented to the gateway user when registering using XEP-0077 extended by XEP-0004.

REGISTRATION_INSTRUCTIONS: str = 'Enter your credentials'#

The text presented to a user that wants to register (or modify) their legacy account configuration.

REGISTRATION_TYPE#

This attribute determines how users to register to the gateway, ie, how they login to the legacy service. The credentials are then stored persistently, so this process should happen once per user (unless they unregister).

The registration process always start with a basic data form (XEP-0004) presented to the user, which is send But the legacy login flow might require something more sophisticated, such as a

SINGLE_STEP_FORM: 1 step, 1 form, compatible with XEP-0077 (in-band registration).

QRCODE: The registration requires flashing a QR code in an official client. See send_qr(), get_qr_text() and confirm_qr().

TWO_FACTOR_CODE: The registration requires confirming login with a 2FA code, eg something received by email or SMS. See validate_two_factor_code().

COMPONENT_NAME: str#

Name of the component, as seen in service discovery by XMPP clients

COMPONENT_TYPE: str | None = ''#

Type of the gateway, should ideally follow https://xmpp.org/registrar/disco-categories.html

COMPONENT_AVATAR: slidge.util.types.AvatarType | None#

Path, bytes or URL used by the component as an avatar.

ROSTER_GROUP: str = 'slidge'#

Roster entries added by the plugin in the user’s roster will be part of the group specified here.

SEARCH_FIELDS: Sequence[slidge.command.base.FormField]#

Fields used for searching items via the component, through XEP-0055 (jabber search). A common use case is to allow users to search for legacy contacts by something else than their usernames, eg their phone number.

Plugins should implement search by overriding BaseSession.search(), effectively restricting search to registered users by default.

If there is only one field, it can also be used via the jabber:iq:gateway protocol described in XEP-0100. Limitation: this only works if the search request returns one result item, and if this item has a ‘jid’ var.

SEARCH_TITLE: str = 'Search for legacy contacts'#

Title of the search form.

SEARCH_INSTRUCTIONS: str = ''#

Instructions of the search form.

WELCOME_MESSAGE = "Thank you for registering. Type 'help' to list the available commands, or just start messaging away!"#

A welcome message displayed to users on registration. This is useful notably for clients that don’t consider component JIDs as a valid recipient in their UI, yet still open a functional chat window on incoming messages from components.

MARK_ALL_MESSAGES = False#

Set this to True for legacy networks that expects read marks for all messages and not just the latest one that was read (as most XMPP clients will only send a read mark for the latest msg).

PROPER_RECEIPTS = False#

Set this to True if the legacy service provides a real equivalent of message delivery receipts (XEP-0184), meaning that there is an event thrown when the actual device of a contact receives a message. Make sure to call Contact.received() adequately if this is set to True.

async validate(user_jid, registration_form)#

Validate the user’s initial registration form.

If REGISTRATION_TYPE is a RegistrationType.SINGLE_STEP_FORM

Parameters:
async unregister(user)#

Optionally override this if you need to clean additional stuff after a user has been removed from the permanent user_store.

By default, this just calls session.logout()

Parameters:

user (slidge.util.db.GatewayUser) –

async input(jid, text=None, mtype='chat', **msg_kwargs)#

Request arbitrary user input using a simple chat message, and await the result.

You shouldn’t need to call directly bust instead use BaseSession.input() to directly target a user.

Parameters:

  • jid (slixmpp.JID) – The JID we want input from

  • text – A prompt to display for the user

  • mtype (slixmpp.types.MessageTypes) – Message type

Returns:

The user’s reply

Return type:

str

async send_qr(text, **msg_kwargs)#

Sends a QR Code to a JID

You shouldn’t need to call directly bust instead use BaseSession.send_qr() to directly target a user.

Parameters:

  • text (str) – The text that will be converted to a QR Code

  • msg_kwargs – Optional additional arguments to pass to BaseGateway.send_file(), such as the recipient of the QR code.

abstract async validate_two_factor_code(user, code)#

Called when the user enters their 2FA code.

Should raise the appropriate XMPPError if the login fails

Parameters:

  • user (slidge.util.db.GatewayUser) – The gateway user whose registration is pending Use their .bare_jid and/or``.registration_form`` attributes to get what you need

  • code (str) – The code they entered, either via “chatbot” message or adhoc command

abstract async get_qr_text(user)#

This is where slidge gets the QR code content for the QR-based registration process. It will turn it into a QR code image and send it to the not-yet-fully-registered .GatewayUser

Only used in when BaseGateway.REGISTRATION_TYPE is RegistrationType.QR_CODE.

Parameters:

user (slidge.util.db.GatewayUser) – The not-yet-fully-registered GatewayUser. Use its GatewayUser.bare_jid and/or GatewayUser.registration_form attributes to get follow up on the process.

Return type:

str

async confirm_qr(user_bare_jid, exception=None)#

This should be called to finalize QR code-based registration flows.

Parameters:

  • user_bare_jid (str) – The bare JID of the almost-registered GatewayUser instance

  • exception (Optional[Exception]) – Optionally, an XMPPError to be raised to not confirm QR code flashing.

invite_to(muc, reason=None, password=None, **send_kwargs)#

Send an invitation to join a group (XEP-0249) to the user, emanating from this contact

Parameters:

  • muc (slidge.group.LegacyMUC) – the muc the user is invited to

  • reason (Optional[str]) – a text explaining why the user should join this muc

  • password (Optional[str]) – maybe this will make sense later? not sure

  • send_kwargs – additional kwargs to be passed to _send() (internal use by slidge)

active(**kwargs)#

Send an “active” chat state (XEP-0085) from this contact to the user.

composing(**kwargs)#

Send a “composing” (ie “typing notification”) chat state (XEP-0085) from this contact to the user.

paused(**kwargs)#

Send a “paused” (ie “typing paused notification”) chat state (XEP-0085) from this contact to the user.

inactive(**kwargs)#

Send an “inactive” (ie “contact has not interacted with the chat session interface for an intermediate period of time”) chat state (XEP-0085) from this contact to the user.

gone(**kwargs)#

Send a “gone” (ie “contact has not interacted with the chat session interface, system, or device for a relatively long period of time”) chat state (XEP-0085) from this contact to the user.

ack(legacy_msg_id, **kwargs)#

Send an “acknowledged” message marker (XEP-0333) from this contact to the user.

Parameters:

legacy_msg_id (slidge.util.types.LegacyMessageType) – The message this marker refers to

received(legacy_msg_id, **kwargs)#

Send a “received” message marker (XEP-0333) from this contact to the user. For LegacyContacts, also send a delivery receipt marker (XEP-0184)

Parameters:

legacy_msg_id (slidge.util.types.LegacyMessageType) – The message this marker refers to

displayed(legacy_msg_id, **kwargs)#

Send a “displayed” message marker (XEP-0333) from this contact to the user.

Parameters:

legacy_msg_id (slidge.util.types.LegacyMessageType) – The message this marker refers to

send_text(body, legacy_msg_id=None, *, when=None, reply_to=None, thread=None, hints=None, carbon=False, archive_only=False, correction=False, correction_event_id=None, **send_kwargs)#

Transmit a message from the entity to the user

Parameters:

  • body (str) – Content of the message

  • legacy_msg_id (Optional[slidge.util.types.LegacyMessageType]) – If you want to be able to transport read markers from the gateway user to the legacy network, specify this

  • when (Optional[datetime.datetime]) – when the message was sent, for a “delay” tag (XEP-0203)

  • reply_to (Optional[slidge.util.types.MessageReference]) – Quote another message (XEP-0461)

  • hints (Optional[Iterable[slidge.util.types.ProcessingHint]]) –

  • thread (Optional[slidge.util.types.LegacyThreadType]) –

  • carbon – (only in 1:1) Reflect a message sent to this Contact by the user. Use this to synchronize outgoing history for legacy official apps.

  • correction – whether this message is a correction or not

  • correction_event_id (Optional[slidge.util.types.LegacyMessageType]) – in the case where an ID is associated with the legacy ‘correction event’, specify it here to use it on the XMPP side. If not specified, a random ID will be used.

  • archive_only – (only in groups) Do not send this message to user, but store it in the archive. Meant to be used during MUC.backfill()

correct(legacy_msg_id, new_text, *, when=None, reply_to=None, thread=None, hints=None, carbon=False, archive_only=False, correction_event_id=None, **send_kwargs)#

Call this when a legacy contact has modified his last message content.

Uses last message correction (XEP-0308)

Parameters:

  • new_text (str) – New content of the message

  • legacy_msg_id (slidge.util.types.LegacyMessageType) – The legacy message ID of the message to correct

  • when (Optional[datetime.datetime]) – when the message was sent, for a “delay” tag (XEP-0203)

  • reply_to (Optional[slidge.util.types.MessageReference]) – Quote another message (XEP-0461)

  • hints (Optional[Iterable[slidge.util.types.ProcessingHint]]) –

  • thread (Optional[slidge.util.types.LegacyThreadType]) –

  • carbon – (only in 1:1) Reflect a message sent to this Contact by the user. Use this to synchronize outgoing history for legacy official apps.

  • archive_only – (only in groups) Do not send this message to user, but store it in the archive. Meant to be used during MUC.backfill()

  • correction_event_id (Optional[slidge.util.types.LegacyMessageType]) – in the case where an ID is associated with the legacy ‘correction event’, specify it here to use it on the XMPP side. If not specified, a random ID will be used.

react(legacy_msg_id, emojis=(), thread=None, **kwargs)#

Call this when a legacy contact reacts to a message

Parameters:

  • legacy_msg_id (slidge.util.types.LegacyMessageType) – The message which the reaction refers to.

  • emojis (Iterable[str]) – An iterable of emojis used as reactions

  • thread (Optional[slidge.util.types.LegacyThreadType]) –

retract(legacy_msg_id, thread=None, **kwargs)#

Call this when a legacy contact retracts (XEP-0424) a message

Parameters:

  • legacy_msg_id (slidge.util.types.LegacyMessageType) – Legacy ID of the message to delete

  • thread (Optional[slidge.util.types.LegacyThreadType]) –

async send_file(file_path=None, legacy_msg_id=None, *, data_stream=None, data=None, file_url=None, file_name=None, content_type=None, reply_to=None, when=None, caption=None, legacy_file_id=None, thread=None, **kwargs)#

Send a message with an attachment

Parameters:

  • file_path (Optional[Union[pathlib.Path, str]]) – Path to the attachment

  • data_stream (Optional[IO[bytes]]) – Alternatively, a stream of bytes (such as a File object)

  • data (Optional[bytes]) – Alternatively, a bytes object

  • file_url (Optional[str]) – Alternatively, a URL

  • file_name (Optional[str]) – How the file should be named.

  • content_type (Optional[str]) – MIME type, inferred from filename if not given

  • legacy_msg_id (Optional[slidge.util.types.LegacyMessageType]) – If you want to be able to transport read markers from the gateway user to the legacy network, specify this

  • reply_to (Optional[slidge.util.types.MessageReference]) – Quote another message (XEP-0461)

  • when (Optional[datetime.datetime]) – when the file was sent, for a “delay” tag (XEP-0203)

  • caption (Optional[str]) – an optional text that is linked to the file

  • legacy_file_id (Optional[Union[str, int]]) – A unique identifier for the file on the legacy network. Plugins should try their best to provide it, to avoid duplicates.

  • thread (Optional[slidge.util.types.LegacyThreadType]) –

Return type:

tuple[Optional[str], list[slixmpp.Message]]

class slidge.BaseSession(user)#

Represents a gateway user logged in to the legacy 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.

Parameters:

user (slidge.util.db.GatewayUser) –

xmpp: slidge.core.gateway.BaseGateway#

The gateway instance singleton. Use it for low-level XMPP calls or custom methods that are not session-specific.

MESSAGE_IDS_ARE_THREAD_IDS = False#

Set this to True if the legacy service uses message IDs as thread IDs, eg Mattermost, where you can only ‘create a thread’ by replying to the message, in which case the message ID is also a thread ID (and all messages are potential threads).

static legacy_msg_id_to_xmpp_msg_id(legacy_msg_id)#

Convert a legacy msg ID to a valid XMPP msg ID. Needed for read marks and message corrections.

The default implementation just converts the legacy ID to a str, but this should be overridden in case some characters needs to be escaped, or to add some additional, legacy network-specific logic.

Parameters:

legacy_msg_id (slidge.util.types.LegacyMessageType) –

Returns:

Should return a string that is usable as an XMPP stanza ID

Return type:

str

static xmpp_msg_id_to_legacy_msg_id(i)#

Convert a legacy XMPP ID to a valid XMPP msg ID. Needed for read marks and message corrections.

The default implementation just converts the legacy ID to a str, but this should be overridden in case some characters needs to be escaped, or to add some additional, legacy network-specific logic.

The default implementation is an identity function

Parameters:

i (str) – The XMPP stanza ID

Returns:

An ID that can be used to identify a message on the legacy network

Return type:

slidge.util.types.LegacyMessageType

send_gateway_status(status=None, show=Optional[PresenceShows], **kwargs)#

Send a presence from the gateway to the user.

Can be used to indicate the user session status, ie “SMS code required”, “connected”, …

Parameters:

  • status (Optional[str]) – A status message

  • show – Presence stanza ‘show’ element. I suggest using “dnd” to show that the gateway is not fully functional

send_gateway_message(text, **msg_kwargs)#

Send a message from the gateway component to the user.

Can be used to indicate the user session status, ie “SMS code required”, “connected”, …

Parameters:

text (str) – A text

send_gateway_invite(muc, reason=None, password=None)#

Send an invitation to join a MUC, emanating from the gateway component.

Parameters:
async input(text, **msg_kwargs)#

Request user input via direct messages.

Wraps call to BaseSession.input()

Parameters:

  • text (str) – The prompt to send to the user

  • msg_kwargs – Extra attributes

Returns:

async send_qr(text)#

Sends a QR code generated from ‘text’ via HTTP Upload and send the URL to self.user

Parameters:

text (str) – Text to encode as a QR code

abstract async login()#

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’”

Return type:

Optional[str]

abstract async logout()#

Logout the gateway user from the legacy network.

Called on user unregistration and gateway shutdown.

re_login()#

Logout then re-login

No reason to override this

abstract async send_text(chat, text, *, reply_to_msg_id=None, reply_to_fallback_text=None, reply_to=None, thread=None)#

Triggered when the user sends a text message from XMPP to a bridged entity, e.g. to translated_user_name@slidge.example.com, or translated_group_name@slidge.example.com

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

Parameters:

  • text (str) – Content of the message

  • chat (slidge.util.types.RecipientType) – RecipientType of the message. LegacyContact instance for 1:1 chat, MUC instance for groups.

  • reply_to_msg_id (Optional[slidge.util.types.LegacyMessageType]) – A legacy message ID if the message references (quotes) another message (XEP-0461)

  • reply_to_fallback_text (Optional[str]) – Content of the quoted text. Not necessarily set by XMPP clients

  • reply_to (Optional[slidge.util.types.Sender]) – Author of the quoted message. LegacyContact instance for 1:1 chat, LegacyParticipant instance for groups. If None, should be interpreted as a self-reply if reply_to_msg_id is not None.

  • thread (Optional[slidge.util.types.LegacyThreadType]) –

Returns:

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

Return type:

Optional[slidge.util.types.LegacyMessageType]

abstract async send_file(chat, url, *, http_response, reply_to_msg_id=None, reply_to_fallback_text=None, reply_to=None, thread=None)#

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:

Optional[slidge.util.types.LegacyMessageType]

abstract async active(c, thread=None)#

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

Parameters:

  • thread (Optional[slidge.util.types.LegacyThreadType]) –

  • c (slidge.util.types.RecipientType) – RecipientType of the active chat state

abstract async inactive(c, thread=None)#

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

Parameters:

  • thread (Optional[slidge.util.types.LegacyThreadType]) –

  • c (slidge.util.types.RecipientType) –

abstract async composing(c, thread=None)#

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

Parameters:

  • thread (Optional[slidge.util.types.LegacyThreadType]) –

  • c (slidge.util.types.RecipientType) –

abstract async paused(c, thread=None)#

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

Parameters:

  • thread (Optional[slidge.util.types.LegacyThreadType]) –

  • c (slidge.util.types.RecipientType) –

abstract async displayed(c, legacy_msg_id, thread=None)#

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:

  • thread (Optional[slidge.util.types.LegacyThreadType]) –

  • legacy_msg_id (slidge.util.types.LegacyMessageType) – Identifier of the message, passed to slidge.LegacyContact.send_text() or slidge.LegacyContact.send_file()

  • c (slidge.util.types.RecipientType) –

abstract async correct(c, text, legacy_msg_id, thread=None)#

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:

  • thread (Optional[slidge.util.types.LegacyThreadType]) –

  • text (str) –

  • legacy_msg_id (slidge.util.types.LegacyMessageType) –

  • c (slidge.util.types.RecipientType) –

Return type:

Optional[slidge.util.types.LegacyMessageType]

abstract async search(form_values)#

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:

Return type:

Optional[slidge.command.SearchResult]

abstract async react(c, legacy_msg_id, emojis, thread=None)#

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

Parameters:

  • thread (Optional[slidge.util.types.LegacyThreadType]) –

  • legacy_msg_id (slidge.util.types.LegacyMessageType) – ID of the message the user reacts to

  • emojis (list[str]) – 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 (slidge.util.types.RecipientType) – Contact or MUC the reaction refers to

abstract async retract(c, legacy_msg_id, thread=None)#

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

Parameters:

  • thread (Optional[slidge.util.types.LegacyThreadType]) –

  • legacy_msg_id (slidge.util.types.LegacyMessageType) – Legacy ID of the retracted message

  • c (slidge.util.types.RecipientType) – The contact this retraction refers to

abstract async presence(resource, show, status, resources, merged_resource)#

Called when the gateway component receives a presence, ie, when one of the user’s clients goes online of offline, or changes its status.

Parameters:

  • resource (str) – The XMPP client identifier, arbitrary string.

  • show (slidge.util.types.PseudoPresenceShow) – The presence <show>, if available. If the resource is just ‘available’ without any <show> element, this is an empty str.

  • status (str) – A status message, like a deeply profound quote, eg, “Roses are red, violets are blue, [INSERT JOKE]”.

  • resources (dict[str, slidge.util.types.ResourceDict]) – A summary of all the resources for this user.

  • merged_resource (Optional[slidge.util.types.ResourceDict]) – A global presence for the user account, following rules described in merge_resources()