slidgram.gateway

Attributes

REGISTRATION_INSTRUCTIONS
_clients
log

Classes

Gateway

The gateway component, handling registrations and un-registrations.

Module Contents

slidgram.gateway.REGISTRATION_INSTRUCTIONS = Multiline-String

Show Value

"""You need to create a telegram account in an official telegram client.

Then you can enter your phone number here, and you will receive a confirmation code in the official telegram client. You can uninstall the telegram client after this if you want."""

class slidgram.gateway.Gateway

Bases: slidge.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:

• validate()

• validate_two_factor_code()

• get_qr_text()

• confirm_qr()

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.

REGISTRATION_INSTRUCTIONS

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

REGISTRATION_FIELDS

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

REGISTRATION_TYPE

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 = 'Telegram'

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

COMPONENT_NAME = 'Telegram (slidge)'

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

COMPONENT_TYPE = 'telegram'

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

COMPONENT_AVATAR = 'https://web.telegram.org/img/logo_share.png'

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

SEARCH_FIELDS

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.

GROUPS = True

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:

• user_jid (slixmpp.JID) – JID of the user that has just registered

• registration_form (dict[str, str | None]) – A dict where keys are the FormField.var attributes of the BaseGateway.REGISTRATION_FIELDS iterable. This dict can be modified and will be accessible as the legacy_module_data of the

:returnA dict that will be stored as the persistent “legacy_module_data”

for this user. If you don’t return anything here, the whole registration_form content will be stored.

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:

• user (slidge.command.register.GatewayUser) – The GatewayUser whose registration is pending Use their GatewayUser.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

:returnA dict which keys and values will be added to the persistent “legacy_module_data”

for this user.

async unregister(user)

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

By default, this just calls BaseSession.logout().

Parameters:

user (slidge.command.register.GatewayUser) –

slidgram.gateway._clients: dict[str, pyrogram.Client]

slidgram.gateway.log