✨(buildpack) add PaaS deployment support, tested with Scalingo

Added:
- ✨(backend) add endpoint checking media status
- ✨(backend) allow setting session cookie age via env var
- ✨(backend) allow theme customnization using a
configuration file
- ✨(frontend) Add a custom callout block to the editor
- 🚩(frontend) version MIT only
- ✨(backend) integrate maleware_detection from django-lasuite
- 🏗️(frontend) Footer configurable
- 🩺(CI) add lint spell mistakes
- ✨(frontend) create generic theme
- 🛂(frontend) block edition to not connected users
- 🚸(frontend) Let loader during upload analyze
- 🚩(frontend) feature flag on blocking edition

Changed:
- 📝(frontend) Update documentation
- ✅(frontend) Improve tests coverage
- ⬆️(docker) upgrade backend image to python 3.13
- ⬆️(docker) upgrade node images to alpine 3.21

Fixed:
- 🐛(y-provider) increase JSON size limits for
transcription conversion

Removed:
- 🔥(back) remove footer endpoint

.github/ISSUE_TEMPLATE/Bug_report.md

@@ -1,7 +1,7 @@
 ---
 name: 🐛 Bug Report
 about: If something is not working as expected 🤔.
-
+labels: ["bug", "triage"]
 ---
 
 ## Bug Report
@@ -18,8 +18,8 @@ A clear and concise description of what you expected to happen (or code).
 3. And then the bug happens!
 
 **Environment**
-- Impress version:
-- Platform:
+- Docs version:
+- Instance url:
 
 **Possible Solution**
 <!--- Only if you have suggestions on a fix for the bug -->

.github/ISSUE_TEMPLATE/Feature_request.md

@@ -1,7 +1,7 @@
 ---
 name: ✨ Feature Request
 about: I have a suggestion (and may want to build it 💪)!
-
+labels: ["feature", "triage"]
 ---
 
 ## Feature Request
@@ -16,8 +16,8 @@ A clear and concise description of what you want to happen. Add any considered d
 A clear and concise description of any alternative solutions or features you've considered.
 
 **Discovery, Documentation, Adoption, Migration Strategy**
-If you can, explain how users will be able to use this and possibly write out a version the docs (if applicable).
-Maybe a screenshot or design?
+If you can, explain how users will be able to use this and possibly write out some documentation (if applicable).
+Maybe add a screenshot or design?
 
 **Do you want to work on it through a Pull Request?**
 <!-- Make sure to coordinate with us before you spend too much time working on an implementation! -->

.github/ISSUE_TEMPLATE/Support_question.md

@@ -1,17 +1,13 @@
 ---
 name: 🤗 Support Question
 about: If you have a question 💬, or something was not clear from the docs!
-
+labels: ["support", "triage"]
 ---
+## Support request
+**Checks before filing**
+Please make sure you have read our [main Readme](https://github.com/suitenumerique/docs).
 
-<!-- ^ Click "Preview" for a nicer view! ^
-We primarily use GitHub as an issue tracker. If however you're encountering an issue not covered in the docs, we may be able to help! -->
-
----
-
-Please make sure you have read our [main Readme](https://github.com/numerique-gouv/impress).
-
-Also make sure it was not already answered in [an open or close issue](https://github.com/numerique-gouv/impress/issues).
+Also make sure it was not already answered in [an open or close issue](https://github.com/suitenumerique/docs/issues?q=is%3Aissue%20state%3Aopen%20label%3Asupport).
 
 If your question was not covered, and you feel like it should be, fire away! We'd love to improve our docs! 👌
 

.github/workflows/crowdin_download.yml

@@ -7,10 +7,11 @@ on:
       - 'release/**'
 
 jobs:
-  install-front:
-    uses: ./.github/workflows/front-dependencies-installation.yml
+  install-dependencies:
+    uses: ./.github/workflows/dependencies.yml
     with:
       node_version: '20.x'
+      with-front-dependencies-installation: true
 
   synchronize-with-crowdin:
     runs-on: ubuntu-latest

.github/workflows/crowdin_upload.yml

@@ -7,13 +7,15 @@ on:
       - main
 
 jobs:
-  install-front:
-    uses: ./.github/workflows/front-dependencies-installation.yml
+  install-dependencies:
+    uses: ./.github/workflows/dependencies.yml
     with:
       node_version: '20.x'
+      with-front-dependencies-installation: true
+      with-build_mails: true
 
   synchronize-with-crowdin:
-    needs: install-front
+    needs: install-dependencies
     runs-on: ubuntu-latest
 
     steps:
@@ -23,12 +25,19 @@ jobs:
       - name: Install Python
         uses: actions/setup-python@v3
         with:
-          python-version: "3.12.6"
+          python-version: "3.13.3"
       - name: Upgrade pip and setuptools
         run: pip install --upgrade pip setuptools
       - name: Install development dependencies
         run: pip install --user .
         working-directory: src/backend
+      - name: Restore the mail templates
+        uses: actions/cache@v4
+        id: mail-templates
+        with:
+          path: "src/backend/core/templates/mail"
+          key: mail-templates-${{ hashFiles('src/mail/mjml') }}
+          fail-on-cache-miss: true
       - name: Install gettext
         run: |
           sudo apt-get update

.github/workflows/dependencies.yml

@@ -0,0 +1,85 @@
+name: Dependency reusable workflow
+
+on:
+  workflow_call:
+    inputs:
+      node_version:
+        required: false
+        default: '20.x'
+        type: string
+      with-front-dependencies-installation:
+        type: boolean
+        default: false
+      with-build_mails:
+        type: boolean
+        default: false
+
+jobs:
+  front-dependencies-installation:
+    if: ${{ inputs.with-front-dependencies-installation == true }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Restore the frontend cache
+        uses: actions/cache@v4
+        id: front-node_modules
+        with:
+          path: "src/frontend/**/node_modules"
+          key: front-node_modules-${{ hashFiles('src/frontend/**/yarn.lock') }}
+      - name: Setup Node.js
+        if: steps.front-node_modules.outputs.cache-hit != 'true'
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ inputs.node_version }}
+      - name: Install dependencies
+        if: steps.front-node_modules.outputs.cache-hit != 'true'
+        run: cd src/frontend/ && yarn install --frozen-lockfile
+      - name: Cache install frontend
+        if: steps.front-node_modules.outputs.cache-hit != 'true'
+        uses: actions/cache@v4
+        with:
+          path: "src/frontend/**/node_modules"
+          key: front-node_modules-${{ hashFiles('src/frontend/**/yarn.lock') }}
+
+  build-mails:
+    if: ${{ inputs.with-build_mails == true }}
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: src/mail
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Restore the mail templates
+        uses: actions/cache@v4
+        id: mail-templates
+        with:
+          path: "src/backend/core/templates/mail"
+          key: mail-templates-${{ hashFiles('src/mail/mjml') }}
+
+      - name: Setup Node.js
+        if: steps.mail-templates.outputs.cache-hit != 'true'
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ inputs.node_version }}
+
+      - name: Install yarn
+        if: steps.mail-templates.outputs.cache-hit != 'true'
+        run: npm install -g yarn
+
+      - name: Install node dependencies
+        if: steps.mail-templates.outputs.cache-hit != 'true'
+        run: yarn install --frozen-lockfile
+
+      - name: Build mails
+        if: steps.mail-templates.outputs.cache-hit != 'true'
+        run: yarn build
+
+      - name: Cache mail templates
+        if: steps.mail-templates.outputs.cache-hit != 'true'
+        uses: actions/cache@v4
+        with:
+          path: "src/backend/core/templates/mail"
+          key: mail-templates-${{ hashFiles('src/mail/mjml') }}

.github/workflows/docker-hub.yml

@@ -11,6 +11,7 @@ on:
   pull_request:
     branches:
       - 'main'
+      - 'ci/trivy-fails'
 
 env:
   DOCKER_USER: 1001:127
@@ -38,7 +39,6 @@ jobs:
         with:
           docker-build-args: '--target backend-production -f Dockerfile'
           docker-image-name: 'docker.io/lasuite/impress-backend:${{ github.sha }}'
-        continue-on-error: true
       -
         name: Build and push
         uses: docker/build-push-action@v6
@@ -72,7 +72,6 @@ jobs:
         with:
           docker-build-args: '-f src/frontend/Dockerfile --target frontend-production'
           docker-image-name: 'docker.io/lasuite/impress-frontend:${{ github.sha }}'
-        continue-on-error: true
       -
         name: Build and push
         uses: docker/build-push-action@v6
@@ -80,7 +79,9 @@ jobs:
           context: .
           file: ./src/frontend/Dockerfile
           target: frontend-production
-          build-args: DOCKER_USER=${{ env.DOCKER_USER }}:-1000
+          build-args: |
+            DOCKER_USER=${{ env.DOCKER_USER }}:-1000
+            PUBLISH_AS_MIT=false
           push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
@@ -106,8 +107,7 @@ jobs:
         uses: numerique-gouv/action-trivy-cache@main
         with:
           docker-build-args: '-f src/frontend/servers/y-provider/Dockerfile --target y-provider'
-          docker-image-name: 'docker.io/lasuite/impress-frontend:${{ github.sha }}'
-        continue-on-error: true
+          docker-image-name: 'docker.io/lasuite/impress-y-provider:${{ github.sha }}'
       -
         name: Build and push
         uses: docker/build-push-action@v6
@@ -125,15 +125,11 @@ jobs:
       - build-and-push-frontend
       - build-and-push-backend
     runs-on: ubuntu-latest
-    if: |
-      github.event_name != 'pull_request'
+    if: github.event_name != 'pull_request'
     steps:
-      -
-        name: Checkout repository
-        uses: actions/checkout@v4
-      -
-        name: Call argocd github webhook
-        run: |
-          data='{"ref": "'$GITHUB_REF'","repository": {"html_url":"'$GITHUB_SERVER_URL'/'$GITHUB_REPOSITORY'"}}'
-          sig=$(echo -n ${data} | openssl dgst -sha1 -hmac ''${{ secrets.ARGOCD_PREPROD_WEBHOOK_SECRET}}'' | awk '{print "X-Hub-Signature: sha1="$2}')
-          curl -X POST -H 'X-GitHub-Event:push' -H "Content-Type: application/json" -H "${sig}" --data "${data}" ${{ vars.ARGOCD_PREPROD_WEBHOOK_URL }}
+      - uses: numerique-gouv/action-argocd-webhook-notification@main
+        id: notify
+        with:
+          deployment_repo_path: "${{ secrets.DEPLOYMENT_REPO_URL }}"
+          argocd_webhook_secret: "${{ secrets.ARGOCD_PREPROD_WEBHOOK_SECRET }}"
+          argocd_url: "${{ vars.ARGOCD_PREPROD_WEBHOOK_URL }}"

.github/workflows/front-dependencies-installation.yml

@@ -1,36 +0,0 @@
-name: Install frontend installation reusable workflow
-
-on:
-  workflow_call:
-    inputs:
-      node_version:
-        required: false
-        default: '20.x'
-        type: string
-
-jobs:
-  front-dependencies-installation:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      - name: Restore the frontend cache
-        uses: actions/cache@v4
-        id: front-node_modules
-        with:
-          path: "src/frontend/**/node_modules"
-          key: front-node_modules-${{ hashFiles('src/frontend/**/yarn.lock') }}
-      - name: Setup Node.js
-        if: steps.front-node_modules.outputs.cache-hit != 'true'
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ inputs.node_version }}
-      - name: Install dependencies
-        if: steps.front-node_modules.outputs.cache-hit != 'true'
-        run: cd src/frontend/ && yarn install --frozen-lockfile
-      - name: Cache install frontend
-        if: steps.front-node_modules.outputs.cache-hit != 'true'
-        uses: actions/cache@v4
-        with:
-          path: "src/frontend/**/node_modules"
-          key: front-node_modules-${{ hashFiles('src/frontend/**/yarn.lock') }}

.github/workflows/helmfile-linter.yaml

@@ -11,7 +11,7 @@ jobs:
   helmfile-lint:
     runs-on: ubuntu-latest
     container:
-      image: ghcr.io/helmfile/helmfile:latest
+      image: ghcr.io/helmfile/helmfile:v0.171.0
     steps:
     -
       name: Checkout repository
@@ -22,9 +22,9 @@ jobs:
       run: |
         set -e
         HELMFILE=src/helm/helmfile.yaml
-        environments=$(awk '/environments:/ {flag=1; next} flag && NF {print} !NF {flag=0}' "$HELMFILE" | grep -E '^[[:space:]]{2}[a-zA-Z]+' | sed 's/^[[:space:]]*//;s/:.*//')
+        environments=$(awk 'BEGIN {in_env=0} /^environments:/ {in_env=1; next} /^---/ {in_env=0} in_env && /^  [^ ]/ {gsub(/^  /,""); gsub(/:.*$/,""); print}' "$HELMFILE")
         for env in $environments; do
           echo "################### $env lint ###################"
           helmfile -e $env -f $HELMFILE lint || exit 1
           echo -e "\n"
-        done
+        done

.github/workflows/impress-frontend.yml

@@ -10,13 +10,14 @@ on:
 
 jobs:
 
-  install-front:
-    uses: ./.github/workflows/front-dependencies-installation.yml
+  install-dependencies:
+    uses: ./.github/workflows/dependencies.yml
     with:
       node_version: '20.x'
+      with-front-dependencies-installation: true
 
   test-front:
-    needs: install-front
+    needs: install-dependencies
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
@@ -39,7 +40,7 @@ jobs:
 
   lint-front:
     runs-on: ubuntu-latest
-    needs: install-front
+    needs: install-dependencies
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
@@ -60,7 +61,7 @@ jobs:
 
   test-e2e-chromium:
     runs-on: ubuntu-latest
-    needs: install-front
+    needs: install-dependencies
     timeout-minutes: 20
     steps:
       - name: Checkout repository
@@ -87,28 +88,6 @@ jobs:
       - name: Start Docker services
         run: make bootstrap FLUSH_ARGS='--no-input' cache=
 
-      # Tool to wait for a service to be ready
-      - name: Install Dockerize
-        run: |
-          curl -sSL https://github.com/jwilder/dockerize/releases/download/v0.8.0/dockerize-linux-amd64-v0.8.0.tar.gz | sudo tar -C /usr/local/bin -xzv
-
-      - name: Wait for services to be ready
-        run: |
-          printf "Minio check...\n"
-          dockerize -wait tcp://localhost:9000 -timeout 20s
-          printf "Keyclock check...\n"
-          dockerize -wait tcp://localhost:8080 -timeout 20s
-          printf "Server collaboration check...\n"
-          dockerize -wait tcp://localhost:4444 -timeout 20s
-          printf "Ngnix check...\n"
-          dockerize -wait tcp://localhost:8083 -timeout 20s
-          printf "DRF check...\n"
-          dockerize -wait tcp://localhost:8071 -timeout 20s
-          printf "Postgres Keyclock check...\n"
-          dockerize -wait tcp://localhost:5433 -timeout 20s
-          printf "Postgres back check...\n"
-          dockerize -wait tcp://localhost:15432 -timeout 20s
-
       - name: Run e2e tests
         run: cd src/frontend/ && yarn e2e:test --project='chromium'
 
@@ -127,8 +106,17 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v4
 
-      - name: Install frontend dependencies
-        uses: ./.github/workflows/front-dependencies-installation.yml
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20.x"
+
+      - name: Restore the frontend cache
+        uses: actions/cache@v4
+        with:
+          path: "src/frontend/**/node_modules"
+          key: front-node_modules-${{ hashFiles('src/frontend/**/yarn.lock') }}
+          fail-on-cache-miss: true
 
       - name: Set e2e env variables
         run: cat env.d/development/common.e2e.dist >> env.d/development/common.dist

.github/workflows/impress.yml

@@ -9,6 +9,11 @@ on:
       - "*"
 
 jobs:
+  install-dependencies:
+    uses: ./.github/workflows/dependencies.yml
+    with:
+      with-build_mails: true
+
   lint-git:
     runs-on: ubuntu-latest
     if: github.event_name == 'pull_request' # Makes sense only for pull requests
@@ -56,45 +61,24 @@ jobs:
             exit 1
           fi
 
-  build-mails:
+  lint-spell-mistakes:
     runs-on: ubuntu-latest
-    defaults:
-      run:
-        working-directory: src/mail
+    if: github.event_name == 'pull_request'
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4
-
-      - name: Install Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: "18"
-
-      - name: Restore the mail templates
-        uses: actions/cache@v4
-        id: mail-templates
-        with:
-          path: "src/backend/core/templates/mail"
-          key: mail-templates-${{ hashFiles('src/mail/mjml') }}
-
-      - name: Install yarn
-        if: steps.mail-templates.outputs.cache-hit != 'true'
-        run: npm install -g yarn
-
-      - name: Install node dependencies
-        if: steps.mail-templates.outputs.cache-hit != 'true'
-        run: yarn install --frozen-lockfile
-
-      - name: Build mails
-        if: steps.mail-templates.outputs.cache-hit != 'true'
-        run: yarn build
-
-      - name: Cache mail templates
-        if: steps.mail-templates.outputs.cache-hit != 'true'
-        uses: actions/cache@v4
-        with:
-          path: "src/backend/core/templates/mail"
-          key: mail-templates-${{ hashFiles('src/mail/mjml') }}
+        uses: actions/checkout@v2
+      - name: Install codespell
+        run: pip install --user codespell
+      - name: Check for typos
+        run: |
+          codespell \
+            --check-filenames \
+            --ignore-words-list "Dokument,afterAll,excpt,statics" \
+            --skip "./git/" \
+            --skip "**/*.po" \
+            --skip "**/*.pot" \
+            --skip "**/*.json" \
+            --skip "**/yarn.lock"
 
   lint-back:
     runs-on: ubuntu-latest
@@ -107,7 +91,7 @@ jobs:
       - name: Install Python
         uses: actions/setup-python@v3
         with:
-          python-version: "3.12.6"
+          python-version: "3.13.3"
       - name: Upgrade pip and setuptools
         run: pip install --upgrade pip setuptools
       - name: Install development dependencies
@@ -121,7 +105,7 @@ jobs:
 
   test-back:
     runs-on: ubuntu-latest
-    needs: build-mails
+    needs: install-dependencies
 
     defaults:
       run:
@@ -169,6 +153,7 @@ jobs:
         with:
           path: "src/backend/core/templates/mail"
           key: mail-templates-${{ hashFiles('src/mail/mjml') }}
+          fail-on-cache-miss: true
 
       - name: Start MinIO
         run: |
@@ -201,7 +186,7 @@ jobs:
       - name: Install Python
         uses: actions/setup-python@v3
         with:
-          python-version: "3.12.6"
+          python-version: "3.13.3"
 
       - name: Install development dependencies
         run: pip install --user .[dev]

.gitignore

