slidge 0.1.0__py3-none-any.whl

slidge/group/__init__.py

@@ -0,0 +1,10 @@
+"""
+Everything related to groups.
+"""
+
+from ..util.types import MucType
+from .bookmarks import LegacyBookmarks
+from .participant import LegacyParticipant
+from .room import LegacyMUC
+
+__all__ = ("LegacyBookmarks", "LegacyParticipant", "LegacyMUC", "MucType")

slidge/group/archive.py

@@ -0,0 +1,125 @@
+import logging
+import uuid
+from copy import copy
+from datetime import datetime
+from typing import TYPE_CHECKING, Collection, Optional
+
+from slixmpp import Iq, Message
+
+from ..util.archive_msg import HistoryMessage
+from ..util.db import GatewayUser
+from ..util.sql import db
+
+if TYPE_CHECKING:
+    from .participant import LegacyParticipant
+
+
+class MessageArchive:
+    def __init__(self, db_id: str, user: GatewayUser):
+        self.db_id = db_id
+        self.user = user
+        db.mam_add_muc(db_id, user)
+
+    def add(
+        self,
+        msg: Message,
+        participant: Optional["LegacyParticipant"] = None,
+    ):
+        """
+        Add a message to the archive if it is deemed archivable
+
+        :param msg:
+        :param participant:
+        """
+        if not archivable(msg):
+            return
+        new_msg = copy(msg)
+        if participant and not participant.muc.is_anonymous:
+            new_msg["muc"]["role"] = participant.role
+            new_msg["muc"]["affiliation"] = participant.affiliation
+            if participant.contact:
+                new_msg["muc"]["jid"] = participant.contact.jid.bare
+            elif participant.is_user:
+                new_msg["muc"]["jid"] = participant.user.jid.bare
+            elif participant.is_system:
+                new_msg["muc"]["jid"] = participant.muc.jid
+            else:
+                log.warning("No real JID for participant in this group")
+                new_msg["muc"][
+                    "jid"
+                ] = f"{uuid.uuid4()}@{participant.xmpp.boundjid.bare}"
+
+        db.mam_add_msg(self.db_id, HistoryMessage(new_msg), self.user)
+
+    def __iter__(self):
+        return iter(self.get_all())
+
+    def get_all(
+        self,
+        start_date: Optional[datetime] = None,
+        end_date: Optional[datetime] = None,
+        before_id: Optional[str] = None,
+        after_id: Optional[str] = None,
+        ids: Collection[str] = (),
+        last_page_n: Optional[int] = None,
+        sender: Optional[str] = None,
+        flip=False,
+    ):
+        for msg in db.mam_get_messages(
+            self.user,
+            self.db_id,
+            before_id=before_id,
+            after_id=after_id,
+            ids=ids,
+            last_page_n=last_page_n,
+            sender=sender,
+            start_date=start_date,
+            end_date=end_date,
+            flip=flip,
+        ):
+            yield msg
+
+    async def send_metadata(self, iq: Iq):
+        """
+        Send archive extent, as per the spec
+
+        :param iq:
+        :return:
+        """
+        reply = iq.reply()
+        messages = db.mam_get_first_and_last(self.db_id)
+        if messages:
+            for x, m in [("start", messages[0]), ("end", messages[-1])]:
+                reply["mam_metadata"][x]["id"] = m.id
+                reply["mam_metadata"][x]["timestamp"] = m.sent_on
+        else:
+            reply.enable("mam_metadata")
+        reply.send()
+
+
+def archivable(msg: Message):
+    """
+    Determine if a message stanza is worth archiving, ie, convey meaningful
+    info
+
+    :param msg:
+    :return:
+    """
+
+    if msg.get_plugin("hint", check=True) and msg["hint"] == "no-store":
+        return False
+
+    if msg["body"]:
+        return True
+
+    if msg.get_plugin("apply_to", check=True):
+        # retractions
+        return True
+
+    if msg.get_plugin("reactions", check=True):
+        return True
+
+    return False
+
+
+log = logging.getLogger(__name__)

slidge/group/bookmarks.py

