slidge 0.2.0a0__py3-none-any.whl → 0.2.0a1__py3-none-any.whl

slidge/core/mixins/avatar.py

@@ -28,7 +28,6 @@ class AvatarMixin:
 
     jid: JID = NotImplemented
     session: AnyBaseSession = NotImplemented
-    _avatar_pubsub_broadcast: bool = NotImplemented
     _avatar_bare_jid: bool = NotImplemented
 
     def __init__(self) -> None:
@@ -86,7 +85,9 @@ class AvatarMixin:
             return None
         raise TypeError("Bad avatar", a)
 
-    async def __set_avatar(self, a: Optional[AvatarType], uid: Optional[AvatarIdType]):
+    async def __set_avatar(
+        self, a: Optional[AvatarType], uid: Optional[AvatarIdType], delete: bool
+    ):
         self.__avatar_unique_id = uid
 
         if a is None:
@@ -105,13 +106,21 @@ class AvatarMixin:
                 return
             self._avatar_pk = cached_avatar.pk
 
-        if self._avatar_pubsub_broadcast:
+        if self.__should_pubsub_broadcast():
             await self.session.xmpp.pubsub.broadcast_avatar(
                 self.__avatar_jid, self.session.user_jid, cached_avatar
             )
 
+        if delete and isinstance(a, Path):
+            a.unlink()
+
         self._post_avatar_update()
 
+    def __should_pubsub_broadcast(self):
+        return getattr(self, "is_friend", False) and getattr(
+            self, "added_to_roster", False
+        )
+
     async def _no_change(self, a: Optional[AvatarType], uid: Optional[AvatarIdType]):
         if a is None:
             return self.__avatar_unique_id is None
@@ -127,16 +136,20 @@ class AvatarMixin:
         self,
         a: Optional[AvatarType],
         avatar_unique_id: Optional[LegacyFileIdType] = None,
+        delete: bool = False,
         blocking=False,
         cancel=True,
     ) -> None:
         """
         Set an avatar for this entity
 
-        :param a:
-        :param avatar_unique_id:
-        :param blocking:
-        :param cancel:
+        :param a: The avatar, in one of the types slidge supports
+        :param avatar_unique_id: A globally unique ID for the avatar on the
+            legacy network
+        :param delete: If the avatar is provided as a Path, whether to delete
+            it once used or not.
+        :param blocking: Internal use by slidge for tests, do not use!
+        :param cancel: Internal use by slidge, do not use!
         """
         if avatar_unique_id is None and a is not None:
             avatar_unique_id = self.__get_uid(a)
@@ -145,7 +158,7 @@ class AvatarMixin:
         if cancel and self._set_avatar_task:
             self._set_avatar_task.cancel()
         awaitable = create_task(
-            self.__set_avatar(a, avatar_unique_id),
+            self.__set_avatar(a, avatar_unique_id, delete),
             name=f"Set pubsub avatar of {self}",
         )
         if not self._set_avatar_task or self._set_avatar_task.done():
@@ -195,7 +208,7 @@ class AvatarMixin:
             # need to do anything else
             return
 
-        if self._avatar_pubsub_broadcast:
+        if self.__should_pubsub_broadcast():
             if new_id is None and cached_id is None:
                 return
             cached_avatar = avatar_cache.get(cached_id)
@@ -208,6 +221,10 @@ class AvatarMixin:
     def _set_avatar_from_store(self, stored):
         if stored.avatar_id is None:
             return
