slidge.core.gateway#

Submodules#

Package Contents#

Classes#

BaseGateway

The gateway component, handling registrations and un-registrations.

class slidge.core.gateway.BaseGateway#

The gateway component, handling registrations and un-registrations.

On slidge launch, a singleton is instantiated, and it will be made available to public classes such LegacyContact or BaseSession as the .xmpp attribute.

Must be subclassed by a legacy module to set up various aspects of the XMPP component behaviour, such as its display name or welcome message, via class attributes COMPONENT_NAME WELCOME_MESSAGE.

Abstract methods related to the registration process must be overriden for a functional Legacy Module:

NB: Not all of these must be overridden, it depends on the REGISTRATION_TYPE.

The other methods, such as send_text() or react() are the same as those of LegacyContact and LegacyParticipant, because the component itself is also a “messaging actor”, ie, an XMPP Entity. For these methods, you need to specify the JID of the recipient with the mto parameter.

Since it inherits from slixmpp.componentxmpp.ComponentXMPP,you also have a hand on low-level XMPP interactions via slixmpp methods, 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: str#

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

COMPONENT_TYPE: str = ''#

Type of the gateway, should 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.

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: slidge.command.register.RegistrationType#

This attribute determines how users 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. But the legacy login flow might require something more sophisticated, see RegistrationType for more details.

ROSTER_GROUP: str = 'slidge'#

Name of the group assigned to a LegacyContact automagically added to the User’s roster with LegacyContact.add_to_roster().

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.

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() (restricted to registered users).

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.

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.

abstract async validate(user_jid, registration_form)#

Validate a user’s initial registration form.

Should raise the appropriate slixmpp.exceptions.XMPPError if the registration does not allow to continue the registration process.

If REGISTRATION_TYPE is a RegistrationType.SINGLE_STEP_FORM, this method should raise something if it wasn’t possible to successfully log in to the legacy service with the registration form content.

It is also used for other types of REGISTRATION_TYPE too, since the first step is always a form. If REGISTRATION_FIELDS is an empty list (ie, it declares no FormField), the “form” is effectively a confirmation dialog displaying REGISTRATION_INSTRUCTIONS.

Parameters:
abstract async validate_two_factor_code(user, code)#

Called when the user enters their 2FA code.

Should raise the appropriate slixmpp.exceptions.XMPPError if the login fails, and return successfully otherwise.

Only used when REGISTRATION_TYPE is RegistrationType.TWO_FACTOR_CODE.

Parameters:
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.QRCODE.

Parameters:

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

Return type:

str

async confirm_qr(user_bare_jid, exception=None)#

This method is meant to be called to finalize QR code-based registration flows, once the legacy service confirms the QR flashing.

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

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.

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 BaseSession.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 this 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