@@ -0,0 +1,163 @@
+import abc
+import logging
+from typing import TYPE_CHECKING, Generic, Type
+
+from slixmpp import JID
+from slixmpp.jid import _unescape_node
+
+from ..contact.roster import ESCAPE_TABLE
+from ..core.mixins.lock import NamedLockMixin
+from ..util import SubclassableOnce
+from ..util.types import LegacyGroupIdType, LegacyMUCType
+from .room import LegacyMUC
+
+if TYPE_CHECKING:
+    from slidge.core.session import BaseSession
+
+
+class LegacyBookmarks(
+    Generic[LegacyGroupIdType, LegacyMUCType],
+    NamedLockMixin,
+    metaclass=SubclassableOnce,
+):
+    """
+    This is instantiated once per :class:`~slidge.BaseSession`
+    """
+
+    def __init__(self, session: "BaseSession"):
+        self.session = session
+        self.xmpp = session.xmpp
+        self.user = session.user
+
+        self._mucs_by_legacy_id = dict[LegacyGroupIdType, LegacyMUCType]()
+        self._mucs_by_bare_jid = dict[str, LegacyMUCType]()
+
+        self._muc_class: Type[LegacyMUCType] = LegacyMUC.get_self_or_unique_subclass()
+
+        self._user_nick: str = self.session.user.jid.node
+
+        super().__init__()
+        self.log = logging.getLogger(f"{self.user.bare_jid}:bookmarks")
+        self.ready = self.session.xmpp.loop.create_future()
+        if not self.xmpp.GROUPS:
+            self.ready.set_result(True)
+
+    @property
+    def user_nick(self):
+        return self._user_nick
+
+    @user_nick.setter
+    def user_nick(self, nick: str):
+        self._user_nick = nick
+
+    def __iter__(self):
+        return iter(self._mucs_by_legacy_id.values())
+
+    def __repr__(self):
+        return f"<Bookmarks of {self.user}>"
+
+    async def __finish_init_muc(self, legacy_id: LegacyGroupIdType, jid: JID):
+        muc = self._muc_class(self.session, legacy_id=legacy_id, jid=jid)
+        await muc.avatar_wrap_update_info()
+        if not muc.user_nick:
+            muc.user_nick = self._user_nick
+        self.log.debug("MUC created: %r", muc)
+        self._mucs_by_legacy_id[muc.legacy_id] = muc
+        self._mucs_by_bare_jid[muc.jid.bare] = muc
+        return muc
+
+    async def legacy_id_to_jid_local_part(self, legacy_id: LegacyGroupIdType):
+        return await self.legacy_id_to_jid_username(legacy_id)
+
+    async def jid_local_part_to_legacy_id(self, local_part: str):
+        return await self.jid_username_to_legacy_id(local_part)
+
+    async def legacy_id_to_jid_username(self, legacy_id: LegacyGroupIdType):
+        """
+        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:
+        """
+        return str(legacy_id).translate(ESCAPE_TABLE)
+
+    async def jid_username_to_legacy_id(self, username: str):
+        """
+
+        :param username:
+        :return:
+        """
+        return _unescape_node(username)
+
+    async def by_jid(self, jid: JID) -> LegacyMUCType:
+        bare = jid.bare
+        async with self.lock(("bare", bare)):
+            muc = self._mucs_by_bare_jid.get(bare)
+            if muc is None:
+                self.log.debug("Attempting to instantiate a new MUC for JID %s", jid)
+                local_part = jid.node
+                legacy_id = await self.jid_local_part_to_legacy_id(local_part)
+                if self.get_lock(("legacy_id", legacy_id)):
+                    self.log.debug("Not instantiating %s after all", jid)
+                    return await self.by_legacy_id(legacy_id)
+                self.log.debug("%r is group %r", local_part, legacy_id)
+                muc = await self.__finish_init_muc(legacy_id, JID(bare))
+            else:
+                self.log.trace("Found an existing MUC instance: %s", muc)  # type:ignore
+            return muc
+
+    async def by_legacy_id(self, legacy_id: LegacyGroupIdType) -> LegacyMUCType:
+        async with self.lock(("legacy_id", legacy_id)):
+            muc = self._mucs_by_legacy_id.get(legacy_id)
+            if muc is None:
+                self.log.debug("Create new MUC instance for legacy ID %s", legacy_id)
+                local = await self.legacy_id_to_jid_local_part(legacy_id)
+                bare = f"{local}@{self.xmpp.boundjid}"
+                jid = JID(bare)
+                if self.get_lock(("bare", bare)):
+                    self.log.debug("Not instantiating %s after all", legacy_id)
+                    return await self.by_jid(jid)
+                muc = await self.__finish_init_muc(legacy_id, jid)
+            else:
+                self.log.trace("Found an existing MUC instance: %s", muc)  # type:ignore
+
+            return muc
+
+    @abc.abstractmethod
+    async def fill(self):
+        """
+        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`
+
+        """
+        if self.xmpp.GROUPS:
+            raise NotImplementedError(
+                "The plugin advertised support for groups but"
+                " LegacyBookmarks.fill() was not overridden."
+            )
+
+    def remove(self, muc: LegacyMUC):
+        try:
+            del self._mucs_by_legacy_id[muc.legacy_id]
+        except KeyError:
+            self.log.warning("Removed a MUC that we didn't store by legacy ID")
+        try:
+            del self._mucs_by_bare_jid[muc.jid.bare]
+        except KeyError:
+            self.log.warning("Removed a MUC that we didn't store by JID")
+        for part in muc._participants_by_contacts.values():
+            try:
+                part.contact.participants.remove(part)
+            except KeyError:
+                part.log.warning(
+                    "That participant wasn't stored in the contact's participants attribute"
+                )