slidge 0.2.0b0__tar.gz → 0.2.0b1__tar.gz

{slidge-0.2.0b0 → slidge-0.2.0b1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: slidge
-Version: 0.2.0b0
+Version: 0.2.0b1
 Summary: XMPP bridging framework
 Home-page: https://sr.ht/~nicoco/slidge/
 License: AGPL-3.0-or-later

{slidge-0.2.0b0 → slidge-0.2.0b1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "slidge"
-version = "0.2.0beta0"
+version = "0.2.0beta1"
 description = "XMPP bridging framework"
 authors = ["Nicolas Cedilnik <nicoco@nicoco.fr>"]
 readme = "README.md"
@@ -51,6 +51,7 @@ xmldiff = "^2.5"
 types-pillow = "^9.5.0.0"
 pre-commit = "^3.3.0"
 coverage = "^7.2.7"
+emoji = "*"
 
 [tool.poetry.group.dev.dependencies.slidge-dev-helpers]
 git = "https://git.sr.ht/~nicoco/slidge-dev-helpers"

{slidge-0.2.0b0 → slidge-0.2.0b1}/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.0beta0"
+__version__ = "0.2.0beta1"

{slidge-0.2.0b0 → slidge-0.2.0b1}/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-0.2.0b0 → slidge-0.2.0b1}/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-0.2.0b0 → slidge-0.2.0b1}/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-0.2.0b1/slidge/command/categories.py

@@ -0,0 +1,13 @@
+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-0.2.0b0 → slidge-0.2.0b1}/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-0.2.0b0 → slidge-0.2.0b1}/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
 

{slidge-0.2.0b0 → slidge-0.2.0b1}/slidge/core/config.py

@@ -214,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-0.2.0b0 → slidge-0.2.0b1}/slidge/db/alembic/versions/15b0bd83407a_remove_bogus_unique_constraints_on_room_.py

@@ -59,6 +59,8 @@ room_table = sa.Table(
 
 
 def upgrade() -> None:
+    if op.get_bind().engine.name == "postgresql":
+        return
     with op.batch_alter_table(
         "room",
         schema=None,

{slidge-0.2.0b0 → slidge-0.2.0b1}/slidge/db/alembic/versions/3071e0fa69d4_add_contact_client_type.py

@@ -37,7 +37,7 @@ def upgrade() -> None:
                     native_enum=False,
                 ),
                 nullable=False,
-                server_default=sa.text("pc"),
+                server_default=sa.literal("pc"),
             )
         )
 

{slidge-0.2.0b0 → slidge-0.2.0b1}/slidge/db/alembic/versions/8d2ced764698_rely_on_db_to_store_contacts_rooms_and_.py

@@ -95,6 +95,12 @@ def upgrade() -> None:
     op.add_column("room", sa.Column("description", sa.String(), nullable=True))
     op.add_column("room", sa.Column("subject", sa.String(), nullable=True))
     op.add_column("room", sa.Column("subject_date", sa.DateTime(), nullable=True))
+
+    if op.get_bind().engine.name == "postgresql":
+        op.execute(
+            "CREATE TYPE muctype AS ENUM ('GROUP', 'CHANNEL', 'CHANNEL_NON_ANONYMOUS')"
+        )
+
     op.add_column(
         "room",
         sa.Column(

{slidge-0.2.0b0 → slidge-0.2.0b1}/slidge/db/alembic/versions/abba1ae0edb3_store_avatar_legacy_id_in_the_contact_.py

@@ -37,12 +37,13 @@ def upgrade() -> None:
 
     with op.batch_alter_table("room", schema=None) as batch_op:
         batch_op.add_column(sa.Column("avatar_legacy_id", sa.String(), nullable=True))
-        batch_op.create_unique_constraint(
-            "uq_room_user_account_id_jid", ["user_account_id", "jid"]
-        )
-        batch_op.create_unique_constraint(
-            "uq_room_user_account_id_legacy_id", ["user_account_id", "legacy_id"]
-        )
+        if op.get_bind().engine.name != "postgresql":
+            batch_op.create_unique_constraint(
+                "uq_room_user_account_id_jid", ["user_account_id", "jid"]
+            )
+            batch_op.create_unique_constraint(
+                "uq_room_user_account_id_legacy_id", ["user_account_id", "legacy_id"]
+            )
 
     for room_pk, avatar_legacy_id in room_avatars:
         conn.execute(

{slidge-0.2.0b0 → slidge-0.2.0b1}/slidge/db/alembic/versions/b64b1a793483_add_source_and_legacy_id_for_archived_.py

@@ -24,6 +24,10 @@ def upgrade() -> None:
     # since we don't want source to be nullable, we drop all rows first.
     # This is what you get by using alpha versions!
     op.execute(sa.delete(ArchivedMessage))
+
+    if op.get_bind().engine.name == "postgresql":
+        op.execute("CREATE TYPE archivedmessagesource AS ENUM ('LIVE', 'BACKFILL')")
+
     # ### commands auto generated by Alembic - please adjust! ###
 
     with op.batch_alter_table("mam", schema=None) as batch_op:

{slidge-0.2.0b0 → slidge-0.2.0b1}/slidge/db/models.py

@@ -317,7 +317,7 @@ class LegacyIdsMulti(Base):
 
     legacy_id: Mapped[str] = mapped_column(nullable=False)
     xmpp_ids: Mapped[list["XmppIdsMulti"]] = relationship(
-        back_populates="legacy_ids_multi"
+        back_populates="legacy_ids_multi", cascade="all, delete-orphan"
     )
 
 

{slidge-0.2.0b0 → slidge-0.2.0b1}/slidge/util/util.py

@@ -9,6 +9,13 @@ from pathlib import Path
 from time import time
 from typing import TYPE_CHECKING, Callable, NamedTuple, Optional, Type, TypeVar
 
+try:
+    import emoji
+except ImportError:
+    EMOJI_LIB_AVAILABLE = False
+else:
+    EMOJI_LIB_AVAILABLE = True
+
 from .types import Mention, ResourceDict
 
 if TYPE_CHECKING:
@@ -318,3 +325,14 @@ def timeit(func):
         return r
 
     return wrapped
+
+
+def strip_leading_emoji(text: str) -> str:
+    if not EMOJI_LIB_AVAILABLE:
+        return text
+    words = text.split(" ")
+    # is_emoji returns False for 🛷️ for obscure reasons,
+    # purely_emoji seems better
+    if len(words) > 1 and emoji.purely_emoji(words[0]):
+        return " ".join(words[1:])
+    return text

slidge-0.2.0b0/slidge/command/categories.py

@@ -1,3 +0,0 @@
-ADMINISTRATION = "🛷️ Slidge administration"
-CONTACTS = "👤 Contacts"
-GROUPS = "👥 Groups"

{slidge-0.2.0b0 → slidge-0.2.0b1}/slidge/db/store.py

@@ -1001,9 +1001,9 @@ class ParticipantStore(EngineMixin):
     def __init__(self, *a, **kw):
         super().__init__(*a, **kw)
         with self.session() as session:
-            session.execute(delete(Participant))
-            session.execute(delete(Hat))
             session.execute(delete(participant_hats))
+            session.execute(delete(Hat))
+            session.execute(delete(Participant))
             session.commit()
 
     def add(self, room_pk: int, nickname: str) -> int: