sleamdge.gateway

Attributes

log

Classes

Gateway

The gateway component, handling registrations and un-registrations.

Module Contents

class sleamdge.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 = 'Enter steam credentials'

REGISTRATION_FIELDS

REGISTRATION_TYPE

ROSTER_GROUP = 'Steam'

SEARCH_FIELDS

COMPONENT_NAME = 'Steam (slidge)'

COMPONENT_TYPE = 'steam'

COMPONENT_AVATAR = 'https://logos-download.com/wp-content/uploads/2016/05/Steam_icon_logo_logotype.png'

GROUPS = True

LEGACY_MSG_ID_TYPE

LEGACY_CONTACT_ID_TYPE

LEGACY_ROOM_ID_TYPE

__pending

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, Optional[str]]) – 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.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

Return type:

dict

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

for this user.

sleamdge.gateway.log