slidge 0.2.0a10__py3-none-any.whl → 0.2.0b1__py3-none-any.whl

slidge/__main__.py

@@ -1,4 +1,3 @@
-if __name__ == "__main__":
-    from slidge.main import main
+from slidge.main import main
 
-    main()
+main()

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.0alpha10"
+__version__ = "0.2.0beta1"

slidge/command/adhoc.py

@@ -9,8 +9,11 @@ from slixmpp.exceptions import XMPPError
 from slixmpp.plugins.xep_0004 import Form as SlixForm  # type: ignore[attr-defined]
 from slixmpp.plugins.xep_0030.stanza.items import DiscoItems
 
+from ..core import config
+from ..util.util import strip_leading_emoji
 from . import Command, CommandResponseType, Confirmation, Form, TableResult
 from .base import FormField
+from .categories import CommandCategory
 
 if TYPE_CHECKING:
     from ..core.gateway import BaseGateway
@@ -46,19 +49,19 @@ class AdhocProvider:
         return await self.__handle_result(session, result, adhoc_session)
 
     async def __handle_category_list(
-        self, category: str, iq: Iq, adhoc_session: AdhocSessionType
+        self, category: CommandCategory, iq: Iq, adhoc_session: AdhocSessionType
     ) -> AdhocSessionType:
         try:
             session = self.xmpp.get_session_from_stanza(iq)
         except XMPPError:
             session = None
-        commands = []
-        for command in self._categories[category]:
+        commands: dict[str, Command] = {}
+        for command in self._categories[category.node]:
             try:
                 command.raise_if_not_authorized(iq.get_from())
             except XMPPError:
                 continue
