slidge 0.1.3__py3-none-any.whl → 0.2.0__py3-none-any.whl

slidge/core/pubsub.py

@@ -1,12 +1,8 @@
-import hashlib
-import io
 import logging
 from copy import copy
 from pathlib import Path
-from typing import TYPE_CHECKING, Optional, Type, Union
+from typing import TYPE_CHECKING, Optional, Union
 
-from PIL import Image, UnidentifiedImageError
-from PIL.Image import Image as PILImage
 from slixmpp import (
     JID,
     CoroutineCallback,
@@ -24,34 +20,28 @@ from slixmpp.plugins.xep_0172 import UserNick
 from slixmpp.plugins.xep_0292.stanza import VCard4
 from slixmpp.types import JidStr, OptJidStr
 
-from ..contact.contact import LegacyContact
-from ..contact.roster import ContactIsUser
-from ..util.db import GatewayUser, user_store
-from ..util.sql import db
-from ..util.types import AvatarType, LegacyFileIdType, PepItemType
-from .cache import CachedAvatar, avatar_cache
+from ..db.avatar import CachedAvatar, avatar_cache
+from ..db.store import ContactStore, SlidgeStore
 from .mixins.lock import NamedLockMixin
 
 if TYPE_CHECKING:
-    from slidge import BaseGateway
+    from slidge.core.gateway import BaseGateway
+
+    from ..contact.contact import LegacyContact
 
 VCARD4_NAMESPACE = "urn:xmpp:vcard4"
 
 
 class PepItem:
-    @staticmethod
-    def from_db(jid: JID, user: Optional[GatewayUser] = None) -> Optional["PepItem"]:
-        raise NotImplementedError
-
-    def to_db(self, jid: JID, user: Optional[GatewayUser] = None):
-        raise NotImplementedError
+    pass
 
 
 class PepAvatar(PepItem):
-    def __init__(self, jid: JID):
+    store: SlidgeStore
+
+    def __init__(self):
         self.metadata: Optional[AvatarMetadata] = None
         self.id: Optional[str] = None
-        self.jid = jid
         self._avatar_data_path: Optional[Path] = None
 
     @property
@@ -62,63 +52,7 @@ class PepAvatar(PepItem):
         data.set_value(self._avatar_data_path.read_bytes())
         return data
 
-    @staticmethod
-    def _sha(b: bytes):
-        return hashlib.sha1(b).hexdigest()
-
-    def _get_weak_unique_id(self, avatar: AvatarType):
-        if isinstance(avatar, str):
-            return avatar  # url
-        elif isinstance(avatar, bytes):
-            return self._sha(avatar)
-        elif isinstance(avatar, Path):
-            return self._sha(avatar.read_bytes())
-
-    @staticmethod
-    async def _get_image(avatar: AvatarType) -> PILImage:
-        if isinstance(avatar, str):
-            # async with aiohttp.ClientSession() as session:
-            async with avatar_cache.http.get(avatar) as response:
-                return Image.open(io.BytesIO(await response.read()))
-        elif isinstance(avatar, bytes):
-            return Image.open(io.BytesIO(avatar))
-        elif isinstance(avatar, Path):
-            return Image.open(avatar)
-        else:
-            raise TypeError("Avatar must be bytes, a Path or a str (URL)", avatar)
-
-    async def set_avatar(
-        self, avatar: AvatarType, unique_id: Optional[LegacyFileIdType] = None
-    ):
-        if unique_id is None:
-            if isinstance(avatar, str):
-                await self._set_avatar_from_url_alone(avatar)
-                return
-            unique_id = self._get_weak_unique_id(avatar)
-
-        await self._set_avatar_from_unique_id(avatar, unique_id)
-
-    async def _set_avatar_from_unique_id(
-        self, avatar: AvatarType, unique_id: LegacyFileIdType
-    ):
-        cached_avatar = avatar_cache.get(unique_id)
-        if cached_avatar:
-            # this shouldn't be necessary but here to re-use avatars downloaded
-            # before the change introducing the JID to unique ID mapping
-            avatar_cache.store_jid(self.jid, unique_id)
-        else:
-            img = await self._get_image(avatar)
-            cached_avatar = await avatar_cache.convert_and_store(
-                img, unique_id, self.jid
-            )
-
-        self._set_avatar_from_cache(cached_avatar)
-
-    async def _set_avatar_from_url_alone(self, url: str):
-        cached_avatar = await avatar_cache.get_avatar_from_url_alone(url, self.jid)
-        self._set_avatar_from_cache(cached_avatar)
-
-    def _set_avatar_from_cache(self, cached_avatar: CachedAvatar):
+    def set_avatar_from_cache(self, cached_avatar: CachedAvatar):
         metadata = AvatarMetadata()
         self.id = cached_avatar.hash
         metadata.add_info(
@@ -131,31 +65,10 @@ class PepAvatar(PepItem):
         self.metadata = metadata
         self._avatar_data_path = cached_avatar.path
 
-    @staticmethod
-    def from_db(jid: JID, user: Optional[GatewayUser] = None) -> Optional["PepAvatar"]:
-        cached_id = db.avatar_get(jid)
-        if cached_id is None:
-            return None
-        item = PepAvatar(jid)
-        cached_avatar = avatar_cache.get(cached_id)
-        if cached_avatar is None:
-            raise XMPPError("internal-server-error")
-        item._set_avatar_from_cache(cached_avatar)
-        return item
-
-    def to_db(self, jid: JID, user=None):
-        cached_id = avatar_cache.get_cached_id_for(jid)
-        if cached_id is None:
-            log.warning("Could not store avatar for %s", jid)
-            return
-        db.avatar_store(jid, cached_id)
-
-    @staticmethod
-    def remove_from_db(jid: JID):
-        db.avatar_delete(jid)
-
 
 class PepNick(PepItem):
+    contact_store: ContactStore
+
     def __init__(self, nick: Optional[str] = None):
         nickname = UserNick()
         if nick is not None:
@@ -163,20 +76,6 @@ class PepNick(PepItem):
         self.nick = nickname
         self.__nick_str = nick
 
-    @staticmethod
-    def from_db(jid: JID, user: Optional[GatewayUser] = None) -> Optional["PepNick"]:
-        if user is None:
-            raise XMPPError("not-allowed")
-        nick = db.nick_get(jid, user)
-        if nick is None:
-            return None
-        return PepNick(nick)
-
-    def to_db(self, jid: JID, user: Optional[GatewayUser] = None):
-        if user is None:
-            raise XMPPError("not-allowed")
-        db.nick_store(jid, str(self.__nick_str), user)
-
 
 class PubSubComponent(NamedLockMixin, BasePlugin):
     xmpp: "BaseGateway"
@@ -186,7 +85,6 @@ class PubSubComponent(NamedLockMixin, BasePlugin):
     dependencies = {
         "xep_0030",
         "xep_0060",
-        # "xep_0084",
         "xep_0115",
         "xep_0163",
     }
@@ -219,7 +117,6 @@ class PubSubComponent(NamedLockMixin, BasePlugin):
                 self._get_vcard,  # type:ignore
             )
         )
