slidge 0.3.0b1__tar.gz → 0.3.0b3__tar.gz

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

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

{slidge-0.3.0b1 → slidge-0.3.0b3}/docs/source/admin/examples/ejabberd.yaml

@@ -47,5 +47,10 @@ modules:
       both: slidge_rule
     message:
       outgoing: slidge_rule
+    iq:
+      "http://jabber.org/protocol/pubsub":
+        both: slidge_rule
+      "http://jabber.org/protocol/pubsub#owner":
+        set: slidge_rule
   mod_roster:
     versioning: true

{slidge-0.3.0b1 → slidge-0.3.0b3}/docs/source/admin/privilege.rst

@@ -60,12 +60,6 @@ for all changes to be taken into account
 Privileges with ejabberd
 ------------------------
 
-.. warning::
-
-  If you want to set up privileges, you need ejabberd with version 23.10 or newer because of these two issues:
-  https://github.com/processone/ejabberd/issues/3990 and
-  https://github.com/processone/ejabberd/issues/3942
-
 .. code-block:: yaml
 
     acl:
@@ -87,3 +81,9 @@ Privileges with ejabberd
           outgoing: slidge_rule
       mod_roster:
         versioning: true
+
+    iq:
+      "http://jabber.org/protocol/pubsub":
+        both: slidge_rule
+      "http://jabber.org/protocol/pubsub#owner":
+        set: slidge_rule

{slidge-0.3.0b1 → slidge-0.3.0b3}/pyproject.toml

@@ -99,7 +99,6 @@ exclude_lines = [
 ]
 
 [tool.pytest.ini_options]
