slidge 0.1.2__py3-none-any.whl → 0.2.0a0__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,
@@ -92,16 +91,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]()
 
@@ -115,26 +108,26 @@ class BaseSession(
 
         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
+
     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:
@@ -488,6 +481,17 @@ class BaseSession(
         """
         await muc.on_set_affiliation(contact, "member", reason, None)
 
+    async def on_leave_group(self, muc: LegacyMUC):
+        """
+        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: The group to leave
+        """
+        raise NotImplementedError
+
     def __reset_ready(self):
         self.ready = self.xmpp.loop.create_future()
 
@@ -507,7 +511,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 +575,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 +594,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 +606,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 +623,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 +662,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 +684,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 +699,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 +711,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 +720,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
@@ -718,8 +731,8 @@ class BaseSession(
     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)
+        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
 
@@ -763,6 +776,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/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/29f5280c61aa_store_subject_setter_in_room.py

@@ -0,0 +1,37 @@
+"""Store subject setter in Room
+
+Revision ID: 29f5280c61aa
+Revises: 8d2ced764698
+Create Date: 2024-07-10 13:09:25.181594
+
+"""
+
+from typing import Sequence, Union
+
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision: str = "29f5280c61aa"
+down_revision: Union[str, None] = "8d2ced764698"
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    with op.batch_alter_table("room", schema=None) as batch_op:
+        batch_op.add_column(sa.Column("subject_setter_id", sa.Integer(), nullable=True))
+        # we give this constraint a name a workaround for
+        # https://github.com/sqlalchemy/alembic/issues/1195
+        batch_op.create_foreign_key(
+            "subject_setter_id_foreign_key",
+            "participant",
+            ["subject_setter_id"],
+            ["id"],
+        )
+
+
+def downgrade() -> None:
+    with op.batch_alter_table("room", schema=None) as batch_op:
+        batch_op.drop_constraint("subject_setter_id_foreign_key", type_="foreignkey")
+        batch_op.drop_column("subject_setter_id")

slidge/db/alembic/versions/8d2ced764698_rely_on_db_to_store_contacts_rooms_and_.py

@@ -0,0 +1,133 @@
+"""Rely on DB to store contacts, rooms and participants
+
+Revision ID: 8d2ced764698
+Revises: b33993e87db3
+Create Date: 2024-07-08 14:39:47.022088
+
+"""
+
+from typing import Sequence, Union
+
+import sqlalchemy as sa
+from alembic import op
+
+import slidge.db.meta
+
+# revision identifiers, used by Alembic.
+revision: str = "8d2ced764698"
+down_revision: Union[str, None] = "b33993e87db3"
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    op.create_table(
+        "hat",
+        sa.Column("id", sa.Integer(), nullable=False),
+        sa.Column("title", sa.String(), nullable=False),
+        sa.Column("uri", sa.String(), nullable=False),
+        sa.PrimaryKeyConstraint("id"),
+        sa.UniqueConstraint("title", "uri"),
+    )
+    op.create_table(
+        "contact_sent",
+        sa.Column("id", sa.Integer(), nullable=False),
+        sa.Column("contact_id", sa.Integer(), nullable=False),
+        sa.Column("msg_id", sa.String(), nullable=False),
+        sa.ForeignKeyConstraint(
+            ["contact_id"],
+            ["contact.id"],
+        ),
+        sa.PrimaryKeyConstraint("id"),
+        sa.UniqueConstraint("contact_id", "msg_id"),
+    )
+    op.create_table(
+        "participant",
+        sa.Column("id", sa.Integer(), nullable=False),
+        sa.Column("room_id", sa.Integer(), nullable=False),
+        sa.Column("contact_id", sa.Integer(), nullable=True),
+        sa.Column("is_user", sa.Boolean(), nullable=False),
+        sa.Column(
+            "affiliation",
+            sa.Enum("outcast", "member", "admin", "owner", "none", native_enum=False),
+            nullable=False,
+        ),
+        sa.Column(
+            "role",
+            sa.Enum("moderator", "participant", "visitor", "none", native_enum=False),
+            nullable=False,
+        ),
+        sa.Column("presence_sent", sa.Boolean(), nullable=False),
+        sa.Column("resource", sa.String(), nullable=True),
+        sa.Column("nickname", sa.String(), nullable=True),
+        sa.Column("extra_attributes", slidge.db.meta.JSONEncodedDict(), nullable=True),
+        sa.ForeignKeyConstraint(
+            ["contact_id"],
+            ["contact.id"],
+        ),
+        sa.ForeignKeyConstraint(
+            ["room_id"],
+            ["room.id"],
+        ),
+        sa.PrimaryKeyConstraint("id"),
+    )
+    op.create_table(
+        "participant_hats",
+        sa.Column("participant_id", sa.Integer(), nullable=False),
+        sa.Column("hat_id", sa.Integer(), nullable=False),
+        sa.ForeignKeyConstraint(
+            ["hat_id"],
+            ["hat.id"],
+        ),
+        sa.ForeignKeyConstraint(
+            ["participant_id"],
+            ["participant.id"],
+        ),
+        sa.PrimaryKeyConstraint("participant_id", "hat_id"),
+    )
+    op.add_column("contact", sa.Column("is_friend", sa.Boolean(), nullable=False))
+    op.add_column("contact", sa.Column("added_to_roster", sa.Boolean(), nullable=False))
+    op.add_column(
+        "contact",
+        sa.Column("extra_attributes", slidge.db.meta.JSONEncodedDict(), nullable=True),
+    )
+    op.add_column("contact", sa.Column("updated", sa.Boolean(), nullable=False))
+    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))
+    op.add_column(
+        "room",
+        sa.Column(
+            "muc_type",
+            sa.Enum("GROUP", "CHANNEL", "CHANNEL_NON_ANONYMOUS", name="muctype"),
+            nullable=True,
+        ),
+    )
+    op.add_column("room", sa.Column("user_resources", sa.String(), nullable=True))
+    op.add_column(
+        "room", sa.Column("participants_filled", sa.Boolean(), nullable=False)
+    )
+    op.add_column(
+        "room",
+        sa.Column("extra_attributes", slidge.db.meta.JSONEncodedDict(), nullable=True),
+    )
+    op.add_column("room", sa.Column("updated", sa.Boolean(), nullable=False))
+
+
+def downgrade() -> None:
+    op.drop_column("room", "updated")
+    op.drop_column("room", "extra_attributes")
+    op.drop_column("room", "participants_filled")
+    op.drop_column("room", "user_resources")
+    op.drop_column("room", "muc_type")
+    op.drop_column("room", "subject_date")
+    op.drop_column("room", "subject")
+    op.drop_column("room", "description")
+    op.drop_column("contact", "updated")
+    op.drop_column("contact", "extra_attributes")
+    op.drop_column("contact", "added_to_roster")
+    op.drop_column("contact", "is_friend")
+    op.drop_table("participant_hats")
+    op.drop_table("participant")
+    op.drop_table("contact_sent")
+    op.drop_table("hat")

slidge/db/alembic/versions/aa9d82a7f6ef_db_creation.py

@@ -0,0 +1,76 @@
+"""DB Creation
+
+Including a migration from the user_store shelf
+
+Revision ID: aa9d82a7f6ef
+Revises:
+Create Date: 2024-04-17 20:57:01.357041
+
+"""
+
+import logging
+from typing import Sequence, Union
+
+import sqlalchemy as sa
+from alembic import op
+
+import slidge.db.meta
+
+# revision identifiers, used by Alembic.
+revision: str = "aa9d82a7f6ef"
+down_revision: Union[str, None] = None
+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! ###
+    accounts = op.create_table(
+        "user_account",
+        sa.Column("id", sa.Integer(), nullable=False),
+        sa.Column("jid", slidge.db.meta.JIDType(), nullable=False),
+        sa.Column(
+            "registration_date",
+            sa.DateTime(),
+            server_default=sa.text("(CURRENT_TIMESTAMP)"),
+            nullable=False,
+        ),
+        sa.Column(
+            "legacy_module_data", slidge.db.meta.JSONEncodedDict(), nullable=False
+        ),
+        sa.Column("preferences", slidge.db.meta.JSONEncodedDict(), nullable=False),
+        sa.PrimaryKeyConstraint("id"),
+        sa.UniqueConstraint("jid"),
+    )
+    # ### end Alembic commands ###
+    migrate_from_shelf(accounts)
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_table("user_account")
+    # ### end Alembic commands ###
+
+
+def migrate_from_shelf(accounts: sa.Table) -> None:
+    try:
+        from slidge.util.db import user_store
+    except ImportError:
+        return
+    try:
+        users = list(user_store.get_all())
+    except AttributeError:
+        return
+    logging.info("Migrating %s users from the deprecated user_store shelf", len(users))
+    op.bulk_insert(
+        accounts,
+        [
+            {
+                "jid": user.jid,
+                "registration_date": user.registration_date,
+                "legacy_module_data": user.registration_form,
+                "preferences": {},
+            }
+            for user in users
+        ],
+    )