-        self.xmpp.add_event_handler("presence_available", self._on_presence_available)
 
         disco = self.xmpp.plugin["xep_0030"]
         disco.add_identity("pubsub", "pep", self.component_name)
@@ -228,82 +125,72 @@ class PubSubComponent(NamedLockMixin, BasePlugin):
         disco.add_feature("http://jabber.org/protocol/pubsub#retrieve-items")
         disco.add_feature("http://jabber.org/protocol/pubsub#persistent-items")
 
-    async def _on_presence_available(self, p: Presence):
+    async def __get_features(self, presence: Presence) -> list[str]:
+        from_ = presence.get_from()
+        ver_string = presence["caps"]["ver"]
+        if ver_string:
+            info = await self.xmpp.plugin["xep_0115"].get_caps(from_)
+        else:
+            info = None
+        if info is None:
+            async with self.lock(from_):
+                iq = await self.xmpp.plugin["xep_0030"].get_info(from_)
+            info = iq["disco_info"]
+        return info["features"]
+
+    async def on_presence_available(
+        self, p: Presence, contact: Optional["LegacyContact"]
+    ):
         if p.get_plugin("muc_join", check=True) is not None:
             log.debug("Ignoring MUC presence here")
             return
 
-        from_ = p.get_from()
-        ver_string = p["caps"]["ver"]
-        info = None
-
         to = p.get_to()
-
-        # we don't want to push anything for contacts that are not in the user's roster
         if to != self.xmpp.boundjid.bare:
-            session = self.xmpp.get_session_from_stanza(p)
-
-            if session is None:
+            # we don't want to push anything for contacts that are not in the user's roster
+            if contact is None or not contact.is_friend:
                 return
 
-            await session.contacts.ready
-            try:
-                contact = await session.contacts.by_jid(to)
-            except XMPPError as e:
-                log.debug(
-                    "Could not determine if %s was added to the roster: %s", to, e
-                )
-                return
-            except Exception as e:
-                log.warning("Could not determine if %s was added to the roster.", to)
-                log.exception(e)
-                return
-            if not contact.is_friend:
-                return
+        from_ = p.get_from()
+        features = await self.__get_features(p)
 
-        if ver_string:
-            info = await self.xmpp.plugin["xep_0115"].get_caps(from_)
-        if info is None:
-            async with self.lock(from_):
-                iq = await self.xmpp.plugin["xep_0030"].get_info(from_)
-            info = iq["disco_info"]
-        features = info["features"]
         if AvatarMetadata.namespace + "+notify" in features:
             try:
-                pep_avatar = await self._get_authorized_avatar(p)
+                pep_avatar = await self._get_authorized_avatar(p, contact)
             except XMPPError:
                 pass
             else:
-                if pep_avatar.metadata is None:
-                    raise XMPPError("internal-server-error", "Avatar but no metadata?")
-                await self._broadcast(
-                    data=pep_avatar.metadata,
-                    from_=p.get_to(),
-                    to=from_,
-                    id=pep_avatar.metadata["info"]["id"],
-                )
+                if pep_avatar.metadata is not None:
+                    await self.__broadcast(
+                        data=pep_avatar.metadata,
+                        from_=p.get_to().bare,
+                        to=from_,
+                        id=pep_avatar.metadata["info"]["id"],
+                    )
         if UserNick.namespace + "+notify" in features:
             try:
-                pep_nick = await self._get_authorized_nick(p)
+                pep_nick = await self._get_authorized_nick(p, contact)
             except XMPPError:
                 pass
             else:
-                await self._broadcast(data=pep_nick.nick, from_=p.get_to(), to=from_)
+                await self.__broadcast(data=pep_nick.nick, from_=p.get_to(), to=from_)
 
-        if VCARD4_NAMESPACE + "+notify" in features:
-            await self.broadcast_vcard_event(p.get_to(), to=from_)
+        if contact is not None and VCARD4_NAMESPACE + "+notify" in features:
+            await self.broadcast_vcard_event(
+                p.get_to(), from_, await contact.get_vcard()
+            )
 
-    async def broadcast_vcard_event(self, from_, to):
+    async def broadcast_vcard_event(self, from_: JID, to: JID, vcard: VCard4 | None):
         item = Item()
         item.namespace = VCARD4_NAMESPACE
         item["id"] = "current"
-        vcard: VCard4 = await self.xmpp["xep_0292_provider"].get_vcard(from_, to)
+        # vcard: VCard4 = await self.xmpp["xep_0292_provider"].get_vcard(from_, to)
         # The vcard content should NOT be in this event according to the spec:
         # https://xmpp.org/extensions/xep-0292.html#sect-idm45669698174224
-        # but movim expects it to be here, and I guess
+        # but movim expects it to be here, and I guess it does not hurt
 
         log.debug("Broadcast vcard4 event: %s", vcard)
-        await self._broadcast(
+        await self.__broadcast(
             data=vcard,
             from_=JID(from_).bare,
             to=to,
@@ -311,71 +198,76 @@ class PubSubComponent(NamedLockMixin, BasePlugin):
             node=VCARD4_NAMESPACE,
         )
 
-    async def _get_authorized_item(
-        self, cls: Type[PepItemType], stanza: Union[Iq, Presence]
-    ) -> PepItemType:
-        sto = stanza.get_to()
-        user = user_store.get_by_jid(stanza.get_from())
-        item = cls.from_db(sto, user)
-        if item is None:
-            raise XMPPError("item-not-found")
-
-        if sto != self.xmpp.boundjid.bare:
-            session = self.xmpp.get_session_from_stanza(stanza)
-            await session.contacts.by_jid(sto)
-
-        return item  # type:ignore
+    async def __get_contact(self, stanza: Union[Iq, Presence]):
+        session = self.xmpp.get_session_from_stanza(stanza)
+        return await session.contacts.by_jid(stanza.get_to())
+
+    async def _get_authorized_avatar(
+        self, stanza: Union[Iq, Presence], contact: Optional["LegacyContact"] = None
+    ) -> PepAvatar:
+        if stanza.get_to() == self.xmpp.boundjid.bare:
+            item = PepAvatar()
+            item.set_avatar_from_cache(avatar_cache.get_by_pk(self.xmpp.avatar_pk))
+            return item
+
+        if contact is None:
+            contact = await self.__get_contact(stanza)
+
+        item = PepAvatar()
+        if contact.avatar_pk is not None:
+            stored = avatar_cache.get_by_pk(contact.avatar_pk)
+            assert stored is not None
+            item.set_avatar_from_cache(stored)
+        return item
 
-    async def _get_authorized_avatar(self, stanza: Union[Iq, Presence]) -> PepAvatar:
-        return await self._get_authorized_item(PepAvatar, stanza)
+    async def _get_authorized_nick(
+        self, stanza: Union[Iq, Presence], contact: Optional["LegacyContact"] = None
+    ) -> PepNick:
+        if stanza.get_to() == self.xmpp.boundjid.bare:
+            return PepNick(self.xmpp.COMPONENT_NAME)
 
-    async def _get_authorized_nick(self, stanza: Union[Iq, Presence]) -> PepNick:
-        return await self._get_authorized_item(PepNick, stanza)
+        if contact is None:
+            contact = await self.__get_contact(stanza)
 
-    async def _get_avatar_data(self, iq: Iq):
-        pep_avatar = await self._get_authorized_avatar(iq)
+        if contact.name is not None:
+            return PepNick(contact.name)
+        else:
+            return PepNick()
 
+    def __reply_with(
+        self, iq: Iq, content: AvatarData | AvatarMetadata | None, item_id: str | None
+    ) -> None:
         requested_items = iq["pubsub"]["items"]
+
         if len(requested_items) == 0:
-            self._reply_with_payload(iq, pep_avatar.data, pep_avatar.id)
+            self._reply_with_payload(iq, content, item_id)
         else:
             for item in requested_items:
-                if item["id"] == pep_avatar.id:
-                    self._reply_with_payload(iq, pep_avatar.data, pep_avatar.id)
+                if item["id"] == item_id:
+                    self._reply_with_payload(iq, content, item_id)
                     return
             else:
                 raise XMPPError("item-not-found")
 
-    async def _get_avatar_metadata(self, iq: Iq):
+    async def _get_avatar_data(self, iq: Iq):
         pep_avatar = await self._get_authorized_avatar(iq)
+        self.__reply_with(iq, pep_avatar.data, pep_avatar.id)
 
-        requested_items = iq["pubsub"]["items"]
-        if len(requested_items) == 0:
-            self._reply_with_payload(iq, pep_avatar.metadata, pep_avatar.id)
-        else:
-            for item in requested_items:
-                if item["id"] == pep_avatar.id:
-                    self._reply_with_payload(iq, pep_avatar.metadata, pep_avatar.id)
-                    return
-            else:
-                raise XMPPError("item-not-found")
+    async def _get_avatar_metadata(self, iq: Iq):
+        pep_avatar = await self._get_authorized_avatar(iq)
+        self.__reply_with(iq, pep_avatar.metadata, pep_avatar.id)
 
     async def _get_vcard(self, iq: Iq):
         # this is not the proper way that clients should retrieve VCards, but
         # gajim does it this way.
         # https://xmpp.org/extensions/xep-0292.html#sect-idm45669698174224
-        vcard: VCard4 = await self.xmpp["xep_0292_provider"].get_vcard(
-            iq.get_to().bare, iq.get_from().bare
-        )
-        log.debug("VCARD: %s -- %s -- %s", iq.get_to().bare, iq.get_from().bare, vcard)
+        session = self.xmpp.get_session_from_stanza(iq)
+        contact = await session.contacts.by_jid(iq.get_to())
+        vcard = await contact.get_vcard()
         if vcard is None:
             raise XMPPError("item-not-found")
         self._reply_with_payload(iq, vcard, "current", VCARD4_NAMESPACE)
 
-    @staticmethod
-    def get_avatar(jid: JID):
-        return PepAvatar.from_db(jid)
-
     @staticmethod
     def _reply_with_payload(
         iq: Iq,
@@ -394,7 +286,7 @@ class PubSubComponent(NamedLockMixin, BasePlugin):
         result["pubsub"]["items"].append(item)
         result.send()
 
-    async def _broadcast(self, data, from_: JidStr, to: OptJidStr = None, **kwargs):
+    async def __broadcast(self, data, from_: JidStr, to: OptJidStr = None, **kwargs):
         from_ = JID(from_)
         if from_ != self.xmpp.boundjid.bare and to is not None:
             to = JID(to)
@@ -402,12 +294,6 @@ class PubSubComponent(NamedLockMixin, BasePlugin):
             if session is None:
                 return
             await session.ready
-            try:
-                entity = await session.get_contact_or_group_or_participant(from_)
-            except ContactIsUser:
-                return
-            if isinstance(entity, LegacyContact) and not entity.is_friend:
-                return
 
         item = EventItem()
         if data:
@@ -428,97 +314,37 @@ class PubSubComponent(NamedLockMixin, BasePlugin):
         msg.append(event)
 
         if to is None:
-            for u in user_store.get_all():
+            for u in self.xmpp.store.users.get_all():
                 new_msg = copy(msg)
-                new_msg.set_to(u.bare_jid)
+                new_msg.set_to(u.jid.bare)
                 new_msg.send()
         else:
             msg.set_to(to)
             msg.send()
 
-    async def set_avatar(
-        self,
-        jid: JidStr,
-        avatar: Optional[AvatarType] = None,
-        broadcast_to: OptJidStr = None,
-        unique_id=None,
-        broadcast=True,
-    ):
-        jid = JID(jid)
-        if avatar is None:
-            PepAvatar.remove_from_db(jid)
-            await self._broadcast(AvatarMetadata(), jid, broadcast_to)
-            avatar_cache.delete_jid(jid)
-        else:
-            pep_avatar = PepAvatar(jid)
-            try:
-                await pep_avatar.set_avatar(avatar, unique_id)
-            except (UnidentifiedImageError, FileNotFoundError) as e:
-                log.warning("Failed to set avatar for %s: %r", self, e)
-                return
-            pep_avatar.to_db(jid)
-            if pep_avatar.metadata is None:
-                raise RuntimeError
-            if not broadcast:
-                return
-            await self._broadcast(
-                pep_avatar.metadata,
-                jid,
-                broadcast_to,
-                id=pep_avatar.metadata["info"]["id"],
-            )
-
-    async def set_avatar_from_cache(
-        self, jid: JID, send_empty: bool, broadcast_to: OptJidStr = None, broadcast=True
-    ):
-        uid = avatar_cache.get_cached_id_for(jid)
-        if uid is None:
-            if not send_empty:
-                return
-            self.xmpp.loop.create_task(
-                self.set_avatar(jid, None, broadcast_to, uid, broadcast)
-            )
-            return
-        cached_avatar = avatar_cache.get(str(uid))
+    async def broadcast_avatar(
+        self, from_: JidStr, to: JidStr, cached_avatar: Optional[CachedAvatar]
+    ) -> None:
         if cached_avatar is None:
-            # should not happen but well…
-            log.warning(
-                "Something is wrong with the avatar, %s won't have an "
-                "avatar because avatar not found in cache",
-                jid,
+            await self.__broadcast(AvatarMetadata(), from_, to)
+        else:
+            pep_avatar = PepAvatar()
+            pep_avatar.set_avatar_from_cache(cached_avatar)
+            assert pep_avatar.metadata is not None
+            await self.__broadcast(
+                pep_avatar.metadata, from_, to, id=pep_avatar.metadata["info"]["id"]
             )
-            return
-        self.xmpp.loop.create_task(
-            self.set_avatar(jid, cached_avatar.path, broadcast_to, uid, broadcast)
-        )
 
-    def set_nick(
+    def broadcast_nick(
         self,
-        user: GatewayUser,
+        user_jid: JID,
         jid: JidStr,
         nick: Optional[str] = None,
     ):
         jid = JID(jid)
         nickname = PepNick(nick)
-        nickname.to_db(jid, user)
         log.debug("New nickname: %s", nickname.nick)
-        self.xmpp.loop.create_task(self._broadcast(nickname.nick, jid, user.bare_jid))
-
-    async def broadcast_all(self, from_: JID, to: JID):
-        """
-        Force push avatar and nick for a stored JID.
-        """
-        a = PepAvatar.from_db(from_)
-        if a:
-            if a.metadata:
-                await self._broadcast(
-                    a.metadata, from_, to, id=a.metadata["info"]["id"]
-                )
-            else:
-                log.warning("No metadata associated to this cached avatar?!")
-        n = PepNick.from_db(from_, user_store.get_by_jid(to))
-        if n:
-            await self._broadcast(n.nick, from_, to)
+        self.xmpp.loop.create_task(self.__broadcast(nickname.nick, jid, user_jid.bare))
 
 
 log = logging.getLogger(__name__)