+        if stored.avatar is None:
+            # seems to happen after avatar cleanup for some reason?
+            self.__avatar_unique_id = None
+            return
         self.__avatar_unique_id = (
             stored.avatar.legacy_id
             if stored.avatar.legacy_id is not None

slidge/core/mixins/db.py

@@ -0,0 +1,18 @@
+from contextlib import contextmanager
+
+
+class UpdateInfoMixin:
+    """
+    This mixin just adds a context manager that prevents commiting to the DB
+    on every attribute change.
+    """
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self._updating_info = False
+
+    @contextmanager
+    def updating_info(self):
+        self._updating_info = True
+        yield
+        self._updating_info = False

slidge/core/mixins/disco.py

@@ -13,10 +13,6 @@ class BaseDiscoMixin(Base):
     DISCO_NAME: str = NotImplemented
     DISCO_LANG = None
 
-    def __init__(self):
-        super().__init__()
-        self.__caps_cache: Optional[str] = None
-
     def _get_disco_name(self):
         if self.DISCO_NAME is NotImplemented:
             return self.xmpp.COMPONENT_NAME
@@ -44,17 +40,11 @@ class BaseDiscoMixin(Base):
         return info
 
     async def get_caps_ver(self, jid: OptJid = None, node: Optional[str] = None):
-        if self.__caps_cache:
-            return self.__caps_cache
         info = await self.get_disco_info(jid, node)
         caps = self.xmpp.plugin["xep_0115"]
         ver = caps.generate_verstring(info, caps.hash)
-        self.__caps_cache = ver
         return ver
 
-    def reset_caps_cache(self):
-        self.__caps_cache = None
-
 
 class ChatterDiscoMixin(BaseDiscoMixin):
     AVATAR = True

slidge/core/mixins/message.py

@@ -241,7 +241,13 @@ class ContentMessageMixin(AttachmentMixin):
         )
         if correction:
             msg["replace"]["id"] = self.__replace_id(legacy_msg_id)
