slidge.group
============

.. py:module:: slidge.group

.. autoapi-nested-parse::

   Everything related to groups.



Classes
-------

.. autoapisummary::

   slidge.group.MucType
   slidge.group.LegacyBookmarks
   slidge.group.LegacyParticipant
   slidge.group.LegacyMUC


Package Contents
----------------

.. py:class:: MucType



   The type of group, private, public, anonymous or not.


   .. py:attribute:: GROUP
      :value: 0


      A private group, members-only and non-anonymous, eg a family group.



   .. py:attribute:: CHANNEL
      :value: 1


      A public group, aka an anonymous channel.



   .. py:attribute:: CHANNEL_NON_ANONYMOUS
      :value: 2


      A public group where participants' legacy IDs are visible to everybody.



.. py:class:: LegacyBookmarks(session)



   This is instantiated once per :class:`~slidge.BaseSession`


   .. py:method:: legacy_id_to_jid_username(legacy_id)
      :async:


      The default implementation calls ``str()`` on the legacy_id and
      escape characters according to :xep:`0106`.

      You can override this class and implement a more subtle logic to raise
      an :class:`~slixmpp.exceptions.XMPPError` early

      :param legacy_id:
      :return:



   .. py:method:: jid_username_to_legacy_id(username)
      :async:


      :param username:
      :return:



   .. py:method:: fill()
      :abstractmethod:

      :async:


      Establish a user's known groups.

      This has to be overridden in plugins with group support and at the
      minimum, this should ``await self.by_legacy_id(group_id)`` for all
      the groups a user is part of.

      Slidge internals will call this on successful :meth:`BaseSession.login`




   .. py:method:: remove(muc, reason='You left this group from the official client.', kick=True)
      :async:


      Delete everything about a specific group.

      This should be called when the user leaves the group from the official
      app.

      :param muc: The MUC to remove.
      :param reason: Optionally, a reason why this group was removed.
      :param kick: Whether the user should be kicked from this group. Set this
          to False in case you do this somewhere else in your code, eg, on
          receiving the confirmation that the group was deleted.



.. py:class:: LegacyParticipant(muc, nickname = None, is_user=False, is_system=False, role = 'participant', affiliation = 'member', resource = None, nickname_no_illegal = None)



   A legacy participant of a legacy group chat.


   .. py:method:: send_initial_presence(full_jid, nick_change=False, presence_id = None)

      Called when the user joins a MUC, as a mechanism
      to indicate to the joining XMPP client the list of "participants".

      Can be called this to trigger a "participant has joined the group" event.

      :param full_jid: Set this to only send to a specific user XMPP resource.
      :param nick_change: Used when the user joins and the MUC renames them (code 210)
      :param presence_id: set the presence ID. used internally by slidge



   .. py:method:: leave()

      Call this when the participant leaves the room



   .. py:method:: kick(reason = None)

      Call this when the participant is kicked from the room



   .. py:method:: ban(reason = None)

      Call this when the participant is banned from the room



