slidge 0.3.0b3__tar.gz → 0.3.0b4__tar.gz

{slidge-0.3.0b3 → slidge-0.3.0b4}/.woodpecker/container-ci.yaml

@@ -19,7 +19,7 @@ labels:
 
 steps:
   build-and-push:
-    image: woodpeckerci/plugin-docker-buildx
+    image: woodpeckerci/plugin-docker-buildx:6.0.2
     settings:
       repo: codeberg.org/slidge/slidge
       registry: codeberg.org

{slidge-0.3.0b3 → slidge-0.3.0b4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: slidge
-Version: 0.3.0b3
+Version: 0.3.0b4
 Summary: XMPP bridging framework
 Author-email: Nicolas Cedilnik <nicoco@nicoco.fr>
 License-Expression: AGPL-3.0-or-later

{slidge-0.3.0b3 → slidge-0.3.0b4}/slidge/core/gateway.py

@@ -172,6 +172,13 @@ class BaseGateway(
             required=True,
             type="boolean",
         ),
+        FormField(
+            var="reaction_fallback",
+            label="Receive fallback messages for reactions (for legacy XMPP clients)",
+            value="false",
+            required=True,
+            type="boolean",
+        ),
     ]
 
     ROSTER_GROUP: str = "slidge"

{slidge-0.3.0b3 → slidge-0.3.0b4}/slidge/core/mixins/base.py

@@ -31,6 +31,8 @@ class Base:
 
 
 class BaseSender(Base):
+    is_participant = False
+
     def _send(
         self, stanza: MessageOrPresenceTypeVar, **send_kwargs
     ) -> MessageOrPresenceTypeVar:

{slidge-0.3.0b3 → slidge-0.3.0b4}/slidge/core/mixins/message_text.py

@@ -2,6 +2,9 @@ import logging
 from datetime import datetime
 from typing import Iterable, Optional
 
