slidge 0.2.3.post1__py3-none-any.whl → 0.2.4__py3-none-any.whl

slidge/__version__.py

@@ -2,4 +2,4 @@ from slidge.util.util import get_version  # noqa: F401
 
 # this is modified before publish, but if someone cloned from the repo,
 # it can help
-__version__ = "v0.2.3.post1"
+__version__ = "v0.2.4"

slidge/core/dispatcher/message/message.py

@@ -296,7 +296,10 @@ class MessageContentMixin(DispatcherMixin):
                 # no need to carbon for groups, we just don't echo the stanza
                 entity.react(legacy_id, carbon=True)  # type: ignore
             await session.on_react(entity, legacy_id, [], thread=thread)
-            raise XMPPError("not-acceptable", text=error_msg)
+            raise XMPPError(
+                "policy-violation",  # type:ignore
+                text=error_msg,
+            )
 
         await session.on_react(entity, legacy_id, emojis, thread=thread)
         if isinstance(entity, LegacyMUC):

slidge/core/gateway.py

@@ -913,7 +913,9 @@ SLIXMPP_PLUGINS = [
     "xep_0444",  # Message reactions
     "xep_0447",  # Stateless File Sharing
     "xep_0461",  # Message replies
+    "xep_0469",  # Bookmark Pinning
     "xep_0490",  # Message Displayed Synchronization
+    "xep_0492",  # Chat Notification Settings
 ]
 
 LOG_STRIP_ELEMENTS = ["data", "binval"]

slidge/core/mixins/recipient.py

@@ -21,9 +21,9 @@ class ReactionRecipientMixin:
         form["type"] = "result"
         form.add_field("FORM_TYPE", "hidden", value="urn:xmpp:reactions:0:restrictions")
         if self.REACTIONS_SINGLE_EMOJI:
-            form.add_field("max_reactions_per_user", value="1")
+            form.add_field("max_reactions_per_user", value="1", type="number")
         if available:
