libreqda 1.2.0__py3-none-any.whl

taguette/migrations/versions/d86c45d7aa8a_add_document_direction.py

@@ -0,0 +1,127 @@
+"""add document direction
+
+Revision ID: d86c45d7aa8a
+Revises: 43d6c240309d
+Create Date: 2021-06-09 13:17:10.397016
+
+"""
+from alembic import op
+import json
+import sqlalchemy as sa
+from sqlalchemy.dialects import postgresql
+
+
+# revision identifiers, used by Alembic.
+revision = 'd86c45d7aa8a'
+down_revision = '43d6c240309d'
+branch_labels = None
+depends_on = None
+
+
+meta = sa.MetaData(naming_convention={
+    "ix": "ix_%(column_0_label)s",
+    "uq": "uq_%(table_name)s_%(column_0_name)s",
+    "ck": "ck_%(table_name)s_%(constraint_name)s",
+    "fk": "fk_%(table_name)s_%(column_0_name)s_%(referred_table_name)s",
+    "pk": "pk_%(table_name)s",
+})
+
+commands = sa.Table(
+    'commands',
+    meta,
+    sa.Column('id', sa.Integer, primary_key=True),
+    sa.Column('date', sa.DateTime, nullable=False),
+    sa.Column('user_login', sa.String(30), nullable=False),
+    sa.Column('project_id', sa.Integer, nullable=False),
+    sa.Column('document_id', sa.Integer, nullable=True),
+    sa.Column('payload', sa.Text, nullable=False),
+)
+
+
+def _do_map(map_func):
+    """Map JSON payloads through the given function.
+    """
+    connection = op.get_bind()
+    assert connection is not None
+
+    payloads = connection.execute('''\
+        SELECT id, payload FROM commands;
+    ''')
+    update = []
+    for id, payload in payloads:
+        payload = json.loads(payload)
+        payload = map_func(payload)
+        if payload is not None:
+            payload = json.dumps(payload, sort_keys=True)
+            update.append({'cmd_id': id, 'cmd_payload': payload})
+
+    if update:
+        with connection.begin():
+            connection.execute(
+                (
+                    commands.update()
+                    .where(commands.c.id == sa.bindparam('cmd_id'))
+                    .values(payload=sa.bindparam('cmd_payload'))
+                ),
+                update,
+            )
+
+
+def upgrade():
+    # Add textdirection enum type
+    connection = op.get_bind()
+    if connection.dialect.name == 'postgresql':
+        direction_enum = postgresql.ENUM(
+            'LEFT_TO_RIGHT', 'RIGHT_TO_LEFT',
+            name='textdirection',
+            create_type=False,
+        )
+        direction_enum.create(connection)
+    else:
+        direction_enum = sa.Enum(
+            'LEFT_TO_RIGHT', 'RIGHT_TO_LEFT',
+            name='textdirection',
+        )
+
+    # Add column to 'documents'
+    op.add_column(
+        'documents',
+        sa.Column(
+            'text_direction',
+            direction_enum,
+            nullable=True,
+        ),
+    )
+    op.execute(
+        '''\
+        UPDATE documents SET text_direction = 'LEFT_TO_RIGHT';
+        ''',
+    )
+    with op.batch_alter_table('documents', schema=None) as batch_op:
+        batch_op.alter_column('text_direction', nullable=False)
+
+    # Add field to commands
+    def add_field(payload):
+        if payload['type'] == 'document_add':
+            payload['text_direction'] = 'LEFT_TO_RIGHT'
+        return payload
+
+    _do_map(add_field)
+
+
+def downgrade():
+    # Remove field from commands
+    def remove_field(payload):
+        payload.pop('text_direction', None)
+        return payload
+
+    _do_map(remove_field)
+
+    # Remove column from 'documents'
+    with op.batch_alter_table('documents', schema=None) as batch_op:
+        batch_op.drop_column('text_direction')
+
+    # Remove textdirection enum type
+    connection = op.get_bind()
+    if connection.dialect.name == 'postgresql':
+        op.execute("DROP TYPE textdirection;")

taguette/migrations/versions/db5e31a0233d_remove_blank_highlights.py

