slidge.core.command#

This module implements an unified way to define ad-hoc or chatbot-type commands

Submodules#

Package Contents#

Classes#

Command

Abstract base class to implement gateway commands (chatbot and ad-hoc)

CommandAccess

Defines who can access a given Command

Confirmation

A confirmation 'dialog'

Form

A form, to request user input

FormField

Represents a field of the form that a user will see when registering to the gateway

SearchResult

Results of the search command (search for contacts via Jabber Search)

TableResult

Structured data as the result of a command

Attributes#

CommandResponseType

class slidge.core.command.Command(xmpp)[source]#

Bases: abc.ABC

Abstract base class to implement gateway commands (chatbot and ad-hoc)

Parameters:

xmpp (slidge.core.gateway.BaseGateway) –

NAME: str#

Friendly name of the command, eg: “do something with stuff”

HELP: str#

Long description of what the command does

NODE: str#

Name of the node used for ad-hoc commands

CHAT_COMMAND: str#

Text to send to the gateway to trigger the command via a message

ACCESS: CommandAccess#

Who can use this command

subclasses#
classmethod __init_subclass__(**kwargs)#
async run(session, ifrom, *args)#

Entry point of the command

Parameters:

  • session (Optional[slidge.core.session.BaseSession]) – If triggered by a registered user, its slidge Session

  • ifrom (slixmpp.JID) – JID of the command-triggering entity

  • args – When triggered via chatbot type message, additional words after the CHAT_COMMAND string was passed

Returns:

Either a TableResult, a Form, a Confirmation, a text, or None

Return type:

CommandResponseType

_get_session(jid)#
Parameters:

jid (slixmpp.JID) –

raise_if_not_authorized(jid)#

Raise an appropriate error is jid is not authorized to use the command

Parameters:

jid (slixmpp.JID) – jid of the entity trying to access the command

:return:session of JID if it exists

class slidge.core.command.CommandAccess[source]#

Bases: int, enum.Enum

Defines who can access a given Command

Initialize self. See help(type(self)) for accurate signature.

ADMIN_ONLY = 0#
USER = 1#
USER_LOGGED = 2#
USER_NON_LOGGED = 3#
NON_USER = 4#
ANY = 5#
slidge.core.command.CommandResponseType[source]#
class slidge.core.command.Confirmation[source]#

A confirmation ‘dialog’

prompt: str#

The text presented to the command triggering user

handler: Callable#

An async function that should return a ResponseType

success: str | None#

Text in case of success, used if handler does not return anything

handler_args: Iterable[Any]#

arguments passed to the handler

handler_kwargs: dict[str, Any]#

keyword arguments passed to the handler

get_form()#

Get the slixmpp form

Returns:

some xml

class slidge.core.command.Form[source]#

A form, to request user input

title: str#
instructions: str#
fields: Collection[FormField]#
handler: Callable#
handler_args: Iterable[Any]#
handler_kwargs: dict[str, Any]#
get_values(slix_form)#

Parse form submission

Parameters:

slix_form (slixmpp.plugins.xep_0004.Form) – the xml received as the submission of a form

Returns:

A dict where keys=field.var and values are either strings or JIDs (if field.type=jid-single)

Return type:

dict[str, Union[str, slixmpp.JID]]

get_xml()#

Get the slixmpp “form”

Returns:

some XML

class slidge.core.command.FormField[source]#

Represents a field of the form that a user will see when registering to the gateway via their XMPP client.

var: str = ''#

Internal name of the field, will be used to retrieve via slidge.GatewayUser.registration_form

label: str | None#

Description of the field that the user will see

required: bool = False#

Whether this field is mandatory or not

private: bool = False#

For sensitive info that should not be displayed on screen while the user types. Forces field_type to “text-private”

type: slidge.util.types.FieldType = 'text-single'#

Type of the field, see XEP-0004

value: str = ''#

Pre-filled value. Will be automatically pre-filled if a registered user modifies their subscription

options: list[Option] | None#
image_url: str | None#

An image associated to this field, eg, a QR code

dict()#
__post_init__()#
__acceptable_options()#
validate(value)#

Raise appropriate XMPPError if a given value is valid for this field

Parameters:

value (str) – The value to test

Returns:

The same value OR a JID if self.type=jid-single

get_xml()#

Get the field in slixmpp format

Returns:

some XML

class slidge.core.command.SearchResult[source]#

Bases: TableResult

Results of the search command (search for contacts via Jabber Search)

description: str = 'Contact search results'#
class slidge.core.command.TableResult[source]#

Structured data as the result of a command

fields: Collection[FormField]#

The ‘columns names’ of the table.

items: Collection[dict[str, str]]#

The rows of the table. Each row is a dict where keys are the fields var attribute.

description: str#

A description of the content of the table.

jids_are_mucs: bool = False#
get_xml()#

Get a slixmpp “form” (with <reported> header)to represent the data

Returns:

some XML