.. py:class:: LegacyMUC(session, legacy_id, jid)



   A room, a.k.a. a Multi-User Chat.

   MUC instances are obtained by calling :py:meth:`slidge.group.bookmarks.LegacyBookmarks`
   on the user's :py:class:`slidge.core.session.BaseSession`.


   .. py:attribute:: STABLE_ARCHIVE
      :value: False


      Because legacy events like reactions, editions, etc. don't all map to a stanza
      with a proper legacy ID, slidge usually cannot guarantee the stability of the archive
      across restarts.

      Set this to True if you know what you're doing, but realistically, this can't
      be set to True until archive is permanently stored on disk by slidge.

      This is just a flag on archive responses that most clients ignore anyway.



   .. py:attribute:: KEEP_BACKFILLED_PARTICIPANTS
      :value: False


      Set this to ``True`` if the participant list is not full after calling
      ``fill_participants()``. This is a workaround for networks with huge
      participant lists which do not map really well the MUCs where all presences
      are sent on join.
      It allows to ensure that the participants that last spoke (within the
      ``fill_history()`` method are effectively participants, thus making possible
      for XMPP clients to fetch their avatars.



   .. py:attribute:: HAS_DESCRIPTION
      :value: True


      Set this to false if the legacy network does not allow setting a description
      for the group. In this case the description field will not be present in the
      room configuration form.



   .. py:attribute:: HAS_SUBJECT
      :value: True


      Set this to false if the legacy network does not allow setting a subject
      (sometimes also called topic) for the group. In this case, as a subject is
      recommended by :xep:`0045` ("SHALL"), the description (or the group name as
      ultimate fallback) will be used as the room subject.
      By setting this to false, an error will be returned when the :term:`User`
      tries to set the room subject.



   .. py:method:: update_info()
      :abstractmethod:

      :async:


      Fetch information about this group from the legacy network

      This is awaited on MUC instantiation, and should be overridden to
      update the attributes of the group chat, like title, subject, number
      of participants etc.

      To take advantage of the slidge avatar cache, you can check the .avatar
      property to retrieve the "legacy file ID" of the cached avatar. If there
      is no change, you should not call
      :py:meth:`slidge.core.mixins.avatar.AvatarMixin.set_avatar()` or
      attempt to modify
      the :attr:.avatar property.



   .. py:method:: backfill(after = None, before = None)
      :abstractmethod:

      :async:


      Override this if the legacy network provide server-side group archives.

      In it, send history messages using ``self.get_participant(xxx).send_xxxx``,
      with the ``archive_only=True`` kwarg. This is only called once per slidge
      run for a given group.

      :param after: Fetch messages after this one. If ``None``, it's up to you
          to decide how far you want to go in the archive. If it's not ``None``,
          it means slidge has some messages in this archive and you should really try
          to complete it to avoid "holes" in the history of this group.
      :param before: Fetch messages before this one. If ``None``, fetch all messages
          up to the most recent one



   .. py:method:: fill_participants()
      :async:


      This method should yield the list of all members of this group.

      Typically, use ``participant = self.get_participant()``, self.get_participant_by_contact(),
      of self.get_user_participant(), and update their affiliation, hats, etc.
      before yielding them.



   .. py:method:: get_user_participant(**kwargs)
      :async:


      Get the participant representing the gateway user

      :param kwargs: additional parameters for the :class:`.Participant`
          construction (optional)
      :return:



   .. py:method:: get_participant(nickname, raise_if_not_found=False, fill_first=False, store=True, **kwargs)
      :async:


      Get a participant by their nickname.

      In non-anonymous groups, you probably want to use
      :meth:`.LegacyMUC.get_participant_by_contact` instead.

      :param nickname: Nickname of the participant (used as resource part in the MUC)
      :param raise_if_not_found: Raise XMPPError("item-not-found") if they are not
          in the participant list (internal use by slidge, plugins should not
          need that)
      :param fill_first: Ensure :meth:`.LegacyMUC.fill_participants()` has been called first
           (internal use by slidge, plugins should not need that)
      :param store: persistently store the user in the list of MUC participants
      :param kwargs: additional parameters for the :class:`.Participant`
          construction (optional)
      :return:



   .. py:method:: get_system_participant()

      Get a pseudo-participant, representing the room itself

      Can be useful for events that cannot be mapped to a participant,
      e.g. anonymous moderation events, or announces from the legacy
      service
      :return:



   .. py:method:: get_participant_by_contact(c, **kwargs)
      :async:


      Get a non-anonymous participant.

      This is what should be used in non-anonymous groups ideally, to ensure
      that the Contact jid is associated to this participant

      :param c: The :class:`.LegacyContact` instance corresponding to this contact
      :param kwargs: additional parameters for the :class:`.Participant`
          construction (optional)
      :return:



   .. py:method:: remove_participant(p, kick=False, ban=False, reason = None)

      Call this when a participant leaves the room

      :param p: The participant
      :param kick: Whether the participant left because they were kicked
      :param ban: Whether the participant left because they were banned
      :param reason: Optionally, a reason why the participant was removed.



   .. py:method:: kick_resource(r)
      :async:


      Kick a XMPP client of the user. (slidge internal use)

      :param r: The resource to kick



   .. py:method:: add_to_bookmarks(auto_join=True, invite=False, preserve=True, pin = None, notify = None)
      :async:


      Add the MUC to the user's XMPP bookmarks (:xep:`0402')

      This requires that slidge has the IQ privileged set correctly
      on the XMPP server

      :param auto_join: whether XMPP clients should automatically join
          this MUC on startup. In theory, XMPP clients will receive
          a "push" notification when this is called, and they will
          join if they are online.
      :param invite: send an invitation to join this MUC emanating from
          the gateway. While this should not be strictly necessary,
          it can help for clients that do not support :xep:`0402`, or
          that have 'do not honor bookmarks auto-join' turned on in their
          settings.
      :param preserve: preserve auto-join and bookmarks extensions
          set by the user outside slidge
      :param pin: Pin the group chat bookmark :xep:`0469`. Requires privileged entity.
          If set to ``None`` (default), the bookmark pinning status will be untouched.
      :param notify: Chat notification setting: :xep:`0492`. Requires privileged entity.
          If set to ``None`` (default), the setting will be untouched. Only the "global"
          notification setting is supported (ie, per client type is not possible).



   .. py:method:: on_avatar(data, mime)
      :abstractmethod:

      :async:


      Called when the user tries to set the avatar of the room from an XMPP
      client.

      If the set avatar operation is completed, should return a legacy image
      unique identifier. In this case the MUC avatar will be immediately
      updated on the XMPP side.

      If data is not None and this method returns None, then we assume that
      self.set_avatar() will be called elsewhere, eg triggered by a legacy
      room update event.

      :param data: image data or None if the user meant to remove the avatar
      :param mime: the mime type of the image. Since this is provided by
          the XMPP client, there is no guarantee that this is valid or
          correct.
      :return: A unique avatar identifier, which will trigger
          :py:meth:`slidge.group.room.LegacyMUC.set_avatar`. Alternatively, None, if
          :py:meth:`.LegacyMUC.set_avatar` is meant to be awaited somewhere else.



   .. py:method:: on_set_affiliation(contact, affiliation, reason, nickname)
      :abstractmethod:

      :async:


      Triggered when the user requests changing the affiliation of a contact
      for this group.

      Examples: promotion them to moderator, ban (affiliation=outcast).

      :param contact: The contact whose affiliation change is requested
      :param affiliation: The new affiliation
      :param reason: A reason for this affiliation change
      :param nickname:



   .. py:method:: on_kick(contact, reason)
      :abstractmethod:

      :async:


      Triggered when the user requests changing the role of a contact
      to "none" for this group. Action commonly known as "kick".

      :param contact: Contact to be kicked
      :param reason: A reason for this kick



   .. py:method:: on_set_config(name, description)
      :abstractmethod:

      :async:


      Triggered when the user requests changing the room configuration.
      Only title and description can be changed at the moment.

      The legacy module is responsible for updating :attr:`.title` and/or
      :attr:`.description` of this instance.

      If :attr:`.HAS_DESCRIPTION` is set to False, description will always
      be ``None``.

      :param name: The new name of the room.
      :param description: The new description of the room.



   .. py:method:: on_destroy_request(reason)
      :abstractmethod:

      :async:


      Triggered when the user requests room destruction.

      :param reason: Optionally, a reason for the destruction



   .. py:method:: on_set_subject(subject)
      :abstractmethod:

      :async:


      Triggered when the user requests changing the room subject.

      The legacy module is responsible for updating :attr:`.subject` of this
      instance.

      :param subject: The new subject for this room.