-        return self._send(msg, archive_only=archive_only, carbon=carbon, **send_kwargs)
+        return self._send(
+            msg,
+            archive_only=archive_only,
+            carbon=carbon,
+            legacy_msg_id=legacy_msg_id,
+            **send_kwargs,
+        )
 
     def correct(
         self,

slidge/core/mixins/presence.py

@@ -19,27 +19,30 @@ _FRIEND_REQUEST_PRESENCES = {"subscribe", "unsubscribe", "subscribed", "unsubscr
 
 class PresenceMixin(BaseSender):
     _ONLY_SEND_PRESENCE_CHANGES = False
-    contact_pk: Optional[int]
+    contact_pk: Optional[int] = None
 
     def __init__(self, *a, **k):
         super().__init__(*a, **k)
         # FIXME: this should not be an attribute of this mixin to allow garbage
         #        collection of instances
         self.__update_last_seen_fallback_task: Optional[Task] = None
+        # this is only used when a presence is set during Contact.update_info(),
+        # when the contact does not have a DB primary key yet, and is written
+        # to DB at the end of update_info()
+        self.cached_presence: Optional[CachedPresence] = None
 
     async def __update_last_seen_fallback(self):
         await sleep(3600 * 7)
         self.send_last_presence(force=True, no_cache_online=False)
 
     def _get_last_presence(self) -> Optional[CachedPresence]:
-        # TODO: use contact PK instead of JID
         if self.contact_pk is None:
             return None
         return self.xmpp.store.contacts.get_presence(self.contact_pk)
 
     def _store_last_presence(self, new: CachedPresence):
-        # TODO: use contact PK instead of JID
         if self.contact_pk is None:
+            self.cached_presence = new
             return
         self.xmpp.store.contacts.set_presence(self.contact_pk, new)
 

slidge/core/pubsub.py

@@ -20,8 +20,6 @@ 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 ..db.avatar import CachedAvatar, avatar_cache
 from ..db.store import ContactStore, SlidgeStore
 from .mixins.lock import NamedLockMixin
@@ -174,7 +172,7 @@ class PubSubComponent(NamedLockMixin, BasePlugin):
             else:
                 if pep_avatar.metadata is None:
                     raise XMPPError("internal-server-error", "Avatar but no metadata?")
-                await self.broadcast(
+                await self.__broadcast(
                     data=pep_avatar.metadata,
                     from_=p.get_to(),
                     to=from_,
@@ -186,7 +184,7 @@ class PubSubComponent(NamedLockMixin, BasePlugin):
             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_)
@@ -201,7 +199,7 @@ class PubSubComponent(NamedLockMixin, BasePlugin):
         # but movim expects it to be here, and I guess
 
         log.debug("Broadcast vcard4 event: %s", vcard)
-        await self.broadcast(
+        await self.__broadcast(
             data=vcard,
             from_=JID(from_).bare,
             to=to,
@@ -296,7 +294,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)
@@ -304,12 +302,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:
@@ -342,12 +334,12 @@ class PubSubComponent(NamedLockMixin, BasePlugin):
         self, from_: JidStr, to: JidStr, cached_avatar: Optional[CachedAvatar]
     ) -> None:
         if cached_avatar is None:
-            await self.broadcast(AvatarMetadata(), from_, to)
+            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(
+            await self.__broadcast(
                 pep_avatar.metadata, from_, to, id=pep_avatar.metadata["info"]["id"]
             )
 
@@ -360,7 +352,7 @@ class PubSubComponent(NamedLockMixin, BasePlugin):
         jid = JID(jid)
         nickname = PepNick(nick)
         log.debug("New nickname: %s", nickname.nick)
-        self.xmpp.loop.create_task(self.broadcast(nickname.nick, jid, user_jid.bare))
+        self.xmpp.loop.create_task(self.__broadcast(nickname.nick, jid, user_jid.bare))
 
 
 log = logging.getLogger(__name__)

slidge/core/session.py

@@ -481,14 +481,14 @@ class BaseSession(
         """
         await muc.on_set_affiliation(contact, "member", reason, None)
 
-    async def on_leave_group(self, muc: LegacyMUC):
+    async def on_leave_group(self, muc_legacy_id: LegacyGroupIdType):
         """
         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: The group to leave
+        :param muc_legacy_id: The legacy ID of the group to leave
         """
         raise NotImplementedError
 
@@ -728,7 +728,7 @@ class BaseSession(
         # No reason to override this
         self.xmpp.re_login(self)
 
-    async def get_contact_or_group_or_participant(self, jid: JID):
+    async def get_contact_or_group_or_participant(self, jid: JID, create=True):
         if jid.bare in (contacts := self.contacts.known_contacts(only_friends=False)):
             return contacts[jid.bare]
         if (muc := self.bookmarks.by_jid_only_if_exists(JID(jid.bare))) is not None:
@@ -736,6 +736,9 @@ class BaseSession(
         else:
             muc = None
 
+        if not create:
+            return None
+
         try:
             return await self.contacts.by_jid(jid)
         except XMPPError:

slidge/db/alembic/versions/2461390c0af2_store_contacts_caps_verstring_in_db.py

@@ -0,0 +1,36 @@
+"""Store contacts caps verstring in DB
+
+Revision ID: 2461390c0af2
+Revises: 2b1f45ab7379
+Create Date: 2024-07-20 08:00:11.675735
+
+"""
+
+from typing import Sequence, Union
+
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision: str = "2461390c0af2"
+down_revision: Union[str, None] = "2b1f45ab7379"
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table("contact", schema=None) as batch_op:
+        batch_op.add_column(sa.Column("caps_ver_bare", sa.String(), nullable=True))
+        batch_op.add_column(sa.Column("caps_ver", sa.String(), nullable=True))
+
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table("contact", schema=None) as batch_op:
+        batch_op.drop_column("caps_ver")
+        batch_op.drop_column("caps_ver_bare")
+
+    # ### end Alembic commands ###

slidge/db/alembic/versions/2b1f45ab7379_store_room_subject_setter_by_nickname.py

@@ -0,0 +1,41 @@
+"""Store room subject setter by nickname
+
+Revision ID: 2b1f45ab7379
+Revises: c4a8ec35a0e8
+Create Date: 2024-07-20 00:14:36.882689
+
+"""
+
+from typing import Sequence, Union
+
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision: str = "2b1f45ab7379"
+down_revision: Union[str, None] = "c4a8ec35a0e8"
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table("room", schema=None) as batch_op:
+        batch_op.add_column(sa.Column("subject_setter", sa.String(), nullable=True))
+        batch_op.drop_constraint("subject_setter_id_foreign_key", type_="foreignkey")
+        batch_op.drop_column("subject_setter_id")
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table("room", schema=None) as batch_op:
+        batch_op.add_column(sa.Column("subject_setter_id", sa.INTEGER(), nullable=True))
+        batch_op.create_foreign_key(
+            "subject_setter_id_foreign_key",
+            "participant",
+            ["subject_setter_id"],
+            ["id"],
+        )
+        batch_op.drop_column("subject_setter")
+    # ### end Alembic commands ###

slidge/db/alembic/versions/82a4af84b679_add_muc_history_filled.py

@@ -0,0 +1,48 @@
+"""Add MUC.history_filled
+
+Also drop caps_ver_bare column that should never have been added.
+
+Revision ID: 82a4af84b679
+Revises: 2461390c0af2
+Create Date: 2024-07-22 07:01:05.352737
+
+"""
+
+from typing import Sequence, Union
+
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision: str = "82a4af84b679"
+down_revision: Union[str, None] = "2461390c0af2"
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table("contact", schema=None) as batch_op:
+        batch_op.drop_column("caps_ver_bare")
+
+    with op.batch_alter_table("room", schema=None) as batch_op:
+        batch_op.add_column(
+            sa.Column(
+                "history_filled",
+                sa.Boolean(),
+                nullable=False,
+                server_default=sa.False_(),  # manually added
+            )
+        )
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table("room", schema=None) as batch_op:
+        batch_op.drop_column("history_filled")
+
+    with op.batch_alter_table("contact", schema=None) as batch_op:
+        batch_op.add_column(sa.Column("caps_ver_bare", sa.VARCHAR(), nullable=True))
+
+    # ### end Alembic commands ###

slidge/db/alembic/versions/aa9d82a7f6ef_db_creation.py

@@ -9,6 +9,7 @@ Create Date: 2024-04-17 20:57:01.357041
 """
 
 import logging
+from datetime import datetime
 from typing import Sequence, Union
 
 import sqlalchemy as sa
@@ -43,7 +44,11 @@ def upgrade() -> None:
         sa.UniqueConstraint("jid"),
     )
     # ### end Alembic commands ###
-    migrate_from_shelf(accounts)
+    try:
+        migrate_from_shelf(accounts)
+    except Exception:
+        downgrade()
+        raise
 
 
 def downgrade() -> None:
@@ -67,7 +72,11 @@ def migrate_from_shelf(accounts: sa.Table) -> None:
         [
             {
                 "jid": user.jid,
-                "registration_date": user.registration_date,
+                "registration_date": (
+                    user.registration_date
+                    if user.registration_date is not None
+                    else datetime.now()
+                ),
                 "legacy_module_data": user.registration_form,
                 "preferences": {},
             }

slidge/db/alembic/versions/b64b1a793483_add_source_and_legacy_id_for_archived_.py

@@ -0,0 +1,48 @@
+"""Add source and legacy ID for archived messages
+
+Revision ID: b64b1a793483
+Revises: 82a4af84b679
+Create Date: 2024-07-22 21:06:35.020569
+
+"""
+
+from typing import Sequence, Union
+
+import sqlalchemy as sa
+from alembic import op
+
+from slidge.db.models import ArchivedMessage
+
+# revision identifiers, used by Alembic.
+revision: str = "b64b1a793483"
+down_revision: Union[str, None] = "82a4af84b679"
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    # since we don't want source to be nullable, we drop all rows first.
+    # This is what you get by using alpha versions!
+    op.execute(sa.delete(ArchivedMessage))
+    # ### commands auto generated by Alembic - please adjust! ###
+
+    with op.batch_alter_table("mam", schema=None) as batch_op:
+        batch_op.add_column(
+            sa.Column(
+                "source",
+                sa.Enum("LIVE", "BACKFILL", name="archivedmessagesource"),
+                nullable=False,
+            )
+        )
+        batch_op.add_column(sa.Column("legacy_id", sa.String(), nullable=True))
+
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table("mam", schema=None) as batch_op:
+        batch_op.drop_column("legacy_id")
+        batch_op.drop_column("source")
+
+    # ### end Alembic commands ###

slidge/db/alembic/versions/c4a8ec35a0e8_per_room_user_nick.py

@@ -0,0 +1,34 @@
+"""Per-room user nick
+
+Revision ID: c4a8ec35a0e8
+Revises: 09f27f098baa
+Create Date: 2024-07-12 06:27:47.397925
+
+"""
+
+from typing import Sequence, Union
+
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision: str = "c4a8ec35a0e8"
+down_revision: Union[str, None] = "09f27f098baa"
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table("room", schema=None) as batch_op:
+        batch_op.add_column(sa.Column("user_nick", sa.String(), nullable=True))
+
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table("room", schema=None) as batch_op:
+        batch_op.drop_column("user_nick")
+
+    # ### end Alembic commands ###

slidge/db/avatar.py

@@ -70,6 +70,17 @@ class AvatarCache:
     def set_dir(self, path: Path):
         self.dir = path
         self.dir.mkdir(exist_ok=True)
+        with self.store.session():
+            for stored in self.store.get_all():
+                avatar = CachedAvatar.from_store(stored, root_dir=path)
+                if avatar.path.exists():
+                    continue
+                log.warning(
+                    "Removing avatar %s from store because %s does not exist",
+                    avatar.hash,
+                    avatar.path,
+                )
+                self.store.delete_by_pk(stored.id)
 
     def close(self):
         self._thread_pool.shutdown(cancel_futures=True)
@@ -142,15 +153,15 @@ class AvatarCache:
 
         if isinstance(avatar, (URL, str)):
             if unique_id is None:
-                stored = self.store.get_by_url(avatar)
-                try:
-                    img, response_headers = await self.__download(
-                        avatar, self.__get_http_headers(stored)
-                    )
-                except NotModified:
-                    assert stored is not None
-                    return CachedAvatar.from_store(stored, self.dir)
-
+                with self.store.session():
+                    stored = self.store.get_by_url(avatar)
+                    try:
+                        img, response_headers = await self.__download(
+                            avatar, self.__get_http_headers(stored)
+                        )
+                    except NotModified:
+                        assert stored is not None
+                        return CachedAvatar.from_store(stored, self.dir)
             else:
                 img, _ = await self.__download(avatar, {})
                 response_headers = None

slidge/db/models.py

@@ -24,6 +24,16 @@ class XmppToLegacyEnum(IntEnum):
     THREAD = 3
 
 
+class ArchivedMessageSource(IntEnum):
+    """
+    Whether an archived message comes from ``LegacyMUC.backfill()`` or was received
+    as a "live" message.
+    """
+
+    LIVE = 1
+    BACKFILL = 2
+
+
 class GatewayUser(Base):
     """
     A user, registered to the gateway component.
@@ -145,6 +155,7 @@ class Contact(Base):
     ptype: Mapped[Optional[str]] = mapped_column(nullable=True)
     pstatus: Mapped[Optional[str]] = mapped_column(nullable=True)
     pshow: Mapped[Optional[str]] = mapped_column(nullable=True)
+    caps_ver: Mapped[Optional[str]] = mapped_column(nullable=True)
 
     is_friend: Mapped[bool] = mapped_column(default=False)
     added_to_roster: Mapped[bool] = mapped_column(default=False)
@@ -195,20 +206,17 @@ class Room(Base):
     description: Mapped[Optional[str]] = mapped_column(nullable=True)
     subject: Mapped[Optional[str]] = mapped_column(nullable=True)
     subject_date: Mapped[Optional[datetime]] = mapped_column(nullable=True)
-    subject_setter_id: Mapped[Optional[int]] = mapped_column(
-        ForeignKey("participant.id"), nullable=True
-    )
-    subject_setter: Mapped["Participant"] = relationship(
-        foreign_keys="Room.subject_setter_id"
-    )
+    subject_setter: Mapped[Optional[str]] = mapped_column(nullable=True)
 
     n_participants: Mapped[Optional[int]] = mapped_column(default=None)
 
     muc_type: Mapped[Optional[MucType]] = mapped_column(default=MucType.GROUP)
 
+    user_nick: Mapped[Optional[str]] = mapped_column()
     user_resources: Mapped[Optional[str]] = mapped_column(nullable=True)
 
     participants_filled: Mapped[bool] = mapped_column(default=False)
+    history_filled: Mapped[bool] = mapped_column(default=False)
 
     extra_attributes: Mapped[Optional[JSONSerializable]] = mapped_column(default=None)
     updated: Mapped[bool] = mapped_column(default=False)
@@ -232,6 +240,8 @@ class ArchivedMessage(Base):
     stanza_id: Mapped[str] = mapped_column(nullable=False)
     timestamp: Mapped[datetime] = mapped_column(nullable=False)
     author_jid: Mapped[JID] = mapped_column(nullable=False)
+    source: Mapped[ArchivedMessageSource] = mapped_column(nullable=False)
+    legacy_id: Mapped[Optional[str]] = mapped_column(nullable=True)
 
     stanza: Mapped[str] = mapped_column(nullable=False)