@@ -0,0 +1,88 @@
+"""remove blank highlights
+
+Revision ID: db5e31a0233d
+Revises: 382db36f20f4
+Create Date: 2022-11-18 15:03:03.154401
+
+"""
+from alembic import op
+import sqlalchemy as sa
+import sys
+
+
+# revision identifiers, used by Alembic.
+revision = 'db5e31a0233d'
+down_revision = '382db36f20f4'
+branch_labels = None
+depends_on = None
+
+
+meta = sa.MetaData(naming_convention={
+    "ix": "ix_%(column_0_label)s",
+    "uq": "uq_%(table_name)s_%(column_0_name)s",
+    "ck": "ck_%(table_name)s_%(constraint_name)s",
+    "fk": "fk_%(table_name)s_%(column_0_name)s_%(referred_table_name)s",
+    "pk": "pk_%(table_name)s",
+})
+
+highlights = sa.Table(
+    'highlights',
+    meta,
+    sa.Column('id', sa.Integer, primary_key=True),
+    sa.Column('document_id', sa.Integer, nullable=False),
+    sa.Column('start_offset', sa.Integer, nullable=False),
+    sa.Column('end_offset', sa.Integer, nullable=False),
+    sa.Column(
+        'snippet', sa.Text,
+        sa.ForeignKey('documents.id', ondelete='CASCADE'),
+        nullable=False,
+    ),
+)
+
+highlight_tags = sa.Table(
+    'highlight_tags',
+    meta,
+    sa.Column(
+        'highlight_id', sa.Integer,
+        sa.ForeignKey('highlights.id', ondelete='CASCADE'),
+        primary_key=True,
+    ),
+    sa.Column(
+        'tag_id', sa.Integer,
+        sa.ForeignKey('tags.id', ondelete='CASCADE'),
+        primary_key=True,
+    ),
+)
+
+
+def upgrade():
+    bind = op.get_bind()
+
+    # Find blank highlights
+    rows = bind.execute(
+        sa.select([highlights.c.id, highlights.c.snippet])
+        .select_from(highlights)
+    )
+    to_delete = []
+    for id, snippet in rows:
+        if all(c in '\r\n\t' for c in snippet):
+            to_delete.append(id)
+
+    # Delete them
+    if to_delete:
+        print(
+            "%d blank highlights to delete" % len(to_delete),
+            file=sys.stderr,
+        )
+        bind.execute(
+            highlight_tags.delete()
+            .where(highlight_tags.c.highlight_id.in_(to_delete))
+        )
+        bind.execute(
+            highlights.delete()
+            .where(highlights.c.id.in_(to_delete))
+        )
+
+
+def downgrade():
+    pass

taguette/migrations/versions/dd37d9027a24_unique_tags.py

@@ -0,0 +1,68 @@
+"""unique_tags
+
+Revision ID: dd37d9027a24
+Revises: e4e090a5b511
+Create Date: 2018-11-10 21:45:13.844011
+
+"""
+from alembic import op
+from sqlalchemy.orm import Session
+
+
+# revision identifiers, used by Alembic.
+revision = 'dd37d9027a24'
+down_revision = 'e4e090a5b511'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # Change the paths of tags that collide, before adding the unique index
+    bind = op.get_bind()
+    session = Session(bind=bind)
+    # https://stackoverflow.com/a/7416624
+    session.execute(
+        '''\
+        UPDATE tags
+        SET path = path || ' ' || id
+        WHERE
+            id NOT IN (
+                SELECT MIN(t3.id)
+                FROM tags t3
+                GROUP BY project_id, path
+                HAVING count(t3.id) > 1
+            ) AND id IN (
+                SELECT t1.id
+                FROM tags AS t1
+                INNER JOIN tags AS t2
+                ON t1.path = t2.path AND
+                    t1.project_id = t2.project_id AND
+                    t1.id <> t2.id
+            );
+        ''',
+    )
+    session.commit()
+
+    # Add the indexes
+    with op.batch_alter_table('tags') as batch_op:
+        batch_op.create_index(
+            batch_op.f('ix_tags_path'),
+            ['path'],
+            unique=True,
+        )
+
+    # We assume no one created those, table is unused so far
+    with op.batch_alter_table('groups') as batch_op:
+        batch_op.create_index(
+            batch_op.f('ix_groups_path'),
+            ['path'],
+            unique=True,
+        )
+
+
+def downgrade():
+    with op.batch_alter_table('groups') as batch_op:
+        batch_op.drop_index(batch_op.f('ix_groups_path'))
+
+    with op.batch_alter_table('tags') as batch_op:
+        batch_op.drop_index(batch_op.f('ix_tags_path'))

taguette/migrations/versions/de678cef2a94_add_project_id_to_collections_and_.py

