slidge 0.2.11__py3-none-any.whl → 0.3.0__py3-none-any.whl

slidge/main.py

@@ -17,6 +17,7 @@ import asyncio
 import importlib
 import inspect
 import logging
+import logging.config
 import os
 import re
 import signal
@@ -27,7 +28,6 @@ import configargparse
 import slidge
 from slidge import BaseGateway
 from slidge.core import config
-from slidge.core.pubsub import PepAvatar, PepNick
 from slidge.db import SlidgeStore
 from slidge.db.avatar import avatar_cache
 from slidge.db.meta import get_engine
@@ -36,15 +36,18 @@ from slidge.util.conf import ConfigModule
 
 
 class MainConfig(ConfigModule):
-    def update_dynamic_defaults(self, args):
+    def update_dynamic_defaults(self, args: configargparse.Namespace) -> None:
         # 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.log_config:
+            logging.config.fileConfig(args.log_config)
+        else:
+            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)
@@ -60,7 +63,7 @@ class SigTermInterrupt(Exception):
     pass
 
 
-def get_configurator(from_entrypoint: bool = False):
+def get_configurator(from_entrypoint: bool = False) -> MainConfig:
     p = configargparse.ArgumentParser(
         default_config_files=os.getenv(
             "SLIDGE_CONF_DIR", "/etc/slidge/conf.d/*.conf"
@@ -74,10 +77,16 @@ def get_configurator(from_entrypoint: bool = False):
         env_var="SLIDGE_CONFIG",
         is_config_file=True,
     )
+    p.add_argument(
+        "--log-config",
+        help="Path to a INI config file to personalise logging output. Refer to "
+        "<https://docs.python.org/3/library/logging.config.html#configuration-file-format> "
+        "for details.",
+    )
     p.add_argument(
         "-q",
         "--quiet",
-        help="loglevel=WARNING",
+        help="loglevel=WARNING (unused if --log-config is specified)",
         action="store_const",
         dest="loglevel",
         const=logging.WARNING,
@@ -87,7 +96,7 @@ def get_configurator(from_entrypoint: bool = False):
     p.add_argument(
         "-d",
         "--debug",
-        help="loglevel=DEBUG",
+        help="loglevel=DEBUG (unused if --log-config is specified)",
         action="store_const",
         dest="loglevel",
         const=logging.DEBUG,
@@ -104,11 +113,11 @@ def get_configurator(from_entrypoint: bool = False):
     return configurator
 
 
-def get_parser():
+def get_parser() -> configargparse.ArgumentParser:
     return get_configurator().parser
 
 
-def configure(from_entrypoint: bool):
+def configure(from_entrypoint: bool) -> list[str]:
     configurator = get_configurator(from_entrypoint)
     args, unknown_argv = configurator.set_conf()
 
@@ -121,7 +130,7 @@ def configure(from_entrypoint: bool):
     return unknown_argv
 
 
-def handle_sigterm(_signum, _frame):
+def handle_sigterm(_signum: int, _frame) -> None:
     logging.info("Caught SIGTERM")
     raise SigTermInterrupt
 
@@ -157,22 +166,25 @@ def main(module_name: str | None = None) -> None:
             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)
+        _, unknown_argv = ConfigModule(plugin_config_obj).set_conf(unknown_argv)
+
+    if unknown_argv:
+        logging.error(
+            f"These config options have not been recognized and ignored: {unknown_argv}"
+        )
 
     migrate()
 
-    store = SlidgeStore(get_engine(config.DB_URL))
+    store = SlidgeStore(
+        get_engine(
+            config.DB_URL, echo=logging.getLogger().isEnabledFor(level=logging.DEBUG)
+        )
+    )
     BaseGateway.store = store
     gateway: BaseGateway = BaseGateway.get_unique_subclass()()
     avatar_cache.store = gateway.store.avatars
     avatar_cache.set_dir(config.HOME_DIR / "slidge_avatars_v3")
 
-    PepAvatar.store = gateway.store
-    PepNick.contact_store = gateway.store.contacts
-
     gateway.connect()
 
     return_code = 0

slidge/migration.py

@@ -1,23 +1,10 @@
 import logging
-import shutil
 import sys
+import traceback
 from pathlib import Path
 
 from alembic import command
 from alembic.config import Config
-from slixmpp import JID
-
-from .core import config
-from .db.meta import get_engine
-from .db.models import GatewayUser
-from .db.store import SlidgeStore
-
-
-def remove_avatar_cache_v1():
-    old_dir = config.HOME_DIR / "slidge_avatars"
-    if old_dir.exists():
-        log.info("Avatar cache dir v1 found, clearing it.")
-        shutil.rmtree(old_dir)
 
 
 def get_alembic_cfg() -> Config:
@@ -30,27 +17,28 @@ def get_alembic_cfg() -> Config:
     return alembic_cfg
 
 
-def remove_resource_parts_from_users() -> None:
-    with SlidgeStore(get_engine(config.DB_URL)).session() as orm:
-        for user in orm.query(GatewayUser).all():
-            if user.jid.resource:
-                user.jid = JID(user.jid.bare)
-                orm.add(user)
-        orm.commit()
-
-
 def migrate() -> None:
-    remove_avatar_cache_v1()
-    command.upgrade(get_alembic_cfg(), "head")
-    remove_resource_parts_from_users()
-
-
-def main():
+    try:
+        command.upgrade(get_alembic_cfg(), "head")
+    except Exception as e:
+        traceback.print_exception(e)
+        print(
+            "Something went wrong during the migration. "
+            "This is expected if you upgrade from slidge 0.2, in this case you need to start from a fresh database."
+        )
+        exit(1)
+
+
+def main() -> None:
     """
     Updates the (dev) database in ./dev/slidge.sqlite and generates a revision
 
     Usage: python -m slidge.migration "Revision message blah blah blah"
     """
+    dev_db = Path(".") / "dev" / "slidge.sqlite"
+    if dev_db.exists():
+        # always start from a clean state
+        dev_db.unlink()
     alembic_cfg = get_alembic_cfg()
     command.upgrade(alembic_cfg, "head")
     command.revision(alembic_cfg, sys.argv[1], autogenerate=True)

slidge/slixfix/__init__.py

@@ -7,11 +7,13 @@ import uuid
 
 import slixmpp.plugins
 import slixmpp.stanza.roster
-from slixmpp import Message
+from slixmpp import Message, register_stanza_plugin
 from slixmpp.exceptions import IqError
 from slixmpp.plugins.xep_0050 import XEP_0050, Command
 from slixmpp.plugins.xep_0356.permissions import IqPermission
 from slixmpp.plugins.xep_0356.privilege import XEP_0356
+from slixmpp.plugins.xep_0385.sims import XEP_0385
+from slixmpp.plugins.xep_0385.sims import stanza as stanza_sims
 from slixmpp.plugins.xep_0469.stanza import NS as PINNED_NS
 from slixmpp.plugins.xep_0469.stanza import Pinned
 from slixmpp.xmlstream import StanzaBase
@@ -25,7 +27,21 @@ from . import (
 )
 
 
-def set_pinned(self, val: bool):
+def plugin_init(self):
+    register_stanza_plugin(self.xmpp["xep_0372"].stanza.Reference, stanza_sims.Sims)
+    register_stanza_plugin(Message, stanza_sims.Sims)
+
+    register_stanza_plugin(stanza_sims.Sims, stanza_sims.Sources)
+    register_stanza_plugin(stanza_sims.Sims, self.xmpp["xep_0234"].stanza.File)
+    register_stanza_plugin(
+        stanza_sims.Sources, self.xmpp["xep_0372"].stanza.Reference, iterable=True
+    )
+
+
+XEP_0385.plugin_init = plugin_init
+
+
+def set_pinned(self, val: bool) -> None:
     extensions = self.parent()
     if val:
         extensions.enable("pinned")
@@ -36,7 +52,7 @@ def set_pinned(self, val: bool):
 Pinned.set_pinned = set_pinned
 
 
-def session_bind(self, jid):
+def session_bind(self, jid) -> None:
     self.xmpp["xep_0030"].add_feature(Command.namespace)
     # awful hack to for the disco items: we need to comment this line
     # related issue: https://todo.sr.ht/~nicoco/slidge/131
@@ -46,7 +62,7 @@ def session_bind(self, jid):
 XEP_0050.session_bind = session_bind  # type:ignore
 
 
-def reply(self, body=None, clear=True):
+def reply(self, body=None, clear: bool = True):
     """
     Overrides slixmpp's Message.reply(), since it strips to sender's resource
     for mtype=groupchat, and we do not want that, because when we raise an XMPPError,

slidge/slixfix/delivery_receipt.py

@@ -15,10 +15,10 @@ if TYPE_CHECKING:
 
 
 class DeliveryReceipt:
-    def __init__(self, xmpp: "BaseGateway"):
+    def __init__(self, xmpp: "BaseGateway") -> None:
         self.xmpp = xmpp
 
-    def ack(self, msg: Message):
+    def ack(self, msg: Message) -> None:
         """
         Send a XEP-0184 (delivery receipt) in response to a message,
         if appropriate.
@@ -30,7 +30,9 @@ class DeliveryReceipt:
         ack = self.make_ack(msg["id"], msg["to"], msg["from"].bare, msg["type"])
         ack.send()
 
-    def make_ack(self, msg_id: str, mfrom: JID, mto: JID, mtype: MessageTypes = "chat"):
+    def make_ack(
+        self, msg_id: str, mfrom: JID, mto: JID, mtype: MessageTypes = "chat"
+    ) -> Message:
         ack = self.xmpp.Message()
         ack["type"] = mtype
         ack["to"] = mto
@@ -38,7 +40,7 @@ class DeliveryReceipt:
         ack["receipt"] = msg_id
         return ack
 
-    def requires_receipt(self, msg: Message):
+    def requires_receipt(self, msg: Message) -> bool:
         """
         Check if a message is eligible for a delivery receipt.
 

slidge/slixfix/link_preview/link_preview.py

@@ -13,5 +13,5 @@ class LinkPreview(BasePlugin):
     dependencies = set()
     stanza = stanza
 
-    def plugin_init(self):
+    def plugin_init(self) -> None:
         stanza.register_plugin()

slidge/slixfix/link_preview/stanza.py

@@ -93,7 +93,7 @@ class SiteName(OpenGraphMixin):
     name = plugin_attrib = "site_name"
 
 
-def register_plugin():
+def register_plugin() -> None:
     for plugin in Title, Description, Url, Image, Type_, SiteName:
         register_stanza_plugin(plugin, Title)
     register_stanza_plugin(Message, LinkPreview, iterable=True)

slidge/slixfix/roster.py

@@ -12,7 +12,7 @@ class YesSet(set):
     A pseudo-set which always test True for membership
     """
 
-    def __contains__(self, item):
+    def __contains__(self, item) -> bool:
         log.debug("Test in")
         return True
 
@@ -27,7 +27,7 @@ class RosterBackend:
     This is rudimentary but the only sane way I could come up with so far.
     """
 
-    def __init__(self, xmpp: "BaseGateway"):
+    def __init__(self, xmpp: "BaseGateway") -> None:
         self.xmpp = xmpp
 
     @staticmethod
@@ -35,14 +35,12 @@ class RosterBackend:
         return YesSet()
 
     @staticmethod
-    def save(_owner_jid, _jid, _item_state, _db_state):
+    def save(_owner_jid, _jid, _item_state, _db_state) -> None:
         pass
 
     def load(self, _owner_jid, jid, _db_state):
-        log.debug("Load %s", jid)
-        user = self.xmpp.store.users.get(JID(jid))
-        log.debug("User %s", user)
-        if user is None:
+        session = self.xmpp.get_session_from_jid(JID(jid))
+        if session is None:
             return {
                 "name": "",
                 "groups": [],

slidge/slixfix/xep_0077/register.py

@@ -71,7 +71,7 @@ class XEP_0077(BasePlugin):
     }
     _user_store: dict[str, dict[str, str]]
 
-    def plugin_init(self):
+    def plugin_init(self) -> None:
         register_stanza_plugin(StreamFeatures, RegisterFeature)
         register_stanza_plugin(Iq, Register)
 
@@ -103,7 +103,7 @@ class XEP_0077(BasePlugin):
 
         self.xmpp.add_event_handler("connected", self._force_registration)
 
-    def plugin_end(self):
+    def plugin_end(self) -> None:
         if not self.xmpp.is_component:
             self.xmpp.unregister_feature("register", self.order)
 
@@ -136,12 +136,12 @@ class XEP_0077(BasePlugin):
         reply.set_payload(reg.xml)
         return reply
 
-    def _user_validate(self, _jid, _node, ifrom, registration):
+    def _user_validate(self, _jid, _node, ifrom, registration) -> None:
         self._user_store[ifrom.bare] = {
             key: registration[key] for key in self.form_fields
         }
 
-    def _user_modify(self, _jid, _node, ifrom, registration):
+    def _user_modify(self, _jid, _node, ifrom, registration) -> None:
         self._user_store[ifrom.bare] = {
             key: registration[key] for key in self.form_fields
         }
@@ -212,11 +212,11 @@ class XEP_0077(BasePlugin):
             else:
                 self.xmpp.event("user_modify", iq)
 
-    async def _send_form(self, iq):
+    async def _send_form(self, iq) -> None:
         reply = await self.api["make_registration_form"](None, None, iq["from"], iq)
         reply.send()
 
-    def _force_registration(self, _event):
+    def _force_registration(self, _event) -> None:
         if self.force_registration:
             self.xmpp.add_filter("in", self._force_stream_feature)
 
@@ -233,7 +233,7 @@ class XEP_0077(BasePlugin):
                 self.xmpp.del_filter("in", self._force_stream_feature)
         return stanza_
 
-    async def _handle_register_feature(self, _features):
+    async def _handle_register_feature(self, _features) -> bool:
         if "mechanisms" in self.xmpp.features:
             # We have already logged in with an account
             return False
@@ -276,7 +276,7 @@ class XEP_0077(BasePlugin):
         return iq.send(timeout=timeout, callback=callback)
 
 
-def _send_error(iq, code, error_type, name, text=""):
+def _send_error(iq, code, error_type, name, text: str="") -> None:
     # It would be nice to raise XMPPError but the iq payload
     # should include the register info
     reply = iq.reply()

slidge/slixfix/xep_0077/stanza.py

@@ -57,27 +57,27 @@ class Register(ElementBase):
         "key",
     }
 
-    def get_registered(self):
+    def get_registered(self) -> bool:
         present = self.xml.find("{%s}registered" % self.namespace)
         return present is not None
 
-    def get_remove(self):
+    def get_remove(self) -> bool:
         present = self.xml.find("{%s}remove" % self.namespace)
         return present is not None
 
-    def set_registered(self, value):
+    def set_registered(self, value) -> None:
         if value:
             self.add_field("registered")
         else:
             del self["registered"]
 
-    def set_remove(self, value):
+    def set_remove(self, value) -> None:
         if value:
             self.add_field("remove")
         else:
             del self["remove"]
 
-    def add_field(self, value):
+    def add_field(self, value: str) -> None:
         self._set_sub_text(value, "", keep=True)
 
     def get_fields(self):
@@ -87,12 +87,12 @@ class Register(ElementBase):
                 fields.add(field)
         return fields
 
-    def set_fields(self, fields):
+    def set_fields(self, fields) -> None:
         del self["fields"]
         for field in fields:
             self._set_sub_text(field, "", keep=True)
 
-    def del_fields(self):
+    def del_fields(self) -> None:
         for field in self.form_fields:
             self._del_sub(field)
 

slidge/slixfix/xep_0100/gateway.py

@@ -27,7 +27,7 @@ class XEP_0100(BasePlugin):
         "needs_registration": True,
     }
 
-    def plugin_init(self):
+    def plugin_init(self) -> None:
         if not self.xmpp.is_component:
             log.error("Only components can be gateways, aborting plugin load")
             return
@@ -50,7 +50,7 @@ class XEP_0100(BasePlugin):
 
         register_stanza_plugin(Iq, stanza.Gateway)
 
-    def plugin_end(self):
+    def plugin_end(self) -> None:
         if not self.xmpp.is_component:
             self.xmpp.remove_event_handler("user_register", self.on_user_register)
             self.xmpp.remove_event_handler("user_unregister", self.on_user_unregister)
@@ -63,18 +63,16 @@ class XEP_0100(BasePlugin):
     async def get_user(self, stanza):
         return await self.xmpp["xep_0077"].api["user_get"](None, None, None, stanza)
 
-    async def on_user_unregister(self, iq: Iq):
+    async def on_user_unregister(self, iq: Iq) -> None:
         self.xmpp.send_presence(pto=iq.get_from().bare, ptype="unavailable")
         self.xmpp.send_presence(pto=iq.get_from().bare, ptype="unsubscribe")
         self.xmpp.send_presence(pto=iq.get_from().bare, ptype="unsubscribed")
 
-    async def on_user_register(self, iq: Iq):
+    async def on_user_register(self, iq: Iq) -> None:
         self.xmpp.client_roster[iq.get_from()].load()
         await self.add_component_to_roster(jid=iq.get_from())
 
-    async def add_component_to_roster(self, jid: JID):
-        if config.NO_ROSTER_PUSH:
-            return
+    async def add_component_to_roster(self, jid: JID) -> None:
         items = {
             self.xmpp.boundjid.bare: {
                 "name": self.component_name,
@@ -85,17 +83,18 @@ class XEP_0100(BasePlugin):
         try:
             await self._set_roster(jid, items)
         except PermissionError:
+            from slidge import __version__
+
             warnings.warn(
-                "Slidge does not have the privilege to manage users' rosters. "
-                "Users should add the slidge component to their rosters manually."
+                "Slidge does not have the privilege to manage rosters. See "
+                f"https://slidge.im/docs/slidge/{__version__}/admin/privilege.html"
             )
-            if config.ROSTER_PUSH_PRESENCE_SUBSCRIPTION_REQUEST_FALLBACK:
-                self.xmpp.send_presence(ptype="subscribe", pto=jid.bare)
+            self.xmpp.send_presence(ptype="subscribe", pto=jid.bare)
 
-    async def _set_roster(self, jid, items):
+    async def _set_roster(self, jid, items) -> None:
         await self.xmpp["xep_0356"].set_roster(jid=jid.bare, roster_items=items)
 
-    def on_presence_unsubscribe(self, p: Presence):
+    def on_presence_unsubscribe(self, p: Presence) -> None:
         if p.get_to() == self.xmpp.boundjid.bare:
             log.debug("REMOVE: Our roster: %s", self.xmpp.client_roster)
             self.xmpp["xep_0077"].api["user_remove"](None, None, p["from"], p)

slidge/slixfix/xep_0153/vcard_avatar.py

@@ -10,5 +10,5 @@ class XEP_0153(BasePlugin):
     dependencies = {"xep_0054"}
     stanza = stanza
 
-    def plugin_init(self):
+    def plugin_init(self) -> None:
         register_stanza_plugin(Presence, VCardTempUpdate)

slidge/slixfix/xep_0292/vcard4.py

@@ -1,5 +1,6 @@
+from slixmpp import register_stanza_plugin, __version_info__
 from slixmpp.plugins.base import BasePlugin, register_plugin
-from slixmpp.plugins.xep_0292.stanza import NS
+from slixmpp.plugins.xep_0292.stanza import NS, _VCardTextElementBase, VCard4
 
 
 class VCard4Provider(BasePlugin):
@@ -7,8 +8,17 @@ class VCard4Provider(BasePlugin):
     description = "VCard4 Provider"
     dependencies = {"xep_0030"}
 
-    def plugin_init(self):
+    def plugin_init(self) -> None:
         self.xmpp.plugin["xep_0030"].add_feature(NS)
 
 
+
+
 register_plugin(VCard4Provider)
+
+
+if __version_info__[0] <= 1 and __version_info__[1] <= 11:
+    class Pronouns(_VCardTextElementBase):
+        name = plugin_attrib = "pronouns"
+
+    register_stanza_plugin(VCard4, Pronouns)

slidge/util/archive_msg.py

@@ -5,10 +5,14 @@ from uuid import uuid4
 from xml.etree import ElementTree as ET
 
 from slixmpp import Message
-from slixmpp.plugins.xep_0297 import Forwarded
+from slixmpp.plugins.xep_0297.stanza import Forwarded
 
 
-def fix_namespaces(xml, old="{jabber:component:accept}", new="{jabber:client}"):
+def fix_namespaces(
+    xml: ET.Element,
+    old: str = "{jabber:component:accept}",
+    new: str = "{jabber:client}",
+) -> None:
     """
     Hack to fix namespaces between jabber:component and jabber:client
 
@@ -24,7 +28,9 @@ def fix_namespaces(xml, old="{jabber:component:accept}", new="{jabber:client}"):
 
 
 class HistoryMessage:
-    def __init__(self, stanza: Union[Message, str], when: Optional[datetime] = None):
+    def __init__(
+        self, stanza: Union[Message, str], when: Optional[datetime] = None
+    ) -> None:
         if isinstance(stanza, str):
             from_db = True
             stanza = Message(xml=ET.fromstring(stanza))
@@ -48,14 +54,14 @@ class HistoryMessage:
         self.stanza: Message = stanza
 
     @property
-    def stanza_component_ns(self):
+    def stanza_component_ns(self) -> Message:
         stanza = copy(self.stanza)
         fix_namespaces(
             stanza.xml, old="{jabber:client}", new="{jabber:component:accept}"
         )
         return stanza
 
-    def forwarded(self):
+    def forwarded(self) -> Forwarded:
         forwarded = Forwarded()
         forwarded["delay"]["stamp"] = self.when
         forwarded.append(self.stanza)