slidge 0.1.3__py3-none-any.whl → 0.2.0a1__py3-none-any.whl

slidge/__init__.py

@@ -13,13 +13,12 @@ from .contact import LegacyContact, LegacyRoster  # noqa: F401
 from .core import config as global_config  # noqa: F401
 from .core.gateway import BaseGateway  # noqa: F401
 from .core.session import BaseSession  # noqa: F401
+from .db import GatewayUser  # noqa: F401
 from .group import LegacyBookmarks, LegacyMUC, LegacyParticipant  # noqa: F401
-from .util.db import GatewayUser, user_store  # noqa: F401
+from .main import main as main_func
 from .util.types import MucType  # noqa: F401
 from .util.util import addLoggingLevel
 
-from .__main__ import main  # isort: skip
-
 
 def entrypoint(module_name: str) -> None:
     """
@@ -29,7 +28,7 @@ def entrypoint(module_name: str) -> None:
     :param module_name: An importable :term:`Legacy Module`.
     """
     sys.argv.extend(["--legacy", module_name])
-    main()
+    main_func()
 
 
 def formatwarning(message, category, filename, lineno, line=""):
@@ -54,7 +53,6 @@ __all__ = [
     # "FormField",
     # "SearchResult",
     "entrypoint",
-    "user_store",
     "global_config",
 ]
 

slidge/__main__.py