+from slixmpp import Message
+
+from ...util.archive_msg import HistoryMessage
 from ...util.types import (
     LegacyMessageType,
     LegacyThreadType,
@@ -9,6 +12,7 @@ from ...util.types import (
     MessageReference,
     ProcessingHint,
 )
+from ...util.util import add_quote_prefix
 from .message_maker import MessageMaker
 
 
@@ -188,8 +192,33 @@ class TextMessageMixin(MessageMaker):
         if not xmpp_id:
             xmpp_id = self._legacy_to_xmpp(legacy_msg_id)
         self.xmpp["xep_0444"].set_reactions(msg, to_id=xmpp_id, reactions=emojis)
+        self.__add_reaction_fallback(msg, legacy_msg_id, emojis)
         self._send(msg, **kwargs)
 
+    def __add_reaction_fallback(
+        self,
+        msg: Message,
+        legacy_msg_id: LegacyMessageType,
+        emojis: Iterable[str] = (),
+    ) -> None:
+        if not self.session.user.preferences.get("reaction_fallback", False):
+            return
+        msg["fallback"]["for"] = self.xmpp.plugin["xep_0444"].namespace
+        msg["fallback"].enable("body")
+        msg["body"] = " ".join(emojis)
+        if not self.is_participant:
+            return
+        with self.xmpp.store.session() as orm:
+            archived = self.xmpp.store.mam.get_by_legacy_id(
+                orm, self.muc.stored.id, str(legacy_msg_id)
+            )
+            if archived is None:
+                return
+            history_msg = HistoryMessage(archived.stanza)
+            msg["body"] = (
+                add_quote_prefix(history_msg.stanza["body"]) + "\n" + msg["body"]
+            )
+
     def retract(
         self,
         legacy_msg_id: LegacyMessageType,

{slidge-0.3.0b3 → slidge-0.3.0b4}/slidge/core/mixins/presence.py

@@ -62,8 +62,9 @@ class PresenceMixin(BaseSender, DBMixin):
             try:
                 return self.stored.contact
             except DetachedInstanceError:
-                self.merge()
-                return self.stored.contact
+                with self.xmpp.store.session() as orm:
+                    orm.add(self.stored)
+                    return self.stored.contact
 
     @property
     def __contact_pk(self) -> int | None:

{slidge-0.3.0b3 → slidge-0.3.0b4}/slidge/group/archive.py

@@ -1,5 +1,6 @@
 import logging
 import uuid
+import warnings
 from copy import copy
 from datetime import datetime, timezone
 from typing import TYPE_CHECKING, Collection, Optional
@@ -48,7 +49,9 @@ class MessageArchive:
             elif participant.is_system:
                 new_msg["muc"]["jid"] = participant.muc.jid
             else:
-                log.warning("No real JID for participant in this group")
+                warnings.warn(
+                    f"No real JID for participant '{participant.nickname}' in '{self.room.name}'"
+                )
                 new_msg["muc"]["jid"] = (
                     f"{uuid.uuid4()}@{participant.xmpp.boundjid.bare}"
                 )

{slidge-0.3.0b3 → slidge-0.3.0b4}/slidge/group/bookmarks.py

@@ -158,7 +158,7 @@ class LegacyBookmarks(
                 stored = Room(
                     user_account_id=self.session.user_pk,
                     jid=jid,
-                    legacy_id=legacy_id,
+                    legacy_id=str(legacy_id),
                 )
             return await self.__update_if_needed(stored)
 

{slidge-0.3.0b3 → slidge-0.3.0b4}/slidge/group/participant.py

@@ -6,8 +6,8 @@ from copy import copy
 from datetime import datetime
 from functools import cached_property
 from typing import TYPE_CHECKING, Any, Optional, Union
+from xml.etree import ElementTree as ET
 
-import sqlalchemy as sa
 from slixmpp import JID, InvalidJID, Message, Presence
 from slixmpp.plugins.xep_0045.stanza import MUCAdminItem
 from slixmpp.types import MessageTypes, OptJid
@@ -51,6 +51,8 @@ class LegacyParticipant(
     A legacy participant of a legacy group chat.
     """
 
+    is_participant = True
+
     mtype: MessageTypes = "groupchat"
     _can_send_carbon = False
     USE_STANZA_ID = True
@@ -93,6 +95,13 @@ class LegacyParticipant(
             self.merge()
             return self.stored.is_user
 
+    @is_user.setter
+    def is_user(self, is_user: bool) -> None:
+        with self.xmpp.store.session(expire_on_commit=True) as orm:
+            orm.add(self.stored)
+            self.stored.is_user = is_user
+            orm.commit()
+
     @property
     def jid(self) -> JID:
         jid = JID(self.muc.jid)
@@ -510,7 +519,11 @@ class LegacyParticipant(
         if when is not None:
             msg["delay"].set_stamp(when)
             msg["delay"]["from"] = self.muc.jid
-        msg["subject"] = subject or str(self.muc.name)
+        if subject:
+            msg["subject"] = subject
+        else:
+            # may be simplified if slixmpp lets it do it more easily some day
+            msg.xml.append(ET.Element(f"{{{msg.namespace}}}subject"))
         self._send(msg, full_jid)
 
 

{slidge-0.3.0b3 → slidge-0.3.0b4}/slidge/group/room.py

@@ -431,8 +431,8 @@ class LegacyMUC(
         yield
 
     @property
-    def subject(self):
-        return self.stored.subject
+    def subject(self) -> str:
+        return self.stored.subject or ""
 
     @subject.setter
     def subject(self, s: str) -> None:
@@ -652,7 +652,7 @@ class LegacyMUC(
                     orm.refresh(self.stored, ["participants"])
         if not user_participant.is_user:
             self.log.warning("is_user flag not set participant on user_participant")
-            user_participant.is_user = True  # type:ignore
+            user_participant.is_user = True
         user_participant.send_initial_presence(
             user_full_jid,
             presence_id=join_presence["id"],
@@ -680,8 +680,12 @@ class LegacyMUC(
                 maxstanzas=maxstanzas,
                 since=since,
             )
+        if self.HAS_SUBJECT:
+            subject = self.subject or ""
+        else:
+            subject = self.description or self.name or ""
         self.__get_subject_setter_participant().set_room_subject(
-            self.subject if self.HAS_SUBJECT else (self.description or self.name or ""),
+            subject,
             user_full_jid,
             self.subject_date,
         )

{slidge-0.3.0b3 → slidge-0.3.0b4}/slidge/migration.py

@@ -1,5 +1,4 @@
 import logging
-import shutil
 import sys
 import traceback
 from pathlib import Path
@@ -7,15 +6,6 @@ from pathlib import Path
 from alembic import command
 from alembic.config import Config
 
-from .core import config
-
-
-def remove_avatar_cache_v1() -> None:
-    old_dir = config.HOME_DIR / "slidge_avatars"
-    if old_dir.exists():
-        log.info("Avatar cache dir v1 found, clearing it.")
-        shutil.rmtree(old_dir)
-
 
 def get_alembic_cfg() -> Config:
     alembic_cfg = Config()
@@ -28,7 +18,6 @@ def get_alembic_cfg() -> Config:
 
 
 def migrate() -> None:
-    remove_avatar_cache_v1()
     try:
         command.upgrade(get_alembic_cfg(), "head")
     except Exception as e:

{slidge-0.3.0b3 → slidge-0.3.0b4}/slidge/util/util.py

@@ -324,3 +324,10 @@ def strip_leading_emoji(text: str) -> str:
 
 async def noop_coro() -> None:
     pass
+
+
+def add_quote_prefix(text: str):
+    """
+    Return multi-line text with leading quote marks (i.e. the ">" character).
+    """
+    return "\n".join(("> " + x).strip() for x in text.split("\n")).strip()

{slidge-0.3.0b3 → slidge-0.3.0b4}/slidge.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: slidge
-Version: 0.3.0b3
+Version: 0.3.0b4
 Summary: XMPP bridging framework
 Author-email: Nicolas Cedilnik <nicoco@nicoco.fr>
 License-Expression: AGPL-3.0-or-later

{slidge-0.3.0b3 → slidge-0.3.0b4}/slidge.egg-info/SOURCES.txt

@@ -164,6 +164,7 @@ tests/test_avatar.py
 tests/test_backfill.py
 tests/test_chat_commands.py
 tests/test_config.py
+tests/test_empty_subject.py
 tests/test_feature_restriction.py
 tests/test_mam_archivable.py
 tests/test_mds.py
@@ -174,6 +175,7 @@ tests/test_session_2.py
 tests/test_set_name_before_fill.py
 tests/test_shakespeare.py
 tests/test_stanza_link_preview.py
+tests/test_type_conversion.py
 tests/test_util.py
 tests/test_vcard.py
 tests/test_adhoc/test_access.py

{slidge-0.3.0b3 → slidge-0.3.0b4}/tests/test_avatar.py

@@ -255,7 +255,8 @@ class BaseMUC(BaseNoMUC):
             </presence>
             """
         )
-        assert self.next_sent()["subject"] != ""
+        subject_msg = self.next_sent()
+        assert subject_msg.xml.find(f"{{{subject_msg.namespace}}}subject") is not None
         # assert self.next_sent()["from"] == "room@aim.shakespeare.lit"
 
     def get_muc(self, joined=True) -> MUC:

slidge-0.3.0b4/tests/test_empty_subject.py

@@ -0,0 +1,139 @@
+import unittest
+
+import pytest
+from slixmpp.exceptions import XMPPError
+
+from conftest import AvatarFixtureMixin
+from slixmpp import JID, Iq
+
+from slidge import BaseGateway, BaseSession, GatewayUser, LegacyRoster, LegacyBookmarks, LegacyMUC, LegacyContact
+from slidge.core.session import _sessions
+from slidge.util.test import SlidgeTest
+from slidge.util.types import LegacyUserIdType, LegacyMUCType, MucType
+
+
+class Gateway(BaseGateway):
+    COMPONENT_NAME = "A test"
+    GROUPS = True
+
+
+class Contact(LegacyContact):
+    async def update_info(self):
+        if self.legacy_id.startswith("group"):
+            raise XMPPError()
+
+
+class Session(BaseSession):
+    async def login(self):
+        return "YUP"
+
+
+class Bookmarks(LegacyBookmarks):
+    async def fill(self) -> None:
+        pass
+
+
+class MUC(LegacyMUC):
+    async def update_info(self):
+        if not self.legacy_id.startswith("group"):
+            raise XMPPError()
+        self.type = MucType.GROUP
+
+@pytest.mark.usefixtures("avatar")
+class TestEmptySubject(AvatarFixtureMixin, SlidgeTest):
+    plugin = globals()
+    xmpp: Gateway
+
+    def setUp(self):
+        super().setUp()
+        with self.xmpp.store.session() as orm:
+            user = GatewayUser(
+                jid=JID("romeo@montague.lit/gajim").bare,
+                legacy_module_data={"username": "romeo", "city": ""},
+                preferences={"sync_avatar": True, "sync_presence": True},
+            )
+            orm.add(user)
+            orm.commit()
+        self.run_coro(
+            self.xmpp._BaseGateway__dispatcher._on_user_register(
+                Iq(sfrom="romeo@montague.lit/gajim")
+            )
+        )
+        welcome = self.next_sent()
+        assert welcome["body"]
+        stanza = self.next_sent()
+        assert "logging in" in stanza["status"].lower(), stanza
+        stanza = self.next_sent()
+        assert "syncing contacts" in stanza["status"].lower(), stanza
+        stanza = self.next_sent()
+        assert "syncing groups" in stanza["status"].lower(), stanza
+        probe = self.next_sent()
+        assert probe.get_type() == "probe"
+        stanza = self.next_sent()
+        assert "yup" in stanza["status"].lower(), stanza
+
+        self.send(  # language=XML
+            """
+            <iq type="get"
+                to="romeo@montague.lit"
+                id="1"
+                from="aim.shakespeare.lit">
+              <pubsub xmlns="http://jabber.org/protocol/pubsub">
+                <items node="urn:xmpp:avatar:metadata" />
+              </pubsub>
+            </iq>
+            """
+        )
+
+    def tearDown(self):
+        super().tearDown()
+        _sessions.clear()
+
+    @property
+    def romeo_session(self) -> Session:
+        return BaseSession.get_self_or_unique_subclass().from_jid(
+            JID("romeo@montague.lit")
+        )
+
+    def test_empty_subject(self):
+        muc = self.run_coro(self.romeo_session.bookmarks.by_legacy_id("group"))
+        with unittest.mock.patch("slidge.core.mixins.message_maker.uuid4", return_value="uuid"), unittest.mock.patch("uuid.uuid4", return_value="uuid"):
+            self.recv(  # language=XML
+                f"""
+            <presence from="romeo@montague.lit/movim"
+                      to="{muc.jid}/nick">
+              <x xmlns='http://jabber.org/protocol/muc' />
+            </presence>
+            """            )
+            self.send(  # language=XML
+                """
+            <presence from="group@aim.shakespeare.lit/romeo"
+                      to="romeo@montague.lit/movim">
+              <x xmlns="http://jabber.org/protocol/muc#user">
+                <item affiliation="member"
+                      role="participant"
+                      jid="romeo@montague.lit/movim" />
+                <status code="210" />
+                <status code="110" />
+                <status code="100" />
+              </x>
+              <occupant-id xmlns="urn:xmpp:occupant-id:0"
+                           id="slidge-user" />
+            </presence>
+            """,
+            use_values=False)
+            self.send(  # language=XML
+                """
+            <message type="groupchat"
+                     from="group@aim.shakespeare.lit"
+                     to="romeo@montague.lit/movim">
+              <stanza-id xmlns="urn:xmpp:sid:0"
+                         id="uuid"
+                         by="group@aim.shakespeare.lit" />
+              <occupant-id xmlns="urn:xmpp:occupant-id:0"
+                           id="room" />
+              <subject />
+            </message>
+            """,
+            use_values=False,
+            )

{slidge-0.3.0b3 → slidge-0.3.0b4}/tests/test_session_2.py

@@ -43,7 +43,7 @@ class Contact(LegacyContact):
 
 class MUC(LegacyMUC):
     async def update_info(self):
-        if self.legacy_id in ("room-noinfo", "room-duplicate-participant", "room-avatar-slow", "room-contact-conflict"):
+        if self.legacy_id in ("room-noinfo", "room-duplicate-participant", "room-avatar-slow", "room-contact-conflict", "room-reaction-fallback"):
             return
         if self.legacy_id == "room-avatar-in-slow-task":
             self.session.create_task(self._slow_set_avatar(), "slow-avatar")
@@ -580,3 +580,89 @@ class TestSession2(AvatarFixtureMixin, SlidgeTest):
             </iq>
             """,
         )
+
+    def test_reaction_fallback(self):
+        self.romeo_session.user.preferences["reaction_fallback"] = True
+        contact = self.run_coro(self.romeo_session.contacts.by_legacy_id("reacter"))
+        contact.react("msg-id", "♥")
+        self.send(  # language=XML
+            """
+            <message xmlns="jabber:component:accept"
+                     type="chat"
+                     from="reacter@aim.shakespeare.lit/slidge"
+                     to="romeo@montague.lit">
+              <store xmlns="urn:xmpp:hints" />
+              <reactions xmlns="urn:xmpp:reactions:0"
+                         id="msg-id">
+                <reaction>♥</reaction>
+              </reactions>
+              <fallback xmlns="urn:xmpp:fallback:0"
+                        for="urn:xmpp:reactions:0">
+                <body />
+              </fallback>
+              <body>♥</body>
+            </message>
+            """,
+            use_values=False
+        )
+
+    def test_reaction_fallback_muc(self):
+        self.romeo_session.user.preferences["reaction_fallback"] = True
+        muc: LegacyMUC = self.run_coro(
+            self.romeo_session.bookmarks.by_legacy_id("room-reaction-fallback")
+        )
+        # yuuuuuuck, if we only call it once, then it does not have an archive PK
+        muc: LegacyMUC = self.run_coro(
+            self.romeo_session.bookmarks.by_legacy_id("room-reaction-fallback")
+        )
+        part = self.run_coro(muc.get_participant_by_legacy_id("participant-x"))
+        muc.add_user_resource("gajim")
+        part.send_text("some text\non lines", legacy_msg_id="msg-id")
+        presence = self.next_sent()
+        assert presence["from"] == "room-reaction-fallback@aim.shakespeare.lit/participant-x"
+        self.send(  # language=XML
+            """
+            <message xmlns="jabber:component:accept"
+                     type="groupchat"
+                     id="msg-id"
+                     from="room-reaction-fallback@aim.shakespeare.lit/participant-x"
+                     to="romeo@montague.lit/gajim">
+              <body>some text\non lines</body>
+              <active xmlns="http://jabber.org/protocol/chatstates" />
+              <markable xmlns="urn:xmpp:chat-markers:0" />
+              <stanza-id xmlns="urn:xmpp:sid:0"
+                         id="msg-id"
+                         by="room-reaction-fallback@aim.shakespeare.lit" />
+              <occupant-id xmlns="urn:xmpp:occupant-id:0"
+                           id="participant-x@aim.shakespeare.lit/slidge" />
+            </message>
+            """,
+            use_values=False,
+        )
+        with unittest.mock.patch("slidge.core.mixins.message_maker.uuid4", return_value="uuid"):
+            part.react("msg-id", "♥")
+            self.send(  # language=XML
+                """
+            <message xmlns="jabber:component:accept"
+                     type="groupchat"
+                     from="room-reaction-fallback@aim.shakespeare.lit/participant-x"
+                     to="romeo@montague.lit/gajim">
+              <store xmlns="urn:xmpp:hints" />
+              <stanza-id xmlns="urn:xmpp:sid:0"
+                         id="uuid"
+                         by="room-reaction-fallback@aim.shakespeare.lit" />
+              <reactions xmlns="urn:xmpp:reactions:0"
+                         id="msg-id">
+                <reaction>♥</reaction>
+              </reactions>
+              <fallback xmlns="urn:xmpp:fallback:0"
+                        for="urn:xmpp:reactions:0">
+                <body />
+              </fallback>
+              <body>&gt; some text\n&gt; on lines\n♥</body>
+              <occupant-id xmlns="urn:xmpp:occupant-id:0"
+                           id="participant-x@aim.shakespeare.lit/slidge" />
+            </message>
+            """,
+                use_values=False,
+            )

slidge-0.3.0b4/tests/test_type_conversion.py

@@ -0,0 +1,119 @@
+import pytest
+
+from conftest import AvatarFixtureMixin
+from slixmpp import JID, Iq
+
+from slidge import BaseGateway, BaseSession, GatewayUser, LegacyRoster, LegacyBookmarks
+from slidge.core.session import _sessions
+from slidge.util.test import SlidgeTest
+from slidge.util.types import LegacyUserIdType
+
+
+class SomeType:
+    def __init__(self, a: int, b: int):
+        self.a = a
+        self.b = b
+
+    @classmethod
+    def from_str(cls, s: str):
+        a, b = (int(x) for x in s.split("-"))
+        return SomeType(a, b)
+
+    def __str__(self):
+        return f"{self.a}-{self.b}"
+
+class Gateway(BaseGateway):
+    COMPONENT_NAME = "A test"
+    LEGACY_CONTACT_ID_TYPE = SomeType.from_str
+    LEGACY_ROOM_ID_TYPE = SomeType.from_str
+    GROUPS = True
+
+
+class Session(BaseSession):
+    async def login(self):
+        return "YUP"
+
+
+class Roster(LegacyRoster):
+    async def legacy_id_to_jid_username(self, legacy_id: LegacyUserIdType) -> str:
+        return f"{legacy_id.a}-{legacy_id.b}"
+
+    async def jid_username_to_legacy_id(self, jid_username: str) -> LegacyUserIdType:
+        return SomeType.from_str(jid_username)
+
+
+class Bookmarks(LegacyBookmarks):
+    async def legacy_id_to_jid_username(self, legacy_id: LegacyUserIdType) -> str:
+        return f"{legacy_id.a}-{legacy_id.b}"
+
+    async def jid_username_to_legacy_id(self, jid_username: str) -> LegacyUserIdType:
+        return SomeType.from_str(jid_username)
+
+    async def fill(self):
+        pass
+
+@pytest.mark.usefixtures("avatar")
+class TestLegacyTypeConversion(AvatarFixtureMixin, SlidgeTest):
+    plugin = globals()
+    xmpp: Gateway
+
+    def setUp(self):
+        super().setUp()
+        with self.xmpp.store.session() as orm:
+            user = GatewayUser(
+                jid=JID("romeo@montague.lit/gajim").bare,
+                legacy_module_data={"username": "romeo", "city": ""},
+                preferences={"sync_avatar": True, "sync_presence": True},
+            )
+            orm.add(user)
+            orm.commit()
+        self.run_coro(
+            self.xmpp._BaseGateway__dispatcher._on_user_register(
+                Iq(sfrom="romeo@montague.lit/gajim")
+            )
+        )
+        welcome = self.next_sent()
+        assert welcome["body"]
+        stanza = self.next_sent()
+        assert "logging in" in stanza["status"].lower(), stanza
+        stanza = self.next_sent()
+        assert "syncing contacts" in stanza["status"].lower(), stanza
+        stanza = self.next_sent()
+        assert "syncing groups" in stanza["status"].lower(), stanza
+        probe = self.next_sent()
+        assert probe.get_type() == "probe"
+        stanza = self.next_sent()
+        assert "yup" in stanza["status"].lower(), stanza
+
+        self.send(  # language=XML
+            """
+            <iq type="get"
+                to="romeo@montague.lit"
+                id="1"
+                from="aim.shakespeare.lit">
+              <pubsub xmlns="http://jabber.org/protocol/pubsub">
+                <items node="urn:xmpp:avatar:metadata" />
+              </pubsub>
+            </iq>
+            """
+        )
+
+    def tearDown(self):
+        super().tearDown()
+        _sessions.clear()
+
+    @property
+    def romeo_session(self) -> Session:
+        return BaseSession.get_self_or_unique_subclass().from_jid(
+            JID("romeo@montague.lit")
+        )
+
+    def test_contact(self):
+        contact = self.run_coro(self.romeo_session.contacts.by_legacy_id(SomeType(1, 2)))
+        assert contact.legacy_id.a == 1
+        assert contact.legacy_id.b == 2
+
+    def test_muc(self):
+        muc = self.run_coro(self.romeo_session.bookmarks.by_legacy_id(SomeType(1, 2)))
+        assert muc.legacy_id.a == 1
+        assert muc.legacy_id.b == 2