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

slidge/core/session.py

@@ -18,11 +18,10 @@ from slixmpp.types import PresenceShows
 
 from ..command import SearchResult
 from ..contact import LegacyContact, LegacyRoster
+from ..db.models import GatewayUser
 from ..group.bookmarks import LegacyBookmarks
 from ..group.room import LegacyMUC
 from ..util import ABCSubclassableOnceAtMost
-from ..util.db import GatewayUser, user_store
-from ..util.sql import SQLBiDict
 from ..util.types import (
     LegacyGroupIdType,
     LegacyMessageType,
@@ -32,6 +31,7 @@ from ..util.types import (
     PseudoPresenceShow,
     RecipientType,
     ResourceDict,
+    Sticker,
 )
 from ..util.util import deprecated
 
@@ -74,8 +74,6 @@ class BaseSession(
     session-specific.
     """
 
-    http: aiohttp.ClientSession
-
     MESSAGE_IDS_ARE_THREAD_IDS = False
     """
     Set this to True if the legacy service uses message IDs as thread IDs,
@@ -92,16 +90,10 @@ class BaseSession(
     """
 
     def __init__(self, user: GatewayUser):
-        self.log = logging.getLogger(user.bare_jid)
+        self.log = logging.getLogger(user.jid.bare)
 
-        self.user = user
-        self.sent = SQLBiDict[LegacyMessageType, str](
-            "session_message_sent", "legacy_id", "xmpp_id", self.user
-        )
-        # message ids (*not* stanza-ids), needed for last msg correction
-        self.muc_sent_msg_ids = SQLBiDict[LegacyMessageType, str](
-            "session_message_sent_muc", "legacy_id", "xmpp_id", self.user
-        )
+        self.user_jid = user.jid
+        self.user_pk = user.id
 
         self.ignore_messages = set[str]()
 
@@ -113,28 +105,30 @@ class BaseSession(
             self
         )
 
-        self.http = self.xmpp.http
-
-        self.threads = SQLBiDict[str, LegacyThreadType](  # type:ignore
-            "session_thread_sent_muc", "legacy_id", "xmpp_id", self.user
-        )
         self.thread_creation_lock = asyncio.Lock()
 
         self.__cached_presence: Optional[CachedPresence] = None
 
-        self.avatar_hash: Optional[str] = None
-
         self.__tasks = set[asyncio.Task]()
 
+    @property
+    def user(self) -> GatewayUser:
+        return self.xmpp.store.users.get(self.user_jid)  # type:ignore
+
+    @property
+    def http(self) -> aiohttp.ClientSession:
+        return self.xmpp.http
+
     def __remove_task(self, fut):
         self.log.debug("Removing fut %s", fut)
         self.__tasks.remove(fut)
 
-    def create_task(self, coro) -> None:
+    def create_task(self, coro) -> asyncio.Task:
         task = self.xmpp.loop.create_task(coro)
         self.__tasks.add(task)
         self.log.debug("Creating task %s", task)
         task.add_done_callback(lambda _: self.__remove_task(task))
+        return task
 
     def cancel_all_tasks(self):
         for task in self.__tasks:
@@ -232,6 +226,31 @@ class BaseSession(
 
     send_file = deprecated("BaseSession.send_file", on_file)
 
+    async def on_sticker(
+        self,
+        chat: RecipientType,
+        sticker: Sticker,
+        *,
+        reply_to_msg_id: Optional[LegacyMessageType] = None,
+        reply_to_fallback_text: Optional[str] = None,
+        reply_to: Optional[Union["LegacyContact", "LegacyParticipant"]] = None,
+        thread: Optional[LegacyThreadType] = None,
+    ) -> Optional[LegacyMessageType]:
+        """
+        Triggered when the user sends a file using HTTP Upload (:xep:`0363`)
+
+        :param chat: See :meth:`.BaseSession.on_text`
+        :param sticker: The sticker sent by the user.
+        :param reply_to_msg_id: See :meth:`.BaseSession.on_text`
+        :param reply_to_fallback_text: See :meth:`.BaseSession.on_text`
+        :param reply_to: See :meth:`.BaseSession.on_text`
+        :param thread:
+
+        :return: An ID of some sort that can be used later to ack and mark the message
+            as read by the user
+        """
+        raise NotImplementedError
+
     async def on_active(
         self, chat: RecipientType, thread: Optional[LegacyThreadType] = None
     ):
@@ -488,6 +507,17 @@ class BaseSession(
         """
         await muc.on_set_affiliation(contact, "member", reason, None)
 
+    async def on_leave_group(self, muc_legacy_id: LegacyGroupIdType):
+        """
+        Triggered when the user leaves a group via the dedicated slidge command
+        or the :xep:`0077` ``<remove />`` mechanism.
+
+        This should be interpreted as definitely leaving the group.
+
+        :param muc_legacy_id: The legacy ID of the group to leave
+        """
+        raise NotImplementedError
+
     def __reset_ready(self):
         self.ready = self.xmpp.loop.create_future()
 
@@ -507,7 +537,7 @@ class BaseSession(
                 self.ready.set_result(True)
 
     def __repr__(self):
-        return f"<Session of {self.user}>"
+        return f"<Session of {self.user_jid}>"
 
     def shutdown(self) -> asyncio.Task:
         for c in self.contacts:
@@ -571,9 +601,9 @@ class BaseSession(
             log.debug("user not found", stack_info=True)
             raise XMPPError(text="User not found", condition="subscription-required")
 
-        session = _sessions.get(user)
+        session = _sessions.get(user.jid.bare)
         if session is None:
-            _sessions[user] = session = cls(user)
+            _sessions[user.jid.bare] = session = cls(user)
         return session
 
     @classmethod
@@ -590,7 +620,7 @@ class BaseSession(
         # :param s:
         # :return:
         # """
-        return cls._from_user_or_none(user_store.get_by_stanza(s))
+        return cls.from_jid(s.get_from())
 
     @classmethod
     def from_jid(cls, jid: JID) -> "BaseSession":
@@ -602,7 +632,11 @@ class BaseSession(
         # :param jid:
         # :return:
         # """
-        return cls._from_user_or_none(user_store.get_by_jid(jid))
+        session = _sessions.get(jid.bare)
+        if session is not None:
+            return session
+        user = cls.xmpp.store.users.get(jid)
+        return cls._from_user_or_none(user)
 
     @classmethod
     async def kill_by_jid(cls, jid: JID):
@@ -615,16 +649,21 @@ class BaseSession(
         # :return:
         # """
         log.debug("Killing session of %s", jid)
-        for user, session in _sessions.items():
-            if user.jid == jid.bare:
+        for user_jid, session in _sessions.items():
+            if user_jid == jid.bare:
                 break
         else:
             log.debug("Did not find a session for %s", jid)
             return
         for c in session.contacts:
             c.unsubscribe()
+        user = cls.xmpp.store.users.get(jid)
+        if user is None:
+            log.warning("User not found during unregistration")
+            return
         await cls.xmpp.unregister(user)
-        del _sessions[user]
+        cls.xmpp.store.users.delete(user.jid)
+        del _sessions[user.jid.bare]
         del user
         del session
 
@@ -649,7 +688,7 @@ class BaseSession(
         """
         self.__cached_presence = CachedPresence(status, show, kwargs)
         self.xmpp.send_presence(
-            pto=self.user.bare_jid, pstatus=status, pshow=show, **kwargs
+            pto=self.user_jid.bare, pstatus=status, pshow=show, **kwargs
         )
 
     def send_cached_presence(self, to: JID):
@@ -671,7 +710,7 @@ class BaseSession(
 
         :param text: A text
         """
-        self.xmpp.send_text(text, mto=self.user.jid, **msg_kwargs)
+        self.xmpp.send_text(text, mto=self.user_jid, **msg_kwargs)
 
     def send_gateway_invite(
         self,
@@ -686,7 +725,7 @@ class BaseSession(
         :param reason:
         :param password:
         """
-        self.xmpp.invite_to(muc, reason=reason, password=password, mto=self.user.jid)
+        self.xmpp.invite_to(muc, reason=reason, password=password, mto=self.user_jid)
 
     async def input(self, text: str, **msg_kwargs):
         """
@@ -698,7 +737,7 @@ class BaseSession(
         :param msg_kwargs: Extra attributes
         :return:
         """
-        return await self.xmpp.input(self.user.jid, text, **msg_kwargs)
+        return await self.xmpp.input(self.user_jid, text, **msg_kwargs)
 
     async def send_qr(self, text: str):
         """
@@ -707,7 +746,7 @@ class BaseSession(
 
         :param text: Text to encode as a QR code
         """
-        await self.xmpp.send_qr(text, mto=self.user.jid)
+        await self.xmpp.send_qr(text, mto=self.user_jid)
 
     def re_login(self):
         # Logout then re-login
@@ -715,14 +754,17 @@ class BaseSession(
         # No reason to override this
         self.xmpp.re_login(self)
 
-    async def get_contact_or_group_or_participant(self, jid: JID):
-        if jid.bare in (contacts := self.contacts.known_contacts(only_friends=False)):
-            return contacts[jid.bare]
-        if jid.bare in (mucs := self.bookmarks._mucs_by_bare_jid):
-            return await self.__get_muc_or_participant(mucs[jid.bare], jid)
+    async def get_contact_or_group_or_participant(self, jid: JID, create=True):
+        if (contact := self.contacts.by_jid_only_if_exists(jid)) is not None:
+            return contact
+        if (muc := self.bookmarks.by_jid_only_if_exists(JID(jid.bare))) is not None:
+            return await self.__get_muc_or_participant(muc, jid)
         else:
             muc = None
 
+        if not create:
+            return None
+
         try:
             return await self.contacts.by_jid(jid)
         except XMPPError:
@@ -763,6 +805,25 @@ class BaseSession(
                 "Legacy session is not fully initialized, retry later",
             )
 
+    def legacy_module_data_update(self, data: dict):
+        with self.xmpp.store.session():
+            user = self.user
+            user.legacy_module_data.update(data)
+            self.xmpp.store.users.update(user)
+
+    def legacy_module_data_set(self, data: dict):
+        with self.xmpp.store.session():
+            user = self.user
+            user.legacy_module_data = data
+            self.xmpp.store.users.update(user)
+
+    def legacy_module_data_clear(self):
+        with self.xmpp.store.session():
+            user = self.user
+            user.legacy_module_data.clear()
+            self.xmpp.store.users.update(user)
+
 
-_sessions: dict[GatewayUser, BaseSession] = {}
+# keys = user.jid.bare
+_sessions: dict[str, BaseSession] = {}
 log = logging.getLogger(__name__)

slidge/db/__init__.py

@@ -0,0 +1,4 @@
+from .models import GatewayUser
+from .store import SlidgeStore
+
+__all__ = ("GatewayUser", "SlidgeStore")

slidge/db/alembic/env.py

@@ -0,0 +1,64 @@
+from alembic import context
+
+from slidge import global_config
+from slidge.db.meta import Base, get_engine
+
+config = context.config
+
+target_metadata = Base.metadata
+
+
+def run_migrations_offline() -> None:
+    """Run migrations in 'offline' mode.
+
+    This configures the context with just a URL
+    and not an Engine, though an Engine is acceptable
+    here as well.  By skipping the Engine creation
+    we don't even need a DBAPI to be available.
+
+    Calls to context.execute() here emit the given string to the
+    script output.
+
+    """
+    url = config.get_main_option("sqlalchemy.url")
+    context.configure(
+        url=url,
+        target_metadata=target_metadata,
+        literal_binds=True,
+        dialect_opts={"paramstyle": "named"},
+        render_as_batch=True,
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def run_migrations_online() -> None:
+    """Run migrations in 'online' mode.
+
+    In this scenario we need to create an Engine
+    and associate a connection with the context.
+
+    """
+    try:
+        # in prod
+        connectable = get_engine(global_config.DB_URL)
+    except AttributeError:
+        # during dev, to generate migrations
+        connectable = get_engine("sqlite+pysqlite:///dev/slidge.sqlite")
+
+    with connectable.connect() as connection:
+        context.configure(
+            connection=connection,
+            target_metadata=target_metadata,
+            render_as_batch=True,
+        )
+
+        with context.begin_transaction():
+            context.run_migrations()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

slidge/db/alembic/old_user_store.py

@@ -0,0 +1,183 @@
+"""
+This module covers a backend for storing user data persistently and managing a
+pseudo-roster for the gateway component.
+"""
+
+import dataclasses
+import datetime
+import logging
+import os.path
+import shelve
+from io import BytesIO
+from os import PathLike
+from typing import Iterable, Optional, Union
+
+from pickle_secure import Pickler, Unpickler
+from slixmpp import JID, Iq, Message, Presence
+
+
+# noinspection PyUnresolvedReferences
+class EncryptedShelf(shelve.DbfilenameShelf):
+    cache: dict
+    dict: dict
+    writeback: bool
+    keyencoding: str
+    _protocol: int
+
+    def __init__(
+        self, filename: PathLike, key: str, flag="c", protocol=None, writeback=False
+    ):
+        super().__init__(str(filename), flag, protocol, writeback)
+        self.secret_key = key
+
+    def __getitem__(self, key):
+        try:
+            value = self.cache[key]
+        except KeyError:
+            f = BytesIO(self.dict[key.encode(self.keyencoding)])
+            value = Unpickler(f, key=self.secret_key).load()  # type:ignore
+            if self.writeback:
+                self.cache[key] = value
+        return value
+
+    def __setitem__(self, key, value):
+        if self.writeback:
+            self.cache[key] = value
+        f = BytesIO()
+        p = Pickler(f, self._protocol, key=self.secret_key)  # type:ignore
+        p.dump(value)
+        self.dict[key.encode(self.keyencoding)] = f.getvalue()
+
+
+@dataclasses.dataclass
+class GatewayUser:
+    """
+    A gateway user
+    """
+
+    bare_jid: str
+    """Bare JID of the user"""
+    registration_form: dict[str, Optional[str]]
+    """Content of the registration form, as a dict"""
+    plugin_data: Optional[dict] = None
+    registration_date: Optional[datetime.datetime] = None
+
+    def __hash__(self):
+        return hash(self.bare_jid)
+
+    def __repr__(self):
+        return f"<User {self.bare_jid}>"
+
+    def __post_init__(self):
+        if self.registration_date is None:
+            self.registration_date = datetime.datetime.now()
+
+    @property
+    def jid(self) -> JID:
+        """
+        The user's (bare) JID
+
+        :return:
+        """
+        return JID(self.bare_jid)
+
+    def get(self, field: str, default: str = "") -> Optional[str]:
+        # """
+        # Get fields from the registration form (required to comply with slixmpp backend protocol)
+        #
+        # :param field: Name of the field
+        # :param default: Default value to return if the field is not present
+        #
+        # :return: Value of the field
+        # """
+        return self.registration_form.get(field, default)
+
+
+class UserStore:
+    """
+    Basic user store implementation using shelve from the python standard library
+
+    Set_file must be called before it is usable
+    """
+
+    def __init__(self):
+        self._users: shelve.Shelf[GatewayUser] = None  # type: ignore
+
+    def set_file(self, filename: PathLike, secret_key: Optional[str] = None):
+        """
+        Set the file to use to store user data
+
+        :param filename: Path to the shelf file
+        :param secret_key: Secret key to store files encrypted on disk
+        """
+        if self._users is not None:
+            raise RuntimeError("Shelf file already set!")
+        if os.path.exists(filename):
+            log.info("Using existing slidge DB: %s", filename)
+        else:
+            log.info("Creating a new slidge DB: %s", filename)
+        if secret_key:
+            self._users = EncryptedShelf(filename, key=secret_key)
+        else:
+            self._users = shelve.open(str(filename))
+        log.info("Registered users in the DB: %s", list(self._users.keys()))
+
+    def get_all(self) -> Iterable[GatewayUser]:
+        """
+        Get all users in the store
+
+        :return: An iterable of GatewayUsers
+        """
+        return self._users.values()
+
+    def commit(self, user: GatewayUser):
+        self._users[user.jid.bare] = user
+        self._users.sync()
+
+    def get(self, _gateway_jid, _node, ifrom: JID, iq) -> Optional[GatewayUser]:
+        """
+        Get a user from the store
+
+        NB: there is no reason to call this, it is used by SliXMPP internal API
+
+        :param _gateway_jid:
+        :param _node:
+        :param ifrom:
+        :param iq:
+        :return:
+        """
+        if ifrom is None:  # bug in SliXMPP's XEP_0100 plugin
+            ifrom = iq["from"]
+        log.debug("Getting user %s", ifrom.bare)
+        return self._users.get(ifrom.bare)
+
+    def get_by_jid(self, jid: JID) -> Optional[GatewayUser]:
+        """
+        Convenience function to get a user from their JID.
+
+        :param jid: JID of the gateway user
+        :return:
+        """
+        return self._users.get(jid.bare)
+
+    def get_by_stanza(self, s: Union[Presence, Message, Iq]) -> Optional[GatewayUser]:
+        """
+        Convenience function to get a user from a stanza they sent.
+
+        :param s: A stanza sent by the gateway user
+        :return:
+        """
+        return self.get_by_jid(s.get_from())
+
+    def close(self):
+        self._users.sync()
+        self._users.close()
+
+
+user_store = UserStore()
+"""
+A persistent store for slidge users. Not public, but I didn't find how to hide
+it from the docs!
+"""
+
+log = logging.getLogger(__name__)

slidge/db/alembic/script.py.mako

@@ -0,0 +1,26 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+${imports if imports else ""}
+
+# revision identifiers, used by Alembic.
+revision: str = ${repr(up_revision)}
+down_revision: Union[str, None] = ${repr(down_revision)}
+branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)}
+depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)}
+
+
+def upgrade() -> None:
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade() -> None:
+    ${downgrades if downgrades else "pass"}

slidge/db/alembic/versions/09f27f098baa_add_missing_attributes_in_room.py

@@ -0,0 +1,36 @@
+"""Add n_participants attributes to Room
+
+Should have been part of another commit, but I messed up some rebase
+
+Revision ID: 09f27f098baa
+Revises: 29f5280c61aa
+Create Date: 2024-07-11 10:54:21.155871
+
+"""
+
+from typing import Sequence, Union
+
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision: str = "09f27f098baa"
+down_revision: Union[str, None] = "29f5280c61aa"
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table("room", schema=None) as batch_op:
+        batch_op.add_column(sa.Column("n_participants", sa.Integer(), nullable=True))
+
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table("room", schema=None) as batch_op:
+        batch_op.drop_column("n_participants")
+
+    # ### end Alembic commands ###

slidge/db/alembic/versions/15b0bd83407a_remove_bogus_unique_constraints_on_room_.py

@@ -0,0 +1,85 @@
+"""Remove bogus unique constraints on room table
+
+Revision ID: 15b0bd83407a
+Revises: 45c24cc73c91
+Create Date: 2024-08-28 06:57:25.022994
+
+"""
+
+from typing import Sequence, Union
+
+import sqlalchemy as sa
+from alembic import op
+
+import slidge.db.meta
+
+# revision identifiers, used by Alembic.
+revision: str = "15b0bd83407a"
+down_revision: Union[str, None] = "45c24cc73c91"
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+meta = sa.MetaData()
+room_table = sa.Table(
+    "room",
+    meta,
+    sa.Column("id", sa.Integer(), nullable=False),
+    sa.Column("user_account_id", sa.Integer(), nullable=False),
+    sa.Column("legacy_id", sa.String(), nullable=False),
+    sa.Column("jid", slidge.db.meta.JIDType(), nullable=False),
+    sa.Column("avatar_id", sa.Integer(), nullable=True),
+    sa.Column("name", sa.String(), nullable=True),
+    sa.Column("description", sa.String(), nullable=True),
+    sa.Column("subject", sa.String(), nullable=True),
+    sa.Column("subject_date", sa.DateTime(), nullable=True),
+    sa.Column("subject_setter", sa.String(), nullable=True),
+    sa.Column("n_participants", sa.Integer(), nullable=True),
+    sa.Column(
+        "muc_type",
+        sa.Enum("GROUP", "CHANNEL", "CHANNEL_NON_ANONYMOUS", name="muctype"),
+        nullable=True,
+    ),
+    sa.Column("user_nick", sa.String(), nullable=True),
+    sa.Column("user_resources", sa.String(), nullable=True),
+    sa.Column("participants_filled", sa.Boolean(), nullable=False),
+    sa.Column("history_filled", sa.Boolean(), nullable=False),
+    sa.Column("extra_attributes", slidge.db.meta.JSONEncodedDict(), nullable=True),
+    sa.Column("updated", sa.Boolean(), nullable=False),
+    sa.Column("avatar_legacy_id", sa.String(), nullable=True),
+    sa.ForeignKeyConstraint(
+        ["avatar_id"],
+        ["avatar.id"],
+    ),
+    sa.ForeignKeyConstraint(
+        ["user_account_id"],
+        ["user_account.id"],
+    ),
+    sa.PrimaryKeyConstraint("id"),
+)
+
+
+def upgrade() -> None:
+    if op.get_bind().engine.name == "postgresql":
+        return
+    with op.batch_alter_table(
+        "room",
+        schema=None,
+        # without copy_from, the newly created table keeps the constraints
+        # we actually want to ditch.
+        copy_from=room_table,
+    ) as batch_op:
+        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"]
+        )
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table("room", schema=None) as batch_op:
+        batch_op.drop_constraint("uq_room_user_account_id_legacy_id", type_="unique")
+        batch_op.drop_constraint("uq_room_user_account_id_jid", type_="unique")
+
+    # ### end Alembic commands ###