@@ -1,198 +1,4 @@
-"""
-Slidge can be configured via CLI args, environment variables and/or INI files.
-
-To use env vars, use this convention: ``--home-dir`` becomes ``HOME_DIR``.
-
-Everything in ``/etc/slidge/conf.d/*`` is automatically used.
-To use a plugin-specific INI file, put it in another dir,
-and launch slidge with ``-c /path/to/plugin-specific.conf``.
-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
-"""
-
-import asyncio
-import importlib
-import logging
-import os
-import signal
-from pathlib import Path
-
-import configargparse
-
-from slidge import BaseGateway
-from slidge.core import config
-from slidge.core.cache import avatar_cache
-from slidge.migration import migrate
-from slidge.util.conf import ConfigModule
-from slidge.util.db import user_store
-from slidge.util.util import get_version  # noqa: F401
-
-
-class MainConfig(ConfigModule):
-    def update_dynamic_defaults(self, args):
-        # force=True is needed in case we call a logger before this is reached,
-        # or basicConfig has no effect
-        logging.basicConfig(
-            level=args.loglevel,
-            filename=args.log_file,
-            force=True,
-            format=args.log_format,
-        )
-
-        if args.home_dir is None:
-            args.home_dir = Path("/var/lib/slidge") / str(args.jid)
-
-        if args.user_jid_validator is None:
-            args.user_jid_validator = ".*@" + args.server
-
-
-class SigTermInterrupt(Exception):
-    pass
-
-
-def get_configurator():
-    p = configargparse.ArgumentParser(
-        default_config_files=os.getenv(
-            "SLIDGE_CONF_DIR", "/etc/slidge/conf.d/*.conf"
-        ).split(":"),
-        description=__doc__,
-    )
-    p.add_argument(
-        "-c",
-        "--config",
-        help="Path to a INI config file.",
-        env_var="SLIDGE_CONFIG",
-        is_config_file=True,
-    )
-    p.add_argument(
-        "-q",
-        "--quiet",
-        help="loglevel=WARNING",
-        action="store_const",
-        dest="loglevel",
-        const=logging.WARNING,
-        default=logging.INFO,
-        env_var="SLIDGE_QUIET",
-    )
-    p.add_argument(
-        "-d",
-        "--debug",
-        help="loglevel=DEBUG",
-        action="store_const",
-        dest="loglevel",
-        const=logging.DEBUG,
-        env_var="SLIDGE_DEBUG",
-    )
-    p.add_argument(
-        "--version",
-        action="version",
-        version=f"%(prog)s {__version__}",
-    )
-    configurator = MainConfig(config, p)
-    return configurator
-
-
-def get_parser():
-    return get_configurator().parser
-
-
-def configure():
-    configurator = get_configurator()
-    args, unknown_argv = configurator.set_conf()
-
-    if not (h := config.HOME_DIR).exists():
-        logging.info("Creating directory '%s'", h)
-        h.mkdir()
-
-    db_file = config.HOME_DIR / "slidge.db"
-    user_store.set_file(db_file, args.secret_key)
-
-    avatar_cache.set_dir(h / "slidge_avatars_v2")
-
-    config.UPLOAD_REQUESTER = config.UPLOAD_REQUESTER or config.JID.bare
-
-    return unknown_argv
-
-
-def handle_sigterm(_signum, _frame):
-    logging.info("Caught SIGTERM")
-    raise SigTermInterrupt
-
-
-def main():
-    signal.signal(signal.SIGTERM, handle_sigterm)
-
-    unknown_argv = configure()
-    logging.info("Starting slidge version %s", __version__)
-
-    legacy_module = importlib.import_module(config.LEGACY_MODULE)
-    logging.debug("Legacy module: %s", dir(legacy_module))
-    logging.info(
-        "Starting legacy module: '%s' version %s",
-        config.LEGACY_MODULE,
-        getattr(legacy_module, "__version__", "No version"),
-    )
-
-    if plugin_config_obj := getattr(
-        legacy_module, "config", getattr(legacy_module, "Config", None)
-    ):
-        logging.debug("Found a config object in plugin: %r", plugin_config_obj)
-        ConfigModule.ENV_VAR_PREFIX += (
-            f"_{config.LEGACY_MODULE.split('.')[-1].upper()}_"
-        )
-        logging.debug("Env var prefix: %s", ConfigModule.ENV_VAR_PREFIX)
-        ConfigModule(plugin_config_obj).set_conf(unknown_argv)
-    else:
-        if unknown_argv:
-            raise RuntimeError("Some arguments have not been recognized", unknown_argv)
-
-    migrate()
-
-    gateway: BaseGateway = BaseGateway.get_unique_subclass()()
-    avatar_cache.http = gateway.http
-    gateway.connect()
-
-    return_code = 0
-    try:
-        gateway.loop.run_forever()
-    except KeyboardInterrupt:
-        logging.debug("Received SIGINT")
-    except SigTermInterrupt:
-        logging.debug("Received SIGTERM")
-    except SystemExit as e:
-        return_code = e.code  # type: ignore
-        logging.debug("Exit called")
-    except Exception as e:
-        return_code = 2
-        logging.exception("Exception in __main__")
-        logging.exception(e)
-    finally:
-        if gateway.has_crashed:
-            if return_code != 0:
-                logging.warning("Return code has been set twice. Please report this.")
-            return_code = 3
-        if gateway.is_connected():
-            logging.debug("Gateway is connected, cleaning up")
-            gateway.loop.run_until_complete(asyncio.gather(*gateway.shutdown()))
-            gateway.disconnect()
-            gateway.loop.run_until_complete(gateway.disconnected)
-        else:
-            logging.debug("Gateway is not connected, no need to clean up")
-        user_store.close()
-        avatar_cache.close()
-        gateway.loop.run_until_complete(gateway.http.close())
-        logging.info("Successful clean shut down")
-    logging.debug("Exiting with code %s", return_code)
-    exit(return_code)
-
-
-# this should be modified before publish, but if someone cloned from the repo,
-# it can help
-__version__ = get_version()
-
-
 if __name__ == "__main__":
+    from slidge.main import main
+
     main()

slidge/__version__.py

@@ -0,0 +1,5 @@
+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.0alpha1"

slidge/command/adhoc.py

@@ -48,7 +48,10 @@ class AdhocProvider:
     async def __handle_category_list(
         self, category: str, iq: Iq, adhoc_session: AdhocSessionType
     ) -> AdhocSessionType:
-        session = self.xmpp.get_session_from_stanza(iq)
+        try:
+            session = self.xmpp.get_session_from_stanza(iq)
+        except XMPPError:
+            session = None
         commands = []
         for command in self._categories[category]:
             try:
@@ -56,6 +59,10 @@ class AdhocProvider:
             except XMPPError:
                 continue
             commands.append(command)
+        if len(commands) == 0:
+            raise XMPPError(
+                "not-authorized", "There is no command you can run in this category"
+            )
         return await self.__handle_result(
             session,
             Form(

slidge/command/admin.py

@@ -7,7 +7,6 @@ from typing import Any, Optional
 from slixmpp import JID
 from slixmpp.exceptions import XMPPError
 
-from ..util.db import user_store
 from ..util.types import AnyBaseSession
 from .base import (
     Command,
@@ -33,13 +32,13 @@ class ListUsers(AdminCommand):
 
     async def run(self, _session, _ifrom, *_):
         items = []
-        for u in user_store.get_all():
+        for u in self.xmpp.store.users.get_all():
             d = u.registration_date
             if d is None:
                 joined = ""
             else:
                 joined = d.isoformat(timespec="seconds")
-            items.append({"jid": u.bare_jid, "joined": joined})
+            items.append({"jid": u.jid.bare, "joined": joined})
         return TableResult(
             description="List of registered users",
             fields=[FormField("jid", type="jid-single"), FormField("joined")],
@@ -54,9 +53,9 @@ class SlidgeInfo(AdminCommand):
     ACCESS = CommandAccess.ANY
 
     async def run(self, _session, _ifrom, *_):
-        from ..__main__ import __version__
+        from slidge.__version__ import __version__
 
-        start = self.xmpp.datetime_started
+        start = self.xmpp.datetime_started  # type:ignore
         uptime = datetime.now() - start
 
         if uptime.days:
@@ -114,7 +113,7 @@ class DeleteUser(AdminCommand):
         self, form_values: FormValues, _session: AnyBaseSession, _ifrom: JID
     ) -> Confirmation:
         jid: JID = form_values.get("jid")  # type:ignore
-        user = user_store.get_by_jid(jid)
+        user = self.xmpp.store.users.get(jid)
         if user is None:
             raise XMPPError("item-not-found", text=f"There is no user '{jid}'")
 
@@ -127,7 +126,7 @@ class DeleteUser(AdminCommand):
     async def finish(
         self, _session: Optional[AnyBaseSession], _ifrom: JID, jid: JID
     ) -> None:
-        user = user_store.get_by_jid(jid)
+        user = self.xmpp.store.users.get(jid)
         if user is None:
             raise XMPPError("bad-request", f"{jid} has no account here!")
         await self.xmpp.unregister_user(user)

slidge/command/base.py

@@ -23,7 +23,6 @@ from slixmpp.plugins.xep_0004 import (
 from slixmpp.types import JidStr
 
 from ..core import config
-from ..util.db import user_store
 from ..util.types import AnyBaseSession, FieldType
 
 if TYPE_CHECKING:
@@ -382,7 +381,7 @@ class Command(ABC):
         raise XMPPError("feature-not-implemented")
 
     def _get_session(self, jid: JID) -> Optional["BaseSession[Any, Any]"]:
-        user = user_store.get_by_jid(jid)
+        user = self.xmpp.store.users.get(jid)
         if user is None:
             return None
 

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,
@@ -76,7 +78,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 +92,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"],
@@ -129,7 +131,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 ""
         )
@@ -229,6 +230,39 @@ class CreateGroup(Command):
         )
 
 
+class Preferences(Command):
+    NAME = "⚙️ Preferences"
+    HELP = "Customize the gateway behaviour to your liking"
+    NODE = CHAT_COMMAND = "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)
+        return "Your preferences have been updated."
+
+
 class Unregister(Command):
     NAME = "❌ Unregister from the gateway"
     HELP = "Unregister from the gateway"
@@ -246,5 +280,50 @@ 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"
+    NODE = CHAT_COMMAND = "leave-group"
+    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",
+                    options=[{"label": g.name, "value": g.name} for g in 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)