@@ -41,7 +41,6 @@ ENV/
 env.bak/
 venv.bak/
 env.d/development/*
-env.d/production/*
 !env.d/development/*.dist
 env.d/terraform
 

CHANGELOG.md

@@ -6,19 +6,249 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0),
 and this project adheres to
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-
 ## [Unreleased]
 
+## [3.3.0] - 2025-05-06
+
+### Added
+
+- ✨(backend) add endpoint checking media status #984
+- ✨(backend) allow setting session cookie age via env var #977
+- ✨(backend) allow theme customnization using a configuration file #948
+- ✨(frontend) Add a custom callout block to the editor #892
+- 🚩(frontend) version MIT only #911
+- ✨(backend) integrate maleware_detection from django-lasuite #936
+- 🏗️(frontend) Footer configurable #959
+- 🩺(CI) add lint spell mistakes #954
+- ✨(frontend) create generic theme #792
+- 🛂(frontend) block edition to not connected users #945
+- 🚸(frontend) Let loader during upload analyze #984
+- 🚩(frontend) feature flag on blocking edition #997
+
+### Changed
+
+- 📝(frontend) Update documentation #949
+- ✅(frontend) Improve tests coverage #949
+- ⬆️(docker) upgrade backend image to python 3.13 #973
+- ⬆️(docker) upgrade node images to alpine 3.21 #973
+
+### Fixed
+- 🐛(y-provider) increase JSON size limits for transcription conversion #989
+
+### Removed
+
+- 🔥(back) remove footer endpoint #948
+
+
+## [3.2.1] - 2025-05-06
+
+## Fixed
+
+- 🐛(frontend) fix list copy paste #943
+- 📝(doc) update contributing policy (commit signatures are now mandatory) #895
+
+
+## [3.2.0] - 2025-05-05
+
 ## Added
 
-- github actions to managed Crowdin workflow
+- 🚸(backend) make document search on title accent-insensitive #874
+- 🚩 add homepage feature flag #861
+- 📝(doc) update contributing policy (commit signatures are now mandatory) #895
+- ✨(settings) Allow configuring PKCE for the SSO #886
+- 🌐(i18n) activate chinese and spanish languages #884
+- 🔧(backend) allow overwriting the data directory #893
+- ➕(backend) add  `django-lasuite` dependency #839
+- ✨(frontend) advanced table features #908
+
+## Changed
+
+- ⚡️(frontend) reduce unblocking time for config #867
+- ♻️(frontend) bind UI with ability access #900
+- ♻️(frontend) use built-in Quote block #908
+
+## Fixed
+
+- 🐛(nginx) fix 404 when accessing a doc #866
+- 🔒️(drf) disable browsable HTML API renderer #919
+- 🔒(frontend) enhance file download security #889
+- 🐛(backend) race condition create doc #633
+- 🐛(frontend) fix breaklines in custom blocks #908
+
+## [3.1.0] - 2025-04-07
+
+## Added
+
+- 🚩(backend) add feature flag for the footer #841
+- 🔧(backend) add view to manage footer json #841
+- ✨(frontend) add custom css style #771
+- 🚩(frontend) conditionally render AI button only when feature is enabled #814
+
+## Changed
+
+- 🚨(frontend) block button when creating doc #749
+
+## Fixed
+
+- 🐛(back) validate document content in serializer #822
+- 🐛(frontend) fix selection click past end of content #840
+
+## [3.0.0] - 2025-03-28
+
+## Added
+
+- 📄(legal) Require contributors to sign a DCO #779
+
+## Changed
+
+- ♻️(frontend) Integrate UI kit #783
+- 🏗️(y-provider) manage auth in y-provider app #804
+
+## Fixed
+
+- 🐛(backend) compute ancestor_links in get_abilities if needed #725
+- 🔒️(back) restrict access to document accesses #801
+
+
+## [2.6.0] - 2025-03-21
+
+## Added
+
+- 📝(doc) add publiccode.yml #770
+
+## Changed
+
+- 🚸(frontend) ctrl+k modal not when editor is focused #712
+
+## Fixed
+
+- 🐛(back) allow only images to be used with the cors-proxy #781
+- 🐛(backend) stop returning inactive users on the list endpoint #636
+- 🔒️(backend) require at least 5 characters to search for users #636
+- 🔒️(back) throttle user list endpoint #636
+- 🔒️(back) remove pagination and limit to 5 for user list endpoint #636
+
+
+## [2.5.0] - 2025-03-18
+
+## Added
+
+- 📝(doc) Added GNU Make link to README #750
+- ✨(frontend) add pinning on doc detail #711
+- 🚩(frontend) feature flag analytic on copy as html #649
+- ✨(frontend) Custom block divider with export #698
+- 🌐(i18n) activate dutch language #742
+- ✨(frontend) add Beautify action to AI transform #478
+- ✨(frontend) add Emojify action to AI transform #478
+
+## Changed
+
+- 🧑‍💻(frontend) change literal section open source #702
+- ♻️(frontend) replace cors proxy for export #695
+- 🚨(gitlint) Allow uppercase in commit messages #756
+- ♻️(frontend) Improve AI translations #478
+
+## Fixed
+
+- 🐛(frontend) SVG export #706
+- 🐛(frontend) remove scroll listener table content  #688
+- 🔒️(back) restrict access to favorite_list endpoint #690
+- 🐛(backend) refactor to fix filtering on children 
+    and descendants views #695
+- 🐛(action) fix notify-argocd workflow #713
+- 🚨(helm) fix helmfile lint #736
+- 🚚(frontend) redirect to 401 page when 401 error #759
+
+
+## [2.4.0] - 2025-03-06
+
+## Added
+
+- ✨(frontend) synchronize language-choice #401
+
+## Changed
+
+- Use sentry tags instead of extra scope
+
+## Fixed
+
+- 🐛(frontend) fix collaboration error #684
+
+
+## [2.3.0] - 2025-03-03
+
+## Added
+
+- ✨(backend) limit link reach/role select options depending on ancestors #645
+- ✨(backend) add new "descendants" action to document API endpoint #645
+- ✨(backend) new "tree" action on document detail endpoint #645
+- ✨(backend) allow forcing page size within limits #645
+- 💄(frontend) add error pages #643
+- 🔒️ Manage unsafe attachments #663
+- ✨(frontend) Custom block quote with export #646
+- ✨(frontend) add open source section homepage #666
+- ✨(frontend) synchronize language-choice #401
+
+## Changed
+
+- 🛂(frontend) Restore version visibility #629
+- 📝(doc) minor README.md formatting and wording enhancements
+- ♻️Stop setting a default title on doc creation #634
+- ♻️(frontend) misc ui improvements #644
+
+## Fixed
+
+- 🐛(backend) allow any type of extensions for media download #671
+- ♻️(frontend) improve table pdf rendering
+- 🐛(email) invitation emails in receivers language
+
+## [2.2.0] - 2025-02-10
+
+## Added
+
+- 📝(doc) Add security.md and codeofconduct.md #604
+- ✨(frontend) add home page #608
+- ✨(frontend) cursor display on activity #609
+- ✨(frontend) Add export page break #623
+
+## Changed
+
+- 🔧(backend) make AI feature reach configurable #628
+
+## Fixed
+
+- 🌐(CI) Fix email partially translated #616
+- 🐛(frontend) fix cursor breakline #609
+- 🐛(frontend) fix style pdf export #609
+
+## [2.1.0] - 2025-01-29
+
+## Added
+
+- ✨(backend) add duplicate action to the document API endpoint
+- ⚗️(backend) add util to extract text from base64 yjs document
+- ✨(backend) add soft delete and restore API endpoints to documents #516
+- ✨(backend) allow organizing documents in a tree structure #516
+- ✨(backend) add "excerpt" field to document list serializer #516
+- ✨(backend) add github actions to manage Crowdin workflow #559 & #563
 - 📈Integrate Posthog #540
 - 🏷️(backend) add content-type to uploaded files #552
+- ✨(frontend) export pdf docx front side #537
 
 ## Changed
 
 - 💄(frontend) add abilities on doc row #581
+- 💄(frontend) improve DocsGridItem responsive padding #582
+- 🔧(backend) Bump maximum page size to 200 #516
+- 📝(doc) Improve Read me #558
 
+## Fixed
+
+- 🐛Fix invitations #575
+
+## Removed
+
+- 🔥(backend) remove "content" field from list serializer # 516
 
 ## [2.0.1] - 2025-01-17
 
@@ -37,6 +267,8 @@ and this project adheres to
 - 💄(frontend) add filtering to left panel #475
 - ✨(frontend) new share modal ui #489
 - ✨(frontend) add favorite feature #515
+- 📝(documentation) Documentation about self-hosted installation #530
+- ✨(helm) helm versioning #530
 
 ## Changed
 
@@ -48,7 +280,7 @@ and this project adheres to
 - 💄(frontend) update DocHeader ui #448
 - 💄(frontend) update doc versioning ui #463
 - 💄(frontend) update doc summary ui #473
-- 📝(doc) update readme.md to match V2 changes #558
+- 📝(doc) update readme.md to match V2 changes #558 & #572
 
 ## Fixed
 
@@ -72,12 +304,11 @@ and this project adheres to
 
 - ⚡️(e2e) reduce flakiness on e2e tests #511
 
-
 ## Fixed
+
 - 🐛(frontend) update doc editor height #481
 - 💄(frontend) add doc search #485
 
-
 ## [1.9.0] - 2024-12-11
 
 ## Added
@@ -99,21 +330,18 @@ and this project adheres to
 - 🐛(frontend) Fix hidden menu on Firefox #468
 - 🐛(backend) fix sanitize problem IA #490
 
-
 ## [1.8.2] - 2024-11-28
 
 ## Changed
 
 - ♻️(SW) change strategy html caching #460
 
-
 ## [1.8.1] - 2024-11-27
 
 ## Fixed
 
 - 🐛(frontend) link not clickable and flickering firefox #457
 
-
 ## [1.8.0] - 2024-11-25
 
 ## Added
@@ -142,7 +370,6 @@ and this project adheres to
 - 🐛(frontend) users have view access when revoked #387
 - 🐛(frontend) fix placeholder editable when double clicks #454
 
-
 ## [1.7.0] - 2024-10-24
 
 ## Added
@@ -170,7 +397,6 @@ and this project adheres to
 
 - 🔥(helm) remove infra related codes #366
 
-
 ## [1.6.0] - 2024-10-17
 
 ## Added
@@ -193,7 +419,6 @@ and this project adheres to
 - 🐛(backend) fix nginx docker container #340
 - 🐛(frontend) fix copy paste firefox #353
 
-
 ## [1.5.1] - 2024-10-10
 
 ## Fixed
@@ -228,7 +453,6 @@ and this project adheres to
 - 🔧(backend) fix configuration to avoid different ssl warning #297
 - 🐛(frontend) fix editor break line not working #302
 
-
 ## [1.4.0] - 2024-09-17
 
 ## Added
@@ -249,7 +473,6 @@ and this project adheres to
 - 🐛(backend) Fix forcing ID when creating a document via API endpoint #234
 - 🐛 Rebuild frontend dev container from makefile #248
 
-
 ## [1.3.0] - 2024-09-05
 
 ## Added
@@ -274,7 +497,6 @@ and this project adheres to
 
 - 🔥(frontend) remove saving modal #213
 
-
 ## [1.2.1] - 2024-08-23
 
 ## Changed
@@ -282,7 +504,6 @@ and this project adheres to
 - ♻️ Change ordering docs datagrid #195
 - 🔥(helm) use scaleway email #194
 
-
 ## [1.2.0] - 2024-08-22
 
 ## Added
@@ -306,14 +527,14 @@ and this project adheres to
 - ⚡️(CI) only e2e chrome mandatory #177
 
 ## Removed
-- 🔥(helm) remove htaccess #181
 
+- 🔥(helm) remove htaccess #181
 
 ## [1.1.0] - 2024-07-15
 
 ## Added
 
-- 🤡(demo) generate dummy documents on dev users #120 
+- 🤡(demo) generate dummy documents on dev users #120
 - ✨(frontend) create side modal component #134
 - ✨(frontend) Doc grid actions (update / delete) #136
 - ✨(frontend) Doc editor header information #137
@@ -324,12 +545,11 @@ and this project adheres to
 - ♻️(frontend) create a doc from a modal #132
 - ♻️(frontend) manage members from the share modal #140
 
-
 ## [1.0.0] - 2024-07-02
 
 ## Added
 
-- 🛂(frontend) Manage the document's right (#75) 
+- 🛂(frontend) Manage the document's right (#75)
 - ✨(frontend) Update document (#68)
 - ✨(frontend) Remove document (#68)
 - 🐳(docker) dockerize dev frontend (#63)
@@ -352,7 +572,7 @@ and this project adheres to
 - ⚡️(e2e) unique login between tests (#80)
 - ⚡️(CI) improve e2e job (#86)
 - ♻️(frontend) improve the error and message info ui (#93)
-- ✏️(frontend) change all occurences of pad to doc (#99)
+- ✏️(frontend) change all occurrences of pad to doc (#99)
 
 ## Fixed
 
@@ -363,7 +583,6 @@ and this project adheres to
 - 💚(CI) Remove trigger workflow on push tags on CI (#68)
 - 🔥(frontend) Remove coming soon page (#121)
 
-
 ## [0.1.0] - 2024-05-24
 
 ## Added
@@ -371,8 +590,18 @@ and this project adheres to
 - ✨(frontend) Coming Soon page (#67)
 - 🚀 Impress, project to manage your documents easily and collaboratively.
 
-
-[unreleased]: https://github.com/numerique-gouv/impress/compare/v2.0.1...main
+[unreleased]: https://github.com/numerique-gouv/impress/compare/v3.3.0...main
+[v3.3.0]: https://github.com/numerique-gouv/impress/releases/v3.3.0
+[v3.2.1]: https://github.com/numerique-gouv/impress/releases/v3.2.1
+[v3.2.0]: https://github.com/numerique-gouv/impress/releases/v3.2.0
+[v3.1.0]: https://github.com/numerique-gouv/impress/releases/v3.1.0
+[v3.0.0]: https://github.com/numerique-gouv/impress/releases/v3.0.0
+[v2.6.0]: https://github.com/numerique-gouv/impress/releases/v2.6.0
+[v2.5.0]: https://github.com/numerique-gouv/impress/releases/v2.5.0
+[v2.4.0]: https://github.com/numerique-gouv/impress/releases/v2.4.0
+[v2.3.0]: https://github.com/numerique-gouv/impress/releases/v2.3.0
+[v2.2.0]: https://github.com/numerique-gouv/impress/releases/v2.2.0
+[v2.1.0]: https://github.com/numerique-gouv/impress/releases/v2.1.0
 [v2.0.1]: https://github.com/numerique-gouv/impress/releases/v2.0.1
 [v2.0.0]: https://github.com/numerique-gouv/impress/releases/v2.0.0
 [v1.10.0]: https://github.com/numerique-gouv/impress/releases/v1.10.0

CODE_OF_CONDUCT.md

@@ -0,0 +1,79 @@
+# Contributor Covenant Code of Conduct
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+- Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+- Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+- This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+- Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at docs@numerique.gouv.fr.
+
+- All complaints will be reviewed and investigated promptly and fairly.
+
+- All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+- Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of the following Code of Conduct 
+
+## Code of Conduct:
+
+### 1. Correction
+
+Community Impact: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+Consequence: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+Community Impact: A violation through a single incident or series of actions.
+
+Consequence: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+Community Impact: A serious violation of community standards, including sustained inappropriate behavior.
+
+Consequence: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+Community Impact: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+Consequence: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the Contributor Covenant, version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by Mozilla's [code of conduct enforcement ladder](https://github.com/mozilla/inclusion/blob/master/code-of-conduct-enforcement/consequence-ladder.md).
+
+For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -2,7 +2,16 @@
 
 Thank you for taking the time to contribute! Please follow these guidelines to ensure a smooth and productive workflow. 🚀🚀🚀
 
-To get started with the project, please refer to the [README.md](https://github.com/numerique-gouv/impress/blob/main/README.md) for detailed instructions.
+To get started with the project, please refer to the [README.md](https://github.com/suitenumerique/docs/blob/main/README.md) for detailed instructions on how to run Docs locally.
+
+Contributors are required to sign off their commits with `git commit --signoff`: this confirms that they have read and accepted the [Developer's Certificate of Origin 1.1](https://developercertificate.org/). For security reasons we also require [signing your commits with your SSH or GPG key](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification) with `git commit -S`.
+
+Please also check out our [dev handbook](https://suitenumerique.gitbook.io/handbook) to learn our best practices.
+
+## Help us with translations
+
+You can help us with translations on [Crowdin](https://crowdin.com/project/lasuite-docs).
+Your language is not there? Request it on our Crowdin page 😊 or ping us on [Matrix](https://matrix.to/#/#docs-official:matrix.org) and let us know if you can help with translations and/or proofreading.
 
 ## Creating an Issue
 
@@ -26,10 +35,14 @@ All commit messages must adhere to the following format:
 
 `<gitmoji>(type) title description`
 
-*   <**gitmoji**>: Use a gitmoji to represent the purpose of the commit. For example, ✨ for adding a new feature or 🔥 for removing something, see the list here: <https://gitmoji.dev/>.
+*   <**gitmoji**>: Use a gitmoji to represent the purpose of the commit. For example, ✨ for adding a new feature or 🔥 for removing something, see the list [here](https://gitmoji.dev/).
 *   **(type)**: Describe the type of change. Common types include `backend`, `frontend`, `CI`, `docker` etc...
-*   **title**: A short, descriptive title for the change, starting with a lowercase character.
-*   **description**: Include additional details about what was changed and why.
+*   **title**: A short, descriptive title for the change (*)
+*   **blank line after the commit title
+*   **description**: Include additional details on why you made the changes (**).
+    
+    (*) ⚠️ **Make sure you add no space between the emoji and the (type) but add a space after the closing parenthesis of the type and use no caps!**
+    (**) ⚠️ **Commit description message is mandatory and shouldn't be too long**
 
 ### Example Commit Message
 
@@ -57,7 +70,9 @@ Please add a line to the changelog describing your development. The changelog en
 It is nice to add information about the purpose of the pull request to help reviewers understand the context and intent of the changes. If you can, add some pictures or a small video to show the changes.
 
 ### Don't forget to: 
-- check your commits
+- signoff your commits
+- sign your commits with your key (SSH, GPG etc.)
+- check your commits (see warnings above)
 - check the linting: `make lint && make frontend-lint`
 - check the tests: `make test`
 - add a changelog entry
@@ -77,3 +92,11 @@ Make sure that all new features or fixes have corresponding tests. Run the test
 If you need any help while contributing, feel free to open a discussion or ask for guidance in the issue tracker. We are more than happy to assist!
 
 Thank you for your contributions! 👍
+
+## Contribute to BlockNote
+We use [BlockNote](https://www.blocknotejs.org/) for the text editing features of Docs. 
+If you find and issue with the editor you can [report it](https://github.com/TypeCellOS/BlockNote/issues) directly on their repository.
+
+Please consider contributing to BlockNotejs, as a library, it's useful to many projects not just Docs.
+
+The project is licended with Mozilla Public License Version 2.0 but be aware that [XL packages](https://github.com/TypeCellOS/BlockNote/blob/main/packages/xl-docx-exporter/LICENSE) are dual licenced with GNU AFFERO GENERAL PUBLIC LICENCE Version 3 and proprietary licence if you are [sponsor](https://www.blocknotejs.org/pricing).

Dockerfile

@@ -1,7 +1,7 @@
 # Django impress
 
 # ---- base image to inherit from ----
-FROM python:3.12.6-alpine3.20 AS base
+FROM python:3.13.3-alpine AS base
 
 # Upgrade pip to its latest release to speed up dependencies installation
 RUN python -m pip install --upgrade pip setuptools
@@ -15,6 +15,13 @@ FROM base AS back-builder
 
 WORKDIR /builder
 
+# Install Rust and Cargo using Alpine's package manager
+RUN apk add --no-cache \
+  build-base \
+  libffi-dev \
+  rust \
+  cargo
+
 # Copy required python dependencies
 COPY ./src/backend /builder
 
@@ -23,7 +30,7 @@ RUN mkdir /install && \
 
 
 # ---- mails ----
-FROM node:20 AS mail-builder
+FROM node:24 AS mail-builder
 
 COPY ./src/mail /mail/app
 
@@ -72,7 +79,6 @@ RUN apk add \
   gettext \
   gdk-pixbuf \
   libffi-dev \
-  pandoc \
   pango \
   shared-mime-info
 
@@ -133,6 +139,9 @@ CMD ["python", "manage.py", "runserver", "0.0.0.0:8000"]
 # ---- Production image ----
 FROM core AS backend-production
 
+# Remove apk cache, we don't need it anymore
+RUN rm -rf /var/cache/apk/*
+
 ARG IMPRESS_STATIC_ROOT=/data/static
 
 # Gunicorn

Makefile

@@ -38,8 +38,7 @@ DB_PORT            = 5432
 DOCKER_UID          = $(shell id -u)
 DOCKER_GID          = $(shell id -g)
 DOCKER_USER         = $(DOCKER_UID):$(DOCKER_GID)
-COMPOSE             = DOCKER_USER=$(DOCKER_USER) ./bin/compose
-COMPOSE_PRODUCTION  = DOCKER_USER=$(DOCKER_USER) COMPOSE_FILE=compose.production.yaml ./bin/compose
+COMPOSE             = DOCKER_USER=$(DOCKER_USER) docker compose
 COMPOSE_EXEC        = $(COMPOSE) exec
 COMPOSE_EXEC_APP    = $(COMPOSE_EXEC) app-dev
 COMPOSE_RUN         = $(COMPOSE) run --rm
@@ -65,19 +64,6 @@ data/media:
 data/static:
 	@mkdir -p data/static
 
-# -- production volumes
-data/production/media:
-	@mkdir -p data/production/media
-
-data/production/certs:
-	@mkdir -p data/production/certs
-
-data/production/databases/backend:
-	@mkdir -p data/production/databases/backend
-
-data/production/databases/keycloak:
-	@mkdir -p data/production/databases/keycloak
-
 # -- Project
 
 create-env-files: ## Copy the dist env files to env files
@@ -94,35 +80,14 @@ bootstrap: \
 	data/static \
 	create-env-files \
 	build \
-	run-with-frontend \
 	migrate \
 	demo \
 	back-i18n-compile \
 	mails-install \
-	mails-build
+	mails-build \
+	run
 .PHONY: bootstrap
 
-bootstrap-production: ## Prepare project to run in production mode using docker compose
-bootstrap-production: \
-	env.d/production \
-	data/production/media \
-	data/production/certs \
-	data/production/databases/backend \
-	data/production/databases/keycloak
-bootstrap-production:
-	@echo 'Environment files created in env.d/production'
-	@echo 'Edit them to set good value for your production environment'
-.PHONY: bootstrap-production
-
-run-production: ## Run compose project in production mode
-	@$(COMPOSE_PRODUCTION) up -d ingress
-.PHONY: run-production
-
-stop-production: ## Stop compose project in production mode
-	@$(COMPOSE_PRODUCTION) stop
-.PHONY: stop-production
-
-
 # -- Docker/compose
 build: cache ?= --no-cache
 build: ## build the project containers
@@ -143,7 +108,7 @@ build-yjs-provider: ## build the y-provider container
 
 build-frontend: cache ?=
 build-frontend: ## build the frontend container
-	@$(COMPOSE) build frontend-dev $(cache)
+	@$(COMPOSE) build frontend $(cache)
 .PHONY: build-frontend
 
 down: ## stop and remove containers, networks, images, and volumes
@@ -154,16 +119,17 @@ logs: ## display app-dev logs (follow mode)
 	@$(COMPOSE) logs -f app-dev
 .PHONY: logs
 
-run: ## start the wsgi (production) and development server
+run-backend: ## Start only the backend application and all needed services
 	@$(COMPOSE) up --force-recreate -d celery-dev
 	@$(COMPOSE) up --force-recreate -d y-provider
 	@$(COMPOSE) up --force-recreate -d nginx
-.PHONY: run
+.PHONY: run-backend
 
-run-with-frontend: ## Start all the containers needed (backend to frontend)
-	@$(MAKE) run
-	@$(COMPOSE) up --force-recreate -d frontend-dev
-.PHONY: run-with-frontend
+run: ## start the wsgi (production) and development server
+run: 
+	@$(MAKE) run-backend
+	@$(COMPOSE) up --force-recreate -d frontend
+.PHONY: run
 
 status: ## an alias for "docker compose ps"
 	@$(COMPOSE) ps
@@ -259,8 +225,6 @@ resetdb: ## flush database and create a superuser "admin"
 	@${MAKE} superuser
 .PHONY: resetdb
 
-# -- Environment variable files
-
 env.d/development/common:
 	cp -n env.d/development/common.dist env.d/development/common
 
@@ -270,9 +234,6 @@ env.d/development/postgresql:
 env.d/development/kc_postgresql:
 	cp -n env.d/development/kc_postgresql.dist env.d/development/kc_postgresql
 
-env.d/production:
-	cp -rnf env.d/production.dist env.d/production
-
 # -- Internationalization
 
 env.d/development/crowdin:
@@ -345,16 +306,16 @@ help:
 .PHONY: help
 
 # Front
-frontend-install: ## install the frontend locally
+frontend-development-install: ## install the frontend locally
 	cd $(PATH_FRONT_IMPRESS) && yarn
-.PHONY: frontend-install
+.PHONY: frontend-development-install
 
 frontend-lint: ## run the frontend linter
 	cd $(PATH_FRONT) && yarn lint
 .PHONY: frontend-lint
 
 run-frontend-development: ## Run the frontend in development mode
-	@$(COMPOSE) stop frontend-dev
+	@$(COMPOSE) stop frontend
 	cd $(PATH_FRONT_IMPRESS) && yarn dev
 .PHONY: run-frontend-development
 

Procfile

@@ -0,0 +1,2 @@
+web: bin/buildpack_start.sh
+postdeploy: python manage.py migrate

README.md

@@ -1,100 +1,123 @@
 <p align="center">
   <a href="https://github.com/suitenumerique/docs">
-    <img alt="Docs" src="/docs/assets/logo-docs.png" width="300" />
+    <img alt="Docs" src="/docs/assets/banner-docs.png" width="100%" />
   </a>
 </p>
-
 <p align="center">
-Welcome to Docs! The open source document editor where your notes can become knowledge through live collaboration
+  <a href="https://github.com/suitenumerique/docs/stargazers/">
+    <img src="https://img.shields.io/github/stars/suitenumerique/docs" alt="">
+  </a>
+  <a href='https://github.com/suitenumerique/docs/blob/main/CONTRIBUTING.md'><img alt='PRs Welcome' src='https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=shields'/></a>
+  <img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/suitenumerique/docs"/>
+  <img alt="GitHub closed issues" src="https://img.shields.io/github/issues-closed/suitenumerique/docs"/>
+  <a href="https://github.com/suitenumerique/docs/blob/main/LICENSE">
+    <img alt="GitHub closed issues" src="https://img.shields.io/github/license/suitenumerique/docs"/>
+  </a>    
 </p>
-
 <p align="center">
   <a href="https://matrix.to/#/#docs-official:matrix.org">
     Chat on Matrix
   </a> - <a href="/docs/">
     Documentation
-  </a> - <a href="#getting-started">
+  </a> - <a href="#getting-started-">
     Getting started
+  </a> - <a href="mailto:docs@numerique.gouv.fr">
+    Reach out
   </a>
 </p>
 
+# La Suite Docs : Collaborative Text Editing
+Docs, where your notes can become knowledge through live collaboration.
+
 <img src="/docs/assets/docs_live_collaboration_light.gif" width="100%" align="center"/>
 
 ## Why use Docs ❓
 Docs is a collaborative text editor designed to address common challenges in knowledge building and sharing.
 
-### Write
-*   😌 Simple collaborative editing without the formatting complexity of markdown
-*   🔌 Offline? No problem, keep writing, your edits will get synced when back online
-*   💅 Create clean documents with limited but beautiful formatting options and focus on content
-*   🧱 Built for productivity (markdown support, many block types, slash commands, markdown support, keyboard shortcuts) (page in french sorry 😅).
-*   ✨ Save time thanks to our AI actions (generate, sum up, correct, translate)
+It offers a scalable and secure alternative to tools such as Google Docs, Notion (without the dbs), Outline, or Confluence.
 
-### Collaborate
-*   🤝 Collaborate in realtime with your team mates
-*   🔒 Granular access control to keep your information secure and shared with the right people
-*   📑 Professional document exports in multiple formats (.odt, .doc, .pdf) with customizable templates
-*   📚 Built-in wiki functionality to transform your team's collaborative work into organized knowledge `ETA 02/2025`
+### Write
+* 😌 Get simple, accessible online editing for your team.
+* 💅 Create clean documents with beautiful formatting options.
+* 🖌️ Focus on your content using either the in-line editor, or [the Markdown syntax](https://www.markdownguide.org/basic-syntax/).
+* 🧱 Quickly design your page thanks to the many block types, accessible from the `/` slash commands, as well as keyboard shortcuts.
+* 🔌 Write offline! Your edits will be synced once you're back online.
+* ✨ Save time thanks to our AI actions, such as rephrasing, summarizing, fixing typos, translating, etc. You can even turn your selected text into a prompt!
+
+### Work together
+* 🤝 Enjoy live editing! See your team collaborate in real time.
+* 🔒 Keep your information secure thanks to granular access control. Only share with the right people.
+* 📑 Export your content in multiple formats (`.odt`, `.docx`, `.pdf`) with customizable templates.
+* 📚 Turn your team's collaborative work into organized knowledge with Subpages.
 
 ### Self-host
-*   🚀 Easy to install, scalable and secure alternative to Notion, Outline or Confluence
+🚀 Docs is easy to install on your own servers
+
+Available methods: Helm chart, Nix package
+
+In the works: Docker Compose, YunoHost
+
+⚠️ For some advanced features (ex: Export as PDF) Docs relies on XL packages from BlockNote. These are licenced under AGPL-3.0 and are not MIT compatible. You can perfectly use Docs without these packages by setting the environment variable `PUBLISH_AS_MIT` to true. That way you'll build an image of the application without the features that are not MIT compatible. Read the [environment variables documentation](/docs/docs/env.md) for more information.
 
 ## Getting started 🔧
+
 ### Test it
-Test Docs on your browser by logging in on this [environment](https://impress-preprod.beta.numerique.gouv.fr/docs/0aa856e9-da41-4d59-b73d-a61cb2c1245f/)
-```
-email: test.docs@yopmail.com
-password: I'd<3ToTestDocs
-```
-### Run it locally
+
+You can test Docs on your browser by visiting this [demo document](https://impress-preprod.beta.numerique.gouv.fr/docs/6ee5aac4-4fb9-457d-95bf-bb56c2467713/)
+
+### Run Docs locally
+
+> ⚠️ The methods described below for running Docs locally is **for testing purposes only**. It is based on building Docs using [Minio](https://min.io/) as an S3-compatible storage solution. Of course you can choose any S3-compatible storage solution.
+
 **Prerequisite**
-Make sure you have a recent version of Docker and [Docker Compose](https://docs.docker.com/compose/install) installed on your laptop:
+
+Make sure you have a recent version of Docker and [Docker Compose](https://docs.docker.com/compose/install) installed on your laptop, then type:
 
 ```shellscript
 $ docker -v
-  Docker version 27.4.1, build b9d17ea
+
+Docker version 20.10.2, build 2291f61
 
 $ docker compose version
-  Docker Compose version v2.32.1
+
+Docker Compose version v2.32.4
 ```
 
-> ⚠️ You may need to run the following commands with sudo but this can be avoided by assigning your user to the `docker` group.
+> ⚠️ You may need to run the following commands with `sudo`, but this can be avoided by adding your user to the local `docker` group.
 
 **Project bootstrap**
-The easiest way to start working on the project is to use GNU Make:
+
+The easiest way to start working on the project is to use [GNU Make](https://www.gnu.org/software/make/):
 
 ```shellscript
 $ make bootstrap FLUSH_ARGS='--no-input'
 ```
 
-This command builds the `app` container, installs dependencies, performs database migrations and compile translations. It's a good idea to use this
-
-command each time you are pulling code from the project repository to avoid dependency-releated or migration-releated issues.
+This command builds the `app` container, installs dependencies, performs database migrations and compiles translations. It's a good idea to use this command each time you are pulling code from the project repository to avoid dependency-related or migration-related issues.
 
 Your Docker services should now be up and running 🎉
 
 You can access to the project by going to <http://localhost:3000>.
 
-You will be prompted to log in, the default credentials are:
+You will be prompted to log in. The default credentials are:
 
-```shellscript
+```
 username: impress
-
 password: impress
 ```
 
 📝 Note that if you need to run them afterwards, you can use the eponym Make rule:
 
 ```shellscript
-$ make run-with-frontend
+$ make run
 ```
 
-⚠️ For the frontend developper, it is often better to run the frontend in development mode locally.
+⚠️ For the frontend developer, it is often better to run the frontend in development mode locally.
 
 To do so, install the frontend dependencies with the following command:
 
 ```shellscript
-$ make frontend-install
+$ make frontend-development-install
 ```
 
 And run the frontend locally in development mode with the following command:
@@ -106,24 +129,26 @@ $ make run-frontend-development
 To start all the services, except the frontend container, you can use the following command:
 
 ```shellscript
-$ make run
+$ make run-backend
 ```
 
 **Adding content**
-You can create a basic demo site by running:
+
+You can create a basic demo site by running this command:
 
 ```shellscript
 $ make demo
 ```
 
-Finally, you can check all available Make rules using:
+Finally, you can check all available Make rules using this command:
 
 ```shellscript
 $ make help
 ```
 
 **Django admin**
-You can access the Django admin site at
+
+You can access the Django admin site at:
 
 <http://localhost:8071/admin>.
 
@@ -134,22 +159,28 @@ $ make superuser
 ```
 
 ## Feedback 🙋‍♂️🙋‍♀️
-We'd love to hear your thoughts and hear about your experiments, so come and say hi on [Matrix](https://matrix.to/#/#docs-official:matrix.org).
+
+We'd love to hear your thoughts, and hear about your experiments, so come and say hi on [Matrix](https://matrix.to/#/#docs-official:matrix.org).
 
 ## Roadmap
+
 Want to know where the project is headed? [🗺️ Checkout our roadmap](https://github.com/orgs/numerique-gouv/projects/13/views/11)
 
 ## Licence 📝
+
 This work is released under the MIT License (see [LICENSE](https://github.com/suitenumerique/docs/blob/main/LICENSE)).
 
-While Docs is public driven initiative our licence choice is an invitation for private sector actors to use, sell and contribute to the project. 
+While Docs is a public-driven initiative, our licence choice is an invitation for private sector actors to use, sell and contribute to the project. 
 
 ## Contributing 🙌
-This project is intended to be community-driven, so please, do not hesitate to get in touch if you have any question related to our implementation or design decisions.
 
-If you intend to make pull requests see CONTRIBUTING for guidelines.
+This project is intended to be community-driven, so please, do not hesitate to [get in touch](https://matrix.to/#/#docs-official:matrix.org) if you have any question related to our implementation or design decisions.
 
-Directory structure:
+You can help us with translations on [Crowdin](https://crowdin.com/project/lasuite-docs).
+
+If you intend to make pull requests, see [CONTRIBUTING](https://github.com/suitenumerique/docs/blob/main/CONTRIBUTING.md) for guidelines.
+
+## Directory structure:
 
 ```markdown
 docs
@@ -164,8 +195,19 @@ docs
 ```
 
 ## Credits ❤️
-### Stack
-Impress is built on top of [Django Rest Framework](https://www.django-rest-framework.org/), [Next.js](https://nextjs.org/), [MinIO](https://min.io/) and [BlocNote.js](https://www.blocknotejs.org/)
 
-### States ❤️ open source
-Docs is the result of a joint effort lead by the French 🇫🇷🥖 ([DINUM](https://www.numerique.gouv.fr/dinum/)) and German 🇩🇪🥨 government ([ZenDiS](https://zendis.de/)). We are always looking for new public partners feel free to reach out if you are interested in using or contributing to docs.
+### Stack
+
+Docs is built on top of [Django Rest Framework](https://www.django-rest-framework.org/), [Next.js](https://nextjs.org/), [BlockNote.js](https://www.blocknotejs.org/), [HocusPocus](https://tiptap.dev/docs/hocuspocus/introduction) and [Yjs](https://yjs.dev/). We thank the contributors of all these projects for their awesome work!
+
+We are proud sponsors of [BlockNotejs](https://www.blocknotejs.org/) and [Yjs](https://yjs.dev/). 
+
+
+### Gov ❤️ open source
+Docs is the result of a joint effort led by the French 🇫🇷🥖 ([DINUM](https://www.numerique.gouv.fr/dinum/)) and German 🇩🇪🥨 governments ([ZenDiS](https://zendis.de/)). 
+
+We are always looking for new public partners (we are currently onboarding the Netherlands 🇳🇱🧀), feel free to [reach out](mailto:docs@numerique.gouv.fr) if you are interested in using or contributing to Docs.
+
+<p align="center">
+  <img src="/docs/assets/europe_opensource.png" width="50%"/>
+</p>

SECURITY.md

@@ -0,0 +1,23 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+Security is very important to us.
+
+If you have any issue regarding security, please disclose the information responsibly submitting [this form](https://vdp.numerique.gouv.fr/p/Send-a-report?lang=en) and not by creating an issue on the repository. You can also email us at docs@numerique.gouv.fr
+
+We appreciate your effort to make Docs more secure.
+
+## Vulnerability disclosure policy
+
+Working with security issues in an open source project can be challenging, as we are required to disclose potential problems that could be exploited by attackers. With this in mind, our security fix policy is as follows:
+
+1. The Maintainers team will handle the fix as usual (Pull Request,
+release).
+2. In the release notes, we will include the identification numbers from the
+GitHub Advisory Database (GHSA) and, if applicable, the Common Vulnerabilities
+and Exposures (CVE) identifier for the vulnerability.
+3. Once this grace period has passed, we will publish the vulnerability.
+
+By adhering to this security policy, we aim to address security concerns
+effectively and responsibly in our open source software project.

UPGRADE.md

@@ -15,3 +15,29 @@ the following command inside your docker container:
 (Note : in your development environment, you can `make migrate`.)
 
 ## [Unreleased]
+
+## [3.3.0] - 2025-05-22
+
+⚠️ For some advanced features (ex: Export as PDF) Docs relies on XL packages from BlockNote. These are licenced under AGPL-3.0 and are not MIT compatible. You can perfectly use Docs without these packages by setting the environment variable `PUBLISH_AS_MIT` to true. That way you'll build an image of the application without the features that are not MIT compatible. Read the [environment variables documentation](/docs/docs/env.md) for more information.
+
+The footer is now configurable from a customization file. To override the default one, you can
+use the `THEME_CUSTOMIZATION_FILE_PATH` environment variable to point to your customization file.
+The customization file must be a JSON file and must follow the rules described in the
+[theming documentation](docs/theming.md).
+
+## [3.0.0] - 2025-03-28
+
+We are not using the nginx auth request anymore to access the collaboration server (`yProvider`)
+The authentication is now managed directly from the yProvider server. 
+You must remove the annotation `nginx.ingress.kubernetes.io/auth-url` from the `ingressCollaborationWS`.
+
+This means as well that the yProvider server must be able to access the Django server.
+To do so, you must set the `COLLABORATION_BACKEND_BASE_URL` environment variable to the `yProvider`
+service.
+
+## [2.2.0] - 2025-02-10
+
+- AI features are now limited to users who are authenticated. Before this release, even anonymous
+  users who gained editor access on a document with link reach used to get AI feature.
+  IF you want anonymous users to keep access on AI features, you must now define the
+  `AI_ALLOW_REACH_FROM` setting to "public".

bin/Tiltfile

@@ -39,6 +39,9 @@ docker_build(
     ]
 )
 
+k8s_resource('impress-docs-backend-migrate', resource_deps=['postgres-postgresql'])
+k8s_resource('impress-docs-backend-createsuperuser', resource_deps=['impress-docs-backend-migrate'])
+k8s_resource('impress-docs-backend', resource_deps=['impress-docs-backend-migrate'])
 k8s_yaml(local('cd ../src/helm && helmfile -n impress -e dev template .'))
 
 migration = '''

bin/_config.sh

@@ -6,9 +6,8 @@ REPO_DIR="$(cd "$( dirname "${BASH_SOURCE[0]}" )/.." && pwd)"
 UNSET_USER=0
 
 TERRAFORM_DIRECTORY="./env.d/terraform"
-if [ -z ${COMPOSE_FILE+x} ]; then
-    COMPOSE_FILE="${REPO_DIR}/compose.yaml"
-fi
+COMPOSE_FILE="${REPO_DIR}/docker-compose.yml"
+
 
 # _set_user: set (or unset) default user id used to run docker commands
 #
@@ -40,7 +39,7 @@ function _set_user() {
 # ARGS   : docker compose command arguments
 function _docker_compose() {
 
-    echo "🐳(compose) project, file: '${COMPOSE_FILE}'"
+    echo "🐳(compose) file: '${COMPOSE_FILE}'"
     docker compose \
         -f "${COMPOSE_FILE}" \
         --project-directory "${REPO_DIR}" \

bin/buildpack_postcompile.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+set -o errexit    # always exit on error
+set -o pipefail   # don't ignore exit codes when piping output
+
+echo "-----> Running post-compile script"
+
+rm -rf docker docs env.d gitlint src/frontend/apps/e2e
+rm -rf src/frontend/apps
+rm -rf src/frontend/packages
+
+# Remove some of the larger packages required by the frontend only
+rm -rf src/frontend/node_modules/@next src/frontend/node_modules/next src/frontend/node_modules/react-icons src/frontend/node_modules/@gouvfr-lasuite 
+
+# du -ch | sort -rh | head -n 100

bin/buildpack_postfrontend.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+set -o errexit    # always exit on error
+set -o pipefail   # don't ignore exit codes when piping output
+
+echo "-----> Running post-frontend script"
+
+# Move the frontend build to the nginx root and clean up
+mkdir -p build/
+mv src/frontend/apps/impress/out build/frontend-out
+
+mv src/backend/* ./
+mv src/nginx/* ./
+
+echo "3.13" > .python-version

bin/buildpack_start.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+# Start the Django backend server
+gunicorn -b :8000 impress.wsgi:application --log-file - &
+
+# Start the Y provider service
+cd src/frontend/servers/y-provider && PORT=4444 ../../.scalingo/node/bin/node dist/start-server.js &
+
+# Start the Nginx server
+bin/run &
+
+# if the current shell is killed, also terminate all its children     
+trap "pkill SIGTERM -P $$" SIGTERM                            
+                                                                   
+# wait for a single child to finish,                               
+wait -n                                                  
+# then kill all the other tasks                          
+pkill -P $$

bin/update_app_cacert.sh

@@ -1,17 +0,0 @@
-#!/bin/sh
-set -o errexit
-
-#  The script is pretty simple. It downloads the latest  cacert.pem  file from the  certifi  package and appends the root certificate from  mkcert  to it. Then it copies the updated  cacert.pem  file to the container. 
-#  The script is executed with the following command: 
-#  $ bin/update_app_cacert.sh docs-production-backend-1
-
-CONTAINER_NAME=${1:-"docs-production-backend-1"}
-
-echo "updating cacert.pem for certifi package in ${CONTAINER_NAME}"
-
-
-curl --create-dirs https://raw.githubusercontent.com/certifi/python-certifi/refs/heads/master/certifi/cacert.pem -o /tmp/certifi/cacert.pem
-cat "$(mkcert -CAROOT)/rootCA.pem" >> /tmp/certifi/cacert.pem
-docker cp /tmp/certifi/cacert.pem ${CONTAINER_NAME}:/usr/local/lib/python3.12/site-packages/certifi/cacert.pem
-
-echo "end patching cacert.pem in ${CONTAINER_NAME}"

compose.production.yaml

@@ -1,167 +0,0 @@
-name: docs-production
-
-services:
-  postgresql:
-    image: postgres:16
-    healthcheck:
-      test: ["CMD", "pg_isready", "-q", "-U", "docs", "-d", "docs"]
-      interval: 1s
-      timeout: 2s
-      retries: 300
-    env_file:
-      - env.d/production/postgresql
-    environment:
-      - PGDATA=/var/lib/postgresql/data/pgdata
-    volumes:
-      - ./data/production/databases/backend:/var/lib/postgresql/data/pgdata
-
-  redis:
-    image: redis:5
-
-  backend-migration:
-    image: lasuite/impress-backend:latest
-    user: ${DOCKER_USER:-1000}
-    command: ["python", "manage.py", "migrate", "--noinput"]
-    environment:
-      - DJANGO_CONFIGURATION=Production
-    env_file:
-      - env.d/production/backend
-      - env.d/production/postgresql
-      - env.d/production/yprovider
-    depends_on:
-      postgresql:
-        condition: service_healthy
-        restart: true
-      redis:
-        condition: service_started
-      minio:
-        condition: service_started
-
-  backend:
-    image: lasuite/impress-backend:latest
-    user: ${DOCKER_USER:-1000}
-    restart: always
-    environment:
-      - DJANGO_CONFIGURATION=Production
-    env_file:
-      - env.d/production/backend
-      - env.d/production/postgresql
-      - env.d/production/yprovider
-    healthcheck:
-      test: ["CMD", "python", "manage.py", "check"]
-      interval: 15s
-      timeout: 30s
-      retries: 20
-      start_period: 10s
-    depends_on:
-      postgresql:
-        condition: service_healthy
-        restart: true
-      backend-migration:
-        condition: service_completed_successfully
-      redis:
-        condition: service_started
-      minio:
-        condition: service_started
-      minio-bootstrap:
-        condition: service_completed_successfully
-
-  celery:
-    user: ${DOCKER_USER:-1000}
-    image: lasuite/impress-backend:latest
-    command: ["celery", "-A", "impress.celery_app", "worker", "-l", "INFO"]
-    environment:
-      - DJANGO_CONFIGURATION=Production
-    env_file:
-      - env.d/production/backend
-      - env.d/production/postgresql
-      - env.d/production/yprovider
-    depends_on:
-      - backend
-
-  frontend:
-    image: lasuite/impress-frontend:latest
-    user: ${DOCKER_USER:-1000}
-
-  y-provider:
-    image: lasuite/impress-y-provider:latest
-    user: ${DOCKER_USER:-1000}
-    env_file:
-      - env.d/production/yprovider
-
-  kc_postgresql:
-    image: postgres:16
-    healthcheck:
-      test: ["CMD", "pg_isready", "-q", "-U", "keycloak", "-d", "keycloak"]
-      interval: 1s
-      timeout: 2s
-      retries: 300    
-    env_file:
-      - env.d/production/kc_postgresql
-    environment:
-      - PGDATA=/var/lib/postgresql/data/pgdata
-    volumes:
-      - ./data/production/databases/keycloak:/var/lib/postgresql/data/pgdata
-
-  keycloak:
-    image: quay.io/keycloak/keycloak:26.1.0
-    command: ["start"]
-    env_file:
-      - env.d/production/keycloak
-      - env.d/production/kc_postgresql
-    ports:
-      - "8443:8443"
-    volumes:
-      - ${DOCS_PROD_KEYCLOAK_CERT_FOLDER:-./data/production/certs}:/etc/ssl/certs:ro
-    depends_on:
-      kc_postgresql:
-        condition: service_healthy
-        restart: true
-
-  minio-bootstrap:
-    image: minio/mc
-    env_file:
-      - env.d/production/minio
-    depends_on:
-      minio:
-        condition: service_healthy
-        restart: true
-    entrypoint: >
-      sh -c "
-      /usr/bin/mc alias set docs http://minio:9000 $${MINIO_ROOT_USER} $${MINIO_ROOT_PASSWORD} && \
-      /usr/bin/mc mb --ignore-existing docs/docs-media-storage && \
-      /usr/bin/mc version enable docs/docs-media-storage && \
-      exit 0;"
-
-  minio:
-    user: ${DOCKER_USER:-1000}
-    image: minio/minio
-    env_file:
-      - env.d/production/minio
-    healthcheck:
-      test: ["CMD", "mc", "ready", "local"]
-      interval: 1s
-      timeout: 20s
-      retries: 300
-    entrypoint: ""
-    command: minio server /data
-    volumes:
-      - ./data/production/media:/data
-
-  ingress:
-    image: nginx:1.27
-    ports:
-      - "${DOCS_PROD_NGING_PORT:-443}:8083"
-    volumes:
-      - ./docker/files/production/etc/nginx/conf.d:/etc/nginx/conf.d:ro
-      - ${DOCS_PROD_NGINX_CERT_FOLDER:-./data/production/certs}:/etc/nginx/ssl:ro
-    depends_on:
-      frontend:
-        condition: service_started
-      y-provider:
-        condition: service_started
-      keycloak:
-        condition: service_started
-      backend:
-        condition: service_healthy
-        restart: true

docker-compose.yml

@@ -4,7 +4,7 @@ services:
   postgresql:
     image: postgres:16
     healthcheck:
-      test: ["CMD-SHELL", "pg_isready"]
+      test: ["CMD-SHELL", "pg_isready -d $${POSTGRES_DB} -U $${POSTGRES_USER}"]
       interval: 1s
       timeout: 2s
       retries: 300
@@ -139,11 +139,15 @@ services:
     volumes:
       - ./docker/files/etc/nginx/conf.d:/etc/nginx/conf.d:ro
     depends_on:
-      - keycloak
-      - app-dev
-      - y-provider
+      app-dev:
+        condition: service_started
+      y-provider:
+        condition: service_started
+      keycloak:
+        condition: service_healthy
+        restart: true
 
-  frontend-dev:
+  frontend:
     user: "${DOCKER_USER:-1000}"
     build: 
       context: .
@@ -151,8 +155,7 @@ services:
       target: frontend-production
       args:
         API_ORIGIN: "http://localhost:8071"
-        Y_PROVIDER_URL: "ws://localhost:4444"
-        MEDIA_URL: "http://localhost:8083"
+        PUBLISH_AS_MIT: "false"
         SW_DEACTIVATED: "true"
     image: impress:frontend-development
     ports:
@@ -190,10 +193,10 @@ services:
   kc_postgresql:
     image: postgres:14.3
     healthcheck:
-      test: ["CMD-SHELL", "pg_isready"]
+      test: ["CMD-SHELL", "pg_isready -d $${POSTGRES_DB} -U $${POSTGRES_USER}"]
       interval: 1s
       timeout: 2s
-      retries: 300    
+      retries: 300
     ports:
       - "5433:5432"
     env_file:
@@ -212,6 +215,13 @@ services:
       - --hostname-admin-url=http://localhost:8083/
       - --hostname-strict=false
       - --hostname-strict-https=false
+      - --health-enabled=true
+      - --metrics-enabled=true
+    healthcheck:
+      test: ["CMD", "curl", "--head", "-fsS", "http://localhost:8080/health/ready"]
+      interval: 1s
+      timeout: 2s
+      retries: 300
     environment:
       KEYCLOAK_ADMIN: admin
       KEYCLOAK_ADMIN_PASSWORD: admin

docker/files/etc/nginx/conf.d/default.conf

@@ -4,54 +4,6 @@ server {
     server_name localhost;
     charset utf-8;
 
-    # Proxy auth for collaboration server
-    location /collaboration/ws/ {
-        # Collaboration Auth request configuration
-        auth_request /collaboration-auth;
-        auth_request_set $authHeader $upstream_http_authorization;
-        auth_request_set $canEdit $upstream_http_x_can_edit;
-        auth_request_set $userId $upstream_http_x_user_id;
-
-        # Pass specific headers from the auth response
-        proxy_set_header Authorization $authHeader;
-        proxy_set_header X-Can-Edit $canEdit;
-        proxy_set_header X-User-Id $userId;
-
-        # Ensure WebSocket upgrade
-        proxy_http_version 1.1;
-        proxy_set_header Upgrade $http_upgrade;
-        proxy_set_header Connection "Upgrade";
-
-        # Collaboration server
-        proxy_pass http://y-provider:4444;
-
-        # Set appropriate timeout for WebSocket
-        proxy_read_timeout 86400;
-        proxy_send_timeout 86400;
-
-        # Preserve original host and additional headers
-        proxy_set_header Host $host;
-    }
-
-    location /collaboration-auth {
-        proxy_pass http://app-dev:8000/api/v1.0/documents/collaboration-auth/;
-        proxy_set_header Host $host;
-        proxy_set_header X-Real-IP $remote_addr;
-        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-        proxy_set_header X-Original-URL $request_uri;
-        
-        # Prevent the body from being passed
-        proxy_pass_request_body off;
-        proxy_set_header Content-Length "";
-        proxy_set_header X-Original-Method $request_method;
-    }
-
-    location  /collaboration/api/ {
-        # Collaboration server
-        proxy_pass http://y-provider:4444;
-        proxy_set_header Host $host;
-    }
-
     # Proxy auth for media
     location /media/ {
         # Auth request configuration
@@ -68,6 +20,8 @@ server {
         # Get resource from Minio
         proxy_pass http://minio:9000/impress-media-storage/;
         proxy_set_header Host minio:9000;
+
+        add_header Content-Security-Policy "default-src 'none'" always;
     }
 
     location /media-auth {
@@ -88,5 +42,11 @@ server {
         proxy_set_header Host $host;
         proxy_set_header X-Real-IP $remote_addr;
         proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+
+        # Increase proxy buffer size to allow keycloak to send large
+        # header responses when a user is created.
+        proxy_buffer_size 128k;
+        proxy_buffers 4 256k;
+        proxy_busy_buffers_size 256k;
     }
 }

docker/files/production/etc/nginx/conf.d/default.conf

@@ -1,132 +0,0 @@
-upstream docs_backend {
-    server backend:8000 fail_timeout=0;
-}
-
-upstream docs_frontend {
-    server frontend:8080 fail_timeout=0;
-}
-
-server {
-    listen 8083 ssl;
-    server_name localhost;
-
-    # Disables server version feedback on pages and in headers
-    server_tokens off;
-
-    ssl_certificate /etc/nginx/ssl/fullchain.pem;
-    ssl_certificate_key /etc/nginx/ssl/privkey.pem;
-
-    location @proxy_to_docs_backend {
-        proxy_set_header X-Forwarded-Proto https;
-        proxy_set_header Host $http_host;
-        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-
-        proxy_redirect off;
-        proxy_pass http://docs_backend;
-    }
-
-    location @proxy_to_docs_frontend {
-        proxy_set_header X-Forwarded-Proto https;
-        proxy_set_header Host $http_host;
-        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-
-        proxy_redirect off;
-        proxy_pass http://docs_frontend;
-    }
-
-    location / {
-        try_files $uri @proxy_to_docs_frontend;
-    }
-
-    location /api {
-        try_files $uri @proxy_to_docs_backend;
-    }
-
-    location /admin {
-        try_files $uri @proxy_to_docs_backend;
-    }
-
-    # Proxy auth for collaboration server
-    location /collaboration/ws/ {
-        # Collaboration Auth request configuration
-        auth_request /collaboration-auth;
-        proxy_set_header X-Forwarded-Proto https;
-        auth_request_set $authHeader $upstream_http_authorization;
-        auth_request_set $canEdit $upstream_http_x_can_edit;
-        auth_request_set $userId $upstream_http_x_user_id;
-
-        # Pass specific headers from the auth response
-        proxy_set_header Authorization $authHeader;
-        proxy_set_header X-Can-Edit $canEdit;
-        proxy_set_header X-User-Id $userId;
-
-        # Ensure WebSocket upgrade
-        proxy_http_version 1.1;
-        proxy_set_header Upgrade $http_upgrade;
-        proxy_set_header Connection "Upgrade";
-
-        # Collaboration server
-        proxy_pass http://y-provider:4444;
-
-        # Set appropriate timeout for WebSocket
-        proxy_read_timeout 86400;
-        proxy_send_timeout 86400;
-
-        # Preserve original host and additional headers
-        proxy_set_header X-Forwarded-Proto https;
-        proxy_set_header Origin $http_origin;
-        proxy_set_header Host $host;
-    }
-
-    location /collaboration-auth {
-        proxy_pass http://docs_backend/api/v1.0/documents/collaboration-auth/;
-        proxy_set_header X-Forwarded-Proto https;
-        proxy_set_header Host $host;
-        proxy_set_header X-Real-IP $remote_addr;
-        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-        proxy_set_header X-Original-URL $request_uri;
-        
-        # Prevent the body from being passed
-        proxy_pass_request_body off;
-        proxy_set_header Content-Length "";
-        proxy_set_header X-Original-Method $request_method;
-    }
-
-    location  /collaboration/api/ {
-        # Collaboration server
-        proxy_pass http://y-provider:4444;
-        proxy_set_header Host $host;
-    }
-
-    # Proxy auth for media
-    location /media/ {
-        # Auth request configuration
-        auth_request /media-auth;
-        auth_request_set $authHeader $upstream_http_authorization;
-        auth_request_set $authDate $upstream_http_x_amz_date;
-        auth_request_set $authContentSha256 $upstream_http_x_amz_content_sha256;
-
-        # Pass specific headers from the auth response
-        proxy_set_header Authorization $authHeader;
-        proxy_set_header X-Amz-Date $authDate;
-        proxy_set_header X-Amz-Content-SHA256 $authContentSha256;
-
-        # Get resource from Minio
-        proxy_pass http://minio:9000/docs-media-storage/;
-        proxy_set_header Host minio:9000;
-    }
-
-    location /media-auth {
-        proxy_pass http://docs_backend/api/v1.0/documents/media-auth/;
-        proxy_set_header X-Forwarded-Proto https;
-        proxy_set_header Host $host;
-        proxy_set_header X-Real-IP $remote_addr;
-        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-        proxy_set_header X-Original-URL $request_uri;
-        
-        # Prevent the body from being passed
-        proxy_pass_request_body off;
-        proxy_set_header Content-Length "";
-        proxy_set_header X-Original-Method $request_method;
-    }
-}

docs/adr/ADR-0001-20250106-use-yjs-for-docs-editing.md

@@ -0,0 +1,193 @@
+## Decision TLDR;
+
+We will use Yjs a CRDT-based library for the collaborative editing of the documents.
+
+## Status
+
+Accepted
+
+## Context
+
+We need to implement a collaborative editing feature for the documents that supports real-time collaboration, offline capabilities, and seamless integration with our Django backend.
+
+## Considered alternatives
+
+### ProseMirror
+
+A robust toolkit for building rich-text editors with collaboration capabilities.
+
+| Pros | Cons |
+| --- | --- |
+| Mature ecosystem | Complex integration with Django |
+| Rich text editing features | Steeper learning curve |
+| Used by major companies | More complex to implement offline support |
+| Large community | |
+
+### ShareDB
+
+Real-time database backend based on Operational Transformation.
+
+| Pros | Cons |
+| --- | --- |
+| Battle-tested in production | Complex setup required |
+| Strong consistency model | Requires specific backend architecture |
+| Good documentation | Less flexible with different backends |
+| | Higher latency compared to CRDTs |
+
+### Convergence
+
+Complete enterprise solution for real-time collaboration.
+
+| Pros | Cons |
+| --- | --- |
+| Full-featured solution | Commercial licensing |
+| Built-in presence features | Less community support |
+| Enterprise support | More expensive |
+| Good offline support | Overkill for basic needs |
+
+### CRDT-based Solutions Comparison
+
+A CRDT-based library specifically designed for real-time collaboration.
+
+| Category | Pros | Cons |
+|----------|------|------|
+| Technical Implementation | • Native real-time collaboration<br>• No central conflict resolution needed<br>• Works well with Django backend<br>• Automatic state synchronization | • Learning curve for CRDT concepts<br>• More complex initial setup<br>• Additional metadata overhead |
+| User Experience | • Instant local updates<br>• Works offline by default<br>• Low latency<br>• Smooth concurrent editing | • Eventual consistency might cause brief inconsistencies<br>• UI must handle temporary conflicts |
+| Performance | • Excellent scaling with multiple users<br>• Reduced server load<br>• Efficient network usage<br>• Good memory optimization (especially Yjs) | • Slightly higher memory usage<br>• Initial state sync can be larger |
+| Development | • No need to build conflict resolution<br>• Simple integration with text editors<br>• Future-proof architecture | • Team needs to learn new concepts<br>• Fewer ready-made solutions<br>• May need to build some features from scratch |
+| Maintenance | • Less server infrastructure<br>• Simpler deployment<br>• Fewer points of failure | • Debugging can be more complex<br>• State management requires careful handling |
+| Business Impact | • Better offline support for users<br>• Scales well as user base grows<br>• No licensing costs (with Yjs) | • Initial development time might be longer<br>• Team training required |
+
+#### Yjs
+- **Type**: State-based CRDT
+- **Implementation**: JavaScript/TypeScript
+- **Features**:
+  - Rich text collaboration
+  - Shared types (Array, Map, XML)
+  - Binary encoding
+  - P2P support
+- **Performance**: Excellent for text editing
+- **Memory Usage**: Optimized
+- **License**: MIT
+
+#### Automerge
+- **Type**: Operation-based CRDT
+- **Implementation**: JavaScript/Rust
+- **Features**:
+  - JSON-like data structures
+  - Change history
+  - Undo/Redo
+  - Binary format
+- **Performance**: Good, with Rust backend
+- **Memory Usage**: Higher than Yjs
+- **License**: MIT
+
+#### Legion
+- **Type**: State-based CRDT
+- **Implementation**: Rust with JS bindings
+- **Features**:
+  - High performance
+  - Memory efficient
+  - Binary protocol
+- **Performance**: Excellent
+- **Memory Usage**: Very efficient
+- **License**: Apache 2.0
+
+#### Diamond Types
+- **Type**: Operation-based CRDT
+- **Implementation**: TypeScript
+- **Features**:
+  - Specialized for text
+  - Small memory footprint
+  - Simple API
+- **Performance**: Good for text
+- **Memory Usage**: Efficient
+- **License**: MIT
+
+Comparison Table:
+
+| Feature | Yjs | Automerge | Legion | Diamond Types |
+|---------|-----|-----------|--------|---------------|
+| Text Editing | ✅ Excellent | ✅ Good | ⚠️ Basic | ✅ Excellent |
+| Structured Data | ✅ | ✅ | ✅ | ⚠️ |
+| Memory Efficiency | ✅ High | ⚠️ Medium | ✅ Very High | ✅ High |
+| Network Efficiency | ✅ | ⚠️ | ✅ | ✅ |
+| Maturity | ✅ | ✅ | ⚠️ | ⚠️ |
+| Community Size | ✅ Large | ✅ Large | ⚠️ Small | ⚠️ Small |
+| Documentation | ✅ | ✅ | ⚠️ | ⚠️ |
+| Backend Options | ✅ Many | ✅ Many | ⚠️ Limited | ⚠️ Limited |
+
+Key Differences:
+1. **Implementation Approach**:
+   - Yjs: Optimized for text and rich-text editing
+   - Automerge: General-purpose JSON CRDT
+   - Legion: Performance-focused with Rust
+   - Diamond Types: Specialized for text collaboration
+
+2. **Performance Characteristics**:
+   - Yjs: Best for text editing scenarios
+   - Automerge: Good all-around performance
+   - Legion: Excellent raw performance
+   - Diamond Types: Optimized for text
+
+3. **Ecosystem Integration**:
+   - Yjs: Wide range of integrations
+   - Automerge: Good JavaScript ecosystem
+   - Legion: Limited but growing
+   - Diamond Types: Focused on text editors
+
+This analysis reinforces our choice of Yjs for the CRDT-based option as it provides:
+- Best-in-class text editing performance
+- Mature ecosystem
+- Active community
+- Excellent documentation
+- Wide range of backend options
+
+## Decision
+
+After evaluating the alternatives, we choose Yjs for the following reasons:
+
+1. **Technical Fit:**
+- Native CRDT support ensures reliable collaboration
+- Excellent offline capabilities
+- Good performance characteristics
+- Flexible backend integration options
+
+2. **Project Requirements Match:**
+- Easy integration with our Django backend
+- Supports our core collaborative features
+- Manageable learning curve for the team
+
+3. **Community & Support:**
+- Active development
+- Growing community
+- Good documentation
+- Open source with MIT license
+
+### Comparison of Key Features:
+
+| Feature | Yjs (CRDT) | ProseMirror | ShareDB | Convergence |
+|---------|-----|-------------|----------|-------------|
+| Real-time Collaboration | ✅ | ✅ | ✅ | ✅ |
+| Offline Support | ✅ | ⚠️ | ⚠️ | ✅ |
+| Django Integration | Easy | Complex | Complex | Moderate |
+| Learning Curve | Medium | High | High | Medium |
+| Cost | Free | Free | Free | Paid |
+| Community Size | Growing | Large | Medium | Small |
+
+## Consequences
+
+### Positive
+- Simplified implementation of real-time collaboration
+- Good developer experience
+- Future-proof technology choice
+- No licensing costs
+
+### Negative
+- Team needs to learn CRDT concepts
+- Newer technology compared to alternatives
+- May need to build some features available out-of-the-box in other solutions
+
+### Risks
+- Community support might not grow as expected
+- May discover limitations as we scale

docs/architecture.md

@@ -0,0 +1,19 @@
+## Architecture
+
+### Global system architecture
+
+```mermaid
+flowchart TD
+    User -- HTTP --> Front("Frontend (NextJS SPA)")
+    Front -- REST API --> Back("Backend (Django)")
+    Front -- WebSocket --> Yserver("Microservice Yjs (Express)") -- WebSocket -->  CollaborationServer("Collaboration server (Hocuspocus)") -- REST API <--> Back
+    Front -- OIDC --> Back -- OIDC ---> OIDC("Keycloak / ProConnect")
+    Back -- REST API --> Yserver
+    Back --> DB("Database (PostgreSQL)")
+    Back <--> Celery --> DB
+    Back ----> S3("Minio (S3)")
+```
+
+### Architecture decision records
+
+- [ADR-0001-20250106-use-yjs-for-docs-editing](./adr/ADR-0001-20250106-use-yjs-for-docs-editing.md)

docs/env.md

@@ -0,0 +1,143 @@
+# Docs variables
+
+Here we describe all environment variables that can be set for the docs application.
+
+## impress-backend container
+
+These are the environment variables you can set for the `impress-backend` container.
+
+| Option                                          | Description                                                                                   | default                                                 |
+| ----------------------------------------------- | --------------------------------------------------------------------------------------------- | ------------------------------------------------------- |
+| DJANGO_ALLOWED_HOSTS                            | allowed hosts                                                                                 | []                                                      |
+| DJANGO_SECRET_KEY                               | secret key                                                                                    |                                                         |
+| DJANGO_SERVER_TO_SERVER_API_TOKENS              |                                                                                               | []                                                      |
+| DB_ENGINE                                       | engine to use for database connections                                                        | django.db.backends.postgresql_psycopg2                  |
+| DB_NAME                                         | name of the database                                                                          | impress                                                 |
+| DB_USER                                         | user to authenticate with                                                                     | dinum                                                   |
+| DB_PASSWORD                                     | password to authenticate with                                                                 | pass                                                    |
+| DB_HOST                                         | host of the database                                                                          | localhost                                               |
+| DB_PORT                                         | port of the database                                                                          | 5432                                                    |
+| MEDIA_BASE_URL                                  |                                                                                               |                                                         |
+| STORAGES_STATICFILES_BACKEND                    |                                                                                               | whitenoise.storage.CompressedManifestStaticFilesStorage |
+| AWS_S3_ENDPOINT_URL                             | S3 endpoint                                                                                   |                                                         |
+| AWS_S3_ACCESS_KEY_ID                            | access id for s3 endpoint                                                                     |                                                         |
+| AWS_S3_SECRET_ACCESS_KEY                        | access key for s3 endpoint                                                                    |                                                         |
+| AWS_S3_REGION_NAME                              | region name for s3 endpoint                                                                   |                                                         |
+| AWS_STORAGE_BUCKET_NAME                         | bucket name for s3 endpoint                                                                   | impress-media-storage                                   |
+| DOCUMENT_IMAGE_MAX_SIZE                         | maximum size of document in bytes                                                             | 10485760                                                |
+| LANGUAGE_CODE                                   | default language                                                                              | en-us                                                   |
+| API_USERS_LIST_THROTTLE_RATE_SUSTAINED          | throttle rate for api                                                                         | 180/hour                                                |
+| API_USERS_LIST_THROTTLE_RATE_BURST              | throttle rate for api on burst                                                                | 30/minute                                               |
+| SPECTACULAR_SETTINGS_ENABLE_DJANGO_DEPLOY_CHECK |                                                                                               | false                                                   |
+| TRASHBIN_CUTOFF_DAYS                            | trashbin cutoff                                                                               | 30                                                      |
+| DJANGO_EMAIL_BACKEND                            | email backend library                                                                         | django.core.mail.backends.smtp.EmailBackend             |
+| DJANGO_EMAIL_BRAND_NAME                         | brand name for email                                                                          |                                                         |
+| DJANGO_EMAIL_HOST                               | host name of email                                                                            |                                                         |
+| DJANGO_EMAIL_HOST_USER                          | user to authenticate with on the email host                                                   |                                                         |
+| DJANGO_EMAIL_HOST_PASSWORD                      | password to authenticate with on the email host                                               |                                                         |
+| DJANGO_EMAIL_LOGO_IMG                           | logo for the email                                                                            |                                                         |
+| DJANGO_EMAIL_PORT                               | port used to connect to email host                                                            |                                                         |
+| DJANGO_EMAIL_USE_TLS                            | use tls for email host connection                                                             | false                                                   |
+| DJANGO_EMAIL_USE_SSL                            | use sstl for email host connection                                                            | false                                                   |
+| DJANGO_EMAIL_FROM                               | email address used as sender                                                                  | from@example.com                                        |
+| DJANGO_CORS_ALLOW_ALL_ORIGINS                   | allow all CORS origins                                                                        | true                                                    |
+| DJANGO_CORS_ALLOWED_ORIGINS                     | list of origins allowed for CORS                                                              | []                                                      |
+| DJANGO_CORS_ALLOWED_ORIGIN_REGEXES              | list of origins allowed for CORS using regulair expressions                                   | []                                                      |
+| SENTRY_DSN                                      | sentry host                                                                                   |                                                         |
+| COLLABORATION_API_URL                           | collaboration api host                                                                        |                                                         |
+| COLLABORATION_SERVER_SECRET                     | collaboration api secret                                                                      |                                                         |
+| COLLABORATION_WS_URL                            | collaboration websocket url                                                                   |                                                         |
+| COLLABORATION_WS_NOT_CONNECTED_READY_ONLY           | Users not connected to the collaboration server cannot edit                                   | false                                                   |
+| FRONTEND_CSS_URL                                | To add a external css file to the app                                                         |                                                         |
+| FRONTEND_HOMEPAGE_FEATURE_ENABLED               | frontend feature flag to display the homepage                                                 | false                                                   |
+| FRONTEND_THEME                                  | frontend theme to use                                                                         |                                                         |
+| POSTHOG_KEY                                     | posthog key for analytics                                                                     |                                                         |
+| CRISP_WEBSITE_ID                                | crisp website id for support                                                                  |                                                         |
+| DJANGO_CELERY_BROKER_URL                        | celery broker url                                                                             | redis://redis:6379/0                                    |
+| DJANGO_CELERY_BROKER_TRANSPORT_OPTIONS          | celery broker transport options                                                               | {}                                                      |
+| SESSION_COOKIE_AGE                              | duration of the cookie session                                                                | 60*60*12                                                |
+| OIDC_CREATE_USER                                | create used on OIDC                                                                           | false                                                   |
+| OIDC_RP_SIGN_ALGO                               | verification algorithm used OIDC tokens                                                       | RS256                                                   |
+| OIDC_RP_CLIENT_ID                               | client id used for OIDC                                                                       | impress                                                 |
+| OIDC_RP_CLIENT_SECRET                           | client secret used for OIDC                                                                   |                                                         |
+| OIDC_OP_JWKS_ENDPOINT                           | JWKS endpoint for OIDC                                                                        |                                                         |
+| OIDC_OP_AUTHORIZATION_ENDPOINT                  | Authorization endpoint for OIDC                                                               |                                                         |
+| OIDC_OP_TOKEN_ENDPOINT                          | Token endpoint for OIDC                                                                       |                                                         |
+| OIDC_OP_USER_ENDPOINT                           | User endpoint for OIDC                                                                        |                                                         |
+| OIDC_OP_LOGOUT_ENDPOINT                         | Logout endpoint for OIDC                                                                      |                                                         |
+| OIDC_AUTH_REQUEST_EXTRA_PARAMS                  | OIDC extra auth parameters                                                                    | {}                                                      |
+| OIDC_RP_SCOPES                                  | scopes requested for OIDC                                                                     | openid email                                            |
+| LOGIN_REDIRECT_URL                              | login redirect url                                                                            |                                                         |
+| LOGIN_REDIRECT_URL_FAILURE                      | login redirect url on failure                                                                 |                                                         |
+| LOGOUT_REDIRECT_URL                             | logout redirect url                                                                           |                                                         |
+| OIDC_USE_NONCE                                  | use nonce for OIDC                                                                            | true                                                    |
+| OIDC_REDIRECT_REQUIRE_HTTPS                     | Require https for OIDC redirect url                                                           | false                                                   |
+| OIDC_REDIRECT_ALLOWED_HOSTS                     | Allowed hosts for OIDC redirect url                                                           | []                                                      |
+| OIDC_STORE_ID_TOKEN                             | Store OIDC token                                                                              | true                                                    |
+| OIDC_FALLBACK_TO_EMAIL_FOR_IDENTIFICATION       | faillback to email for identification                                                         | true                                                    |
+| OIDC_ALLOW_DUPLICATE_EMAILS                     | Allow duplicate emails                                                                        | false                                                   |
+| USER_OIDC_ESSENTIAL_CLAIMS                      | essential claims in OIDC token                                                                | []                                                      |
+| OIDC_USERINFO_FULLNAME_FIELDS                   | OIDC token claims to create full name                                                         | ["first_name", "last_name"]                             |
+| OIDC_USERINFO_SHORTNAME_FIELD                   | OIDC token claims to create shortname                                                         | first_name                                              |
+| ALLOW_LOGOUT_GET_METHOD                         | Allow get logout method                                                                       | true                                                    |
+| AI_API_KEY                                      | AI key to be used for AI Base url                                                             |                                                         |
+| AI_BASE_URL                                     | OpenAI compatible AI base url                                                                 |                                                         |
+| AI_MODEL                                        | AI Model to use                                                                               |                                                         |
+| AI_ALLOW_REACH_FROM                             | Users that can use AI must be this level. options are "public", "authenticated", "restricted" | authenticated                                           |
+| AI_FEATURE_ENABLED                              | Enable AI options                                                                             | false                                                   |
+| Y_PROVIDER_API_KEY                              | Y provider API key                                                                            |                                                         |
+| Y_PROVIDER_API_BASE_URL                         | Y Provider url                                                                                |                                                         |
+| CONVERSION_API_ENDPOINT                         | Conversion API endpoint                                                                       | convert-markdown                                        |
+| CONVERSION_API_CONTENT_FIELD                    | Conversion api content field                                                                  | content                                                 |
+| CONVERSION_API_TIMEOUT                          | Conversion api timeout                                                                        | 30                                                      |
+| CONVERSION_API_SECURE                           | Require secure conversion api                                                                 | false                                                   |
+| LOGGING_LEVEL_LOGGERS_ROOT                      | default logging level. options are "DEBUG", "INFO", "WARN", "ERROR", "CRITICAL"               | INFO                                                    |
+| LOGGING_LEVEL_LOGGERS_APP                       | application logging level. options are "DEBUG", "INFO", "WARN", "ERROR", "CRITICAL"           | INFO                                                    |
+| API_USERS_LIST_LIMIT                            | Limit on API users                                                                            | 5                                                       |
+| DJANGO_CSRF_TRUSTED_ORIGINS                     | CSRF trusted origins                                                                          | []                                                      |
+| REDIS_URL                                       | cache url                                                                                     | redis://redis:6379/1                                    |
+| CACHES_DEFAULT_TIMEOUT                          | cache default timeout                                                                         | 30                                                      |
+| CACHES_KEY_PREFIX                               | The prefix used to every cache keys.                                                          | docs                                                    |
+| MALWARE_DETECTION_BACKEND                       | The malware detection backend use from the django-lasuite package                             | lasuite.malware_detection.backends.dummy.DummyBackend           |
+| MALWARE_DETECTION_PARAMETERS                    | A dict containing all the parameters to initiate the malware detection backend                | {"callback_path": "core.malware_detection.malware_detection_callback",} |
+| THEME_CUSTOMIZATION_FILE_PATH                   | full path to the file customizing the theme. An example is provided in src/backend/impress/configuration/theme/default.json | BASE_DIR/impress/configuration/theme/default.json       |
+| THEME_CUSTOMIZATION_CACHE_TIMEOUT               | Cache duration for the customization settings                                                  | 86400                                                   |
+
+
+## impress-frontend image
+
+These are the environment variables you can set to build the `impress-frontend` image.
+
+Depending on how you are building the front-end application, this variable is used in different ways.
+
+If you want to build the Docker image, this variable is used as an argument in the build command.
+
+Example:
+
+```
+docker build -f src/frontend/Dockerfile --target frontend-production --build-arg PUBLISH_AS_MIT=false docs-frontend:latest
+``` 
+
+If you want to build the front-end application using the yarn build command, you can edit the file `src/frontend/apps/impress/.env` with the `NODE_ENV=production` environment variable and modify it. Alternatively, you can use the listed environment variables with the prefix `NEXT_PUBLIC_` (for example, `NEXT_PUBLIC_PUBLISH_AS_MIT=false`).
+
+Example:
+
+```
+cd src/frontend/apps/impress
+NODE_ENV=production NEXT_PUBLIC_PUBLISH_AS_MIT=false yarn build
+```
+
+| Option                                          | Description                                                                                   | default                                                 |
+| ----------------------------------------------- | --------------------------------------------------------------------------------------------- | ------------------------------------------------------- |
+| API_ORIGIN                                      | backend domain - it uses the current domain if not initialized                                |                                                         |
+| SW_DEACTIVATED                                  | To not install the service worker                                                             |                                                         |
+| PUBLISH_AS_MIT                                  | Removes packages whose licences are incompatible with the MIT licence (see  below)                                               | true                                                    |
+
+Packages with licences incompatible with the MIT licence:
+* `xl-docx-exporter`: [AGPL-3.0](https://github.com/TypeCellOS/BlockNote/blob/main/packages/xl-docx-exporter/LICENSE), 
+* `xl-pdf-exporter`: [AGPL-3.0](https://github.com/TypeCellOS/BlockNote/blob/main/packages/xl-pdf-exporter/LICENSE) 
+
+In `.env.development`, `PUBLISH_AS_MIT` is set to `false`, allowing developers to test Docs with all its features.
+
+⚠️ If you run Docs in production with `PUBLISH_AS_MIT` set to `false` make sure you fulfill your [BlockNote licensing](https://github.com/TypeCellOS/BlockNote/blob/main/packages/xl-pdf-exporter/LICENSE) or [subscription](https://www.blocknotejs.org/about#partner-with-us) obligations.
+

docs/examples/impress.values.yaml

@@ -33,8 +33,8 @@ backend:
     OIDC_RP_SIGN_ALGO: RS256
     OIDC_RP_SCOPES: "openid email"
     OIDC_VERIFY_SSL: False
-    USER_OIDC_FIELD_TO_SHORTNAME: "given_name"
-    USER_OIDC_FIELDS_TO_FULLNAME: "given_name,usual_name"
+    OIDC_USERINFO_SHORTNAME_FIELD: "given_name"
+    OIDC_USERINFO_FULLNAME_FIELDS: "given_name,usual_name"
     OIDC_REDIRECT_ALLOWED_HOSTS: https://impress.127.0.0.1.nip.io
     OIDC_AUTH_REQUEST_EXTRA_PARAMS: "{'acr_values': 'eidas1'}"
     LOGIN_REDIRECT_URL: https://impress.127.0.0.1.nip.io
@@ -82,13 +82,13 @@ backend:
         python manage.py createsuperuser --email admin@example.com --password admin
     restartPolicy: Never
 
-  # Exra volume to manage our local custom CA and avoid to set ssl_verify: false
+  # Extra volume to manage our local custom CA and avoid to set ssl_verify: false
   extraVolumeMounts:
     - name: certs
       mountPath: /usr/local/lib/python3.12/site-packages/certifi/cacert.pem
       subPath: cacert.pem
 
-  # Exra volume to manage our local custom CA and avoid to set ssl_verify: false
+  # Extra volume to manage our local custom CA and avoid to set ssl_verify: false
   extraVolumes:
     - name: certs
       configMap:

docs/installation.md

@@ -1,21 +1,20 @@
 # Installation on a k8s cluster
 
-This document is a step-by-step guide that describes how to install Docs on a k8s cluster without AI features. It's a teaching document to learn how it's work. It needs to be adapt for production environment.
-
+This document is a step-by-step guide that describes how to install Docs on a k8s cluster without AI features. It's a teaching document to learn how it works. It needs to be adapted for a production environment.
 
 ## Prerequisites
 
 - k8s cluster with an nginx-ingress controller
-- an OIDC provider (if you don't have one, we will provide an example)
-- a PostgreSQL server (if you don't have one, we will provide an example)
-- a Memcached server (if you don't have one, we will provide an example)
-- a S3 bucket (if you don't have one, we will provide an example)
+- an OIDC provider (if you don't have one, we provide an example)
+- a PostgreSQL server (if you don't have one, we provide an example)
+- a Memcached server (if you don't have one, we provide an example)
+- a S3 bucket (if you don't have one, we provide an example)
 
 ### Test cluster
 
-If you do not have a test cluster, you can install everything on a local kind cluster. In this case, the simplest way is to use our script **bin/start-kind.sh**.
+If you do not have a test cluster, you can install everything on a local Kind cluster. In this case, the simplest way is to use our script **bin/start-kind.sh**.
 
-To be able to use the script, you will need to install:
+To be able to use the script, you need to install:
 
 - Docker (https://docs.docker.com/desktop/)
 - Kind (https://kind.sigs.k8s.io/docs/user/quick-start/#installation)
@@ -23,7 +22,7 @@ To be able to use the script, you will need to install:
 - Helm (https://helm.sh/docs/intro/quickstart/#install-helm)
 
 ```
-./bin/start-kind.sh 
+./bin/start-kind.sh
   % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                  Dload  Upload   Total   Spent    Left  Speed
 100  4700  100  4700    0     0  92867      0 --:--:-- --:--:-- --:--:-- 94000
@@ -46,11 +45,11 @@ It will expire on 24 March 2027 🗓
 2. Create kind cluster with containerd registry config dir enabled
 Creating cluster "suite" ...
  ✓ Ensuring node image (kindest/node:v1.27.3) 🖼
- ✓ Preparing nodes 📦  
- ✓ Writing configuration 📜 
- ✓ Starting control-plane 🕹️ 
- ✓ Installing CNI 🔌 
- ✓ Installing StorageClass 💾 
+ ✓ Preparing nodes 📦
+ ✓ Writing configuration 📜
+ ✓ Starting control-plane 🕹️
+ ✓ Installing CNI 🔌
+ ✓ Installing StorageClass 💾
 Set kubectl context to "kind-suite"
 You can now use your cluster with:
 
@@ -96,13 +95,14 @@ ingress-nginx-admission-create-t55ph        0/1     Completed   0          2m56s
 ingress-nginx-admission-patch-94dvt         0/1     Completed   1          2m56s
 ingress-nginx-controller-57c548c4cd-2rx47   1/1     Running     0          2m56s
 ```
-When your k8s cluster is ready (the ingress nginx controller is up), you can start the deployment. This cluster is special because it uses the *.127.0.0.1.nip.io domain and mkcert certificates to have full HTTPS support and easy domain name management.
 
-Please remember that *.127.0.0.1.nip.io will always resolve to 127.0.0.1, except in the k8s cluster where we configure CoreDNS to answer with the ingress-nginx service IP.
+When your k8s cluster is ready (the ingress nginx controller is up), you can start the deployment. This cluster is special because it uses the `*.127.0.0.1.nip.io` domain and mkcert certificates to have full HTTPS support and easy domain name management.
+
+Please remember that `*.127.0.0.1.nip.io` will always resolve to `127.0.0.1`, except in the k8s cluster where we configure CoreDNS to answer with the ingress-nginx service IP.
 
 ## Preparation
 
-### What will you use to authenticate your users ?
+### What do you use to authenticate your users?
 
 Docs uses OIDC, so if you already have an OIDC provider, obtain the necessary information to use it. In the next step, we will see how to configure Django (and thus Docs) to use it. If you do not have a provider, we will show you how to deploy a local Keycloak instance (this is not a production deployment, just a demo).
 
@@ -117,9 +117,9 @@ keycloak-0              1/1     Running   0          6m48s
 keycloak-postgresql-0   1/1     Running   0          6m48s
 ```
 
-From here the important informations you will need are :
+From here the important information you will need are:
 
-```
+```yaml
 OIDC_OP_JWKS_ENDPOINT: https://keycloak.127.0.0.1.nip.io/realms/impress/protocol/openid-connect/certs
 OIDC_OP_AUTHORIZATION_ENDPOINT: https://keycloak.127.0.0.1.nip.io/realms/impress/protocol/openid-connect/auth
 OIDC_OP_TOKEN_ENDPOINT: https://keycloak.127.0.0.1.nip.io/realms/impress/protocol/openid-connect/token
@@ -133,9 +133,9 @@ OIDC_RP_SCOPES: "openid email"
 
 You can find these values in **examples/keycloak.values.yaml**
 
-### Find redis server connexion values
+### Find redis server connection values
 
-Impress need a redis so we will start by deploying a redis :
+Docs needs a redis so we start by deploying one:
 
 ```
 $ helm install redis oci://registry-1.docker.io/bitnamicharts/redis -f examples/redis.values.yaml
@@ -146,9 +146,9 @@ keycloak-postgresql-0   1/1     Running   0          26m
 redis-master-0          1/1     Running   0          35s
 ```
 
-### Find postgresql connexion values
+### Find postgresql connection values
 
-Impress uses a postgresql db as backend so if you have a provider, obtain the necessary information to use it. If you do not have, you can install a postgresql testing environment as follow:
+Docs uses a postgresql database as backend, so if you have a provider, obtain the necessary information to use it. If you don't, you can install a postgresql testing environment as follow:
 
 ```
 $ helm install postgresql oci://registry-1.docker.io/bitnamicharts/postgresql -f examples/postgresql.values.yaml
@@ -160,9 +160,9 @@ postgresql-0            1/1     Running   0          14m
 redis-master-0          1/1     Running   0          42s
 ```
 
-From here important informations you will need are :
+From here the important information you will need are:
 
-```
+```yaml
 DB_HOST: postgres-postgresql
 DB_NAME: impress
 DB_USER: dinum
@@ -173,9 +173,9 @@ POSTGRES_USER: dinum
 POSTGRES_PASSWORD: pass
 ```
 
-### Find s3 bucket connexion values
+### Find s3 bucket connection values
 
-Impress uses a s3 bucket to store documents so if you have a provider obtain the necessary information to use it. If you do not have, you can install a local minio testing environment as follow:
+Docs uses an s3 bucket to store documents, so if you have a provider obtain the necessary information to use it. If you don't, you can install a local minio testing environment as follow:
 
 ```
 $ helm install minio oci://registry-1.docker.io/bitnamicharts/minio -f examples/minio.values.yaml
@@ -191,7 +191,7 @@ redis-master-0             1/1     Running     0          10m
 
 ## Deployment
 
-Now you are ready to deploy Impress without AI. AI requiered more dependancies (openai API). To deploy impress you need to provide all previous informations to the helm chart.
+Now you are ready to deploy Docs without AI. AI requires more dependencies (OpenAI API). To deploy Docs you need to provide all previous information to the helm chart.
 
 ```
 $ helm repo add impress https://suitenumerique.github.io/docs/
@@ -214,7 +214,7 @@ redis-master-0                               1/1     Running     0          20m
 
 ## Test your deployment
 
-In order to test your deployment you have to login to your instance. If you use exclusively our examples you can do :
+In order to test your deployment you have to log into your instance. If you exclusively use our examples you can do:
 
 ```
 $ kubectl get ingress
@@ -227,5 +227,4 @@ impress-docs-ws                  <none>   impress.127.0.0.1.nip.io    localhost
 keycloak                         <none>   keycloak.127.0.0.1.nip.io   localhost   80        49m
 ```
 
-You can use impress on https://impress.127.0.0.1.nip.io. The provisionning user in keycloak is impress/impress.
-
+You can use Docs at https://impress.127.0.0.1.nip.io. The provisionning user in keycloak is impress/impress.

docs/installation/compose.md

@@ -1,66 +0,0 @@
-# Installation with docker compose
-
-We provide a configuration for running Docs in production using docker compose. This configuration is experimental, the official way to deploy Docs in production is to use [k8s](docs/installation/k8s.md)
-
-## Requirements
-
-- A modern version of Docker and its Compose plugin.
-- SSL certificates for Docs domain and Keycloak.
-- Two domain name. One for the Docs application and an other one for Keycloak. Both can be a subdomain of a common domain. (example: docs.domain.tld and keycloak.domain.tld)
-
-## Installation
-
-- Clone this repository: `git clone https://github.com/suitenumerique/docs.git`
-- Then in the clone directory you can run the following command: `make bootsrap-production`
-
-## Configure your ssl certificates
-
-You have to provide the ssl certificates. The easiest way is to use [certbot](https://certbot.eff.org/), generate the certificates with it (both for Docs and Keycloak) and then mount them in ingress and keycloak containers. Two environment variables can be used for that: 
-- `DOCS_PROD_NGINX_CERT_FOLDER` path to the folder containing the certificates for Docs. This folder will be mounted in `/etc/nginx/ssl` in the container. You have to adapt the certificates name in the file `docker/files/production/etc/nginx/conf.d/default.conf` accordingly with the certificates name you have (see `ssl_certificate` and `ssl_certificate_key` directives).
-- `DOCS_PROD_KEYCLOAK_CERT_FOLDER` path to the folder containing the certificates for Keycloak. This folder will be mounted in `/etc/ssl/certs` in the container. You have to adapt the certificates name in the configuration file in `env.d/production/keycloak` to add the correct path for environment variables `KC_HTTPS_CERTIFICATE_FILE` and `KC_HTTPS_CERTIFICATE_KEY_FILE`.
-
-### Configuration
-
-All the configuration files are in the directory `env.d/production`. You have to edit all the files to complete them. For the OIDC information you will have them once Keycloak will be running and you have configured your own realm on it.
-
-#### env.d/production/minio
-
-All the settings related to Minio. You have to set a username and a password to manage the minio cluster. You will need them later in the `env.d/production/backend` file.
-
-#### env.d/production/postgresql
-
-All the settings related to the Postgresql database used by the Django application.
-
-#### env.d/production/yprovider
-
-All the settings related to the collaboration server. All the secret and api key must be generated.
-
-#### env.d/production/kc_postgresql
-
-All the settings related to the Postgresql database used by keycloak.
-
-#### env.d/production/keycloak
-
-All the settings related to the Keycloak application.
-
-#### env.d/production/backend
-
-All the settings related to the Django application. Only the settings you don't have for now are all the one related to OIDC. You will have them once the compose started and you can access to Keycloak.
-
-## Run the compose configuration
-
-The compose configuration can be run with the following command: `make run-production`. The first start can be a little bit long, lots of things are created. Once started you can check that everything is running with the following command: `COMPOSE_FILE=compose.production.yaml ./bin/compose ps`
-
-## Configure keycloak
-
-You have to create a new realm in your Keycloak and once created you have to create a new OIDC client in it. You will use this client to configure the OIDC part in `env.d/production/backend`. This is the last missing part to complete the Django application configuration.
-Once the client information set in `env.d/production/backend` you have to start the containers again by running the commande `make run-production`. The command will recreate the containers with the good configuration.
-
-### Helpers
-
-there is a helper script to control the `docker compose` command. You can export the variable `COMPOSE_FILE` with the compose filename (`export COMPOSE_FILE=compose.production.yaml`). After you can run `./bin/compose` to run the docker compose command line.
-
-Makefile commands available:
-- `make bootstrap-production`: create the configuration files in `env.d/production`, create the directories : `data/production`. Both directories must be backup, if you loose them you loose all the data related to the application.
-- `make run-production`: up the ingress containers. Will start all the containers needed in cascade.
-- `make stop-production`: stop all the containers.

docs/theming.md

@@ -0,0 +1,56 @@
+# Runtime Theming 🎨
+
+### How to Use
+
+To use this feature, simply set the `FRONTEND_CSS_URL` environment variable to the URL of your custom CSS file. For example:
+
+```javascript
+FRONTEND_CSS_URL=http://anything/custom-style.css
+```
+
+Once you've set this variable, our application will load your custom CSS file and apply the styles to our frontend application.
+
+### Benefits
+
+This feature provides several benefits, including:
+
+*   **Easy customization** 🔄: With this feature, you can easily customize the look and feel of our application without requiring any code changes.
+*   **Flexibility** 🌈: You can use any CSS styles you like to create a custom theme that meets your needs.
+*   **Runtime theming** ⏱️: This feature allows you to change the theme of our application at runtime, without requiring a restart or recompilation.
+
+### Example Use Case
+
+Let's say you want to change the background color of our application to a custom color. You can create a custom CSS file with the following contents:
+
+```css
+body {
+  background-color: #3498db;
+}
+```
+
+Then, set the `FRONTEND_CSS_URL` environment variable to the URL of your custom CSS file. Once you've done this, our application will load your custom CSS file and apply the styles, changing the background color to the custom color you specified.
+
+----
+
+# **Footer Configuration** 📝
+
+The footer is configurable from the theme customization file.
+
+### Settings 🔧
+
+```shellscript
+THEME_CUSTOMIZATION_FILE_PATH=<path>
+```
+
+### Example of JSON
+
+The json must follow some rules: https://github.com/suitenumerique/docs/blob/main/src/helm/env.d/dev/configuration/theme/demo.json
+
+`footer.default` is the fallback if the language is not supported.
+
+--- 
+Below is a visual example of a configured footer ⬇️:
+
+![Footer Configuration Example](./assets/footer-configurable.png)
+
+

env.d/development/common.dist

@@ -50,15 +50,14 @@ OIDC_REDIRECT_ALLOWED_HOSTS=["http://localhost:8083", "http://localhost:3000"]
 OIDC_AUTH_REQUEST_EXTRA_PARAMS={"acr_values": "eidas1"}
 
 # AI
+AI_FEATURE_ENABLED=true
 AI_BASE_URL=https://openaiendpoint.com
 AI_API_KEY=password
 AI_MODEL=llama
 
 # Collaboration
-COLLABORATION_API_URL=http://nginx:8083/collaboration/api/
+COLLABORATION_API_URL=http://y-provider:4444/collaboration/api/
+COLLABORATION_BACKEND_BASE_URL=http://app-dev:8000
 COLLABORATION_SERVER_ORIGIN=http://localhost:3000
 COLLABORATION_SERVER_SECRET=my-secret
-COLLABORATION_WS_URL=ws://localhost:8083/collaboration/ws/
-
-# Frontend
-FRONTEND_THEME=dsfr
+COLLABORATION_WS_URL=ws://localhost:4444/collaboration/ws/

env.d/development/common.e2e.dist

@@ -1,6 +1,6 @@
 # For the CI job test-e2e
-SUSTAINED_THROTTLE_RATES="200/hour"
 BURST_THROTTLE_RATES="200/minute"
 DJANGO_SERVER_TO_SERVER_API_TOKENS=test-e2e
+SUSTAINED_THROTTLE_RATES="200/hour"
 Y_PROVIDER_API_KEY=yprovider-api-key
 Y_PROVIDER_API_BASE_URL=http://y-provider:4444/api/

env.d/production.dist/backend

@@ -1,58 +0,0 @@
-## Django
-DJANGO_ALLOWED_HOSTS=impress.127.0.0.1.nip.io,keycloack.127.0.0.1.nip.io
-DJANGO_SECRET_KEY=ThisIsAnExampleKeyForDevPurposeOnly
-DJANGO_SETTINGS_MODULE=impress.settings
-DJANGO_SUPERUSER_PASSWORD=ThisIsAnExamplePassword
-
-# Logging
-# Set to DEBUG level for dev only
-LOGGING_LEVEL_HANDLERS_CONSOLE=ERROR
-LOGGING_LEVEL_LOGGERS_ROOT=INFO
-LOGGING_LEVEL_LOGGERS_APP=INFO
-
-# Python
-PYTHONPATH=/app
-
-# impress settings
-
-# Mail
-DJANGO_EMAIL_BRAND_NAME="La Suite Numérique"
-DJANGO_EMAIL_HOST="mailcatcher"
-DJANGO_EMAIL_LOGO_IMG="https://impress.127.0.0.1.nip.io/assets/logo-suite-numerique.png"
-DJANGO_EMAIL_PORT=1025
-
-# Media
-STORAGES_STATICFILES_BACKEND=django.contrib.staticfiles.storage.StaticFilesStorage
-AWS_S3_ENDPOINT_URL=http://minio:9000
-AWS_S3_ACCESS_KEY_ID=<minio root user>
-AWS_S3_SECRET_ACCESS_KEY=<minio root password>
-AWS_STORAGE_BUCKET_NAME=docs-media-storage
-MEDIA_BASE_URL=impress.127.0.0.1.nip.io
-
-# OIDC
-USER_OIDC_FIELD_TO_SHORTNAME="given_name"
-USER_OIDC_FIELDS_TO_FULLNAME="given_name,usual_name"
-OIDC_OP_JWKS_ENDPOINT=https://impress.127.0.0.1.nip.io/realms/impress/protocol/openid-connect/certs
-OIDC_OP_AUTHORIZATION_ENDPOINT=https://impress.127.0.0.1.nip.io/realms/impress/protocol/openid-connect/auth
-OIDC_OP_TOKEN_ENDPOINT=https://impress.127.0.0.1.nip.io/realms/impress/protocol/openid-connect/token
-OIDC_OP_USER_ENDPOINT=https://impress.127.0.0.1.nip.io/realms/impress/protocol/openid-connect/userinfo
-OIDC_OP_LOGOUT_ENDPOINT=https://impress.127.0.0.1.nip.io/realms/impress/protocol/openid-connect/logout
-OIDC_RP_CLIENT_ID=impress
-OIDC_RP_CLIENT_SECRETThisIsAnExampleKeyForDevPurposeOnly
-OIDC_RP_SIGN_ALGO=RS256
-OIDC_RP_SCOPES="openid email"
-
-LOGIN_REDIRECT_URL=https://impress.127.0.0.1.nip.io
-LOGIN_REDIRECT_URL_FAILURE=https://impress.127.0.0.1.nip.io
-LOGOUT_REDIRECT_URL=https://impress.127.0.0.1.nip.io
-
-OIDC_REDIRECT_ALLOWED_HOSTS=["https://impress.127.0.0.1.nip.io"]
-OIDC_AUTH_REQUEST_EXTRA_PARAMS={"acr_values": "eidas1"}
-
-# AI
-AI_BASE_URL=https://openaiendpoint.com
-AI_API_KEY=password
-AI_MODEL=llama
-
-# Frontend
-FRONTEND_THEME=dsfr

env.d/production.dist/kc_postgresql

@@ -1,9 +0,0 @@
-# Postgresql db container configuration
-POSTGRES_DB=keycloak
-POSTGRES_USER=keycloak
-POSTGRES_PASSWORD=<Set postgresql password>
-
-# Keycloak database configuration
-KC_DB_URL_DATABASE=keycloak
-KC_DB_USERNAME=keycloak
-KC_DB_PASSWORD=<Same password as above>

env.d/production.dist/keycloak

@@ -1,9 +0,0 @@
-KC_BOOTSTRAP_ADMIN_USERNAME=<Change this admin user>
-KC_BOOTSTRAP_ADMIN_PASSWORD=<Change this admin password>
-KC_DB=postgres
-KC_DB_URL_HOST=kc_postgresql
-KC_DB_SCHEMA=public
-PROXY_ADDRESS_FORWARDING='true'
-KC_HOSTNAME=http://localhost:8083
-KC_HTTPS_CERTIFICATE_FILE=/etc/ssl/certs/docs.crt
-KC_HTTPS_CERTIFICATE_KEY_FILE=/etc/ssl/private/docs.key

env.d/production.dist/minio

@@ -1,2 +0,0 @@
-MINIO_ROOT_USER=<Set minio root username>
-MINIO_ROOT_PASSWORD=<Set minio root password>

env.d/production.dist/postgresql

@@ -1,11 +0,0 @@
-# Postgresql db container configuration
-POSTGRES_DB=docs
-POSTGRES_USER=docs
-POSTGRES_PASSWORD=<Set postgresql password>
-
-# App database configuration
-DB_HOST=postgresql
-DB_NAME=docs
-DB_USER=docs
-DB_PASSWORD=<Same password as above>
-DB_PORT=5432

env.d/production.dist/yprovider

@@ -1,5 +0,0 @@
-COLLABORATION_LOGGING=true
-Y_PROVIDER_API_KEY=<Set y provider api key>
-COLLABORATION_API_URL=https://impress.127.0.0.1.nip.io/collaboration/api/
-COLLABORATION_SERVER_ORIGIN=https://impress.127.0.0.1.nip.io
-COLLABORATION_SERVER_SECRET=<Set collaboration secret>

gitlint/gitlint_emoji.py

@@ -31,7 +31,7 @@ class GitmojiTitle(LineRule):
             "https://raw.githubusercontent.com/carloscuesta/gitmoji/master/packages/gitmojis/src/gitmojis.json"
         ).json()["gitmojis"]
         emojis = [item["emoji"] for item in gitmojis]
-        pattern = r"^({:s})\(.*\)\s[a-z].*$".format("|".join(emojis))
+        pattern = r"^({:s})\(.*\)\s[a-zA-Z].*$".format("|".join(emojis))
         if not re.search(pattern, title):
             violation_msg = 'Title does not match regex "<gitmoji>(<scope>) <subject>"'
             return [RuleViolation(self.id, violation_msg, title)]

publiccode.yml

@@ -0,0 +1,27 @@
+publiccodeYmlVersion: "2.4.0"
+name: Docs
+url: https://github.com/suitenumerique/docs
+landingURL: https://github.com/suitenumerique/docs
+creationDate: 2023-12-10
+logo: https://raw.githubusercontent.com/suitenumerique/docs/main/docs/assets/docs-logo.png
+usedBy:
+  - Direction interministériel du numérique (DINUM)
+fundedBy:
+  - name: Direction interministériel du numérique (DINUM)
+    url: https://www.numerique.gouv.fr
+roadmap: "https://github.com/orgs/suitenumerique/projects/2/views/1"
+softwareType: "standalone/other"
+description:
+  en:
+    shortDescription: "The open source document editor where your notes can become knowledge through live collaboration"
+  fr:
+    shortDescription: "L'éditeur de documents open source où vos notes peuvent devenir des connaissances grâce à la collaboration en direct."
+legal:
+  license: MIT
+maintenance:
+  type: internal
+  contacts:
+    - name: "Virgile Deville"
+      email: "virgile.deville@numerique.gouv.fr"
+    - name: "samuel.paccoud"
+      email: "samuel.paccoud@numerique.gouv.fr"

renovate.json

@@ -9,15 +9,29 @@
       "matchManagers": ["pep621"],
       "matchPackageNames": []
     },
+    {
+      "groupName": "allowed django versions",
+      "matchManagers": ["pep621"],
+      "matchPackageNames": ["Django"],
+      "allowedVersions": "<5.2"
+    },
+    {
+      "groupName": "allowed redis versions",
+      "matchManagers": ["pep621"],
+      "matchPackageNames": ["redis"],
+      "allowedVersions": "<6.0.0"
+    },
     {
       "enabled": false,
       "groupName": "ignored js dependencies",
       "matchManagers": ["npm"],
       "matchPackageNames": [
+        "@hocuspocus/provider",
+        "@hocuspocus/server",
+        "eslint",
         "fetch-mock",
         "node",
         "node-fetch",
-        "eslint",
         "workbox-webpack-plugin"
       ]
     }

src/backend/core/admin.py

@@ -4,12 +4,16 @@ from django.contrib import admin
 from django.contrib.auth import admin as auth_admin
 from django.utils.translation import gettext_lazy as _
 
+from treebeard.admin import TreeAdmin
+from treebeard.forms import movenodeform_factory
+
 from . import models
 
 
 class TemplateAccessInline(admin.TabularInline):
     """Inline admin class for template accesses."""
 
+    autocomplete_fields = ["user"]
     model = models.TemplateAccess
     extra = 0
 
@@ -111,14 +115,49 @@ class TemplateAdmin(admin.ModelAdmin):
 class DocumentAccessInline(admin.TabularInline):
     """Inline admin class for template accesses."""
 
+    autocomplete_fields = ["user"]
     model = models.DocumentAccess
     extra = 0
 
 
 @admin.register(models.Document)
-class DocumentAdmin(admin.ModelAdmin):
+class DocumentAdmin(TreeAdmin):
     """Document admin interface declaration."""
 
+    fieldsets = (
+        (
+            None,
+            {
+                "fields": (
+                    "id",
+                    "title",
+                )
+            },
+        ),
+        (
+            _("Permissions"),
+            {
+                "fields": (
+                    "creator",
+                    "link_reach",
+                    "link_role",
+                )
+            },
+        ),
+        (
+            _("Tree structure"),
+            {
+                "fields": (
+                    "path",
+                    "depth",
+                    "numchild",
+                    "duplicated_from",
+                    "attachments",
+                )
+            },
+        ),
+    )
+    form = movenodeform_factory(models.Document)
     inlines = (DocumentAccessInline,)
     list_display = (
         "id",
@@ -128,6 +167,16 @@ class DocumentAdmin(admin.ModelAdmin):
         "created_at",
         "updated_at",
     )
+    readonly_fields = (
+        "attachments",
+        "creator",
+        "depth",
+        "duplicated_from",
+        "id",
+        "numchild",
+        "path",
+    )
+    search_fields = ("id", "title")
 
 
 @admin.register(models.Invitation)

src/backend/core/api/__init__.py

@@ -17,9 +17,10 @@ def exception_handler(exc, context):
     https://gist.github.com/twidi/9d55486c36b6a51bdcb05ce3a763e79f
     """
     if isinstance(exc, ValidationError):
-        detail = exc.message_dict
-
-        if hasattr(exc, "message"):
+        detail = None
+        if hasattr(exc, "message_dict"):
+            detail = exc.message_dict
+        elif hasattr(exc, "message"):
             detail = exc.message
         elif hasattr(exc, "messages"):
             detail = exc.messages

src/backend/core/api/filters.py

@@ -1,5 +1,7 @@
 """API filters for Impress' core application."""
 
+import unicodedata
+
 from django.utils.translation import gettext_lazy as _
 
 import django_filters
@@ -7,7 +9,50 @@ import django_filters
 from core import models
 
 
+def remove_accents(value):
+    """Remove accents from a string (vélo -> velo)."""
+    return "".join(
+        c
+        for c in unicodedata.normalize("NFD", value)
+        if unicodedata.category(c) != "Mn"
+    )
+
+
+class AccentInsensitiveCharFilter(django_filters.CharFilter):
+    """
+    A custom CharFilter that filters on the accent-insensitive value searched.
+    """
+
+    def filter(self, qs, value):
+        """
+        Apply the filter to the queryset using the unaccented version of the field.
+
+        Args:
+            qs: The queryset to filter.
+            value: The value to search for in the unaccented field.
+        Returns:
+            A filtered queryset.
+        """
+        if value:
+            value = remove_accents(value)
+        return super().filter(qs, value)
+
+
 class DocumentFilter(django_filters.FilterSet):
+    """
+    Custom filter for filtering documents on title (accent and case insensitive).
+    """
+
+    title = AccentInsensitiveCharFilter(
+        field_name="title", lookup_expr="unaccent__icontains", label=_("Title")
+    )
+
+    class Meta:
+        model = models.Document
+        fields = ["title"]
+
+
+class ListDocumentFilter(DocumentFilter):
     """
     Custom filter for filtering documents.
     """
@@ -18,13 +63,10 @@ class DocumentFilter(django_filters.FilterSet):
     is_favorite = django_filters.BooleanFilter(
         method="filter_is_favorite", label=_("Favorite")
     )
-    title = django_filters.CharFilter(
-        field_name="title", lookup_expr="icontains", label=_("Title")
-    )
 
     class Meta:
         model = models.Document
-        fields = ["is_creator_me", "is_favorite", "link_reach", "title"]
+        fields = ["is_creator_me", "is_favorite", "title"]
 
     # pylint: disable=unused-argument
     def filter_is_creator_me(self, queryset, name, value):
@@ -63,7 +105,4 @@ class DocumentFilter(django_filters.FilterSet):
         if not user.is_authenticated:
             return queryset
 
-        if value:
-            return queryset.filter(favorited_by_users__user=user)
-
-        return queryset.exclude(favorited_by_users__user=user)
+        return queryset.filter(is_favorite=bool(value))

src/backend/core/api/permissions.py

@@ -2,13 +2,15 @@
 
 from django.core import exceptions
 from django.db.models import Q
+from django.http import Http404
 
 from rest_framework import permissions
 
-from core.models import DocumentAccess, RoleChoices
+from core.models import DocumentAccess, RoleChoices, get_trashbin_cutoff
 
 ACTION_FOR_METHOD_TO_PERMISSION = {
-    "versions_detail": {"DELETE": "versions_destroy", "GET": "versions_retrieve"}
+    "versions_detail": {"DELETE": "versions_destroy", "GET": "versions_retrieve"},
+    "children": {"GET": "children_list", "POST": "children_create"},
 }
 
 
@@ -109,3 +111,26 @@ class AccessPermission(permissions.BasePermission):
         except KeyError:
             pass
         return abilities.get(action, False)
+
+
+class DocumentAccessPermission(AccessPermission):
+    """Subclass to handle soft deletion specificities."""
+
+    def has_object_permission(self, request, view, obj):
+        """
+        Return a 404 on deleted documents
+        - for which the trashbin cutoff is past
+        - for which the current user is not owner of the document or one of its ancestors
+        """
+        if (
+            deleted_at := obj.ancestors_deleted_at
+        ) and deleted_at < get_trashbin_cutoff():
+            raise Http404
+
+        # Compute permission first to ensure the "user_roles" attribute is set
+        has_permission = super().has_object_permission(request, view, obj)
+
+        if obj.ancestors_deleted_at and not RoleChoices.OWNER in obj.user_roles:
+            raise Http404
+
+        return has_permission

src/backend/core/api/serializers.py

@@ -1,6 +1,8 @@
 """Client serializers for the impress core app."""
 
+import binascii
 import mimetypes
+from base64 import b64decode
 
 from django.conf import settings
 from django.db.models import Q
@@ -10,7 +12,7 @@ from django.utils.translation import gettext_lazy as _
 import magic
 from rest_framework import exceptions, serializers
 
-from core import enums, models
+from core import enums, models, utils
 from core.services.ai_services import AI_ACTIONS
 from core.services.converter_services import (
     ConversionError,
@@ -21,6 +23,26 @@ from core.services.converter_services import (
 class UserSerializer(serializers.ModelSerializer):
     """Serialize users."""
 
+    class Meta:
+        model = models.User
+        fields = ["id", "email", "full_name", "short_name", "language"]
+        read_only_fields = ["id", "email", "full_name", "short_name"]
+
+
+class UserLightSerializer(UserSerializer):
+    """Serialize users with limited fields."""
+
+    id = serializers.SerializerMethodField(read_only=True)
+    email = serializers.SerializerMethodField(read_only=True)
+
+    def get_id(self, _user):
+        """Return always None. Here to have the same fields than in UserSerializer."""
+        return None
+
+    def get_email(self, _user):
+        """Return always None. Here to have the same fields than in UserSerializer."""
+        return None
+
     class Meta:
         model = models.User
         fields = ["id", "email", "full_name", "short_name"]
@@ -118,6 +140,17 @@ class DocumentAccessSerializer(BaseAccessSerializer):
         read_only_fields = ["id", "abilities"]
 
 
+class DocumentAccessLightSerializer(DocumentAccessSerializer):
+    """Serialize document accesses with limited fields."""
+
+    user = UserLightSerializer(read_only=True)
+
+    class Meta:
+        model = models.DocumentAccess
+        fields = ["id", "user", "team", "role", "abilities"]
+        read_only_fields = ["id", "team", "role", "abilities"]
+
+
 class TemplateAccessSerializer(BaseAccessSerializer):
     """Serialize template accesses."""
 
@@ -128,53 +161,79 @@ class TemplateAccessSerializer(BaseAccessSerializer):
         read_only_fields = ["id", "abilities"]
 
 
-class BaseResourceSerializer(serializers.ModelSerializer):
-    """Serialize documents."""
-
-    abilities = serializers.SerializerMethodField(read_only=True)
-    accesses = TemplateAccessSerializer(many=True, read_only=True)
-
-    def get_abilities(self, document) -> dict:
-        """Return abilities of the logged-in user on the instance."""
-        request = self.context.get("request")
-        if request:
-            return document.get_abilities(request.user)
-        return {}
-
-
-class ListDocumentSerializer(BaseResourceSerializer):
+class ListDocumentSerializer(serializers.ModelSerializer):
     """Serialize documents with limited fields for display in lists."""
 
     is_favorite = serializers.BooleanField(read_only=True)
-    nb_accesses = serializers.IntegerField(read_only=True)
+    nb_accesses_ancestors = serializers.IntegerField(read_only=True)
+    nb_accesses_direct = serializers.IntegerField(read_only=True)
+    user_roles = serializers.SerializerMethodField(read_only=True)
+    abilities = serializers.SerializerMethodField(read_only=True)
 
     class Meta:
         model = models.Document
         fields = [
             "id",
             "abilities",
-            "content",
             "created_at",
             "creator",
+            "depth",
+            "excerpt",
             "is_favorite",
             "link_role",
             "link_reach",
-            "nb_accesses",
+            "nb_accesses_ancestors",
+            "nb_accesses_direct",
+            "numchild",
+            "path",
             "title",
             "updated_at",
+            "user_roles",
         ]
         read_only_fields = [
             "id",
             "abilities",
             "created_at",
             "creator",
+            "depth",
+            "excerpt",
             "is_favorite",
             "link_role",
             "link_reach",
-            "nb_accesses",
+            "nb_accesses_ancestors",
+            "nb_accesses_direct",
+            "numchild",
+            "path",
             "updated_at",
+            "user_roles",
         ]
 
+    def get_abilities(self, document) -> dict:
+        """Return abilities of the logged-in user on the instance."""
+        request = self.context.get("request")
+
+        if request:
+            paths_links_mapping = self.context.get("paths_links_mapping", None)
+            # Retrieve ancestor links from paths_links_mapping (if provided)
+            ancestors_links = (
+                paths_links_mapping.get(document.path[: -document.steplen])
+                if paths_links_mapping
+                else None
+            )
+            return document.get_abilities(request.user, ancestors_links=ancestors_links)
+
+        return {}
+
+    def get_user_roles(self, document):
+        """
+        Return roles of the logged-in user for the current document,
+        taking into account ancestors.
+        """
+        request = self.context.get("request")
+        if request:
+            return document.get_roles(request.user)
+        return []
+
 
 class DocumentSerializer(ListDocumentSerializer):
     """Serialize documents with all fields for display in detail views."""
@@ -189,23 +248,34 @@ class DocumentSerializer(ListDocumentSerializer):
             "content",
             "created_at",
             "creator",
+            "depth",
+            "excerpt",
             "is_favorite",
             "link_role",
             "link_reach",
-            "nb_accesses",
+            "nb_accesses_ancestors",
+            "nb_accesses_direct",
+            "numchild",
+            "path",
             "title",
             "updated_at",
+            "user_roles",
         ]
         read_only_fields = [
             "id",
             "abilities",
             "created_at",
             "creator",
+            "depth",
             "is_favorite",
             "link_role",
             "link_reach",
-            "nb_accesses",
+            "nb_accesses_ancestors",
+            "nb_accesses_direct",
+            "numchild",
+            "path",
             "updated_at",
+            "user_roles",
         ]
 
     def get_fields(self):
@@ -231,6 +301,65 @@ class DocumentSerializer(ListDocumentSerializer):
 
         return value
 
+    def validate_content(self, value):
+        """Validate the content field."""
+        if not value:
+            return None
+
+        try:
+            b64decode(value, validate=True)
+        except binascii.Error as err:
+            raise serializers.ValidationError("Invalid base64 content.") from err
+
+        return value
+
+    def save(self, **kwargs):
+        """
+        Process the content field to extract attachment keys and update the document's
+        "attachments" field for access control.
+        """
+        content = self.validated_data.get("content", "")
+        extracted_attachments = set(utils.extract_attachments(content))
+
+        existing_attachments = (
+            set(self.instance.attachments or []) if self.instance else set()
+        )
+        new_attachments = extracted_attachments - existing_attachments
+
+        if new_attachments:
+            attachments_documents = (
+                models.Document.objects.filter(
+                    attachments__overlap=list(new_attachments)
+                )
+                .only("path", "attachments")
+                .order_by("path")
+            )
+
+            user = self.context["request"].user
+            readable_per_se_paths = (
+                models.Document.objects.readable_per_se(user)
+                .order_by("path")
+                .values_list("path", flat=True)
+            )
+            readable_attachments_paths = utils.filter_descendants(
+                [doc.path for doc in attachments_documents],
+                readable_per_se_paths,
+                skip_sorting=True,
+            )
+
+            readable_attachments = set()
+            for document in attachments_documents:
+                if document.path not in readable_attachments_paths:
+                    continue
+                readable_attachments.update(set(document.attachments) & new_attachments)
+
+            # Update attachments with readable keys
+            self.validated_data["attachments"] = list(
+                existing_attachments | readable_attachments
+            )
+
+        return super().save(**kwargs)
+
 
 class ServerCreateDocumentSerializer(serializers.Serializer):
     """
@@ -287,7 +416,7 @@ class ServerCreateDocumentSerializer(serializers.Serializer):
                 {"content": ["Could not convert content"]}
             ) from err
 
-        document = models.Document.objects.create(
+        document = models.Document.add_root(
             title=validated_data["title"],
             content=document_content,
             creator=user,
@@ -330,7 +459,7 @@ class ServerCreateDocumentSerializer(serializers.Serializer):
         raise NotImplementedError("Update is not supported for this serializer.")
 
 
-class LinkDocumentSerializer(BaseResourceSerializer):
+class LinkDocumentSerializer(serializers.ModelSerializer):
     """
     Serialize link configuration for documents.
     We expose it separately from document in order to simplify and secure access control.
@@ -344,6 +473,27 @@ class LinkDocumentSerializer(BaseResourceSerializer):
         ]
 
 
+class DocumentDuplicationSerializer(serializers.Serializer):
+    """
+    Serializer for duplicating a document.
+    Allows specifying whether to keep access permissions.
+    """
+
+    with_accesses = serializers.BooleanField(default=False)
+
+    def create(self, validated_data):
+        """
+        This serializer is not intended to create objects.
+        """
+        raise NotImplementedError("This serializer does not support creation.")
+
+    def update(self, instance, validated_data):
+        """
+        This serializer is not intended to update objects.
+        """
+        raise NotImplementedError("This serializer does not support updating.")
+
+
 # Suppress the warning about not implementing `create` and `update` methods
 # since we don't use a model and only rely on the serializer for validation
 # pylint: disable=abstract-method
@@ -389,6 +539,7 @@ class FileUploadSerializer(serializers.Serializer):
 
         self.context["expected_extension"] = extension
         self.context["content_type"] = magic_mime_type
+        self.context["file_name"] = file.name
 
         return file
 
@@ -397,12 +548,16 @@ class FileUploadSerializer(serializers.Serializer):
         attrs["expected_extension"] = self.context["expected_extension"]
         attrs["is_unsafe"] = self.context["is_unsafe"]
         attrs["content_type"] = self.context["content_type"]
+        attrs["file_name"] = self.context["file_name"]
         return attrs
 
 
-class TemplateSerializer(BaseResourceSerializer):
+class TemplateSerializer(serializers.ModelSerializer):
     """Serialize templates."""
 
+    abilities = serializers.SerializerMethodField(read_only=True)
+    accesses = TemplateAccessSerializer(many=True, read_only=True)
+
     class Meta:
         model = models.Template
         fields = [
@@ -416,6 +571,13 @@ class TemplateSerializer(BaseResourceSerializer):
         ]
         read_only_fields = ["id", "accesses", "abilities"]
 
+    def get_abilities(self, document) -> dict:
+        """Return abilities of the logged-in user on the instance."""
+        request = self.context.get("request")
+        if request:
+            return document.get_abilities(request.user)
+        return {}
+
 
 # pylint: disable=abstract-method
 class DocumentGenerationSerializer(serializers.Serializer):
@@ -539,3 +701,37 @@ class AITranslateSerializer(serializers.Serializer):
         if len(value.strip()) == 0:
             raise serializers.ValidationError("Text field cannot be empty.")
         return value
+
+
+class MoveDocumentSerializer(serializers.Serializer):
+    """
+    Serializer for validating input data to move a document within the tree structure.
+
+    Fields:
+        - target_document_id (UUIDField): The ID of the target parent document where the
+            document should be moved. This field is required and must be a valid UUID.
+        - position (ChoiceField): Specifies the position of the document in relation to
+            the target parent's children.
+          Choices:
+            - "first-child": Place the document as the first child of the target parent.
+            - "last-child": Place the document as the last child of the target parent (default).
+            - "left": Place the document as the left sibling of the target parent.
+            - "right": Place the document as the right sibling of the target parent.
+
+    Example:
+        Input payload for moving a document:
+        {
+            "target_document_id": "123e4567-e89b-12d3-a456-426614174000",
+            "position": "first-child"
+        }
+
+    Notes:
+        - The `target_document_id` is mandatory.
+        - The `position` defaults to "last-child" if not provided.
+    """
+
+    target_document_id = serializers.UUIDField(required=True)
+    position = serializers.ChoiceField(
+        choices=enums.MoveNodePositionChoices.choices,
+        default=enums.MoveNodePositionChoices.LAST_CHILD,
+    )

src/backend/core/api/utils.py

@@ -11,6 +11,58 @@ import botocore
 from rest_framework.throttling import BaseThrottle
 
 
+def nest_tree(flat_list, steplen):
+    """
+    Convert a flat list of serialized documents into a nested tree making advantage
+    of the`path` field and its step length.
+    """
+    node_dict = {}
+    roots = []
+
+    # Sort the flat list by path to ensure parent nodes are processed first
+    flat_list.sort(key=lambda x: x["path"])
+
+    for node in flat_list:
+        node["children"] = []  # Initialize children list
+        node_dict[node["path"]] = node
+
+        # Determine parent path
+        parent_path = node["path"][:-steplen]
+
+        if parent_path in node_dict:
+            node_dict[parent_path]["children"].append(node)
+        else:
+            roots.append(node)  # Collect root nodes
+
+    if len(roots) > 1:
+        raise ValueError("More than one root element detected.")
+
+    return roots[0] if roots else None
+
+
+def filter_root_paths(paths, skip_sorting=False):
+    """
+    Filters root paths from a list of paths representing a tree structure.
+    A root path is defined as a path that is not a prefix of any other path.
+
+    Args:
+        paths (list of str): The list of paths.
+
+    Returns:
+        list of str: The filtered list of root paths.
+    """
+    if not skip_sorting:
+        paths.sort()
+
+    root_paths = []
+    for path in paths:
+        # If the current path is not a prefix of the last added root path, add it
+        if not root_paths or not path.startswith(root_paths[-1]):
+            root_paths.append(path)
+
+    return root_paths
+
+
 def generate_s3_authorization_headers(key):
     """
     Generate authorization headers for an s3 object.

src/backend/core/authentication/backends.py

@@ -1,130 +1,59 @@
 """Authentication Backends for the Impress core app."""
 
 import logging
+import os
 
 from django.conf import settings
 from django.core.exceptions import SuspiciousOperation
-from django.utils.translation import gettext_lazy as _
 
-import requests
-from mozilla_django_oidc.auth import (
-    OIDCAuthenticationBackend as MozillaOIDCAuthenticationBackend,
+from lasuite.oidc_login.backends import (
+    OIDCAuthenticationBackend as LaSuiteOIDCAuthenticationBackend,
 )
 
-from core.models import DuplicateEmailError, User
+from core.models import DuplicateEmailError
 
 logger = logging.getLogger(__name__)
 
+# Settings renamed warnings
+if os.environ.get("USER_OIDC_FIELDS_TO_FULLNAME"):
+    logger.warning(
+        "USER_OIDC_FIELDS_TO_FULLNAME has been renamed to "
+        "OIDC_USERINFO_FULLNAME_FIELDS please update your settings."
+    )
 
-class OIDCAuthenticationBackend(MozillaOIDCAuthenticationBackend):
+if os.environ.get("USER_OIDC_FIELD_TO_SHORTNAME"):
+    logger.warning(
+        "USER_OIDC_FIELD_TO_SHORTNAME has been renamed to "
+        "OIDC_USERINFO_SHORTNAME_FIELD please update your settings."
+    )
+
+
+class OIDCAuthenticationBackend(LaSuiteOIDCAuthenticationBackend):
     """Custom OpenID Connect (OIDC) Authentication Backend.
 
     This class overrides the default OIDC Authentication Backend to accommodate differences
     in the User and Identity models, and handles signed and/or encrypted UserInfo response.
     """
 
-    def get_userinfo(self, access_token, id_token, payload):
-        """Return user details dictionary.
+    def get_extra_claims(self, user_info):
+        """
+        Return extra claims from user_info.
 
-        Parameters:
-        - access_token (str): The access token.
-        - id_token (str): The id token (unused).
-        - payload (dict): The token payload (unused).
-
-        Note: The id_token and payload parameters are unused in this implementation,
-        but were kept to preserve base method signature.
-
-        Note: It handles signed and/or encrypted UserInfo Response. It is required by
-        Agent Connect, which follows the OIDC standard. It forces us to override the
-        base method, which deal with 'application/json' response.
+        Args:
+          user_info (dict): The user information dictionary.
 
         Returns:
-        - dict: User details dictionary obtained from the OpenID Connect user endpoint.
+          dict: A dictionary of extra claims.
         """
-
-        user_response = requests.get(
-            self.OIDC_OP_USER_ENDPOINT,
-            headers={"Authorization": f"Bearer {access_token}"},
-            verify=self.get_settings("OIDC_VERIFY_SSL", True),
-            timeout=self.get_settings("OIDC_TIMEOUT", None),
-            proxies=self.get_settings("OIDC_PROXY", None),
-        )
-        user_response.raise_for_status()
-
-        try:
-            userinfo = user_response.json()
-        except ValueError:
-            try:
-                userinfo = self.verify_token(user_response.text)
-            except Exception as e:
-                raise SuspiciousOperation(
-                    _("Invalid response format or token verification failed")
-                ) from e
-
-        return userinfo
-
-    def verify_claims(self, claims):
-        """
-        Verify the presence of essential claims and the "sub" (which is mandatory as defined
-        by the OIDC specification) to decide if authentication should be allowed.
-        """
-        essential_claims = settings.USER_OIDC_ESSENTIAL_CLAIMS
-        missing_claims = [claim for claim in essential_claims if claim not in claims]
-
-        if missing_claims:
-            logger.error("Missing essential claims: %s", missing_claims)
-            return False
-
-        return True
-
-    def get_or_create_user(self, access_token, id_token, payload):
-        """Return a User based on userinfo. Create a new user if no match is found."""
-
-        user_info = self.get_userinfo(access_token, id_token, payload)
-
-        if not self.verify_claims(user_info):
-            raise SuspiciousOperation("Claims verification failed.")
-
-        sub = user_info["sub"]
-        email = user_info.get("email")
-
-        # Get user's full name from OIDC fields defined in settings
-        full_name = self.compute_full_name(user_info)
-        short_name = user_info.get(settings.USER_OIDC_FIELD_TO_SHORTNAME)
-
-        claims = {
-            "email": email,
-            "full_name": full_name,
-            "short_name": short_name,
+        return {
+            "full_name": self.compute_full_name(user_info),
+            "short_name": user_info.get(settings.OIDC_USERINFO_SHORTNAME_FIELD),
         }
 
+    def get_existing_user(self, sub, email):
+        """Fetch existing user by sub or email."""
+
         try:
-            user = User.objects.get_user_by_sub_or_email(sub, email)
+            return self.UserModel.objects.get_user_by_sub_or_email(sub, email)
         except DuplicateEmailError as err:
             raise SuspiciousOperation(err.message) from err
-
-        if user:
-            if not user.is_active:
-                raise SuspiciousOperation(_("User account is disabled"))
-            self.update_user_if_needed(user, claims)
-        elif self.get_settings("OIDC_CREATE_USER", True):
-            user = User.objects.create(sub=sub, password="!", **claims)  # noqa: S106
-
-        return user
-
-    def compute_full_name(self, user_info):
-        """Compute user's full name based on OIDC fields in settings."""
-        name_fields = settings.USER_OIDC_FIELDS_TO_FULLNAME
-        full_name = " ".join(
-            user_info[field] for field in name_fields if user_info.get(field)
-        )
-        return full_name or None
-
-    def update_user_if_needed(self, user, claims):
-        """Update user claims if they have changed."""
-        has_changed = any(
-            value and value != getattr(user, key) for key, value in claims.items()
-        )
-        if has_changed:
-            updated_claims = {key: value for key, value in claims.items() if value}
-            self.UserModel.objects.filter(id=user.id).update(**updated_claims)

src/backend/core/authentication/urls.py

@@ -1,18 +0,0 @@
-"""Authentication URLs for the People core app."""
-
-from django.urls import path
-
-from mozilla_django_oidc.urls import urlpatterns as mozzila_oidc_urls
-
-from .views import OIDCLogoutCallbackView, OIDCLogoutView
-
-urlpatterns = [
-    # Override the default 'logout/' path from Mozilla Django OIDC with our custom view.
-    path("logout/", OIDCLogoutView.as_view(), name="oidc_logout_custom"),
-    path(
-        "logout-callback/",
-        OIDCLogoutCallbackView.as_view(),
-        name="oidc_logout_callback",
-    ),
-    *mozzila_oidc_urls,
-]

src/backend/core/authentication/views.py

@@ -1,137 +0,0 @@
-"""Authentication Views for the People core app."""
-
-from urllib.parse import urlencode
-
-from django.contrib import auth
-from django.core.exceptions import SuspiciousOperation
-from django.http import HttpResponseRedirect
-from django.urls import reverse
-from django.utils import crypto
-
-from mozilla_django_oidc.utils import (
-    absolutify,
-)
-from mozilla_django_oidc.views import (
-    OIDCLogoutView as MozillaOIDCOIDCLogoutView,
-)
-
-
-class OIDCLogoutView(MozillaOIDCOIDCLogoutView):
-    """Custom logout view for handling OpenID Connect (OIDC) logout flow.
-
-    Adds support for handling logout callbacks from the identity provider (OP)
-    by initiating the logout flow if the user has an active session.
-
-    The Django session is retained during the logout process to persist the 'state' OIDC parameter.
-    This parameter is crucial for maintaining the integrity of the logout flow between this call
-    and the subsequent callback.
-    """
-
-    @staticmethod
-    def persist_state(request, state):
-        """Persist the given 'state' parameter in the session's 'oidc_states' dictionary
-
-        This method is used to store the OIDC state parameter in the session, according to the
-        structure expected by Mozilla Django OIDC's 'add_state_and_verifier_and_nonce_to_session'
-        utility function.
-        """
-
-        if "oidc_states" not in request.session or not isinstance(
-            request.session["oidc_states"], dict
-        ):
-            request.session["oidc_states"] = {}
-
-        request.session["oidc_states"][state] = {}
-        request.session.save()
-
-    def construct_oidc_logout_url(self, request):
-        """Create the redirect URL for interfacing with the OIDC provider.
-
-        Retrieves the necessary parameters from the session and constructs the URL
-        required to initiate logout with the OpenID Connect provider.
-
-        If no ID token is found in the session, the logout flow will not be initiated,
-        and the method will return the default redirect URL.
-
-        The 'state' parameter is generated randomly and persisted in the session to ensure
-        its integrity during the subsequent callback.
-        """
-
-        oidc_logout_endpoint = self.get_settings("OIDC_OP_LOGOUT_ENDPOINT")
-
-        if not oidc_logout_endpoint:
-            return self.redirect_url
-
-        reverse_url = reverse("oidc_logout_callback")
-        id_token = request.session.get("oidc_id_token", None)
-
-        if not id_token:
-            return self.redirect_url
-
-        query = {
-            "id_token_hint": id_token,
-            "state": crypto.get_random_string(self.get_settings("OIDC_STATE_SIZE", 32)),
-            "post_logout_redirect_uri": absolutify(request, reverse_url),
-        }
-
-        self.persist_state(request, query["state"])
-
-        return f"{oidc_logout_endpoint}?{urlencode(query)}"
-
-    def post(self, request):
-        """Handle user logout.
-
-        If the user is not authenticated, redirects to the default logout URL.
-        Otherwise, constructs the OIDC logout URL and redirects the user to start
-        the logout process.
-
-        If the user is redirected to the default logout URL, ensure her Django session
-        is terminated.
-        """
-
-        logout_url = self.redirect_url
-
-        if request.user.is_authenticated:
-            logout_url = self.construct_oidc_logout_url(request)
-
-        # If the user is not redirected to the OIDC provider, ensure logout
-        if logout_url == self.redirect_url:
-            auth.logout(request)
-
-        return HttpResponseRedirect(logout_url)
-
-
-class OIDCLogoutCallbackView(MozillaOIDCOIDCLogoutView):
-    """Custom view for handling the logout callback from the OpenID Connect (OIDC) provider.
-
-    Handles the callback after logout from the identity provider (OP).
-    Verifies the state parameter and performs necessary logout actions.
-
-    The Django session is maintained during the logout process to ensure the integrity
-    of the logout flow initiated in the previous step.
-    """
-
-    http_method_names = ["get"]
-
-    def get(self, request):
-        """Handle the logout callback.
-
-        If the user is not authenticated, redirects to the default logout URL.
-        Otherwise, verifies the state parameter and performs necessary logout actions.
-        """
-
-        if not request.user.is_authenticated:
-            return HttpResponseRedirect(self.redirect_url)
-
-        state = request.GET.get("state")
-
-        if state not in request.session.get("oidc_states", {}):
-            msg = "OIDC callback state not found in session `oidc_states`!"
-            raise SuspiciousOperation(msg)
-
-        del request.session["oidc_states"][state]
-        request.session.save()
-
-        auth.logout(request)
-
-        return HttpResponseRedirect(self.redirect_url)

src/backend/core/enums.py

@@ -2,11 +2,47 @@
 Core application enums declaration
 """
 
-from django.conf import global_settings
+import re
+from enum import StrEnum
+
+from django.conf import global_settings, settings
+from django.db import models
 from django.utils.translation import gettext_lazy as _
 
+ATTACHMENTS_FOLDER = "attachments"
+UUID_REGEX = (
+    r"[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}"
+)
+FILE_EXT_REGEX = r"\.[a-zA-Z0-9]{1,10}"
+MEDIA_STORAGE_URL_PATTERN = re.compile(
+    f"{settings.MEDIA_URL:s}(?P<pk>{UUID_REGEX:s})/"
+    f"(?P<attachment>{ATTACHMENTS_FOLDER:s}/{UUID_REGEX:s}(?:-unsafe)?{FILE_EXT_REGEX:s})$"
+)
+MEDIA_STORAGE_URL_EXTRACT = re.compile(
+    f"{settings.MEDIA_URL:s}({UUID_REGEX}/{ATTACHMENTS_FOLDER}/{UUID_REGEX}{FILE_EXT_REGEX})"
+)
+
+
 # In Django's code base, `LANGUAGES` is set by default with all supported languages.
 # We can use it for the choice of languages which should not be limited to the few languages
 # active in the app.
 # pylint: disable=no-member
 ALL_LANGUAGES = {language: _(name) for language, name in global_settings.LANGUAGES}
+
+
+class MoveNodePositionChoices(models.TextChoices):
+    """Defines the possible positions when moving a django-treebeard node."""
+
+    FIRST_CHILD = "first-child", _("First child")
+    LAST_CHILD = "last-child", _("Last child")
+    FIRST_SIBLING = "first-sibling", _("First sibling")
+    LAST_SIBLING = "last-sibling", _("Last sibling")
+    LEFT = "left", _("Left")
+    RIGHT = "right", _("Right")
+
+
+class DocumentAttachmentStatus(StrEnum):
+    """Defines the possible statuses for an attachment."""
+
+    PROCESSING = "processing"
+    READY = "ready"

src/backend/core/factories.py

@@ -13,6 +13,22 @@ from core import models
 
 fake = Faker()
 
+YDOC_HELLO_WORLD_BASE64 = (
+    "AR717vLVDgAHAQ5kb2N1bWVudC1zdG9yZQMKYmxvY2tHcm91cAcA9e7y1Q4AAw5ibG9ja0NvbnRh"
+    "aW5lcgcA9e7y1Q4BAwdoZWFkaW5nBwD17vLVDgIGBgD17vLVDgMGaXRhbGljAnt9hPXu8tUOBAVI"
+    "ZWxsb4b17vLVDgkGaXRhbGljBG51bGwoAPXu8tUOAg10ZXh0QWxpZ25tZW50AXcEbGVmdCgA9e7y"
+    "1Q4CBWxldmVsAX0BKAD17vLVDgECaWQBdyQwNGQ2MjM0MS04MzI2LTQyMzYtYTA4My00ODdlMjZm"
+    "YWQyMzAoAPXu8tUOAQl0ZXh0Q29sb3IBdwdkZWZhdWx0KAD17vLVDgEPYmFja2dyb3VuZENvbG9y"
+    "AXcHZGVmYXVsdIf17vLVDgEDDmJsb2NrQ29udGFpbmVyBwD17vLVDhADDmJ1bGxldExpc3RJdGVt"
+    "BwD17vLVDhEGBAD17vLVDhIBd4b17vLVDhMEYm9sZAJ7fYT17vLVDhQCb3KG9e7y1Q4WBGJvbGQE"
+    "bnVsbIT17vLVDhcCbGQoAPXu8tUOEQ10ZXh0QWxpZ25tZW50AXcEbGVmdCgA9e7y1Q4QAmlkAXck"
+    "ZDM1MWUwNjgtM2U1NS00MjI2LThlYTUtYWJiMjYzMTk4ZTJhKAD17vLVDhAJdGV4dENvbG9yAXcH"
+    "ZGVmYXVsdCgA9e7y1Q4QD2JhY2tncm91bmRDb2xvcgF3B2RlZmF1bHSH9e7y1Q4QAw5ibG9ja0Nv"
+    "bnRhaW5lcgcA9e7y1Q4eAwlwYXJhZ3JhcGgoAPXu8tUOHw10ZXh0QWxpZ25tZW50AXcEbGVmdCgA"
+    "9e7y1Q4eAmlkAXckODk3MDBjMDctZTBlMS00ZmUwLWFjYTItODQ5MzIwOWE3ZTQyKAD17vLVDh4J"
+    "dGV4dENvbG9yAXcHZGVmYXVsdCgA9e7y1Q4eD2JhY2tncm91bmRDb2xvcgF3B2RlZmF1bHQA"
+)
+
 
 class UserFactory(factory.django.DjangoModelFactory):
     """A factory to random users for testing purposes."""
@@ -46,6 +62,23 @@ class UserFactory(factory.django.DjangoModelFactory):
             UserTemplateAccessFactory(user=self, role="owner")
 
 
+class ParentNodeFactory(factory.declarations.ParameteredAttribute):
+    """Custom factory attribute for setting the parent node."""
+
+    def generate(self, step, params):
+        """
+        Generate a parent node for the factory.
+
+        This method is invoked during the factory's build process to determine the parent
+        node of the current object being created. If `params` is provided, it uses the factory's
+        metadata to recursively create or fetch the parent node. Otherwise, it returns `None`.
+        """
+        if not params:
+            return None
+        subfactory = step.builder.factory_meta.factory
+        return step.recurse(subfactory, params)
+
+
 class DocumentFactory(factory.django.DjangoModelFactory):
     """A factory to create documents"""
 
@@ -54,9 +87,13 @@ class DocumentFactory(factory.django.DjangoModelFactory):
         django_get_or_create = ("title",)
         skip_postgeneration_save = True
 
+    parent = ParentNodeFactory()
+
     title = factory.Sequence(lambda n: f"document{n}")
-    content = factory.Sequence(lambda n: f"content{n}")
+    excerpt = factory.Sequence(lambda n: f"excerpt{n}")
+    content = YDOC_HELLO_WORLD_BASE64
     creator = factory.SubFactory(UserFactory)
+    deleted_at = None
     link_reach = factory.fuzzy.FuzzyChoice(
         [a[0] for a in models.LinkReachChoices.choices]
     )
@@ -64,6 +101,29 @@ class DocumentFactory(factory.django.DjangoModelFactory):
         [r[0] for r in models.LinkRoleChoices.choices]
     )
 
+    @classmethod
+    def _create(cls, model_class, *args, **kwargs):
+        """
+        Custom creation logic for the factory: creates a document as a child node if
+        a parent is provided; otherwise, creates it as a root node.
+        """
+        parent = kwargs.pop("parent", None)
+
+        if parent:
+            # Add as a child node
+            kwargs["ancestors_deleted_at"] = (
+                kwargs.get("ancestors_deleted_at") or parent.ancestors_deleted_at
+            )
+            return parent.add_child(instance=model_class(**kwargs))
+
+        # Add as a root node
+        return model_class.add_root(instance=model_class(**kwargs))
+
+    @factory.lazy_attribute
+    def ancestors_deleted_at(self):
+        """Should always be set when "deleted_at" is set."""
+        return self.deleted_at
+
     @factory.post_generation
     def users(self, create, extracted, **kwargs):
         """Add users to document from a given list of users with or without roles."""
@@ -74,6 +134,16 @@ class DocumentFactory(factory.django.DjangoModelFactory):
                 else:
                     UserDocumentAccessFactory(document=self, user=item[0], role=item[1])
 
+    @factory.post_generation
+    def teams(self, create, extracted, **kwargs):
+        """Add teams to document from a given list of teams with or without roles."""
+        if create and extracted:
+            for item in extracted:
+                if isinstance(item, str):
+                    TeamDocumentAccessFactory(document=self, team=item)
+                else:
+                    TeamDocumentAccessFactory(document=self, team=item[0], role=item[1])
+
     @factory.post_generation
     def link_traces(self, create, extracted, **kwargs):
         """Add link traces to document from a given list of users."""

src/backend/core/malware_detection.py

@@ -0,0 +1,52 @@
+"""Malware detection callbacks"""
+
+import logging
+
+from django.core.files.storage import default_storage
+
+from lasuite.malware_detection.enums import ReportStatus
+
+from core.enums import DocumentAttachmentStatus
+from core.models import Document
+
+logger = logging.getLogger(__name__)
+security_logger = logging.getLogger("docs.security")
+
+
+def malware_detection_callback(file_path, status, error_info, **kwargs):
+    """Malware detection callback"""
+
+    if status == ReportStatus.SAFE:
+        logger.info("File %s is safe", file_path)
+        # Get existing metadata
+        s3_client = default_storage.connection.meta.client
+        bucket_name = default_storage.bucket_name
+        head_resp = s3_client.head_object(Bucket=bucket_name, Key=file_path)
+        metadata = head_resp.get("Metadata", {})
+        metadata.update({"status": DocumentAttachmentStatus.READY})
+        # Update status in metadata
+        s3_client.copy_object(
+            Bucket=bucket_name,
+            CopySource={"Bucket": bucket_name, "Key": file_path},
+            Key=file_path,
+            ContentType=head_resp.get("ContentType"),
+            Metadata=metadata,
+            MetadataDirective="REPLACE",
+        )
+        return
+
+    document_id = kwargs.get("document_id")
+    security_logger.warning(
+        "File %s for document %s is infected with malware. Error info: %s",
+        file_path,
+        document_id,
+        error_info,
+    )
+
+    # Remove the file from the document and change the status to unsafe
+    document = Document.objects.get(pk=document_id)
+    document.attachments.remove(file_path)
+    document.save(update_fields=["attachments"])
+
+    # Delete the file from the storage
+    default_storage.delete(file_path)

src/backend/core/migrations/0001_initial.py

@@ -1,166 +1,552 @@
 # Generated by Django 5.0.3 on 2024-05-28 20:29
 
+import uuid
+
 import django.contrib.auth.models
 import django.core.validators
 import django.db.models.deletion
-import timezone_field.fields
-import uuid
 from django.conf import settings
 from django.db import migrations, models
 
+import timezone_field.fields
+
 
 class Migration(migrations.Migration):
-
     initial = True
 
     dependencies = [
-        ('auth', '0012_alter_user_first_name_max_length'),
+        ("auth", "0012_alter_user_first_name_max_length"),
     ]
 
     operations = [
         migrations.CreateModel(
-            name='Document',
+            name="Document",
             fields=[
-                ('id', models.UUIDField(default=uuid.uuid4, editable=False, help_text='primary key for the record as UUID', primary_key=True, serialize=False, verbose_name='id')),
-                ('created_at', models.DateTimeField(auto_now_add=True, help_text='date and time at which a record was created', verbose_name='created on')),
-                ('updated_at', models.DateTimeField(auto_now=True, help_text='date and time at which a record was last updated', verbose_name='updated on')),
-                ('title', models.CharField(max_length=255, verbose_name='title')),
-                ('is_public', models.BooleanField(default=False, help_text='Whether this document is public for anyone to use.', verbose_name='public')),
+                (
+                    "id",
+                    models.UUIDField(
+                        default=uuid.uuid4,
+                        editable=False,
+                        help_text="primary key for the record as UUID",
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="id",
+                    ),
+                ),
+                (
+                    "created_at",
+                    models.DateTimeField(
+                        auto_now_add=True,
+                        help_text="date and time at which a record was created",
+                        verbose_name="created on",
+                    ),
+                ),
+                (
+                    "updated_at",
+                    models.DateTimeField(
+                        auto_now=True,
+                        help_text="date and time at which a record was last updated",
+                        verbose_name="updated on",
+                    ),
+                ),
+                ("title", models.CharField(max_length=255, verbose_name="title")),
+                (
+                    "is_public",
+                    models.BooleanField(
+                        default=False,
+                        help_text="Whether this document is public for anyone to use.",
+                        verbose_name="public",
+                    ),
+                ),
             ],
             options={
-                'verbose_name': 'Document',
-                'verbose_name_plural': 'Documents',
-                'db_table': 'impress_document',
-                'ordering': ('title',),
+                "verbose_name": "Document",
+                "verbose_name_plural": "Documents",
+                "db_table": "impress_document",
+                "ordering": ("title",),
             },
         ),
         migrations.CreateModel(
-            name='Template',
+            name="Template",
             fields=[
-                ('id', models.UUIDField(default=uuid.uuid4, editable=False, help_text='primary key for the record as UUID', primary_key=True, serialize=False, verbose_name='id')),
-                ('created_at', models.DateTimeField(auto_now_add=True, help_text='date and time at which a record was created', verbose_name='created on')),
-                ('updated_at', models.DateTimeField(auto_now=True, help_text='date and time at which a record was last updated', verbose_name='updated on')),
-                ('title', models.CharField(max_length=255, verbose_name='title')),
-                ('description', models.TextField(blank=True, verbose_name='description')),
-                ('code', models.TextField(blank=True, verbose_name='code')),
-                ('css', models.TextField(blank=True, verbose_name='css')),
-                ('is_public', models.BooleanField(default=False, help_text='Whether this template is public for anyone to use.', verbose_name='public')),
+                (
+                    "id",
+                    models.UUIDField(
+                        default=uuid.uuid4,
+                        editable=False,
+                        help_text="primary key for the record as UUID",
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="id",
+                    ),
+                ),
+                (
+                    "created_at",
+                    models.DateTimeField(
+                        auto_now_add=True,
+                        help_text="date and time at which a record was created",
+                        verbose_name="created on",
+                    ),
+                ),
+                (
+                    "updated_at",
+                    models.DateTimeField(
+                        auto_now=True,
+                        help_text="date and time at which a record was last updated",
+                        verbose_name="updated on",
+                    ),
+                ),
+                ("title", models.CharField(max_length=255, verbose_name="title")),
+                (
+                    "description",
+                    models.TextField(blank=True, verbose_name="description"),
+                ),
+                ("code", models.TextField(blank=True, verbose_name="code")),
+                ("css", models.TextField(blank=True, verbose_name="css")),
+                (
+                    "is_public",
+                    models.BooleanField(
+                        default=False,
+                        help_text="Whether this template is public for anyone to use.",
+                        verbose_name="public",
+                    ),
+                ),
             ],
             options={
-                'verbose_name': 'Template',
-                'verbose_name_plural': 'Templates',
-                'db_table': 'impress_template',
-                'ordering': ('title',),
+                "verbose_name": "Template",
+                "verbose_name_plural": "Templates",
+                "db_table": "impress_template",
+                "ordering": ("title",),
             },
         ),
         migrations.CreateModel(
-            name='User',
+            name="User",
             fields=[
-                ('password', models.CharField(max_length=128, verbose_name='password')),
-                ('last_login', models.DateTimeField(blank=True, null=True, verbose_name='last login')),
-                ('is_superuser', models.BooleanField(default=False, help_text='Designates that this user has all permissions without explicitly assigning them.', verbose_name='superuser status')),
-                ('id', models.UUIDField(default=uuid.uuid4, editable=False, help_text='primary key for the record as UUID', primary_key=True, serialize=False, verbose_name='id')),
-                ('created_at', models.DateTimeField(auto_now_add=True, help_text='date and time at which a record was created', verbose_name='created on')),
-                ('updated_at', models.DateTimeField(auto_now=True, help_text='date and time at which a record was last updated', verbose_name='updated on')),
-                ('sub', models.CharField(blank=True, help_text='Required. 255 characters or fewer. Letters, numbers, and @/./+/-/_ characters only.', max_length=255, null=True, unique=True, validators=[django.core.validators.RegexValidator(message='Enter a valid sub. This value may contain only letters, numbers, and @/./+/-/_ characters.', regex='^[\\w.@+-]+\\Z')], verbose_name='sub')),
-                ('email', models.EmailField(blank=True, max_length=254, null=True, verbose_name='identity email address')),
-                ('admin_email', models.EmailField(blank=True, max_length=254, null=True, unique=True, verbose_name='admin email address')),
-                ('language', models.CharField(choices="(('en-us', 'English'), ('fr-fr', 'French'))", default='en-us', help_text='The language in which the user wants to see the interface.', max_length=10, verbose_name='language')),
-                ('timezone', timezone_field.fields.TimeZoneField(choices_display='WITH_GMT_OFFSET', default='UTC', help_text='The timezone in which the user wants to see times.', use_pytz=False)),
-                ('is_device', models.BooleanField(default=False, help_text='Whether the user is a device or a real user.', verbose_name='device')),
-                ('is_staff', models.BooleanField(default=False, help_text='Whether the user can log into this admin site.', verbose_name='staff status')),
-                ('is_active', models.BooleanField(default=True, help_text='Whether this user should be treated as active. Unselect this instead of deleting accounts.', verbose_name='active')),
-                ('groups', models.ManyToManyField(blank=True, help_text='The groups this user belongs to. A user will get all permissions granted to each of their groups.', related_name='user_set', related_query_name='user', to='auth.group', verbose_name='groups')),
-                ('user_permissions', models.ManyToManyField(blank=True, help_text='Specific permissions for this user.', related_name='user_set', related_query_name='user', to='auth.permission', verbose_name='user permissions')),
+                ("password", models.CharField(max_length=128, verbose_name="password")),
+                (
+                    "last_login",
+                    models.DateTimeField(
+                        blank=True, null=True, verbose_name="last login"
+                    ),
+                ),
+                (
+                    "is_superuser",
+                    models.BooleanField(
+                        default=False,
+                        help_text="Designates that this user has all permissions without explicitly assigning them.",
+                        verbose_name="superuser status",
+                    ),
+                ),
+                (
+                    "id",
+                    models.UUIDField(
+                        default=uuid.uuid4,
+                        editable=False,
+                        help_text="primary key for the record as UUID",
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="id",
+                    ),
+                ),
+                (
+                    "created_at",
+                    models.DateTimeField(
+                        auto_now_add=True,
+                        help_text="date and time at which a record was created",
+                        verbose_name="created on",
+                    ),
+                ),
+                (
+                    "updated_at",
+                    models.DateTimeField(
+                        auto_now=True,
+                        help_text="date and time at which a record was last updated",
+                        verbose_name="updated on",
+                    ),
+                ),
+                (
+                    "sub",
+                    models.CharField(
+                        blank=True,
+                        help_text="Required. 255 characters or fewer. Letters, numbers, and @/./+/-/_ characters only.",
+                        max_length=255,
+                        null=True,
+                        unique=True,
+                        validators=[
+                            django.core.validators.RegexValidator(
+                                message="Enter a valid sub. This value may contain only letters, numbers, and @/./+/-/_ characters.",
+                                regex="^[\\w.@+-]+\\Z",
+                            )
+                        ],
+                        verbose_name="sub",
+                    ),
+                ),
+                (
+                    "email",
+                    models.EmailField(
+                        blank=True,
+                        max_length=254,
+                        null=True,
+                        verbose_name="identity email address",
+                    ),
+                ),
+                (
+                    "admin_email",
+                    models.EmailField(
+                        blank=True,
+                        max_length=254,
+                        null=True,
+                        unique=True,
+                        verbose_name="admin email address",
+                    ),
+                ),
+                (
+                    "language",
+                    models.CharField(
+                        choices="(('en-us', 'English'), ('fr-fr', 'French'))",
+                        default="en-us",
+                        help_text="The language in which the user wants to see the interface.",
+                        max_length=10,
+                        verbose_name="language",
+                    ),
+                ),
+                (
+                    "timezone",
+                    timezone_field.fields.TimeZoneField(
+                        choices_display="WITH_GMT_OFFSET",
+                        default="UTC",
+                        help_text="The timezone in which the user wants to see times.",
+                        use_pytz=False,
+                    ),
+                ),
+                (
+                    "is_device",
+                    models.BooleanField(
+                        default=False,
+                        help_text="Whether the user is a device or a real user.",
+                        verbose_name="device",
+                    ),
+                ),
+                (
+                    "is_staff",
+                    models.BooleanField(
+                        default=False,
+                        help_text="Whether the user can log into this admin site.",
+                        verbose_name="staff status",
+                    ),
+                ),
+                (
+                    "is_active",
+                    models.BooleanField(
+                        default=True,
+                        help_text="Whether this user should be treated as active. Unselect this instead of deleting accounts.",
+                        verbose_name="active",
+                    ),
+                ),
+                (
+                    "groups",
+                    models.ManyToManyField(
+                        blank=True,
+                        help_text="The groups this user belongs to. A user will get all permissions granted to each of their groups.",
+                        related_name="user_set",
+                        related_query_name="user",
+                        to="auth.group",
+                        verbose_name="groups",
+                    ),
+                ),
+                (
+                    "user_permissions",
+                    models.ManyToManyField(
+                        blank=True,
+                        help_text="Specific permissions for this user.",
+                        related_name="user_set",
+                        related_query_name="user",
+                        to="auth.permission",
+                        verbose_name="user permissions",
+                    ),
+                ),
             ],
             options={
-                'verbose_name': 'user',
-                'verbose_name_plural': 'users',
-                'db_table': 'impress_user',
+                "verbose_name": "user",
+                "verbose_name_plural": "users",
+                "db_table": "impress_user",
             },
             managers=[
-                ('objects', django.contrib.auth.models.UserManager()),
+                ("objects", django.contrib.auth.models.UserManager()),
             ],
         ),
         migrations.CreateModel(
-            name='DocumentAccess',
+            name="DocumentAccess",
             fields=[
-                ('id', models.UUIDField(default=uuid.uuid4, editable=False, help_text='primary key for the record as UUID', primary_key=True, serialize=False, verbose_name='id')),
-                ('created_at', models.DateTimeField(auto_now_add=True, help_text='date and time at which a record was created', verbose_name='created on')),
-                ('updated_at', models.DateTimeField(auto_now=True, help_text='date and time at which a record was last updated', verbose_name='updated on')),
-                ('team', models.CharField(blank=True, max_length=100)),
-                ('role', models.CharField(choices=[('reader', 'Reader'), ('editor', 'Editor'), ('administrator', 'Administrator'), ('owner', 'Owner')], default='reader', max_length=20)),
-                ('document', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='accesses', to='core.document')),
-                ('user', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL)),
+                (
+                    "id",
+                    models.UUIDField(
+                        default=uuid.uuid4,
+                        editable=False,
+                        help_text="primary key for the record as UUID",
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="id",
+                    ),
+                ),
+                (
+                    "created_at",
+                    models.DateTimeField(
+                        auto_now_add=True,
+                        help_text="date and time at which a record was created",
+                        verbose_name="created on",
+                    ),
+                ),
+                (
+                    "updated_at",
+                    models.DateTimeField(
+                        auto_now=True,
+                        help_text="date and time at which a record was last updated",
+                        verbose_name="updated on",
+                    ),
+                ),
+                ("team", models.CharField(blank=True, max_length=100)),
+                (
+                    "role",
+                    models.CharField(
+                        choices=[
+                            ("reader", "Reader"),
+                            ("editor", "Editor"),
+                            ("administrator", "Administrator"),
+                            ("owner", "Owner"),
+                        ],
+                        default="reader",
+                        max_length=20,
+                    ),
+                ),
+                (
+                    "document",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="accesses",
+                        to="core.document",
+                    ),
+                ),
+                (
+                    "user",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        to=settings.AUTH_USER_MODEL,
+                    ),
+                ),
             ],
             options={
-                'verbose_name': 'Document/user relation',
-                'verbose_name_plural': 'Document/user relations',
-                'db_table': 'impress_document_access',
-                'ordering': ('-created_at',),
+                "verbose_name": "Document/user relation",
+                "verbose_name_plural": "Document/user relations",
+                "db_table": "impress_document_access",
+                "ordering": ("-created_at",),
             },
         ),
         migrations.CreateModel(
-            name='Invitation',
+            name="Invitation",
             fields=[
-                ('id', models.UUIDField(default=uuid.uuid4, editable=False, help_text='primary key for the record as UUID', primary_key=True, serialize=False, verbose_name='id')),
-                ('created_at', models.DateTimeField(auto_now_add=True, help_text='date and time at which a record was created', verbose_name='created on')),
-                ('updated_at', models.DateTimeField(auto_now=True, help_text='date and time at which a record was last updated', verbose_name='updated on')),
-                ('email', models.EmailField(max_length=254, verbose_name='email address')),
-                ('role', models.CharField(choices=[('reader', 'Reader'), ('editor', 'Editor'), ('administrator', 'Administrator'), ('owner', 'Owner')], default='reader', max_length=20)),
-                ('document', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='invitations', to='core.document')),
-                ('issuer', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='invitations', to=settings.AUTH_USER_MODEL)),
+                (
+                    "id",
+                    models.UUIDField(
+                        default=uuid.uuid4,
+                        editable=False,
+                        help_text="primary key for the record as UUID",
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="id",
+                    ),
+                ),
+                (
+                    "created_at",
+                    models.DateTimeField(
+                        auto_now_add=True,
+                        help_text="date and time at which a record was created",
+                        verbose_name="created on",
+                    ),
+                ),
+                (
+                    "updated_at",
+                    models.DateTimeField(
+                        auto_now=True,
+                        help_text="date and time at which a record was last updated",
+                        verbose_name="updated on",
+                    ),
+                ),
+                (
+                    "email",
+                    models.EmailField(max_length=254, verbose_name="email address"),
+                ),
+                (
+                    "role",
+                    models.CharField(
+                        choices=[
+                            ("reader", "Reader"),
+                            ("editor", "Editor"),
+                            ("administrator", "Administrator"),
+                            ("owner", "Owner"),
+                        ],
+                        default="reader",
+                        max_length=20,
+                    ),
+                ),
+                (
+                    "document",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="invitations",
+                        to="core.document",
+                    ),
+                ),
+                (
+                    "issuer",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="invitations",
+                        to=settings.AUTH_USER_MODEL,
+                    ),
+                ),
             ],
             options={
-                'verbose_name': 'Document invitation',
-                'verbose_name_plural': 'Document invitations',
-                'db_table': 'impress_invitation',
+                "verbose_name": "Document invitation",
+                "verbose_name_plural": "Document invitations",
+                "db_table": "impress_invitation",
             },
         ),
         migrations.CreateModel(
-            name='TemplateAccess',
+            name="TemplateAccess",
             fields=[
-                ('id', models.UUIDField(default=uuid.uuid4, editable=False, help_text='primary key for the record as UUID', primary_key=True, serialize=False, verbose_name='id')),
-                ('created_at', models.DateTimeField(auto_now_add=True, help_text='date and time at which a record was created', verbose_name='created on')),
-                ('updated_at', models.DateTimeField(auto_now=True, help_text='date and time at which a record was last updated', verbose_name='updated on')),
-                ('team', models.CharField(blank=True, max_length=100)),
-                ('role', models.CharField(choices=[('reader', 'Reader'), ('editor', 'Editor'), ('administrator', 'Administrator'), ('owner', 'Owner')], default='reader', max_length=20)),
-                ('template', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='accesses', to='core.template')),
-                ('user', models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL)),
+                (
+                    "id",
+                    models.UUIDField(
+                        default=uuid.uuid4,
+                        editable=False,
+                        help_text="primary key for the record as UUID",
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="id",
+                    ),
+                ),
+                (
+                    "created_at",
+                    models.DateTimeField(
+                        auto_now_add=True,
+                        help_text="date and time at which a record was created",
+                        verbose_name="created on",
+                    ),
+                ),
+                (
+                    "updated_at",
+                    models.DateTimeField(
+                        auto_now=True,
+                        help_text="date and time at which a record was last updated",
+                        verbose_name="updated on",
+                    ),
+                ),
+                ("team", models.CharField(blank=True, max_length=100)),
+                (
+                    "role",
+                    models.CharField(
+                        choices=[
+                            ("reader", "Reader"),
+                            ("editor", "Editor"),
+                            ("administrator", "Administrator"),
+                            ("owner", "Owner"),
+                        ],
+                        default="reader",
+                        max_length=20,
+                    ),
+                ),
+                (
+                    "template",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="accesses",
+                        to="core.template",
+                    ),
+                ),
+                (
+                    "user",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        to=settings.AUTH_USER_MODEL,
+                    ),
+                ),
             ],
             options={
-                'verbose_name': 'Template/user relation',
-                'verbose_name_plural': 'Template/user relations',
-                'db_table': 'impress_template_access',
-                'ordering': ('-created_at',),
+                "verbose_name": "Template/user relation",
+                "verbose_name_plural": "Template/user relations",
+                "db_table": "impress_template_access",
+                "ordering": ("-created_at",),
             },
         ),
         migrations.AddConstraint(
-            model_name='documentaccess',
-            constraint=models.UniqueConstraint(condition=models.Q(('user__isnull', False)), fields=('user', 'document'), name='unique_document_user', violation_error_message='This user is already in this document.'),
+            model_name="documentaccess",
+            constraint=models.UniqueConstraint(
+                condition=models.Q(("user__isnull", False)),
+                fields=("user", "document"),
+                name="unique_document_user",
+                violation_error_message="This user is already in this document.",
+            ),
         ),
         migrations.AddConstraint(
-            model_name='documentaccess',
-            constraint=models.UniqueConstraint(condition=models.Q(('team__gt', '')), fields=('team', 'document'), name='unique_document_team', violation_error_message='This team is already in this document.'),
+            model_name="documentaccess",
+            constraint=models.UniqueConstraint(
+                condition=models.Q(("team__gt", "")),
+                fields=("team", "document"),
+                name="unique_document_team",
+                violation_error_message="This team is already in this document.",
+            ),
         ),
         migrations.AddConstraint(
-            model_name='documentaccess',
-            constraint=models.CheckConstraint(check=models.Q(models.Q(('team', ''), ('user__isnull', False)), models.Q(('team__gt', ''), ('user__isnull', True)), _connector='OR'), name='check_document_access_either_user_or_team', violation_error_message='Either user or team must be set, not both.'),
+            model_name="documentaccess",
+            constraint=models.CheckConstraint(
+                check=models.Q(
+                    models.Q(("team", ""), ("user__isnull", False)),
+                    models.Q(("team__gt", ""), ("user__isnull", True)),
+                    _connector="OR",
+                ),
+                name="check_document_access_either_user_or_team",
+                violation_error_message="Either user or team must be set, not both.",
+            ),
         ),
         migrations.AddConstraint(
-            model_name='invitation',
-            constraint=models.UniqueConstraint(fields=('email', 'document'), name='email_and_document_unique_together'),
+            model_name="invitation",
+            constraint=models.UniqueConstraint(
+                fields=("email", "document"), name="email_and_document_unique_together"
+            ),
         ),
         migrations.AddConstraint(
-            model_name='templateaccess',
-            constraint=models.UniqueConstraint(condition=models.Q(('user__isnull', False)), fields=('user', 'template'), name='unique_template_user', violation_error_message='This user is already in this template.'),
+            model_name="templateaccess",
+            constraint=models.UniqueConstraint(
+                condition=models.Q(("user__isnull", False)),
+                fields=("user", "template"),
+                name="unique_template_user",
+                violation_error_message="This user is already in this template.",
+            ),
         ),
         migrations.AddConstraint(
-            model_name='templateaccess',
-            constraint=models.UniqueConstraint(condition=models.Q(('team__gt', '')), fields=('team', 'template'), name='unique_template_team', violation_error_message='This team is already in this template.'),
+            model_name="templateaccess",
+            constraint=models.UniqueConstraint(
+                condition=models.Q(("team__gt", "")),
+                fields=("team", "template"),
+                name="unique_template_team",
+                violation_error_message="This team is already in this template.",
+            ),
         ),
         migrations.AddConstraint(
-            model_name='templateaccess',
-            constraint=models.CheckConstraint(check=models.Q(models.Q(('team', ''), ('user__isnull', False)), models.Q(('team__gt', ''), ('user__isnull', True)), _connector='OR'), name='check_template_access_either_user_or_team', violation_error_message='Either user or team must be set, not both.'),
+            model_name="templateaccess",
+            constraint=models.CheckConstraint(
+                check=models.Q(
+                    models.Q(("team", ""), ("user__isnull", False)),
+                    models.Q(("team__gt", ""), ("user__isnull", True)),
+                    _connector="OR",
+                ),
+                name="check_template_access_either_user_or_team",
+                violation_error_message="Either user or team must be set, not both.",
+            ),
         ),
     ]

src/backend/core/migrations/0002_create_pg_trgm_extension.py

@@ -1,9 +1,9 @@
 from django.db import migrations
 
-class Migration(migrations.Migration):
 
+class Migration(migrations.Migration):
     dependencies = [
-        ('core', '0001_initial'),
+        ("core", "0001_initial"),
     ]
 
     operations = [

src/backend/core/migrations/0003_document_link_reach_document_link_role_and_more.py

@@ -1,52 +1,114 @@
 # Generated by Django 5.1 on 2024-09-08 16:55
 
-import django.db.models.deletion
 import uuid
+
+import django.db.models.deletion
 from django.conf import settings
 from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
-        ('core', '0002_create_pg_trgm_extension'),
+        ("core", "0002_create_pg_trgm_extension"),
     ]
 
     operations = [
         migrations.AddField(
-            model_name='document',
-            name='link_reach',
-            field=models.CharField(choices=[('restricted', 'Restricted'), ('authenticated', 'Authenticated'), ('public', 'Public')], default='authenticated', max_length=20),
+            model_name="document",
+            name="link_reach",
+            field=models.CharField(
+                choices=[
+                    ("restricted", "Restricted"),
+                    ("authenticated", "Authenticated"),
+                    ("public", "Public"),
+                ],
+                default="authenticated",
+                max_length=20,
+            ),
         ),
         migrations.AddField(
-            model_name='document',
-            name='link_role',
-            field=models.CharField(choices=[('reader', 'Reader'), ('editor', 'Editor')], default='reader', max_length=20),
+            model_name="document",
+            name="link_role",
+            field=models.CharField(
+                choices=[("reader", "Reader"), ("editor", "Editor")],
+                default="reader",
+                max_length=20,
+            ),
         ),
         migrations.AlterField(
-            model_name='document',
-            name='is_public',
+            model_name="document",
+            name="is_public",
             field=models.BooleanField(null=True),
         ),
         migrations.AlterField(
-            model_name='user',
-            name='language',
-            field=models.CharField(choices="(('en-us', 'English'), ('fr-fr', 'French'))", default='en-us', help_text='The language in which the user wants to see the interface.', max_length=10, verbose_name='language'),
+            model_name="user",
+            name="language",
+            field=models.CharField(
+                choices="(('en-us', 'English'), ('fr-fr', 'French'))",
+                default="en-us",
+                help_text="The language in which the user wants to see the interface.",
+                max_length=10,
+                verbose_name="language",
+            ),
         ),
         migrations.CreateModel(
-            name='LinkTrace',
+            name="LinkTrace",
             fields=[
-                ('id', models.UUIDField(default=uuid.uuid4, editable=False, help_text='primary key for the record as UUID', primary_key=True, serialize=False, verbose_name='id')),
-                ('created_at', models.DateTimeField(auto_now_add=True, help_text='date and time at which a record was created', verbose_name='created on')),
-                ('updated_at', models.DateTimeField(auto_now=True, help_text='date and time at which a record was last updated', verbose_name='updated on')),
-                ('document', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='link_traces', to='core.document')),
-                ('user', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='link_traces', to=settings.AUTH_USER_MODEL)),
+                (
+                    "id",
+                    models.UUIDField(
+                        default=uuid.uuid4,
+                        editable=False,
+                        help_text="primary key for the record as UUID",
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="id",
+                    ),
+                ),
+                (
+                    "created_at",
+                    models.DateTimeField(
+                        auto_now_add=True,
+                        help_text="date and time at which a record was created",
+                        verbose_name="created on",
+                    ),
+                ),
+                (
+                    "updated_at",
+                    models.DateTimeField(
+                        auto_now=True,
+                        help_text="date and time at which a record was last updated",
+                        verbose_name="updated on",
+                    ),
+                ),
+                (
+                    "document",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="link_traces",
+                        to="core.document",
+                    ),
+                ),
+                (
+                    "user",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="link_traces",
+                        to=settings.AUTH_USER_MODEL,
+                    ),
+                ),
             ],
             options={
-                'verbose_name': 'Document/user link trace',
-                'verbose_name_plural': 'Document/user link traces',
-                'db_table': 'impress_link_trace',
-                'constraints': [models.UniqueConstraint(fields=('user', 'document'), name='unique_link_trace_document_user', violation_error_message='A link trace already exists for this document/user.')],
+                "verbose_name": "Document/user link trace",
+                "verbose_name_plural": "Document/user link traces",
+                "db_table": "impress_link_trace",
+                "constraints": [
+                    models.UniqueConstraint(
+                        fields=("user", "document"),
+                        name="unique_link_trace_document_user",
+                        violation_error_message="A link trace already exists for this document/user.",
+                    )
+                ],
             },
         ),
     ]

src/backend/core/migrations/0004_migrate_is_public_to_link_reach.py

@@ -1,13 +1,14 @@
 # Generated by Django 5.1 on 2024-09-08 17:04
 from django.db import migrations
 
+
 def migrate_is_public_to_link_reach(apps, schema_editor):
     """
     Forward migration: Migrate 'is_public' to 'link_reach'.
     If is_public == True, set link_reach to 'public'
     """
-    Document = apps.get_model('core', 'Document')
-    Document.objects.filter(is_public=True).update(link_reach='public')
+    Document = apps.get_model("core", "Document")
+    Document.objects.filter(is_public=True).update(link_reach="public")
 
 
 def reverse_migrate_link_reach_to_is_public(apps, schema_editor):
@@ -16,20 +17,20 @@ def reverse_migrate_link_reach_to_is_public(apps, schema_editor):
     - If link_reach == 'public', set is_public to True
     - Else set is_public to False
     """
-    Document = apps.get_model('core', 'Document')
-    Document.objects.filter(link_reach='public').update(is_public=True)
-    Document.objects.filter(link_reach__in=['restricted', "authenticated"]).update(is_public=False)
+    Document = apps.get_model("core", "Document")
+    Document.objects.filter(link_reach="public").update(is_public=True)
+    Document.objects.filter(link_reach__in=["restricted", "authenticated"]).update(
+        is_public=False
+    )
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
-        ('core', '0003_document_link_reach_document_link_role_and_more'),
+        ("core", "0003_document_link_reach_document_link_role_and_more"),
     ]
 
     operations = [
         migrations.RunPython(
-            migrate_is_public_to_link_reach, 
-            reverse_migrate_link_reach_to_is_public
+            migrate_is_public_to_link_reach, reverse_migrate_link_reach_to_is_public
         ),
     ]

src/backend/core/migrations/0005_remove_document_is_public_alter_document_link_reach_and_more.py

@@ -4,15 +4,16 @@ from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
-        ('core', '0004_migrate_is_public_to_link_reach'),
+        ("core", "0004_migrate_is_public_to_link_reach"),
     ]
 
     operations = [
         migrations.AlterField(
-            model_name='document',
-            name='title',
-            field=models.CharField(blank=True, max_length=255, null=True, verbose_name='title'),
+            model_name="document",
+            name="title",
+            field=models.CharField(
+                blank=True, max_length=255, null=True, verbose_name="title"
+            ),
         ),
     ]

src/backend/core/migrations/0006_add_user_full_name_and_short_name.py

@@ -4,25 +4,34 @@ from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
-        ('core', '0005_remove_document_is_public_alter_document_link_reach_and_more'),
+        ("core", "0005_remove_document_is_public_alter_document_link_reach_and_more"),
     ]
 
     operations = [
         migrations.AddField(
-            model_name='user',
-            name='full_name',
-            field=models.CharField(blank=True, max_length=100, null=True, verbose_name='full name'),
+            model_name="user",
+            name="full_name",
+            field=models.CharField(
+                blank=True, max_length=100, null=True, verbose_name="full name"
+            ),
         ),
         migrations.AddField(
-            model_name='user',
-            name='short_name',
-            field=models.CharField(blank=True, max_length=20, null=True, verbose_name='short name'),
+            model_name="user",
+            name="short_name",
+            field=models.CharField(
+                blank=True, max_length=20, null=True, verbose_name="short name"
+            ),
         ),
         migrations.AlterField(
-            model_name='user',
-            name='language',
-            field=models.CharField(choices="(('en-us', 'English'), ('fr-fr', 'French'))", default='en-us', help_text='The language in which the user wants to see the interface.', max_length=10, verbose_name='language'),
+            model_name="user",
+            name="language",
+            field=models.CharField(
+                choices="(('en-us', 'English'), ('fr-fr', 'French'))",
+                default="en-us",
+                help_text="The language in which the user wants to see the interface.",
+                max_length=10,
+                verbose_name="language",
+            ),
         ),
     ]

src/backend/core/migrations/0007_fix_users_duplicate.py

@@ -117,10 +117,10 @@ BEGIN
 END $$;
 """
 
-class Migration(migrations.Migration):
 
+class Migration(migrations.Migration):
     dependencies = [
-        ('core', '0006_add_user_full_name_and_short_name'),
+        ("core", "0006_add_user_full_name_and_short_name"),
     ]
 
     operations = [

src/backend/core/migrations/0008_alter_document_link_reach.py

@@ -4,15 +4,22 @@ from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
-        ('core', '0007_fix_users_duplicate'),
+        ("core", "0007_fix_users_duplicate"),
     ]
 
     operations = [
         migrations.AlterField(
-            model_name='document',
-            name='link_reach',
-            field=models.CharField(choices=[('restricted', 'Restricted'), ('authenticated', 'Authenticated'), ('public', 'Public')], default='restricted', max_length=20),
+            model_name="document",
+            name="link_reach",
+            field=models.CharField(
+                choices=[
+                    ("restricted", "Restricted"),
+                    ("authenticated", "Authenticated"),
+                    ("public", "Public"),
+                ],
+                default="restricted",
+                max_length=20,
+            ),
         ),
     ]

src/backend/core/migrations/0009_add_document_favorite.py

@@ -1,37 +1,87 @@
 # Generated by Django 5.1.2 on 2024-11-08 07:59
 
-import django.db.models.deletion
 import uuid
+
+import django.db.models.deletion
 from django.conf import settings
 from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
-        ('core', '0008_alter_document_link_reach'),
+        ("core", "0008_alter_document_link_reach"),
     ]
 
     operations = [
         migrations.AlterField(
-            model_name='user',
-            name='language',
-            field=models.CharField(choices="(('en-us', 'English'), ('fr-fr', 'French'), ('de-de', 'German'))", default='en-us', help_text='The language in which the user wants to see the interface.', max_length=10, verbose_name='language'),
+            model_name="user",
+            name="language",
+            field=models.CharField(
+                choices="(('en-us', 'English'), ('fr-fr', 'French'), ('de-de', 'German'))",
+                default="en-us",
+                help_text="The language in which the user wants to see the interface.",
+                max_length=10,
+                verbose_name="language",
+            ),
         ),
         migrations.CreateModel(
-            name='DocumentFavorite',
+            name="DocumentFavorite",
             fields=[
-                ('id', models.UUIDField(default=uuid.uuid4, editable=False, help_text='primary key for the record as UUID', primary_key=True, serialize=False, verbose_name='id')),
-                ('created_at', models.DateTimeField(auto_now_add=True, help_text='date and time at which a record was created', verbose_name='created on')),
-                ('updated_at', models.DateTimeField(auto_now=True, help_text='date and time at which a record was last updated', verbose_name='updated on')),
-                ('document', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='favorited_by_users', to='core.document')),
-                ('user', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='favorite_documents', to=settings.AUTH_USER_MODEL)),
+                (
+                    "id",
+                    models.UUIDField(
+                        default=uuid.uuid4,
+                        editable=False,
+                        help_text="primary key for the record as UUID",
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="id",
+                    ),
+                ),
+                (
+                    "created_at",
+                    models.DateTimeField(
+                        auto_now_add=True,
+                        help_text="date and time at which a record was created",
+                        verbose_name="created on",
+                    ),
+                ),
+                (
+                    "updated_at",
+                    models.DateTimeField(
+                        auto_now=True,
+                        help_text="date and time at which a record was last updated",
+                        verbose_name="updated on",
+                    ),
+                ),
+                (
+                    "document",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="favorited_by_users",
+                        to="core.document",
+                    ),
+                ),
+                (
+                    "user",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="favorite_documents",
+                        to=settings.AUTH_USER_MODEL,
+                    ),
+                ),
             ],
             options={
-                'verbose_name': 'Document favorite',
-                'verbose_name_plural': 'Document favorites',
-                'db_table': 'impress_document_favorite',
-                'constraints': [models.UniqueConstraint(fields=('user', 'document'), name='unique_document_favorite_user', violation_error_message='This document is already targeted by a favorite relation instance for the same user.')],
+                "verbose_name": "Document favorite",
+                "verbose_name_plural": "Document favorites",
+                "db_table": "impress_document_favorite",
+                "constraints": [
+                    models.UniqueConstraint(
+                        fields=("user", "document"),
+                        name="unique_document_favorite_user",
+                        violation_error_message="This document is already targeted by a favorite relation instance for the same user.",
+                    )
+                ],
             },
         ),
     ]

src/backend/core/migrations/0010_add_field_creator_to_document.py

@@ -7,25 +7,48 @@ from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
-        ('core', '0009_add_document_favorite'),
+        ("core", "0009_add_document_favorite"),
     ]
 
     operations = [
         migrations.AddField(
-            model_name='document',
-            name='creator',
-            field=models.ForeignKey(null=True, on_delete=django.db.models.deletion.RESTRICT, related_name='documents_created', to=settings.AUTH_USER_MODEL),
+            model_name="document",
+            name="creator",
+            field=models.ForeignKey(
+                null=True,
+                on_delete=django.db.models.deletion.RESTRICT,
+                related_name="documents_created",
+                to=settings.AUTH_USER_MODEL,
+            ),
         ),
         migrations.AlterField(
-            model_name='user',
-            name='language',
-            field=models.CharField(choices="(('en-us', 'English'), ('fr-fr', 'French'), ('de-de', 'German'))", default='en-us', help_text='The language in which the user wants to see the interface.', max_length=10, verbose_name='language'),
+            model_name="user",
+            name="language",
+            field=models.CharField(
+                choices="(('en-us', 'English'), ('fr-fr', 'French'), ('de-de', 'German'))",
+                default="en-us",
+                help_text="The language in which the user wants to see the interface.",
+                max_length=10,
+                verbose_name="language",
+            ),
         ),
         migrations.AlterField(
-            model_name='user',
-            name='sub',
-            field=models.CharField(blank=True, help_text='Required. 255 characters or fewer. Letters, numbers, and @/./+/-/_/: characters only.', max_length=255, null=True, unique=True, validators=[django.core.validators.RegexValidator(message='Enter a valid sub. This value may contain only letters, numbers, and @/./+/-/_/: characters.', regex='^[\\w.@+-:]+\\Z')], verbose_name='sub'),
+            model_name="user",
+            name="sub",
+            field=models.CharField(
+                blank=True,
+                help_text="Required. 255 characters or fewer. Letters, numbers, and @/./+/-/_/: characters only.",
+                max_length=255,
+                null=True,
+                unique=True,
+                validators=[
+                    django.core.validators.RegexValidator(
+                        message="Enter a valid sub. This value may contain only letters, numbers, and @/./+/-/_/: characters.",
+                        regex="^[\\w.@+-:]+\\Z",
+                    )
+                ],
+                verbose_name="sub",
+            ),
         ),
     ]

src/backend/core/migrations/0011_populate_creator_field_and_make_it_required.py

@@ -3,7 +3,7 @@
 import django.db.models.deletion
 from django.conf import settings
 from django.db import migrations
-from django.db.models import F, ForeignKey, Subquery, OuterRef, Q
+from django.db.models import F, ForeignKey, OuterRef, Q, Subquery
 
 
 def set_creator_from_document_access(apps, schema_editor):
@@ -25,28 +25,37 @@ def set_creator_from_document_access(apps, schema_editor):
     DocumentAccess = apps.get_model("core", "DocumentAccess")
 
     # Update `creator` using the "owner" role
-    owner_subquery = DocumentAccess.objects.filter(
-        document=OuterRef('pk'),
-        user__isnull=False,
-        role='owner',
-    ).order_by('created_at').values('user_id')[:1]
+    owner_subquery = (
+        DocumentAccess.objects.filter(
+            document=OuterRef("pk"),
+            user__isnull=False,
+            role="owner",
+        )
+        .order_by("created_at")
+        .values("user_id")[:1]
+    )
 
-    Document.objects.filter(
-        creator__isnull=True
-    ).update(creator=Subquery(owner_subquery))
+    Document.objects.filter(creator__isnull=True).update(
+        creator=Subquery(owner_subquery)
+    )
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
-        ('core', '0010_add_field_creator_to_document'),
+        ("core", "0010_add_field_creator_to_document"),
     ]
 
     operations = [
-        migrations.RunPython(set_creator_from_document_access, reverse_code=migrations.RunPython.noop),
+        migrations.RunPython(
+            set_creator_from_document_access, reverse_code=migrations.RunPython.noop
+        ),
         migrations.AlterField(
-            model_name='document',
-            name='creator',
-            field=ForeignKey(on_delete=django.db.models.deletion.RESTRICT, related_name='documents_created', to=settings.AUTH_USER_MODEL),
+            model_name="document",
+            name="creator",
+            field=ForeignKey(
+                on_delete=django.db.models.deletion.RESTRICT,
+                related_name="documents_created",
+                to=settings.AUTH_USER_MODEL,
+            ),
         ),
     ]

src/backend/core/migrations/0012_make_document_creator_and_invitation_issuer_optional.py

@@ -6,25 +6,42 @@ from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
-        ('core', '0011_populate_creator_field_and_make_it_required'),
+        ("core", "0011_populate_creator_field_and_make_it_required"),
     ]
 
     operations = [
         migrations.AlterField(
-            model_name='document',
-            name='creator',
-            field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.RESTRICT, related_name='documents_created', to=settings.AUTH_USER_MODEL),
+            model_name="document",
+            name="creator",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.RESTRICT,
+                related_name="documents_created",
+                to=settings.AUTH_USER_MODEL,
+            ),
         ),
         migrations.AlterField(
-            model_name='invitation',
-            name='issuer',
-            field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, related_name='invitations', to=settings.AUTH_USER_MODEL),
+            model_name="invitation",
+            name="issuer",
+            field=models.ForeignKey(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                related_name="invitations",
+                to=settings.AUTH_USER_MODEL,
+            ),
         ),
         migrations.AlterField(
-            model_name='user',
-            name='language',
-            field=models.CharField(choices="(('en-us', 'English'), ('fr-fr', 'French'), ('de-de', 'German'))", default='en-us', help_text='The language in which the user wants to see the interface.', max_length=10, verbose_name='language'),
+            model_name="user",
+            name="language",
+            field=models.CharField(
+                choices="(('en-us', 'English'), ('fr-fr', 'French'), ('de-de', 'German'))",
+                default="en-us",
+                help_text="The language in which the user wants to see the interface.",
+                max_length=10,
+                verbose_name="language",
+            ),
         ),
     ]

src/backend/core/migrations/0013_activate_fuzzystrmatch_extension.py

@@ -0,0 +1,16 @@
+# Generated by Django 5.1.4 on 2025-01-25 08:38
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("core", "0012_make_document_creator_and_invitation_issuer_optional"),
+    ]
+
+    operations = [
+        migrations.RunSQL(
+            "CREATE EXTENSION IF NOT EXISTS fuzzystrmatch;",
+            reverse_sql="DROP EXTENSION IF EXISTS fuzzystrmatch;",
+        ),
+    ]

src/backend/core/migrations/0014_add_tree_structure_to_documents.py

@@ -0,0 +1,32 @@
+# Generated by Django 5.1.2 on 2024-12-07 09:43
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("core", "0013_activate_fuzzystrmatch_extension"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="document",
+            name="depth",
+            field=models.PositiveIntegerField(default=0),
+            preserve_default=False,
+        ),
+        migrations.AddField(
+            model_name="document",
+            name="numchild",
+            field=models.PositiveIntegerField(default=0),
+        ),
+        migrations.AddField(
+            model_name="document",
+            name="path",
+            # Allow null values pending the next datamigration to populate the field
+            field=models.CharField(
+                db_collation="C", max_length=252, null=True, unique=True
+            ),
+            preserve_default=False,
+        ),
+    ]

src/backend/core/migrations/0015_set_path_on_existing_documents.py

@@ -0,0 +1,51 @@
+# Generated by Django 5.1.2 on 2024-12-07 10:33
+
+from django.db import migrations, models
+
+from treebeard.numconv import NumConv
+
+ALPHABET = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"
+STEPLEN = 7
+
+
+def set_path_on_existing_documents(apps, schema_editor):
+    """
+    Updates the `path` and `depth` fields for all existing Document records
+    to ensure valid materialized paths.
+
+    This function assigns a unique `path` to each Document as a root node
+
+    Note: After running this migration, we quickly modify the schema to make
+    the `path` field required as it should.
+    """
+    Document = apps.get_model("core", "Document")
+
+    # Iterate over all existing documents and make them root nodes
+    documents = Document.objects.order_by("created_at").values_list("id", flat=True)
+    numconv = NumConv(len(ALPHABET), ALPHABET)
+
+    updates = []
+    for i, pk in enumerate(documents):
+        key = numconv.int2str(i)
+        path = "{0}{1}".format(ALPHABET[0] * (STEPLEN - len(key)), key)
+        updates.append(Document(pk=pk, path=path, depth=1))
+
+    # Bulk update using the prepared updates list
+    Document.objects.bulk_update(updates, ["depth", "path"])
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("core", "0014_add_tree_structure_to_documents"),
+    ]
+
+    operations = [
+        migrations.RunPython(
+            set_path_on_existing_documents, reverse_code=migrations.RunPython.noop
+        ),
+        migrations.AlterField(
+            model_name="document",
+            name="path",
+            field=models.CharField(db_collation="C", max_length=252, unique=True),
+        ),
+    ]

src/backend/core/migrations/0016_add_document_excerpt.py

@@ -0,0 +1,30 @@
+# Generated by Django 5.1.4 on 2024-12-18 08:56
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("core", "0015_set_path_on_existing_documents"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="document",
+            name="excerpt",
+            field=models.TextField(
+                blank=True, max_length=300, null=True, verbose_name="excerpt"
+            ),
+        ),
+        migrations.AlterField(
+            model_name="user",
+            name="language",
+            field=models.CharField(
+                choices="(('en-us', 'English'), ('fr-fr', 'French'), ('de-de', 'German'))",
+                default="en-us",
+                help_text="The language in which the user wants to see the interface.",
+                max_length=10,
+                verbose_name="language",
+            ),
+        ),
+    ]

src/backend/core/migrations/0017_add_fields_for_soft_delete.py

@@ -0,0 +1,52 @@
+# Generated by Django 5.1.4 on 2025-01-12 14:27
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("core", "0016_add_document_excerpt"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="document",
+            options={
+                "ordering": ("path",),
+                "verbose_name": "Document",
+                "verbose_name_plural": "Documents",
+            },
+        ),
+        migrations.AddField(
+            model_name="document",
+            name="ancestors_deleted_at",
+            field=models.DateTimeField(blank=True, null=True),
+        ),
+        migrations.AddField(
+            model_name="document",
+            name="deleted_at",
+            field=models.DateTimeField(blank=True, null=True),
+        ),
+        migrations.AlterField(
+            model_name="user",
+            name="language",
+            field=models.CharField(
+                choices="(('en-us', 'English'), ('fr-fr', 'French'), ('de-de', 'German'))",
+                default="en-us",
+                help_text="The language in which the user wants to see the interface.",
+                max_length=10,
+                verbose_name="language",
+            ),
+        ),
+        migrations.AddConstraint(
+            model_name="document",
+            constraint=models.CheckConstraint(
+                condition=models.Q(
+                    ("deleted_at__isnull", True),
+                    ("deleted_at", models.F("ancestors_deleted_at")),
+                    _connector="OR",
+                ),
+                name="check_deleted_at_matches_ancestors_deleted_at_when_set",
+            ),
+        ),
+    ]

src/backend/core/migrations/0018_update_blank_title.py

@@ -0,0 +1,24 @@
+from django.db import migrations
+
+
+def update_titles_to_null(apps, schema_editor):
+    """
+    If the titles are "Untitled document" or "Unbenanntes Dokument" or "Document sans titre"
+    we set them to Null
+    """
+    Document = apps.get_model("core", "Document")
+    Document.objects.filter(
+        title__in=["Untitled document", "Unbenanntes Dokument", "Document sans titre"]
+    ).update(title=None)
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("core", "0017_add_fields_for_soft_delete"),
+    ]
+
+    operations = [
+        migrations.RunPython(
+            update_titles_to_null, reverse_code=migrations.RunPython.noop
+        ),
+    ]

src/backend/core/migrations/0019_alter_user_language_default_to_null.py

@@ -0,0 +1,36 @@
+# Generated by Django 5.1.5 on 2025-03-04 12:23
+from django.db import migrations, models
+
+import core.models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("core", "0018_update_blank_title"),
+    ]
+
+    operations = [
+        migrations.AlterModelManagers(
+            name="user",
+            managers=[
+                ("objects", core.models.UserManager()),
+            ],
+        ),
+        migrations.AlterField(
+            model_name="user",
+            name="language",
+            field=models.CharField(
+                blank=True,
+                choices=[
+                    ("en-us", "English"),
+                    ("fr-fr", "Français"),
+                    ("de-de", "Deutsch"),
+                ],
+                default=None,
+                help_text="The language in which the user wants to see the interface.",
+                max_length=10,
+                null=True,
+                verbose_name="language",
+            ),
+        ),
+    ]

src/backend/core/migrations/0020_remove_is_public_add_field_attachments_and_duplicated_from.py

@@ -0,0 +1,77 @@
+# Generated by Django 5.1.4 on 2025-01-18 11:53
+import re
+
+import django.contrib.postgres.fields
+import django.db.models.deletion
+from django.core.files.storage import default_storage
+from django.db import migrations, models
+
+from botocore.exceptions import ClientError
+
+import core.models
+from core.utils import extract_attachments
+
+
+def populate_attachments_on_all_documents(apps, schema_editor):
+    """Populate "attachments" field on all existing documents in the database."""
+    Document = apps.get_model("core", "Document")
+
+    for document in Document.objects.all():
+        try:
+            response = default_storage.connection.meta.client.get_object(
+                Bucket=default_storage.bucket_name, Key=f"{document.pk!s}/file"
+            )
+        except (FileNotFoundError, ClientError):
+            pass
+        else:
+            content = response["Body"].read().decode("utf-8")
+            document.attachments = extract_attachments(content)
+            document.save(update_fields=["attachments"])
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("core", "0019_alter_user_language_default_to_null"),
+    ]
+
+    operations = [
+        # v2.0.0 was released so we can now remove BC field "is_public"
+        migrations.RemoveField(
+            model_name="document",
+            name="is_public",
+        ),
+        migrations.AlterModelManagers(
+            name="user",
+            managers=[
+                ("objects", core.models.UserManager()),
+            ],
+        ),
+        migrations.AddField(
+            model_name="document",
+            name="attachments",
+            field=django.contrib.postgres.fields.ArrayField(
+                base_field=models.CharField(max_length=255),
+                blank=True,
+                default=list,
+                editable=False,
+                null=True,
+                size=None,
+            ),
+        ),
+        migrations.AddField(
+            model_name="document",
+            name="duplicated_from",
+            field=models.ForeignKey(
+                blank=True,
+                editable=False,
+                null=True,
+                on_delete=django.db.models.deletion.SET_NULL,
+                related_name="duplicates",
+                to="core.document",
+            ),
+        ),
+        migrations.RunPython(
+            populate_attachments_on_all_documents,
+            reverse_code=migrations.RunPython.noop,
+        ),
+    ]

src/backend/core/migrations/0021_activate_unaccent_extension.py

@@ -0,0 +1,10 @@
+from django.contrib.postgres.operations import UnaccentExtension
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("core", "0020_remove_is_public_add_field_attachments_and_duplicated_from"),
+    ]
+
+    operations = [UnaccentExtension()]

src/backend/core/models.py

@@ -5,56 +5,49 @@ Declare and configure the models for the impress core application
 
 import hashlib
 import smtplib
-import tempfile
-import textwrap
 import uuid
+from collections import defaultdict
 from datetime import timedelta
-from io import BytesIO
 from logging import getLogger
 
 from django.conf import settings
 from django.contrib.auth import models as auth_models
 from django.contrib.auth.base_user import AbstractBaseUser
+from django.contrib.postgres.fields import ArrayField
 from django.contrib.sites.models import Site
-from django.core import exceptions, mail, validators
+from django.core import mail, validators
+from django.core.cache import cache
 from django.core.files.base import ContentFile
 from django.core.files.storage import default_storage
 from django.core.mail import send_mail
-from django.db import models
-from django.http import FileResponse
-from django.template.base import Template as DjangoTemplate
-from django.template.context import Context
+from django.db import models, transaction
+from django.db.models.functions import Left, Length
 from django.template.loader import render_to_string
-from django.utils import html, timezone
-from django.utils.functional import cached_property, lazy
+from django.utils import timezone
+from django.utils.functional import cached_property
 from django.utils.translation import get_language, override
 from django.utils.translation import gettext_lazy as _
 
-import frontmatter
-import markdown
-import pypandoc
-import weasyprint
 from botocore.exceptions import ClientError
+from rest_framework.exceptions import ValidationError
 from timezone_field import TimeZoneField
+from treebeard.mp_tree import MP_Node, MP_NodeManager, MP_NodeQuerySet
 
 logger = getLogger(__name__)
 
 
-def get_resource_roles(resource, user):
-    """Compute the roles a user has on a resource."""
-    if not user.is_authenticated:
-        return []
+def get_trashbin_cutoff():
+    """
+    Calculate the cutoff datetime for soft-deleted items based on the retention policy.
 
-    try:
-        roles = resource.user_roles or []
-    except AttributeError:
-        try:
-            roles = resource.accesses.filter(
-                models.Q(user=user) | models.Q(team__in=user.teams),
-            ).values_list("role", flat=True)
-        except (models.ObjectDoesNotExist, IndexError):
-            roles = []
-    return roles
+    The function returns the current datetime minus the number of days specified in
+    the TRASHBIN_CUTOFF_DAYS setting, indicating the oldest date for items that can
+    remain in the trash bin.
+
+    Returns:
+        datetime: The cutoff datetime for soft-deleted items.
+    """
+    return timezone.now() - timedelta(days=settings.TRASHBIN_CUTOFF_DAYS)
 
 
 class LinkRoleChoices(models.TextChoices):
@@ -89,6 +82,55 @@ class LinkReachChoices(models.TextChoices):
     )  # Any authenticated user can access the document
     PUBLIC = "public", _("Public")  # Even anonymous users can access the document
 
+    @classmethod
+    def get_select_options(cls, ancestors_links):
+        """
+        Determines the valid select options for link reach and link role depending on the
+        list of ancestors' link reach/role.
+
+        Args:
+            ancestors_links: List of dictionaries, each with 'link_reach' and 'link_role' keys
+                             representing the reach and role of ancestors links.
+
+        Returns:
+            Dictionary mapping possible reach levels to their corresponding possible roles.
+        """
+        # If no ancestors, return all options
+        if not ancestors_links:
+            return dict.fromkeys(cls.values, LinkRoleChoices.values)
+
+        # Initialize result with all possible reaches and role options as sets
+        result = {reach: set(LinkRoleChoices.values) for reach in cls.values}
+
+        # Group roles by reach level
+        reach_roles = defaultdict(set)
+        for link in ancestors_links:
+            reach_roles[link["link_reach"]].add(link["link_role"])
+
+        # Apply constraints based on ancestor links
+        if LinkRoleChoices.EDITOR in reach_roles[cls.RESTRICTED]:
+            result[cls.RESTRICTED].discard(LinkRoleChoices.READER)
+
+        if LinkRoleChoices.EDITOR in reach_roles[cls.AUTHENTICATED]:
+            result[cls.AUTHENTICATED].discard(LinkRoleChoices.READER)
+            result.pop(cls.RESTRICTED, None)
+        elif LinkRoleChoices.READER in reach_roles[cls.AUTHENTICATED]:
+            result[cls.RESTRICTED].discard(LinkRoleChoices.READER)
+
+        if LinkRoleChoices.EDITOR in reach_roles[cls.PUBLIC]:
+            result[cls.PUBLIC].discard(LinkRoleChoices.READER)
+            result.pop(cls.AUTHENTICATED, None)
+            result.pop(cls.RESTRICTED, None)
+        elif LinkRoleChoices.READER in reach_roles[cls.PUBLIC]:
+            result[cls.AUTHENTICATED].discard(LinkRoleChoices.READER)
+            result.get(cls.RESTRICTED, set()).discard(LinkRoleChoices.READER)
+
+        # Convert roles sets to lists while maintaining the order from LinkRoleChoices
+        for reach, roles in result.items():
+            result[reach] = [role for role in LinkRoleChoices.values if role in roles]
+
+        return result
+
 
 class DuplicateEmailError(Exception):
     """Raised when an email is already associated with a pre-existing user."""
@@ -202,10 +244,12 @@ class User(AbstractBaseUser, BaseModel, auth_models.PermissionsMixin):
 
     language = models.CharField(
         max_length=10,
-        choices=lazy(lambda: settings.LANGUAGES, tuple)(),
-        default=settings.LANGUAGE_CODE,
+        choices=settings.LANGUAGES,
+        default=None,
         verbose_name=_("language"),
         help_text=_("The language in which the user wants to see the interface."),
+        null=True,
+        blank=True,
     )
     timezone = TimeZoneField(
         choices_display="WITH_GMT_OFFSET",
@@ -320,10 +364,9 @@ class BaseAccess(BaseModel):
     class Meta:
         abstract = True
 
-    def _get_abilities(self, resource, user):
+    def _get_roles(self, resource, user):
         """
-        Compute and return abilities for a given user taking into account
-        the current state of the object.
+        Get the roles a user has on a resource.
         """
         roles = []
         if user.is_authenticated:
@@ -338,6 +381,15 @@ class BaseAccess(BaseModel):
                 except (self._meta.model.DoesNotExist, IndexError):
                     roles = []
 
+        return roles
+
+    def _get_abilities(self, resource, user):
+        """
+        Compute and return abilities for a given user taking into account
+        the current state of the object.
+        """
+        roles = self._get_roles(resource, user)
+
         is_owner_or_admin = bool(
             set(roles).intersection({RoleChoices.OWNER, RoleChoices.ADMIN})
         )
@@ -376,10 +428,47 @@ class BaseAccess(BaseModel):
         }
 
 
-class Document(BaseModel):
+class DocumentQuerySet(MP_NodeQuerySet):
+    """
+    Custom queryset for the Document model, providing additional methods
+    to filter documents based on user permissions.
+    """
+
+    def readable_per_se(self, user):
+        """
+        Filters the queryset to return documents on which the given user has
+        direct access, team access or link access. This will not return all the
+        documents that a user can read because it can be obtained via an ancestor.
+        :param user: The user for whom readable documents are to be fetched.
+        :return: A queryset of documents for which the user has direct access,
+            team access or link access.
+        """
+        if user.is_authenticated:
+            return self.filter(
+                models.Q(accesses__user=user)
+                | models.Q(accesses__team__in=user.teams)
+                | ~models.Q(link_reach=LinkReachChoices.RESTRICTED)
+            )
+
+        return self.filter(link_reach=LinkReachChoices.PUBLIC)
+
+
+class DocumentManager(MP_NodeManager.from_queryset(DocumentQuerySet)):
+    """
+    Custom manager for the Document model, enabling the use of the custom
+    queryset methods directly from the model manager.
+    """
+
+    def get_queryset(self):
+        """Sets the custom queryset as the default."""
+        return self._queryset_class(self.model).order_by("path")
+
+
+class Document(MP_Node, BaseModel):
     """Pad document carrying the content."""
 
     title = models.CharField(_("title"), max_length=255, null=True, blank=True)
+    excerpt = models.TextField(_("excerpt"), max_length=300, null=True, blank=True)
     link_reach = models.CharField(
         max_length=20,
         choices=LinkReachChoices.choices,
@@ -395,14 +484,49 @@ class Document(BaseModel):
         blank=True,
         null=True,
     )
+    deleted_at = models.DateTimeField(null=True, blank=True)
+    ancestors_deleted_at = models.DateTimeField(null=True, blank=True)
+    duplicated_from = models.ForeignKey(
+        "self",
+        on_delete=models.SET_NULL,
+        related_name="duplicates",
+        editable=False,
+        blank=True,
+        null=True,
+    )
+    attachments = ArrayField(
+        models.CharField(max_length=255),
+        default=list,
+        editable=False,
+        blank=True,
+        null=True,
+    )
 
     _content = None
 
+    # Tree structure
+    alphabet = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"
+    steplen = 7  # nb siblings max: 3,521,614,606,208
+    node_order_by = []  # Manual ordering
+
+    path = models.CharField(max_length=7 * 36, unique=True, db_collation="C")
+
+    objects = DocumentManager()
+
     class Meta:
         db_table = "impress_document"
-        ordering = ("title",)
+        ordering = ("path",)
         verbose_name = _("Document")
         verbose_name_plural = _("Documents")
+        constraints = [
+            models.CheckConstraint(
+                check=(
+                    models.Q(deleted_at__isnull=True)
+                    | models.Q(deleted_at=models.F("ancestors_deleted_at"))
+                ),
+                name="check_deleted_at_matches_ancestors_deleted_at_when_set",
+            ),
+        ]
 
     def __str__(self):
         return str(self.title) if self.title else str(_("Untitled Document"))
@@ -473,9 +597,13 @@ class Document(BaseModel):
 
     def get_content_response(self, version_id=""):
         """Get the content in a specific version of the document"""
-        return default_storage.connection.meta.client.get_object(
-            Bucket=default_storage.bucket_name, Key=self.file_key, VersionId=version_id
-        )
+        params = {
+            "Bucket": default_storage.bucket_name,
+            "Key": self.file_key,
+        }
+        if version_id:
+            params["VersionId"] = version_id
+        return default_storage.connection.meta.client.get_object(**params)
 
     def get_versions_slice(self, from_version_id="", min_datetime=None, page_size=None):
         """Get document versions from object storage with pagination and starting conditions"""
@@ -541,48 +669,194 @@ class Document(BaseModel):
             Bucket=default_storage.bucket_name, Key=self.file_key, VersionId=version_id
         )
 
-    def get_abilities(self, user):
+    def get_nb_accesses_cache_key(self):
+        """Generate a unique cache key for each document."""
+        return f"document_{self.id!s}_nb_accesses"
+
+    def get_nb_accesses(self):
+        """
+        Calculate the number of accesses:
+        - directly attached to the document
+        - attached to any of the document's ancestors
+        """
+        cache_key = self.get_nb_accesses_cache_key()
+        nb_accesses = cache.get(cache_key)
+
+        if nb_accesses is None:
+            nb_accesses = (
+                DocumentAccess.objects.filter(document=self).count(),
+                DocumentAccess.objects.filter(
+                    document__path=Left(
+                        models.Value(self.path), Length("document__path")
+                    ),
+                    document__ancestors_deleted_at__isnull=True,
+                ).count(),
+            )
+            cache.set(cache_key, nb_accesses)
+
+        return nb_accesses
+
+    @property
+    def nb_accesses_direct(self):
+        """Returns the number of accesses related to the document or one of its ancestors."""
+        return self.get_nb_accesses()[0]
+
+    @property
+    def nb_accesses_ancestors(self):
+        """Returns the number of accesses related to the document or one of its ancestors."""
+        return self.get_nb_accesses()[1]
+
+    def invalidate_nb_accesses_cache(self):
+        """
+        Invalidate the cache for number of accesses, including on affected descendants.
+        Args:
+            path: can optionally be passed as argument (useful when invalidating cache for a
+                document we just deleted)
+        """
+
+        for document in Document.objects.filter(path__startswith=self.path).only("id"):
+            cache_key = document.get_nb_accesses_cache_key()
+            cache.delete(cache_key)
+
+    def get_roles(self, user):
+        """Return the roles a user has on a document."""
+        if not user.is_authenticated:
+            return []
+
+        try:
+            roles = self.user_roles or []
+        except AttributeError:
+            try:
+                roles = DocumentAccess.objects.filter(
+                    models.Q(user=user) | models.Q(team__in=user.teams),
+                    document__path=Left(
+                        models.Value(self.path), Length("document__path")
+                    ),
+                ).values_list("role", flat=True)
+            except (models.ObjectDoesNotExist, IndexError):
+                roles = []
+        return roles
+
+    def get_links_definitions(self, ancestors_links):
+        """Get links reach/role definitions for the current document and its ancestors."""
+
+        links_definitions = defaultdict(set)
+        links_definitions[self.link_reach].add(self.link_role)
+
+        # Merge ancestor link definitions
+        for ancestor in ancestors_links:
+            links_definitions[ancestor["link_reach"]].add(ancestor["link_role"])
+
+        return dict(links_definitions)  # Convert defaultdict back to a normal dict
+
+    def compute_ancestors_links(self, user):
+        """
+        Compute the ancestors links for the current document up to the highest readable ancestor.
+        """
+        ancestors = (
+            (self.get_ancestors() | self._meta.model.objects.filter(pk=self.pk))
+            .filter(ancestors_deleted_at__isnull=True)
+            .order_by("path")
+        )
+        highest_readable = ancestors.readable_per_se(user).only("depth").first()
+
+        if highest_readable is None:
+            return []
+
+        ancestors_links = []
+        paths_links_mapping = {}
+        for ancestor in ancestors.filter(depth__gte=highest_readable.depth):
+            ancestors_links.append(
+                {"link_reach": ancestor.link_reach, "link_role": ancestor.link_role}
+            )
+            paths_links_mapping[ancestor.path] = ancestors_links.copy()
+
+        ancestors_links = paths_links_mapping.get(self.path[: -self.steplen], [])
+
+        return ancestors_links
+
+    def get_abilities(self, user, ancestors_links=None):
         """
         Compute and return abilities for a given user on the document.
         """
-        roles = set(get_resource_roles(self, user))
+        if self.depth <= 1 or getattr(self, "is_highest_ancestor_for_user", False):
+            ancestors_links = []
+        elif ancestors_links is None:
+            ancestors_links = self.compute_ancestors_links(user=user)
 
-        # Compute version roles before adding link roles because we don't
+        roles = set(
+            self.get_roles(user)
+        )  # at this point only roles based on specific access
+
+        # Characteristics that are based only on specific access
+        is_owner = RoleChoices.OWNER in roles
+        is_deleted = self.ancestors_deleted_at and not is_owner
+        is_owner_or_admin = (is_owner or RoleChoices.ADMIN in roles) and not is_deleted
+
+        # Compute access roles before adding link roles because we don't
         # want anonymous users to access versions (we wouldn't know from
         # which date to allow them anyway)
         # Anonymous users should also not see document accesses
-        has_role = bool(roles)
+        has_access_role = bool(roles) and not is_deleted
+        can_update_from_access = (
+            is_owner_or_admin or RoleChoices.EDITOR in roles
+        ) and not is_deleted
 
-        # Add role provided by the document link
-        if self.link_reach == LinkReachChoices.PUBLIC or (
-            self.link_reach == LinkReachChoices.AUTHENTICATED and user.is_authenticated
-        ):
-            roles.add(self.link_role)
-
-        is_owner_or_admin = bool(
-            roles.intersection({RoleChoices.OWNER, RoleChoices.ADMIN})
+        # Add roles provided by the document link, taking into account its ancestors
+        links_definitions = self.get_links_definitions(ancestors_links)
+        public_roles = links_definitions.get(LinkReachChoices.PUBLIC, set())
+        authenticated_roles = (
+            links_definitions.get(LinkReachChoices.AUTHENTICATED, set())
+            if user.is_authenticated
+            else set()
+        )
+        roles = roles | public_roles | authenticated_roles
+
+        can_get = bool(roles) and not is_deleted
+        can_update = (
+            is_owner_or_admin or RoleChoices.EDITOR in roles
+        ) and not is_deleted
+
+        ai_allow_reach_from = settings.AI_ALLOW_REACH_FROM
+        ai_access = any(
+            [
+                ai_allow_reach_from == LinkReachChoices.PUBLIC and can_update,
+                ai_allow_reach_from == LinkReachChoices.AUTHENTICATED
+                and user.is_authenticated
+                and can_update,
+                ai_allow_reach_from == LinkReachChoices.RESTRICTED
+                and can_update_from_access,
+            ]
         )
-        can_get = bool(roles)
-        can_update = is_owner_or_admin or RoleChoices.EDITOR in roles
 
         return {
             "accesses_manage": is_owner_or_admin,
-            "accesses_view": has_role,
-            "ai_transform": can_update,
-            "ai_translate": can_update,
+            "accesses_view": has_access_role,
+            "ai_transform": ai_access,
+            "ai_translate": ai_access,
             "attachment_upload": can_update,
+            "media_check": can_get,
+            "children_list": can_get,
+            "children_create": can_update and user.is_authenticated,
             "collaboration_auth": can_get,
-            "destroy": RoleChoices.OWNER in roles,
+            "cors_proxy": can_get,
+            "descendants": can_get,
+            "destroy": is_owner,
+            "duplicate": can_get,
             "favorite": can_get and user.is_authenticated,
             "link_configuration": is_owner_or_admin,
-            "invite_owner": RoleChoices.OWNER in roles,
+            "invite_owner": is_owner,
+            "move": is_owner_or_admin and not self.ancestors_deleted_at,
             "partial_update": can_update,
+            "restore": is_owner,
             "retrieve": can_get,
             "media_auth": can_get,
+            "link_select_options": LinkReachChoices.get_select_options(ancestors_links),
+            "tree": can_get,
             "update": can_update,
             "versions_destroy": is_owner_or_admin,
-            "versions_list": has_role,
-            "versions_retrieve": has_role,
+            "versions_list": has_access_role,
+            "versions_retrieve": has_access_role,
         }
 
     def send_email(self, subject, emails, context=None, language=None):
@@ -596,6 +870,7 @@ class Document(BaseModel):
                 "document": self,
                 "domain": domain,
                 "link": f"{domain}/docs/{self.id}/",
+                "document_title": self.title or str(_("Untitled Document")),
                 "logo_img": settings.EMAIL_LOGO_IMG,
             }
         )
@@ -637,12 +912,90 @@ class Document(BaseModel):
                     '{name} invited you with the role "{role}" on the following document:'
                 ).format(name=sender_name_email, role=role.lower()),
             }
-            subject = _("{name} shared a document with you: {title}").format(
-                name=sender_name, title=self.title
+            subject = (
+                context["title"]
+                if not self.title
+                else _("{name} shared a document with you: {title}").format(
+                    name=sender_name, title=self.title
+                )
             )
 
         self.send_email(subject, [email], context, language)
 
+    @transaction.atomic
+    def soft_delete(self):
+        """
+        Soft delete the document, marking the deletion on descendants.
+        We still keep the .delete() method untouched for programmatic purposes.
+        """
+        if (
+            self._meta.model.objects.filter(
+                models.Q(deleted_at__isnull=False)
+                | models.Q(ancestors_deleted_at__isnull=False),
+                pk=self.pk,
+            ).exists()
+            or self.get_ancestors().filter(deleted_at__isnull=False).exists()
+        ):
+            raise RuntimeError(
+                "This document is already deleted or has deleted ancestors."
+            )
+
+        self.ancestors_deleted_at = self.deleted_at = timezone.now()
+        self.save()
+        self.invalidate_nb_accesses_cache()
+
+        if self.depth > 1:
+            self._meta.model.objects.filter(pk=self.get_parent().pk).update(
+                numchild=models.F("numchild") - 1
+            )
+
+        # Mark all descendants as soft deleted
+        self.get_descendants().filter(ancestors_deleted_at__isnull=True).update(
+            ancestors_deleted_at=self.ancestors_deleted_at
+        )
+
+    @transaction.atomic
+    def restore(self):
+        """Cancelling a soft delete with checks."""
+        # This should not happen
+        if self._meta.model.objects.filter(
+            pk=self.pk, deleted_at__isnull=True
+        ).exists():
+            raise RuntimeError("This document is not deleted.")
+
+        if self.deleted_at < get_trashbin_cutoff():
+            raise RuntimeError(
+                "This document was permanently deleted and cannot be restored."
+            )
+
+        # save the current deleted_at value to exclude it from the descendants update
+        current_deleted_at = self.deleted_at
+
+        # Restore the current document
+        self.deleted_at = None
+
+        # Calculate the minimum `deleted_at` among all ancestors
+        ancestors_deleted_at = (
+            self.get_ancestors()
+            .filter(deleted_at__isnull=False)
+            .order_by("deleted_at")
+            .values_list("deleted_at", flat=True)
+            .first()
+        )
+        self.ancestors_deleted_at = ancestors_deleted_at
+        self.save(update_fields=["deleted_at", "ancestors_deleted_at"])
+        self.invalidate_nb_accesses_cache()
+
+        self.get_descendants().exclude(
+            models.Q(deleted_at__isnull=False)
+            | models.Q(ancestors_deleted_at__lt=current_deleted_at)
+        ).update(ancestors_deleted_at=self.ancestors_deleted_at)
+
+        if self.depth > 1:
+            self._meta.model.objects.filter(pk=self.get_parent().pk).update(
+                numchild=models.F("numchild") + 1
+            )
+
 
 class LinkTrace(BaseModel):
     """
@@ -745,11 +1098,55 @@ class DocumentAccess(BaseAccess):
     def __str__(self):
         return f"{self.user!s} is {self.role:s} in document {self.document!s}"
 
+    def save(self, *args, **kwargs):
+        """Override save to clear the document's cache for number of accesses."""
+        super().save(*args, **kwargs)
+        self.document.invalidate_nb_accesses_cache()
+
+    def delete(self, *args, **kwargs):
+        """Override delete to clear the document's cache for number of accesses."""
+        super().delete(*args, **kwargs)
+        self.document.invalidate_nb_accesses_cache()
+
     def get_abilities(self, user):
         """
         Compute and return abilities for a given user on the document access.
         """
-        return self._get_abilities(self.document, user)
+        roles = self._get_roles(self.document, user)
+        is_owner_or_admin = bool(set(roles).intersection(set(PRIVILEGED_ROLES)))
+        if self.role == RoleChoices.OWNER:
+            can_delete = (
+                RoleChoices.OWNER in roles
+                and self.document.accesses.filter(role=RoleChoices.OWNER).count() > 1
+            )
+            set_role_to = (
+                [RoleChoices.ADMIN, RoleChoices.EDITOR, RoleChoices.READER]
+                if can_delete
+                else []
+            )
+        else:
+            can_delete = is_owner_or_admin
+            set_role_to = []
+            if RoleChoices.OWNER in roles:
+                set_role_to.append(RoleChoices.OWNER)
+            if is_owner_or_admin:
+                set_role_to.extend(
+                    [RoleChoices.ADMIN, RoleChoices.EDITOR, RoleChoices.READER]
+                )
+
+        # Remove the current role as we don't want to propose it as an option
+        try:
+            set_role_to.remove(self.role)
+        except ValueError:
+            pass
+
+        return {
+            "destroy": can_delete,
+            "update": bool(set_role_to) and is_owner_or_admin,
+            "partial_update": bool(set_role_to) and is_owner_or_admin,
+            "retrieve": self.user and self.user.id == user.id or is_owner_or_admin,
+            "set_role_to": set_role_to,
+        }
 
 
 class Template(BaseModel):
@@ -774,11 +1171,27 @@ class Template(BaseModel):
     def __str__(self):
         return self.title
 
+    def get_roles(self, user):
+        """Return the roles a user has on a resource as an iterable."""
+        if not user.is_authenticated:
+            return []
+
+        try:
+            roles = self.user_roles or []
+        except AttributeError:
+            try:
+                roles = self.accesses.filter(
+                    models.Q(user=user) | models.Q(team__in=user.teams),
+                ).values_list("role", flat=True)
+            except (models.ObjectDoesNotExist, IndexError):
+                roles = []
+        return roles
+
     def get_abilities(self, user):
         """
         Compute and return abilities for a given user on the template.
         """
-        roles = get_resource_roles(self, user)
+        roles = self.get_roles(user)
         is_owner_or_admin = bool(
             set(roles).intersection({RoleChoices.OWNER, RoleChoices.ADMIN})
         )
@@ -794,107 +1207,6 @@ class Template(BaseModel):
             "retrieve": can_get,
         }
 
-    def generate_pdf(self, body_html, metadata):
-        """
-        Generate and return a pdf document wrapped around the current template
-        """
-        document_html = weasyprint.HTML(
-            string=DjangoTemplate(self.code).render(
-                Context({"body": html.format_html(body_html), **metadata})
-            )
-        )
-        css = weasyprint.CSS(
-            string=self.css,
-            font_config=weasyprint.text.fonts.FontConfiguration(),
-        )
-
-        pdf_content = document_html.write_pdf(stylesheets=[css], zoom=1)
-        response = FileResponse(BytesIO(pdf_content), content_type="application/pdf")
-        response["Content-Disposition"] = f"attachment; filename={self.title}.pdf"
-
-        return response
-
-    def generate_word(self, body_html, metadata):
-        """
-        Generate and return a docx document wrapped around the current template
-        """
-        template_string = DjangoTemplate(self.code).render(
-            Context({"body": html.format_html(body_html), **metadata})
-        )
-
-        html_string = f"""
-        <!DOCTYPE html>
-        <html>
-        <head>
-            <style>
-                {self.css}
-            </style>
-        </head>
-        <body>
-            {template_string}
-        </body>
-        </html>
-        """
-
-        reference_docx = "core/static/reference.docx"
-        output = BytesIO()
-
-        # Convert the HTML to a temporary docx file
-        with tempfile.NamedTemporaryFile(suffix=".docx", prefix="docx_") as tmp_file:
-            output_path = tmp_file.name
-
-            pypandoc.convert_text(
-                html_string,
-                "docx",
-                format="html",
-                outputfile=output_path,
-                extra_args=["--reference-doc", reference_docx],
-            )
-
-            # Create a BytesIO object to store the output of the temporary docx file
-            with open(output_path, "rb") as f:
-                output = BytesIO(f.read())
-
-        # Ensure the pointer is at the beginning
-        output.seek(0)
-
-        response = FileResponse(
-            output,
-            content_type="application/vnd.openxmlformats-officedocument.wordprocessingml.document",
-        )
-        response["Content-Disposition"] = f"attachment; filename={self.title}.docx"
-
-        return response
-
-    def generate_document(self, body, body_type, export_format):
-        """
-        Generate and return a document for this template around the
-        body passed as argument.
-
-        2 types of body are accepted:
-        - HTML: body_type = "html"
-        - Markdown: body_type = "markdown"
-
-        2 types of documents can be generated:
-        - PDF: export_format = "pdf"
-        - Docx: export_format = "docx"
-        """
-        document = frontmatter.loads(body)
-        metadata = document.metadata
-        strip_body = document.content.strip()
-
-        if body_type == "html":
-            body_html = strip_body
-        else:
-            body_html = (
-                markdown.markdown(textwrap.dedent(strip_body)) if strip_body else ""
-            )
-
-        if export_format == "pdf":
-            return self.generate_pdf(body_html, metadata)
-
-        return self.generate_word(body_html, metadata)
-
 
 class TemplateAccess(BaseAccess):
     """Relation model to give access to a template for a user or a team with a role."""
@@ -983,8 +1295,8 @@ class Invitation(BaseModel):
             User.objects.filter(email=self.email).exists()
             and not settings.OIDC_ALLOW_DUPLICATE_EMAILS
         ):
-            raise exceptions.ValidationError(
-                {"email": _("This email is already associated to a registered user.")}
+            raise ValidationError(
+                {"email": [_("This email is already associated to a registered user.")]}
             )
 
     @property

src/backend/core/services/ai_services.py

@@ -1,8 +1,5 @@
 """AI services."""
 
-import json
-import re
-
 from django.conf import settings
 from django.core.exceptions import ImproperlyConfigured
 
@@ -12,32 +9,44 @@ from core import enums
 
 AI_ACTIONS = {
     "prompt": (
-        "Answer the prompt in markdown format. Return JSON: "
-        '{"answer": "Your markdown answer"}. '
-        "Do not provide any other information."
+        "Answer the prompt in markdown format. "
+        "Preserve the language and markdown formatting. "
+        "Do not provide any other information. "
+        "Preserve the language."
     ),
     "correct": (
         "Correct grammar and spelling of the markdown text, "
         "preserving language and markdown formatting. "
-        'Return JSON: {"answer": "your corrected markdown text"}. '
-        "Do not provide any other information."
+        "Do not provide any other information. "
+        "Preserve the language."
     ),
     "rephrase": (
         "Rephrase the given markdown text, "
         "preserving language and markdown formatting. "
-        'Return JSON: {"answer": "your rephrased markdown text"}. '
-        "Do not provide any other information."
+        "Do not provide any other information. "
+        "Preserve the language."
     ),
     "summarize": (
         "Summarize the markdown text, preserving language and markdown formatting. "
-        'Return JSON: {"answer": "your markdown summary"}. '
-        "Do not provide any other information."
+        "Do not provide any other information. "
+        "Preserve the language."
+    ),
+    "beautify": (
+        "Add formatting to the text to make it more readable. "
+        "Do not provide any other information. "
+        "Preserve the language."
+    ),
+    "emojify": (
+        "Add emojis to the important parts of the text. "
+        "Do not provide any other information. "
+        "Preserve the language."
     ),
 }
 
 AI_TRANSLATE = (
-    "Translate the markdown text to {language:s}, preserving markdown formatting. "
-    'Return JSON: {{"answer": "your translated markdown text in {language:s}"}}. '
+    "Keep the same html structure and formatting. "
+    "Translate the content in the html to the specified language {language:s}. "
+    "Check the translation for accuracy and make any necessary corrections. "
     "Do not provide any other information."
 )
 
@@ -59,32 +68,18 @@ class AIService:
         """Helper method to call the OpenAI API and process the response."""
         response = self.client.chat.completions.create(
             model=settings.AI_MODEL,
-            response_format={"type": "json_object"},
             messages=[
                 {"role": "system", "content": system_content},
-                {"role": "user", "content": json.dumps({"markdown_input": text})},
+                {"role": "user", "content": text},
             ],
         )
 
         content = response.choices[0].message.content
 
-        try:
-            sanitized_content = re.sub(r'\s*"answer"\s*:\s*', '"answer": ', content)
-            sanitized_content = re.sub(r"\s*\}", "}", sanitized_content)
-            sanitized_content = re.sub(r"(?<!\\)\n", "\\\\n", sanitized_content)
-            sanitized_content = re.sub(r"(?<!\\)\t", "\\\\t", sanitized_content)
-
-            json_response = json.loads(sanitized_content)
-        except (json.JSONDecodeError, IndexError):
-            try:
-                json_response = json.loads(content)
-            except json.JSONDecodeError as err:
-                raise RuntimeError("AI response is not valid JSON", content) from err
-
-        if "answer" not in json_response:
+        if not content:
             raise RuntimeError("AI response does not contain an answer")
 
-        return json_response
+        return {"answer": content}
 
     def transform(self, text, action):
         """Transform text based on specified action."""

src/backend/core/services/collaboration_services.py

@@ -17,7 +17,7 @@ class CollaborationService:
     def reset_connections(self, room, user_id=None):
         """
         Reset connections of a room in the collaboration server.
-        Reseting a connection means that the user will be disconnected and will
+        Resetting a connection means that the user will be disconnected and will
         have to reconnect to the collaboration server, with updated rights.
         """
         endpoint = "reset-connections"

src/backend/core/tests/authentication/test_backends.py

@@ -2,14 +2,14 @@
 
 import random
 import re
-from logging import Logger
-from unittest import mock
 
 from django.core.exceptions import SuspiciousOperation
 from django.test.utils import override_settings
 
 import pytest
 import responses
+from cryptography.fernet import Fernet
+from lasuite.oidc_login.backends import get_oidc_refresh_token
 
 from core import models
 from core.authentication.backends import OIDCAuthenticationBackend
@@ -57,7 +57,7 @@ def test_authentication_getter_existing_user_via_email(
 
     monkeypatch.setattr(OIDCAuthenticationBackend, "get_userinfo", get_userinfo_mocked)
 
-    with django_assert_num_queries(2):
+    with django_assert_num_queries(3):  # user by sub, user by mail, update sub
         user = klass.get_or_create_user(
             access_token="test-token", id_token=None, payload=None
         )
@@ -288,7 +288,7 @@ def test_authentication_getter_new_user_no_email(monkeypatch):
     assert user.email is None
     assert user.full_name is None
     assert user.short_name is None
-    assert user.password == "!"
+    assert user.has_usable_password() is False
     assert models.User.objects.count() == 1
 
 
@@ -315,7 +315,7 @@ def test_authentication_getter_new_user_with_email(monkeypatch):
     assert user.email == email
     assert user.full_name == "John Doe"
     assert user.short_name == "John"
-    assert user.password == "!"
+    assert user.has_usable_password() is False
     assert models.User.objects.count() == 1
 
 
@@ -345,11 +345,15 @@ def test_authentication_get_userinfo_json_response():
 
 @override_settings(OIDC_OP_USER_ENDPOINT="http://oidc.endpoint.test/userinfo")
 @responses.activate
-def test_authentication_get_userinfo_token_response(monkeypatch):
+def test_authentication_get_userinfo_token_response(monkeypatch, settings):
     """Test get_userinfo method with a token response."""
-
+    settings.OIDC_RP_SIGN_ALGO = "HS256"  # disable JWKS URL call
     responses.add(
-        responses.GET, re.compile(r".*/userinfo"), body="fake.jwt.token", status=200
+        responses.GET,
+        re.compile(r".*/userinfo"),
+        body="fake.jwt.token",
+        status=200,
+        content_type="application/jwt",
     )
 
     def mock_verify_token(self, token):  # pylint: disable=unused-argument
@@ -371,21 +375,25 @@ def test_authentication_get_userinfo_token_response(monkeypatch):
 
 @override_settings(OIDC_OP_USER_ENDPOINT="http://oidc.endpoint.test/userinfo")
 @responses.activate
-def test_authentication_get_userinfo_invalid_response():
+def test_authentication_get_userinfo_invalid_response(settings):
     """
     Test get_userinfo method with an invalid JWT response that
     causes verify_token to raise an error.
     """
-
+    settings.OIDC_RP_SIGN_ALGO = "HS256"  # disable JWKS URL call
     responses.add(
-        responses.GET, re.compile(r".*/userinfo"), body="fake.jwt.token", status=200
+        responses.GET,
+        re.compile(r".*/userinfo"),
+        body="fake.jwt.token",
+        status=200,
+        content_type="application/jwt",
     )
 
     oidc_backend = OIDCAuthenticationBackend()
 
     with pytest.raises(
         SuspiciousOperation,
-        match="Invalid response format or token verification failed",
+        match="User info response was not valid JWT",
     ):
         oidc_backend.get_userinfo("fake_access_token", None, None)
 
@@ -450,100 +458,54 @@ def test_authentication_getter_existing_disabled_user_via_email(
     assert models.User.objects.count() == 1
 
 
-# Essential claims
-
-
-def test_authentication_verify_claims_default(django_assert_num_queries, monkeypatch):
-    """The sub claim should be mandatory by default."""
-    klass = OIDCAuthenticationBackend()
-
-    def get_userinfo_mocked(*args):
-        return {
-            "test": "123",
-        }
-
-    monkeypatch.setattr(OIDCAuthenticationBackend, "get_userinfo", get_userinfo_mocked)
-
-    with (
-        django_assert_num_queries(0),
-        pytest.raises(
-            KeyError,
-            match="sub",
-        ),
-    ):
-        klass.get_or_create_user(access_token="test-token", id_token=None, payload=None)
-
-    assert models.User.objects.exists() is False
-
-
-@pytest.mark.parametrize(
-    "essential_claims, missing_claims",
-    [
-        (["email", "sub"], ["email"]),
-        (["Email", "sub"], ["Email"]),  # Case sensitivity
-    ],
-)
-@override_settings(OIDC_OP_USER_ENDPOINT="http://oidc.endpoint.test/userinfo")
-@mock.patch.object(Logger, "error")
-def test_authentication_verify_claims_essential_missing(
-    mock_logger,
-    essential_claims,
-    missing_claims,
-    django_assert_num_queries,
-    monkeypatch,
+@responses.activate
+def test_authentication_session_tokens(
+    django_assert_num_queries, monkeypatch, rf, settings
 ):
-    """Ensure SuspiciousOperation is raised if essential claims are missing."""
+    """
+    Test that the session contains oidc_refresh_token and oidc_access_token after authentication.
+    """
+    settings.OIDC_OP_TOKEN_ENDPOINT = "http://oidc.endpoint.test/token"
+    settings.OIDC_OP_USER_ENDPOINT = "http://oidc.endpoint.test/userinfo"
+    settings.OIDC_OP_JWKS_ENDPOINT = "http://oidc.endpoint.test/jwks"
+    settings.OIDC_STORE_ACCESS_TOKEN = True
+    settings.OIDC_STORE_REFRESH_TOKEN = True
+    settings.OIDC_STORE_REFRESH_TOKEN_KEY = Fernet.generate_key()
 
     klass = OIDCAuthenticationBackend()
+    request = rf.get("/some-url", {"state": "test-state", "code": "test-code"})
+    request.session = {}
 
-    def get_userinfo_mocked(*args):
-        return {
-            "sub": "123",
-            "last_name": "Doe",
-        }
+    def verify_token_mocked(*args, **kwargs):
+        return {"sub": "123", "email": "test@example.com"}
 
-    monkeypatch.setattr(OIDCAuthenticationBackend, "get_userinfo", get_userinfo_mocked)
+    monkeypatch.setattr(OIDCAuthenticationBackend, "verify_token", verify_token_mocked)
 
-    with (
-        django_assert_num_queries(0),
-        pytest.raises(
-            SuspiciousOperation,
-            match="Claims verification failed",
-        ),
-        override_settings(USER_OIDC_ESSENTIAL_CLAIMS=essential_claims),
-    ):
-        klass.get_or_create_user(access_token="test-token", id_token=None, payload=None)
+    responses.add(
+        responses.POST,
+        re.compile(settings.OIDC_OP_TOKEN_ENDPOINT),
+        json={
+            "access_token": "test-access-token",
+            "refresh_token": "test-refresh-token",
+        },
+        status=200,
+    )
 
-    assert models.User.objects.exists() is False
-    mock_logger.assert_called_once_with("Missing essential claims: %s", missing_claims)
-
-
-@override_settings(
-    OIDC_OP_USER_ENDPOINT="http://oidc.endpoint.test/userinfo",
-    USER_OIDC_ESSENTIAL_CLAIMS=["email", "last_name"],
-)
-def test_authentication_verify_claims_success(django_assert_num_queries, monkeypatch):
-    """Ensure user is authenticated when all essential claims are present."""
-
-    klass = OIDCAuthenticationBackend()
-
-    def get_userinfo_mocked(*args):
-        return {
-            "email": "john.doe@example.com",
-            "last_name": "Doe",
-            "sub": "123",
-        }
-
-    monkeypatch.setattr(OIDCAuthenticationBackend, "get_userinfo", get_userinfo_mocked)
+    responses.add(
+        responses.GET,
+        re.compile(settings.OIDC_OP_USER_ENDPOINT),
+        json={"sub": "123", "email": "test@example.com"},
+        status=200,
+    )
 
     with django_assert_num_queries(6):
-        user = klass.get_or_create_user(
-            access_token="test-token", id_token=None, payload=None
+        user = klass.authenticate(
+            request,
+            code="test-code",
+            nonce="test-nonce",
+            code_verifier="test-code-verifier",
         )
 
-    assert models.User.objects.filter(id=user.id).exists()
-
-    assert user.sub == "123"
-    assert user.full_name == "Doe"
-    assert user.short_name is None
-    assert user.email == "john.doe@example.com"
+    assert user is not None
+    assert request.session["oidc_access_token"] == "test-access-token"
+    assert get_oidc_refresh_token(request.session) == "test-refresh-token"

src/backend/core/tests/authentication/test_urls.py

@@ -1,10 +0,0 @@
-"""Unit tests for the Authentication URLs."""
-
-from core.authentication.urls import urlpatterns
-
-
-def test_urls_override_default_mozilla_django_oidc():
-    """Custom URL patterns should override default ones from Mozilla Django OIDC."""
-
-    url_names = [u.name for u in urlpatterns]
-    assert url_names.index("oidc_logout_custom") < url_names.index("oidc_logout")

src/backend/core/tests/authentication/test_views.py

@@ -1,231 +0,0 @@
-"""Unit tests for the Authentication Views."""
-
-from unittest import mock
-from urllib.parse import parse_qs, urlparse
-
-from django.contrib.auth.models import AnonymousUser
-from django.contrib.sessions.middleware import SessionMiddleware
-from django.core.exceptions import SuspiciousOperation
-from django.test import RequestFactory
-from django.test.utils import override_settings
-from django.urls import reverse
-from django.utils import crypto
-
-import pytest
-from rest_framework.test import APIClient
-
-from core import factories
-from core.authentication.views import OIDCLogoutCallbackView, OIDCLogoutView
-
-pytestmark = pytest.mark.django_db
-
-
-@override_settings(LOGOUT_REDIRECT_URL="/example-logout")
-def test_view_logout_anonymous():
-    """Anonymous users calling the logout url,
-    should be redirected to the specified LOGOUT_REDIRECT_URL."""
-
-    url = reverse("oidc_logout_custom")
-    response = APIClient().get(url)
-
-    assert response.status_code == 302
-    assert response.url == "/example-logout"
-
-
-@mock.patch.object(
-    OIDCLogoutView, "construct_oidc_logout_url", return_value="/example-logout"
-)
-def test_view_logout(mocked_oidc_logout_url):
-    """Authenticated users should be redirected to OIDC provider for logout."""
-
-    user = factories.UserFactory()
-
-    client = APIClient()
-    client.force_login(user)
-
-    url = reverse("oidc_logout_custom")
-    response = client.get(url)
-
-    mocked_oidc_logout_url.assert_called_once()
-
-    assert response.status_code == 302
-    assert response.url == "/example-logout"
-
-
-@override_settings(LOGOUT_REDIRECT_URL="/default-redirect-logout")
-@mock.patch.object(
-    OIDCLogoutView, "construct_oidc_logout_url", return_value="/default-redirect-logout"
-)
-def test_view_logout_no_oidc_provider(mocked_oidc_logout_url):
-    """Authenticated users should be logged out when no OIDC provider is available."""
-
-    user = factories.UserFactory()
-
-    client = APIClient()
-    client.force_login(user)
-
-    url = reverse("oidc_logout_custom")
-
-    with mock.patch("mozilla_django_oidc.views.auth.logout") as mock_logout:
-        response = client.get(url)
-        mocked_oidc_logout_url.assert_called_once()
-        mock_logout.assert_called_once()
-
-    assert response.status_code == 302
-    assert response.url == "/default-redirect-logout"
-
-
-@override_settings(LOGOUT_REDIRECT_URL="/example-logout")
-def test_view_logout_callback_anonymous():
-    """Anonymous users calling the logout callback url,
-    should be redirected to the specified LOGOUT_REDIRECT_URL."""
-
-    url = reverse("oidc_logout_callback")
-    response = APIClient().get(url)
-
-    assert response.status_code == 302
-    assert response.url == "/example-logout"
-
-
-@pytest.mark.parametrize(
-    "initial_oidc_states",
-    [{}, {"other_state": "foo"}],
-)
-def test_view_logout_persist_state(initial_oidc_states):
-    """State value should be persisted in session's data."""
-
-    user = factories.UserFactory()
-
-    request = RequestFactory().request()
-    request.user = user
-
-    middleware = SessionMiddleware(get_response=lambda x: x)
-    middleware.process_request(request)
-
-    if initial_oidc_states:
-        request.session["oidc_states"] = initial_oidc_states
-        request.session.save()
-
-    mocked_state = "mock_state"
-
-    OIDCLogoutView().persist_state(request, mocked_state)
-
-    assert "oidc_states" in request.session
-    assert request.session["oidc_states"] == {
-        "mock_state": {},
-        **initial_oidc_states,
-    }
-
-
-@override_settings(OIDC_OP_LOGOUT_ENDPOINT="/example-logout")
-@mock.patch.object(OIDCLogoutView, "persist_state")
-@mock.patch.object(crypto, "get_random_string", return_value="mocked_state")
-def test_view_logout_construct_oidc_logout_url(
-    mocked_get_random_string, mocked_persist_state
-):
-    """Should construct the logout URL to initiate the logout flow with the OIDC provider."""
-
-    user = factories.UserFactory()
-
-    request = RequestFactory().request()
-    request.user = user
-
-    middleware = SessionMiddleware(get_response=lambda x: x)
-    middleware.process_request(request)
-
-    request.session["oidc_id_token"] = "mocked_oidc_id_token"
-    request.session.save()
-
-    redirect_url = OIDCLogoutView().construct_oidc_logout_url(request)
-
-    mocked_persist_state.assert_called_once()
-    mocked_get_random_string.assert_called_once()
-
-    params = parse_qs(urlparse(redirect_url).query)
-
-    assert params["id_token_hint"][0] == "mocked_oidc_id_token"
-    assert params["state"][0] == "mocked_state"
-
-    url = reverse("oidc_logout_callback")
-    assert url in params["post_logout_redirect_uri"][0]
-
-
-@override_settings(LOGOUT_REDIRECT_URL="/")
-def test_view_logout_construct_oidc_logout_url_none_id_token():
-    """If no ID token is available in the session,
-    the user should be redirected to the final URL."""
-
-    user = factories.UserFactory()
-
-    request = RequestFactory().request()
-    request.user = user
-
-    middleware = SessionMiddleware(get_response=lambda x: x)
-    middleware.process_request(request)
-
-    redirect_url = OIDCLogoutView().construct_oidc_logout_url(request)
-
-    assert redirect_url == "/"
-
-
-@pytest.mark.parametrize(
-    "initial_state",
-    [None, {"other_state": "foo"}],
-)
-def test_view_logout_callback_wrong_state(initial_state):
-    """Should raise an error if OIDC state doesn't match session data."""
-
-    user = factories.UserFactory()
-
-    request = RequestFactory().request()
-    request.user = user
-
-    middleware = SessionMiddleware(get_response=lambda x: x)
-    middleware.process_request(request)
-
-    if initial_state:
-        request.session["oidc_states"] = initial_state
-        request.session.save()
-
-    callback_view = OIDCLogoutCallbackView.as_view()
-
-    with pytest.raises(SuspiciousOperation) as excinfo:
-        callback_view(request)
-
-    assert (
-        str(excinfo.value) == "OIDC callback state not found in session `oidc_states`!"
-    )
-
-
-@override_settings(LOGOUT_REDIRECT_URL="/example-logout")
-def test_view_logout_callback():
-    """If state matches, callback should clear OIDC state and redirects."""
-
-    user = factories.UserFactory()
-
-    request = RequestFactory().get("/logout-callback/", data={"state": "mocked_state"})
-    request.user = user
-
-    middleware = SessionMiddleware(get_response=lambda x: x)
-    middleware.process_request(request)
-
-    mocked_state = "mocked_state"
-
-    request.session["oidc_states"] = {mocked_state: {}}
-    request.session.save()
-
-    callback_view = OIDCLogoutCallbackView.as_view()
-
-    with mock.patch("mozilla_django_oidc.views.auth.logout") as mock_logout:
-
-        def clear_user(request):
-            # Assert state is cleared prior to logout
-            assert request.session["oidc_states"] == {}
-            request.user = AnonymousUser()
-
-        mock_logout.side_effect = clear_user
-        response = callback_view(request)
-        mock_logout.assert_called_once()
-
-    assert response.status_code == 302
-    assert response.url == "/example-logout"

src/backend/core/tests/commands/test_update_files_content_type_metadata.py

@@ -42,9 +42,9 @@ def test_update_files_content_type_metadata():
 
     for key in keys:
         head_resp = s3_client.head_object(Bucket=bucket_name, Key=key)
-        assert (
-            head_resp["ContentType"] == "image/png"
-        ), f"ContentType not fixed, got {head_resp['ContentType']!r}"
+        assert head_resp["ContentType"] == "image/png", (
+            f"ContentType not fixed, got {head_resp['ContentType']!r}"
+        )
 
         # Check that original metadata was preserved
         assert head_resp["Metadata"].get("owner") == "None"

src/backend/core/tests/conftest.py

@@ -2,6 +2,8 @@
 
 from unittest import mock
 
+from django.core.cache import cache
+
 import pytest
 
 USER = "user"
@@ -9,6 +11,12 @@ TEAM = "team"
 VIA = [USER, TEAM]
 
 
+@pytest.fixture(autouse=True)
+def clear_cache():
+    """Fixture to clear the cache before each test."""
+    cache.clear()
+
+
 @pytest.fixture
 def mock_user_teams():
     """Mock for the "teams" property on the User model."""

src/backend/core/tests/documents/test_api_document_accesses.py

@@ -59,8 +59,32 @@ def test_api_document_accesses_list_authenticated_unrelated():
     }
 
 
+def test_api_document_accesses_list_unexisting_document():
+    """
+    Listing document accesses for an unexisting document should return an empty list.
+    """
+    user = factories.UserFactory()
+
+    client = APIClient()
+    client.force_login(user)
+
+    response = client.get(f"/api/v1.0/documents/{uuid4()!s}/accesses/")
+    assert response.status_code == 200
+    assert response.json() == {
+        "count": 0,
+        "next": None,
+        "previous": None,
+        "results": [],
+    }
+
+
 @pytest.mark.parametrize("via", VIA)
-def test_api_document_accesses_list_authenticated_related(via, mock_user_teams):
+@pytest.mark.parametrize(
+    "role", [role for role in models.RoleChoices if role not in models.PRIVILEGED_ROLES]
+)
+def test_api_document_accesses_list_authenticated_related_non_privileged(
+    via, role, mock_user_teams
+):
     """
     Authenticated users should be able to list document accesses for a document
     to which they are directly related, whatever their role in the document.
@@ -70,24 +94,114 @@ def test_api_document_accesses_list_authenticated_related(via, mock_user_teams):
     client = APIClient()
     client.force_login(user)
 
-    document = factories.DocumentFactory()
+    owner = factories.UserFactory()
+    accesses = []
+
+    document_access = factories.UserDocumentAccessFactory(
+        user=owner, role=models.RoleChoices.OWNER
+    )
+    accesses.append(document_access)
+    document = document_access.document
+    if via == USER:
+        models.DocumentAccess.objects.create(
+            document=document,
+            user=user,
+            role=role,
+        )
+    elif via == TEAM:
+        mock_user_teams.return_value = ["lasuite", "unknown"]
+        models.DocumentAccess.objects.create(
+            document=document,
+            team="lasuite",
+            role=role,
+        )
+
+    access1 = factories.TeamDocumentAccessFactory(document=document)
+    access2 = factories.UserDocumentAccessFactory(document=document)
+    accesses.append(access1)
+    accesses.append(access2)
+
+    # Accesses for other documents to which the user is related should not be listed either
+    other_access = factories.UserDocumentAccessFactory(user=user)
+    factories.UserDocumentAccessFactory(document=other_access.document)
+
+    response = client.get(
+        f"/api/v1.0/documents/{document.id!s}/accesses/",
+    )
+
+    # Return only owners
+    owners_accesses = [
+        access for access in accesses if access.role in models.PRIVILEGED_ROLES
+    ]
+    assert response.status_code == 200
+    content = response.json()
+    assert content["count"] == len(owners_accesses)
+    assert sorted(content["results"], key=lambda x: x["id"]) == sorted(
+        [
+            {
+                "id": str(access.id),
+                "user": {
+                    "id": None,
+                    "email": None,
+                    "full_name": access.user.full_name,
+                    "short_name": access.user.short_name,
+                }
+                if access.user
+                else None,
+                "team": access.team,
+                "role": access.role,
+                "abilities": access.get_abilities(user),
+            }
+            for access in owners_accesses
+        ],
+        key=lambda x: x["id"],
+    )
+
+    for access in content["results"]:
+        assert access["role"] in models.PRIVILEGED_ROLES
+
+
+@pytest.mark.parametrize("via", VIA)
+@pytest.mark.parametrize("role", models.PRIVILEGED_ROLES)
+def test_api_document_accesses_list_authenticated_related_privileged_roles(
+    via, role, mock_user_teams
+):
+    """
+    Authenticated users should be able to list document accesses for a document
+    to which they are directly related, whatever their role in the document.
+    """
+    user = factories.UserFactory()
+
+    client = APIClient()
+    client.force_login(user)
+
+    owner = factories.UserFactory()
+    accesses = []
+
+    document_access = factories.UserDocumentAccessFactory(
+        user=owner, role=models.RoleChoices.OWNER
+    )
+    accesses.append(document_access)
+    document = document_access.document
     user_access = None
     if via == USER:
         user_access = models.DocumentAccess.objects.create(
             document=document,
             user=user,
-            role=random.choice(models.RoleChoices.choices)[0],
+            role=role,
         )
     elif via == TEAM:
         mock_user_teams.return_value = ["lasuite", "unknown"]
         user_access = models.DocumentAccess.objects.create(
             document=document,
             team="lasuite",
-            role=random.choice(models.RoleChoices.choices)[0],
+            role=role,
         )
 
     access1 = factories.TeamDocumentAccessFactory(document=document)
     access2 = factories.UserDocumentAccessFactory(document=document)
+    accesses.append(access1)
+    accesses.append(access2)
 
     # Accesses for other documents to which the user is related should not be listed either
     other_access = factories.UserDocumentAccessFactory(user=user)
@@ -102,7 +216,7 @@ def test_api_document_accesses_list_authenticated_related(via, mock_user_teams):
 
     assert response.status_code == 200
     content = response.json()
-    assert len(content["results"]) == 3
+    assert len(content["results"]) == 4
     assert sorted(content["results"], key=lambda x: x["id"]) == sorted(
         [
             {
@@ -126,6 +240,13 @@ def test_api_document_accesses_list_authenticated_related(via, mock_user_teams):
                 "role": access2.role,
                 "abilities": access2.get_abilities(user),
             },
+            {
+                "id": str(document_access.id),
+                "user": serializers.UserSerializer(instance=owner).data,
+                "team": "",
+                "role": models.RoleChoices.OWNER,
+                "abilities": document_access.get_abilities(user),
+            },
         ],
         key=lambda x: x["id"],
     )
@@ -184,7 +305,10 @@ def test_api_document_accesses_retrieve_authenticated_unrelated():
 
 
 @pytest.mark.parametrize("via", VIA)
-def test_api_document_accesses_retrieve_authenticated_related(via, mock_user_teams):
+@pytest.mark.parametrize("role", models.RoleChoices)
+def test_api_document_accesses_retrieve_authenticated_related(
+    via, role, mock_user_teams
+):
     """
     A user who is related to a document should be allowed to retrieve the
     associated document user accesses.
@@ -196,10 +320,12 @@ def test_api_document_accesses_retrieve_authenticated_related(via, mock_user_tea
 
     document = factories.DocumentFactory()
     if via == USER:
-        factories.UserDocumentAccessFactory(document=document, user=user)
+        factories.UserDocumentAccessFactory(document=document, user=user, role=role)
     elif via == TEAM:
         mock_user_teams.return_value = ["lasuite", "unknown"]
-        factories.TeamDocumentAccessFactory(document=document, team="lasuite")
+        factories.TeamDocumentAccessFactory(
+            document=document, team="lasuite", role=role
+        )
 
     access = factories.UserDocumentAccessFactory(document=document)
 
@@ -207,16 +333,19 @@ def test_api_document_accesses_retrieve_authenticated_related(via, mock_user_tea
         f"/api/v1.0/documents/{document.id!s}/accesses/{access.id!s}/",
     )
 
-    access_user = serializers.UserSerializer(instance=access.user).data
+    if not role in models.PRIVILEGED_ROLES:
+        assert response.status_code == 403
+    else:
+        access_user = serializers.UserSerializer(instance=access.user).data
 
-    assert response.status_code == 200
-    assert response.json() == {
-        "id": str(access.id),
-        "user": access_user,
-        "team": "",
-        "role": access.role,
-        "abilities": access.get_abilities(user),
-    }
+        assert response.status_code == 200
+        assert response.json() == {
+            "id": str(access.id),
+            "user": access_user,
+            "team": "",
+            "role": access.role,
+            "abilities": access.get_abilities(user),
+        }
 
 
 def test_api_document_accesses_update_anonymous():
@@ -227,7 +356,7 @@ def test_api_document_accesses_update_anonymous():
     new_values = {
         "id": uuid4(),
         "user": factories.UserFactory().id,
-        "role": random.choice(models.RoleChoices.choices)[0],
+        "role": random.choice(models.RoleChoices.values),
     }
 
     api_client = APIClient()
@@ -260,7 +389,7 @@ def test_api_document_accesses_update_authenticated_unrelated():
     new_values = {
         "id": uuid4(),
         "user": factories.UserFactory().id,
-        "role": random.choice(models.RoleChoices.choices)[0],
+        "role": random.choice(models.RoleChoices.values),
     }
 
     for field, value in new_values.items():
@@ -302,7 +431,7 @@ def test_api_document_accesses_update_authenticated_reader_or_editor(
     new_values = {
         "id": uuid4(),
         "user": factories.UserFactory().id,
-        "role": random.choice(models.RoleChoices.choices)[0],
+        "role": random.choice(models.RoleChoices.values),
     }
 
     for field, value in new_values.items():
@@ -413,7 +542,7 @@ def test_api_document_accesses_update_administrator_from_owner(via, mock_user_te
     new_values = {
         "id": uuid4(),
         "user_id": factories.UserFactory().id,
-        "role": random.choice(models.RoleChoices.choices)[0],
+        "role": random.choice(models.RoleChoices.values),
     }
 
     for field, value in new_values.items():
@@ -527,7 +656,7 @@ def test_api_document_accesses_update_owner(
     new_values = {
         "id": uuid4(),
         "user_id": factories.UserFactory().id,
-        "role": random.choice(models.RoleChoices.choices)[0],
+        "role": random.choice(models.RoleChoices.values),
     }
 
     for field, value in new_values.items():