-            commands.append(command)
+            commands[command.NODE] = command
         if len(commands) == 0:
             raise XMPPError(
                 "not-authorized", "There is no command you can run in this category"
@@ -66,7 +69,7 @@ class AdhocProvider:
         return await self.__handle_result(
             session,
             Form(
-                category,
+                category.name,
                 "",
                 [
                     FormField(
@@ -74,8 +77,11 @@ class AdhocProvider:
                         label="Command",
                         type="list-single",
                         options=[
-                            {"label": command.NAME, "value": str(i)}
-                            for i, command in enumerate(commands)
+                            {
+                                "label": strip_leading_emoji_if_needed(command.NAME),
+                                "value": command.NODE,
+                            }
+                            for command in commands.values()
                         ],
                     )
                 ],
@@ -86,12 +92,12 @@ class AdhocProvider:
 
     async def __handle_category_choice(
         self,
-        commands: list[Command],
+        commands: dict[str, Command],
         form_values: dict[str, str],
         session: "BaseSession[Any, Any]",
         jid: JID,
     ):
-        command = commands[int(form_values["command"])]
+        command = commands[form_values["command"]]
         result = await self.__wrap_handler(command.run, session, jid)
         return result
 
@@ -207,19 +213,23 @@ class AdhocProvider:
             self.xmpp.plugin["xep_0050"].add_command(  # type: ignore[no-untyped-call]
                 jid=jid,
                 node=command.NODE,
-                name=command.NAME,
+                name=strip_leading_emoji_if_needed(command.NAME),
                 handler=partial(self.__wrap_initial_handler, command),
             )
         else:
-            if category not in self._categories:
-                self._categories[category] = list[Command]()
+            if isinstance(category, str):
+                category = CommandCategory(category, category)
+            node = category.node
+            name = category.name
+            if node not in self._categories:
+                self._categories[node] = list[Command]()
                 self.xmpp.plugin["xep_0050"].add_command(  # type: ignore[no-untyped-call]
                     jid=jid,
-                    node=category,
-                    name=category,
+                    node=node,
+                    name=strip_leading_emoji_if_needed(name),
                     handler=partial(self.__handle_category_list, category),
                 )
-            self._categories[category].append(command)
+            self._categories[node].append(command)
 
     async def get_items(self, jid: JID, node: str, iq: Iq) -> DiscoItems:
         """
@@ -262,4 +272,10 @@ class AdhocProvider:
         return filtered_items
 
 
+def strip_leading_emoji_if_needed(text: str) -> str:
+    if config.STRIP_LEADING_EMOJI_ADHOC:
+        return strip_leading_emoji(text)
+    return text
+
+
 log = logging.getLogger(__name__)

slidge/command/admin.py

@@ -11,6 +11,7 @@ from slixmpp.exceptions import XMPPError
 from ..core import config
 from ..util.types import AnyBaseSession
 from .base import (
+    NODE_PREFIX,
     Command,
     CommandAccess,
     Confirmation,
@@ -21,6 +22,8 @@ from .base import (
 )
 from .categories import ADMINISTRATION
 
+NODE_PREFIX = NODE_PREFIX + "admin/"
+
 
 class AdminCommand(Command):
     ACCESS = CommandAccess.ADMIN_ONLY
@@ -30,7 +33,8 @@ class AdminCommand(Command):
 class ListUsers(AdminCommand):
     NAME = "👤 List registered users"
     HELP = "List the users registered to this gateway"
-    NODE = CHAT_COMMAND = "list_users"
+    CHAT_COMMAND = "list_users"
+    NODE = NODE_PREFIX + CHAT_COMMAND
 
     async def run(self, _session, _ifrom, *_):
         items = []
@@ -51,7 +55,8 @@ class ListUsers(AdminCommand):
 class SlidgeInfo(AdminCommand):
     NAME = "ℹ️ Server information"
     HELP = "List the users registered to this gateway"
-    NODE = CHAT_COMMAND = "info"
+    CHAT_COMMAND = "info"
+    NODE = NODE_PREFIX + CHAT_COMMAND
     ACCESS = CommandAccess.ANY
 
     async def run(self, _session, _ifrom, *_):
@@ -105,7 +110,8 @@ class SlidgeInfo(AdminCommand):
 class DeleteUser(AdminCommand):
     NAME = "❌ Delete a user"
     HELP = "Unregister a user from the gateway"
-    NODE = CHAT_COMMAND = "delete_user"
+    CHAT_COMMAND = "delete_user"
+    NODE = NODE_PREFIX + CHAT_COMMAND
 
     async def run(self, _session, _ifrom, *_):
         return Form(
@@ -141,7 +147,8 @@ class DeleteUser(AdminCommand):
 class ChangeLoglevel(AdminCommand):
     NAME = "📋 Change the verbosity of the logs"
     HELP = "Set the logging level"
-    NODE = CHAT_COMMAND = "loglevel"
+    CHAT_COMMAND = "loglevel"
+    NODE = NODE_PREFIX + CHAT_COMMAND
 
     async def run(self, _session, _ifrom, *_):
         return Form(

slidge/command/base.py

@@ -25,9 +25,12 @@ from slixmpp.types import JidStr
 from ..core import config
 from ..util.types import AnyBaseSession, FieldType
 
+NODE_PREFIX = "https://slidge.im/command/core/"
+
 if TYPE_CHECKING:
     from ..core.gateway import BaseGateway
     from ..core.session import BaseSession
+    from .categories import CommandCategory
 
 
 HandlerType = Union[
@@ -178,8 +181,8 @@ class Form:
         """
         form = SlixForm()  # type: ignore[no-untyped-call]
         form["type"] = "form"
-        form["instructions"] = self.instructions
         form["title"] = self.title
+        form["instructions"] = self.instructions
         for fi in self.fields:
             form.append(fi.get_xml())
         return form
@@ -347,7 +350,7 @@ class Command(ABC):
     Who can use this command
     """
 
-    CATEGORY: Optional[str] = None
+    CATEGORY: Optional[Union[str, "CommandCategory"]] = None
     """
     If used, the command will be under this top-level category.
     Use the same string for several commands to group them.

slidge/command/categories.py

@@ -1,3 +1,13 @@
-ADMINISTRATION = "🛷️ Slidge administration"
-CONTACTS = "👤 Contacts"
-GROUPS = "👥 Groups"
+from typing import NamedTuple
+
+from .base import NODE_PREFIX
+
+
+class CommandCategory(NamedTuple):
+    name: str
+    node: str
+
+
+ADMINISTRATION = CommandCategory("🛷️ Slidge administration", NODE_PREFIX + "admin")
+CONTACTS = CommandCategory("👤 Contacts", NODE_PREFIX + "contacts")
+GROUPS = CommandCategory("👥 Groups", NODE_PREFIX + "groups")

slidge/command/chat_command.py

@@ -13,6 +13,7 @@ from slixmpp.exceptions import XMPPError
 from slixmpp.types import JidStr, MessageTypes
 
 from . import Command, CommandResponseType, Confirmation, Form, TableResult
+from .categories import CommandCategory
 
 if TYPE_CHECKING:
     from ..core.gateway import BaseGateway
@@ -280,7 +281,19 @@ class ChatCommandProvider:
     def _help(self, mfrom: JID):
         msg = "Available commands:"
         for c in sorted(
-            self._commands.values(), key=lambda co: (co.CATEGORY or "", co.CHAT_COMMAND)
+            self._commands.values(),
+            key=lambda co: (
+                (
+                    co.CATEGORY
+                    if isinstance(co.CATEGORY, str)
+                    else (
+                        co.CATEGORY.name
+                        if isinstance(co.CATEGORY, CommandCategory)
+                        else ""
+                    )
+                ),
+                co.CHAT_COMMAND,
+            ),
         ):
             try:
                 c.raise_if_not_authorized(mfrom)

slidge/command/user.py

@@ -26,8 +26,8 @@ if TYPE_CHECKING:
 class Search(Command):
     NAME = "🔎 Search for contacts"
     HELP = "Search for contacts via this gateway"
-    NODE = "search"
     CHAT_COMMAND = "find"
+    NODE = CONTACTS.node + "/" + CHAT_COMMAND
     ACCESS = CommandAccess.USER_LOGGED
     CATEGORY = CONTACTS
 
@@ -64,7 +64,8 @@ class SyncContacts(Command):
         "Synchronize your XMPP roster with your legacy contacts. "
         "Slidge will only add/remove/modify contacts in its dedicated roster group"
     )
-    NODE = CHAT_COMMAND = "sync-contacts"
+    CHAT_COMMAND = "sync-contacts"
+    NODE = CONTACTS.node + "/" + CHAT_COMMAND
     ACCESS = CommandAccess.USER_LOGGED
     CATEGORY = CONTACTS
 
@@ -123,7 +124,8 @@ class SyncContacts(Command):
 
 class ListContacts(Command):
     NAME = HELP = "👤 List your legacy contacts"
-    NODE = CHAT_COMMAND = "contacts"
+    CHAT_COMMAND = "contacts"
+    NODE = CONTACTS.node + "/" + CHAT_COMMAND
     ACCESS = CommandAccess.USER_LOGGED
     CATEGORY = CONTACTS
 
@@ -143,7 +145,8 @@ class ListContacts(Command):
 
 class ListGroups(Command):
     NAME = HELP = "👥 List your legacy groups"
-    NODE = CHAT_COMMAND = "groups"
+    CHAT_COMMAND = "groups"
+    NODE = GROUPS.node + "/" + CHAT_COMMAND
     ACCESS = CommandAccess.USER_LOGGED
     CATEGORY = GROUPS
 
@@ -162,7 +165,8 @@ class ListGroups(Command):
 class Login(Command):
     NAME = "🔐 Re-login to the legacy network"
     HELP = "Login to the legacy service"
-    NODE = CHAT_COMMAND = "re-login"
+    CHAT_COMMAND = "re-login"
+    NODE = "https://slidge.im/command/core/" + CHAT_COMMAND
 
     ACCESS = CommandAccess.USER_NON_LOGGED
 
@@ -184,7 +188,8 @@ class Login(Command):
 class CreateGroup(Command):
     NAME = "🆕 New legacy group"
     HELP = "Create a group on the legacy service"
-    NODE = CHAT_COMMAND = "create-group"
+    CHAT_COMMAND = "create-group"
+    NODE = GROUPS.node + "/" + CHAT_COMMAND
     CATEGORY = GROUPS
 
     ACCESS = CommandAccess.USER_LOGGED
@@ -233,7 +238,8 @@ class CreateGroup(Command):
 class Preferences(Command):
     NAME = "⚙️ Preferences"
     HELP = "Customize the gateway behaviour to your liking"
-    NODE = CHAT_COMMAND = "preferences"
+    CHAT_COMMAND = "preferences"
+    NODE = "https://slidge.im/command/core/preferences"
     ACCESS = CommandAccess.USER
 
     async def run(
@@ -268,7 +274,8 @@ class Preferences(Command):
 class Unregister(Command):
     NAME = "❌ Unregister from the gateway"
     HELP = "Unregister from the gateway"
-    NODE = CHAT_COMMAND = "unregister"
+    CHAT_COMMAND = "unregister"
+    NODE = "https://slidge.im/command/core/unregister"
     ACCESS = CommandAccess.USER
 
     async def run(
@@ -290,7 +297,8 @@ class Unregister(Command):
 
 class LeaveGroup(Command):
     NAME = HELP = "❌ Leave a legacy group"
-    NODE = CHAT_COMMAND = "leave-group"
+    CHAT_COMMAND = "leave-group"
+    NODE = GROUPS.node + "/" + CHAT_COMMAND
     ACCESS = CommandAccess.USER_LOGGED
     CATEGORY = GROUPS
 
@@ -305,7 +313,10 @@ class LeaveGroup(Command):
                 FormField(
                     "group",
                     "Group name",
-                    options=[{"label": g.name, "value": g.name} for g in groups],
+                    type="list-single",
+                    options=[
+                        {"label": g.name, "value": str(i)} for i, g in enumerate(groups)
+                    ],
                 )
             ],
             handler=self.confirm,  # type:ignore
@@ -329,3 +340,4 @@ class LeaveGroup(Command):
     @staticmethod
     async def finish(session: AnyBaseSession, _ifrom, group: LegacyMUC):
         await session.on_leave_group(group.legacy_id)
+        await session.bookmarks.remove(group, reason="You left this group via slidge.")

slidge/contact/roster.py

@@ -154,6 +154,8 @@ class LegacyRoster(
         try:
             with contact.updating_info():
                 await contact.avatar_wrap_update_info()
+        except XMPPError:
+            raise
         except Exception as e:
             raise XMPPError("internal-server-error", str(e))
         contact._caps_ver = await contact.get_caps_ver(contact.jid)

slidge/core/config.py

@@ -154,9 +154,6 @@ LAST_SEEN_FALLBACK__DOC = (
 QR_TIMEOUT = 60
 QR_TIMEOUT__DOC = "Timeout for QR code flashing confirmation."
 
-DOWNLOAD_CHUNK_SIZE = 1024
-DOWNLOAD_CHUNK_SIZE__DOC = "Chunk size when slidge needs to download files using HTTP."
-
 LAST_MESSAGE_CORRECTION_RETRACTION_WORKAROUND = False
 LAST_MESSAGE_CORRECTION_RETRACTION_WORKAROUND__DOC = (
     "If the legacy service does not support last message correction but supports"
@@ -217,3 +214,9 @@ DEV_MODE__DOC = (
     "Enables an interactive python shell via chat commands, for admins."
     "Not safe to use in prod, but great during dev."
 )
+
+STRIP_LEADING_EMOJI_ADHOC = False
+STRIP_LEADING_EMOJI_ADHOC__DOC = (
+    "Strip the leading emoji in ad-hoc command names, if present, in case you "
+    "are a emoji-hater."
+)

slidge/core/dispatcher/message/marker.py

@@ -3,12 +3,7 @@ from slixmpp.xmlstream import StanzaBase
 
 from ....group.room import LegacyMUC
 from ....util.types import Recipient
-from ..util import (
-    DispatcherMixin,
-    _get_entity,
-    _xmpp_to_legacy_thread,
-    exceptions_to_xmpp_errors,
-)
+from ..util import DispatcherMixin, _get_entity, exceptions_to_xmpp_errors
 
 
 class MarkerMixin(DispatcherMixin):
@@ -26,7 +21,7 @@ class MarkerMixin(DispatcherMixin):
         session = await self._get_session(msg)
 
         e: Recipient = await _get_entity(session, msg)
-        legacy_thread = await _xmpp_to_legacy_thread(session, msg, e)
+        legacy_thread = await self._xmpp_to_legacy_thread(session, msg, e)
         displayed_msg_id = msg["displayed"]["id"]
         if not isinstance(e, LegacyMUC) and self.xmpp.MARK_ALL_MESSAGES:
             to_mark = e.get_msg_xmpp_id_up_to(displayed_msg_id)  # type: ignore

slidge/core/dispatcher/muc/misc.py

@@ -54,6 +54,9 @@ class MucMiscMixin(DispatcherMixin):
             muc = await self.get_muc_from_stanza(iq)
             await muc.session.on_leave_group(muc.legacy_id)
             iq.reply().send()
+            await muc.session.bookmarks.remove(
+                muc, "You left this chat from an XMPP client."
+            )
             return
 
         raise XMPPError("feature-not-implemented")

slidge/core/dispatcher/muc/owner.py

@@ -88,7 +88,7 @@ class MucOwnerMixin(DispatcherMixin):
             if reason is not None:
                 presence["muc"]["destroy"]["reason"] = reason
             user_participant._send(presence)
-            muc.session.bookmarks.remove(muc)
+            await muc.session.bookmarks.remove(muc, kick=False)
             clear = True
         else:
             raise XMPPError("bad-request")

slidge/core/dispatcher/util.py

@@ -96,9 +96,31 @@ class DispatcherMixin:
     ) -> tuple["BaseSession", Recipient, int | str]:
         session = await self._get_session(msg)
         e: Recipient = await _get_entity(session, msg)
-        legacy_thread = await _xmpp_to_legacy_thread(session, msg, e)
+        legacy_thread = await self._xmpp_to_legacy_thread(session, msg, e)
         return session, e, legacy_thread
 
+    async def _xmpp_to_legacy_thread(
+        self, session: "BaseSession", msg: Message, recipient: RecipientType
+    ):
+        xmpp_thread = msg["thread"]
+        if not xmpp_thread:
+            return None
+
+        if session.MESSAGE_IDS_ARE_THREAD_IDS:
+            return self._xmpp_msg_id_to_legacy(session, xmpp_thread)
+
+        legacy_thread_str = session.xmpp.store.sent.get_legacy_thread(
+            session.user_pk, xmpp_thread
+        )
+        if legacy_thread_str is not None:
+            return session.xmpp.LEGACY_MSG_ID_TYPE(legacy_thread_str)
+        async with session.thread_creation_lock:
+            legacy_thread = await recipient.create_thread(xmpp_thread)
+            session.xmpp.store.sent.set_thread(
+                session.user_pk, str(legacy_thread), xmpp_thread
+            )
+            return legacy_thread
+
 
 def _ignore(session: "BaseSession", msg: Message):
     i = msg.get_id()
@@ -111,28 +133,6 @@ def _ignore(session: "BaseSession", msg: Message):
     return True
 
 
-async def _xmpp_to_legacy_thread(
-    session: "BaseSession", msg: Message, recipient: RecipientType
-):
-    xmpp_thread = msg["thread"]
-    if not xmpp_thread:
-        return
-
-    if session.MESSAGE_IDS_ARE_THREAD_IDS:
-        return session.xmpp.store.sent.get_legacy_thread(session.user_pk, xmpp_thread)
-
-    async with session.thread_creation_lock:
-        legacy_thread_str = session.xmpp.store.sent.get_legacy_thread(
-            session.user_pk, xmpp_thread
-        )
-        if legacy_thread_str is None:
-            legacy_thread = str(await recipient.create_thread(xmpp_thread))
-            session.xmpp.store.sent.set_thread(
-                session.user_pk, xmpp_thread, legacy_thread
-            )
-    return session.xmpp.LEGACY_MSG_ID_TYPE(legacy_thread)
-
-
 async def _get_entity(session: "BaseSession", m: Message) -> RecipientType:
     session.raise_if_not_logged()
     if m.get_type() == "groupchat":

slidge/core/mixins/attachment.py

@@ -33,17 +33,14 @@ from ...util.types import (
 )
 from ...util.util import fix_suffix
 from .. import config
-from .message_maker import MessageMaker
+from .message_text import TextMessageMixin
 
 
-class AttachmentMixin(MessageMaker):
+class AttachmentMixin(TextMessageMixin):
     def __init__(self, *a, **kw):
         super().__init__(*a, **kw)
         self.__store = self.xmpp.store.attachments
 
-    def send_text(self, *_, **k) -> Optional[Message]:
-        raise NotImplementedError
-
     async def __upload(
         self,
         file_path: Path,
@@ -261,7 +258,7 @@ class AttachmentMixin(MessageMaker):
                 thumbnail["width"] = x
                 thumbnail["height"] = y
                 thumbnail["media-type"] = "image/thumbhash"
-                thumbnail["uri"] = "data:image/thumbhash," + urlquote(h)
+                thumbnail["uri"] = "data:image/thumbhash;base64," + urlquote(h)
 
         self.__store.set_sims(uploaded_url, str(ref))
 
@@ -304,6 +301,7 @@ class AttachmentMixin(MessageMaker):
         caption: Optional[str] = None,
         carbon=False,
         when: Optional[datetime] = None,
+        correction=False,
         **kwargs,
     ) -> list[Message]:
         msg["oob"]["url"] = uploaded_url
@@ -311,11 +309,19 @@ class AttachmentMixin(MessageMaker):
         if caption:
             m1 = self._send(msg, carbon=carbon, **kwargs)
             m2 = self.send_text(
-                caption, legacy_msg_id=legacy_msg_id, when=when, carbon=carbon, **kwargs
+                caption,
+                legacy_msg_id=legacy_msg_id,
+                when=when,
+                carbon=carbon,
+                correction=correction,
+                **kwargs,
             )
             return [m1, m2] if m2 else [m1]
         else:
-            self._set_msg_id(msg, legacy_msg_id)
+            if correction:
+                msg["replace"]["id"] = self._replace_id(legacy_msg_id)
+            else:
+                self._set_msg_id(msg, legacy_msg_id)
             return [self._send(msg, carbon=carbon, **kwargs)]
 
     async def send_file(
@@ -358,6 +364,16 @@ class AttachmentMixin(MessageMaker):
         carbon = kwargs.pop("carbon", False)
         mto = kwargs.pop("mto", None)
         store_multi = kwargs.pop("store_multi", True)
+        correction = kwargs.get("correction", False)
+        if correction and (original_xmpp_id := self._legacy_to_xmpp(legacy_msg_id)):
+            xmpp_ids = self.xmpp.store.multi.get_xmpp_ids(
+                self.session.user_pk, original_xmpp_id
+            )
+
+            for xmpp_id in xmpp_ids:
+                if xmpp_id == original_xmpp_id:
+                    continue
+                self.retract(xmpp_id, thread)
         msg = self._make_message(
             when=when,
             reply_to=reply_to,

slidge/core/mixins/lock.py

@@ -15,14 +15,16 @@ class NamedLockMixin:
         locks = self.__locks
         if not locks.get(id_):
             locks[id_] = asyncio.Lock()
-        async with locks[id_]:
-            log.trace("acquired %s", id_)  # type:ignore
-            yield
-        log.trace("releasing %s", id_)  # type:ignore
-        waiters = locks[id_]._waiters  # type:ignore
-        if not waiters:
-            del locks[id_]
-            log.trace("erasing %s", id_)  # type:ignore
+        try:
+            async with locks[id_]:
+                log.trace("acquired %s", id_)  # type:ignore
+                yield
+        finally:
+            log.trace("releasing %s", id_)  # type:ignore
+            waiters = locks[id_]._waiters  # type:ignore
+            if not waiters:
+                del locks[id_]
+                log.trace("erasing %s", id_)  # type:ignore
 
     def get_lock(self, id_: Hashable):
         return self.__locks.get(id_)