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

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/2461390c0af2_store_contacts_caps_verstring_in_db.py

@@ -0,0 +1,36 @@
+"""Store contacts caps verstring in DB
+
+Revision ID: 2461390c0af2
+Revises: 2b1f45ab7379
+Create Date: 2024-07-20 08:00:11.675735
+
+"""
+
+from typing import Sequence, Union
+
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision: str = "2461390c0af2"
+down_revision: Union[str, None] = "2b1f45ab7379"
+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("contact", schema=None) as batch_op:
+        batch_op.add_column(sa.Column("caps_ver_bare", sa.String(), nullable=True))
+        batch_op.add_column(sa.Column("caps_ver", sa.String(), nullable=True))
+
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table("contact", schema=None) as batch_op:
+        batch_op.drop_column("caps_ver")
+        batch_op.drop_column("caps_ver_bare")
+
+    # ### 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/2b1f45ab7379_store_room_subject_setter_by_nickname.py

@@ -0,0 +1,41 @@
+"""Store room subject setter by nickname
+
+Revision ID: 2b1f45ab7379
+Revises: c4a8ec35a0e8
+Create Date: 2024-07-20 00:14:36.882689
+
+"""
+
+from typing import Sequence, Union
+
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision: str = "2b1f45ab7379"
+down_revision: Union[str, None] = "c4a8ec35a0e8"
+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("subject_setter", sa.String(), nullable=True))
+        batch_op.drop_constraint("subject_setter_id_foreign_key", type_="foreignkey")
+        batch_op.drop_column("subject_setter_id")
+    # ### 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.add_column(sa.Column("subject_setter_id", sa.INTEGER(), nullable=True))
+        batch_op.create_foreign_key(
+            "subject_setter_id_foreign_key",
+            "participant",
+            ["subject_setter_id"],
+            ["id"],
+        )
+        batch_op.drop_column("subject_setter")
+    # ### end Alembic commands ###

slidge/db/alembic/versions/82a4af84b679_add_muc_history_filled.py

@@ -0,0 +1,48 @@
+"""Add MUC.history_filled
+
+Also drop caps_ver_bare column that should never have been added.
+
+Revision ID: 82a4af84b679
+Revises: 2461390c0af2
+Create Date: 2024-07-22 07:01:05.352737
+
+"""
+
+from typing import Sequence, Union
+
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision: str = "82a4af84b679"
+down_revision: Union[str, None] = "2461390c0af2"
+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("contact", schema=None) as batch_op:
+        batch_op.drop_column("caps_ver_bare")
+
+    with op.batch_alter_table("room", schema=None) as batch_op:
+        batch_op.add_column(
+            sa.Column(
+                "history_filled",
+                sa.Boolean(),
+                nullable=False,
+                server_default=sa.False_(),  # manually added
+            )
+        )
+    # ### 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("history_filled")
+
+    with op.batch_alter_table("contact", schema=None) as batch_op:
+        batch_op.add_column(sa.Column("caps_ver_bare", sa.VARCHAR(), nullable=True))
+
+    # ### end Alembic commands ###

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,85 @@
+"""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 datetime import datetime
+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 ###
+    try:
+        migrate_from_shelf(accounts)
+    except Exception:
+        downgrade()
+        raise
+
+
+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
+                    if user.registration_date is not None
+                    else datetime.now()
+                ),
+                "legacy_module_data": user.registration_form,
+                "preferences": {},
+            }
+            for user in users
+        ],
+    )