slidge.plugins.steam#

Just a stab at steam chat.

Unfortunately the library underneath uses gevent and there is probably some work to do to make it play nice with asyncio.

Right now, listing friends + send them messages works BUT in a blocking way.

Asyncsteampy https://github.com/somespecialone/asyncsteampy might be interesting as it uses python’s asyncio BUT the login process seem a little too exotic for my taste.

Module Contents#

Classes#

Gateway

Must be subclassed by a plugin to set up various aspects of the XMPP

Contact

This class centralizes actions in relation to a specific legacy contact.

Roster

Virtual roster of a gateway user, that allows to represent all

Session

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

Attributes#

class slidge.plugins.steam.Gateway[source]#

Bases: slidge.BaseGateway[Session]

Must be subclassed by a plugin to set up various aspects of the XMPP component behaviour, such as its display name or its registration process.

On slidge launch, a singleton is instantiated, and it will be made available to public classes such LegacyContact or BaseSession as the .xmpp attribute. Since it inherits from slixmpp.componentxmpp.ComponentXMPP, this gives you a hand on low-level XMPP interactions via slixmpp plugins, 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[source]#
REGISTRATION_FIELDS[source]#
ROSTER_GROUP = Steam[source]#
COMPONENT_NAME = Steam (slidge)[source]#
COMPONENT_TYPE = steam[source]#
COMPONENT_AVATAR = https://logos-download.com/wp-content/uploads/2016/05/Steam_icon_logo_logotype.png[source]#
class slidge.plugins.steam.Contact(*a, **k)[source]#

Bases: slidge.LegacyContact[Session]

This class centralizes actions in relation to a specific legacy contact.

You shouldn’t create instances of contacts manually, but rather rely on LegacyRoster.by_legacy_id() to ensure that contact instances are singletons. The LegacyRoster instance of a session is accessible through the BaseSession.contacts attribute.

Typically, your plugin should have methods hook to the legacy events and call appropriate methods here to transmit the “legacy action” to the xmpp user. This should look like this:

Parameters
  • session – The session this contact is part of

  • legacy_id – The contact’s legacy ID

  • jid_username – User part of this contact’s ‘puppet’ JID. NB: case-insensitive, and some special characters are not allowed

MARKS = False[source]#
CORRECTION = False[source]#
RETRACTION = False[source]#
update_status(persona_state)[source]#
Parameters

persona_state (steam.enums.common.EPersonaState) –

update_reactions(timestamp)[source]#
Parameters

timestamp (int) –

class slidge.plugins.steam.Roster(session)[source]#

Bases: slidge.LegacyRoster[Contact, Session]

Virtual roster of a gateway user, that allows to represent all of their contacts as singleton instances (if used properly and not too bugged).

Every BaseSession instance will have its own LegacyRoster instance accessible via the BaseSession.contacts attribute.

Typically, you will mostly use the LegacyRoster.by_legacy_id() function to retrieve a contact instance.

You might need to override LegacyRoster.legacy_id_to_jid_username() and/or LegacyRoster.jid_username_to_legacy_id() to incorporate some custom logic if you need some characters when translation JID user parts and legacy IDs.

Parameters

session (slidge.core.session.SessionType) –

static jid_username_to_legacy_id(jid_username)[source]#

Convert a JID user part to a legacy ID.

Should be overridden in case legacy IDs are not strings, or more generally for any case where the username part of a JID (unescaped with to the mapping defined by XEP-0106) is not enough to identify a contact on the legacy network.

Default implementation is an identity operation

Parameters

jid_username (str) – User part of a JID, ie “user” in “user@example.com

Returns

An identifier for the user on the legacy network.

Return type

int

class slidge.plugins.steam.Session(user)[source]#

Bases: slidge.BaseSession[Contact, Roster, Gateway]

Represents a gateway user logged in to the 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.

static xmpp_msg_id_to_legacy_msg_id(legacy_msg_id)[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 – The XMPP stanza ID

  • legacy_msg_id (Any) –

Returns

An ID that can be used to identify a message on the legacy network

Return type

int

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’”

async idle()[source]#
on_service_method_response(msg)[source]#
on_friend_message(msg)[source]#
on_friend_reaction(msg)[source]#
on_persona_state(msg)[source]#
Parameters

msg (steam.core.msg.MsgProto) –

async logout()[source]#

Logout the gateway user from the legacy network.

Called on user unregistration and gateway shutdown.

async send_text(t, c, *, reply_to_msg_id=None)[source]#

Triggered when the user sends a text message from xmpp to a bridged contact, e.g. to translated_user_name@slidge.example.com.

Override this and implement sending a message to the legacy network in this method.

Parameters
  • t (str) – Content of the message

  • c (Contact) – Recipient of the message

  • reply_to_msg_id

Returns

An ID of some sort that can be used later to ack and mark the message as read by the user

async send_file(u, c, *, reply_to_msg_id=None)[source]#

Triggered when the user has sends a file using HTTP Upload (XEP-0363)

Parameters
  • u (str) – URL of the file

  • c (Contact) – Recipient of the file

  • reply_to_msg_id

Returns

An ID of some sort that can be used later to ack and mark the message as read by the user

async active(c)[source]#

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

Parameters

c (Contact) – Recipient of the active chat state

async inactive(c)[source]#

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

Parameters

c (Contact) –

async composing(c)[source]#

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

Parameters

c (Contact) –

async paused(c)[source]#

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

Parameters

c (Contact) –

async displayed(legacy_msg_id, c)[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
async correct(text, legacy_msg_id, c)[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 (Any) –

  • c (Contact) –

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

async react(legacy_msg_id, emojis, c)[source]#

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

Parameters
  • legacy_msg_id (Any) – 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 (Contact) – Contact the reaction refers to

async retract(legacy_msg_id, c)[source]#

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

Parameters
  • legacy_msg_id (Any) – Legacy ID of the retracted message

  • c (Contact) – The contact this retraction refers to

slidge.plugins.steam.emoji_translate[source]#