-log_level = "DEBUG"
 asyncio_mode = "strict"
 filterwarnings = [
     "ignore:The object should be created within an async function:DeprecationWarning:aiohttp",

{slidge-0.3.0b1 → slidge-0.3.0b3}/slidge/contact/roster.py

@@ -95,6 +95,8 @@ class LegacyRoster(
         contact_jid = JID(contact_jid.bare)
         async with self.lock(("username", username)):
             legacy_id = await self.jid_username_to_legacy_id(username)
+            if legacy_id == self.user_legacy_id:
+                raise ContactIsUser
             if self.get_lock(("legacy_id", legacy_id)):
                 self.log.debug("Already updating %s via by_legacy_id()", contact_jid)
                 return await self.by_legacy_id(legacy_id)

{slidge-0.3.0b1 → slidge-0.3.0b3}/slidge/core/dispatcher/message/message.py

@@ -415,7 +415,9 @@ class MessageContentMixin(DispatcherMixin):
         with self.xmpp.store.session() as orm:
             sticker = self.xmpp.store.bob.get_sticker(orm, cid)
         if sticker is None:
-            await self.xmpp.plugin["xep_0231"].get_bob(from_, cid)
+            await self.xmpp.plugin["xep_0231"].get_bob(
+                from_, cid, ifrom=self.xmpp.boundjid
+            )
             with self.xmpp.store.session() as orm:
                 sticker = self.xmpp.store.bob.get_sticker(orm, cid)
         assert sticker is not None

{slidge-0.3.0b1 → slidge-0.3.0b3}/slidge/core/dispatcher/presence.py

@@ -3,6 +3,7 @@ import logging
 from slixmpp import JID, Presence
 from slixmpp.exceptions import XMPPError
 
+from ...contact.roster import ContactIsUser
 from ...util.util import merge_resources
 from ..session import BaseSession
 from .util import DispatcherMixin, exceptions_to_xmpp_errors
@@ -142,6 +143,10 @@ class PresenceHandlerMixin(DispatcherMixin):
                 contact = await session.contacts.by_jid(pto)
             except XMPPError:
                 contact = None
+            except ContactIsUser:
+                raise XMPPError(
+                    "bad-request", "Actions with yourself are not supported."
+                )
             if contact is not None:
                 await self.xmpp.pubsub.on_presence_available(p, contact)
                 return

{slidge-0.3.0b1 → slidge-0.3.0b3}/slidge/core/mixins/attachment.py

@@ -303,6 +303,10 @@ class AttachmentMixin(TextMessageMixin):
         )
         if attachment.name:
             sfs["file"]["name"] = attachment.name
+        if attachment.disposition:
+            sfs["disposition"] = attachment.disposition
+        else:
+            del sfs["disposition"]
         if thumbnail is not None:
             sfs["file"].append(thumbnail)
         stored.sfs = str(sfs)

{slidge-0.3.0b1 → slidge-0.3.0b3}/slidge/core/mixins/avatar.py

@@ -4,7 +4,6 @@ from typing import TYPE_CHECKING, Optional
 
 from PIL import UnidentifiedImageError
 from slixmpp import JID
-from sqlalchemy.exc import IntegrityError
 from sqlalchemy.orm.exc import DetachedInstanceError
 
 from ...db.avatar import CachedAvatar, avatar_cache
@@ -124,25 +123,14 @@ class AvatarMixin(UpdateInfoMixin):
                 avatar.path.unlink()
 
         stored_avatar = None if cached_avatar is None else cached_avatar.stored
-        self.stored.avatar = stored_avatar
-
-        try:
-            self.commit(merge=True)
-        except IntegrityError as e:
-            with self.xmpp.store.session(expire_on_commit=False) as orm:
-                if orm.object_session(self.stored):
-                    self.log.debug(
-                        "Hit integrity error, attempting to fix by refreshing participants"
-                    )
-                    orm.refresh(self.stored, ["participants"])
-                else:
-                    self.log.debug(
-                        "Hit integrity error, attempting to fix by merging contact.stored"
-                    )
+        if not self._updating_info:
+            with self.xmpp.store.session() as orm:
+                with orm.no_autoflush:
                     self.stored = orm.merge(self.stored)
-                    self.stored.avatar = stored_avatar
-                orm.add(self.stored)
-                orm.commit()
+                    orm.refresh(self.stored)
+
+        self.stored.avatar = stored_avatar
+        self.commit(merge=True)
 
         self._post_avatar_update(cached_avatar)
 

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

@@ -19,7 +19,7 @@ class Base:
     xmpp: "BaseGateway" = NotImplemented
 
     jid: JID = NotImplemented
-    name: str = NotImplemented
+    name: str | None = NotImplemented
 
     @property
     def user_jid(self):

{slidge-0.3.0b1 → slidge-0.3.0b3}/slidge/core/mixins/disco.py

@@ -13,7 +13,7 @@ class BaseDiscoMixin(Base):
     DISCO_NAME: str = NotImplemented
     DISCO_LANG = None
 
-    def _get_disco_name(self):
+    def _get_disco_name(self) -> str | None:
         if self.DISCO_NAME is NotImplemented:
             return self.xmpp.COMPONENT_NAME
         return self.DISCO_NAME or self.xmpp.COMPONENT_NAME

{slidge-0.3.0b1 → slidge-0.3.0b3}/slidge/core/session.py

@@ -133,8 +133,8 @@ class BaseSession(
         self.log.debug("Removing fut %s", fut)
         self.__tasks.remove(fut)
 
-    def create_task(self, coro) -> asyncio.Task:
-        task = self.xmpp.loop.create_task(coro)
+    def create_task(self, coro, name: str | None = None) -> asyncio.Task:
+        task = self.xmpp.loop.create_task(coro, name=name)
         self.__tasks.add(task)
         self.log.debug("Creating task %s", task)
         task.add_done_callback(lambda _: self.__remove_task(task))

{slidge-0.3.0b1 → slidge-0.3.0b3}/slidge/db/store.py

@@ -478,7 +478,7 @@ class ParticipantStore:
 
     @staticmethod
     def get_all(
-        session, room_pk: int, user_included: bool = True
+        session: Session, room_pk: int, user_included: bool = True
     ) -> Iterator[Participant]:
         query = select(Participant).where(Participant.room_id == room_pk)
         if not user_included:

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

@@ -1,6 +1,6 @@
 import abc
 import logging
-from typing import TYPE_CHECKING, Generic, Iterator, Optional, Type
+from typing import TYPE_CHECKING, Generic, Iterator, Literal, Optional, Type, overload
 
 from slixmpp import JID
 from slixmpp.exceptions import XMPPError
@@ -119,13 +119,31 @@ class LegacyBookmarks(
                 return self.from_store(stored)
         return None
 
-    async def by_legacy_id(self, legacy_id: LegacyGroupIdType) -> LegacyMUCType:
+    @overload
+    async def by_legacy_id(self, legacy_id: LegacyGroupIdType) -> "LegacyMUCType": ...
+
+    @overload
+    async def by_legacy_id(
+        self, legacy_id: LegacyGroupIdType, create: Literal[False]
+    ) -> "LegacyMUCType | None": ...
+
+    @overload
+    async def by_legacy_id(
+        self, legacy_id: LegacyGroupIdType, create: Literal[True]
+    ) -> "LegacyMUCType": ...
+
+    async def by_legacy_id(
+        self, legacy_id: LegacyGroupIdType, create: bool = False
+    ) -> LegacyMUCType | None:
         async with self.lock(("legacy_id", legacy_id)):
             local = await self.legacy_id_to_jid_local_part(legacy_id)
             jid = JID(f"{local}@{self.xmpp.boundjid}")
             if self.get_lock(("bare", jid.bare)):
                 self.session.log.debug("Already updating %s via by_jid()", jid)
-                return await self.by_jid(jid)
+                if create:
+                    return await self.by_jid(jid)
+                else:
+                    return self.by_jid_only_if_exists(jid)
 
             with self.xmpp.store.session() as orm:
                 stored = (

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

@@ -3,9 +3,20 @@ import logging
 import re
 import string
 import warnings
+from asyncio import Lock
+from contextlib import asynccontextmanager
 from copy import copy
 from datetime import datetime, timedelta, timezone
-from typing import TYPE_CHECKING, AsyncIterator, Generic, Optional, Type, Union
+from typing import (
+    TYPE_CHECKING,
+    AsyncIterator,
+    Generic,
+    Literal,
+    Optional,
+    Type,
+    Union,
+    overload,
+)
 from uuid import uuid4
 
 import sqlalchemy as sa
@@ -18,7 +29,6 @@ from slixmpp.plugins.xep_0469.stanza import NS as PINNING_NS
 from slixmpp.plugins.xep_0492.stanza import NS as NOTIFY_NS
 from slixmpp.plugins.xep_0492.stanza import WhenLiteral
 from slixmpp.xmlstream import ET
-from sqlalchemy.exc import InvalidRequestError
 from sqlalchemy.orm import Session as OrmSession
 
 from ..contact.contact import LegacyContact
@@ -28,7 +38,6 @@ from ..core.mixins.disco import ChatterDiscoMixin
 from ..core.mixins.recipient import ReactionRecipientMixin, ThreadRecipientMixin
 from ..db.models import Participant, Room
 from ..util.jid_escaping import unescape_node
-from ..util.lock import NamedLockMixin
 from ..util.types import (
     HoleBound,
     LegacyGroupIdType,
@@ -56,7 +65,6 @@ class LegacyMUC(
         LegacyGroupIdType, LegacyMessageType, LegacyParticipantType, LegacyUserIdType
     ],
     AvatarMixin,
-    NamedLockMixin,
     ChatterDiscoMixin,
     ReactionRecipientMixin,
     ThreadRecipientMixin,
@@ -242,10 +250,22 @@ class LegacyMUC(
         )
         self.commit()
 
+    @asynccontextmanager
+    async def lock(self, id_: str) -> AsyncIterator[None]:
+        async with self.session.lock((self.legacy_id, id_)):
+            yield
+
+    def get_lock(self, id_: str) -> Lock | None:
+        return self.session.get_lock((self.legacy_id, id_))
+
     async def __fill_participants(self) -> None:
-        if self.participants_filled:
-            return
         async with self.lock("fill participants"):
+            with self.xmpp.store.session(expire_on_commit=False) as orm:
+                orm.add(self.stored)
+                with orm.no_autoflush:
+                    orm.refresh(self.stored, ["participants_filled"])
+            if self.participants_filled:
+                return
             parts: list[Participant] = []
             resources = set[str]()
             # During fill_participants(), self.get_participant*() methods may
@@ -261,17 +281,13 @@ class LegacyMUC(
                 resources.add(participant.stored.resource)
         with self.xmpp.store.session(expire_on_commit=False) as orm:
             orm.add(self.stored)
-            # because self.participants() is async, self.stored  may be out of sync at
-            # this point.
+            # because self.fill_participants() is async, self.stored may be stale at
+            # this point, and the only thing we want to update is the participant list
+            # and the participant_filled attribute.
             with orm.no_autoflush:
                 orm.refresh(self.stored)
-            for part in parts:
-                try:
-                    self.stored.participants.append(part)
-                except InvalidRequestError:
-                    # the participant was already stored in the DB. `part` may even
-                    # be out-of-sync, so it's fine to just ditch it.
-                    pass
+                for part in parts:
+                    orm.merge(part)
             self.stored.participants_filled = True
             orm.commit()
 
@@ -290,10 +306,14 @@ class LegacyMUC(
                 yield self.participant_from_store(db_participant)
 
     async def __fill_history(self) -> None:
-        if self.stored.history_filled:
-            self.log.debug("History has already been fetched.")
-            return
         async with self.lock("fill history"):
+            with self.xmpp.store.session(expire_on_commit=False) as orm:
+                orm.add(self.stored)
+                with orm.no_autoflush:
+                    orm.refresh(self.stored, ["history_filled"])
+            if self.stored.history_filled:
+                self.log.debug("History has already been fetched.")
+                return
             log.debug("Fetching history for %s", self)
             try:
                 before, after = self.archive.get_hole_bounds()
@@ -314,16 +334,15 @@ class LegacyMUC(
             self.stored.history_filled = True
             self.commit(merge=True)
 
-    @property
-    def DISCO_NAME(self) -> str:  # type:ignore
-        return self.name or "unnamed-room"
+    def _get_disco_name(self) -> str | None:
+        return self.name
 
     @property
-    def name(self) -> str:
-        return self.stored.name or "unnamed-room"
+    def name(self) -> str | None:
+        return self.stored.name
 
     @name.setter
-    def name(self, n: str) -> None:
+    def name(self, n: str | None) -> None:
         if self.name == n:
             return
         self.stored.name = n
@@ -662,7 +681,7 @@ class LegacyMUC(
                 since=since,
             )
         self.__get_subject_setter_participant().set_room_subject(
-            self.subject if self.HAS_SUBJECT else (self.description or self.name),
+            self.subject if self.HAS_SUBJECT else (self.description or self.name or ""),
             user_full_jid,
             self.subject_date,
         )
@@ -753,9 +772,24 @@ class LegacyMUC(
         """
         return self._participant_cls(self, Participant(), is_system=True)
 
+    @overload
     async def get_participant_by_contact(
         self, c: "LegacyContact"
-    ) -> "LegacyParticipantType":
+    ) -> "LegacyParticipantType": ...
+
+    @overload
+    async def get_participant_by_contact(
+        self, c: "LegacyContact", create: Literal[False]
+    ) -> "LegacyParticipantType | None": ...
+
+    @overload
+    async def get_participant_by_contact(
+        self, c: "LegacyContact", create: Literal[True]
+    ) -> "LegacyParticipantType": ...
+
+    async def get_participant_by_contact(
+        self, c: "LegacyContact", create: bool = True
+    ) -> "LegacyParticipantType | None":
         """
         Get a non-anonymous participant.
 
@@ -763,20 +797,23 @@ class LegacyMUC(
         that the Contact jid is associated to this participant
 
         :param c: The :class:`.LegacyContact` instance corresponding to this contact
+        :param create: Creates the participant if it does not exist.
         :return:
         """
         await self.session.contacts.ready
 
-        if not self.get_lock("fill participants"):
-            with self.xmpp.store.session() as orm:
-                self.stored = orm.merge(self.stored)
-                stored = (
-                    orm.query(Participant)
-                    .filter_by(contact=c.stored, room=self.stored)
-                    .one_or_none()
-                )
-                if stored is not None:
-                    return self.participant_from_store(stored=stored, contact=c)
+        with self.xmpp.store.session() as orm:
+            self.stored = orm.merge(self.stored)
+            stored = (
+                orm.query(Participant)
+                .filter_by(contact=c.stored, room=self.stored)
+                .one_or_none()
+            )
+            if stored is None:
+                if not create:
+                    return None
+            else:
+                return self.participant_from_store(stored=stored, contact=c)
 
         nickname = c.name or unescape_node(c.jid.node)
 

{slidge-0.3.0b1 → slidge-0.3.0b3}/slidge/main.py

@@ -166,10 +166,12 @@ def main(module_name: str | None = None) -> None:
             f"_{config.LEGACY_MODULE.split('.')[-1].upper()}_"
         )
         logging.debug("Env var prefix: %s", ConfigModule.ENV_VAR_PREFIX)
-        ConfigModule(plugin_config_obj).set_conf(unknown_argv)
-    else:
-        if unknown_argv:
-            raise RuntimeError("Some arguments have not been recognized", unknown_argv)
+        _, unknown_argv = ConfigModule(plugin_config_obj).set_conf(unknown_argv)
+
+    if unknown_argv:
+        logging.error(
+            f"These config options have not been recognized and ignored: {unknown_argv}"
+        )
 
     migrate()
 

{slidge-0.3.0b1 → slidge-0.3.0b3}/slidge/util/conf.py

@@ -159,7 +159,10 @@ class ConfigModule:
                     upper = _argv_to_option_name(a)
                     opt = options_long.get(upper)
                     if opt and opt.type is bool:
-                        if _argv_to_option_name(aa) not in options_long:
+                        if (
+                            not aa.startswith("-")
+                            and _argv_to_option_name(aa) not in options_long
+                        ):
                             log.debug("Removing %s from argv", aa)
                             skip_next = True
 

{slidge-0.3.0b1 → slidge-0.3.0b3}/slidge/util/types.py

@@ -72,6 +72,7 @@ MucRole = Literal["visitor", "participant", "moderator", "none"]
 ClientType = Literal[
     "bot", "console", "game", "handheld", "pc", "phone", "sms", "tablet", "web"
 ]
+AttachmentDisposition = Literal["attachment", "inline"]
 
 
 @dataclass
@@ -115,6 +116,7 @@ class LegacyAttachment:
     legacy_file_id: Optional[Union[str, int]] = None
     url: Optional[str] = None
     caption: Optional[str] = None
+    disposition: Optional[AttachmentDisposition] = None
     """
     A caption for this specific image. For a global caption for a list of attachments,
     use the ``body`` parameter of :meth:`.AttachmentMixin.send_files`

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

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

{slidge-0.3.0b1 → slidge-0.3.0b3}/tests/test_attachment.py

@@ -74,15 +74,18 @@ class Base(Shakespeare, AvatarFixtureMixin):
                 use_values=False,
             )
 
-    def _assert_file(self, url="http://url"):
+    def _assert_file(self, url="http://url", disposition: str = ''):
         when = (
             datetime.fromtimestamp(self.avatar_path.stat().st_mtime)
             .isoformat()
             .replace("+00:00", "Z")
         )
+        if disposition:
+            el = f"disposition='{disposition}'"
+        else:
+            el = ""
         self.send(  # language=XML
-            f"""
-            <message type="chat"
+            f"""<message type="chat"
                      from="juliet@aim.shakespeare.lit/slidge"
                      to="romeo@montague.lit">
               <reference xmlns="urn:xmpp:reference:0"
@@ -108,8 +111,7 @@ class Base(Shakespeare, AvatarFixtureMixin):
                   </file>
                 </media-sharing>
               </reference>
-              <file-sharing xmlns="urn:xmpp:sfs:0"
-                            disposition="inline">
+              <file-sharing xmlns="urn:xmpp:sfs:0" {el}>
                 <sources>
                   <url-data xmlns="http://jabber.org/protocol/url-data"
                             target="{url}" />
@@ -153,13 +155,13 @@ class TestBodyOnly(Base):
 
 
 class TestAttachmentUpload(Base):
-    def __test_basic(self, attachment: LegacyAttachment, upload_kwargs: dict):
+    def __test_basic(self, attachment: LegacyAttachment, upload_kwargs: dict, disposition: str = ''):
         """
         Basic test that file is uploaded.
         """
         self.run_coro(self.juliet.send_files([attachment]))
         self.http_upload.assert_called_with(**upload_kwargs)
-        self._assert_file()
+        self._assert_file(disposition=disposition)
 
     def _test_reuse(self, attachment: LegacyAttachment, upload_kwargs: dict):
         """
@@ -185,6 +187,18 @@ class TestAttachmentUpload(Base):
             ),
         )
 
+    def test_path_attachment(self):
+        self.__test_basic(
+            LegacyAttachment(path=self.avatar_path, disposition="attachment"),
+            dict(
+                filename=self.avatar_path,
+                content_type="image/png",
+                ifrom=self.xmpp.boundjid,
+                domain=None,
+            ),
+            "attachment",
+        )
+
     def test_thumbhash(self):
         self.__test_basic(
             LegacyAttachment(path=self.avatar_path, content_type="image/png"),
@@ -441,8 +455,7 @@ class TestAttachmentNoUpload(Base):
                   </file>
                 </media-sharing>
               </reference>
-              <file-sharing xmlns="urn:xmpp:sfs:0"
-                            disposition="inline">
+              <file-sharing xmlns="urn:xmpp:sfs:0">
                 <sources>
                   <url-data xmlns="http://jabber.org/protocol/url-data"
                             target="https://url/uuid/uuid/5x5.png" />

{slidge-0.3.0b1 → slidge-0.3.0b3}/tests/test_config.py

@@ -272,3 +272,15 @@ def test_rest(tmp_path):
 
     assert Config1.PROUT == "caca"
     assert Config2.PROUT2 == "something"
+
+
+def test_unrecognized_after_boolean():
+    class Config:
+        PROUT = True
+        PROUT__DOC = "?"
+
+
+    configurator = ConfigModule(Config)
+    ns, rest = configurator.set_conf(["--prout", "--joujoujou"])
+    assert Config.PROUT
+    assert rest == ["--joujoujou"]

{slidge-0.3.0b1 → slidge-0.3.0b3}/tests/test_muc.py

@@ -4189,9 +4189,7 @@ class TestMUCAdmin(Base):
                   </field>
                   <field label='Natural-Language Room Name'
                          type='text-single'
-                         var='muc#roomconfig_roomname'>
-                    <value>unnamed-room</value>
-                  </field>
+                         var='muc#roomconfig_roomname'></field>
                   <field label='Short Description of Room'
                          type='text-single'
                          var='muc#roomconfig_roomdesc'>

{slidge-0.3.0b1 → slidge-0.3.0b3}/tests/test_session.py

@@ -328,10 +328,11 @@ class TestSession(AvatarFixtureMixin, SlidgeTest):
             """
         self.recv(sticker_stanza)
         self.send(  # language=XML
-            """
+            f"""
             <iq id="2"
                 type="get"
-                to="romeo@montague.lit/movim">
+                to="romeo@montague.lit/movim"
+                from="{self.xmpp.boundjid.bare}">
               <data xmlns="urn:xmpp:bob"
                     cid="sha1+4b97ce7f0f06a0e05999f3c719cd5b4f3da992a7@bob.xmpp.org" />
             </iq>