slidge.core.gateway
#
Submodules#
Package Contents#
Classes#
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
orBaseSession
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()
orreact()
are the same as those ofLegacyContact
andLegacyParticipant
, 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_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 withLegacyContact.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.
- 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 aRegistrationType.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. IfREGISTRATION_FIELDS
is an empty list (ie, it declares noFormField
), the “form” is effectively a confirmation dialog displayingREGISTRATION_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 theBaseGateway.REGISTRATION_FIELDS
iterable
- 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
isRegistrationType.TWO_FACTOR_CODE
.- Parameters:
user (slidge.util.db.GatewayUser) – The
GatewayUser
whose registration is pending Use theirGatewayUser.bare_jid
and/orregistration_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
isRegistrationType.QRCODE
.- Parameters:
user (slidge.util.db.GatewayUser) – The
GatewayUser
whose registration is pending Use theirGatewayUser.bare_jid
and/orregistration_form
attributes to get what you need.- Return type:
- 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
isRegistrationType.QRCODE
.
- 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:
- 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
- invite_to(muc, reason=None, password=None, **send_kwargs)#
Send an invitation to join a group (XEP-0249) from this XMPP Entity.
- 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 XMPP Entity.
- composing(**kwargs)#
Send a “composing” (ie “typing notification”) chat state (XEP-0085) from this XMPP Entity.
- paused(**kwargs)#
Send a “paused” (ie “typing paused notification”) chat state (XEP-0085) from this XMPP Entity.
- 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 XMPP Entity.
- 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 XMPP Entity.
- ack(legacy_msg_id, **kwargs)#
Send an “acknowledged” message marker (XEP-0333) from this XMPP Entity.
- 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 XMPP Entity. If called on a
LegacyContact
, 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 XMPP Entity.
- 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, link_previews=None, **send_kwargs)#
Send a text message from this XMPP Entity.
- 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 used if called on a
LegacyContact
) Set this toTrue
if this is actually a message sent to theLegacyContact
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.
link_previews (Optional[list[slidge.util.types.LinkPreview]]) – A little of sender (or server, or gateway)-generated previews of URLs linked in the body.
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, link_previews=None, **send_kwargs)#
Modify a message that was previously sent by this XMPP Entity.
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.
link_previews (Optional[list[slidge.util.types.LinkPreview]]) – A little of sender (or server, or gateway)-generated previews of URLs linked in the body.
- react(legacy_msg_id, emojis=(), thread=None, **kwargs)#
Send a reaction (XEP-0444) from this XMPP Entity.
- 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)#
Send a message retraction (XEP-0424) from this XMPP Entity.
- 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 single file from this XMPP Entity.
- 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: