slidge 0.1.2__py3-none-any.whl → 0.2.0a0__py3-none-any.whl

slidge/contact/contact.py

@@ -2,7 +2,7 @@ import datetime
 import logging
 import warnings
 from datetime import date
-from typing import TYPE_CHECKING, Generic, Iterable, Optional, Union
+from typing import TYPE_CHECKING, Generic, Iterable, Optional, Self, Union
 
 from slixmpp import JID, Message, Presence
 from slixmpp.exceptions import IqError
@@ -10,10 +10,10 @@ from slixmpp.plugins.xep_0292.stanza import VCard4
 from slixmpp.types import MessageTypes
 
 from ..core import config
-from ..core.mixins import FullCarbonMixin
-from ..core.mixins.avatar import AvatarMixin
+from ..core.mixins import AvatarMixin, FullCarbonMixin, StoredAttributeMixin
 from ..core.mixins.disco import ContactAccountDiscoMixin
 from ..core.mixins.recipient import ReactionRecipientMixin, ThreadRecipientMixin
+from ..db.models import Contact
 from ..util import SubclassableOnce
 from ..util.types import LegacyUserIdType, MessageOrPresenceTypeVar
 
@@ -24,6 +24,7 @@ if TYPE_CHECKING:
 
 class LegacyContact(
     Generic[LegacyUserIdType],
+    StoredAttributeMixin,
     AvatarMixin,
     ContactAccountDiscoMixin,
     FullCarbonMixin,
@@ -100,7 +101,6 @@ class LegacyContact(
         """
         super().__init__()
         self.session = session
-        self.user = session.user
         self.legacy_id: LegacyUserIdType = legacy_id
         """
         The legacy identifier of the :term:`Legacy Contact`.
@@ -116,16 +116,40 @@ class LegacyContact(
 
         self._name: Optional[str] = None
 
-        if self.xmpp.MARK_ALL_MESSAGES:
-            self._sent_order = list[str]()
-
         self.xmpp = session.xmpp
         self.jid = JID(self.jid_username + "@" + self.xmpp.boundjid.bare)
         self.jid.resource = self.RESOURCE
-        self.log = logging.getLogger(f"{self.user.bare_jid}:{self.jid.bare}")
-        self.participants = set["LegacyParticipant"]()
-        self.is_friend: bool = False
-        self.__added_to_roster = False
+        self.log = logging.getLogger(f"{self.user_jid.bare}:{self.jid.bare}")
+        self._is_friend: bool = False
+        self.added_to_roster = False
+
+    @property
+    def is_friend(self):
+        return self._is_friend
+
+    @is_friend.setter
+    def is_friend(self, value: bool):
+        if value == self._is_friend:
+            return
+        self._is_friend = value
+        assert self.contact_pk is not None
+        self.xmpp.store.contacts.set_friend(self.contact_pk, value)
+
+    @property
+    def participants(self) -> list["LegacyParticipant"]:
+        assert self.contact_pk is not None
+        from ..group.participant import LegacyParticipant
+
+        return [
+            LegacyParticipant.get_self_or_unique_subclass().from_store(
+                self.session, stored, contact=self
+            )
+            for stored in self.xmpp.store.participants.get_for_contact(self.contact_pk)
+        ]
+
+    @property
+    def user_jid(self):
+        return self.session.user_jid
 
     def __repr__(self):
         return f"<Contact '{self.legacy_id}'/'{self.jid.bare}'>"
@@ -170,7 +194,7 @@ class LegacyContact(
     ) -> MessageOrPresenceTypeVar:
         if carbon and isinstance(stanza, Message):
             stanza["to"] = self.jid.bare
-            stanza["from"] = self.user.jid
+            stanza["from"] = self.user_jid
             self._privileged_send(stanza)
             return stanza  # type:ignore
 
@@ -186,12 +210,13 @@ class LegacyContact(
             n["nick"] = self.name
             stanza.append(n)
         if self.xmpp.MARK_ALL_MESSAGES and is_markable(stanza):
-            self._sent_order.append(stanza["id"])
-        stanza["to"] = self.user.jid
+            assert self.contact_pk is not None
+            self.xmpp.store.contacts.add_to_sent(self.contact_pk, stanza["id"])
+        stanza["to"] = self.user_jid
         stanza.send()
         return stanza
 
-    def get_msg_xmpp_id_up_to(self, horizon_xmpp_id: str):
+    def get_msg_xmpp_id_up_to(self, horizon_xmpp_id: str) -> list[str]:
         """
         Return XMPP msg ids sent by this contact up to a given XMPP msg id.
 
@@ -205,15 +230,8 @@ class LegacyContact(
         :param horizon_xmpp_id: The latest message
         :return: A list of XMPP ids or None if horizon_xmpp_id was not found
         """
-        for i, xmpp_id in enumerate(self._sent_order):
-            if xmpp_id == horizon_xmpp_id:
-                break
-        else:
-            return
-        i += 1
-        res = self._sent_order[:i]
-        self._sent_order = self._sent_order[i:]
-        return res
+        assert self.contact_pk is not None
+        return self.xmpp.store.contacts.pop_sent_up_to(self.contact_pk, horizon_xmpp_id)
 
     @property
     def name(self):
@@ -229,9 +247,19 @@ class LegacyContact(
         for p in self.participants:
             p.nickname = n
         self._name = n
-        self.xmpp.pubsub.set_nick(user=self.user, jid=self.jid.bare, nick=n)
+        assert self.contact_pk is not None
+        self.xmpp.store.contacts.update_nick(self.contact_pk, n)
+        self.xmpp.pubsub.broadcast_nick(
+            user_jid=self.user_jid, jid=self.jid.bare, nick=n
+        )
+
+    def _get_cached_avatar_id(self):
+        assert self.contact_pk is not None
+        return self.xmpp.store.contacts.get_avatar_legacy_id(self.contact_pk)
 
     def _post_avatar_update(self):
+        assert self.contact_pk is not None
+        self.xmpp.store.contacts.set_avatar(self.contact_pk, self._avatar_pk)
         for p in self.participants:
             self.log.debug("Propagating new avatar to %s", p.muc)
             p.send_last_presence(force=True, no_cache_online=True)
@@ -283,7 +311,7 @@ class LegacyContact(
         elif country:
             vcard.add_address(country, locality)
 
-        self.xmpp.vcard.set_vcard(self.jid.bare, vcard, {self.user.jid.bare})
+        self.xmpp.vcard.set_vcard(self.jid.bare, vcard, {self.user_jid.bare})
 
     async def add_to_roster(self, force=False):
         """
@@ -291,7 +319,7 @@ class LegacyContact(
 
         :param force: add even if the contact was already added successfully
         """
-        if self.__added_to_roster and not force:
+        if self.added_to_roster and not force:
             return
         if config.NO_ROSTER_PUSH:
             log.debug("Roster push request by plugin ignored (--no-roster-push)")
@@ -303,7 +331,7 @@ class LegacyContact(
         if (n := self.name) is not None:
             item["name"] = n
         kw = dict(
-            jid=self.user.jid,
+            jid=self.user_jid,
             roster_items={self.jid.bare: item},
         )
         try:
@@ -325,12 +353,26 @@ class LegacyContact(
         else:
             # we only broadcast pubsub events for contacts added to the roster
             # so if something was set before, we need to push it now
-            self.__added_to_roster = True
+            self.added_to_roster = True
             self.session.create_task(self.__broadcast_pubsub_items())
             self.send_last_presence()
 
     async def __broadcast_pubsub_items(self):
-        await self.xmpp.pubsub.broadcast_all(JID(self.jid.bare), self.user.jid)
+        cached_avatar = self.get_cached_avatar()
+        if cached_avatar is not None:
+            await self.xmpp.pubsub.broadcast_avatar(
+                self.jid.bare, self.session.user_jid, cached_avatar
+            )
+        nick = self.name
+        from ..core.pubsub import PepNick
+
+        if nick is not None:
+            pep_nick = PepNick(nick)
+            await self.xmpp.pubsub.broadcast(
+                pep_nick.nick,
+                self.jid.bare,
+                self.session.user_jid,
+            )
 
     async def _set_roster(self, **kw):
         try:
@@ -350,6 +392,8 @@ class LegacyContact(
         :param text: Optional message from the friend to the user
         """
         self.is_friend = True
+        assert self.contact_pk is not None
+        self.xmpp.store.contacts.set_friend(self.contact_pk, True)
         self.log.debug("Accepting friend request")
         presence = self._make_presence(ptype="subscribed", pstatus=text, bare=True)
         self._send(presence, nick=True)
@@ -415,7 +459,7 @@ class LegacyContact(
         their 'friends'".
         """
         for ptype in "unsubscribe", "unsubscribed", "unavailable":
-            self.xmpp.send_presence(pfrom=self.jid, pto=self.user.jid.bare, ptype=ptype)  # type: ignore
+            self.xmpp.send_presence(pfrom=self.jid, pto=self.user_jid.bare, ptype=ptype)  # type: ignore
 
     async def update_info(self):
         """
@@ -442,6 +486,24 @@ class LegacyContact(
         """
         pass
 
+    @classmethod
+    def from_store(cls, session, stored: Contact, *args, **kwargs) -> Self:
+        contact = cls(
+            session,
+            cls.xmpp.LEGACY_CONTACT_ID_TYPE(stored.legacy_id),
+            stored.jid.username,  # type: ignore
+            *args,  # type: ignore
+            **kwargs,  # type: ignore
+        )
+        contact.contact_pk = stored.id
+        contact._name = stored.nick
+        contact._is_friend = stored.is_friend
+        contact.added_to_roster = stored.added_to_roster
+        if (data := stored.extra_attributes) is not None:
+            contact.deserialize_extra_attributes(data)
+        contact._set_avatar_from_store(stored)
+        return contact
+
 
 def is_markable(stanza: Union[Message, Presence]):
     if isinstance(stanza, Presence):

slidge/contact/roster.py

@@ -1,11 +1,12 @@
 import asyncio
 import logging
-from typing import TYPE_CHECKING, Generic, Optional, Type
+from typing import TYPE_CHECKING, Generic, Iterator, Optional, Type
 
 from slixmpp import JID
 from slixmpp.jid import JID_UNESCAPE_TRANSFORMATIONS, _unescape_node
 
 from ..core.mixins.lock import NamedLockMixin
+from ..db.store import ContactStore
 from ..util import SubclassableOnce
 from ..util.types import LegacyContactType, LegacyUserIdType
 from .contact import LegacyContact
@@ -43,38 +44,45 @@ class LegacyRoster(
             LegacyContact.get_self_or_unique_subclass()
         )
         self._contact_cls.xmpp = session.xmpp
+        self.__store: ContactStore = session.xmpp.store.contacts
 
         self.session = session
-        self._contacts_by_bare_jid: dict[str, LegacyContactType] = {}
-        self._contacts_by_legacy_id: dict[LegacyUserIdType, LegacyContactType] = {}
-        self.log = logging.getLogger(f"{self.session.user.bare_jid}:roster")
+        self.log = logging.getLogger(f"{self.session.user_jid.bare}:roster")
         self.user_legacy_id: Optional[LegacyUserIdType] = None
         self.ready: asyncio.Future[bool] = self.session.xmpp.loop.create_future()
         super().__init__()
 
     def __repr__(self):
-        return f"<Roster of {self.session.user}>"
+        return f"<Roster of {self.session.user_jid}>"
 
-    def __iter__(self):
-        return iter(self._contacts_by_legacy_id.values())
+    def __iter__(self) -> Iterator[LegacyContactType]:
+        with self.__store.session():
+            for stored in self.__store.get_all(user_pk=self.session.user_pk):
+                yield self._contact_cls.from_store(self.session, stored)
 
     async def __finish_init_contact(
         self, legacy_id: LegacyUserIdType, jid_username: str, *args, **kwargs
     ):
         c = self._contact_cls(self.session, legacy_id, jid_username, *args, **kwargs)
-        async with self.lock(("finish", c)):
-            if legacy_id in self._contacts_by_legacy_id:
-                self.log.debug("Already updated %s", c)
-                return c
-            await c.avatar_wrap_update_info()
-            self._contacts_by_legacy_id[legacy_id] = c
-            self._contacts_by_bare_jid[c.jid.bare] = c
+        async with self.lock(("finish", c.legacy_id)):
+            with self.__store.session():
+                stored = self.__store.get_by_legacy_id(
+                    self.session.user_pk, str(legacy_id)
+                )
+                if stored is not None and stored.updated:
+                    self.log.debug("Already updated %s", c)
+                    return self._contact_cls.from_store(self.session, stored)
+                c.contact_pk = self.__store.add(
+                    self.session.user_pk, c.legacy_id, c.jid
+                )
+                await c.avatar_wrap_update_info()
+                self.__store.update(c)
         return c
 
     def known_contacts(self, only_friends=True) -> dict[str, LegacyContactType]:
         if only_friends:
-            return {j: c for j, c in self._contacts_by_bare_jid.items() if c.is_friend}
-        return self._contacts_by_bare_jid
+            return {j: c for j, c in self if c.is_friend}  # type:ignore
+        return {c.jid.bare: c for c in self}
 
     async def by_jid(self, contact_jid: JID) -> LegacyContactType:
         # """
@@ -89,16 +97,17 @@ class LegacyRoster(
         # """
         username = contact_jid.node
         async with self.lock(("username", username)):
-            bare = contact_jid.bare
-            c = self._contacts_by_bare_jid.get(bare)
-            if c is None:
-                legacy_id = await self.jid_username_to_legacy_id(username)
-                log.debug("Contact %s not found", contact_jid)
-                if self.get_lock(("legacy_id", legacy_id)):
-                    log.debug("Already updating %s", contact_jid)
-                    return await self.by_legacy_id(legacy_id)
-                c = await self.__finish_init_contact(legacy_id, username)
-            return c
+            with self.__store.session():
+                stored = self.__store.get_by_jid(self.session.user_pk, contact_jid)
+                if stored is not None and stored.updated:
+                    return self._contact_cls.from_store(self.session, stored)
+
+            legacy_id = await self.jid_username_to_legacy_id(username)
+            log.debug("Contact %s not found", contact_jid)
+            if self.get_lock(("legacy_id", legacy_id)):
+                log.debug("Already updating %s", contact_jid)
+                return await self.by_legacy_id(legacy_id)
+            return await self.__finish_init_contact(legacy_id, username)
 
     async def by_legacy_id(
         self, legacy_id: LegacyUserIdType, *args, **kwargs
@@ -121,20 +130,26 @@ class LegacyRoster(
         if legacy_id == self.user_legacy_id:
             raise ContactIsUser
         async with self.lock(("legacy_id", legacy_id)):
-            c = self._contacts_by_legacy_id.get(legacy_id)
-            if c is None:
-                username = await self.legacy_id_to_jid_username(legacy_id)
-                log.debug("Contact %s not found", legacy_id)
-                if self.get_lock(("username", username)):
-                    log.debug("Already updating %s", username)
-                    jid = JID()
-                    jid.node = username
-                    jid.domain = self.session.xmpp.boundjid.bare
-                    return await self.by_jid(jid)
-                c = await self.__finish_init_contact(
-                    legacy_id, username, *args, **kwargs
+            with self.__store.session():
+                stored = self.__store.get_by_legacy_id(
+                    self.session.user_pk, str(legacy_id)
                 )
-            return c
+                if stored is not None and stored.updated:
+                    return self._contact_cls.from_store(
+                        self.session, stored, *args, **kwargs
+                    )
+
+            username = await self.legacy_id_to_jid_username(legacy_id)
+            log.debug("Contact %s not found", legacy_id)
+            if self.get_lock(("username", username)):
+                log.debug("Already updating %s", username)
+                jid = JID()
+                jid.node = username
+                jid.domain = self.session.xmpp.boundjid.bare
+                return await self.by_jid(jid)
+            return await self.__finish_init_contact(
+                legacy_id, username, *args, **kwargs
+            )
 
     async def by_stanza(self, s) -> LegacyContact:
         # """

slidge/core/config.py

@@ -43,11 +43,18 @@ PORT__SHORT = "p"
 
 HOME_DIR: Path
 HOME_DIR__DOC = (
-    "Shelve file used to store persistent user data. "
+    "Directory where slidge will writes it persistent data and cache. "
     "Defaults to /var/lib/slidge/${SLIDGE_JID}. "
 )
 HOME_DIR__DYNAMIC_DEFAULT = True
 
+DB_URL: str
+DB_URL__DOC = (
+    "Database URL, see <https://docs.sqlalchemy.org/en/20/core/engines.html#database-urls>. "
+    "Defaults to sqlite:///${HOME_DIR}/slidge.sqlite"
+)
+DB_URL__DYNAMIC_DEFAULT = True
+
 USER_JID_VALIDATOR: str
 USER_JID_VALIDATOR__DOC = (
     "Regular expression to restrict users that can register to the gateway, by JID. "
@@ -70,7 +77,7 @@ UPLOAD_SERVICE__DOC = (
 )
 
 SECRET_KEY: Optional[str] = None
-SECRET_KEY__DOC = "Encryption for disk storage"
+SECRET_KEY__DOC = "Encryption for disk storage. Deprecated."
 
 NO_ROSTER_PUSH = False
 NO_ROSTER_PUSH__DOC = "Do not fill users' rosters with legacy contacts automatically"
@@ -135,11 +142,13 @@ PARTIAL_REGISTRATION_TIMEOUT__DOC = (
     "a single step registration process is not enough."
 )
 
-LAST_SEEN_FALLBACK = True
+LAST_SEEN_FALLBACK = False
 LAST_SEEN_FALLBACK__DOC = (
     "When using XEP-0319 (Last User Interaction in Presence), use the presence status"
     " to display the last seen information in the presence status. Useful for clients"
-    " that do not implement XEP-0319."
+    " that do not implement XEP-0319. Because of implementation details, this can increase"
+    " RAM usage and might be deprecated in the future. Ask your client dev for XEP-0319"
+    " support ;o)."
 )
 
 QR_TIMEOUT = 60
@@ -211,6 +220,3 @@ DEV_MODE__DOC = (
     "Enables an interactive python shell via chat commands, for admins."
     "Not safe to use in prod, but great during dev."
 )
-
-SYNC_AVATAR = True
-SYNC_AVATAR__DOC = "Sync the user XMPP avatar to legacy network (if supported)."