matridge.session
================

.. py:module:: matridge.session


Attributes
----------

.. autoapisummary::

   matridge.session.Sender
   matridge.session.Recipient
   matridge.session.PRESENCE_DICT


Classes
-------

.. autoapisummary::

   matridge.session.Session


Module Contents
---------------

.. py:data:: Sender

.. py:data:: Recipient

.. py:class:: Session(*a)

   Bases: :py:obj:`slidge.BaseSession`\ [\ :py:obj:`str`\ , :py:obj:`Recipient`\ ]


   The session of a registered :term:`User`.

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

   Will be instantiated automatically on slidge startup for each registered user,
   or upon registration for new (validated) users.

   Must be subclassed for a functional :term:`Legacy Module`.


   .. py:attribute:: bookmarks
      :type:  matridge.group.Bookmarks


   .. py:attribute:: contacts
      :type:  matridge.contact.Roster


   .. py:attribute:: matrix
      :type:  matridge.matrix.Client


   .. py:attribute:: MESSAGE_IDS_ARE_THREAD_IDS
      :value: True


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



   .. py:attribute:: events_to_ignore


   .. py:attribute:: send_lock


   .. py:method:: migrate_shelf()


   .. py:method:: login()
      :async:


      Logs in 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.

      :return: Optionally, a text to use as the gateway status, e.g., "Connected as 'dude@legacy.network'"



   .. py:method:: logout()
      :async:


      Logs out the gateway user from the legacy network.

      Called on gateway shutdown.



   .. py:method:: __relates_to(room_id, content, reply_to_msg_id, thread)
      :async:



   .. py:method:: __handle_response(response)
      :async:



   .. py:method:: __room_send(chat, content, message_type='m.room.message')
      :async:



   .. py:method:: on_text(chat, text, *, reply_to_msg_id = None, reply_to_fallback_text = None, reply_to = None, thread = None, link_previews = (), mentions = None)
      :async:


      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.

      :param text: Content of the message
      :param chat: Recipient of the message. :class:`.LegacyContact` instance for 1:1 chat,
          :class:`.MUC` instance for groups.
      :param reply_to_msg_id: A legacy message ID if the message references (quotes)
          another message (:xep:`0461`)
      :param reply_to_fallback_text: Content of the quoted text. Not necessarily set
          by XMPP clients
      :param reply_to: Author of the quoted message. :class:`LegacyContact` instance for
          1:1 chat, :class:`LegacyParticipant` instance for groups.
          If `None`, should be interpreted as a self-reply if reply_to_msg_id is not None.
      :param link_previews: A list of sender-generated link previews.
          At the time of writing, only `Cheogram <https://wiki.soprani.ca/CheogramApp/LinkPreviews>`_
          supports it.
      :param mentions: (only for groups) A list of Contacts mentioned by their
          nicknames.
      :param thread:

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



   .. py:method:: on_file(chat, url, *, http_response, reply_to_msg_id = None, reply_to_fallback_text = None, reply_to = None, thread = None)
      :async:


      Triggered when the user sends a file using HTTP Upload (:xep:`0363`)

      :param url: URL of the file
      :param chat: See :meth:`.BaseSession.on_text`
      :param http_response: The HTTP GET response object on the URL
      :param reply_to_msg_id: See :meth:`.BaseSession.on_text`
      :param reply_to_fallback_text: See :meth:`.BaseSession.on_text`
      :param reply_to: See :meth:`.BaseSession.on_text`
      :param thread:

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



   .. py:method:: on_composing(chat, thread = None)
      :async:


      Triggered when the user starts typing in a legacy chat (:xep:`0085`)

      :param chat: See :meth:`.BaseSession.on_text`
      :param thread:



   .. py:method:: on_paused(chat, thread = None)
      :async:


      Triggered when the user pauses typing in a legacy chat (:xep:`0085`)

      :param chat: See :meth:`.BaseSession.on_text`
      :param thread:



   .. py:method:: on_displayed(chat, legacy_msg_id, thread = None)
      :async:


      Triggered when the user reads a message in a legacy chat. (:xep:`0333`)

      This is only possible if a valid ``legacy_msg_id`` was passed when
      transmitting a message from a legacy chat to the user, eg in
      :meth:`slidge.contact.LegacyContact.send_text`
      or
      :meth:`slidge.group.LegacyParticipant.send_text`.

      :param chat: See :meth:`.BaseSession.on_text`
      :param legacy_msg_id: Identifier of the message/
      :param thread:



   .. py:method:: on_correct(chat, text, legacy_msg_id, *, thread = None, link_previews = (), mentions = None)
      :async:


      Triggered when the user corrects a message using :xep:`0308`

      This is only possible if a valid ``legacy_msg_id`` was returned by
      :meth:`.on_text`.

      :param chat: See :meth:`.BaseSession.on_text`
      :param text: The new text
      :param legacy_msg_id: Identifier of the edited message
      :param thread:
      :param link_previews: A list of sender-generated link previews.
          At the time of writing, only `Cheogram <https://wiki.soprani.ca/CheogramApp/LinkPreviews>`_
          supports it.
      :param mentions: (only for groups) A list of Contacts mentioned by their
          nicknames.



   .. py:method:: on_react(chat, legacy_msg_id, emojis, thread = None)
      :async:


      Triggered when the user sends message reactions (:xep:`0444`).

      :param chat: See :meth:`.BaseSession.on_text`
      :param thread:
      :param legacy_msg_id: ID of the message the user reacts to
      :param emojis: 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



   .. py:method:: on_retract(chat, legacy_msg_id, thread = None)
      :async:


      Triggered when the user retracts (:xep:`0424`) a message.

      :param chat: See :meth:`.BaseSession.on_text`
      :param thread:
      :param legacy_msg_id: Legacy ID of the retracted message



   .. py:method:: on_presence(resource, show, status, resources, merged_resource)
      :async:


      Called when the gateway component receives a presence, ie, when
      one of the user's clients goes online of offline, or changes its
      status.

      :param resource: The XMPP client identifier, arbitrary string.
      :param show: The presence ``<show>``, if available. If the resource is
          just 'available' without any ``<show>`` element, this is an empty
          str.
      :param status: A status message, like a deeply profound quote, eg,
          "Roses are red, violets are blue, [INSERT JOKE]".
      :param resources: A summary of all the resources for this user.
      :param merged_resource: A global presence for the user account,
          following rules described in :meth:`merge_resources`



   .. py:method:: on_avatar(bytes_, hash_, type_, width, height)
      :async:


      Triggered when the user uses modifies their avatar via :xep:`0084`.

      :param bytes_: The data of the avatar. According to the spec, this
          should always be a PNG, but some implementations do not respect
          that. If `None` it means the user has unpublished their avatar.
      :param hash_: The SHA1 hash of the avatar data. This is an identifier of
          the avatar.
      :param type_: The MIME type of the avatar.
      :param width: The width of the avatar image.
      :param height: The height of the avatar image.



   .. py:method:: on_leave_group(muc_legacy_id)
      :async:


      Triggered when the user leaves a group via the dedicated slidge command
      or the :xep:`0077` ``<remove />`` mechanism.

      This should be interpreted as definitely leaving the group.

      :param muc_legacy_id: The legacy ID of the group to leave



.. py:data:: PRESENCE_DICT
   :type:  dict[slidge.util.types.PseudoPresenceShow, str]

