slidge 0.1.2__py3-none-any.whl → 0.2.0__py3-none-any.whl

slidge/command/register.py

@@ -6,7 +6,6 @@ step for a JID to become a slidge :term:`User`.
 import asyncio
 import functools
 import tempfile
-from datetime import datetime
 from enum import IntEnum
 from typing import Any
 
@@ -15,8 +14,10 @@ from slixmpp import JID, Iq
 from slixmpp.exceptions import XMPPError
 
 from ..core import config
-from ..util.db import GatewayUser
+from ..db import GatewayUser
+from ..util.types import UserPreferences
 from .base import Command, CommandAccess, Form, FormField, FormValues
+from .user import Preferences
 
 
 class RegistrationType(IntEnum):
@@ -66,9 +67,12 @@ class Register(Command):
 
     SUCCESS_MESSAGE = "Success, welcome!"
 
-    def _finalize(self, user: GatewayUser):
-        user.commit()
-        self.xmpp.event("user_register", Iq(sfrom=user.jid))
+    def _finalize(
+        self, form_values: UserPreferences, _session, ifrom: JID, user: GatewayUser, *_
+    ) -> str:
+        user.preferences = form_values  # type: ignore
+        self.xmpp.store.users.update(user)
+        self.xmpp.event("user_register", Iq(sfrom=ifrom.bare))
         return self.SUCCESS_MESSAGE
 
     async def run(self, _session, _ifrom, *_):
@@ -82,26 +86,26 @@ class Register(Command):
     async def register(self, form_values: dict[str, Any], _session, ifrom: JID):
         two_fa_needed = True
         try:
-            await self.xmpp.user_prevalidate(ifrom, form_values)
+            data = await self.xmpp.user_prevalidate(ifrom, form_values)
         except ValueError as e:
             raise XMPPError("bad-request", str(e))
         except TwoFactorNotRequired:
+            data = None
             if self.xmpp.REGISTRATION_TYPE == RegistrationType.TWO_FACTOR_CODE:
                 two_fa_needed = False
             else:
                 raise
 
         user = GatewayUser(
-            bare_jid=ifrom.bare,
-            registration_form=form_values,
-            registration_date=datetime.now(),
+            jid=ifrom.bare,
+            legacy_module_data=form_values if data is None else data,
         )
 
         if self.xmpp.REGISTRATION_TYPE == RegistrationType.SINGLE_STEP_FORM or (
             self.xmpp.REGISTRATION_TYPE == RegistrationType.TWO_FACTOR_CODE
             and not two_fa_needed
         ):
-            return self._finalize(user)
+            return await self.preferences(user)
 
         if self.xmpp.REGISTRATION_TYPE == RegistrationType.TWO_FACTOR_CODE:
             return Form(
@@ -113,7 +117,7 @@ class Register(Command):
 
         elif self.xmpp.REGISTRATION_TYPE == RegistrationType.QRCODE:
             self.xmpp.qr_pending_registrations[  # type:ignore
-                user.bare_jid
+                user.jid.bare
             ] = (
                 self.xmpp.loop.create_future()
             )
@@ -159,13 +163,15 @@ class Register(Command):
         self, form_values: FormValues, _session, _ifrom, user: GatewayUser
     ):
         assert isinstance(form_values["code"], str)
-        await self.xmpp.validate_two_factor_code(user, form_values["code"])
-        return self._finalize(user)
+        data = await self.xmpp.validate_two_factor_code(user, form_values["code"])
+        if data is not None:
+            user.legacy_module_data.update(data)
+        return await self.preferences(user)
 
     async def qr(self, _form_values: FormValues, _session, _ifrom, user: GatewayUser):
         try:
-            await asyncio.wait_for(
-                self.xmpp.qr_pending_registrations[user.bare_jid],  # type:ignore
+            data = await asyncio.wait_for(
+                self.xmpp.qr_pending_registrations[user.jid.bare],  # type:ignore
                 config.QR_TIMEOUT,
             )
         except asyncio.TimeoutError:
@@ -176,4 +182,14 @@ class Register(Command):
                     "or you took too much time"
                 ),
             )
-        return self._finalize(user)
+        if data is not None:
+            user.legacy_module_data.update(data)
+        return await self.preferences(user)
+
+    async def preferences(self, user: GatewayUser) -> Form:
+        return Form(
+            title="Preferences",
+            instructions=Preferences.HELP,
+            fields=self.xmpp.PREFERENCES,
+            handler=functools.partial(self._finalize, user=user),  # type:ignore
+        )

slidge/command/user.py

@@ -1,10 +1,12 @@
 # Commands available to users
+from copy import deepcopy
 from typing import TYPE_CHECKING, Any, Optional, Union, cast
 
 from slixmpp import JID  # type:ignore[attr-defined]
 from slixmpp.exceptions import XMPPError
 
