slidge 0.2.2__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__ = "0.2.2"
+__version__ = "v0.2.4"

slidge/command/register.py

@@ -119,9 +119,7 @@ class Register(Command):
         elif self.xmpp.REGISTRATION_TYPE == RegistrationType.QRCODE:
             self.xmpp.qr_pending_registrations[  # type:ignore
                 user.jid.bare
-            ] = (
-                self.xmpp.loop.create_future()
-            )
+            ] = self.xmpp.loop.create_future()
             qr_text = await self.xmpp.get_qr_text(user)
             qr = qrcode.make(qr_text)
             with tempfile.NamedTemporaryFile(

slidge/contact/contact.py

@@ -454,7 +454,7 @@ class LegacyContact(
         except PermissionError:
             warnings.warn(
                 "Slidge does not have privileges to add contacts to the roster. Refer"
-                " to https://slidge.im/core/admin/privilege.html for"
+                " to https://slidge.codeberg.page/docs/main/admin/privilege.html for"
                 " more info."
             )
             if config.ROSTER_PUSH_PRESENCE_SUBSCRIPTION_REQUEST_FALLBACK:

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/dispatcher/muc/admin.py

@@ -11,7 +11,7 @@ class MucAdminMixin(DispatcherMixin):
         self.xmpp.register_handler(
             CoroutineCallback(
                 "MUCModerate",
-                StanzaPath("iq/apply_to/moderate"),
+                StanzaPath("iq/moderate"),
                 self.on_user_moderation,
             )
         )
@@ -35,12 +35,11 @@ class MucAdminMixin(DispatcherMixin):
         assert isinstance(iq, Iq)
         muc = await self.get_muc_from_stanza(iq)
 
-        apply_to = iq["apply_to"]
-        xmpp_id = apply_to["id"]
+        moderate = iq["moderate"]
+        xmpp_id = iq["moderate"]["id"]
         if not xmpp_id:
             raise XMPPError("bad-request", "Missing moderated message ID")
 
-        moderate = apply_to["moderate"]
         if not moderate["retract"]:
             raise XMPPError(
                 "feature-not-implemented",

slidge/core/dispatcher/presence.py

@@ -165,9 +165,9 @@ class PresenceHandlerMixin(DispatcherMixin):
         error_stanza["error"]["type"] = "cancel"
         error_stanza["error"]["by"] = muc.jid
         error_stanza["error"]["condition"] = "not-acceptable"
-        error_stanza["error"][
-            "text"
-        ] = "Slidge does not let you change your nickname in groups."
+        error_stanza["error"]["text"] = (
+            "Slidge does not let you change your nickname in groups."
+        )
         error_stanza.send()
 
 

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/attachment.py

@@ -20,11 +20,11 @@ import thumbhash
 from PIL import Image, ImageOps
 from slixmpp import JID, Message
 from slixmpp.exceptions import IqError, IqTimeout
+from slixmpp.plugins.xep_0264.stanza import Thumbnail
 from slixmpp.plugins.xep_0363 import FileUploadError
 from slixmpp.plugins.xep_0447.stanza import StatelessFileSharing
 
 from ...db.avatar import avatar_cache
-from ...slixfix.xep_0264.stanza import Thumbnail
 from ...util.types import (
     LegacyAttachment,
     LegacyMessageType,

slidge/core/mixins/avatar.py

@@ -3,6 +3,7 @@ from hashlib import sha1
 from pathlib import Path
 from typing import TYPE_CHECKING, Optional
 
+from PIL import UnidentifiedImageError
 from slixmpp import JID
 
 from ...db.avatar import CachedAvatar, avatar_cache
@@ -100,6 +101,11 @@ class AvatarMixin:
         else:
             try:
                 cached_avatar = await avatar_cache.convert_or_get(a)
+            except UnidentifiedImageError:
+                self.session.log.warning("%s is not a valid avatar", a)
+                self._avatar_pk = None
+                self.__avatar_unique_id = uid
+                return
             except Exception as e:
                 self.session.log.error("Failed to set avatar %s", a, exc_info=e)
                 self._avatar_pk = None

slidge/core/mixins/message.py

@@ -4,8 +4,8 @@ import warnings
 from typing import TYPE_CHECKING, Optional
 
 from slixmpp import Iq, Message
+from slixmpp.plugins.xep_0004 import Form
 
-from ...slixfix.xep_0490.mds import PUBLISH_OPTIONS
 from ...util.types import ChatState, LegacyMessageType, Marker
 from .attachment import AttachmentMixin
 from .message_maker import MessageMaker
@@ -14,6 +14,17 @@ from .message_text import TextMessageMixin
 if TYPE_CHECKING:
     from ...group import LegacyMUC
 
+# this is for MDS
+PUBLISH_OPTIONS = Form()
+PUBLISH_OPTIONS["type"] = "submit"
+PUBLISH_OPTIONS.add_field(
+    "FORM_TYPE", "hidden", value="http://jabber.org/protocol/pubsub#publish-options"
+)
+PUBLISH_OPTIONS.add_field("pubsub#persist_items", value="true")
+PUBLISH_OPTIONS.add_field("pubsub#max_items", value="max")
+PUBLISH_OPTIONS.add_field("pubsub#send_last_published_item", value="never")
+PUBLISH_OPTIONS.add_field("pubsub#access_model", value="whitelist")
+
 
 class ChatStateMixin(MessageMaker):
     def __init__(self):
@@ -172,7 +183,7 @@ class CarbonMessageMixin(ContentMessageMixin, MarkerMixin):
                 warnings.warn(
                     "Slidge does not have privileges to send message on behalf of"
                     " user.Refer to"
-                    " https://slidge.im/core/admin/privilege.html"
+                    " https://slidge.codeberg.page/docs/main/admin/privilege.html"
                     " for more info."
                 )
 

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/db/store.py

@@ -18,9 +18,16 @@ from sqlalchemy.sql.functions import count
 
 from ..core import config
 from ..util.archive_msg import HistoryMessage
-from ..util.types import URL, CachedPresence, ClientType
+from ..util.types import (
+    URL,
+    CachedPresence,
+    ClientType,
+    MamMetadata,
+    MucAffiliation,
+    MucRole,
+    Sticker,
+)
 from ..util.types import Hat as HatTuple
-from ..util.types import MamMetadata, MucAffiliation, MucRole, Sticker
 from .meta import Base
 from .models import (
     ArchivedMessage,
@@ -545,7 +552,6 @@ class MAMStore(EngineMixin):
         sender: Optional[str] = None,
         flip=False,
     ) -> Iterator[HistoryMessage]:
-
         with self.session() as session:
             q = select(ArchivedMessage).where(ArchivedMessage.room_id == room_pk)
             if start_date is not None:

slidge/group/archive.py

@@ -49,9 +49,9 @@ class MessageArchive:
                 new_msg["muc"]["jid"] = participant.muc.jid
             else:
                 log.warning("No real JID for participant in this group")
-                new_msg["muc"][
-                    "jid"
-                ] = f"{uuid.uuid4()}@{participant.xmpp.boundjid.bare}"
+                new_msg["muc"]["jid"] = (
+                    f"{uuid.uuid4()}@{participant.xmpp.boundjid.bare}"
+                )
 
         self.__store.add_message(
             self.room_pk,

slidge/group/participant.py

@@ -322,7 +322,10 @@ class LegacyParticipant(
         legacy_msg_id=None,
         **send_kwargs,
     ) -> MessageOrPresenceTypeVar:
-        stanza["occupant-id"]["id"] = self.__occupant_id
+        if stanza.get_from().resource:
+            stanza["occupant-id"]["id"] = self.__occupant_id
+        else:
+            stanza["occupant-id"]["id"] = "room"
         self.__add_nick_element(stanza)
         if not self.is_user and isinstance(stanza, Presence):
             if stanza["type"] == "unavailable" and not self._presence_sent:
@@ -459,11 +462,14 @@ class LegacyParticipant(
 
         for i in msg_ids:
             m = self.muc.get_system_participant()._make_message()
-            m["apply_to"]["id"] = i
-            m["apply_to"]["moderated"].enable("retract")
-            m["apply_to"]["moderated"]["by"] = self.jid
+            m["retract"]["id"] = i
+            if self.is_system:
+                m["retract"].enable("moderated")
+            else:
+                m["retract"]["moderated"]["by"] = self.jid
+                m["retract"]["moderated"]["occupant-id"]["id"] = self.__occupant_id
             if reason:
-                m["apply_to"]["moderated"]["reason"] = reason
+                m["retract"]["reason"] = reason
             self._send(m)
 
     def set_room_subject(

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/main.py

@@ -10,7 +10,7 @@ Use the long version of the CLI arg without the double dash prefix inside this
 INI file, eg ``debug=true``.
 
 An example configuration file is available at
-https://git.sr.ht/~nicoco/slidge/tree/master/item/dev/confs/slidge-example.ini
+https://codeberg.org/slidge/slidge/src/branch/main/dev/confs/slidge-example.ini
 """
 
 import asyncio

slidge/slixfix/__init__.py

@@ -5,25 +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 (  # xep_0356,
+from . import (
     link_preview,
     xep_0077,
     xep_0100,
     xep_0153,
-    xep_0264,
     xep_0292,
-    xep_0313,
-    xep_0317,
     xep_0356_old,
-    xep_0424,
-    xep_0490,
+    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"]
@@ -50,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
 
 
@@ -83,16 +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_0264",
         "xep_0292_provider",
-        "xep_0317",
         "xep_0356_old",
-        "xep_0490",
+        "xep_0492",
     ]
 )
-
-
-Message.reply = reply  # type: ignore

slidge/slixfix/xep_0153/__init__.py

@@ -4,7 +4,6 @@
 # See the file LICENSE for copying permission.
 from slixmpp.plugins.base import register_plugin
 
-from .stanza import VCardTempUpdate
 from .vcard_avatar import XEP_0153
 
 register_plugin(XEP_0153)

slidge/slixfix/xep_0153/vcard_avatar.py

@@ -1,17 +1,8 @@
-# Slixmpp: The Slick XMPP Library
-# Copyright (C) 2012 Nathanael C. Fritz, Lance J.T. Stout
-# This file is part of Slixmpp.
-# See the file LICENSE for copying permission.
-import logging
-
 from slixmpp.plugins.base import BasePlugin
+from slixmpp.plugins.xep_0153 import VCardTempUpdate, stanza
 from slixmpp.stanza import Presence
 from slixmpp.xmlstream import register_stanza_plugin
 
-from . import VCardTempUpdate, stanza
-
-log = logging.getLogger(__name__)
-
 
 class XEP_0153(BasePlugin):
     name = "xep_0153"

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/util/test.py

@@ -5,7 +5,14 @@ from pathlib import Path
 from typing import Optional, Union
 from xml.dom.minidom import parseString
 
-import xmldiff.main
+try:
+    import xmldiff.main
+
+    XML_DIFF_PRESENT = True
+except ImportError:
+    xmldiff = None
+    XML_DIFF_PRESENT = False
+
 from slixmpp import (
     JID,
     ElementBase,
@@ -157,7 +164,7 @@ class SlixTestPlus(SlixTest):
                 result = self.compare(xml, stanza.xml, stanza2.xml)
             stanza_class.namespace = old_ns
 
-            if not result:
+            if XML_DIFF_PRESENT and not result:
                 debug += str(
                     xmldiff.main.diff_texts(tostring(xml), tostring(stanza.xml))
                 )