slidge 0.3.0b2__tar.gz → 0.3.0b3__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: slidge
-Version: 0.3.0b2
+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.0b2 → 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.0b2 → 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.0b2 → 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.0b2 → 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.0b2 → 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.0b2 → 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.0b2 → 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.0b2 → slidge-0.3.0b3}/slidge/group/room.py

@@ -7,7 +7,16 @@ 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
@@ -325,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
@@ -673,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,
         )
@@ -764,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.
 
@@ -774,6 +797,7 @@ 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
@@ -785,7 +809,10 @@ class LegacyMUC(
                 .filter_by(contact=c.stored, room=self.stored)
                 .one_or_none()
             )
-            if stored is not 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.0b2 → 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.0b2 → slidge-0.3.0b3}/slidge.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: slidge
-Version: 0.3.0b2
+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.0b2 → 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.0b2 → 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.0b2 → slidge-0.3.0b3}/tests/test_session_2.py

@@ -355,8 +355,7 @@ class TestSession2(AvatarFixtureMixin, SlidgeTest):
             </presence>
             """
         )
-        subject = self.next_sent()
-        assert subject["subject"] == "unnamed-room"
+        _subject = self.next_sent()
         self.send(  # language=XML
             """
             <presence to="romeo@montague.lit/movim"
@@ -502,3 +501,82 @@ class TestSession2(AvatarFixtureMixin, SlidgeTest):
             </presence>
             """
         )
+
+    def test_disco_unnamed_room(self):
+        self.recv(  # language=XML
+            f"""
+            <iq type="get"
+                from="romeo@montague.lit/gajim"
+                to="room-noinfo@{self.xmpp.boundjid.bare}"
+                id="123">
+              <query xmlns='http://jabber.org/protocol/disco#info' />
+            </iq>
+            """
+        )
+        self.send(  # language=XML
+            f"""
+            <iq xmlns="jabber:component:accept"
+                type="result"
+                from="room-noinfo@aim.shakespeare.lit"
+                to="romeo@montague.lit/gajim"
+                id="123">
+              <query xmlns="http://jabber.org/protocol/disco#info">
+                <identity category="conference"
+                          type="text" />
+                <feature var="http://jabber.org/protocol/muc" />
+                <feature var="http://jabber.org/protocol/muc#stable_id" />
+                <feature var="http://jabber.org/protocol/muc#self-ping-optimization" />
+                <feature var="urn:xmpp:mam:2" />
+                <feature var="urn:xmpp:mam:2#extended" />
+                <feature var="urn:xmpp:sid:0" />
+                <feature var="muc_persistent" />
+                <feature var="vcard-temp" />
+                <feature var="urn:xmpp:ping" />
+                <feature var="urn:xmpp:occupant-id:0" />
+                <feature var="jabber:iq:register" />
+                <feature var="urn:xmpp:message-moderate:1" />
+                <feature var="muc_open" />
+                <feature var="muc_semianonymous" />
+                <feature var="muc_public" />
+                <x xmlns="jabber:x:data"
+                   type="result">
+                  <field var="FORM_TYPE"
+                         type="hidden">
+                    <value>http://jabber.org/protocol/muc#roominfo</value>
+                  </field>
+                  <field var="muc#roomconfig_persistentroom"
+                         type="boolean">
+                    <value>1</value>
+                  </field>
+                  <field var="muc#roomconfig_changesubject"
+                         type="boolean">
+                    <value>0</value>
+                  </field>
+                  <field var="muc#maxhistoryfetch">
+                    <value>100</value>
+                  </field>
+                  <field var="muc#roominfo_subjectmod"
+                         type="boolean">
+                    <value>0</value>
+                  </field>
+                  <field var="muc#roomconfig_membersonly"
+                         type="boolean">
+                    <value>0</value>
+                  </field>
+                  <field var="muc#roomconfig_whois"
+                         type="list-single">
+                    <value>moderators</value>
+                  </field>
+                  <field var="muc#roomconfig_publicroom"
+                         type="boolean">
+                    <value>1</value>
+                  </field>
+                  <field var="muc#roomconfig_allowpm"
+                         type="boolean">
+                    <value>0</value>
+                  </field>
+                </x>
+              </query>
+            </iq>
+            """,
+        )

{slidge-0.3.0b2 → slidge-0.3.0b3}/tests/test_shakespeare.py

@@ -1841,8 +1841,7 @@ class TestCarbon(ClearSessionMixin, SlidgeTest):
                         </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="URL" />