-from ..util.types import AnyBaseSession, LegacyGroupIdType
+from ..group.room import LegacyMUC
+from ..util.types import AnyBaseSession, LegacyGroupIdType, UserPreferences
 from .base import (
     Command,
     CommandAccess,
@@ -24,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
 
@@ -62,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
 
@@ -76,7 +79,7 @@ class SyncContacts(Command):
     async def sync(self, session: Optional[AnyBaseSession], _ifrom: JID) -> str:
         if session is None:
             raise RuntimeError
-        roster_iq = await self.xmpp["xep_0356"].get_roster(session.user.bare_jid)
+        roster_iq = await self.xmpp["xep_0356"].get_roster(session.user_jid.bare)
 
         contacts = session.contacts.known_contacts()
 
@@ -90,13 +93,13 @@ class SyncContacts(Command):
                 if contact is None:
                     if len(groups) == 1:
                         await self.xmpp["xep_0356"].set_roster(
-                            session.user.jid, {item["jid"]: {"subscription": "remove"}}
+                            session.user_jid, {item["jid"]: {"subscription": "remove"}}
                         )
                         removed += 1
                     else:
                         groups.remove(self.xmpp.ROSTER_GROUP)
                         await self.xmpp["xep_0356"].set_roster(
-                            session.user.jid,
+                            session.user_jid,
                             {
                                 item["jid"]: {
                                     "subscription": item["subscription"],
@@ -121,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
 
@@ -129,7 +133,6 @@ class ListContacts(Command):
         self, session: Optional[AnyBaseSession], _ifrom: JID, *_
     ) -> TableResult:
         assert session is not None
-        await session.contacts.fill()
         contacts = sorted(
             session.contacts, key=lambda c: c.name.casefold() if c.name else ""
         )
@@ -142,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
 
@@ -161,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
 
@@ -183,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
@@ -229,10 +235,47 @@ class CreateGroup(Command):
         )
 
 
+class Preferences(Command):
+    NAME = "⚙️ Preferences"
+    HELP = "Customize the gateway behaviour to your liking"
+    CHAT_COMMAND = "preferences"
+    NODE = "https://slidge.im/command/core/preferences"
+    ACCESS = CommandAccess.USER
+
+    async def run(
+        self, session: Optional[AnyBaseSession], _ifrom: JID, *_: Any
+    ) -> Form:
+        fields = deepcopy(self.xmpp.PREFERENCES)
+        assert session is not None
+        current = session.user.preferences
+        for field in fields:
+            field.value = current.get(field.var)  # type:ignore
+        return Form(
+            title="Preferences",
+            instructions=self.HELP,
+            fields=fields,
+            handler=self.finish,  # type:ignore
+        )
+
+    async def finish(
+        self, form_values: UserPreferences, session: Optional[AnyBaseSession], *_
+    ) -> str:
+        assert session is not None
+        user = session.user
+        user.preferences.update(form_values)  # type:ignore
+        self.xmpp.store.users.update(user)
+        if form_values["sync_avatar"]:
+            await self.xmpp.fetch_user_avatar(session)
+        else:
+            session.xmpp.store.users.set_avatar_hash(session.user_pk, None)
+        return "Your preferences have been updated."
+
+
 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(
@@ -246,5 +289,55 @@ class Unregister(Command):
 
     async def unregister(self, session: Optional[AnyBaseSession], _ifrom: JID) -> str:
         assert session is not None
-        await self.xmpp.unregister_user(session.user)
+        user = self.xmpp.store.users.get(session.user_jid)
+        assert user is not None
+        await self.xmpp.unregister_user(user)
         return "OK"
+
+
+class LeaveGroup(Command):
+    NAME = HELP = "❌ Leave a legacy group"
+    CHAT_COMMAND = "leave-group"
+    NODE = GROUPS.node + "/" + CHAT_COMMAND
+    ACCESS = CommandAccess.USER_LOGGED
+    CATEGORY = GROUPS
+
+    async def run(self, session, _ifrom, *_):
+        assert session is not None
+        await session.bookmarks.fill()
+        groups = sorted(session.bookmarks, key=lambda g: g.DISCO_NAME.casefold())
+        return Form(
+            title="Leave a group",
+            instructions="Select the group you want to leave",
+            fields=[
+                FormField(
+                    "group",
+                    "Group name",
+                    type="list-single",
+                    options=[
+                        {"label": g.name, "value": str(i)} for i, g in enumerate(groups)
+                    ],
+                )
+            ],
+            handler=self.confirm,  # type:ignore
+            handler_args=(groups,),
+        )
+
+    async def confirm(
+        self,
+        form_values: FormValues,
+        _session: AnyBaseSession,
+        _ifrom,
+        groups: list[LegacyMUC],
+    ):
+        group = groups[int(form_values["group"])]  # type:ignore
+        return Confirmation(
+            prompt=f"Are you sure you want to leave the group '{group.name}'?",
+            handler=self.finish,  # type:ignore
+            handler_args=(group,),
+        )
+
+    @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.")