@@ -0,0 +1,41 @@
+"""Add project_id to collections and relation to Project
+
+Revision ID: de678cef2a94
+Revises: 955db2e523d1
+Create Date: 2025-07-08 14:22:33.272231
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = 'de678cef2a94'
+down_revision = '955db2e523d1'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table('collections', schema=None) as batch_op:
+        batch_op.add_column(
+            sa.Column('project_id', sa.Integer(), nullable=False))
+        batch_op.create_index(batch_op.f('ix_collections_project_id'), [
+                              'project_id'], unique=False)
+        batch_op.create_foreign_key(
+            batch_op.f('fk_collections_project_id_projects'),
+            'projects', ['project_id'], ['id'], ondelete='CASCADE')
+
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table('collections', schema=None) as batch_op:
+        batch_op.drop_constraint(batch_op.f(
+            'fk_collections_project_id_projects'), type_='foreignkey')
+        batch_op.drop_index(batch_op.f('ix_collections_project_id'))
+        batch_op.drop_column('project_id')
+
+    # ### end Alembic commands ###

taguette/migrations/versions/e459991d960e_add_table_edugainidps.py

@@ -0,0 +1,39 @@
+"""add table edugainidps
+
+Revision ID: e459991d960e
+Revises: 4c55b3b3ff30
+Create Date: 2024-03-11 10:16:16.804208
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = 'e459991d960e'
+down_revision = '4c55b3b3ff30'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    op.create_table(
+        'edigainidps',
+        sa.Column('id', sa.Integer(), nullable=False),
+        sa.Column('entityid', sa.String(length=255), nullable=True),
+        sa.Column('e_displayname', sa.String(length=255), nullable=True),
+        sa.Column('regauth', sa.String(length=255), nullable=True),
+        sa.Column('entity_cat', sa.String(length=255), nullable=True),
+        sa.Column('eccs_status', sa.Integer(), nullable=True),
+        sa.Column('validator_status', sa.BigInteger(), nullable=True),
+        sa.Column('coco_status', sa.String(length=255), nullable=True),
+        sa.Column('coco_id', sa.Integer(), nullable=True),
+        sa.Column('sirtfi_status', sa.Integer(), nullable=True),
+        sa.Column('code', sa.String(length=255), nullable=True),
+        sa.Column('scopes', sa.Text(), nullable=True),
+        sa.PrimaryKeyConstraint('id', name=op.f('pk_edigainidps'))
+    )
+
+
+def downgrade():
+    op.drop_table('edigainidps')

taguette/migrations/versions/e4cf92942271_add_index.py

@@ -0,0 +1,29 @@
+"""add index
+
+Revision ID: e4cf92942271
+Revises: 491de2dc7cd7
+Create Date: 2021-11-18 10:38:47.124630
+
+"""
+from alembic import op
+
+
+# revision identifiers, used by Alembic.
+revision = 'e4cf92942271'
+down_revision = '491de2dc7cd7'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    with op.batch_alter_table('commands', schema=None) as batch_op:
+        batch_op.create_index(
+            'idx_project_id',
+            ['project_id', 'id'],
+            unique=False,
+        )
+
+
+def downgrade():
+    with op.batch_alter_table('commands', schema=None) as batch_op:
+        batch_op.drop_index('idx_project_id')

taguette/migrations/versions/e4e090a5b511_remove_commands_document_id_fk.py

@@ -0,0 +1,38 @@
+"""remove commands.document_id fk
+
+Revision ID: e4e090a5b511
+Revises:
+Create Date: 2018-10-28 22:54:11.833009
+
+"""
+from alembic import op
+
+
+# revision identifiers, used by Alembic.
+revision = 'e4e090a5b511'
+down_revision = None
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    naming_convention = {
+        "fk":
+            "fk_%(table_name)s_%(column_0_name)s_%(referred_table_name)s",
+    }
+    with op.batch_alter_table(
+            'commands',
+            naming_convention=naming_convention,
+    ) as batch_op:
+        batch_op.drop_constraint(
+            'fk_commands_document_id_documents',
+            type_='foreignkey',
+        )
+
+
+def downgrade():
+    with op.batch_alter_table('commands') as batch_op:
+        batch_op.create_foreign_key(
+            None,
+            'documents', ['document_id'], ['id'],
+        )

taguette/migrations/versions/e9a9f1c77971_add_favorite_column_to_document.py

@@ -0,0 +1,32 @@
+"""Add favorite column to document
+
+Revision ID: e9a9f1c77971
+Revises: 7f56de97e3c8
+Create Date: 2024-04-08 19:29:37.036133
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = 'e9a9f1c77971'
+down_revision = '7f56de97e3c8'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table('documents', schema=None) as batch_op:
+        batch_op.add_column(sa.Column('favorite', sa.Boolean(), nullable=True))
+
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table('documents', schema=None) as batch_op:
+        batch_op.drop_column('favorite')
+
+    # ### end Alembic commands ###

taguette/migrations/versions/ecb4065de575_don_t_use_server_default_now_timezone_.py

@@ -0,0 +1,44 @@
+"""Don't use server_default=now(), timezone issues
+
+Revision ID: ecb4065de575
+Revises: 807c0cc0ecf6
+Create Date: 2021-02-27 11:12:36.221364
+
+"""
+from alembic import op
+from sqlalchemy.sql import functions
+
+
+# revision identifiers, used by Alembic.
+revision = 'ecb4065de575'
+down_revision = '807c0cc0ecf6'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    with op.batch_alter_table('users') as batch_op:
+        batch_op.alter_column('created', server_default=None)
+
+    with op.batch_alter_table('projects') as batch_op:
+        batch_op.alter_column('created', server_default=None)
+
+    with op.batch_alter_table('documents') as batch_op:
+        batch_op.alter_column('created', server_default=None)
+
+    with op.batch_alter_table('commands') as batch_op:
+        batch_op.alter_column('date', server_default=None)
+
+
+def downgrade():
+    with op.batch_alter_table('users') as batch_op:
+        batch_op.alter_column('created', server_default=functions.now())
+
+    with op.batch_alter_table('projects') as batch_op:
+        batch_op.alter_column('created', server_default=functions.now())
+
+    with op.batch_alter_table('documents') as batch_op:
+        batch_op.alter_column('created', server_default=functions.now())
+
+    with op.batch_alter_table('commands') as batch_op:
+        batch_op.alter_column('date', server_default=functions.now())

taguette/migrations/versions/fbdc29566f62_edugain_fix_field_type.py

@@ -0,0 +1,42 @@
+"""edugain : fix field type
+
+Revision ID: fbdc29566f62
+Revises: e459991d960e
+Create Date: 2024-03-26 11:25:38.289515
+
+"""
+from alembic import op
+import sqlalchemy as sa
+import logging
+
+logger = logging.getLogger(__name__)
+
+# revision identifiers, used by Alembic.
+revision = 'fbdc29566f62'
+down_revision = 'e459991d960e'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    db_url = op.get_context().config.get_section('alembic')['sqlalchemy.url']
+    if db_url.startswith('sqlite:'):
+        # SQLite doesn't mind field length
+        logger.info(f"Skipping upgrade {revision} for SQLite")
+    else:
+        op.alter_column('edigainidps', 'scopes',
+                        existing_type=sa.VARCHAR(length=255),
+                        type_=sa.Text(),
+                        existing_nullable=True)
+
+
+def downgrade():
+    db_url = op.get_context().config.get_section('alembic')['sqlalchemy.url']
+    if db_url.startswith('sqlite:'):
+        # SQLite doesn't mind field length
+        logger.info(f"Skipping downgrade {down_revision} for SQLite")
+    else:
+        op.alter_column('edigainidps', 'scopes',
+                        existing_type=sa.Text(),
+                        type_=sa.VARCHAR(length=255),
+                        existing_nullable=True)

taguette/migrations/versions/fdc6eb54b034_add_parent_id_column_to_tags_table.py

@@ -0,0 +1,31 @@
+"""Add parent_id column to tags table
+
+Revision ID: fdc6eb54b034
+Revises: db5e31a0233d
+Create Date: 2024-01-09 13:46:17.464940
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = 'fdc6eb54b034'
+down_revision = 'db5e31a0233d'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    with op.batch_alter_table('tags', schema=None) as batch_op:
+        batch_op.add_column(sa.Column('parent_id', sa.Integer(),
+                                      nullable=True))
+        batch_op.create_index(batch_op.f('ix_tags_parent_id'),
+                              ['parent_id'],
+                              unique=False)
+        batch_op.create_foreign_key(batch_op.f('fk_tags_parent_id_tags'),
+                                    'tags', ['parent_id'], ['id'],
+                                    ondelete='CASCADE')
+
+    # ### end Alembic commands ###

taguette/static/README.md

@@ -0,0 +1,34 @@
+# Customizing styles
+LibreQDA uses SCSS instead of plain CSS for better modularity and theme management.
+
+## Theme creation
+Themes are stored under `taguette/static/scss/themes/<theme_name>.
+
+You can copy the `default` or `example` theme and customize the main variables in `_variables.scss`. They are used throughout the partials in `components/` and `layout/`.
+
+Note: do not edit `themed.css` directly — it’s overwritten on each build.
+
+## Compilation
+To compile a theme, run:
+
+``` console
+poetry run make-theme <theme_name>
+```
+
+## Customizing the logo
+
+Default LibreQDA logos are stored at the following path: `taguette/static/`.
+
+To customize:
+
+1. Add a new logo image under `taguette/static/assets/<theme_name>/`.  
+   You need to create a directory for your theme inside `assets/`.
+
+2. In your custom `_variables.scss`, define a new variable `$logo-main` and set it to the path for your new logo:
+
+   ```scss
+   $logo-main: "/static/assets/<theme_name>/<your-logo.png>";
+
+3. If the `$logo-main` variable is defined in your `_variables.scss`, it will overwrite the default logo. Otherwise, the default logo will be displayed.
+
+4. You can repeat the same steps for the horizontal version of the logo using the `$logo-horizontal` variable.