slidge.core.session#

Module Contents#

Classes#

BaseSession

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

Functions#

ignore_sent_carbons(func)

remove_emoji_variation_selector_16(emoji)

Attributes#

_sessions

log

slidge.core.session.ignore_sent_carbons(func)[source]#
class slidge.core.session.BaseSession(user)[source]#

Bases: Generic[slidge.util.types.LegacyMessageType, slidge.util.types.RecipientType]

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) –

property logged[source]#
sent: slidge.util.BiDict[slidge.util.types.LegacyMessageType, str][source]#

Since we cannot set the XMPP ID of messages sent by XMPP clients, we need to keep a mapping between XMPP IDs and legacy message IDs if we want to further refer to a message that was sent by the user. This also applies to ‘carboned’ messages, ie, messages sent by the user from the official client of a legacy network.

xmpp: slidge.core.gateway.BaseGateway[source]#

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

http: aiohttp.ClientSession[source]#
MESSAGE_IDS_ARE_THREAD_IDS = False[source]#

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).

__reset_ready()[source]#
__repr__()[source]#

Return repr(self).

shutdown()[source]#
static legacy_msg_id_to_xmpp_msg_id(legacy_msg_id)[source]#

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)[source]#

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

raise_if_not_logged()[source]#
classmethod _from_user_or_none(user)[source]#
classmethod from_user(user)[source]#
classmethod from_stanza(s)[source]#

Get a user’s LegacySession using the “from” field of a stanza

Meant to be called from BaseGateway only.

Parameters:

s –

Returns:

Return type:

BaseSession

classmethod from_jid(jid)[source]#

Get a user’s LegacySession using its jid

Meant to be called from BaseGateway only.

Parameters:

jid (slixmpp.JID) –

Returns:

Return type:

BaseSession

async classmethod kill_by_jid(jid)[source]#

Terminate a user session.

Meant to be called from BaseGateway only.

Parameters:

jid (slixmpp.JID) –

Returns:

async send_from_msg(m)[source]#

Meant to be called from BaseGateway only.

Parameters:

m (slixmpp.Message) –

Returns:

async __xmpp_to_legacy_thread(msg, recipient)[source]#
Parameters:

  • msg (slixmpp.Message) –

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

__ack(msg)[source]#
Parameters:

msg (slixmpp.Message) –

async __get_entity(m)[source]#
Parameters:

m (slixmpp.Message) –

Return type:

slidge.util.types.RecipientType

async active_from_msg(m)[source]#

Meant to be called from BaseGateway only.

Parameters:

m (slixmpp.Message) –

Returns:

async inactive_from_msg(m)[source]#

Meant to be called from BaseGateway only.

Parameters:

m (slixmpp.Message) –

Returns:

async composing_from_msg(m)[source]#

Meant to be called from BaseGateway only.

Parameters:

m (slixmpp.Message) –

Returns:

async paused_from_msg(m)[source]#

Meant to be called from BaseGateway only.

Parameters:

m (slixmpp.Message) –

Returns:

__xmpp_msg_id_to_legacy(xmpp_id)[source]#
Parameters:

xmpp_id (str) –

async displayed_from_msg(m)[source]#

Meant to be called from BaseGateway only.

Parameters:

m (slixmpp.Message) –

Returns:

async correct_from_msg(m)[source]#
Parameters:

m (slixmpp.Message) –

async react_from_msg(m)[source]#
Parameters:

m (slixmpp.Message) –

async retract_from_msg(m)[source]#
Parameters:

m (slixmpp.Message) –

async join_groupchat(p)[source]#
Parameters:

p (slixmpp.Presence) –

async __get_contact_or_ignore_or_raise(p)[source]#
Parameters:

p (slixmpp.Presence) –

async on_subscribe(p)[source]#

Called when receiving a “subscribe” presence, which is more or less a “friend request”.

Right now, this is mostly a placeholder for a future friend request workflow, but is useful to ensure avatars and nicks ard broadcast when XEP-0356 is not available for slidge

Parameters:

p (slixmpp.Presence) –

async on_subscribed(p)[source]#

Called when receiving a “subscribed” presence, confirming that a contact is in the roster.

Right now, this is mostly a placeholder for a future friend request workflow, but is useful to ensure avatars and nicks ard broadcast when XEP-0356 is not available for slidge

Parameters:

p (slixmpp.Presence) –

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

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)[source]#

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 – A text

async input(text, **msg_kwargs)[source]#

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)[source]#

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()[source]#

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()[source]#

Logout the gateway user from the legacy network.

Called on user unregistration and gateway shutdown.

re_login()[source]#

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)[source]#

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)[source]#

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)[source]#

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

Parameters:

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

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

abstract async inactive(c, thread=None)[source]#

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

Parameters:

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

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

abstract async composing(c, thread=None)[source]#

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

Parameters:

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

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

abstract async paused(c, thread=None)[source]#

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

Parameters:

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

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

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

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:
abstract async correct(c, text, legacy_msg_id, thread=None)[source]#

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:

  • text (str) –

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

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

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

Return type:

Optional[slidge.util.types.LegacyMessageType]

abstract async search(form_values)[source]#

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.core.command.base.SearchResult]

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

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

Parameters:

  • 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

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

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

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

Parameters:

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

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

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

async get_contact_or_group_or_participant(jid)[source]#
Parameters:

jid (slixmpp.JID) –

async wait_for_ready(timeout=10)[source]#

Wait until session, contacts and bookmarks are ready

(slidge internal use)

Parameters:

timeout (Optional[Union[int, float]]) –

Returns:

slidge.core.session.remove_emoji_variation_selector_16(emoji)[source]#
Parameters:

emoji (str) –

slidge.core.session._sessions: dict[slidge.util.db.GatewayUser, BaseSession][source]#
slidge.core.session.log[source]#