-            form.add_field("allowlist", value=list(available))
+            form.add_field("allowlist", value=list(available), type="text-multi")
         return form
 
     async def available_emojis(

slidge/group/room.py

@@ -26,6 +26,7 @@ from ..core.mixins.disco import ChatterDiscoMixin
 from ..core.mixins.lock import NamedLockMixin
 from ..core.mixins.recipient import ReactionRecipientMixin, ThreadRecipientMixin
 from ..db.models import Room
+from ..slixfix.xep_0492.stanza import WhenLiteral
 from ..util import ABCSubclassableOnceAtMost
 from ..util.types import (
     HoleBound,
@@ -994,7 +995,14 @@ class LegacyMUC(
         p["muc"]["status_codes"] = {110, 333}
         p.send()
 
-    async def add_to_bookmarks(self, auto_join=True, invite=False, preserve=True):
+    async def add_to_bookmarks(
+        self,
+        auto_join=True,
+        invite=False,
+        preserve=True,
+        pin: bool | None = None,
+        notify: WhenLiteral | None = None,
+    ):
         """
         Add the MUC to the user's XMPP bookmarks (:xep:`0402')
 
@@ -1012,6 +1020,11 @@ class LegacyMUC(
             settings.
         :param preserve: preserve auto-join and bookmarks extensions
             set by the user outside slidge
+        :param pin: Pin the group chat bookmark :xep:`0469`. Requires privileged entity.
+            If set to ``None`` (default), the bookmark pinning status will be untouched.
+        :param notify: Chat notification setting: :xep:`0492`. Requires privileged entity.
+            If set to ``None`` (default), the setting will be untouched. Only the "global"
+            notification setting is supported (ie, per client type is not possible).
         """
         item = Item()
         item["id"] = self.jid
@@ -1046,6 +1059,13 @@ class LegacyMUC(
             item["conference"]["autojoin"] = auto_join
 
         item["conference"]["nick"] = self.user_nick
+
+        if pin is not None:
+            item["conference"]["extensions"]["pinned"] = pin
+
+        if notify is not None:
+            item["conference"]["extensions"]["notify"].configure(notify)
+
         iq = Iq(stype="set", sfrom=self.user_jid, sto=self.user_jid)
         iq["pubsub"]["publish"]["node"] = self.xmpp["xep_0402"].stanza.NS
         iq["pubsub"]["publish"].append(item)

slidge/slixfix/__init__.py

@@ -5,17 +5,30 @@
 
 import slixmpp.plugins
 from slixmpp import Iq, Message
-from slixmpp.exceptions import XMPPError
+from slixmpp.exceptions import _DEFAULT_ERROR_TYPES, XMPPError
+from slixmpp.plugins.xep_0004.stanza.field import FormField
 from slixmpp.plugins.xep_0050 import XEP_0050, Command
 from slixmpp.plugins.xep_0231 import XEP_0231
 from slixmpp.plugins.xep_0425.stanza import Moderate
+from slixmpp.plugins.xep_0469.stanza import NS as PINNED_NS
+from slixmpp.plugins.xep_0469.stanza import Pinned
 from slixmpp.xmlstream import StanzaBase
 
-from . import link_preview, xep_0077, xep_0100, xep_0153, xep_0292, xep_0356_old
+from . import (
+    link_preview,
+    xep_0077,
+    xep_0100,
+    xep_0153,
+    xep_0292,
+    xep_0356_old,
+    xep_0492,
+)
 
 # TODO: remove this when the fix is included in slixmpp
 Moderate.interfaces.add("id")
 
+_DEFAULT_ERROR_TYPES["policy-violation"] = "modify"  # type:ignore
+
 
 async def _handle_bob_iq(self, iq: Iq):
     cid = iq["bob"]["cid"]
@@ -42,6 +55,17 @@ async def _handle_bob_iq(self, iq: Iq):
         iq.send()
 
 
+def set_pinned(self, val: bool):
+    extensions = self.parent()
+    if val:
+        extensions.enable("pinned")
+    else:
+        extensions._del_sub(f"{{{PINNED_NS}}}pinned")
+
+
+Pinned.set_pinned = set_pinned
+
+
 XEP_0231._handle_bob_iq = _handle_bob_iq
 
 
@@ -75,13 +99,56 @@ def reply(self, body=None, clear=True):
     return new_message
 
 
+Message.reply = reply  # type: ignore
+
+
+FormField.set_value_base = FormField.set_value  # type:ignore
+
+
+def set_value(self: FormField, value):
+    if not self._type:
+        if isinstance(value, bool):
+            self._type = "boolean"
+        elif isinstance(value, str):
+            self._type = "text-single"
+        elif isinstance(value, (list, tuple)):
+            self._type = "text-multi"
+
+    FormField.set_value_base(self, value)
+
+
+def get_value(self, convert=True, convert_list=False):
+    valsXML = self.xml.findall("{%s}value" % self.namespace)
+    if len(valsXML) == 0:
+        return None
+    elif self._type == "boolean":
+        if convert:
+            return valsXML[0].text in self.true_values
+        return valsXML[0].text
+    elif self._type in self.multi_value_types or len(valsXML) > 1:
+        values = []
+        for valXML in valsXML:
+            if valXML.text is None:
+                valXML.text = ""
+            values.append(valXML.text)
+        if self._type == "text-multi" and convert_list:
+            values = "\n".join(values)
+        return values
+    else:
+        if valsXML[0].text is None:
+            return ""
+        return valsXML[0].text
+
+
+FormField.set_value = set_value  # type:ignore
+FormField.get_value = get_value  # type:ignore
+
+
 slixmpp.plugins.PLUGINS.extend(
     [
         "link_preview",
         "xep_0292_provider",
         "xep_0356_old",
+        "xep_0492",
     ]
 )
-
-
-Message.reply = reply  # type: ignore

slidge/slixfix/xep_0492/__init__.py

@@ -0,0 +1,8 @@
+from slixmpp.plugins.base import register_plugin
+
+from . import stanza
+from .notify import XEP_0492
+
+register_plugin(XEP_0492)
+
+__all__ = ["stanza", "XEP_0492"]

slidge/slixfix/xep_0492/notify.py

@@ -0,0 +1,16 @@
+from slixmpp.plugins import BasePlugin
+from . import stanza
+
+
+class XEP_0492(BasePlugin):
+    """
+    XEP-0492: Chat notification settings
+    """
+
+    name = "xep_0492"
+    description = "XEP-0492: Chat notification settings"
+    dependencies = {"xep_0402"}
+    stanza = stanza
+
+    def plugin_init(self):
+        stanza.register_plugin()

slidge/slixfix/xep_0492/stanza.py

@@ -0,0 +1,102 @@
+from typing import Literal, Optional, cast
+
+from slixmpp import register_stanza_plugin
+from slixmpp.plugins.xep_0402.stanza import Extensions
+from slixmpp.xmlstream import ElementBase
+
+from ...util.types import ClientType
+
+NS = "urn:xmpp:notification-settings:0"
+
+WhenLiteral = Literal["never", "always", "on-mention"]
+
+
+class Notify(ElementBase):
+    """
+    Chat notification settings element
+
+
+    To enable it on a Conference element, use configure() like this:
+
+    .. code-block::python
+
+        # C being a Conference element
+        C['extensions']["notify"].configure("always", client_type="pc")
+
+    Which will add the <notify> element to the <extensions> element.
+    """
+
+    namespace = NS
+    name = "notify"
+    plugin_attrib = "notify"
+    interfaces = {"notify"}
+
+    def configure(self, when: WhenLiteral, client_type: Optional[ClientType] = None) -> None:
+        """
+        Configure the chat notification settings for this bookmark.
+
+        This method ensures that there are no conflicting settings, e.g.,
+        both a <never /> and a <always /> element.
+        """
+        cls = _CLASS_MAP[when]
+        element = cls()
+        if client_type is not None:
+            element["client-type"] = client_type
+
+        match = client_type if client_type is not None else ""
+        for child in self:
+            if isinstance(child, _Base) and child["client-type"] == match:
+                self.xml.remove(child.xml)
+
+        self.append(element)
+
+    def get_config(
+            self, client_type: Optional[ClientType] = None
+    ) -> Optional[WhenLiteral]:
+        """
+        Get the chat notification settings for this bookmark.
+
+        :param client_type: Optionally, get the notification for a specific client type.
+            If unset, returns the global notification setting.
+
+        :return: The chat notification setting as a string, or None if unset.
+        """
+        match = client_type if client_type is not None else ""
+        for child in self:
+            if isinstance(child, _Base) and child["client-type"] == match:
+                return cast(WhenLiteral, child.name)
+        return None
+
+
+class _Base(ElementBase):
+    namespace = NS
+    interfaces = {"client-type"}
+
+
+class Never(_Base):
+    name = "never"
+
+
+class Always(_Base):
+    name = "always"
+
+
+class OnMention(_Base):
+    name = "on-mention"
+
+
+class Advanced(ElementBase):
+    namespace = NS
+    name = plugin_attrib = "advanced"
+
+
+_CLASS_MAP = {
+    "never": Never,
+    "always": Always,
+    "on-mention": OnMention,
+}
+
+
+def register_plugin():
+    register_stanza_plugin(Extensions, Notify)
+    register_stanza_plugin(Notify, Advanced)

{slidge-0.2.3.post1.dist-info → slidge-0.2.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: slidge
-Version: 0.2.3.post1
+Version: 0.2.4
 Summary: XMPP bridging framework
 Author-email: Nicolas Cedilnik <nicoco@nicoco.fr>
 License:                     GNU AFFERO GENERAL PUBLIC LICENSE
@@ -693,7 +693,7 @@ Requires-Dist: thumbhash>=0.1.2
 
 
 [![woodpecker CI status](https://ci.codeberg.org/api/badges/14027/status.svg)](https://ci.codeberg.org/repos/14027)
-[![coverage](https://slidge.codeberg.page/coverage/main/coverage.svg)](https://slidge.im/coverage)
+[![coverage](https://slidge.codeberg.page/coverage/main/coverage.svg)](https://slidge.im/coverage/main)
 
 [![pypi version](https://badge.fury.io/py/slidge.svg)](https://pypi.org/project/slidge/)
 [![debian unstable version](https://badges.debian.net/badges/debian/unstable/python3-slidge/version.svg)](https://packages.debian.org/unstable/python3-slidge)

{slidge-0.2.3.post1.dist-info → slidge-0.2.4.dist-info}/RECORD

@@ -1,6 +1,6 @@
 slidge/__init__.py,sha256=S0tUjqpZlzsr8G4Y_1Xt-KCYB07qaknTB0OwHU8k29U,1587
 slidge/__main__.py,sha256=ydjUklOoavS4YlGfjRX_8BQN2DaSbaXPMi47RkOgcFI,37
-slidge/__version__.py,sha256=i4LQytjT85nU1wHx0KxMZ2wULDy9KnXdNBwMO7WBmNk,171
+slidge/__version__.py,sha256=ieOsYgM0aVfIKxAjpsbCrB7YTVXvXet9-wS_3Z87ito,165
 slidge/main.py,sha256=vMJzhvUxbeuIXuHxXXs6lm_ShBjXiS9B5Li5Ge4vWPo,6238
 slidge/migration.py,sha256=4BJmPIRB56_WIhRTqBFIIBXuvnhhBjjOMl4CE7jY6oc,1541
 slidge/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -17,7 +17,7 @@ slidge/contact/contact.py,sha256=BQ5Fw7InnI76S5bQi_kZL1HhtptZhegmtsKksml7tjY,231
 slidge/contact/roster.py,sha256=x3speGdHbZ-VTLoQLQW4s53rBeBvW87W8ZibCCZSLDA,10300
 slidge/core/__init__.py,sha256=RG7Jj5JCJERjhqJ31lOLYV-7bH_oblClQD1KF9LsTXo,68
 slidge/core/config.py,sha256=WP3-ScXqdAhJBX7IRB5pBi_tAV_vE6G5W3Z-LGGULQw,7691
-slidge/core/gateway.py,sha256=m7XN4ACd_txLl4zoAJNJjKT0BFJu6yUfJmhVfUkV7XM,36512
+slidge/core/gateway.py,sha256=Rid4Zc_IIV-3lMiiBirqiezkxC_Ed1HMlb9HLyxlnJc,36594
 slidge/core/pubsub.py,sha256=oTiS5KFQJAmsgkhOsvfvthT-LkuZGQSCrrUG0JskNkI,11907
 slidge/core/session.py,sha256=nQexpCd1jlHOhQPnFI4ri-5odp3N2pU5HO4l7WFetZY,28148
 slidge/core/dispatcher/__init__.py,sha256=1EXcjXietUKlxEqdrCWCV3xZ3q_DSsjHoqWrPMbtYao,84
@@ -32,7 +32,7 @@ slidge/core/dispatcher/vcard.py,sha256=Rmx-wCz6Lps0mXCO48HppNQlS3GOgMuzuw9hZYBdl
 slidge/core/dispatcher/message/__init__.py,sha256=vpDGOc_U9XvkUU_ws9n9-5M2NPJ87XGTVpuIxM7Z99k,223
 slidge/core/dispatcher/message/chat_state.py,sha256=sCdEpzbgmvBmTovNOCv9uY6v0eJZcWVvDYAGlAV3FJ4,1735
 slidge/core/dispatcher/message/marker.py,sha256=f1ezaMoHupBFZY7aUMsWLAQG7G1J9b3ihxICCkpGtis,2411
-slidge/core/dispatcher/message/message.py,sha256=HwauW2kGionLyDWG01OSa9a14gYzoovJuJvGbfB4nt4,15296
+slidge/core/dispatcher/message/message.py,sha256=07h7OBbIh3OtSbi7DNwv5ANRTzWbwS9ICMHjS_6KpEM,15360
 slidge/core/dispatcher/muc/__init__.py,sha256=V8URHLJ_y7mk-7Id6FzRuczb1Uq_Z69fhxvzHuVLH1w,269
 slidge/core/dispatcher/muc/admin.py,sha256=mkosquhaI2iC_mFq7C08kjwjr4iVqAWp7kbOTmgUQtU,3321
 slidge/core/dispatcher/muc/mam.py,sha256=1ROVP4ZPEVEH-HR5qRV4YwHz-V15uu5gyhv1ZwwKhk8,2821
@@ -50,7 +50,7 @@ slidge/core/mixins/message.py,sha256=5Tt1r_8rjsV445b_28Lx73S-rW5tsP1uGPQhIKN64VM
 slidge/core/mixins/message_maker.py,sha256=TcCutHi0sIwL6beJNkN7XyR0aDIbA0xZyxd2Gc9ulG4,6022
 slidge/core/mixins/message_text.py,sha256=pCY4tezEuwB2ZuUyUi72i4v9AJkxp_SWF1jrFsn94Ns,8096
 slidge/core/mixins/presence.py,sha256=yywo6KAw8C7GaZSMrSMuioNfhW08MrnobHt8XbHd0q8,7891
-slidge/core/mixins/recipient.py,sha256=U-YppozUO8pA94jmD3-qmhkykTebPNaOVWc3JDPC9w8,1302
+slidge/core/mixins/recipient.py,sha256=b0uFnpym-hOFgYxGjXT1xQcZ4YRbDSBftPcNWLzSwEI,1336
 slidge/db/__init__.py,sha256=EBDH1JSEhgqYcli2Bw11CRC749wJk8AOucgBzmhDSvU,105
 slidge/db/avatar.py,sha256=FfRt2Vu11ZKD9F3x1_drawvUd-TDE3mp7SE3BZ9hOOg,6467
 slidge/db/meta.py,sha256=v1Jf-npZ28QwdGpsLQWLBHEbEP3-jnPrygRg05tJ_Iw,1831
@@ -81,8 +81,8 @@ slidge/group/__init__.py,sha256=yFt7cHqeaKIMN6f9ZyhhspOcJJvBtLedGv-iICG7lto,258
 slidge/group/archive.py,sha256=IPqklzo0UN3lPHckfsKW9c4nl3m_9XGY4u0eehrhe8k,5281
 slidge/group/bookmarks.py,sha256=AvFL34bEX6n3OP1Np309T5hrLK9GnjkjdyLJ3uiLZyc,6616
 slidge/group/participant.py,sha256=epxXqJ545ALkEYxziiobH149nlBeSZlxsNCYeI8LFhM,17357
-slidge/group/room.py,sha256=kPy-5bWT8215I1MPJnCCPcaDfSRMiqXx6Fta9BRpLVk,46043
-slidge/slixfix/__init__.py,sha256=epiEsPNTWGF7uEhbL-cJaUyvPCbku8ZGNj3hlL7ofvc,2544
+slidge/group/room.py,sha256=aJ-VIYACuEuoyKDsBFxsUZFoVpd265i0mzTOOHCNTPg,46849
+slidge/slixfix/__init__.py,sha256=aEXtmxMgxQWsUoDV5NSxZKwb-Hml5XeR2FMJlnaDUng,4324
 slidge/slixfix/delivery_receipt.py,sha256=3bWdZH3-X3CZJXmnI_TpjkTUUK-EY4Ktm78lW0-40fc,1366
 slidge/slixfix/roster.py,sha256=KvDjh9q7pqaZf69H93okfib13cc95uVZUJ6rzpqmDaU,1704
 slidge/slixfix/link_preview/__init__.py,sha256=TDPTSEH5FQxgGpQpQIde-D72AHg-6YVWG-tOj4KpKmU,290
@@ -101,6 +101,9 @@ slidge/slixfix/xep_0292/vcard4.py,sha256=jL-TOW3eG2QXLduSLNq03L8HoUNmvy8kTZI5ojv
 slidge/slixfix/xep_0356_old/__init__.py,sha256=3jGWJX2m5gWgDCxcVqCsCCVPRTcfmU96yenwvAJtOKE,180
 slidge/slixfix/xep_0356_old/privilege.py,sha256=kcJzFbzhOHtQMtzOJpvvwm1pghSpealWnqhC0zc8dGo,5338
 slidge/slixfix/xep_0356_old/stanza.py,sha256=i7aqcaTg6PBhVwbHToLtlrwxBj7uO-M7VrYSyElyEKI,1229
+slidge/slixfix/xep_0492/__init__.py,sha256=kjWVeX3SG_2ohHx0fuMh1gmM2G57Bl6SRo7Mfv6sglA,161
+slidge/slixfix/xep_0492/notify.py,sha256=8EPSdU3rTzWkHNm8oFr0tK2PmMJ6hBAIr88GoOmHTuQ,340
+slidge/slixfix/xep_0492/stanza.py,sha256=gL0ixpV07Q9eqTXIOjdLVPtim45izuwaLk0iCoZ8e7c,2649
 slidge/util/__init__.py,sha256=BELovoTMPcPPGz3D48esBr8A4BRRHXTvavfgnArBgEc,301
 slidge/util/archive_msg.py,sha256=xXAR0BI5r3d6KKWjae9594izCOv6iI03z2WLuTecNw8,1724
 slidge/util/conf.py,sha256=1j2OnOsCBar1tOObErhXR5RC3Vl3faliOZ1U8J3My58,6613
@@ -108,8 +111,8 @@ slidge/util/db.py,sha256=4LxZj8oBYgiSnyBUnF_ALjr0TblkfNQq_p28sCfkHMY,242
 slidge/util/test.py,sha256=l1VHBsw5Uzk2t7wtkfb9kWvtehcYhw1t_d567JAJFKA,14135
 slidge/util/types.py,sha256=R_xfS5mRL0XUJIoDpnaAkZlTOoLPerduXBFftaVwIAI,5489
 slidge/util/util.py,sha256=An4BRIHktZGXnu4kCwaKYaSye_PlyuxEm_4SC9YvPhc,9594
-slidge-0.2.3.post1.dist-info/METADATA,sha256=qv5adMikUh_9Eu-6rinlYgSMaCLYG1fF4YaQ1D1QJeg,44800
-slidge-0.2.3.post1.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-slidge-0.2.3.post1.dist-info/entry_points.txt,sha256=py3_x834fFJ2TEzPd18Wt2DnysdAfuVqJ5zzBrXbAZs,44
-slidge-0.2.3.post1.dist-info/top_level.txt,sha256=2LRjDYHaGZ5ieCMF8xy58JIiabRMzX-MGMbCZwfE17c,7
-slidge-0.2.3.post1.dist-info/RECORD,,
+slidge-0.2.4.dist-info/METADATA,sha256=pMPAZlzk25loszDWjC73w2dvufxfN4f9NxTxxQ7KcNA,44799
+slidge-0.2.4.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+slidge-0.2.4.dist-info/entry_points.txt,sha256=py3_x834fFJ2TEzPd18Wt2DnysdAfuVqJ5zzBrXbAZs,44
+slidge-0.2.4.dist-info/top_level.txt,sha256=2LRjDYHaGZ5ieCMF8xy58JIiabRMzX-MGMbCZwfE17c,7
+slidge-0.2.4.dist-info/RECORD,,