add test cases

Automatic product actions

.env.example

@@ -0,0 +1,18 @@
+HTTPS=off
+SITH_DEBUG=true
+
+# This is not the real key used in prod
+SECRET_KEY=(4sjxvhz@m5$0a$j0_pqicnc$s!vbve)z+&++m%g%bjhlz4+g2
+
+# comment the sqlite line and uncomment the postgres one to switch the dbms
+DATABASE_URL=sqlite:///db.sqlite3
+#DATABASE_URL=postgres://user:password@127.0.0.1:5432/sith
+
+REDIS_PORT=7963
+CACHE_URL=redis://127.0.0.1:${REDIS_PORT}/0
+TASK_BROKER_URL=redis://127.0.0.1:${REDIS_PORT}/1
+
+# Used to select which other services to run alongside
+# manage.py, pytest and runserver
+PROCFILE_STATIC=Procfile.static
+PROCFILE_SERVICE=Procfile.service

.envrc

@@ -0,0 +1,6 @@
+if [[ ! -d .venv ]]; then
+  log_error 'No .venv folder found. Use `uv sync` to create one first.'
+  exit 2
+fi
+
+. .venv/bin/activate

.github/actions/setup_project/action.yml

@@ -0,0 +1,65 @@
+name: "Setup project"
+description: "Setup Python and Poetry"
+inputs:
+  full:
+    description: > 
+      If true, do a full setup, else install
+      only python, uv and non-xapian python deps
+    required: false
+    default: "false"
+runs:
+  using: composite
+  steps:
+    - name: Install apt packages
+      if: ${{ inputs.full == 'true' }}
+      uses: awalsh128/cache-apt-pkgs-action@v1.4.3
+      with:
+        packages: gettext
+        version: 1.0  # increment to reset cache
+
+    - name: Install Redis
+      if: ${{ inputs.full == 'true' }}
+      uses: shogo82148/actions-setup-redis@v1
+      with:
+        redis-version: "7.x"
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+      with:
+        version: "0.5.14"
+        enable-cache: true
+        cache-dependency-glob: "uv.lock"
+
+    - name: "Set up Python"
+      uses: actions/setup-python@v5
+      with:
+        python-version-file: ".python-version"
+
+    - name: Restore cached virtualenv
+      uses: actions/cache/restore@v4
+      with:
+        key: venv-${{ runner.os }}-${{ hashFiles('.python-version') }}-${{ hashFiles('pyproject.toml') }}-${{ env.CACHE_SUFFIX }}
+        path: .venv
+
+    - name: Install dependencies
+      run: uv sync
+      shell: bash
+
+    - name: Install Xapian
+      if: ${{ inputs.full == 'true' }}
+      run: uv run ./manage.py install_xapian
+      shell: bash
+
+    # compiling xapian accounts for almost the entirety of the virtualenv setup,
+    # so we save the virtual environment only on workflows where it has been installed
+    - name: Save cached virtualenv
+      if: ${{ inputs.full == 'true' }}
+      uses: actions/cache/save@v4
+      with:
+        key: venv-${{ runner.os }}-${{ hashFiles('.python-version') }}-${{ hashFiles('pyproject.toml') }}-${{ env.CACHE_SUFFIX }}
+        path: .venv
+
+    - name: Compile gettext messages
+      if: ${{ inputs.full == 'true' }}
+      run: uv run ./manage.py compilemessages
+      shell: bash

.github/auto_assign.yml

@@ -0,0 +1,13 @@
+# Set to true to add reviewers to pull requests
+addReviewers: true
+
+# Set to true to add assignees to pull requests
+addAssignees: author
+
+# A list of team reviewers to be added to pull requests (GitHub team slug)
+reviewers:
+  - ae-utbm/developpeurs
+
+# Number of reviewers has no impact on GitHub teams
+# Set 0 to add all the reviewers (default: 0)
+numberOfReviewers: 0

.github/dependabot.yml

@@ -0,0 +1,31 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+
+multi-ecosystem-groups:
+  common:
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    target-branch: "taiste"
+    commit-message:
+      prefix: "[UPDATE] "
+
+updates:
+  - package-ecosystem: "uv"
+    patterns: ["*"]
+    multi-ecosystem-group: "common"
+
+  - package-ecosystem: "npm"
+    patterns: ["*"]
+    multi-ecosystem-group: "common"
+    groups:
+      # npm supports production and development groups, but not uv
+      # cf. https://docs.github.com/en/code-security/dependabot/working-with-dependabot/dependabot-options-reference#dependency-type-groups
+      main-deps:
+        dependency-type: "production"
+      dev-deps:
+        dependency-type: "development"

.github/workflows/ci.yml

@@ -0,0 +1,55 @@
+name: Sith CI
+
+on:
+  push:
+    branches: [master, taiste]
+  pull_request:
+    branches: [master, taiste]
+  workflow_dispatch:
+
+env:
+  SECRET_KEY: notTheRealOne
+  DATABASE_URL: sqlite:///db.sqlite3
+  CACHE_URL: redis://127.0.0.1:6379/0
+  TASK_BROKER_URL: redis://127.0.0.1:6379/1
+
+jobs:
+  pre-commit:
+    name: Launch pre-commits checks (ruff)
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+      with:
+        python-version-file: ".python-version"
+    - uses: pre-commit/action@v3.0.1
+      with:
+        extra_args: --all-files
+
+  tests:
+    name: Run tests and generate coverage report
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false  # don't interrupt the other test processes
+      matrix:
+        pytest-mark: [not slow]
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+      - uses: ./.github/actions/setup_project
+        with:
+          full: true
+        env:
+          # To avoid race conditions on environment cache
+          CACHE_SUFFIX: ${{ matrix.pytest-mark }}
+      - name: Run tests
+        run: uv run coverage run -m pytest -m "${{ matrix.pytest-mark }}"
+      - name: Generate coverage report
+        run: |
+          uv run coverage report
+          uv run coverage html
+      - name: Archive code coverage results
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report-${{ matrix.pytest-mark }}
+          path: coverage_report

.github/workflows/deploy.yml

@@ -0,0 +1,65 @@
+name: Deploy to production
+concurrency: production
+
+on:
+  push:
+    branches: [master]
+  workflow_dispatch:
+
+jobs:
+  deployment:
+    runs-on: ubuntu-latest
+    environment: production
+    timeout-minutes: 30
+  
+    steps:
+    - name: SSH Remote Commands
+      uses: appleboy/ssh-action@v1.1.0
+      with:
+        # Proxy
+        proxy_host : ${{secrets.PROXY_HOST}}
+        proxy_port : ${{secrets.PROXY_PORT}}
+        proxy_username : ${{secrets.PROXY_USER}}
+        proxy_passphrase: ${{secrets.PROXY_PASSPHRASE}}
+        proxy_key: ${{secrets.PROXY_KEY}}
+        
+        # Serveur web
+        host: ${{secrets.HOST}}
+        port : ${{secrets.PORT}}
+        username : ${{secrets.USER}}
+        key: ${{secrets.KEY}}
+
+        script_stop: true
+
+        # See https://github.com/ae-utbm/sith/wiki/GitHub-Actions#deployment-action
+        script: |
+          cd ${{secrets.SITH_PATH}}
+
+          git fetch
+          git reset --hard origin/master
+          uv sync --group prod
+          npm install
+          uv run ./manage.py install_xapian
+          uv run ./manage.py migrate
+          uv run ./manage.py collectstatic --clear --noinput
+          uv run ./manage.py compilemessages
+
+          sudo systemctl restart uwsgi
+  
+  sentry:
+    runs-on: ubuntu-latest
+    environment: production
+    timeout-minutes: 30
+    needs: deployment
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Sentry Release
+        uses: getsentry/action-release@v1.7.0
+        env:
+          SENTRY_AUTH_TOKEN: ${{ secrets.SENTRY_AUTH_TOKEN }}
+          SENTRY_ORG: ${{ secrets.SENTRY_ORG }}
+          SENTRY_PROJECT: ${{ secrets.SENTRY_PROJECT }}
+          SENTRY_URL: ${{ secrets.SENTRY_URL }}
+        with:
+          environment: production

.github/workflows/deploy_docs.yml

@@ -0,0 +1,21 @@
+name: deploy_docs
+on:
+  push:
+    branches:
+      - taiste
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/setup_project
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v3
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: uv run mkdocs gh-deploy --force

.github/workflows/taiste.yml

@@ -0,0 +1,46 @@
+name: Sith taiste
+
+on:
+  push:
+    branches: [taiste]
+  workflow_dispatch:
+
+jobs:
+  deployment:
+    runs-on: ubuntu-latest
+    environment: taiste
+    timeout-minutes: 30
+
+    steps:
+    - name: SSH Remote Commands
+      uses: appleboy/ssh-action@v1.1.0
+      with:
+        # Proxy
+        proxy_host : ${{secrets.PROXY_HOST}}
+        proxy_port : ${{secrets.PROXY_PORT}}
+        proxy_username : ${{secrets.PROXY_USER}}
+        proxy_passphrase: ${{secrets.PROXY_PASSPHRASE}}
+        proxy_key: ${{secrets.PROXY_KEY}}
+
+        # Serveur web
+        host: ${{secrets.HOST}}
+        port : ${{secrets.PORT}}
+        username : ${{secrets.USER}}
+        key: ${{secrets.KEY}}
+
+        script_stop: true
+
+        # See https://github.com/ae-utbm/sith/wiki/GitHub-Actions#deployment-action
+        script: |
+          cd ${{secrets.SITH_PATH}}
+
+          git fetch
+          git reset --hard origin/taiste
+          uv sync --group prod
+          npm install
+          uv run ./manage.py install_xapian
+          uv run ./manage.py migrate
+          uv run ./manage.py collectstatic --clear --noinput
+          uv run ./manage.py compilemessages
+
+          sudo systemctl restart uwsgi

.gitignore

@@ -1,15 +1,31 @@
-db.sqlite3
+*.sqlite3
 *.log
 *.pyc
 *.mo
 *__pycache__*
 .DS_Store
+pyrightconfig.json
+dist/
 .vscode/
-env/
+.idea/
+.venv/
 doc/html
 data/
+galaxy/test_galaxy_state.json
 /static/
 sith/settings_custom.py
 sith/search_indexes/
 .coverage
 coverage_report/
+node_modules/
+.env
+*.pid
+
+# compiled documentation
+site/
+
+### Redis ###
+
+# Ignore redis binary dump (dump.rdb) files
+
+*.rdb

.gitlab-ci.yml

@@ -1,26 +0,0 @@
-stages:
-  - test
-
-test:
-  stage: test
-  script:
-  - apt-get update
-  - apt-get install -y gettext python3-xapian
-  - pushd /usr/lib/python3/dist-packages/xapian && ln -s _xapian* _xapian.so && popd
-  - export PYTHONPATH="/usr/lib/python3/dist-packages:$PYTHONPATH"
-  - python -c 'import xapian' # Fail immediately if there is a problem with xapian
-  - pip install -r requirements.txt
-  - pip install coverage
-  - ./manage.py compilemessages
-  - coverage run ./manage.py test
-  - coverage html
-  - coverage report
-  artifacts:
-    paths:
-      - coverage_report/
-
-black:
-  stage: test
-  script:
-    - pip install black
-    - black --check .

.mailmap

@@ -0,0 +1,19 @@
+Code <gregoire.duvauchelle@utbm.fr>
+Cyl <labetowiez@aol.fr>
+Juste <maaxleblanc@gmail.com>
+Krophil <pierre.brunet@krophil.fr>
+Lo-J <renaudg779@gmail.com>
+Nabos <gnikwo@hotmail.com>
+Och <francescowitz68@gmail.com>
+Partoo <joqaste@gmail.com>
+Skia <skia@hya.sk> <lordbanana25@mailoo.org>
+Skia <skia@hya.sk> <skia@libskia.so>
+Sli <klmp200@klmp200.net> <antoine@bartuccio.fr>
+Soldat <ryan-68@live.fr>
+Terre <jbaptiste.lenglet+git@gmail.com>
+Vial <robin.trioux@utbm.fr>
+Zar <antoine.charmeau@utbm.fr> <antoine.charmeau@laposte.net>
+root <root@localhost.localdomain>
+tleb <tleb@openmailbox.org> <theo.lebrun@live.fr>
+tleb <tleb@openmailbox.org> <theo.lebrun@utbm.fr>
+Maréchal <thgirod@hotmail.com>

.npmrc

@@ -0,0 +1 @@
+@jsr:registry=https://npm.jsr.io

.pre-commit-config.yaml

@@ -0,0 +1,26 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.11.13
+    hooks:
+      - id: ruff-check  # just check the code, and print the errors
+      - id: ruff-check  # actually fix the fixable errors, but print nothing
+        args: ["--fix", "--silent"]
+      # Run the formatter.
+      - id: ruff-format
+  - repo: https://github.com/biomejs/pre-commit
+    rev: v0.6.1
+    hooks:
+      - id: biome-check
+        additional_dependencies: ["@biomejs/biome@1.9.4"]
+  - repo: https://github.com/rtts/djhtml
+    rev: 3.0.7
+    hooks:
+      - id: djhtml
+        name: format templates
+        entry: djhtml --tabwidth 2
+        types: ["jinja"]
+      - id: djcss
+        name: format scss files
+        entry: djcss --tabwidth 2
+        types: ["scss"]

.python-version

@@ -0,0 +1 @@
+3.12

CONTRIBUTING.md

@@ -1,106 +0,0 @@
-*Contribuer c'est la vie*
-=========================
-
-Hey ! Tu veux devenir un mec bien et en plus devenir bon en python si tu l'es pas déjà ?
-Il se trouve que le sith AE prévu pour l'été 2016 a besoin de toi !
-
-Pour faire le sith, on utilise le framework Web [Django](https://docs.djangoproject.com/fr/1.11/intro/)  
-N'hésite pas à lire les tutos et à nous demander (ae.info@utbm.fr).
-
-Bon, passons aux choses sérieuses, pour bidouiller le sith sans le casser :  
-Ben en fait, tu peux pas le casser, tu vas juste t'amuser comme un petit fou sur un clone du sith.
-
-C'est pas compliqué, il suffit d'avoir [Git](http://www.git-scm.com/book/fr/v2), python et pip (pour faciliter la gestion des paquets python).
-
-Tout d'abord, tu vas avoir besoin d'un compte Gitlab pour pouvoir te connecter.  
-Ensuite, tu fais :
-`git clone https://ae-dev.utbm.fr/ae/Sith.git`
-Avec cette commande, tu clones le sith AE dans le dossier courant.
-
-```bash
-cd Sith
-virtualenv --system-site-packages --python=python3 env
-source env/bin/activate
-pip install -r requirements.txt
-./manage runserver
-```
-
-Attention aux dépendances système, à voir dans le README.md
-
-Maintenant, faut passer le sith en mode debug dans le fichier de settings personnalisé.
-
-```bash
-echo "DEBUG=True" > sith/settings_custom.py
-echo 'SITH_URL = "localhost:8000"' >> sith/settings_custom.py
-```
-
-Enfin, il s'agit de créer la base de donnée de test lors de la première utilisation
-
-```bash
-./manage.py setup
-```
-
-Et pour lancer le sith, tu fais `python3 manage.py runserver`
-
-Voilà, c'est le sith AE. Il y a des issues dans le gitlab qui sont à régler. Si tu as un domaine qui t'intéresse, une appli que tu voudrais développer, n'hésites pas et contacte-nous.
-Va, et que l'AE soit avec toi.
-
-# Black
-
-Pour uniformiser le formattage du code nous utilisons [Black](https://github.com/ambv/black). Cela permet d'avoir le même codestyle et donc le codereview prend moins de temps. Tout étant dans le même format, il est plus facile pour chacun de comprendre le code de chacun ! Cela permet aussi d'éviter des erreurs (y parait 🤷‍♀️).
-
-Installation de black:
-
-```bash
-pip install black
-```
-
-## Sous VsCode:
-Attention, pour VsCode, Black doit être installé dans votre virtualenv !
-Ajouter ces deux lignes dans les settings de VsCode
-
-```json
-{
-    "python.formatting.provider": "black",
-    "editor.formatOnSave": true
-}
-```
-
-## Sous Sublime Text
-Il faut installer le plugin [sublack](https://packagecontrol.io/packages/sublack) depuis Package Control.
-
-Il suffit ensuite d'ajouter dans les settings du projet (ou en global)
-
-```json
-{
-    "sublack.black_on_save": true
-}
-```
-
-Si vous utilisez le plugin [anaconda](http://damnwidget.github.io/anaconda/), pensez à modifier les paramètres du linter pep8 pour éviter de recevoir des warnings dans le formatage de black
-
-```json
-{
-    "pep8_ignore": [
-      "E203",
-      "E266",
-      "E501",
-      "W503"
-    ]
-}
-```
-
-Sites et doc cools
-------------------
-
-[Classy Class-Based Views](http://ccbv.co.uk/projects/Django/1.11/)
-
-Helpers:
-
-`./manage.py makemessages --ignore "env/*" -e py,jinja`
-
-`for f in $(find . -name "*.py" ! -path "*migration*" ! -path "./env/*" ! -path "./doc/*"); do cat ./doc/header "$f" > /tmp/temp && mv /tmp/temp "$f"; done`
-
-
-
-

CONTRIBUTING.rst

@@ -0,0 +1,3 @@
+Pour contribuer au projet, vous pouvez vous référer à la documentation disponible à https://sith-ae.readthedocs.io/.
+
+Et n'oubliez pas, contribuer c'est la vie !

LICENSE.old

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2016 Skia
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

Procfile.service

@@ -0,0 +1,2 @@
+redis: redis-server --port $REDIS_PORT
+celery: uv run celery -A sith worker --beat -l INFO

Procfile.static

@@ -0,0 +1 @@
+bundler: npm run serve

README.md

@@ -1,104 +1,21 @@
-[![pipeline status](https://ae-dev.utbm.fr/ae/Sith/badges/master/pipeline.svg)](https://ae-dev.utbm.fr/ae/Sith/commits/master)
-[![coverage report](https://ae-dev.utbm.fr/ae/Sith/badges/master/coverage.svg)](https://ae-dev.utbm.fr/ae/Sith/commits/master)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
-[![project chat](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg)](https://ae-dev.zulipchat.com)
+# Sith
 
-## Sith AE
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](#)
+[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+[![CI status](https://github.com/ae-utbm/sith/actions/workflows/ci.yml/badge.svg)](#)
+[![Docs status](https://github.com/ae-utbm/sith/actions/workflows/deploy_docs.yml/badge.svg)](https://ae-utbm.github.io/sith)
+[![Built with Material for MkDocs](https://img.shields.io/badge/Material_for_MkDocs-526CFE?style=default&logo=MaterialForMkDocs&logoColor=white)](https://squidfunk.github.io/mkdocs-material/)
+[![Checked with Biome](https://img.shields.io/badge/Checked_with-Biome-60a5fa?style=flat&logo=biome)](https://biomejs.dev)
+[![discord](https://img.shields.io/discord/971448179075731476?label=discord&logo=discord&style=default)](https://discord.gg/xk9wfpsufm)
 
-### Dependencies:
-See requirements.txt
+### This is the source code of the UTBM's student association available at [https://ae.utbm.fr/](https://ae.utbm.fr/).
 
-You may need to install some dev libraries like `libmysqlclient-dev`, `libssl-dev`, `libjpeg-dev`, `python3-xapian`, or `zlib1g-dev` to install all the
-requiered dependancies with pip. You may also need `mysql-client`. Don't also forget `python3-dev` if you don't have it
-already.
+All documentation is in the `docs` directory and online at [https://ae-utbm.github.io/sith](https://ae-utbm.github.io/sith). This documentation is written in French because it targets a French audience and it's too much work to maintain two versions. The code and code comments are strictly written in English.
 
-You can check all of them with:
-
-```bash
-sudo apt install libmysqlclient-dev libssl-dev libjpeg-dev zlib1g-dev python3-dev libffi-dev python3-dev libgraphviz-dev pkg-config python3-xapian gettext
-```
-
-On macos, you will need homebrew
-
-```bash
-brew install xapian
-```
-
-If it doesn't work it's because it need [this pull request](https://github.com/Homebrew/homebrew-core/pull/34835) to be validated.
-
-The development is done with sqlite, but it is advised to set a more robust DBMS for production (Postgresql for example)
-
-### Get started
-
-To start working on the project, just run the following commands:
-
-```bash
-git clone https://ae-dev.utbm.fr/ae/Sith.git
-cd Sith
-virtualenv --system-site-packages --python=python3 env
-source env/bin/activate
-pip install -r requirements.txt
-./manage.py setup
-```
-
-To start the simple development server, just run `python3 manage.py runserver`
-
-For more informations, check out the CONTRIBUTING.md file.
-
-### Logging errors with sentry
-
-To connect the app to sentry.io, you must set the variable SENTRY_DSN in your settings custom. It's composed of the full link given on your sentry project
-
-### Generating documentation
-
-There is a Doxyfile at the root of the project, meaning that if you have Doxygen, you can run `doxygen Doxyfile` to
-generate a complete HTML documentation that will be available in the *./doc/html/* folder.
-
-### Collecting statics for production:
-
-We use scss in the project. In development environment (DEBUG=True), scss is compiled every time the file is needed. For production, it assumes you have already compiled every files and to do so, you need to use the following commands : 
-
-```bash
-./manage.py collectstatic # To collect statics
-./manage.py compilestatic # To compile scss in those statics
-```
-
-### Misc about development
-
-#### Controlling the rights
-
-When you need to protect an object, there are three levels:
-  * Editing the object properties
-  * Editing the object various values
-  * Viewing the object
-
-Now you have many solutions in your model:
-  * You can define a `is_owned_by(self, user)`, a `can_be_edited_by(self, user)`, and/or a `can_be_viewed_by(self, user)`
-    method, each returning True is the user passed can edit/view the object, False otherwise.   
-    This allows you to make complex request when the group solution is not powerful enough.    
-    It's useful too when you want to define class-wide permissions, e.g. the club members, that are viewable only for
-    Subscribers.
-  * You can add an `owner_group` field, as a ForeignKey to Group.  Second is an `edit_groups` field, as a ManyToMany to
-    Group, and third is a `view_groups`, same as for edit.
-
-Finally, when building a class based view, which is highly advised, you just have to inherit it from CanEditPropMixin,
-CanEditMixin, or CanViewMixin, which are located in core.views. Your view will then be protected using either the
-appropriate group fields, or the right method to check user permissions.
-
-#### Counting the number of line of code
-
-```bash
-sudo apt install cloc
-cloc --exclude-dir=doc,env .
-```
-
-#### Updating doc/SYNTAX.md
-
-If you make an update in the Markdown syntax parser, it's good to document
-update the syntax reference page in `doc/SYNTAX.md`. But updating this file will
-break the tests if you don't update the corresponding `doc/SYNTAX.html` file at
-the same time.  
-To do that, simply run `./manage.py markdown > doc/SYNTAX.html`,
-and the tests should pass again.
+#### If you want to contribute, here's how we recommend to read the docs:
 
+* First, it's advised to read the about part of the project to understand the goals and the mindset of the current and previous maintainers and know what to expect to learn.
+* If in the first part you realize that you need more background about what we use, we provide some links to tutorials and documentation at the end of our documentation. Feel free to use it and complete it with what you found helpful.
+* Keep in mind that this documentation is thought to be read in order.
 
+> This project is licensed under GNU GPL, see the LICENSE file at the top of the repository for more details.

TODO.md

@@ -1,9 +0,0 @@
-# TODO
-
-## Easter eggs
-
-  * 'A' 'L' 'L' 'O': Entendre le Allooo de Madame Coucoune
-  * idem avec cacafe
-  * Un meat spin quelque part
-  * Konami code
-

accounting/__init__.py

@@ -1,23 +0,0 @@
-# -*- coding:utf-8 -*
-#
-# Copyright 2016,2017
-# - Skia <skia@libskia.so>
-#
-# Ce fichier fait partie du site de l'Association des Étudiants de l'UTBM,
-# http://ae.utbm.fr.
-#
-# This program is free software; you can redistribute it and/or modify it under
-# the terms of the GNU General Public License a published by the Free Software
-# Foundation; either version 3 of the License, or (at your option) any later
-# version.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
-# details.
-#
-# You should have received a copy of the GNU General Public License along with
-# this program; if not, write to the Free Sofware Foundation, Inc., 59 Temple
-# Place - Suite 330, Boston, MA 02111-1307, USA.
-#
-#

accounting/migrations/0001_initial.py

@@ -1,278 +0,0 @@
-# -*- coding: utf-8 -*-
-from __future__ import unicode_literals
-
-from django.db import migrations, models
-import django.core.validators
-import accounting.models
-
-
-class Migration(migrations.Migration):
-
-    dependencies = []
-
-    operations = [
-        migrations.CreateModel(
-            name="AccountingType",
-            fields=[
-                (
-                    "id",
-                    models.AutoField(
-                        primary_key=True,
-                        serialize=False,
-                        verbose_name="ID",
-                        auto_created=True,
-                    ),
-                ),
-                (
-                    "code",
-                    models.CharField(
-                        max_length=16,
-                        verbose_name="code",
-                        validators=[
-                            django.core.validators.RegexValidator(
-                                "^[0-9]*$",
-                                "An accounting type code contains only numbers",
-                            )
-                        ],
-                    ),
-                ),
-                ("label", models.CharField(max_length=128, verbose_name="label")),
-                (
-                    "movement_type",
-                    models.CharField(
-                        choices=[
-                            ("CREDIT", "Credit"),
-                            ("DEBIT", "Debit"),
-                            ("NEUTRAL", "Neutral"),
-                        ],
-                        max_length=12,
-                        verbose_name="movement type",
-                    ),
-                ),
-            ],
-            options={
-                "verbose_name": "accounting type",
-                "ordering": ["movement_type", "code"],
-            },
-        ),
-        migrations.CreateModel(
-            name="BankAccount",
-            fields=[
-                (
-                    "id",
-                    models.AutoField(
-                        primary_key=True,
-                        serialize=False,
-                        verbose_name="ID",
-                        auto_created=True,
-                    ),
-                ),
-                ("name", models.CharField(max_length=30, verbose_name="name")),
-                (
-                    "iban",
-                    models.CharField(max_length=255, blank=True, verbose_name="iban"),
-                ),
-                (
-                    "number",
-                    models.CharField(
-                        max_length=255, blank=True, verbose_name="account number"
-                    ),
-                ),
-            ],
-            options={"verbose_name": "Bank account", "ordering": ["club", "name"]},
-        ),
-        migrations.CreateModel(
-            name="ClubAccount",
-            fields=[
-                (
-                    "id",
-                    models.AutoField(
-                        primary_key=True,
-                        serialize=False,
-                        verbose_name="ID",
-                        auto_created=True,
-                    ),
-                ),
-                ("name", models.CharField(max_length=30, verbose_name="name")),
-            ],
-            options={
-                "verbose_name": "Club account",
-                "ordering": ["bank_account", "name"],
-            },
-        ),
-        migrations.CreateModel(
-            name="Company",
-            fields=[
-                (
-                    "id",
-                    models.AutoField(
-                        primary_key=True,
-                        serialize=False,
-                        verbose_name="ID",
-                        auto_created=True,
-                    ),
-                ),
-                ("name", models.CharField(max_length=60, verbose_name="name")),
-            ],
-            options={"verbose_name": "company"},
-        ),
-        migrations.CreateModel(
-            name="GeneralJournal",
-            fields=[
-                (
-                    "id",
-                    models.AutoField(
-                        primary_key=True,
-                        serialize=False,
-                        verbose_name="ID",
-                        auto_created=True,
-                    ),
-                ),
-                ("start_date", models.DateField(verbose_name="start date")),
-                (
-                    "end_date",
-                    models.DateField(
-                        null=True, verbose_name="end date", default=None, blank=True
-                    ),
-                ),
-                ("name", models.CharField(max_length=40, verbose_name="name")),
-                (
-                    "closed",
-                    models.BooleanField(verbose_name="is closed", default=False),
-                ),
-                (
-                    "amount",
-                    accounting.models.CurrencyField(
-                        decimal_places=2,
-                        default=0,
-                        verbose_name="amount",
-                        max_digits=12,
-                    ),
-                ),
-                (
-                    "effective_amount",
-                    accounting.models.CurrencyField(
-                        decimal_places=2,
-                        default=0,
-                        verbose_name="effective_amount",
-                        max_digits=12,
-                    ),
-                ),
-            ],
-            options={"verbose_name": "General journal", "ordering": ["-start_date"]},
-        ),
-        migrations.CreateModel(
-            name="Operation",
-            fields=[
-                (
-                    "id",
-                    models.AutoField(
-                        primary_key=True,
-                        serialize=False,
-                        verbose_name="ID",
-                        auto_created=True,
-                    ),
-                ),
-                ("number", models.IntegerField(verbose_name="number")),
-                (
-                    "amount",
-                    accounting.models.CurrencyField(
-                        decimal_places=2, max_digits=12, verbose_name="amount"
-                    ),
-                ),
-                ("date", models.DateField(verbose_name="date")),
-                ("remark", models.CharField(max_length=128, verbose_name="comment")),
-                (
-                    "mode",
-                    models.CharField(
-                        choices=[
-                            ("CHECK", "Check"),
-                            ("CASH", "Cash"),
-                            ("TRANSFERT", "Transfert"),
-                            ("CARD", "Credit card"),
-                        ],
-                        max_length=255,
-                        verbose_name="payment method",
-                    ),
-                ),
-                (
-                    "cheque_number",
-                    models.CharField(
-                        max_length=32,
-                        null=True,
-                        verbose_name="cheque number",
-                        default="",
-                        blank=True,
-                    ),
-                ),
-                ("done", models.BooleanField(verbose_name="is done", default=False)),
-                (
-                    "target_type",
-                    models.CharField(
-                        choices=[
-                            ("USER", "User"),
-                            ("CLUB", "Club"),
-                            ("ACCOUNT", "Account"),
-                            ("COMPANY", "Company"),
-                            ("OTHER", "Other"),
-                        ],
-                        max_length=10,
-                        verbose_name="target type",
-                    ),
-                ),
-                (
-                    "target_id",
-                    models.IntegerField(
-                        null=True, verbose_name="target id", blank=True
-                    ),
-                ),
-                (
-                    "target_label",
-                    models.CharField(
-                        max_length=32,
-                        blank=True,
-                        verbose_name="target label",
-                        default="",
-                    ),
-                ),
-                (
-                    "accounting_type",
-                    models.ForeignKey(
-                        null=True,
-                        related_name="operations",
-                        verbose_name="accounting type",
-                        to="accounting.AccountingType",
-                        blank=True,
-                    ),
-                ),
-            ],
-            options={"ordering": ["-number"]},
-        ),
-        migrations.CreateModel(
-            name="SimplifiedAccountingType",
-            fields=[
-                (
-                    "id",
-                    models.AutoField(
-                        primary_key=True,
-                        serialize=False,
-                        verbose_name="ID",
-                        auto_created=True,
-                    ),
-                ),
-                ("label", models.CharField(max_length=128, verbose_name="label")),
-                (
-                    "accounting_type",
-                    models.ForeignKey(
-                        verbose_name="simplified accounting types",
-                        to="accounting.AccountingType",
-                        related_name="simplified_types",
-                    ),
-                ),
-            ],
-            options={
-                "verbose_name": "simplified type",
-                "ordering": ["accounting_type__movement_type", "accounting_type__code"],
-            },
-        ),
-    ]

accounting/migrations/0002_auto_20160824_2152.py

@@ -1,94 +0,0 @@
-# -*- coding: utf-8 -*-
-from __future__ import unicode_literals
-
-from django.db import migrations, models
-
-
-class Migration(migrations.Migration):
-
-    dependencies = [
-        ("club", "0001_initial"),
-        ("accounting", "0001_initial"),
-        ("core", "0001_initial"),
-    ]
-
-    operations = [
-        migrations.AddField(
-            model_name="operation",
-            name="invoice",
-            field=models.ForeignKey(
-                null=True,
-                related_name="operations",
-                verbose_name="invoice",
-                to="core.SithFile",
-                blank=True,
-            ),
-        ),
-        migrations.AddField(
-            model_name="operation",
-            name="journal",
-            field=models.ForeignKey(
-                verbose_name="journal",
-                to="accounting.GeneralJournal",
-                related_name="operations",
-            ),
-        ),
-        migrations.AddField(
-            model_name="operation",
-            name="linked_operation",
-            field=models.OneToOneField(
-                blank=True,
-                to="accounting.Operation",
-                null=True,
-                related_name="operation_linked_to",
-                verbose_name="linked operation",
-                default=None,
-            ),
-        ),
-        migrations.AddField(
-            model_name="operation",
-            name="simpleaccounting_type",
-            field=models.ForeignKey(
-                null=True,
-                related_name="operations",
-                verbose_name="simple type",
-                to="accounting.SimplifiedAccountingType",
-                blank=True,
-            ),
-        ),
-        migrations.AddField(
-            model_name="generaljournal",
-            name="club_account",
-            field=models.ForeignKey(
-                verbose_name="club account",
-                to="accounting.ClubAccount",
-                related_name="journals",
-            ),
-        ),
-        migrations.AddField(
-            model_name="clubaccount",
-            name="bank_account",
-            field=models.ForeignKey(
-                verbose_name="bank account",
-                to="accounting.BankAccount",
-                related_name="club_accounts",
-            ),
-        ),
-        migrations.AddField(
-            model_name="clubaccount",
-            name="club",
-            field=models.ForeignKey(
-                verbose_name="club", to="club.Club", related_name="club_account"
-            ),
-        ),
-        migrations.AddField(
-            model_name="bankaccount",
-            name="club",
-            field=models.ForeignKey(
-                verbose_name="club", to="club.Club", related_name="bank_accounts"
-            ),
-        ),
-        migrations.AlterUniqueTogether(
-            name="operation", unique_together=set([("number", "journal")])
-        ),
-    ]

accounting/migrations/0003_auto_20160824_2203.py

@@ -1,50 +0,0 @@
-# -*- coding: utf-8 -*-
-from __future__ import unicode_literals
-
-from django.db import migrations, models
-import phonenumber_field.modelfields
-
-
-class Migration(migrations.Migration):
-
-    dependencies = [("accounting", "0002_auto_20160824_2152")]
-
-    operations = [
-        migrations.AddField(
-            model_name="company",
-            name="city",
-            field=models.CharField(blank=True, verbose_name="city", max_length=60),
-        ),
-        migrations.AddField(
-            model_name="company",
-            name="country",
-            field=models.CharField(blank=True, verbose_name="country", max_length=32),
-        ),
-        migrations.AddField(
-            model_name="company",
-            name="email",
-            field=models.EmailField(blank=True, verbose_name="email", max_length=254),
-        ),
-        migrations.AddField(
-            model_name="company",
-            name="phone",
-            field=phonenumber_field.modelfields.PhoneNumberField(
-                blank=True, verbose_name="phone", max_length=128
-            ),
-        ),
-        migrations.AddField(
-            model_name="company",
-            name="postcode",
-            field=models.CharField(blank=True, verbose_name="postcode", max_length=10),
-        ),
-        migrations.AddField(
-            model_name="company",
-            name="street",
-            field=models.CharField(blank=True, verbose_name="street", max_length=60),
-        ),
-        migrations.AddField(
-            model_name="company",
-            name="website",
-            field=models.CharField(blank=True, verbose_name="website", max_length=64),
-        ),
-    ]

accounting/migrations/0004_auto_20161005_1505.py

@@ -1,51 +0,0 @@
-# -*- coding: utf-8 -*-
-from __future__ import unicode_literals
-
-from django.db import migrations, models
-import django.db.models.deletion
-
-
-class Migration(migrations.Migration):
-
-    dependencies = [("accounting", "0003_auto_20160824_2203")]
-
-    operations = [
-        migrations.CreateModel(
-            name="Label",
-            fields=[
-                (
-                    "id",
-                    models.AutoField(
-                        verbose_name="ID",
-                        primary_key=True,
-                        auto_created=True,
-                        serialize=False,
-                    ),
-                ),
-                ("name", models.CharField(max_length=64, verbose_name="label")),
-                (
-                    "club_account",
-                    models.ForeignKey(
-                        related_name="labels",
-                        verbose_name="club account",
-                        to="accounting.ClubAccount",
-                    ),
-                ),
-            ],
-        ),
-        migrations.AddField(
-            model_name="operation",
-            name="label",
-            field=models.ForeignKey(
-                on_delete=django.db.models.deletion.SET_NULL,
-                related_name="operations",
-                null=True,
-                blank=True,
-                verbose_name="label",
-                to="accounting.Label",
-            ),
-        ),
-        migrations.AlterUniqueTogether(
-            name="label", unique_together=set([("name", "club_account")])
-        ),
-    ]

accounting/migrations/0005_auto_20170324_0917.py

@@ -1,19 +0,0 @@
-# -*- coding: utf-8 -*-
-from __future__ import unicode_literals
-
-from django.db import migrations, models
-
-
-class Migration(migrations.Migration):
-
-    dependencies = [("accounting", "0004_auto_20161005_1505")]
-
-    operations = [
-        migrations.AlterField(
-            model_name="operation",
-            name="remark",
-            field=models.CharField(
-                null=True, max_length=128, blank=True, verbose_name="comment"
-            ),
-        )
-    ]

accounting/models.py

@@ -1,542 +0,0 @@
-# -*- coding:utf-8 -*
-#
-# Copyright 2016,2017
-# - Skia <skia@libskia.so>
-#
-# Ce fichier fait partie du site de l'Association des Étudiants de l'UTBM,
-# http://ae.utbm.fr.
-#
-# This program is free software; you can redistribute it and/or modify it under
-# the terms of the GNU General Public License a published by the Free Software
-# Foundation; either version 3 of the License, or (at your option) any later
-# version.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
-# details.
-#
-# You should have received a copy of the GNU General Public License along with
-# this program; if not, write to the Free Sofware Foundation, Inc., 59 Temple
-# Place - Suite 330, Boston, MA 02111-1307, USA.
-#
-#
-
-from django.core.urlresolvers import reverse
-from django.core.exceptions import ValidationError
-from django.core import validators
-from django.db import models
-from django.conf import settings
-from django.utils.translation import ugettext_lazy as _
-from django.template import defaultfilters
-
-from phonenumber_field.modelfields import PhoneNumberField
-
-from decimal import Decimal
-from core.models import User, SithFile
-from club.models import Club
-
-
-class CurrencyField(models.DecimalField):
-    """
-    This is a custom database field used for currency
-    """
-
-    def __init__(self, *args, **kwargs):
-        kwargs["max_digits"] = 12
-        kwargs["decimal_places"] = 2
-        super(CurrencyField, self).__init__(*args, **kwargs)
-
-    def to_python(self, value):
-        try:
-            return super(CurrencyField, self).to_python(value).quantize(Decimal("0.01"))
-        except AttributeError:
-            return None
-
-
-# Accounting classes
-
-
-class Company(models.Model):
-    name = models.CharField(_("name"), max_length=60)
-    street = models.CharField(_("street"), max_length=60, blank=True)
-    city = models.CharField(_("city"), max_length=60, blank=True)
-    postcode = models.CharField(_("postcode"), max_length=10, blank=True)
-    country = models.CharField(_("country"), max_length=32, blank=True)
-    phone = PhoneNumberField(_("phone"), blank=True)
-    email = models.EmailField(_("email"), blank=True)
-    website = models.CharField(_("website"), max_length=64, blank=True)
-
-    class Meta:
-        verbose_name = _("company")
-
-    def is_owned_by(self, user):
-        """
-        Method to see if that object can be edited by the given user
-        """
-        if user.is_in_group(settings.SITH_GROUP_ACCOUNTING_ADMIN_ID):
-            return True
-        return False
-
-    def can_be_edited_by(self, user):
-        """
-        Method to see if that object can be edited by the given user
-        """
-        for club in user.memberships.filter(end_date=None).all():
-            if club and club.role == settings.SITH_CLUB_ROLES_ID["Treasurer"]:
-                return True
-        return False
-
-    def can_be_viewed_by(self, user):
-        """
-        Method to see if that object can be viewed by the given user
-        """
-        for club in user.memberships.filter(end_date=None).all():
-            if club and club.role >= settings.SITH_CLUB_ROLES_ID["Treasurer"]:
-                return True
-        return False
-
-    def get_absolute_url(self):
-        return reverse("accounting:co_edit", kwargs={"co_id": self.id})
-
-    def get_display_name(self):
-        return self.name
-
-    def __str__(self):
-        return self.name
-
-
-class BankAccount(models.Model):
-    name = models.CharField(_("name"), max_length=30)
-    iban = models.CharField(_("iban"), max_length=255, blank=True)
-    number = models.CharField(_("account number"), max_length=255, blank=True)
-    club = models.ForeignKey(Club, related_name="bank_accounts", verbose_name=_("club"))
-
-    class Meta:
-        verbose_name = _("Bank account")
-        ordering = ["club", "name"]
-
-    def is_owned_by(self, user):
-        """
-        Method to see if that object can be edited by the given user
-        """
-        if user.is_in_group(settings.SITH_GROUP_ACCOUNTING_ADMIN_ID):
-            return True
-        m = self.club.get_membership_for(user)
-        if m is not None and m.role >= settings.SITH_CLUB_ROLES_ID["Treasurer"]:
-            return True
-        return False
-
-    def get_absolute_url(self):
-        return reverse("accounting:bank_details", kwargs={"b_account_id": self.id})
-
-    def __str__(self):
-        return self.name
-
-
-class ClubAccount(models.Model):
-    name = models.CharField(_("name"), max_length=30)
-    club = models.ForeignKey(Club, related_name="club_account", verbose_name=_("club"))
-    bank_account = models.ForeignKey(
-        BankAccount, related_name="club_accounts", verbose_name=_("bank account")
-    )
-
-    class Meta:
-        verbose_name = _("Club account")
-        ordering = ["bank_account", "name"]
-
-    def is_owned_by(self, user):
-        """
-        Method to see if that object can be edited by the given user
-        """
-        if user.is_in_group(settings.SITH_GROUP_ACCOUNTING_ADMIN_ID):
-            return True
-        return False
-
-    def can_be_edited_by(self, user):
-        """
-        Method to see if that object can be edited by the given user
-        """
-        m = self.club.get_membership_for(user)
-        if m and m.role == settings.SITH_CLUB_ROLES_ID["Treasurer"]:
-            return True
-        return False
-
-    def can_be_viewed_by(self, user):
-        """
-        Method to see if that object can be viewed by the given user
-        """
-        m = self.club.get_membership_for(user)
-        if m and m.role >= settings.SITH_CLUB_ROLES_ID["Treasurer"]:
-            return True
-        return False
-
-    def has_open_journal(self):
-        for j in self.journals.all():
-            if not j.closed:
-                return True
-        return False
-
-    def get_open_journal(self):
-        return self.journals.filter(closed=False).first()
-
-    def get_absolute_url(self):
-        return reverse("accounting:club_details", kwargs={"c_account_id": self.id})
-
-    def __str__(self):
-        return self.name
-
-    def get_display_name(self):
-        return _("%(club_account)s on %(bank_account)s") % {
-            "club_account": self.name,
-            "bank_account": self.bank_account,
-        }
-
-
-class GeneralJournal(models.Model):
-    """
-    Class storing all the operations for a period of time
-    """
-
-    start_date = models.DateField(_("start date"))
-    end_date = models.DateField(_("end date"), null=True, blank=True, default=None)
-    name = models.CharField(_("name"), max_length=40)
-    closed = models.BooleanField(_("is closed"), default=False)
-    club_account = models.ForeignKey(
-        ClubAccount, related_name="journals", null=False, verbose_name=_("club account")
-    )
-    amount = CurrencyField(_("amount"), default=0)
-    effective_amount = CurrencyField(_("effective_amount"), default=0)
-
-    class Meta:
-        verbose_name = _("General journal")
-        ordering = ["-start_date"]
-
-    def is_owned_by(self, user):
-        """
-        Method to see if that object can be edited by the given user
-        """
-        if user.is_in_group(settings.SITH_GROUP_ACCOUNTING_ADMIN_ID):
-            return True
-        if self.club_account.can_be_edited_by(user):
-            return True
-        return False
-
-    def can_be_edited_by(self, user):
-        """
-        Method to see if that object can be edited by the given user
-        """
-        if user.is_in_group(settings.SITH_GROUP_ACCOUNTING_ADMIN_ID):
-            return True
-        if self.club_account.can_be_edited_by(user):
-            return True
-        return False
-
-    def can_be_viewed_by(self, user):
-        return self.club_account.can_be_viewed_by(user)
-
-    def get_absolute_url(self):
-        return reverse("accounting:journal_details", kwargs={"j_id": self.id})
-
-    def __str__(self):
-        return self.name
-
-    def update_amounts(self):
-        self.amount = 0
-        self.effective_amount = 0
-        for o in self.operations.all():
-            if o.accounting_type.movement_type == "CREDIT":
-                if o.done:
-                    self.effective_amount += o.amount
-                self.amount += o.amount
-            else:
-                if o.done:
-                    self.effective_amount -= o.amount
-                self.amount -= o.amount
-        self.save()
-
-
-class Operation(models.Model):
-    """
-    An operation is a line in the journal, a debit or a credit
-    """
-
-    number = models.IntegerField(_("number"))
-    journal = models.ForeignKey(
-        GeneralJournal, related_name="operations", null=False, verbose_name=_("journal")
-    )
-    amount = CurrencyField(_("amount"))
-    date = models.DateField(_("date"))
-    remark = models.CharField(_("comment"), max_length=128, null=True, blank=True)
-    mode = models.CharField(
-        _("payment method"),
-        max_length=255,
-        choices=settings.SITH_ACCOUNTING_PAYMENT_METHOD,
-    )
-    cheque_number = models.CharField(
-        _("cheque number"), max_length=32, default="", null=True, blank=True
-    )
-    invoice = models.ForeignKey(
-        SithFile,
-        related_name="operations",
-        verbose_name=_("invoice"),
-        null=True,
-        blank=True,
-    )
-    done = models.BooleanField(_("is done"), default=False)
-    simpleaccounting_type = models.ForeignKey(
-        "SimplifiedAccountingType",
-        related_name="operations",
-        verbose_name=_("simple type"),
-        null=True,
-        blank=True,
-    )
-    accounting_type = models.ForeignKey(
-        "AccountingType",
-        related_name="operations",
-        verbose_name=_("accounting type"),
-        null=True,
-        blank=True,
-    )
-    label = models.ForeignKey(
-        "Label",
-        related_name="operations",
-        verbose_name=_("label"),
-        null=True,
-        blank=True,
-        on_delete=models.SET_NULL,
-    )
-    target_type = models.CharField(
-        _("target type"),
-        max_length=10,
-        choices=[
-            ("USER", _("User")),
-            ("CLUB", _("Club")),
-            ("ACCOUNT", _("Account")),
-            ("COMPANY", _("Company")),
-            ("OTHER", _("Other")),
-        ],
-    )
-    target_id = models.IntegerField(_("target id"), null=True, blank=True)
-    target_label = models.CharField(
-        _("target label"), max_length=32, default="", blank=True
-    )
-    linked_operation = models.OneToOneField(
-        "self",
-        related_name="operation_linked_to",
-        verbose_name=_("linked operation"),
-        null=True,
-        blank=True,
-        default=None,
-    )
-
-    class Meta:
-        unique_together = ("number", "journal")
-        ordering = ["-number"]
-
-    def __getattribute__(self, attr):
-        if attr == "target":
-            return self.get_target()
-        else:
-            return object.__getattribute__(self, attr)
-
-    def clean(self):
-        super(Operation, self).clean()
-        if self.date is None:
-            raise ValidationError(_("The date must be set."))
-        elif self.date < self.journal.start_date:
-            raise ValidationError(
-                _(
-                    """The date can not be before the start date of the journal, which is
-%(start_date)s."""
-                )
-                % {
-                    "start_date": defaultfilters.date(
-                        self.journal.start_date, settings.DATE_FORMAT
-                    )
-                }
-            )
-        if self.target_type != "OTHER" and self.get_target() is None:
-            raise ValidationError(_("Target does not exists"))
-        if self.target_type == "OTHER" and self.target_label == "":
-            raise ValidationError(
-                _("Please add a target label if you set no existing target")
-            )
-        if not self.accounting_type and not self.simpleaccounting_type:
-            raise ValidationError(
-                _(
-                    "You need to provide ether a simplified accounting type or a standard accounting type"
-                )
-            )
-        if self.simpleaccounting_type:
-            self.accounting_type = self.simpleaccounting_type.accounting_type
-
-    @property
-    def target(self):
-        return self.get_target()
-
-    def get_target(self):
-        tar = None
-        if self.target_type == "USER":
-            tar = User.objects.filter(id=self.target_id).first()
-        elif self.target_type == "CLUB":
-            tar = Club.objects.filter(id=self.target_id).first()
-        elif self.target_type == "ACCOUNT":
-            tar = ClubAccount.objects.filter(id=self.target_id).first()
-        elif self.target_type == "COMPANY":
-            tar = Company.objects.filter(id=self.target_id).first()
-        return tar
-
-    def save(self):
-        if self.number is None:
-            self.number = self.journal.operations.count() + 1
-        super(Operation, self).save()
-        self.journal.update_amounts()
-
-    def is_owned_by(self, user):
-        """
-        Method to see if that object can be edited by the given user
-        """
-        if user.is_in_group(settings.SITH_GROUP_ACCOUNTING_ADMIN_ID):
-            return True
-        if self.journal.closed:
-            return False
-        m = self.journal.club_account.club.get_membership_for(user)
-        if m is not None and m.role >= settings.SITH_CLUB_ROLES_ID["Treasurer"]:
-            return True
-        return False
-
-    def can_be_edited_by(self, user):
-        """
-        Method to see if that object can be edited by the given user
-        """
-        if user.is_in_group(settings.SITH_GROUP_ACCOUNTING_ADMIN_ID):
-            return True
-        if self.journal.closed:
-            return False
-        m = self.journal.club_account.club.get_membership_for(user)
-        if m is not None and m.role == settings.SITH_CLUB_ROLES_ID["Treasurer"]:
-            return True
-        return False
-
-    def get_absolute_url(self):
-        return reverse("accounting:journal_details", kwargs={"j_id": self.journal.id})
-
-    def __str__(self):
-        return "%d € | %s | %s | %s" % (
-            self.amount,
-            self.date,
-            self.accounting_type,
-            self.done,
-        )
-
-
-class AccountingType(models.Model):
-    """
-    Class describing the accounting types.
-
-    Thoses are numbers used in accounting to classify operations
-    """
-
-    code = models.CharField(
-        _("code"),
-        max_length=16,
-        validators=[
-            validators.RegexValidator(
-                r"^[0-9]*$", _("An accounting type code contains only numbers")
-            )
-        ],
-    )
-    label = models.CharField(_("label"), max_length=128)
-    movement_type = models.CharField(
-        _("movement type"),
-        choices=[
-            ("CREDIT", _("Credit")),
-            ("DEBIT", _("Debit")),
-            ("NEUTRAL", _("Neutral")),
-        ],
-        max_length=12,
-    )
-
-    class Meta:
-        verbose_name = _("accounting type")
-        ordering = ["movement_type", "code"]
-
-    def is_owned_by(self, user):
-        """
-        Method to see if that object can be edited by the given user
-        """
-        if user.is_in_group(settings.SITH_GROUP_ACCOUNTING_ADMIN_ID):
-            return True
-        return False
-
-    def get_absolute_url(self):
-        return reverse("accounting:type_list")
-
-    def __str__(self):
-        return self.code + " - " + self.get_movement_type_display() + " - " + self.label
-
-
-class SimplifiedAccountingType(models.Model):
-    """
-    Class describing the simplified accounting types.
-    """
-
-    label = models.CharField(_("label"), max_length=128)
-    accounting_type = models.ForeignKey(
-        AccountingType,
-        related_name="simplified_types",
-        verbose_name=_("simplified accounting types"),
-    )
-
-    class Meta:
-        verbose_name = _("simplified type")
-        ordering = ["accounting_type__movement_type", "accounting_type__code"]
-
-    @property
-    def movement_type(self):
-        return self.accounting_type.movement_type
-
-    def get_movement_type_display(self):
-        return self.accounting_type.get_movement_type_display()
-
-    def get_absolute_url(self):
-        return reverse("accounting:simple_type_list")
-
-    def __str__(self):
-        return (
-            self.get_movement_type_display()
-            + " - "
-            + self.accounting_type.code
-            + " - "
-            + self.label
-        )
-
-
-class Label(models.Model):
-    """Label allow a club to sort its operations"""
-
-    name = models.CharField(_("label"), max_length=64)
-    club_account = models.ForeignKey(
-        ClubAccount, related_name="labels", verbose_name=_("club account")
-    )
-
-    class Meta:
-        unique_together = ("name", "club_account")
-
-    def __str__(self):
-        return "%s (%s)" % (self.name, self.club_account.name)
-
-    def get_absolute_url(self):
-        return reverse(
-            "accounting:label_list", kwargs={"clubaccount_id": self.club_account.id}
-        )
-
-    def is_owned_by(self, user):
-        return self.club_account.is_owned_by(user)
-
-    def can_be_edited_by(self, user):
-        return self.club_account.can_be_edited_by(user)
-
-    def can_be_viewed_by(self, user):
-        return self.club_account.can_be_viewed_by(user)

accounting/templates/accounting/accountingtype_list.jinja

@@ -1,27 +0,0 @@
-{% extends "core/base.jinja" %}
-
-{% block title %}
-{% trans %}Accounting type list{% endtrans %}
-{% endblock %}
-
-{% block content %}
-    <div id="accounting">
-        <p>
-        <a href="{{ url('accounting:bank_list') }}">{% trans %}Accounting{% endtrans %}</a> >
-        {% trans %}Accounting types{% endtrans %}
-        </p>
-        <hr>
-        <p><a href="{{ url('accounting:type_new') }}">{% trans %}New accounting type{% endtrans %}</a></p>
-        {% if accountingtype_list %}
-        <h3>{% trans %}Accounting type list{% endtrans %}</h3>
-        <ul>
-            {% for a in accountingtype_list  %}
-            <li><a href="{{ url('accounting:type_edit', type_id=a.id) }}">{{ a }}</a></li>
-            {% endfor %}
-        </ul>
-        {% else %}
-        {% trans %}There is no types in this website.{% endtrans %}
-        {% endif %}
-    </div>
-{% endblock %}
-

accounting/templates/accounting/bank_account_details.jinja

@@ -1,38 +0,0 @@
-{% extends "core/base.jinja" %}
-
-{% block title %}
-{% trans %}Bank account: {% endtrans %}{{ object.name }}
-{% endblock %}
-
-{% block content %}
-    <div id="accounting">
-        <p>
-        <a href="{{ url('accounting:bank_list') }}">{% trans %}Accounting{% endtrans %}</a> >
-        {{ object.name }}
-        </p>
-        <hr>
-        <h2>{% trans %}Bank account: {% endtrans %}{{ object.name }}</h2>
-        {% if user.is_in_group(settings.SITH_GROUP_ACCOUNTING_ADMIN_ID) and not object.club_accounts.exists() %}
-        <a href="{{ url('accounting:bank_delete', b_account_id=object.id) }}">{% trans %}Delete{% endtrans %}</a>
-        {% endif %}
-        <h4>{% trans %}Infos{% endtrans %}</h4>
-        <ul>
-            <li><strong>{% trans %}IBAN: {% endtrans %}</strong>{{ object.iban }}</li>
-            <li><strong>{% trans %}Number: {% endtrans %}</strong>{{ object.number }}</li>
-        </ul>
-        <p><a href="{{ url('accounting:club_new') }}?parent={{ object.id }}">{% trans %}New club account{% endtrans %}</a></p>
-        <ul>
-        {% for c in object.club_accounts.all() %}
-            <li><a href="{{ url('accounting:club_details', c_account_id=c.id) }}">{{ c }}</a>
-                - <a href="{{ url('accounting:club_edit', c_account_id=c.id) }}">{% trans %}Edit{% endtrans %}</a>
-                {% if c.journals.count() == 0 %}
-                - <a href="{{ url('accounting:club_delete', c_account_id=c.id) }}">{% trans %}Delete{% endtrans %}</a>
-                {% endif %}
-                </li>
-        {% endfor %}
-        </ul>
-    </div>
-{% endblock %}
-
-
-

accounting/templates/accounting/bank_account_list.jinja

@@ -1,33 +0,0 @@
-{% extends "core/base.jinja" %}
-
-{% block title %}
-{% trans %}Bank account list{% endtrans %}
-{% endblock %}
-
-{% block content %}
-    <div id="accounting">
-        <h4>
-        {% trans %}Accounting{% endtrans %}
-        </h4>
-        {% if user.is_in_group(settings.SITH_GROUP_ACCOUNTING_ADMIN_ID) %}
-        <p><a href="{{ url('accounting:simple_type_list') }}">{% trans %}Manage simplified types{% endtrans %}</a></p>
-        <p><a href="{{ url('accounting:type_list') }}">{% trans %}Manage accounting types{% endtrans %}</a></p>
-        <p><a href="{{ url('accounting:bank_new') }}">{% trans %}New bank account{% endtrans %}</a></p>
-        {% endif %}
-        {% if bankaccount_list %}
-        <h3>{% trans %}Bank account list{% endtrans %}</h3>
-            <ul>
-                {% for a in object_list  %}
-                <li><a href="{{ url('accounting:bank_details', b_account_id=a.id) }}">{{ a }}</a>
-                    - <a href="{{ url('accounting:bank_edit', b_account_id=a.id) }}">{% trans %}Edit{% endtrans %}</a>
-                </li>
-                {% endfor %}
-            </ul>
-        {% else %}
-        {% trans %}There is no accounts in this website.{% endtrans %}
-        {% endif %}
-    </div>
-{% endblock %}
-
-
-

accounting/templates/accounting/club_account_details.jinja

@@ -1,68 +0,0 @@
-{% extends "core/base.jinja" %}
-
-{% block title %}
-{% trans %}Club account:{% endtrans %} {{ object.name }}
-{% endblock %}
-
-{% block content %}
-    <div id="accounting">
-        <p>
-        <a href="{{ url('accounting:bank_list') }}">{% trans %}Accounting{% endtrans %}</a> >
-        <a href="{{ url('accounting:bank_details', b_account_id=object.bank_account.id) }}">{{object.bank_account }}</a> >
-        {{ object }}
-        </p>
-        <hr>
-        <h2>{% trans %}Club account:{% endtrans %} {{ object.name }}</h2>
-        {% if user.is_root and not object.journals.exists() %}
-        <a href="{{ url('accounting:club_delete', c_account_id=object.id) }}">{% trans %}Delete{% endtrans %}</a>
-        {% endif %}
-        {% if user.is_in_group(settings.SITH_GROUP_ACCOUNTING_ADMIN_ID) %}
-        <p><a href="{{ url('accounting:label_new') }}?parent={{ object.id }}">{% trans %}New label{% endtrans %}</a></p>
-        {% endif %}
-        <p><a href="{{ url('accounting:label_list', clubaccount_id=object.id) }}">{% trans %}Label list{% endtrans %}</a></p>
-        {% if not object.has_open_journal() %}
-        <p><a href="{{ url('accounting:journal_new') }}?parent={{ object.id }}">{% trans %}New journal{% endtrans %}</a></p>
-        {% else %}
-        <p>{% trans %}You can not create new journal while you still have one opened{% endtrans %}</p>
-        {% endif %}
-        <table>
-            <thead>
-            <tr>
-                <td>{% trans %}Name{% endtrans %}</td>
-                <td>{% trans %}Start{% endtrans %}</td>
-                <td>{% trans %}End{% endtrans %}</td>
-                <td>{% trans %}Amount{% endtrans %}</td>
-                <td>{% trans %}Effective amount{% endtrans %}</td>
-                <td>{% trans %}Closed{% endtrans %}</td>
-                <td>{% trans %}Actions{% endtrans %}</td>
-            </tr>
-            </thead>
-            <tbody>
-            {% for j in object.journals.all() %}
-            <tr>
-                <td>{{ j.name }}</td>
-                <td>{{ j.start_date }}</td>
-                {% if j.end_date %}
-                <td>{{ j.end_date }}</td>
-                {% else %}
-                <td> - </td>
-                {% endif %}
-                <td>{{ j.amount }} €</td>
-                <td>{{ j.effective_amount }} €</td>
-                {% if j.closed %}
-                <td>{% trans %}Yes{% endtrans %}</td>
-                {% else %}
-                <td>{% trans %}No{% endtrans %}</td>
-                {% endif %}
-                <td> <a href="{{ url('accounting:journal_details', j_id=j.id) }}">{% trans %}View{% endtrans %}</a>
-                    <a href="{{ url('accounting:journal_edit', j_id=j.id) }}">{% trans %}Edit{% endtrans %}</a>
-                    {% if user.is_in_group(settings.SITH_GROUP_ACCOUNTING_ADMIN_ID) and j.operations.count() == 0 %}
-                        <a href="{{ url('accounting:journal_delete', j_id=j.id) }}">{% trans %}Delete{% endtrans %}</a>
-                    {% endif %}
-                    </td>
-            </tr>
-            {% endfor %}
-            </tbody>
-        </table>
-    </div>
-{% endblock %}

accounting/templates/accounting/co_list.jinja

@@ -1,29 +0,0 @@
-{% extends "core/base.jinja" %}
-
-{% block title %}
-{% trans %}Company list{% endtrans %}
-{% endblock %}
-
-{% block content %}
-    <div id="accounting">
-        {% if user.is_in_group(settings.SITH_GROUP_ACCOUNTING_ADMIN_ID) or user.is_root %}
-        <p><a href="{{ url('accounting:co_new') }}">{% trans %}Create new company{% endtrans %}</a></p>
-        {% endif %}
-
-        </br>
-        <table>
-            <thead>
-            <tr>
-                <td>{% trans %}Companies{% endtrans %}</td>
-            </tr>
-            </thead>
-            <tbody>
-                {% for o in object_list %}
-                    <tr>
-                        <td><a href="{{ url('accounting:co_edit', co_id=o.id) }}">{{ o.get_display_name() }}</a></td>
-                    </tr>
-                {% endfor %}
-            </tbody>
-        </table>
-    </div>
-{% endblock %}

accounting/templates/accounting/journal_details.jinja

@@ -1,100 +0,0 @@
-{% extends "core/base.jinja" %}
-
-{% block title %}
-{% trans %}General journal:{% endtrans %} {{ object.name }}
-{% endblock %}
-
-{% block content %}
-    <div id="accounting">
-        <p>
-        <a href="{{ url('accounting:bank_list') }}">{% trans %}Accounting{% endtrans %}</a> >
-        <a href="{{ url('accounting:bank_details', b_account_id=object.club_account.bank_account.id) }}">{{object.club_account.bank_account }}</a> >
-        <a href="{{ url('accounting:club_details', c_account_id=object.club_account.id) }}">{{ object.club_account }}</a> >
-        {{ object.name }}
-        </p>
-        <hr>
-        <h2>{% trans %}General journal:{% endtrans %} {{ object.name }}</h2>
-        <p><a href="{{ url('accounting:label_new') }}?parent={{ object.club_account.id }}">{% trans %}New label{% endtrans %}</a></p>
-        <p><a href="{{ url('accounting:label_list', clubaccount_id=object.club_account.id) }}">{% trans %}Label list{% endtrans %}</a></p>
-        <p><a href="{{ url('accounting:co_list') }}">{% trans %}Company list{% endtrans %}</a></p>
-        <p><strong>{% trans %}Amount: {% endtrans %}</strong>{{ object.amount }} € -
-        <strong>{% trans %}Effective amount: {% endtrans %}</strong>{{ object.effective_amount }} €</p>
-        {% if object.closed %}
-        <p>{% trans %}Journal is closed, you can not create operation{% endtrans %}</p>
-        {% else %}
-        <p><a href="{{ url('accounting:op_new', j_id=object.id) }}">{% trans %}New operation{% endtrans %}</a></p>
-        </br>
-        {% endif %}
-        <div class="journal-table">
-        <table>
-            <thead>
-            <tr>
-                <td>{% trans %}Nb{% endtrans %}</td>
-                <td>{% trans %}Date{% endtrans %}</td>
-                <td>{% trans %}Label{% endtrans %}</td>
-                <td>{% trans %}Amount{% endtrans %}</td>
-                <td>{% trans %}Payment mode{% endtrans %}</td>
-                <td>{% trans %}Target{% endtrans %}</td>
-                <td>{% trans %}Code{% endtrans %}</td>
-                <td>{% trans %}Nature{% endtrans %}</td>
-                <td>{% trans %}Done{% endtrans %}</td>
-                <td>{% trans %}Comment{% endtrans %}</td>
-                <td>{% trans %}File{% endtrans %}</td>
-                <td>{% trans %}Actions{% endtrans %}</td>
-                <td>{% trans %}PDF{% endtrans %}</td>
-            </tr>
-            </thead>
-            <tbody>
-            {% for o in object.operations.all() %}
-            <tr>
-                <td>{{ o.number }}</td>
-                <td>{{ o.date }}</td>
-                <td>{{ o.label or "" }}</td>
-                {% if o.accounting_type.movement_type == "DEBIT" %}
-                    <td class="neg-amount">&nbsp;{{ o.amount }}&nbsp;€</td>
-                {% else %}
-                    <td class="pos-amount">&nbsp;{{ o.amount }}&nbsp;€</td>
-                {% endif %}
-                <td>{{ o.get_mode_display() }}</td>
-                {% if o.target_type == "OTHER" %}
-                <td>{{ o.target_label }}</td>
-                {% else %}
-                <td><a href="{{ o.target.get_absolute_url() }}">{{ o.target.get_display_name() }}</a></td>
-                {% endif %}
-                <td>{{ o.accounting_type.code }}</td>
-                <td>{{ o.accounting_type.label }}</td>
-                {% if o.done %}
-                <td>{% trans %}Yes{% endtrans %}</td>
-                {% else %}
-                <td>{% trans %}No{% endtrans %}</td>
-                {% endif %}
-                <td>{{ o.remark }}
-                {% if not o.linked_operation and o.target_type == "ACCOUNT" and not o.target.has_open_journal() %}
-                    <p><strong>
-    {% trans %}Warning: this operation has no linked operation because the targeted club account has no opened journal.{% endtrans %}
-                </strong></p>
-                <p><strong>
-    {% trans url=o.target.get_absolute_url() %}Open a journal in <a href="{{ url }}">this club account</a>, then save this operation again to make the linked operation.{% endtrans %}
-            </strong></p>
-                {% endif %}
-                </td>
-                {% if o.invoice %}
-                <td><a href="{{ url('core:download', file_id=o.invoice.id) }}">{{ o.invoice.name }}</a></td>
-                {% else %}
-                <td>-</td>
-                {% endif %}
-                <td>
-                    {% if o.journal.club_account.bank_account.name != "AE TI" and o.journal.club_account.bank_account.name != "TI" or user.is_in_group(settings.SITH_GROUP_ACCOUNTING_ADMIN_ID) %}
-                    {% if not o.journal.closed %}
-                    <a href="{{ url('accounting:op_edit', op_id=o.id) }}">{% trans %}Edit{% endtrans %}</a>
-                    {% endif %}
-                    {% endif %}
-                </td>
-                <td><a href="{{ url('accounting:op_pdf', op_id=o.id) }}">{% trans %}Generate{% endtrans %}</a></td>
-            </tr>
-            {% endfor %}
-            </tbody>
-        </table>
-        </div>
-    </div>
-{% endblock %}

accounting/templates/accounting/journal_statement_accounting.jinja

@@ -1,33 +0,0 @@
-{% extends "core/base.jinja" %}
-
-{% block title %}
-{% trans %}General journal:{% endtrans %} {{ object.name }}
-{% endblock %}
-
-
-{% block content %}
-<div id="accounting">
-    <h3>{% trans %}Accounting statement: {% endtrans %} {{ object.name }}</h3>
-
-    <table>
-        <thead>
-            <tr>
-                <td>{% trans %}Operation type{% endtrans %}</td>
-                <td>{% trans %}Sum{% endtrans %}</td>
-            </tr>
-        </thead>
-        <tbody>
-            {% for k,v in statement.items() %}
-            <tr>
-                <td>{{ k }}</td>
-                <td>{{ v }}</td>
-            </tr>
-            {% endfor %}
-        </tbody>
-
-    </table>
-
-    <p><strong>{% trans %}Amount: {% endtrans %}</strong>{{ object.amount }} €</p>
-    <p><strong>{% trans %}Effective amount: {% endtrans %}</strong>{{ object.effective_amount }} €</p>
-</div>
-{% endblock %}

accounting/templates/accounting/journal_statement_nature.jinja

@@ -1,57 +0,0 @@
-{% extends "core/base.jinja" %}
-
-{% block title %}
-{% trans %}General journal:{% endtrans %} {{ object.name }}
-{% endblock %}
-
-{% macro display_tables(dict) %}
-<div id="accounting">
-    <h6>{% trans %}Credit{% endtrans %}</h6>
-    <table>
-        <thead>
-            <tr>
-                <td>{% trans %}Nature of operation{% endtrans %}</td>
-                <td>{% trans %}Sum{% endtrans %}</td>
-            </tr>
-        </thead>
-        <tbody>
-            {% for k,v in dict['CREDIT'].items() %}
-            <tr>
-                <td>{{ k }}</td>
-                <td>{{ v }}</td>
-            </tr>
-            {% endfor %}
-        </tbody>
-    </table>
-    {% trans %}Total: {% endtrans %}{{ dict['CREDIT_sum'] }}
-
-    <h6>{% trans %}Debit{% endtrans %}</h6>
-    <table>
-        <thead>
-            <tr>
-                <td>{% trans %}Nature of operation{% endtrans %}</td>
-                <td>{% trans %}Sum{% endtrans %}</td>
-            </tr>
-        </thead>
-        <tbody>
-            {% for k,v in dict['DEBIT'].items() %}
-            <tr>
-                <td>{{ k }}</td>
-                <td>{{ v }}</td>
-            </tr>
-            {% endfor %}
-        </tbody>
-    </table>
-    {% trans %}Total: {% endtrans %}{{ dict['DEBIT_sum'] }}
-    {% endmacro %}
-
-    {% block content %}
-    <h3>{% trans %}Statement by nature: {% endtrans %} {{ object.name }}</h3>
-
-    {% for k,v in statement.items() %}
-        <h4 style="background: lightblue; padding: 4px;">{{ k }} : {{ v['CREDIT_sum'] - v['DEBIT_sum'] }}</h4>
-    {{ display_tables(v) }}
-    <hr>
-    {% endfor %}
-</div>
-{% endblock %}

accounting/templates/accounting/journal_statement_person.jinja

@@ -1,68 +0,0 @@
-{% extends "core/base.jinja" %}
-
-{% block title %}
-{% trans %}General journal:{% endtrans %} {{ object.name }}
-{% endblock %}
-
-
-{% block content %}
-<div id="accounting">
-    <h3>{% trans %}Statement by person: {% endtrans %} {{ object.name }}</h3>
-
-    <h4>{% trans %}Credit{% endtrans %}</h4>
-
-    <table>
-        <thead>
-            <tr>
-                <td>{% trans %}Target of the operation{% endtrans %}</td>
-                <td>{% trans %}Sum{% endtrans %}</td>
-            </tr>
-        </thead>
-        <tbody>
-            {% for key in credit_statement.keys() %}
-            <tr>
-                {% if key.target_type == "OTHER" %}
-                <td>{{ o.target_label }}</td>
-                {% elif key %}
-                <td><a href="{{ key.get_absolute_url() }}">{{ key.get_display_name() }}</a></td>
-                {% else %}
-                <td></td>
-                {% endif %}
-                <td>{{ credit_statement[key] }}</td>
-            </tr>
-            {% endfor %}
-        </tbody>
-
-    </table>
-
-    <p>Total : {{ total_credit }}</p>
-
-    <h4>{% trans %}Debit{% endtrans %}</h4>
-
-    <table>
-        <thead>
-            <tr>
-                <td>{% trans %}Target of the operation{% endtrans %}</td>
-                <td>{% trans %}Sum{% endtrans %}</td>
-            </tr>
-        </thead>
-        <tbody>
-            {% for key in debit_statement.keys() %}
-            <tr>
-                {% if key.target_type == "OTHER" %}
-                <td>{{ o.target_label }}</td>
-                {% elif key %}
-                <td><a href="{{ key.get_absolute_url() }}">{{ key.get_display_name() }}</a></td>
-                {% else %}
-                <td></td>
-                {% endif %}
-                <td>{{ debit_statement[key] }}</td>
-            </tr>
-            {% endfor %}
-        </tbody>
-
-    </table>
-
-    <p>Total : {{ total_debit }}</p>
-</div>
-{% endblock %}

accounting/templates/accounting/label_list.jinja

@@ -1,36 +0,0 @@
-{% extends "core/base.jinja" %}
-
-{% block title %}
-{% trans %}Label list{% endtrans %}
-{% endblock %}
-
-{% block content %}
-    <div id="accounting">
-        <p>
-        <a href="{{ url('accounting:bank_list') }}">{% trans %}Accounting{% endtrans %}</a> >
-        <a href="{{ url('accounting:bank_details', b_account_id=object.bank_account.id) }}">{{object.bank_account }}</a> >
-        <a href="{{ url('accounting:club_details', c_account_id=object.id) }}">{{ object }}</a>
-        </p>
-        <hr>
-        <p><a href="{{ url('accounting:club_details', c_account_id=object.id) }}">{% trans %}Back to club account{% endtrans %}</a></p>
-        {% if user.is_in_group(settings.SITH_GROUP_ACCOUNTING_ADMIN_ID) %}
-        <p><a href="{{ url('accounting:label_new') }}?parent={{ object.id }}">{% trans %}New label{% endtrans %}</a></p>
-        {% endif %}
-        {% if object.labels.all() %}
-        <h3>{% trans %}Label list{% endtrans %}</h3>
-        <ul>
-            {% for l in object.labels.all()  %}
-            <li><a href="{{ url('accounting:label_edit', label_id=l.id) }}">{{ l }}</a>
-            {% if user.is_in_group(settings.SITH_GROUP_ACCOUNTING_ADMIN_ID) %}
-             -
-                <a href="{{ url('accounting:label_delete', label_id=l.id) }}">{% trans %}Delete{% endtrans %}</a>
-            {% endif %}
-            </li>
-            {% endfor %}
-        </ul>
-        {% else %}
-        {% trans %}There is no label in this club account.{% endtrans %}
-        {% endif %}
-    </div>
-{% endblock %}
-

accounting/templates/accounting/operation_edit.jinja

@@ -1,123 +0,0 @@
-{% extends "core/base.jinja" %}
-
-{% block title %}
-{% trans %}Edit operation{% endtrans %}
-{% endblock %}
-
-{% block content %}
-<div id="accounting">
-    <p>
-    <a href="{{ url('accounting:bank_list') }}">{% trans %}Accounting{% endtrans %}</a> >
-    <a href="{{ url('accounting:bank_details', b_account_id=object.club_account.bank_account.id) }}">{{object.club_account.bank_account }}</a> >
-    <a href="{{ url('accounting:club_details', c_account_id=object.club_account.id) }}">{{ object.club_account }}</a> >
-    <a href="{{ url('accounting:journal_details', j_id=object.id) }}">{{ object.name }}</a> >
-    {% trans %}Edit operation{% endtrans %}
-    </p>
-    <hr>
-    <h2>{% trans %}Edit operation{% endtrans %}</h2>
-    <form action="" method="post">
-        {% csrf_token %}
-        {{ form.non_field_errors() }}
-        {{ form.journal }}
-        {{ form.target_id }}
-        <p>{{ form.amount.errors }}<label for="{{ form.amount.name }}">{{ form.amount.label }}</label> {{ form.amount }}</p>
-        <p>{{ form.remark.errors }}<label for="{{ form.remark.name }}">{{ form.remark.label }}</label> {{ form.remark }}</p>
-        <br />
-        <strong>{% trans %}Warning: if you select <em>Account</em>, the opposite operation will be created in the target account. If you don't want that, select <em>Club</em> instead of <em>Account</em>.{% endtrans %}</strong>
-        <p>{{ form.target_type.errors }}<label for="{{ form.target_type.name }}">{{ form.target_type.label }}</label> {{ form.target_type }}</p>
-            {{ form.user }}
-            {{ form.club }}
-            {{ form.club_account }}
-            {{ form.company }}
-            {{ form.target_label }}
-            <span id="id_need_link_full"><label>{{ form.need_link.label }}</label> {{ form.need_link }}</span>
-        <p>{{ form.date.errors }}<label for="{{ form.date.name }}">{{ form.date.label }}</label> {{ form.date }}</p>
-        <p>{{ form.mode.errors }}<label for="{{ form.mode.name }}">{{ form.mode.label }}</label> {{ form.mode }}</p>
-        <p>{{ form.cheque_number.errors }}<label for="{{ form.cheque_number.name }}">{{ form.cheque_number.label }}</label> {{
-        form.cheque_number }}</p>
-        <p>{{ form.invoice.errors }}<label for="{{ form.invoice.name }}">{{ form.invoice.label }}</label> {{ form.invoice }}</p>
-        <p>{{ form.simpleaccounting_type.errors }}<label for="{{ form.simpleaccounting_type.name }}">{{
-            form.simpleaccounting_type.label }}</label> {{ form.simpleaccounting_type }}</p>
-        <p>{{ form.accounting_type.errors }}<label for="{{ form.accounting_type.name }}">{{ form.accounting_type.label }}</label> {{
-        form.accounting_type }}</p>
-        <p>{{ form.label.errors }}<label for="{{ form.label.name }}">{{ form.label.label }}</label> {{ form.label }}</p>
-        <p>{{ form.done.errors }}<label for="{{ form.done.name }}">{{ form.done.label }}</label> {{ form.done }}</p>
-        {% if form.instance.linked_operation %}
-        {% set obj = form.instance.linked_operation %}
-        <p><strong>{% trans %}Linked operation:{% endtrans %}</strong><br>
-        <a href="{{ url('accounting:bank_details', b_account_id=obj.journal.club_account.bank_account.id) }}">
-                {{obj.journal.club_account.bank_account }}</a> >
-        <a href="{{ url('accounting:club_details', c_account_id=obj.journal.club_account.id) }}">{{ obj.journal.club_account }}</a> >
-        <a href="{{ url('accounting:journal_details', j_id=obj.journal.id) }}">{{ obj.journal }}</a> >
-        n°{{ obj.number }}
-        </p>
-        {% endif %}
-        <p><input type="submit" value="{% trans %}Save{% endtrans %}" /></p>
-    </form>
-    {% endblock %}
-
-    {% block script %}
-        {{ super() }}
-    <script>
-    $( function() {
-            var target_type = $('#id_target_type');
-            var user = $('#id_user_wrapper');
-            var club = $('#id_club_wrapper');
-            var club_account = $('#id_club_account_wrapper');
-            var company = $('#id_company_wrapper');
-            var other = $('#id_target_label');
-            var need_link = $('#id_need_link_full');
-            function update_targets () {
-                if (target_type.val() == "USER") {
-                    console.log(user);
-                    user.show();
-                    club.hide();
-                    club_account.hide();
-                    company.hide();
-                    other.hide();
-                    need_link.hide();
-                } else if (target_type.val() == "ACCOUNT") {
-                    club_account.show();
-                    need_link.show();
-                    user.hide();
-                    club.hide();
-                    company.hide();
-                    other.hide();
-                } else if (target_type.val() == "CLUB") {
-                    club.show();
-                    user.hide();
-                    club_account.hide();
-                    company.hide();
-                    other.hide();
-                    need_link.hide();
-                } else if (target_type.val() == "COMPANY") {
-                    company.show();
-                    user.hide();
-                    club_account.hide();
-                    club.hide();
-                    other.hide();
-                    need_link.hide();
-                } else if (target_type.val() == "OTHER") {
-                    other.show();
-                    user.hide();
-                    club.hide();
-                    club_account.hide();
-                    company.hide();
-                    need_link.hide();
-                } else {
-                    company.hide();
-                    user.hide();
-                    club_account.hide();
-                    club.hide();
-                    other.hide();
-                    need_link.hide();
-                }
-            }
-            update_targets();
-            target_type.change(update_targets);
-            } );
-    </script>
-</div>
-{% endblock %}
-
-

accounting/templates/accounting/refound_account.jinja

@@ -1,16 +0,0 @@
-{% extends "core/base.jinja" %}
-
-{% block title %}
-{% trans %}Refound account{% endtrans %}
-{% endblock %}
-
-{% block content %}
-	<div id="accounting">
-	    <h3>{% trans %}Refound account{% endtrans %}</h3>
-	    <form action="" method="post">
-	        {% csrf_token %}
-	        {{ form.as_p() }}
-	        <p><input type="submit" value="{% trans %}Refound{% endtrans %}" /></p>
-	    </form>
-	</div>
-{% endblock %}

accounting/templates/accounting/simplifiedaccountingtype_list.jinja

@@ -1,27 +0,0 @@
-{% extends "core/base.jinja" %}
-
-{% block title %}
-{% trans %}Simplified type list{% endtrans %}
-{% endblock %}
-
-{% block content %}
-    <div id="accounting">
-        <p>
-        <a href="{{ url('accounting:bank_list') }}">{% trans %}Accounting{% endtrans %}</a> >
-        {% trans %}Simplified types{% endtrans %}
-        </p>
-        <hr>
-        <p><a href="{{ url('accounting:simple_type_new') }}">{% trans %}New simplified type{% endtrans %}</a></p>
-        {% if simplifiedaccountingtype_list %}
-        <h3>{% trans %}Simplified type list{% endtrans %}</h3>
-        <ul>
-            {% for a in simplifiedaccountingtype_list  %}
-            <li><a href="{{ url('accounting:simple_type_edit', type_id=a.id) }}">{{ a }}</a></li>
-            {% endfor %}
-        </ul>
-        {% else %}
-        {% trans %}There is no types in this website.{% endtrans %}
-        {% endif %}
-    </div>
-{% endblock %}
-

accounting/tests.py

@@ -1,301 +0,0 @@
-# -*- coding:utf-8 -*
-#
-# Copyright 2016,2017
-# - Skia <skia@libskia.so>
-#
-# Ce fichier fait partie du site de l'Association des Étudiants de l'UTBM,
-# http://ae.utbm.fr.
-#
-# This program is free software; you can redistribute it and/or modify it under
-# the terms of the GNU General Public License a published by the Free Software
-# Foundation; either version 3 of the License, or (at your option) any later
-# version.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
-# details.
-#
-# You should have received a copy of the GNU General Public License along with
-# this program; if not, write to the Free Sofware Foundation, Inc., 59 Temple
-# Place - Suite 330, Boston, MA 02111-1307, USA.
-#
-#
-
-from django.test import TestCase
-from django.core.urlresolvers import reverse
-from django.core.management import call_command
-from datetime import date
-
-from core.models import User
-from accounting.models import (
-    GeneralJournal,
-    Operation,
-    Label,
-    AccountingType,
-    SimplifiedAccountingType,
-)
-
-
-class RefoundAccountTest(TestCase):
-    def setUp(self):
-        call_command("populate")
-        self.skia = User.objects.filter(username="skia").first()
-        # reffil skia's account
-        self.skia.customer.amount = 800
-        self.skia.customer.save()
-
-    def test_permission_denied(self):
-        self.client.login(username="guy", password="plop")
-        response_post = self.client.post(
-            reverse("accounting:refound_account"), {"user": self.skia.id}
-        )
-        response_get = self.client.get(reverse("accounting:refound_account"))
-        self.assertTrue(response_get.status_code == 403)
-        self.assertTrue(response_post.status_code == 403)
-
-    def test_root_granteed(self):
-        self.client.login(username="root", password="plop")
-        response_post = self.client.post(
-            reverse("accounting:refound_account"), {"user": self.skia.id}
-        )
-        self.skia = User.objects.filter(username="skia").first()
-        response_get = self.client.get(reverse("accounting:refound_account"))
-        self.assertFalse(response_get.status_code == 403)
-        self.assertTrue('<form action="" method="post">' in str(response_get.content))
-        self.assertFalse(response_post.status_code == 403)
-        self.assertTrue(self.skia.customer.amount == 0)
-
-    def test_comptable_granteed(self):
-        self.client.login(username="comptable", password="plop")
-        response_post = self.client.post(
-            reverse("accounting:refound_account"), {"user": self.skia.id}
-        )
-        self.skia = User.objects.filter(username="skia").first()
-        response_get = self.client.get(reverse("accounting:refound_account"))
-        self.assertFalse(response_get.status_code == 403)
-        self.assertTrue('<form action="" method="post">' in str(response_get.content))
-        self.assertFalse(response_post.status_code == 403)
-        self.assertTrue(self.skia.customer.amount == 0)
-
-
-class JournalTest(TestCase):
-    def setUp(self):
-        call_command("populate")
-        self.journal = GeneralJournal.objects.filter(id=1).first()
-
-    def test_permission_granted(self):
-        self.client.login(username="comptable", password="plop")
-        response_get = self.client.get(
-            reverse("accounting:journal_details", args=[self.journal.id])
-        )
-
-        self.assertTrue(response_get.status_code == 200)
-        self.assertTrue(
-            "<td>M\\xc3\\xa9thode de paiement</td>" in str(response_get.content)
-        )
-
-    def test_permission_not_granted(self):
-        self.client.login(username="skia", password="plop")
-        response_get = self.client.get(
-            reverse("accounting:journal_details", args=[self.journal.id])
-        )
-
-        self.assertTrue(response_get.status_code == 403)
-        self.assertFalse(
-            "<td>M\xc3\xa9thode de paiement</td>" in str(response_get.content)
-        )
-
-
-class OperationTest(TestCase):
-    def setUp(self):
-        call_command("populate")
-        self.journal = GeneralJournal.objects.filter(id=1).first()
-        self.skia = User.objects.filter(username="skia").first()
-        at = AccountingType(
-            code="443", label="Ce code n'existe pas", movement_type="CREDIT"
-        )
-        at.save()
-        l = Label(club_account=self.journal.club_account, name="bob")
-        l.save()
-        self.client.login(username="comptable", password="plop")
-        self.op1 = Operation(
-            journal=self.journal,
-            date=date.today(),
-            amount=1,
-            remark="Test bilan",
-            mode="CASH",
-            done=True,
-            label=l,
-            accounting_type=at,
-            target_type="USER",
-            target_id=self.skia.id,
-        )
-        self.op1.save()
-        self.op2 = Operation(
-            journal=self.journal,
-            date=date.today(),
-            amount=2,
-            remark="Test bilan",
-            mode="CASH",
-            done=True,
-            label=l,
-            accounting_type=at,
-            target_type="USER",
-            target_id=self.skia.id,
-        )
-        self.op2.save()
-
-    def test_new_operation(self):
-        self.client.login(username="comptable", password="plop")
-        at = AccountingType.objects.filter(code="604").first()
-        response = self.client.post(
-            reverse("accounting:op_new", args=[self.journal.id]),
-            {
-                "amount": 30,
-                "remark": "Un gros test",
-                "journal": self.journal.id,
-                "target_type": "OTHER",
-                "target_id": "",
-                "target_label": "Le fantome de la nuit",
-                "date": "04/12/2020",
-                "mode": "CASH",
-                "cheque_number": "",
-                "invoice": "",
-                "simpleaccounting_type": "",
-                "accounting_type": at.id,
-                "label": "",
-                "done": False,
-            },
-        )
-        self.assertFalse(response.status_code == 403)
-        self.assertTrue(
-            self.journal.operations.filter(
-                target_label="Le fantome de la nuit"
-            ).exists()
-        )
-        response_get = self.client.get(
-            reverse("accounting:journal_details", args=[self.journal.id])
-        )
-        self.assertTrue("<td>Le fantome de la nuit</td>" in str(response_get.content))
-
-    def test_bad_new_operation(self):
-        self.client.login(username="comptable", password="plop")
-        AccountingType.objects.filter(code="604").first()
-        response = self.client.post(
-            reverse("accounting:op_new", args=[self.journal.id]),
-            {
-                "amount": 30,
-                "remark": "Un gros test",
-                "journal": self.journal.id,
-                "target_type": "OTHER",
-                "target_id": "",
-                "target_label": "Le fantome de la nuit",
-                "date": "04/12/2020",
-                "mode": "CASH",
-                "cheque_number": "",
-                "invoice": "",
-                "simpleaccounting_type": "",
-                "accounting_type": "",
-                "label": "",
-                "done": False,
-            },
-        )
-        self.assertTrue(
-            "Vous devez fournir soit un type comptable simplifi\\xc3\\xa9 ou un type comptable standard"
-            in str(response.content)
-        )
-
-    def test_new_operation_not_authorized(self):
-        self.client.login(username="skia", password="plop")
-        at = AccountingType.objects.filter(code="604").first()
-        response = self.client.post(
-            reverse("accounting:op_new", args=[self.journal.id]),
-            {
-                "amount": 30,
-                "remark": "Un gros test",
-                "journal": self.journal.id,
-                "target_type": "OTHER",
-                "target_id": "",
-                "target_label": "Le fantome du jour",
-                "date": "04/12/2020",
-                "mode": "CASH",
-                "cheque_number": "",
-                "invoice": "",
-                "simpleaccounting_type": "",
-                "accounting_type": at.id,
-                "label": "",
-                "done": False,
-            },
-        )
-        self.assertTrue(response.status_code == 403)
-        self.assertFalse(
-            self.journal.operations.filter(target_label="Le fantome du jour").exists()
-        )
-
-    def test__operation_simple_accounting(self):
-        self.client.login(username="comptable", password="plop")
-        sat = SimplifiedAccountingType.objects.all().first()
-        response = self.client.post(
-            reverse("accounting:op_new", args=[self.journal.id]),
-            {
-                "amount": 23,
-                "remark": "Un gros test",
-                "journal": self.journal.id,
-                "target_type": "OTHER",
-                "target_id": "",
-                "target_label": "Le fantome de l'aurore",
-                "date": "04/12/2020",
-                "mode": "CASH",
-                "cheque_number": "",
-                "invoice": "",
-                "simpleaccounting_type": sat.id,
-                "accounting_type": "",
-                "label": "",
-                "done": False,
-            },
-        )
-        self.assertFalse(response.status_code == 403)
-        self.assertTrue(self.journal.operations.filter(amount=23).exists())
-        response_get = self.client.get(
-            reverse("accounting:journal_details", args=[self.journal.id])
-        )
-        self.assertTrue(
-            "<td>Le fantome de l&#39;aurore</td>" in str(response_get.content)
-        )
-        self.assertTrue(
-            self.journal.operations.filter(amount=23)
-            .values("accounting_type")
-            .first()["accounting_type"]
-            == AccountingType.objects.filter(code=6).values("id").first()["id"]
-        )
-
-    def test_nature_statement(self):
-        self.client.login(username="comptable", password="plop")
-        response_get = self.client.get(
-            reverse("accounting:journal_nature_statement", args=[self.journal.id])
-        )
-        self.assertTrue(
-            "bob (Troll Pench\\xc3\\xa9) : 3.00" in str(response_get.content)
-        )
-
-    def test_person_statement(self):
-        self.client.login(username="comptable", password="plop")
-        response_get = self.client.get(
-            reverse("accounting:journal_person_statement", args=[self.journal.id])
-        )
-        self.assertTrue(
-            "<td>3.00</td>" in str(response_get.content)
-            and '<td><a href="/user/1/">S&#39; Kia</a></td>'
-            in str(response_get.content)
-        )
-
-    def test_accounting_statement(self):
-        self.client.login(username="comptable", password="plop")
-        response_get = self.client.get(
-            reverse("accounting:journal_accounting_statement", args=[self.journal.id])
-        )
-        self.assertTrue(
-            "<td>443 - Cr\\xc3\\xa9dit - Ce code n&#39;existe pas</td>"
-            in str(response_get.content)
-        )

accounting/urls.py

@@ -1,152 +0,0 @@
-# -*- coding:utf-8 -*
-#
-# Copyright 2016,2017
-# - Skia <skia@libskia.so>
-#
-# Ce fichier fait partie du site de l'Association des Étudiants de l'UTBM,
-# http://ae.utbm.fr.
-#
-# This program is free software; you can redistribute it and/or modify it under
-# the terms of the GNU General Public License a published by the Free Software
-# Foundation; either version 3 of the License, or (at your option) any later
-# version.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
-# details.
-#
-# You should have received a copy of the GNU General Public License along with
-# this program; if not, write to the Free Sofware Foundation, Inc., 59 Temple
-# Place - Suite 330, Boston, MA 02111-1307, USA.
-#
-#
-
-from django.conf.urls import url
-
-from accounting.views import *
-
-urlpatterns = [
-    # Accounting types
-    url(
-        r"^simple_type$",
-        SimplifiedAccountingTypeListView.as_view(),
-        name="simple_type_list",
-    ),
-    url(
-        r"^simple_type/create$",
-        SimplifiedAccountingTypeCreateView.as_view(),
-        name="simple_type_new",
-    ),
-    url(
-        r"^simple_type/(?P<type_id>[0-9]+)/edit$",
-        SimplifiedAccountingTypeEditView.as_view(),
-        name="simple_type_edit",
-    ),
-    # Accounting types
-    url(r"^type$", AccountingTypeListView.as_view(), name="type_list"),
-    url(r"^type/create$", AccountingTypeCreateView.as_view(), name="type_new"),
-    url(
-        r"^type/(?P<type_id>[0-9]+)/edit$",
-        AccountingTypeEditView.as_view(),
-        name="type_edit",
-    ),
-    # Bank accounts
-    url(r"^$", BankAccountListView.as_view(), name="bank_list"),
-    url(r"^bank/create$", BankAccountCreateView.as_view(), name="bank_new"),
-    url(
-        r"^bank/(?P<b_account_id>[0-9]+)$",
-        BankAccountDetailView.as_view(),
-        name="bank_details",
-    ),
-    url(
-        r"^bank/(?P<b_account_id>[0-9]+)/edit$",
-        BankAccountEditView.as_view(),
-        name="bank_edit",
-    ),
-    url(
-        r"^bank/(?P<b_account_id>[0-9]+)/delete$",
-        BankAccountDeleteView.as_view(),
-        name="bank_delete",
-    ),
-    # Club accounts
-    url(r"^club/create$", ClubAccountCreateView.as_view(), name="club_new"),
-    url(
-        r"^club/(?P<c_account_id>[0-9]+)$",
-        ClubAccountDetailView.as_view(),
-        name="club_details",
-    ),
-    url(
-        r"^club/(?P<c_account_id>[0-9]+)/edit$",
-        ClubAccountEditView.as_view(),
-        name="club_edit",
-    ),
-    url(
-        r"^club/(?P<c_account_id>[0-9]+)/delete$",
-        ClubAccountDeleteView.as_view(),
-        name="club_delete",
-    ),
-    # Journals
-    url(r"^journal/create$", JournalCreateView.as_view(), name="journal_new"),
-    url(
-        r"^journal/(?P<j_id>[0-9]+)$",
-        JournalDetailView.as_view(),
-        name="journal_details",
-    ),
-    url(
-        r"^journal/(?P<j_id>[0-9]+)/edit$",
-        JournalEditView.as_view(),
-        name="journal_edit",
-    ),
-    url(
-        r"^journal/(?P<j_id>[0-9]+)/delete$",
-        JournalDeleteView.as_view(),
-        name="journal_delete",
-    ),
-    url(
-        r"^journal/(?P<j_id>[0-9]+)/statement/nature$",
-        JournalNatureStatementView.as_view(),
-        name="journal_nature_statement",
-    ),
-    url(
-        r"^journal/(?P<j_id>[0-9]+)/statement/person$",
-        JournalPersonStatementView.as_view(),
-        name="journal_person_statement",
-    ),
-    url(
-        r"^journal/(?P<j_id>[0-9]+)/statement/accounting$",
-        JournalAccountingStatementView.as_view(),
-        name="journal_accounting_statement",
-    ),
-    # Operations
-    url(
-        r"^operation/create/(?P<j_id>[0-9]+)$",
-        OperationCreateView.as_view(),
-        name="op_new",
-    ),
-    url(r"^operation/(?P<op_id>[0-9]+)$", OperationEditView.as_view(), name="op_edit"),
-    url(
-        r"^operation/(?P<op_id>[0-9]+)/pdf$", OperationPDFView.as_view(), name="op_pdf"
-    ),
-    # Companies
-    url(r"^company/list$", CompanyListView.as_view(), name="co_list"),
-    url(r"^company/create$", CompanyCreateView.as_view(), name="co_new"),
-    url(r"^company/(?P<co_id>[0-9]+)$", CompanyEditView.as_view(), name="co_edit"),
-    # Labels
-    url(r"^label/new$", LabelCreateView.as_view(), name="label_new"),
-    url(
-        r"^label/(?P<clubaccount_id>[0-9]+)$",
-        LabelListView.as_view(),
-        name="label_list",
-    ),
-    url(
-        r"^label/(?P<label_id>[0-9]+)/edit$", LabelEditView.as_view(), name="label_edit"
-    ),
-    url(
-        r"^label/(?P<label_id>[0-9]+)/delete$",
-        LabelDeleteView.as_view(),
-        name="label_delete",
-    ),
-    # User account
-    url(r"^refound/account$", RefoundAccountView.as_view(), name="refound_account"),
-]

accounting/views.py

@@ -1,942 +0,0 @@
-# -*- coding:utf-8 -*
-#
-# Copyright 2016,2017
-# - Skia <skia@libskia.so>
-#
-# Ce fichier fait partie du site de l'Association des Étudiants de l'UTBM,
-# http://ae.utbm.fr.
-#
-# This program is free software; you can redistribute it and/or modify it under
-# the terms of the GNU General Public License a published by the Free Software
-# Foundation; either version 3 of the License, or (at your option) any later
-# version.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
-# details.
-#
-# You should have received a copy of the GNU General Public License along with
-# this program; if not, write to the Free Sofware Foundation, Inc., 59 Temple
-# Place - Suite 330, Boston, MA 02111-1307, USA.
-#
-#
-
-from django.views.generic import ListView, DetailView
-from django.views.generic.edit import UpdateView, CreateView, DeleteView, FormView
-from django.core.urlresolvers import reverse_lazy, reverse
-from django.utils.translation import ugettext_lazy as _
-from django.forms.models import modelform_factory
-from django.core.exceptions import PermissionDenied, ValidationError
-from django.forms import HiddenInput
-from django.db import transaction
-from django.db.models import Sum
-from django.conf import settings
-from django import forms
-from django.http import HttpResponse
-import collections
-
-from ajax_select.fields import AutoCompleteSelectField
-
-from core.views import (
-    CanViewMixin,
-    CanEditMixin,
-    CanEditPropMixin,
-    CanCreateMixin,
-    TabedViewMixin,
-)
-from core.views.forms import SelectFile, SelectDate
-from accounting.models import (
-    BankAccount,
-    ClubAccount,
-    GeneralJournal,
-    Operation,
-    AccountingType,
-    Company,
-    SimplifiedAccountingType,
-    Label,
-)
-from counter.models import Counter, Selling, Product
-
-# Main accounting view
-
-
-class BankAccountListView(CanViewMixin, ListView):
-    """
-    A list view for the admins
-    """
-
-    model = BankAccount
-    template_name = "accounting/bank_account_list.jinja"
-    ordering = ["name"]
-
-
-# Simplified accounting types
-
-
-class SimplifiedAccountingTypeListView(CanViewMixin, ListView):
-    """
-    A list view for the admins
-    """
-
-    model = SimplifiedAccountingType
-    template_name = "accounting/simplifiedaccountingtype_list.jinja"
-
-
-class SimplifiedAccountingTypeEditView(CanViewMixin, UpdateView):
-    """
-    An edit view for the admins
-    """
-
-    model = SimplifiedAccountingType
-    pk_url_kwarg = "type_id"
-    fields = ["label", "accounting_type"]
-    template_name = "core/edit.jinja"
-
-
-class SimplifiedAccountingTypeCreateView(CanCreateMixin, CreateView):
-    """
-    Create an accounting type (for the admins)
-    """
-
-    model = SimplifiedAccountingType
-    fields = ["label", "accounting_type"]
-    template_name = "core/create.jinja"
-
-
-# Accounting types
-
-
-class AccountingTypeListView(CanViewMixin, ListView):
-    """
-    A list view for the admins
-    """
-
-    model = AccountingType
-    template_name = "accounting/accountingtype_list.jinja"
-
-
-class AccountingTypeEditView(CanViewMixin, UpdateView):
-    """
-    An edit view for the admins
-    """
-
-    model = AccountingType
-    pk_url_kwarg = "type_id"
-    fields = ["code", "label", "movement_type"]
-    template_name = "core/edit.jinja"
-
-
-class AccountingTypeCreateView(CanCreateMixin, CreateView):
-    """
-    Create an accounting type (for the admins)
-    """
-
-    model = AccountingType
-    fields = ["code", "label", "movement_type"]
-    template_name = "core/create.jinja"
-
-
-# BankAccount views
-
-
-class BankAccountEditView(CanViewMixin, UpdateView):
-    """
-    An edit view for the admins
-    """
-
-    model = BankAccount
-    pk_url_kwarg = "b_account_id"
-    fields = ["name", "iban", "number", "club"]
-    template_name = "core/edit.jinja"
-
-
-class BankAccountDetailView(CanViewMixin, DetailView):
-    """
-    A detail view, listing every club account
-    """
-
-    model = BankAccount
-    pk_url_kwarg = "b_account_id"
-    template_name = "accounting/bank_account_details.jinja"
-
-
-class BankAccountCreateView(CanCreateMixin, CreateView):
-    """
-    Create a bank account (for the admins)
-    """
-
-    model = BankAccount
-    fields = ["name", "club", "iban", "number"]
-    template_name = "core/create.jinja"
-
-
-class BankAccountDeleteView(
-    CanEditPropMixin, DeleteView
-):  # TODO change Delete to Close
-    """
-    Delete a bank account (for the admins)
-    """
-
-    model = BankAccount
-    pk_url_kwarg = "b_account_id"
-    template_name = "core/delete_confirm.jinja"
-    success_url = reverse_lazy("accounting:bank_list")
-
-
-# ClubAccount views
-
-
-class ClubAccountEditView(CanViewMixin, UpdateView):
-    """
-    An edit view for the admins
-    """
-
-    model = ClubAccount
-    pk_url_kwarg = "c_account_id"
-    fields = ["name", "club", "bank_account"]
-    template_name = "core/edit.jinja"
-
-
-class ClubAccountDetailView(CanViewMixin, DetailView):
-    """
-    A detail view, listing every journal
-    """
-
-    model = ClubAccount
-    pk_url_kwarg = "c_account_id"
-    template_name = "accounting/club_account_details.jinja"
-
-
-class ClubAccountCreateView(CanCreateMixin, CreateView):
-    """
-    Create a club account (for the admins)
-    """
-
-    model = ClubAccount
-    fields = ["name", "club", "bank_account"]
-    template_name = "core/create.jinja"
-
-    def get_initial(self):
-        ret = super(ClubAccountCreateView, self).get_initial()
-        if "parent" in self.request.GET.keys():
-            obj = BankAccount.objects.filter(id=int(self.request.GET["parent"])).first()
-            if obj is not None:
-                ret["bank_account"] = obj.id
-        return ret
-
-
-class ClubAccountDeleteView(
-    CanEditPropMixin, DeleteView
-):  # TODO change Delete to Close
-    """
-    Delete a club account (for the admins)
-    """
-
-    model = ClubAccount
-    pk_url_kwarg = "c_account_id"
-    template_name = "core/delete_confirm.jinja"
-    success_url = reverse_lazy("accounting:bank_list")
-
-
-# Journal views
-
-
-class JournalTabsMixin(TabedViewMixin):
-    def get_tabs_title(self):
-        return _("Journal")
-
-    def get_list_of_tabs(self):
-        tab_list = []
-        tab_list.append(
-            {
-                "url": reverse(
-                    "accounting:journal_details", kwargs={"j_id": self.object.id}
-                ),
-                "slug": "journal",
-                "name": _("Journal"),
-            }
-        )
-        tab_list.append(
-            {
-                "url": reverse(
-                    "accounting:journal_nature_statement",
-                    kwargs={"j_id": self.object.id},
-                ),
-                "slug": "nature_statement",
-                "name": _("Statement by nature"),
-            }
-        )
-        tab_list.append(
-            {
-                "url": reverse(
-                    "accounting:journal_person_statement",
-                    kwargs={"j_id": self.object.id},
-                ),
-                "slug": "person_statement",
-                "name": _("Statement by person"),
-            }
-        )
-        tab_list.append(
-            {
-                "url": reverse(
-                    "accounting:journal_accounting_statement",
-                    kwargs={"j_id": self.object.id},
-                ),
-                "slug": "accounting_statement",
-                "name": _("Accounting statement"),
-            }
-        )
-        return tab_list
-
-
-class JournalCreateView(CanCreateMixin, CreateView):
-    """
-    Create a general journal
-    """
-
-    model = GeneralJournal
-    form_class = modelform_factory(
-        GeneralJournal,
-        fields=["name", "start_date", "club_account"],
-        widgets={"start_date": SelectDate},
-    )
-    template_name = "core/create.jinja"
-
-    def get_initial(self):
-        ret = super(JournalCreateView, self).get_initial()
-        if "parent" in self.request.GET.keys():
-            obj = ClubAccount.objects.filter(id=int(self.request.GET["parent"])).first()
-            if obj is not None:
-                ret["club_account"] = obj.id
-        return ret
-
-
-class JournalDetailView(JournalTabsMixin, CanViewMixin, DetailView):
-    """
-    A detail view, listing every operation
-    """
-
-    model = GeneralJournal
-    pk_url_kwarg = "j_id"
-    template_name = "accounting/journal_details.jinja"
-    current_tab = "journal"
-
-
-class JournalEditView(CanEditMixin, UpdateView):
-    """
-    Update a general journal
-    """
-
-    model = GeneralJournal
-    pk_url_kwarg = "j_id"
-    fields = ["name", "start_date", "end_date", "club_account", "closed"]
-    template_name = "core/edit.jinja"
-
-
-class JournalDeleteView(CanEditPropMixin, DeleteView):
-    """
-    Delete a club account (for the admins)
-    """
-
-    model = GeneralJournal
-    pk_url_kwarg = "j_id"
-    template_name = "core/delete_confirm.jinja"
-    success_url = reverse_lazy("accounting:club_details")
-
-    def dispatch(self, request, *args, **kwargs):
-        self.object = self.get_object()
-        if self.object.operations.count() == 0:
-            return super(JournalDeleteView, self).dispatch(request, *args, **kwargs)
-        else:
-            raise PermissionDenied
-
-
-# Operation views
-
-
-class OperationForm(forms.ModelForm):
-    class Meta:
-        model = Operation
-        fields = [
-            "amount",
-            "remark",
-            "journal",
-            "target_type",
-            "target_id",
-            "target_label",
-            "date",
-            "mode",
-            "cheque_number",
-            "invoice",
-            "simpleaccounting_type",
-            "accounting_type",
-            "label",
-            "done",
-        ]
-        widgets = {
-            "journal": HiddenInput,
-            "target_id": HiddenInput,
-            "date": SelectDate,
-            "invoice": SelectFile,
-        }
-
-    user = AutoCompleteSelectField("users", help_text=None, required=False)
-    club_account = AutoCompleteSelectField(
-        "club_accounts", help_text=None, required=False
-    )
-    club = AutoCompleteSelectField("clubs", help_text=None, required=False)
-    company = AutoCompleteSelectField("companies", help_text=None, required=False)
-    need_link = forms.BooleanField(
-        label=_("Link this operation to the target account"),
-        required=False,
-        initial=False,
-    )
-
-    def __init__(self, *args, **kwargs):
-        club_account = kwargs.pop("club_account", None)
-        super(OperationForm, self).__init__(*args, **kwargs)
-        if club_account:
-            self.fields["label"].queryset = club_account.labels.order_by("name").all()
-        if self.instance.target_type == "USER":
-            self.fields["user"].initial = self.instance.target_id
-        elif self.instance.target_type == "ACCOUNT":
-            self.fields["club_account"].initial = self.instance.target_id
-        elif self.instance.target_type == "CLUB":
-            self.fields["club"].initial = self.instance.target_id
-        elif self.instance.target_type == "COMPANY":
-            self.fields["company"].initial = self.instance.target_id
-
-    def clean(self):
-        self.cleaned_data = super(OperationForm, self).clean()
-        if "target_type" in self.cleaned_data.keys():
-            if (
-                self.cleaned_data.get("user") is None
-                and self.cleaned_data.get("club") is None
-                and self.cleaned_data.get("club_account") is None
-                and self.cleaned_data.get("company") is None
-                and self.cleaned_data.get("target_label") == ""
-            ):
-                self.add_error(
-                    "target_type", ValidationError(_("The target must be set."))
-                )
-            else:
-                if self.cleaned_data["target_type"] == "USER":
-                    self.cleaned_data["target_id"] = self.cleaned_data["user"].id
-                elif self.cleaned_data["target_type"] == "ACCOUNT":
-                    self.cleaned_data["target_id"] = self.cleaned_data[
-                        "club_account"
-                    ].id
-                elif self.cleaned_data["target_type"] == "CLUB":
-                    self.cleaned_data["target_id"] = self.cleaned_data["club"].id
-                elif self.cleaned_data["target_type"] == "COMPANY":
-                    self.cleaned_data["target_id"] = self.cleaned_data["company"].id
-
-        if self.cleaned_data.get("amount") is None:
-            self.add_error("amount", ValidationError(_("The amount must be set.")))
-
-        return self.cleaned_data
-
-    def save(self):
-        ret = super(OperationForm, self).save()
-        if (
-            self.instance.target_type == "ACCOUNT"
-            and not self.instance.linked_operation
-            and self.instance.target.has_open_journal()
-            and self.cleaned_data["need_link"]
-        ):
-            inst = self.instance
-            club_account = inst.target
-            acc_type = (
-                AccountingType.objects.exclude(movement_type="NEUTRAL")
-                .exclude(movement_type=inst.accounting_type.movement_type)
-                .order_by("code")
-                .first()
-            )  # Select a random opposite accounting type
-            op = Operation(
-                journal=club_account.get_open_journal(),
-                amount=inst.amount,
-                date=inst.date,
-                remark=inst.remark,
-                mode=inst.mode,
-                cheque_number=inst.cheque_number,
-                invoice=inst.invoice,
-                done=False,  # Has to be checked by hand
-                simpleaccounting_type=None,
-                accounting_type=acc_type,
-                target_type="ACCOUNT",
-                target_id=inst.journal.club_account.id,
-                target_label="",
-                linked_operation=inst,
-            )
-            op.save()
-            self.instance.linked_operation = op
-            self.save()
-        return ret
-
-
-class OperationCreateView(CanCreateMixin, CreateView):
-    """
-    Create an operation
-    """
-
-    model = Operation
-    form_class = OperationForm
-    template_name = "accounting/operation_edit.jinja"
-
-    def get_form(self, form_class=None):
-        self.journal = GeneralJournal.objects.filter(id=self.kwargs["j_id"]).first()
-        ca = self.journal.club_account if self.journal else None
-        return self.form_class(club_account=ca, **self.get_form_kwargs())
-
-    def get_initial(self):
-        ret = super(OperationCreateView, self).get_initial()
-        if self.journal is not None:
-            ret["journal"] = self.journal.id
-        return ret
-
-    def get_context_data(self, **kwargs):
-        """ Add journal to the context """
-        kwargs = super(OperationCreateView, self).get_context_data(**kwargs)
-        if self.journal:
-            kwargs["object"] = self.journal
-        return kwargs
-
-
-class OperationEditView(CanEditMixin, UpdateView):
-    """
-    An edit view, working as detail for the moment
-    """
-
-    model = Operation
-    pk_url_kwarg = "op_id"
-    form_class = OperationForm
-    template_name = "accounting/operation_edit.jinja"
-
-    def get_context_data(self, **kwargs):
-        """ Add journal to the context """
-        kwargs = super(OperationEditView, self).get_context_data(**kwargs)
-        kwargs["object"] = self.object.journal
-        return kwargs
-
-
-class OperationPDFView(CanViewMixin, DetailView):
-    """
-    Display the PDF of a given operation
-    """
-
-    model = Operation
-    pk_url_kwarg = "op_id"
-
-    def get(self, request, *args, **kwargs):
-        from reportlab.pdfgen import canvas
-        from reportlab.lib.units import cm
-        from reportlab.platypus import Table, TableStyle
-        from reportlab.lib import colors
-        from reportlab.lib.pagesizes import letter
-        from reportlab.lib.utils import ImageReader
-        from reportlab.pdfbase.ttfonts import TTFont
-        from reportlab.pdfbase import pdfmetrics
-
-        pdfmetrics.registerFont(TTFont("DejaVu", "DejaVuSerif.ttf"))
-
-        self.object = self.get_object()
-        amount = self.object.amount
-        remark = self.object.remark
-        nature = self.object.accounting_type.movement_type
-        num = self.object.number
-        date = self.object.date
-        mode = self.object.mode
-        club_name = self.object.journal.club_account.name
-        ti = self.object.journal.name
-        op_label = self.object.label
-        club_address = self.object.journal.club_account.club.address
-        id_op = self.object.id
-
-        if self.object.target_type == "OTHER":
-            target = self.object.target_label
-        else:
-            target = self.object.target.get_display_name()
-
-        response = HttpResponse(content_type="application/pdf")
-        response["Content-Disposition"] = 'filename="op-%d(%s_on_%s).pdf"' % (
-            num,
-            ti,
-            club_name,
-        )
-        p = canvas.Canvas(response)
-
-        p.setFont("DejaVu", 12)
-
-        p.setTitle("%s %d" % (_("Operation"), num))
-        width, height = letter
-        im = ImageReader("core/static/core/img/logo.jpg")
-        iw, ih = im.getSize()
-        p.drawImage(im, 40, height - 50, width=iw / 2, height=ih / 2)
-
-        labelStr = [["%s %s - %s %s" % (_("Journal"), ti, _("Operation"), num)]]
-
-        label = Table(labelStr, colWidths=[150], rowHeights=[20])
-
-        label.setStyle(TableStyle([("ALIGN", (0, 0), (-1, -1), "RIGHT")]))
-        w, h = label.wrapOn(label, 0, 0)
-        label.drawOn(p, width - 180, height)
-
-        p.drawString(
-            90, height - 100, _("Financial proof: ") + "OP%010d" % (id_op)
-        )  # Justificatif du libellé
-        p.drawString(
-            90, height - 130, _("Club: %(club_name)s") % ({"club_name": club_name})
-        )
-        p.drawString(
-            90,
-            height - 160,
-            _("Label: %(op_label)s")
-            % {"op_label": op_label if op_label is not None else ""},
-        )
-        p.drawString(90, height - 190, _("Date: %(date)s") % {"date": date})
-
-        data = []
-
-        data += [
-            ["%s" % (_("Credit").upper() if nature == "CREDIT" else _("Debit").upper())]
-        ]
-
-        data += [[_("Amount: %(amount).2f €") % {"amount": amount}]]
-
-        payment_mode = ""
-        for m in settings.SITH_ACCOUNTING_PAYMENT_METHOD:
-            if m[0] == mode:
-                payment_mode += "[\u00D7]"
-            else:
-                payment_mode += "[  ]"
-            payment_mode += " %s\n" % (m[1])
-
-        data += [[payment_mode]]
-
-        data += [
-            [
-                "%s : %s"
-                % (_("Debtor") if nature == "CREDIT" else _("Creditor"), target),
-                "",
-            ]
-        ]
-
-        data += [["%s \n%s" % (_("Comment:"), remark)]]
-
-        t = Table(
-            data, colWidths=[(width - 90 * 2) / 2] * 2, rowHeights=[20, 20, 70, 20, 80]
-        )
-        t.setStyle(
-            TableStyle(
-                [
-                    ("ALIGN", (0, 0), (-1, -1), "CENTER"),
-                    ("VALIGN", (-2, -1), (-1, -1), "TOP"),
-                    ("VALIGN", (0, 0), (-1, -2), "MIDDLE"),
-                    ("INNERGRID", (0, 0), (-1, -1), 0.25, colors.black),
-                    ("SPAN", (0, 0), (1, 0)),  # line DEBIT/CREDIT
-                    ("SPAN", (0, 1), (1, 1)),  # line amount
-                    ("SPAN", (-2, -1), (-1, -1)),  # line comment
-                    ("SPAN", (0, -2), (-1, -2)),  # line creditor/debtor
-                    ("SPAN", (0, 2), (1, 2)),  # line payment_mode
-                    ("ALIGN", (0, 2), (1, 2), "LEFT"),  # line payment_mode
-                    ("ALIGN", (-2, -1), (-1, -1), "LEFT"),
-                    ("BOX", (0, 0), (-1, -1), 0.25, colors.black),
-                ]
-            )
-        )
-
-        signature = []
-        signature += [[_("Signature:")]]
-
-        tSig = Table(signature, colWidths=[(width - 90 * 2)], rowHeights=[80])
-        tSig.setStyle(
-            TableStyle(
-                [
-                    ("VALIGN", (0, 0), (-1, -1), "TOP"),
-                    ("BOX", (0, 0), (-1, -1), 0.25, colors.black),
-                ]
-            )
-        )
-
-        w, h = tSig.wrapOn(p, 0, 0)
-        tSig.drawOn(p, 90, 200)
-
-        w, h = t.wrapOn(p, 0, 0)
-
-        t.drawOn(p, 90, 350)
-
-        p.drawCentredString(10.5 * cm, 2 * cm, club_name)
-        p.drawCentredString(10.5 * cm, 1 * cm, club_address)
-
-        p.showPage()
-        p.save()
-        return response
-
-
-class JournalNatureStatementView(JournalTabsMixin, CanViewMixin, DetailView):
-    """
-    Display a statement sorted by labels
-    """
-
-    model = GeneralJournal
-    pk_url_kwarg = "j_id"
-    template_name = "accounting/journal_statement_nature.jinja"
-    current_tab = "nature_statement"
-
-    def statement(self, queryset, movement_type):
-        ret = collections.OrderedDict()
-        statement = collections.OrderedDict()
-        total_sum = 0
-        for sat in [None] + list(
-            SimplifiedAccountingType.objects.order_by("label").all()
-        ):
-            sum = queryset.filter(
-                accounting_type__movement_type=movement_type, simpleaccounting_type=sat
-            ).aggregate(amount_sum=Sum("amount"))["amount_sum"]
-            if sat:
-                sat = sat.label
-            else:
-                sat = ""
-            if sum:
-                total_sum += sum
-                statement[sat] = sum
-        ret[movement_type] = statement
-        ret[movement_type + "_sum"] = total_sum
-        return ret
-
-    def big_statement(self):
-        label_list = (
-            self.object.operations.order_by("label").values_list("label").distinct()
-        )
-        labels = Label.objects.filter(id__in=label_list).all()
-        statement = collections.OrderedDict()
-        gen_statement = collections.OrderedDict()
-        no_label_statement = collections.OrderedDict()
-        gen_statement.update(self.statement(self.object.operations.all(), "CREDIT"))
-        gen_statement.update(self.statement(self.object.operations.all(), "DEBIT"))
-        statement[_("General statement")] = gen_statement
-        no_label_statement.update(
-            self.statement(self.object.operations.filter(label=None).all(), "CREDIT")
-        )
-        no_label_statement.update(
-            self.statement(self.object.operations.filter(label=None).all(), "DEBIT")
-        )
-        statement[_("No label operations")] = no_label_statement
-        for l in labels:
-            l_stmt = collections.OrderedDict()
-            l_stmt.update(
-                self.statement(self.object.operations.filter(label=l).all(), "CREDIT")
-            )
-            l_stmt.update(
-                self.statement(self.object.operations.filter(label=l).all(), "DEBIT")
-            )
-            statement[l] = l_stmt
-        return statement
-
-    def get_context_data(self, **kwargs):
-        """ Add infos to the context """
-        kwargs = super(JournalNatureStatementView, self).get_context_data(**kwargs)
-        kwargs["statement"] = self.big_statement()
-        return kwargs
-
-
-class JournalPersonStatementView(JournalTabsMixin, CanViewMixin, DetailView):
-    """
-    Calculate a dictionary with operation target and sum of operations
-    """
-
-    model = GeneralJournal
-    pk_url_kwarg = "j_id"
-    template_name = "accounting/journal_statement_person.jinja"
-    current_tab = "person_statement"
-
-    def sum_by_target(self, target_id, target_type, movement_type):
-        return self.object.operations.filter(
-            accounting_type__movement_type=movement_type,
-            target_id=target_id,
-            target_type=target_type,
-        ).aggregate(amount_sum=Sum("amount"))["amount_sum"]
-
-    def statement(self, movement_type):
-        statement = collections.OrderedDict()
-        for op in (
-            self.object.operations.filter(accounting_type__movement_type=movement_type)
-            .order_by("target_type", "target_id")
-            .distinct()
-        ):
-            statement[op.target] = self.sum_by_target(
-                op.target_id, op.target_type, movement_type
-            )
-        return statement
-
-    def total(self, movement_type):
-        return sum(self.statement(movement_type).values())
-
-    def get_context_data(self, **kwargs):
-        """ Add journal to the context """
-        kwargs = super(JournalPersonStatementView, self).get_context_data(**kwargs)
-        kwargs["credit_statement"] = self.statement("CREDIT")
-        kwargs["debit_statement"] = self.statement("DEBIT")
-        kwargs["total_credit"] = self.total("CREDIT")
-        kwargs["total_debit"] = self.total("DEBIT")
-        return kwargs
-
-
-class JournalAccountingStatementView(JournalTabsMixin, CanViewMixin, DetailView):
-    """
-    Calculate a dictionary with operation type and sum of operations
-    """
-
-    model = GeneralJournal
-    pk_url_kwarg = "j_id"
-    template_name = "accounting/journal_statement_accounting.jinja"
-    current_tab = "accounting_statement"
-
-    def statement(self):
-        statement = collections.OrderedDict()
-        for at in AccountingType.objects.order_by("code").all():
-            sum_by_type = self.object.operations.filter(
-                accounting_type__code__startswith=at.code
-            ).aggregate(amount_sum=Sum("amount"))["amount_sum"]
-            if sum_by_type:
-                statement[at] = sum_by_type
-        return statement
-
-    def get_context_data(self, **kwargs):
-        """ Add journal to the context """
-        kwargs = super(JournalAccountingStatementView, self).get_context_data(**kwargs)
-        kwargs["statement"] = self.statement()
-        return kwargs
-
-
-# Company views
-
-
-class CompanyListView(CanViewMixin, ListView):
-    model = Company
-    template_name = "accounting/co_list.jinja"
-
-
-class CompanyCreateView(CanCreateMixin, CreateView):
-    """
-    Create a company
-    """
-
-    model = Company
-    fields = ["name"]
-    template_name = "core/create.jinja"
-    success_url = reverse_lazy("accounting:co_list")
-
-
-class CompanyEditView(CanCreateMixin, UpdateView):
-    """
-    Edit a company
-    """
-
-    model = Company
-    pk_url_kwarg = "co_id"
-    fields = ["name"]
-    template_name = "core/edit.jinja"
-    success_url = reverse_lazy("accounting:co_list")
-
-
-# Label views
-
-
-class LabelListView(CanViewMixin, DetailView):
-    model = ClubAccount
-    pk_url_kwarg = "clubaccount_id"
-    template_name = "accounting/label_list.jinja"
-
-
-class LabelCreateView(
-    CanCreateMixin, CreateView
-):  # FIXME we need to check the rights before creating the object
-    model = Label
-    form_class = modelform_factory(
-        Label, fields=["name", "club_account"], widgets={"club_account": HiddenInput}
-    )
-    template_name = "core/create.jinja"
-
-    def get_initial(self):
-        ret = super(LabelCreateView, self).get_initial()
-        if "parent" in self.request.GET.keys():
-            obj = ClubAccount.objects.filter(id=int(self.request.GET["parent"])).first()
-            if obj is not None:
-                ret["club_account"] = obj.id
-        return ret
-
-
-class LabelEditView(CanEditMixin, UpdateView):
-    model = Label
-    pk_url_kwarg = "label_id"
-    fields = ["name"]
-    template_name = "core/edit.jinja"
-
-
-class LabelDeleteView(CanEditMixin, DeleteView):
-    model = Label
-    pk_url_kwarg = "label_id"
-    template_name = "core/delete_confirm.jinja"
-
-    def get_success_url(self):
-        return self.object.get_absolute_url()
-
-
-class CloseCustomerAccountForm(forms.Form):
-    user = AutoCompleteSelectField(
-        "users", label=_("Refound this account"), help_text=None, required=True
-    )
-
-
-class RefoundAccountView(FormView):
-    """
-    Create a selling with the same amount than the current user money
-    """
-
-    template_name = "accounting/refound_account.jinja"
-    form_class = CloseCustomerAccountForm
-
-    def permission(self, user):
-        if user.is_root or user.is_in_group(settings.SITH_GROUP_ACCOUNTING_ADMIN_ID):
-            return True
-        else:
-            raise PermissionDenied
-
-    def dispatch(self, request, *arg, **kwargs):
-        res = super(RefoundAccountView, self).dispatch(request, *arg, **kwargs)
-        if self.permission(request.user):
-            return res
-
-    def post(self, request, *arg, **kwargs):
-        self.operator = request.user
-        if self.permission(request.user):
-            return super(RefoundAccountView, self).post(self, request, *arg, **kwargs)
-
-    def form_valid(self, form):
-        self.customer = form.cleaned_data["user"]
-        self.create_selling()
-        return super(RefoundAccountView, self).form_valid(form)
-
-    def get_success_url(self):
-        return reverse("accounting:refound_account")
-
-    def create_selling(self):
-        with transaction.atomic():
-            uprice = self.customer.customer.amount
-            refound_club_counter = Counter.objects.get(
-                id=settings.SITH_COUNTER_REFOUND_ID
-            )
-            refound_club = refound_club_counter.club
-            s = Selling(
-                label=_("Refound account"),
-                unit_price=uprice,
-                quantity=1,
-                seller=self.operator,
-                customer=self.customer.customer,
-                club=refound_club,
-                counter=refound_club_counter,
-                product=Product.objects.get(id=settings.SITH_PRODUCT_REFOUND_ID),
-            )
-            s.save()

antispam/admin.py

@@ -0,0 +1,10 @@
+from django.contrib import admin
+
+from antispam.models import ToxicDomain
+
+
+@admin.register(ToxicDomain)
+class ToxicDomainAdmin(admin.ModelAdmin):
+    list_display = ("domain", "is_externally_managed", "created")
+    search_fields = ("domain", "is_externally_managed", "created")
+    list_filter = ("is_externally_managed",)

antispam/apps.py

@@ -0,0 +1,7 @@
+from django.apps import AppConfig
+
+
+class AntispamConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    verbose_name = "antispam"
+    name = "antispam"

antispam/forms.py

@@ -0,0 +1,22 @@
+from django import forms
+from django.core.validators import EmailValidator
+from django.utils.translation import gettext_lazy as _
+
+from antispam.models import ToxicDomain
+
+
+class AntiSpamEmailValidator(EmailValidator):
+    def __call__(self, value: str):
+        super().__call__(value)
+        domain_part = value.rsplit("@", 1)[1]
+        if ToxicDomain.objects.filter(domain=domain_part).exists():
+            raise forms.ValidationError(_("Email domain is not allowed."))
+
+
+validate_antispam_email = AntiSpamEmailValidator()
+
+
+class AntiSpamEmailField(forms.EmailField):
+    """An email field that email addresses with a known toxic domain."""
+
+    default_validators = [validate_antispam_email]

antispam/management/commands/update_spam_database.py

@@ -0,0 +1,69 @@
+import requests
+from django.conf import settings
+from django.core.management import BaseCommand
+from django.db.models import Max
+from django.utils import timezone
+
+from antispam.models import ToxicDomain
+
+
+class Command(BaseCommand):
+    """Update blocked ips/mails database"""
+
+    help = "Update blocked ips/mails database"
+
+    def add_arguments(self, parser):
+        parser.add_argument(
+            "--force", action="store_true", help="Force re-creation even if up to date"
+        )
+
+    def _should_update(self, *, force: bool = False) -> bool:
+        if force:
+            return True
+        oldest = ToxicDomain.objects.filter(is_externally_managed=True).aggregate(
+            res=Max("created")
+        )["res"]
+        return not (oldest and timezone.now() < (oldest + timezone.timedelta(days=1)))
+
+    def _download_domains(self, providers: list[str]) -> set[str]:
+        domains = set()
+        for provider in providers:
+            res = requests.get(provider)
+            if not res.ok:
+                self.stderr.write(
+                    f"Source {provider} responded with code {res.status_code}"
+                )
+                continue
+            domains |= set(res.text.splitlines())
+        return domains
+
+    def _update_domains(self, domains: set[str]):
+        # Cleanup database
+        ToxicDomain.objects.filter(is_externally_managed=True).delete()
+
+        # Create database
+        ToxicDomain.objects.bulk_create(
+            [
+                ToxicDomain(domain=domain, is_externally_managed=True)
+                for domain in domains
+            ],
+            ignore_conflicts=True,
+        )
+        self.stdout.write("Domain database updated")
+
+    def handle(self, *args, **options):
+        if not self._should_update(force=options["force"]):
+            self.stdout.write("Domain database is up to date")
+            return
+        self.stdout.write("Updating domain database")
+
+        domains = self._download_domains(settings.TOXIC_DOMAINS_PROVIDERS)
+
+        if not domains:
+            self.stderr.write(
+                "No domains could be fetched from settings.TOXIC_DOMAINS_PROVIDERS. "
+                "Please, have a look at your settings."
+            )
+            return
+
+        self._update_domains(domains)

antispam/migrations/0001_initial.py

@@ -0,0 +1,35 @@
+# Generated by Django 4.2.14 on 2024-08-03 23:05
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    initial = True
+
+    dependencies = []
+
+    operations = [
+        migrations.CreateModel(
+            name="ToxicDomain",
+            fields=[
+                (
+                    "domain",
+                    models.URLField(
+                        max_length=253,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="domain",
+                    ),
+                ),
+                ("created", models.DateTimeField(auto_now_add=True)),
+                (
+                    "is_externally_managed",
+                    models.BooleanField(
+                        default=False,
+                        help_text="True if kept up-to-date using external toxic domain providers, else False",
+                        verbose_name="is externally managed",
+                    ),
+                ),
+            ],
+        ),
+    ]

antispam/models.py

@@ -0,0 +1,19 @@
+from django.db import models
+from django.utils.translation import gettext_lazy as _
+
+
+class ToxicDomain(models.Model):
+    """Domain marked as spam in public databases"""
+
+    domain = models.URLField(_("domain"), max_length=253, primary_key=True)
+    created = models.DateTimeField(auto_now_add=True)
+    is_externally_managed = models.BooleanField(
+        _("is externally managed"),
+        default=False,
+        help_text=_(
+            "True if kept up-to-date using external toxic domain providers, else False"
+        ),
+    )
+
+    def __str__(self) -> str:
+        return self.domain

api/__init__.py

@@ -1,23 +0,0 @@
-# -*- coding:utf-8 -*
-#
-# Copyright 2016,2017
-# - Skia <skia@libskia.so>
-#
-# Ce fichier fait partie du site de l'Association des Étudiants de l'UTBM,
-# http://ae.utbm.fr.
-#
-# This program is free software; you can redistribute it and/or modify it under
-# the terms of the GNU General Public License a published by the Free Software
-# Foundation; either version 3 of the License, or (at your option) any later
-# version.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
-# details.
-#
-# You should have received a copy of the GNU General Public License along with
-# this program; if not, write to the Free Sofware Foundation, Inc., 59 Temple
-# Place - Suite 330, Boston, MA 02111-1307, USA.
-#
-#

api/admin.py

@@ -1,27 +1,55 @@
-# -*- coding:utf-8 -*
-#
-# Copyright 2016,2017
-# - Skia <skia@libskia.so>
-#
-# Ce fichier fait partie du site de l'Association des Étudiants de l'UTBM,
-# http://ae.utbm.fr.
-#
-# This program is free software; you can redistribute it and/or modify it under
-# the terms of the GNU General Public License a published by the Free Software
-# Foundation; either version 3 of the License, or (at your option) any later
-# version.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
-# details.
-#
-# You should have received a copy of the GNU General Public License along with
-# this program; if not, write to the Free Sofware Foundation, Inc., 59 Temple
-# Place - Suite 330, Boston, MA 02111-1307, USA.
-#
-#
+from django.contrib import admin, messages
+from django.db.models import QuerySet
+from django.http import HttpRequest
+from django.utils.translation import gettext_lazy as _
 
-from django.contrib import admin
+from api.hashers import generate_key
+from api.models import ApiClient, ApiKey
 
-# Register your models here.
+
+@admin.register(ApiClient)
+class ApiClientAdmin(admin.ModelAdmin):
+    list_display = ("name", "owner", "created_at", "updated_at")
+    search_fields = (
+        "name",
+        "owner__first_name",
+        "owner__last_name",
+        "owner__nick_name",
+    )
+    autocomplete_fields = ("owner", "groups", "client_permissions")
+
+
+@admin.register(ApiKey)
+class ApiKeyAdmin(admin.ModelAdmin):
+    list_display = ("name", "client", "created_at", "revoked")
+    list_filter = ("revoked",)
+    date_hierarchy = "created_at"
+
+    readonly_fields = ("prefix", "hashed_key")
+    actions = ("revoke_keys",)
+
+    def save_model(self, request: HttpRequest, obj: ApiKey, form, change):
+        if not change:
+            key, hashed = generate_key()
+            obj.prefix = key[: ApiKey.PREFIX_LENGTH]
+            obj.hashed_key = hashed
+            self.message_user(
+                request,
+                _(
+                    "The API key for %(name)s is: %(key)s. "
+                    "Please store it somewhere safe: "
+                    "you will not be able to see it again."
+                )
+                % {"name": obj.name, "key": key},
+                level=messages.WARNING,
+            )
+        return super().save_model(request, obj, form, change)
+
+    def get_readonly_fields(self, request, obj: ApiKey | None = None):
+        if obj is None or obj.revoked:
+            return ["revoked", *self.readonly_fields]
+        return self.readonly_fields
+
+    @admin.action(description=_("Revoke selected API keys"))
+    def revoke_keys(self, _request: HttpRequest, queryset: QuerySet[ApiKey]):
+        queryset.update(revoked=True)

api/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class ApiConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "api"

api/auth.py

@@ -0,0 +1,20 @@
+from django.http import HttpRequest
+from ninja.security import APIKeyHeader
+
+from api.hashers import get_hasher
+from api.models import ApiClient, ApiKey
+
+
+class ApiKeyAuth(APIKeyHeader):
+    param_name = "X-APIKey"
+
+    def authenticate(self, request: HttpRequest, key: str | None) -> ApiClient | None:
+        if not key or len(key) != ApiKey.KEY_LENGTH:
+            return None
+        hasher = get_hasher()
+        hashed_key = hasher.encode(key)
+        try:
+            key_obj = ApiKey.objects.get(revoked=False, hashed_key=hashed_key)
+        except ApiKey.DoesNotExist:
+            return None
+        return key_obj.client

api/hashers.py

@@ -0,0 +1,43 @@
+import functools
+import hashlib
+import secrets
+
+from django.contrib.auth.hashers import BasePasswordHasher
+from django.utils.crypto import constant_time_compare
+
+
+class Sha512ApiKeyHasher(BasePasswordHasher):
+    """
+    An API key hasher using the sha256 algorithm.
+
+    This hasher shouldn't be used in Django's `PASSWORD_HASHERS` setting.
+    It is insecure for use in hashing passwords, but is safe for hashing
+    high entropy, randomly generated API keys.
+    """
+
+    algorithm = "sha512"
+
+    def salt(self) -> str:
+        # No need for a salt on a high entropy key.
+        return ""
+
+    def encode(self, password: str, salt: str = "") -> str:
+        hashed = hashlib.sha512(password.encode()).hexdigest()
+        return f"{self.algorithm}$${hashed}"
+
+    def verify(self, password: str, encoded: str) -> bool:
+        encoded_2 = self.encode(password, "")
+        return constant_time_compare(encoded, encoded_2)
+
+
+@functools.cache
+def get_hasher():
+    return Sha512ApiKeyHasher()
+
+
+def generate_key() -> tuple[str, str]:
+    """Generate a [key, hash] couple."""
+    # this will result in key with a length of 72
+    key = str(secrets.token_urlsafe(54))
+    hasher = get_hasher()
+    return key, hasher.encode(key)

api/migrations/0001_initial.py

@@ -0,0 +1,113 @@
+# Generated by Django 5.2 on 2025-06-01 08:53
+
+import django.db.models.deletion
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    initial = True
+
+    dependencies = [
+        ("auth", "0012_alter_user_first_name_max_length"),
+        ("core", "0046_permissionrights"),
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="ApiClient",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("name", models.CharField(max_length=64, verbose_name="name")),
+                ("created_at", models.DateTimeField(auto_now_add=True)),
+                ("updated_at", models.DateTimeField(auto_now=True)),
+                (
+                    "client_permissions",
+                    models.ManyToManyField(
+                        blank=True,
+                        help_text="Specific permissions for this api client.",
+                        related_name="clients",
+                        to="auth.permission",
+                        verbose_name="client permissions",
+                    ),
+                ),
+                (
+                    "groups",
+                    models.ManyToManyField(
+                        blank=True,
+                        related_name="api_clients",
+                        to="core.group",
+                        verbose_name="groups",
+                    ),
+                ),
+                (
+                    "owner",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="api_clients",
+                        to=settings.AUTH_USER_MODEL,
+                        verbose_name="owner",
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "api client",
+                "verbose_name_plural": "api clients",
+            },
+        ),
+        migrations.CreateModel(
+            name="ApiKey",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("name", models.CharField(blank=True, default="", verbose_name="name")),
+                (
+                    "prefix",
+                    models.CharField(
+                        editable=False, max_length=5, verbose_name="prefix"
+                    ),
+                ),
+                (
+                    "hashed_key",
+                    models.CharField(
+                        db_index=True,
+                        editable=False,
+                        max_length=136,
+                        verbose_name="hashed key",
+                    ),
+                ),
+                ("revoked", models.BooleanField(default=False, verbose_name="revoked")),
+                ("created_at", models.DateTimeField(auto_now_add=True)),
+                (
+                    "client",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="api_keys",
+                        to="api.apiclient",
+                        verbose_name="api client",
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "api key",
+                "verbose_name_plural": "api keys",
+                "permissions": [("revoke_apikey", "Revoke API keys")],
+            },
+        ),
+    ]

api/models.py

@@ -1,27 +1,94 @@
-# -*- coding:utf-8 -*
-#
-# Copyright 2016,2017
-# - Skia <skia@libskia.so>
-#
-# Ce fichier fait partie du site de l'Association des Étudiants de l'UTBM,
-# http://ae.utbm.fr.
-#
-# This program is free software; you can redistribute it and/or modify it under
-# the terms of the GNU General Public License a published by the Free Software
-# Foundation; either version 3 of the License, or (at your option) any later
-# version.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
-# details.
-#
-# You should have received a copy of the GNU General Public License along with
-# this program; if not, write to the Free Sofware Foundation, Inc., 59 Temple
-# Place - Suite 330, Boston, MA 02111-1307, USA.
-#
-#
+from typing import Iterable
 
+from django.contrib.auth.models import Permission
 from django.db import models
+from django.utils.translation import gettext_lazy as _
+from django.utils.translation import pgettext_lazy
 
-# Create your models here.
+from core.models import Group, User
+
+
+class ApiClient(models.Model):
+    name = models.CharField(_("name"), max_length=64)
+    owner = models.ForeignKey(
+        User,
+        verbose_name=_("owner"),
+        related_name="api_clients",
+        on_delete=models.CASCADE,
+    )
+    groups = models.ManyToManyField(
+        Group, verbose_name=_("groups"), related_name="api_clients", blank=True
+    )
+    client_permissions = models.ManyToManyField(
+        Permission,
+        verbose_name=_("client permissions"),
+        blank=True,
+        help_text=_("Specific permissions for this api client."),
+        related_name="clients",
+    )
+    created_at = models.DateTimeField(auto_now_add=True)
+    updated_at = models.DateTimeField(auto_now=True)
+
+    _perm_cache: set[str] | None = None
+
+    class Meta:
+        verbose_name = _("api client")
+        verbose_name_plural = _("api clients")
+
+    def __str__(self):
+        return self.name
+
+    def has_perm(self, perm: str):
+        """Return True if the client has the specified permission."""
+
+        if self._perm_cache is None:
+            group_permissions = (
+                Permission.objects.filter(group__group__in=self.groups.all())
+                .values_list("content_type__app_label", "codename")
+                .order_by()
+            )
+            client_permissions = self.client_permissions.values_list(
+                "content_type__app_label", "codename"
+            ).order_by()
+            self._perm_cache = {
+                f"{content_type}.{name}"
+                for content_type, name in (*group_permissions, *client_permissions)
+            }
+        return perm in self._perm_cache
+
+    def has_perms(self, perm_list):
+        """
+        Return True if the client has each of the specified permissions. If
+        object is passed, check if the client has all required perms for it.
+        """
+        if not isinstance(perm_list, Iterable) or isinstance(perm_list, str):
+            raise ValueError("perm_list must be an iterable of permissions.")
+        return all(self.has_perm(perm) for perm in perm_list)
+
+
+class ApiKey(models.Model):
+    PREFIX_LENGTH = 5
+    KEY_LENGTH = 72
+    HASHED_KEY_LENGTH = 136
+
+    name = models.CharField(_("name"), blank=True, default="")
+    prefix = models.CharField(_("prefix"), max_length=PREFIX_LENGTH, editable=False)
+    hashed_key = models.CharField(
+        _("hashed key"), max_length=HASHED_KEY_LENGTH, db_index=True, editable=False
+    )
+    client = models.ForeignKey(
+        ApiClient,
+        verbose_name=_("api client"),
+        related_name="api_keys",
+        on_delete=models.CASCADE,
+    )
+    revoked = models.BooleanField(pgettext_lazy("api key", "revoked"), default=False)
+    created_at = models.DateTimeField(auto_now_add=True)
+
+    class Meta:
+        verbose_name = _("api key")
+        verbose_name_plural = _("api keys")
+        permissions = [("revoke_apikey", "Revoke API keys")]
+
+    def __str__(self):
+        return f"{self.name} ({self.prefix}***)"

api/permissions.py

@@ -0,0 +1,197 @@
+"""Permission classes to be used within ninja-extra controllers.
+
+Some permissions are global (like `IsInGroup` or `IsRoot`),
+and some others are per-object (like `CanView` or `CanEdit`).
+
+Example:
+    ```python
+    # restrict all the routes of this controller
+    # to subscribed users
+    @api_controller("/foo", permissions=[IsSubscriber])
+    class FooController(ControllerBase):
+        @route.get("/bar")
+        def bar_get(self):
+            # This route inherits the permissions of the controller
+            # ...
+
+        @route.bar("/bar/{bar_id}", permissions=[CanView])
+        def bar_get_one(self, bar_id: int):
+            # per-object permission resolution happens
+            # when calling either the `get_object_or_exception`
+            # or `get_object_or_none` method.
+            bar = self.get_object_or_exception(Counter, pk=bar_id)
+
+            # you can also call the `check_object_permission` manually
+            other_bar = Counter.objects.first()
+            self.check_object_permissions(other_bar)
+
+            # ...
+
+        # This route is restricted to counter admins and root users
+        @route.delete(
+            "/bar/{bar_id}",
+            permissions=[IsRoot | IsInGroup(settings.SITH_GROUP_COUNTER_ADMIN_ID)
+        ]
+        def bar_delete(self, bar_id: int):
+            # ...
+    ```
+"""
+
+import operator
+from functools import reduce
+from typing import Any, Callable
+
+from django.contrib.auth.models import Permission
+from django.http import HttpRequest
+from ninja_extra import ControllerBase
+from ninja_extra.permissions import BasePermission
+
+from counter.models import Counter
+
+
+class IsInGroup(BasePermission):
+    """Check that the user is in the group whose primary key is given."""
+
+    def __init__(self, group_pk: int):
+        self._group_pk = group_pk
+
+    def has_permission(self, request: HttpRequest, controller: ControllerBase) -> bool:
+        return request.user.is_in_group(pk=self._group_pk)
+
+
+class HasPerm(BasePermission):
+    """Check that the user has the required perm.
+
+    If multiple perms are given, a comparer function can also be passed,
+    in order to change the way perms are checked.
+
+    Example:
+        ```python
+        @api_controller("/foo")
+        class FooController(ControllerBase):
+            # this route will require both permissions
+            @route.put("/foo", permissions=[HasPerm(["foo.change_foo", "foo.add_foo"])]
+            def foo(self): ...
+
+            # This route will require at least one of the perm,
+            # but it's not mandatory to have all of them
+            @route.put(
+                "/bar",
+                permissions=[HasPerm(["foo.change_bar", "foo.add_bar"], op=operator.or_)],
+            )
+            def bar(self): ...
+        ```
+    """
+
+    def __init__(
+        self,
+        perms: str | Permission | list[str | Permission],
+        op: Callable[[bool, bool], bool] = operator.and_,
+    ):
+        """
+        Args:
+            perms: a permission or a list of permissions the user must have
+            op: An operator to combine multiple permissions (in most cases,
+                it will be either `operator.and_` or `operator.or_`)
+        """
+        super().__init__()
+        if not isinstance(perms, (list, tuple, set)):
+            perms = [perms]
+        self._operator = op
+        self._perms = perms
+
+    def has_permission(self, request: HttpRequest, controller: ControllerBase) -> bool:
+        # if the request has the `auth` property,
+        # it means that the user has been explicitly authenticated
+        # using a django-ninja authentication backend
+        # (whether it is SessionAuth or ApiKeyAuth).
+        # If not, this authentication has not been done, but the user may
+        # still be implicitly authenticated through AuthenticationMiddleware
+        user = request.auth if hasattr(request, "auth") else request.user
+        # `user` may either be a `core.User` or an `api.ApiClient` ;
+        # they are not the same model, but they both implement the `has_perm` method
+        return reduce(self._operator, (user.has_perm(p) for p in self._perms))
+
+
+class IsRoot(BasePermission):
+    """Check that the user is root."""
+
+    def has_permission(self, request: HttpRequest, controller: ControllerBase) -> bool:
+        return request.user.is_root
+
+
+class IsSubscriber(BasePermission):
+    """Check that the user is currently subscribed."""
+
+    def has_permission(self, request: HttpRequest, controller: ControllerBase) -> bool:
+        return request.user.is_subscribed
+
+
+class IsOldSubscriber(BasePermission):
+    """Check that the user has at least one subscription in its history."""
+
+    def has_permission(self, request: HttpRequest, controller: ControllerBase) -> bool:
+        return request.user.was_subscribed
+
+
+class CanView(BasePermission):
+    """Check that this user has the permission to view the object of this route.
+
+    Wrap the `user.can_view(obj)` method.
+    To see an example, look at the example in the module docstring.
+    """
+
+    def has_permission(self, request: HttpRequest, controller: ControllerBase) -> bool:
+        return True
+
+    def has_object_permission(
+        self, request: HttpRequest, controller: ControllerBase, obj: Any
+    ) -> bool:
+        return request.user.can_view(obj)
+
+
+class CanEdit(BasePermission):
+    """Check that this user has the permission to edit the object of this route.
+
+    Wrap the `user.can_edit(obj)` method.
+    To see an example, look at the example in the module docstring.
+    """
+
+    def has_permission(self, request: HttpRequest, controller: ControllerBase) -> bool:
+        return True
+
+    def has_object_permission(
+        self, request: HttpRequest, controller: ControllerBase, obj: Any
+    ) -> bool:
+        return request.user.can_edit(obj)
+
+
+class IsOwner(BasePermission):
+    """Check that this user owns the object of this route.
+
+    Wrap the `user.is_owner(obj)` method.
+    To see an example, look at the example in the module docstring.
+    """
+
+    def has_permission(self, request: HttpRequest, controller: ControllerBase) -> bool:
+        return True
+
+    def has_object_permission(
+        self, request: HttpRequest, controller: ControllerBase, obj: Any
+    ) -> bool:
+        return request.user.is_owner(obj)
+
+
+class IsLoggedInCounter(BasePermission):
+    """Check that a user is logged in a counter."""
+
+    def has_permission(self, request: HttpRequest, controller: ControllerBase) -> bool:
+        if "/counter/" not in request.META.get("HTTP_REFERER", ""):
+            return False
+        token = request.session.get("counter_token")
+        if not token:
+            return False
+        return Counter.objects.filter(token=token).exists()
+
+
+CanAccessLookup = IsLoggedInCounter | HasPerm("core.access_lookup")

api/tests.py

@@ -1,27 +0,0 @@
-# -*- coding:utf-8 -*
-#
-# Copyright 2016,2017
-# - Skia <skia@libskia.so>
-#
-# Ce fichier fait partie du site de l'Association des Étudiants de l'UTBM,
-# http://ae.utbm.fr.
-#
-# This program is free software; you can redistribute it and/or modify it under
-# the terms of the GNU General Public License a published by the Free Software
-# Foundation; either version 3 of the License, or (at your option) any later
-# version.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
-# details.
-#
-# You should have received a copy of the GNU General Public License along with
-# this program; if not, write to the Free Sofware Foundation, Inc., 59 Temple
-# Place - Suite 330, Boston, MA 02111-1307, USA.
-#
-#
-
-from django.test import TestCase
-
-# Create your tests here.

api/tests/test_api_key.py

@@ -0,0 +1,29 @@
+import pytest
+from django.test import RequestFactory
+from model_bakery import baker
+
+from api.auth import ApiKeyAuth
+from api.hashers import generate_key
+from api.models import ApiClient, ApiKey
+
+
+@pytest.mark.django_db
+def test_api_key_auth():
+    key, hashed = generate_key()
+    client = baker.make(ApiClient)
+    baker.make(ApiKey, client=client, hashed_key=hashed)
+    auth = ApiKeyAuth()
+
+    assert auth.authenticate(RequestFactory().get(""), key) == client
+
+
+@pytest.mark.django_db
+@pytest.mark.parametrize(
+    ("key", "hashed"), [(generate_key()[0], generate_key()[1]), (generate_key()[0], "")]
+)
+def test_api_key_auth_invalid(key, hashed):
+    client = baker.make(ApiClient)
+    baker.make(ApiKey, client=client, hashed_key=hashed)
+    auth = ApiKeyAuth()
+
+    assert auth.authenticate(RequestFactory().get(""), key) is None

api/urls.py

@@ -1,56 +1,10 @@
-# -*- coding:utf-8 -*
-#
-# Copyright 2016,2017
-# - Skia <skia@libskia.so>
-#
-# Ce fichier fait partie du site de l'Association des Étudiants de l'UTBM,
-# http://ae.utbm.fr.
-#
-# This program is free software; you can redistribute it and/or modify it under
-# the terms of the GNU General Public License a published by the Free Software
-# Foundation; either version 3 of the License, or (at your option) any later
-# version.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
-# details.
-#
-# You should have received a copy of the GNU General Public License along with
-# this program; if not, write to the Free Sofware Foundation, Inc., 59 Temple
-# Place - Suite 330, Boston, MA 02111-1307, USA.
-#
-#
+from ninja_extra import NinjaExtraAPI
 
-from django.conf.urls import url, include
-
-from api.views import *
-from rest_framework import routers
-
-# Router config
-router = routers.DefaultRouter()
-router.register(r"counter", CounterViewSet, base_name="api_counter")
-router.register(r"user", UserViewSet, base_name="api_user")
-router.register(r"club", ClubViewSet, base_name="api_club")
-router.register(r"group", GroupViewSet, base_name="api_group")
-
-# Launderette
-router.register(
-    r"launderette/place", LaunderettePlaceViewSet, base_name="api_launderette_place"
+api = NinjaExtraAPI(
+    title="PICON",
+    description="Portail Interactif de Communication avec les Outils Numériques",
+    version="0.2.0",
+    urls_namespace="api",
+    csrf=True,
 )
-router.register(
-    r"launderette/machine",
-    LaunderetteMachineViewSet,
-    base_name="api_launderette_machine",
-)
-router.register(
-    r"launderette/token", LaunderetteTokenViewSet, base_name="api_launderette_token"
-)
-
-urlpatterns = [
-    # API
-    url(r"^", include(router.urls)),
-    url(r"^login/", include("rest_framework.urls", namespace="rest_framework")),
-    url(r"^markdown$", RenderMarkdown, name="api_markdown"),
-    url(r"^mailings$", FetchMailingLists, name="mailings_fetch"),
-]
+api.auto_discover_controllers()

api/views/__init__.py

@@ -1,79 +0,0 @@
-# -*- coding:utf-8 -*
-#
-# Copyright 2016,2017
-# - Skia <skia@libskia.so>
-#
-# Ce fichier fait partie du site de l'Association des Étudiants de l'UTBM,
-# http://ae.utbm.fr.
-#
-# This program is free software; you can redistribute it and/or modify it under
-# the terms of the GNU General Public License a published by the Free Software
-# Foundation; either version 3 of the License, or (at your option) any later
-# version.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
-# details.
-#
-# You should have received a copy of the GNU General Public License along with
-# this program; if not, write to the Free Sofware Foundation, Inc., 59 Temple
-# Place - Suite 330, Boston, MA 02111-1307, USA.
-#
-#
-
-from rest_framework.response import Response
-from rest_framework import viewsets
-from django.core.exceptions import PermissionDenied
-from rest_framework.decorators import detail_route
-from django.db.models.query import QuerySet
-
-from core.views import can_view, can_edit
-
-
-def check_if(obj, user, test):
-    """
-        Detect if it's a single object or a queryset
-        aply a given test on individual object and return global permission
-    """
-    if isinstance(obj, QuerySet):
-        for o in obj:
-            if test(o, user) is False:
-                return False
-        return True
-    else:
-        return test(obj, user)
-
-
-class ManageModelMixin:
-    @detail_route()
-    def id(self, request, pk=None):
-        """
-            Get by id (api/v1/router/{pk}/id/)
-        """
-        self.queryset = get_object_or_404(self.queryset.filter(id=pk))
-        serializer = self.get_serializer(self.queryset)
-        return Response(serializer.data)
-
-
-class RightModelViewSet(ManageModelMixin, viewsets.ModelViewSet):
-    def dispatch(self, request, *arg, **kwargs):
-        res = super(RightModelViewSet, self).dispatch(request, *arg, **kwargs)
-        obj = self.queryset
-        user = self.request.user
-        try:
-            if request.method == "GET" and check_if(obj, user, can_view):
-                return res
-            if request.method != "GET" and check_if(obj, user, can_edit):
-                return res
-        except:
-            pass  # To prevent bug with Anonymous user
-        raise PermissionDenied
-
-
-from .api import *
-from .counter import *
-from .user import *
-from .club import *
-from .group import *
-from .launderette import *

api/views/api.py

@@ -1,43 +0,0 @@
-# -*- coding:utf-8 -*
-#
-# Copyright 2016,2017
-# - Skia <skia@libskia.so>
-#
-# Ce fichier fait partie du site de l'Association des Étudiants de l'UTBM,
-# http://ae.utbm.fr.
-#
-# This program is free software; you can redistribute it and/or modify it under
-# the terms of the GNU General Public License a published by the Free Software
-# Foundation; either version 3 of the License, or (at your option) any later
-# version.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
-# details.
-#
-# You should have received a copy of the GNU General Public License along with
-# this program; if not, write to the Free Sofware Foundation, Inc., 59 Temple
-# Place - Suite 330, Boston, MA 02111-1307, USA.
-#
-#
-
-from rest_framework.response import Response
-from rest_framework.decorators import api_view, renderer_classes
-from rest_framework.renderers import StaticHTMLRenderer
-from rest_framework.views import APIView
-
-from core.templatetags.renderer import markdown
-
-
-@api_view(["POST"])
-@renderer_classes((StaticHTMLRenderer,))
-def RenderMarkdown(request):
-    """
-        Render Markdown
-    """
-    try:
-        data = markdown(request.POST["text"])
-    except:
-        data = "Error"
-    return Response(data)

api/views/club.py

@@ -1,64 +0,0 @@
-# -*- coding:utf-8 -*
-#
-# Copyright 2016,2017
-# - Skia <skia@libskia.so>
-#
-# Ce fichier fait partie du site de l'Association des Étudiants de l'UTBM,
-# http://ae.utbm.fr.
-#
-# This program is free software; you can redistribute it and/or modify it under
-# the terms of the GNU General Public License a published by the Free Software
-# Foundation; either version 3 of the License, or (at your option) any later
-# version.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
-# details.
-#
-# You should have received a copy of the GNU General Public License along with
-# this program; if not, write to the Free Sofware Foundation, Inc., 59 Temple
-# Place - Suite 330, Boston, MA 02111-1307, USA.
-#
-#
-
-from rest_framework.response import Response
-from rest_framework import serializers
-from rest_framework.decorators import api_view, renderer_classes
-from rest_framework.renderers import StaticHTMLRenderer
-
-from django.conf import settings
-from django.core.exceptions import PermissionDenied
-
-from club.models import Club, Mailing
-
-from api.views import RightModelViewSet
-
-
-class ClubSerializer(serializers.ModelSerializer):
-    class Meta:
-        model = Club
-        fields = ("id", "name", "unix_name", "address", "members")
-
-
-class ClubViewSet(RightModelViewSet):
-    """
-        Manage Clubs (api/v1/club/)
-    """
-
-    serializer_class = ClubSerializer
-    queryset = Club.objects.all()
-
-
-@api_view(["GET"])
-@renderer_classes((StaticHTMLRenderer,))
-def FetchMailingLists(request):
-    key = request.GET.get("key", "")
-    if key != settings.SITH_MAILING_FETCH_KEY:
-        raise PermissionDenied
-    data = ""
-    for mailing in Mailing.objects.filter(
-        is_moderated=True, club__is_active=True
-    ).all():
-        data += mailing.fetch_format() + "\n"
-    return Response(data)

api/views/counter.py

@@ -1,61 +0,0 @@
-# -*- coding:utf-8 -*
-#
-# Copyright 2016,2017
-# - Skia <skia@libskia.so>
-#
-# Ce fichier fait partie du site de l'Association des Étudiants de l'UTBM,
-# http://ae.utbm.fr.
-#
-# This program is free software; you can redistribute it and/or modify it under
-# the terms of the GNU General Public License a published by the Free Software
-# Foundation; either version 3 of the License, or (at your option) any later
-# version.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
-# details.
-#
-# You should have received a copy of the GNU General Public License along with
-# this program; if not, write to the Free Sofware Foundation, Inc., 59 Temple
-# Place - Suite 330, Boston, MA 02111-1307, USA.
-#
-#
-
-from rest_framework import serializers
-from rest_framework.response import Response
-from rest_framework.decorators import list_route
-
-from counter.models import Counter
-
-from api.views import RightModelViewSet
-
-
-class CounterSerializer(serializers.ModelSerializer):
-
-    is_open = serializers.BooleanField(read_only=True)
-    barman_list = serializers.ListField(
-        child=serializers.IntegerField(), read_only=True
-    )
-
-    class Meta:
-        model = Counter
-        fields = ("id", "name", "type", "club", "products", "is_open", "barman_list")
-
-
-class CounterViewSet(RightModelViewSet):
-    """
-        Manage Counters (api/v1/counter/)
-    """
-
-    serializer_class = CounterSerializer
-    queryset = Counter.objects.all()
-
-    @list_route()
-    def bar(self, request):
-        """
-            Return all bars (api/v1/counter/bar/)
-        """
-        self.queryset = self.queryset.filter(type="BAR")
-        serializer = self.get_serializer(self.queryset, many=True)
-        return Response(serializer.data)

api/views/launderette.py

@@ -1,137 +0,0 @@
-# -*- coding:utf-8 -*
-#
-# Copyright 2016,2017
-# - Skia <skia@libskia.so>
-#
-# Ce fichier fait partie du site de l'Association des Étudiants de l'UTBM,
-# http://ae.utbm.fr.
-#
-# This program is free software; you can redistribute it and/or modify it under
-# the terms of the GNU General Public License a published by the Free Software
-# Foundation; either version 3 of the License, or (at your option) any later
-# version.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
-# details.
-#
-# You should have received a copy of the GNU General Public License along with
-# this program; if not, write to the Free Sofware Foundation, Inc., 59 Temple
-# Place - Suite 330, Boston, MA 02111-1307, USA.
-#
-#
-
-from rest_framework import serializers
-from rest_framework.response import Response
-from rest_framework.decorators import list_route
-
-from launderette.models import Launderette, Machine, Token
-
-from api.views import RightModelViewSet
-
-
-class LaunderettePlaceSerializer(serializers.ModelSerializer):
-
-    machine_list = serializers.ListField(
-        child=serializers.IntegerField(), read_only=True
-    )
-    token_list = serializers.ListField(child=serializers.IntegerField(), read_only=True)
-
-    class Meta:
-        model = Launderette
-        fields = (
-            "id",
-            "name",
-            "counter",
-            "machine_list",
-            "token_list",
-            "get_absolute_url",
-        )
-
-
-class LaunderetteMachineSerializer(serializers.ModelSerializer):
-    class Meta:
-        model = Machine
-        fields = ("id", "name", "type", "is_working", "launderette")
-
-
-class LaunderetteTokenSerializer(serializers.ModelSerializer):
-    class Meta:
-        model = Token
-        fields = (
-            "id",
-            "name",
-            "type",
-            "launderette",
-            "borrow_date",
-            "user",
-            "is_avaliable",
-        )
-
-
-class LaunderettePlaceViewSet(RightModelViewSet):
-    """
-        Manage Launderette (api/v1/launderette/place/)
-    """
-
-    serializer_class = LaunderettePlaceSerializer
-    queryset = Launderette.objects.all()
-
-
-class LaunderetteMachineViewSet(RightModelViewSet):
-    """
-        Manage Washing Machines (api/v1/launderette/machine/)
-    """
-
-    serializer_class = LaunderetteMachineSerializer
-    queryset = Machine.objects.all()
-
-
-class LaunderetteTokenViewSet(RightModelViewSet):
-    """
-        Manage Launderette's tokens (api/v1/launderette/token/)
-    """
-
-    serializer_class = LaunderetteTokenSerializer
-    queryset = Token.objects.all()
-
-    @list_route()
-    def washing(self, request):
-        """
-            Return all washing tokens (api/v1/launderette/token/washing)
-        """
-        self.queryset = self.queryset.filter(type="WASHING")
-        serializer = self.get_serializer(self.queryset, many=True)
-        return Response(serializer.data)
-
-    @list_route()
-    def drying(self, request):
-        """
-            Return all drying tokens (api/v1/launderette/token/drying)
-        """
-        self.queryset = self.queryset.filter(type="DRYING")
-        serializer = self.get_serializer(self.queryset, many=True)
-        return Response(serializer.data)
-
-    @list_route()
-    def avaliable(self, request):
-        """
-            Return all avaliable tokens (api/v1/launderette/token/avaliable)
-        """
-        self.queryset = self.queryset.filter(
-            borrow_date__isnull=True, user__isnull=True
-        )
-        serializer = self.get_serializer(self.queryset, many=True)
-        return Response(serializer.data)
-
-    @list_route()
-    def unavaliable(self, request):
-        """
-            Return all unavaliable tokens (api/v1/launderette/token/unavaliable)
-        """
-        self.queryset = self.queryset.filter(
-            borrow_date__isnull=False, user__isnull=False
-        )
-        serializer = self.get_serializer(self.queryset, many=True)
-        return Response(serializer.data)

api/views/user.py

@@ -1,68 +0,0 @@
-# -*- coding:utf-8 -*
-#
-# Copyright 2016,2017
-# - Skia <skia@libskia.so>
-#
-# Ce fichier fait partie du site de l'Association des Étudiants de l'UTBM,
-# http://ae.utbm.fr.
-#
-# This program is free software; you can redistribute it and/or modify it under
-# the terms of the GNU General Public License a published by the Free Software
-# Foundation; either version 3 of the License, or (at your option) any later
-# version.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
-# details.
-#
-# You should have received a copy of the GNU General Public License along with
-# this program; if not, write to the Free Sofware Foundation, Inc., 59 Temple
-# Place - Suite 330, Boston, MA 02111-1307, USA.
-#
-#
-
-import datetime
-
-from rest_framework import serializers
-from rest_framework.response import Response
-from rest_framework.decorators import list_route
-
-from core.models import User
-
-from api.views import RightModelViewSet
-
-
-class UserSerializer(serializers.ModelSerializer):
-    class Meta:
-        model = User
-        fields = (
-            "id",
-            "first_name",
-            "last_name",
-            "email",
-            "date_of_birth",
-            "nick_name",
-            "is_active",
-            "date_joined",
-        )
-
-
-class UserViewSet(RightModelViewSet):
-    """
-        Manage Users (api/v1/user/)
-        Only show active users
-    """
-
-    serializer_class = UserSerializer
-    queryset = User.objects.filter(is_active=True)
-
-    @list_route()
-    def birthday(self, request):
-        """
-            Return all users born today (api/v1/user/birstdays)
-        """
-        date = datetime.datetime.today()
-        self.queryset = self.queryset.filter(date_of_birth=date)
-        serializer = self.get_serializer(self.queryset, many=True)
-        return Response(serializer.data)

biome.json

@@ -0,0 +1,29 @@
+{
+  "$schema": "./node_modules/@biomejs/biome/configuration_schema.json",
+  "vcs": {
+    "enabled": true,
+    "clientKind": "git",
+    "useIgnoreFile": true
+  },
+  "files": {
+    "ignoreUnknown": false,
+    "ignore": ["*.min.*", "staticfiles/generated"]
+  },
+  "formatter": {
+    "enabled": true,
+    "indentStyle": "space",
+    "lineWidth": 88
+  },
+  "organizeImports": {
+    "enabled": true
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "all": true
+    }
+  },
+  "javascript": {
+    "globals": ["Alpine", "$", "jQuery", "gettext", "interpolate"]
+  }
+}

club/__init__.py

@@ -1,23 +1,14 @@
-# -*- coding:utf-8 -*
 #
-# Copyright 2016,2017
-# - Skia <skia@libskia.so>
+# Copyright 2023 © AE UTBM
+# ae@utbm.fr / ae.info@utbm.fr
 #
-# Ce fichier fait partie du site de l'Association des Étudiants de l'UTBM,
-# http://ae.utbm.fr.
+# This file is part of the website of the UTBM Student Association (AE UTBM),
+# https://ae.utbm.fr.
 #
-# This program is free software; you can redistribute it and/or modify it under
-# the terms of the GNU General Public License a published by the Free Software
-# Foundation; either version 3 of the License, or (at your option) any later
-# version.
+# You can find the source code of the website at https://github.com/ae-utbm/sith
 #
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
-# details.
-#
-# You should have received a copy of the GNU General Public License along with
-# this program; if not, write to the Free Sofware Foundation, Inc., 59 Temple
-# Place - Suite 330, Boston, MA 02111-1307, USA.
+# LICENSED UNDER THE GNU GENERAL PUBLIC LICENSE VERSION 3 (GPLv3)
+# SEE : https://raw.githubusercontent.com/ae-utbm/sith/master/LICENSE
+# OR WITHIN THE LOCAL FILE "LICENSE"
 #
 #

club/admin.py

@@ -1,31 +1,42 @@
-# -*- coding:utf-8 -*
 #
-# Copyright 2016,2017
-# - Skia <skia@libskia.so>
+# Copyright 2023 © AE UTBM
+# ae@utbm.fr / ae.info@utbm.fr
 #
-# Ce fichier fait partie du site de l'Association des Étudiants de l'UTBM,
-# http://ae.utbm.fr.
+# This file is part of the website of the UTBM Student Association (AE UTBM),
+# https://ae.utbm.fr.
 #
-# This program is free software; you can redistribute it and/or modify it under
-# the terms of the GNU General Public License a published by the Free Software
-# Foundation; either version 3 of the License, or (at your option) any later
-# version.
+# You can find the source code of the website at https://github.com/ae-utbm/sith
 #
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
-# details.
-#
-# You should have received a copy of the GNU General Public License along with
-# this program; if not, write to the Free Sofware Foundation, Inc., 59 Temple
-# Place - Suite 330, Boston, MA 02111-1307, USA.
+# LICENSED UNDER THE GNU GENERAL PUBLIC LICENSE VERSION 3 (GPLv3)
+# SEE : https://raw.githubusercontent.com/ae-utbm/sith/master/LICENSE
+# OR WITHIN THE LOCAL FILE "LICENSE"
 #
 #
-
 from django.contrib import admin
 
 from club.models import Club, Membership
 
 
-admin.site.register(Club)
-admin.site.register(Membership)
+@admin.register(Club)
+class ClubAdmin(admin.ModelAdmin):
+    list_display = ("name", "slug_name", "parent", "is_active")
+    search_fields = ("name", "slug_name")
+    autocomplete_fields = (
+        "parent",
+        "board_group",
+        "members_group",
+        "home",
+        "page",
+    )
+
+
+@admin.register(Membership)
+class MembershipAdmin(admin.ModelAdmin):
+    list_display = ("user", "club", "role", "start_date", "end_date")
+    search_fields = (
+        "user__username",
+        "user__first_name",
+        "user__last_name",
+        "club__name",
+    )
+    autocomplete_fields = ("user",)

club/api.py

@@ -0,0 +1,44 @@
+from django.db.models import Prefetch
+from ninja import Query
+from ninja.security import SessionAuth
+from ninja_extra import ControllerBase, api_controller, paginate, route
+from ninja_extra.pagination import PageNumberPaginationExtra
+from ninja_extra.schemas import PaginatedResponseSchema
+
+from api.auth import ApiKeyAuth
+from api.permissions import CanAccessLookup, HasPerm
+from club.models import Club, Membership
+from club.schemas import ClubSchema, ClubSearchFilterSchema, SimpleClubSchema
+
+
+@api_controller("/club")
+class ClubController(ControllerBase):
+    @route.get(
+        "/search",
+        response=PaginatedResponseSchema[SimpleClubSchema],
+        auth=[SessionAuth(), ApiKeyAuth()],
+        permissions=[CanAccessLookup],
+        url_name="search_club",
+    )
+    @paginate(PageNumberPaginationExtra, page_size=50)
+    def search_club(
+        self,
+        filters: Query[ClubSearchFilterSchema],
+    ):
+        clubs = Club.objects.all()
+        return filters.filter(clubs)
+
+    @route.get(
+        "/{int:club_id}",
+        response=ClubSchema,
+        auth=[SessionAuth(), ApiKeyAuth()],
+        permissions=[HasPerm("club.view_club")],
+        url_name="fetch_club",
+    )
+    def fetch_club(self, club_id: int):
+        prefetch = Prefetch(
+            "members", queryset=Membership.objects.ongoing().select_related("user")
+        )
+        return self.get_object_or_exception(
+            Club.objects.prefetch_related(prefetch), id=club_id
+        )

club/forms.py

@@ -1,4 +1,3 @@
-# -*- coding:utf-8 -*
 #
 # Copyright 2016,2017
 # - Skia <skia@libskia.so>
@@ -23,50 +22,60 @@
 #
 #
 
-from django.conf import settings
 from django import forms
-from django.utils.translation import ugettext_lazy as _
-
-from ajax_select.fields import AutoCompleteSelectField, AutoCompleteSelectMultipleField
-
-from club.models import Mailing, MailingSubscription, Club, Membership
+from django.conf import settings
+from django.db.models import Exists, OuterRef, Q
+from django.db.models.functions import Lower
+from django.utils.functional import cached_property
+from django.utils.translation import gettext_lazy as _
 
+from club.models import Club, Mailing, MailingSubscription, Membership
 from core.models import User
-from core.views.forms import SelectDate, SelectDateTime
-from counter.models import Counter
+from core.views.forms import SelectDateTime
+from core.views.widgets.ajax_select import (
+    AutoCompleteSelectMultipleUser,
+    AutoCompleteSelectUser,
+)
+from counter.models import Counter, Selling
 
 
 class ClubEditForm(forms.ModelForm):
+    error_css_class = "error"
+    required_css_class = "required"
+
     class Meta:
         model = Club
         fields = ["address", "logo", "short_description"]
+        widgets = {"short_description": forms.Textarea()}
 
-    def __init__(self, *args, **kwargs):
-        super(ClubEditForm, self).__init__(*args, **kwargs)
-        self.fields["short_description"].widget = forms.Textarea()
+
+class ClubAdminEditForm(ClubEditForm):
+    admin_fields = ["name", "parent", "is_active"]
+
+    class Meta(ClubEditForm.Meta):
+        fields = ["name", "parent", "is_active", *ClubEditForm.Meta.fields]
 
 
 class MailingForm(forms.Form):
-    """
-    Form handling mailing lists right
-    """
+    """Form handling mailing lists right."""
 
     ACTION_NEW_MAILING = 1
     ACTION_NEW_SUBSCRIPTION = 2
     ACTION_REMOVE_SUBSCRIPTION = 3
 
-    subscription_users = AutoCompleteSelectMultipleField(
-        "users",
+    subscription_users = forms.ModelMultipleChoiceField(
         label=_("Users to add"),
         help_text=_("Search users to add (one or more)."),
         required=False,
+        widget=AutoCompleteSelectMultipleUser,
+        queryset=User.objects.all(),
     )
 
     def __init__(self, club_id, user_id, mailings, *args, **kwargs):
-        super(MailingForm, self).__init__(*args, **kwargs)
+        super().__init__(*args, **kwargs)
 
         self.fields["action"] = forms.TypedChoiceField(
-            (
+            choices=(
                 (self.ACTION_NEW_MAILING, _("New Mailing")),
                 (self.ACTION_NEW_SUBSCRIPTION, _("Subscribe")),
                 (self.ACTION_REMOVE_SUBSCRIPTION, _("Remove")),
@@ -108,24 +117,15 @@ class MailingForm(forms.Form):
         )
 
     def check_required(self, cleaned_data, field):
-        """
-        If the given field doesn't exist or has no value, add a required error on it
-        """
+        """If the given field doesn't exist or has no value, add a required error on it."""
         if not cleaned_data.get(field, None):
             self.add_error(field, _("This field is required"))
 
     def clean_subscription_users(self):
-        """
-        Convert given users into real users and check their validity
-        """
-        cleaned_data = super(MailingForm, self).clean()
+        """Convert given users into real users and check their validity."""
+        cleaned_data = super().clean()
         users = []
         for user in cleaned_data["subscription_users"]:
-            user = User.objects.filter(id=user).first()
-            if not user:
-                raise forms.ValidationError(
-                    _("One of the selected users doesn't exist"), code="invalid"
-                )
             if not user.email:
                 raise forms.ValidationError(
                     _("One of the selected users doesn't have an email address"),
@@ -135,9 +135,9 @@ class MailingForm(forms.Form):
         return users
 
     def clean(self):
-        cleaned_data = super(MailingForm, self).clean()
+        cleaned_data = super().clean()
 
-        if not "action" in cleaned_data:
+        if "action" not in cleaned_data:
             # If there is no action provided, we can stop here
             raise forms.ValidationError(_("An action is required"), code="invalid")
 
@@ -157,135 +157,148 @@ class MailingForm(forms.Form):
         return cleaned_data
 
 
-class SellingsFormBase(forms.Form):
+class SellingsForm(forms.Form):
     begin_date = forms.DateTimeField(
-        ["%Y-%m-%d %H:%M:%S"],
-        label=_("Begin date"),
-        required=False,
-        widget=SelectDateTime,
+        label=_("Begin date"), widget=SelectDateTime, required=False
     )
     end_date = forms.DateTimeField(
-        ["%Y-%m-%d %H:%M:%S"],
-        label=_("End date"),
+        label=_("End date"), widget=SelectDateTime, required=False
+    )
+
+    def __init__(self, club, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        # postgres struggles really hard with a single query having three WHERE conditions,
+        # but deals perfectly fine with UNION of multiple queryset with their own WHERE clause,
+        # so we do this to get the ids, which we use to build another queryset that can be used by django.
+        club_sales_subquery = Selling.objects.filter(counter=OuterRef("pk"), club=club)
+        ids = (
+            Counter.objects.filter(Q(club=club) | Q(products__club=club))
+            .union(Counter.objects.filter(Exists(club_sales_subquery)))
+            .values_list("id", flat=True)
+        )
+        counters_qs = Counter.objects.filter(id__in=ids).order_by(Lower("name"))
+        self.fields["counters"] = forms.ModelMultipleChoiceField(
+            counters_qs, label=_("Counter"), required=False
+        )
+        self.fields["products"] = forms.ModelMultipleChoiceField(
+            club.products.order_by("name").filter(archived=False).all(),
+            label=_("Products"),
+            required=False,
+        )
+        self.fields["archived_products"] = forms.ModelMultipleChoiceField(
+            club.products.order_by("name").filter(archived=True).all(),
+            label=_("Archived products"),
+            required=False,
+        )
+
+
+class ClubOldMemberForm(forms.Form):
+    members_old = forms.ModelMultipleChoiceField(
+        Membership.objects.none(),
+        label=_("Mark as old"),
+        widget=forms.CheckboxSelectMultiple,
         required=False,
-        widget=SelectDateTime,
-    )
-    counter = forms.ModelChoiceField(
-        Counter.objects.order_by("name").all(), label=_("Counter"), required=False
     )
 
+    def __init__(self, *args, user: User, club: Club, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.fields["members_old"].queryset = (
+            Membership.objects.ongoing().filter(club=club).editable_by(user)
+        )
 
-class ClubMemberForm(forms.Form):
-    """
-    Form handling the members of a club
-    """
+
+class ClubMemberForm(forms.ModelForm):
+    """Form to add a member to the club, as a board member."""
 
     error_css_class = "error"
     required_css_class = "required"
 
-    users = AutoCompleteSelectMultipleField(
-        "users",
-        label=_("Users to add"),
-        help_text=_("Search users to add (one or more)."),
-        required=False,
-    )
+    class Meta:
+        model = Membership
+        fields = ["role", "description"]
 
-    def __init__(self, *args, **kwargs):
-        self.club = kwargs.pop("club")
-        self.request_user = kwargs.pop("request_user")
-        self.club_members = kwargs.pop("club_members", None)
-        if not self.club_members:
-            self.club_members = (
-                self.club.members.filter(end_date=None).order_by("-role").all()
-            )
+    def __init__(self, *args, club: Club, request_user: User, **kwargs):
+        self.club = club
+        self.request_user = request_user
         self.request_user_membership = self.club.get_membership_for(self.request_user)
-        super(ClubMemberForm, self).__init__(*args, **kwargs)
+        super().__init__(*args, **kwargs)
+        self.fields["role"].required = True
+        self.fields["role"].choices = [
+            (value, name)
+            for value, name in settings.SITH_CLUB_ROLES.items()
+            if value <= self.max_available_role
+        ]
+        self.instance.club = club
 
-        # Using a ModelForm binds too much the form with the model and we don't want that
-        # We want the view to process the model creation since they are multiple users
-        # We also want the form to handle bulk deletion
-        self.fields.update(
-            forms.fields_for_model(
-                Membership,
-                fields=("role", "start_date", "description"),
-                widgets={"start_date": SelectDate},
+    @property
+    def max_available_role(self):
+        """The greatest role that will be obtainable with this form."""
+        # this is unreachable, because it will be overridden by subclasses
+        return -1  # pragma: no cover
+
+
+class ClubAddMemberForm(ClubMemberForm):
+    """Form to add a member to the club, as a board member."""
+
+    class Meta(ClubMemberForm.Meta):
+        fields = ["user", *ClubMemberForm.Meta.fields]
+        widgets = {"user": AutoCompleteSelectUser}
+
+    @cached_property
+    def max_available_role(self):
+        """The greatest role that will be obtainable with this form.
+
+        Admins and the club president can attribute any role.
+        Board members can attribute roles lower than their own.
+        Other users cannot attribute roles with this form
+        """
+        if self.request_user.has_perm("club.add_membership"):
+            return settings.SITH_CLUB_ROLES_ID["President"]
+        membership = self.request_user_membership
+        if membership is None or membership.role <= settings.SITH_MAXIMUM_FREE_ROLE:
+            return -1
+        if membership.role == settings.SITH_CLUB_ROLES_ID["President"]:
+            return membership.role
+        return membership.role - 1
+
+    def clean_user(self):
+        """Check that the user is not trying to add a user already in the club.
+
+        Also check that the user is valid and has a valid subscription.
+        """
+        user = self.cleaned_data["user"]
+        if not user.is_subscribed:
+            raise forms.ValidationError(
+                _("User must be subscriber to take part to a club"), code="invalid"
             )
-        )
+        if self.club.get_membership_for(user):
+            raise forms.ValidationError(
+                _("You can not add the same user twice"), code="invalid"
+            )
+        return user
 
-        # Role is required only if users is specified
-        self.fields["role"].required = False
 
-        # Start date and description are never really required
-        self.fields["start_date"].required = False
-        self.fields["description"].required = False
+class JoinClubForm(ClubMemberForm):
+    """Form to join a club."""
 
-        self.fields["users_old"] = forms.ModelMultipleChoiceField(
-            User.objects.filter(
-                id__in=[
-                    ms.user.id
-                    for ms in self.club_members
-                    if ms.can_be_edited_by(
-                        self.request_user, self.request_user_membership
-                    )
-                ]
-            ).all(),
-            label=_("Mark as old"),
-            required=False,
-            widget=forms.CheckboxSelectMultiple,
-        )
-        if not self.request_user.is_root:
-            self.fields.pop("start_date")
+    def __init__(self, *args, club: Club, request_user: User, **kwargs):
+        super().__init__(*args, club=club, request_user=request_user, **kwargs)
+        # this form doesn't manage the user who will join the club,
+        # so we must set this here to avoid errors
+        self.instance.user = self.request_user
 
-    def clean_users(self):
-        """
-            Check that the user is not trying to add an user already in the club
-            Also check that the user is valid and has a valid subscription
-        """
-        cleaned_data = super(ClubMemberForm, self).clean()
-        users = []
-        for user_id in cleaned_data["users"]:
-            user = User.objects.filter(id=user_id).first()
-            if not user:
-                raise forms.ValidationError(
-                    _("One of the selected users doesn't exist"), code="invalid"
-                )
-            if not user.is_subscribed:
-                raise forms.ValidationError(
-                    _("User must be subscriber to take part to a club"), code="invalid"
-                )
-            if self.club.get_membership_for(user):
-                raise forms.ValidationError(
-                    _("You can not add the same user twice"), code="invalid"
-                )
-            users.append(user)
-        return users
+    @cached_property
+    def max_available_role(self):
+        return settings.SITH_MAXIMUM_FREE_ROLE
 
     def clean(self):
-        """
-            Check user rights for adding an user
-        """
-        cleaned_data = super(ClubMemberForm, self).clean()
-
-        if "start_date" in cleaned_data and not cleaned_data["start_date"]:
-            # Drop start_date if allowed to edition but not specified
-            cleaned_data.pop("start_date")
-
-        if not cleaned_data.get("users"):
-            # No user to add equals no check needed
-            return cleaned_data
-
-        if cleaned_data.get("role", "") == "":
-            # Role is required if users exists
-            self.add_error("role", _("You should specify a role"))
-            return cleaned_data
-
-        request_user = self.request_user
-        membership = self.request_user_membership
-        if not (
-            cleaned_data["role"] <= settings.SITH_MAXIMUM_FREE_ROLE
-            or (membership is not None and membership.role >= cleaned_data["role"])
-            or request_user.is_board_member
-            or request_user.is_root
-        ):
-            raise forms.ValidationError(_("You do not have the permission to do that"))
-        return cleaned_data
+        """Check that the user is subscribed and isn't already in the club."""
+        if not self.request_user.is_subscribed:
+            raise forms.ValidationError(
+                _("You must be subscribed to join a club"), code="invalid"
+            )
+        if self.club.get_membership_for(self.request_user):
+            raise forms.ValidationError(
+                _("You are already a member of this club"), code="invalid"
+            )
+        return super().clean()

club/migrations/0001_initial.py

@@ -1,12 +1,11 @@
-# -*- coding: utf-8 -*-
 from __future__ import unicode_literals
 
-from django.db import migrations, models
 import django.core.validators
+import django.db.models.deletion
+from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
-
     dependencies = []
 
     operations = [
@@ -90,7 +89,10 @@ class Migration(migrations.Migration):
                 (
                     "club",
                     models.ForeignKey(
-                        verbose_name="club", to="club.Club", related_name="members"
+                        verbose_name="club",
+                        to="club.Club",
+                        related_name="members",
+                        on_delete=django.db.models.deletion.CASCADE,
                     ),
                 ),
             ],

club/migrations/0002_auto_20160824_2152.py

@@ -1,12 +1,11 @@
-# -*- coding: utf-8 -*-
 from __future__ import unicode_literals
 
-from django.db import migrations, models
+import django.db.models.deletion
 from django.conf import settings
+from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         migrations.swappable_dependency(settings.AUTH_USER_MODEL),
         ("club", "0001_initial"),
@@ -18,6 +17,7 @@ class Migration(migrations.Migration):
             model_name="membership",
             name="user",
             field=models.ForeignKey(
+                on_delete=django.db.models.deletion.CASCADE,
                 verbose_name="user",
                 to=settings.AUTH_USER_MODEL,
                 related_name="membership",
@@ -34,6 +34,7 @@ class Migration(migrations.Migration):
             model_name="club",
             name="home",
             field=models.OneToOneField(
+                on_delete=django.db.models.deletion.CASCADE,
                 blank=True,
                 null=True,
                 related_name="home_of_club",
@@ -45,14 +46,21 @@ class Migration(migrations.Migration):
             model_name="club",
             name="owner_group",
             field=models.ForeignKey(
-                default=1, to="core.Group", related_name="owned_club"
+                on_delete=django.db.models.deletion.CASCADE,
+                default=1,
+                to="core.Group",
+                related_name="owned_club",
             ),
         ),
         migrations.AddField(
             model_name="club",
             name="parent",
             field=models.ForeignKey(
-                null=True, to="club.Club", related_name="children", blank=True
+                on_delete=django.db.models.deletion.CASCADE,
+                null=True,
+                to="club.Club",
+                related_name="children",
+                blank=True,
             ),
         ),
         migrations.AddField(

club/migrations/0003_auto_20160902_2042.py

@@ -1,11 +1,9 @@
-# -*- coding: utf-8 -*-
 from __future__ import unicode_literals
 
 from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
-
     dependencies = [("club", "0002_auto_20160824_2152")]
 
     operations = [

club/migrations/0004_auto_20160915_1057.py

@@ -1,12 +1,11 @@
-# -*- coding: utf-8 -*-
 from __future__ import unicode_literals
 
-from django.db import migrations, models
+import django.db.models.deletion
 from django.conf import settings
+from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
-
     dependencies = [("club", "0003_auto_20160902_2042")]
 
     operations = [
@@ -14,6 +13,7 @@ class Migration(migrations.Migration):
             model_name="membership",
             name="user",
             field=models.ForeignKey(
+                on_delete=django.db.models.deletion.CASCADE,
                 verbose_name="user",
                 related_name="memberships",
                 to=settings.AUTH_USER_MODEL,

club/migrations/0005_auto_20161120_1149.py

@@ -1,12 +1,10 @@
-# -*- coding: utf-8 -*-
 from __future__ import unicode_literals
 
-from django.db import migrations, models
 import django.db.models.deletion
+from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
-
     dependencies = [("club", "0004_auto_20160915_1057")]
 
     operations = [

club/migrations/0006_auto_20161229_0040.py

@@ -1,12 +1,10 @@
-# -*- coding: utf-8 -*-
 from __future__ import unicode_literals
 
-from django.db import migrations, models
 import django.utils.timezone
+from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
-
     dependencies = [("club", "0005_auto_20161120_1149")]
 
     operations = [

club/migrations/0007_auto_20170324_0917.py

@@ -1,11 +1,9 @@
-# -*- coding: utf-8 -*-
 from __future__ import unicode_literals
 
-from django.db import migrations, models
+from django.db import migrations
 
 
 class Migration(migrations.Migration):
-
     dependencies = [("club", "0006_auto_20161229_0040")]
 
     operations = [

club/migrations/0008_auto_20170515_2214.py

@@ -1,11 +1,9 @@
-# -*- coding: utf-8 -*-
 from __future__ import unicode_literals
 
 from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
-
     dependencies = [("club", "0007_auto_20170324_0917")]
 
     operations = [

club/migrations/0009_auto_20170822_2232.py

@@ -1,14 +1,14 @@
-# -*- coding: utf-8 -*-
 from __future__ import unicode_literals
 
-from django.db import migrations, models
-from django.conf import settings
 import re
+
 import django.core.validators
+import django.db.models.deletion
+from django.conf import settings
+from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         migrations.swappable_dependency(settings.AUTH_USER_MODEL),
         ("club", "0008_auto_20170515_2214"),
@@ -51,12 +51,16 @@ class Migration(migrations.Migration):
                 (
                     "club",
                     models.ForeignKey(
-                        verbose_name="Club", related_name="mailings", to="club.Club"
+                        on_delete=django.db.models.deletion.CASCADE,
+                        verbose_name="Club",
+                        related_name="mailings",
+                        to="club.Club",
                     ),
                 ),
                 (
                     "moderator",
                     models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
                         null=True,
                         verbose_name="moderator",
                         related_name="moderated_mailings",
@@ -84,6 +88,7 @@ class Migration(migrations.Migration):
                 (
                     "mailing",
                     models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
                         verbose_name="Mailing",
                         related_name="subscriptions",
                         to="club.Mailing",
@@ -92,6 +97,7 @@ class Migration(migrations.Migration):
                 (
                     "user",
                     models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
                         null=True,
                         verbose_name="User",
                         related_name="mailing_subscriptions",
@@ -103,6 +109,6 @@ class Migration(migrations.Migration):
         ),
         migrations.AlterUniqueTogether(
             name="mailingsubscription",
-            unique_together=set([("user", "email", "mailing")]),
+            unique_together={("user", "email", "mailing")},
         ),
     ]

club/migrations/0010_auto_20170912_2028.py

@@ -1,24 +1,10 @@
-# -*- coding: utf-8 -*-
 from __future__ import unicode_literals
 
+import django.db.models.deletion
 from django.db import migrations, models
 
-from club.models import Club
-from core.operations import PsqlRunOnly
-
-
-def generate_club_pages(apps, schema_editor):
-    def recursive_generate_club_page(club):
-        club.make_page()
-        for child in Club.objects.filter(parent=club).all():
-            recursive_generate_club_page(child)
-
-    for club in Club.objects.filter(parent=None).all():
-        recursive_generate_club_page(club)
-
 
 class Migration(migrations.Migration):
-
     dependencies = [("core", "0024_auto_20170906_1317"), ("club", "0010_club_logo")]
 
     operations = [
@@ -31,7 +17,11 @@ class Migration(migrations.Migration):
             model_name="club",
             name="page",
             field=models.OneToOneField(
-                related_name="club", blank=True, null=True, to="core.Page"
+                on_delete=django.db.models.deletion.CASCADE,
+                related_name="club",
+                blank=True,
+                null=True,
+                to="core.Page",
             ),
         ),
         migrations.AddField(
@@ -45,11 +35,4 @@ class Migration(migrations.Migration):
                 null=True,
             ),
         ),
-        PsqlRunOnly(
-            "SET CONSTRAINTS ALL IMMEDIATE", reverse_sql=migrations.RunSQL.noop
-        ),
-        migrations.RunPython(generate_club_pages),
-        PsqlRunOnly(
-            migrations.RunSQL.noop, reverse_sql="SET CONSTRAINTS ALL IMMEDIATE"
-        ),
     ]

club/migrations/0010_club_logo.py

@@ -1,11 +1,9 @@
-# -*- coding: utf-8 -*-
 from __future__ import unicode_literals
 
 from django.db import migrations, models
 
 
 class Migration(migrations.Migration):
-
     dependencies = [("club", "0009_auto_20170822_2232")]
 
     operations = [

club/migrations/0011_auto_20180426_2013.py

@@ -1,12 +1,11 @@
-# -*- coding: utf-8 -*-
 from __future__ import unicode_literals
 
+import django.db.models.deletion
+from django.conf import settings
 from django.db import migrations, models
-import club.models
 
 
 class Migration(migrations.Migration):
-
     dependencies = [("club", "0010_auto_20170912_2028")]
 
     operations = [
@@ -14,7 +13,8 @@ class Migration(migrations.Migration):
             model_name="club",
             name="owner_group",
             field=models.ForeignKey(
-                default=club.models.Club.get_default_owner_group,
+                on_delete=django.db.models.deletion.CASCADE,
+                default=lambda: settings.SITH_ROOT_USER_ID,
                 related_name="owned_club",
                 to="core.Group",
             ),

club/migrations/0012_club_board_group_club_members_group.py

@@ -0,0 +1,104 @@
+# Generated by Django 4.2.16 on 2024-11-20 17:08
+
+import django.db.models.deletion
+import django.db.models.functions.datetime
+from django.conf import settings
+from django.db import migrations, models
+from django.db.migrations.state import StateApps
+from django.db.models import Q
+from django.utils.timezone import localdate
+
+
+def migrate_meta_groups(apps: StateApps, schema_editor):
+    """Attach the existing meta groups to the clubs.
+
+    Until now, the meta groups were not attached to the clubs,
+    nor to the users.
+    This creates actual foreign relationships between the clubs
+    and theirs groups and the users and theirs groups.
+
+    Warnings:
+        When the meta groups associated with the clubs aren't found,
+        they are created.
+        Thus the migration shouldn't fail, and all the clubs will
+        have their groups.
+        However, there will probably be some groups that have
+        not been found but exist nonetheless,
+        so there will be duplicates and dangling groups.
+        There must be a manual cleanup after this migration.
+    """
+    Group = apps.get_model("core", "Group")
+    Club = apps.get_model("club", "Club")
+
+    meta_groups = Group.objects.filter(is_meta=True)
+    clubs = list(Club.objects.all())
+    for club in clubs:
+        club.board_group = meta_groups.get_or_create(
+            name=f"{club.unix_name}-bureau", defaults={"is_meta": True}
+        )[0]
+        club.members_group = meta_groups.get_or_create(
+            name=f"{club.unix_name}-membres", defaults={"is_meta": True}
+        )[0]
+        club.save()
+        club.refresh_from_db()
+        memberships = club.members.filter(
+            Q(end_date=None) | Q(end_date__gt=localdate())
+        ).select_related("user")
+        club.members_group.users.set([m.user for m in memberships])
+        club.board_group.users.set(
+            [
+                m.user
+                for m in memberships.filter(role__gt=settings.SITH_MAXIMUM_FREE_ROLE)
+            ]
+        )
+
+
+# steps of the migration :
+# - Create a nullable field for the board group and the member group
+# - Edit those new fields to make them point to currently existing meta groups
+# - When this data migration is done, make the fields non-nullable
+class Migration(migrations.Migration):
+    dependencies = [
+        ("core", "0040_alter_user_options_user_user_permissions_and_more"),
+        ("club", "0011_auto_20180426_2013"),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name="club",
+            name="edit_groups",
+        ),
+        migrations.RemoveField(
+            model_name="club",
+            name="owner_group",
+        ),
+        migrations.RemoveField(
+            model_name="club",
+            name="view_groups",
+        ),
+        migrations.AddField(
+            model_name="club",
+            name="board_group",
+            field=models.OneToOneField(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.PROTECT,
+                related_name="club_board",
+                to="core.group",
+            ),
+        ),
+        migrations.AddField(
+            model_name="club",
+            name="members_group",
+            field=models.OneToOneField(
+                blank=True,
+                null=True,
+                on_delete=django.db.models.deletion.PROTECT,
+                related_name="club",
+                to="core.group",
+            ),
+        ),
+        migrations.RunPython(
+            migrate_meta_groups, reverse_code=migrations.RunPython.noop, elidable=True
+        ),
+    ]

club/migrations/0013_alter_club_board_group_alter_club_members_group_and_more.py

@@ -0,0 +1,36 @@
+# Generated by Django 4.2.17 on 2025-01-04 16:46
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [("club", "0012_club_board_group_club_members_group")]
+
+    operations = [
+        migrations.AlterField(
+            model_name="club",
+            name="board_group",
+            field=models.OneToOneField(
+                on_delete=django.db.models.deletion.PROTECT,
+                related_name="club_board",
+                to="core.group",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="club",
+            name="members_group",
+            field=models.OneToOneField(
+                on_delete=django.db.models.deletion.PROTECT,
+                related_name="club",
+                to="core.group",
+            ),
+        ),
+        migrations.AddConstraint(
+            model_name="membership",
+            constraint=models.CheckConstraint(
+                condition=models.Q(("end_date__gte", models.F("start_date"))),
+                name="end_after_start",
+            ),
+        ),
+    ]

club/migrations/0014_alter_club_options_rename_unix_name_club_slug_name_and_more.py

@@ -0,0 +1,75 @@
+# Generated by Django 4.2.17 on 2025-02-28 20:34
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+import core.fields
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("core", "0044_alter_userban_options"),
+        ("club", "0013_alter_club_board_group_alter_club_members_group_and_more"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(name="club", options={"ordering": ["name"]}),
+        migrations.RenameField(
+            model_name="club",
+            old_name="unix_name",
+            new_name="slug_name",
+        ),
+        migrations.AlterField(
+            model_name="club",
+            name="name",
+            field=models.CharField(unique=True, max_length=64, verbose_name="name"),
+        ),
+        migrations.AlterField(
+            model_name="club",
+            name="slug_name",
+            field=models.SlugField(
+                editable=False, max_length=30, unique=True, verbose_name="slug name"
+            ),
+        ),
+        migrations.AlterField(
+            model_name="club",
+            name="id",
+            field=models.AutoField(
+                auto_created=True, primary_key=True, serialize=False, verbose_name="ID"
+            ),
+        ),
+        migrations.AlterField(
+            model_name="club",
+            name="logo",
+            field=core.fields.ResizedImageField(
+                blank=True,
+                force_format="WEBP",
+                height=200,
+                null=True,
+                upload_to="club_logos",
+                verbose_name="logo",
+                width=200,
+            ),
+        ),
+        migrations.AlterField(
+            model_name="club",
+            name="page",
+            field=models.OneToOneField(
+                blank=True,
+                on_delete=django.db.models.deletion.CASCADE,
+                related_name="club",
+                to="core.page",
+            ),
+        ),
+        migrations.AlterField(
+            model_name="club",
+            name="short_description",
+            field=models.CharField(
+                blank=True,
+                default="",
+                help_text="A summary of what your club does. This will be displayed on the club list page.",
+                max_length=1000,
+                verbose_name="short description",
+            ),
+        ),
+    ]

club/models.py

@@ -1,4 +1,3 @@
-# -*- coding:utf-8 -*
 #
 # Copyright 2016,2017
 # - Skia <skia@libskia.so>
@@ -22,67 +21,66 @@
 # Place - Suite 330, Boston, MA 02111-1307, USA.
 #
 #
+from __future__ import annotations
+
+from typing import Iterable, Self
 
-from django.db import models
-from django.core import validators
 from django.conf import settings
-from django.utils.translation import ugettext_lazy as _
-from django.core.exceptions import ValidationError, ObjectDoesNotExist
-from django.db import transaction
-from django.core.urlresolvers import reverse
-from django.utils import timezone
+from django.core.cache import cache
+from django.core.exceptions import ObjectDoesNotExist, ValidationError
 from django.core.validators import RegexValidator, validate_email
+from django.db import models, transaction
+from django.db.models import Exists, F, OuterRef, Q, Value
+from django.db.models.functions import Greatest
+from django.urls import reverse
+from django.utils import timezone
 from django.utils.functional import cached_property
+from django.utils.text import slugify
+from django.utils.timezone import localdate
+from django.utils.translation import gettext_lazy as _
 
-from core.models import User, MetaGroup, Group, SithFile, RealGroup, Notification, Page
+from core.fields import ResizedImageField
+from core.models import Group, Notification, Page, SithFile, User
 
-# Create your models here.
+
+class ClubQuerySet(models.QuerySet):
+    def having_board_member(self, user: User) -> Self:
+        """Filter all club in which the given user is a board member."""
+        active_memberships = user.memberships.board().ongoing()
+        return self.filter(Exists(active_memberships.filter(club=OuterRef("pk"))))
 
 
 class Club(models.Model):
-    """
-    The Club class, made as a tree to allow nice tidy organization
-    """
+    """The Club class, made as a tree to allow nice tidy organization."""
 
-    id = models.AutoField(primary_key=True, db_index=True)
-    name = models.CharField(_("name"), max_length=64)
-    parent = models.ForeignKey("Club", related_name="children", null=True, blank=True)
-    unix_name = models.CharField(
-        _("unix name"),
-        max_length=30,
-        unique=True,
-        validators=[
-            validators.RegexValidator(
-                r"^[a-z0-9][a-z0-9._-]*[a-z0-9]$",
-                _(
-                    "Enter a valid unix name. This value may contain only "
-                    "letters, numbers ./-/_ characters."
-                ),
-            )
-        ],
-        error_messages={"unique": _("A club with that unix name already exists.")},
+    name = models.CharField(_("name"), unique=True, max_length=64)
+    parent = models.ForeignKey(
+        "Club", related_name="children", null=True, blank=True, on_delete=models.CASCADE
     )
-    logo = models.ImageField(
-        upload_to="club_logos", verbose_name=_("logo"), null=True, blank=True
+    slug_name = models.SlugField(
+        _("slug name"), max_length=30, unique=True, editable=False
+    )
+    logo = ResizedImageField(
+        upload_to="club_logos",
+        verbose_name=_("logo"),
+        null=True,
+        blank=True,
+        force_format="WEBP",
+        height=200,
+        width=200,
     )
     is_active = models.BooleanField(_("is active"), default=True)
     short_description = models.CharField(
-        _("short description"), max_length=1000, default="", blank=True, null=True
+        _("short description"),
+        max_length=1000,
+        default="",
+        blank=True,
+        help_text=_(
+            "A summary of what your club does. "
+            "This will be displayed on the club list page."
+        ),
     )
     address = models.CharField(_("address"), max_length=254)
-    # This function prevents generating migration upon settings change
-    def get_default_owner_group():
-        return settings.SITH_GROUP_ROOT_ID
-
-    owner_group = models.ForeignKey(
-        Group, related_name="owned_club", default=get_default_owner_group
-    )
-    edit_groups = models.ManyToManyField(
-        Group, related_name="editable_club", blank=True
-    )
-    view_groups = models.ManyToManyField(
-        Group, related_name="viewable_club", blank=True
-    )
     home = models.OneToOneField(
         SithFile,
         related_name="home_of_club",
@@ -91,19 +89,62 @@ class Club(models.Model):
         blank=True,
         on_delete=models.SET_NULL,
     )
-    page = models.OneToOneField(Page, related_name="club", blank=True, null=True)
+    page = models.OneToOneField(
+        Page, related_name="club", blank=True, on_delete=models.CASCADE
+    )
+    members_group = models.OneToOneField(
+        Group, related_name="club", on_delete=models.PROTECT
+    )
+    board_group = models.OneToOneField(
+        Group, related_name="club_board", on_delete=models.PROTECT
+    )
+
+    objects = ClubQuerySet.as_manager()
 
     class Meta:
-        ordering = ["name", "unix_name"]
+        ordering = ["name"]
+
+    def __str__(self):
+        return self.name
+
+    @transaction.atomic()
+    def save(self, *args, **kwargs):
+        creation = self._state.adding
+        if (slug := slugify(self.name)[:30]) != self.slug_name:
+            self.slug_name = slug
+        if not creation:
+            db_club = Club.objects.get(id=self.id)
+            if self.name != db_club.name:
+                self.home.name = self.slug_name
+                self.home.save()
+            if self.name != db_club.name:
+                self.board_group.name = f"{self.name} - Bureau"
+                self.board_group.save()
+                self.members_group.name = f"{self.name} - Membres"
+                self.members_group.save()
+        if creation:
+            self.board_group = Group.objects.create(
+                name=f"{self.name} - Bureau", is_manually_manageable=False
+            )
+            self.members_group = Group.objects.create(
+                name=f"{self.name} - Membres", is_manually_manageable=False
+            )
+            self.make_home()
+        self.make_page()
+        super().save(*args, **kwargs)
+
+    def get_absolute_url(self):
+        return reverse("club:club_view", kwargs={"club_id": self.id})
 
     @cached_property
-    def president(self):
+    def president(self) -> Membership | None:
+        """Fetch the membership of the current president of this club."""
         return self.members.filter(
             role=settings.SITH_CLUB_ROLES_ID["President"], end_date=None
         ).first()
 
     def check_loop(self):
-        """Raise a validation error when a loop is found within the parent list"""
+        """Raise a validation error when a loop is found within the parent list."""
         objs = []
         cur = self
         while cur.parent is not None:
@@ -115,137 +156,200 @@ class Club(models.Model):
     def clean(self):
         self.check_loop()
 
-    def _change_unixname(self, new_name):
-        c = Club.objects.filter(unix_name=new_name).first()
-        if c is None:
-            if self.home:
-                self.home.name = new_name
-                self.home.save()
-        else:
-            raise ValidationError(_("A club with that unix_name already exists"))
+    def make_home(self) -> None:
+        if self.home:
+            return
+        home_root = SithFile.objects.get(parent=None, name="clubs")
+        root = User.objects.get(id=settings.SITH_ROOT_USER_ID)
+        self.home = SithFile.objects.create(
+            parent=home_root, name=self.slug_name, owner=root
+        )
 
-    def make_home(self):
-        if not self.home:
-            home_root = SithFile.objects.filter(parent=None, name="clubs").first()
-            root = User.objects.filter(username="root").first()
-            if home_root and root:
-                home = SithFile(parent=home_root, name=self.unix_name, owner=root)
-                home.save()
-                self.home = home
-                self.save()
-
-    def make_page(self):
-        root = User.objects.filter(username="root").first()
-        if not self.page:
-            club_root = Page.objects.filter(name=settings.SITH_CLUB_ROOT_PAGE).first()
-            if root and club_root:
-                public = Group.objects.filter(id=settings.SITH_GROUP_PUBLIC_ID).first()
-                p = Page(name=self.unix_name)
-                p.parent = club_root
-                p.save(force_lock=True)
-                if public:
-                    p.view_groups.add(public)
-                p.save(force_lock=True)
-                if self.parent and self.parent.page:
-                    p.parent = self.parent.page
-                self.page = p
-                self.save()
-        elif self.page and self.page.name != self.unix_name:
-            self.page.unset_lock()
-            self.page.name = self.unix_name
-            self.page.save(force_lock=True)
-        elif (
-            self.page
-            and self.parent
-            and self.parent.page
-            and self.page.parent != self.parent.page
-        ):
-            self.page.unset_lock()
+    def make_page(self) -> None:
+        page_name = self.slug_name
+        if not self.page_id:
+            # Club.page is a OneToOneField, so if we are inside this condition
+            # then self._meta.state.adding is True.
+            club_root = Page.objects.get(name=settings.SITH_CLUB_ROOT_PAGE)
+            public = Group.objects.get(id=settings.SITH_GROUP_PUBLIC_ID)
+            p = Page(name=page_name, parent=club_root)
+            p.save(force_lock=True)
+            p.view_groups.add(public)
+            if self.parent and self.parent.page_id:
+                p.parent_id = self.parent.page_id
+            self.page = p
+            return
+        self.page.unset_lock()
+        if self.page.name != page_name:
+            self.page.name = page_name
+        elif self.parent and self.parent.page and self.page.parent != self.parent.page:
             self.page.parent = self.parent.page
-            self.page.save(force_lock=True)
+        self.page.save(force_lock=True)
 
-    def save(self, *args, **kwargs):
-        with transaction.atomic():
-            creation = False
-            old = Club.objects.filter(id=self.id).first()
-            if not old:
-                creation = True
-            else:
-                if old.unix_name != self.unix_name:
-                    self._change_unixname(self.unix_name)
-            super(Club, self).save(*args, **kwargs)
-            if creation:
-                board = MetaGroup(name=self.unix_name + settings.SITH_BOARD_SUFFIX)
-                board.save()
-                member = MetaGroup(name=self.unix_name + settings.SITH_MEMBER_SUFFIX)
-                member.save()
-                subscribers = Group.objects.filter(
-                    name=settings.SITH_MAIN_MEMBERS_GROUP
-                ).first()
-                self.make_home()
-                self.home.edit_groups = [board]
-                self.home.view_groups = [member, subscribers]
-                self.home.save()
-            self.make_page()
+    def delete(self, *args, **kwargs) -> tuple[int, dict[str, int]]:
+        # Invalidate the cache of this club and of its memberships
+        for membership in self.members.ongoing().select_related("user"):
+            cache.delete(f"membership_{self.id}_{membership.user.id}")
+        self.board_group.delete()
+        self.members_group.delete()
+        return super().delete(*args, **kwargs)
 
-    def __str__(self):
+    def get_display_name(self) -> str:
         return self.name
 
-    def get_absolute_url(self):
-        return reverse("club:club_view", kwargs={"club_id": self.id})
+    def is_owned_by(self, user: User) -> bool:
+        """Method to see if that object can be super edited by the given user."""
+        if user.is_anonymous:
+            return False
+        return user.is_root or user.is_board_member
 
-    def get_display_name(self):
-        return self.name
+    def get_full_logo_url(self) -> str:
+        return f"https://{settings.SITH_URL}{self.logo.url}"
 
-    def is_owned_by(self, user):
-        """
-        Method to see if that object can be super edited by the given user
-        """
-        return user.is_in_group(settings.SITH_MAIN_BOARD_GROUP)
-
-    def get_full_logo_url(self):
-        return "https://%s%s" % (settings.SITH_URL, self.logo.url)
-
-    def can_be_edited_by(self, user):
-        """
-        Method to see if that object can be edited by the given user
-        """
+    def can_be_edited_by(self, user: User) -> bool:
+        """Method to see if that object can be edited by the given user."""
         return self.has_rights_in_club(user)
 
-    def can_be_viewed_by(self, user):
-        """
-        Method to see if that object can be seen by the given user
-        """
-        sub = User.objects.filter(pk=user.pk).first()
-        if sub is None:
-            return False
-        return sub.was_subscribed
+    def get_membership_for(self, user: User) -> Membership | None:
+        """Return the current membership the given user.
 
-    _memberships = {}
-
-    def get_membership_for(self, user):
+        Note:
+            The result is cached.
         """
-        Returns the current membership the given user
-        """
-        try:
-            return Club._memberships[self.id][user.id]
-        except:
-            m = self.members.filter(user=user.id).filter(end_date=None).first()
-            try:
-                Club._memberships[self.id][user.id] = m
-            except:
-                Club._memberships[self.id] = {}
-                Club._memberships[self.id][user.id] = m
-            return m
+        if user.is_anonymous:
+            return None
+        membership = cache.get(f"membership_{self.id}_{user.id}")
+        if membership == "not_member":
+            return None
+        if membership is None:
+            membership = self.members.filter(user=user, end_date=None).first()
+            if membership is None:
+                cache.set(f"membership_{self.id}_{user.id}", "not_member")
+            else:
+                cache.set(f"membership_{self.id}_{user.id}", membership)
+        return membership
 
-    def has_rights_in_club(self, user):
-        m = self.get_membership_for(user)
-        return m is not None and m.role > settings.SITH_MAXIMUM_FREE_ROLE
+    def has_rights_in_club(self, user: User) -> bool:
+        return user.is_in_group(pk=self.board_group_id)
+
+
+class MembershipQuerySet(models.QuerySet):
+    def ongoing(self) -> Self:
+        """Filter all memberships which are not finished yet."""
+        return self.filter(Q(end_date=None) | Q(end_date__gt=localdate()))
+
+    def board(self) -> Self:
+        """Filter all memberships where the user is/was in the board.
+
+        Be aware that users who were in the board in the past
+        are included, even if there are no more members.
+
+        If you want to get the users who are currently in the board,
+        mind combining this with the :meth:`ongoing` queryset method
+        """
+        return self.filter(role__gt=settings.SITH_MAXIMUM_FREE_ROLE)
+
+    def editable_by(self, user: User) -> Self:
+        """Filter Memberships that this user can edit.
+
+        Users with the `club.change_membership` permission can edit all Membership.
+        The other users can edit :
+        - their own membership
+        - if they are board members, ongoing memberships with a role lower than their own
+
+        For example, let's suppose the following users :
+        - A : board member
+        - B : board member
+        - C : simple member
+        - D : curious
+        - E : old member
+
+        A will be able to edit the memberships of A, C and D ;
+        C and D will be able to edit only their own membership ;
+        nobody will be able to edit E's membership.
+        """
+        if user.has_perm("club.change_membership"):
+            return self.all()
+        return self.filter(
+            Q(user=user)
+            | Exists(
+                Membership.objects.filter(
+                    Q(
+                        role__gt=Greatest(
+                            OuterRef("role"), Value(settings.SITH_MAXIMUM_FREE_ROLE)
+                        )
+                    ),
+                    user=user,
+                    end_date=None,
+                    club=OuterRef("club"),
+                )
+            ),
+            end_date=None,
+        )
+
+    def update(self, **kwargs) -> int:
+        """Refresh the cache and edit group ownership.
+
+        Update the cache, when necessary, remove
+        users from club groups they are no more in
+        and add them in the club groups they should be in.
+
+        Be aware that this adds three db queries :
+        one to retrieve the updated memberships,
+        one to perform group removal and one to perform
+        group attribution.
+        """
+        nb_rows = super().update(**kwargs)
+        if nb_rows == 0:
+            # if no row was affected, no need to refresh the cache
+            return 0
+
+        cache_memberships = {}
+        memberships = set(self.select_related("club"))
+        # delete all User-Group relations and recreate the necessary ones
+        # It's more concise to write and more reliable
+        Membership._remove_club_groups(memberships)
+        Membership._add_club_groups(memberships)
+        for member in memberships:
+            cache_key = f"membership_{member.club_id}_{member.user_id}"
+            if member.end_date is None:
+                cache_memberships[cache_key] = member
+            else:
+                cache_memberships[cache_key] = "not_member"
+        cache.set_many(cache_memberships)
+        return nb_rows
+
+    def delete(self) -> tuple[int, dict[str, int]]:
+        """Work just like the default Django's delete() method,
+        but add a cache invalidation for the elements of the queryset
+        before the deletion,
+        and a removal of the user from the club groups.
+
+        Be aware that this adds some db queries :
+
+        - 1 to retrieve the deleted elements in order to perform
+          post-delete operations.
+          As we can't know if a delete will affect rows or not,
+          this query will always happen
+        - 1 query to remove the users from the club groups.
+          If the delete operation affected no row,
+          this query won't happen.
+        """
+        memberships = set(self.all())
+        nb_rows, rows_counts = super().delete()
+        if nb_rows > 0:
+            Membership._remove_club_groups(memberships)
+            cache.set_many(
+                {
+                    f"membership_{m.club_id}_{m.user_id}": "not_member"
+                    for m in memberships
+                }
+            )
+        return nb_rows, rows_counts
 
 
 class Membership(models.Model):
-    """
-    The Membership class makes the connection between User and Clubs
+    """The Membership class makes the connection between User and Clubs.
 
     Both Users and Clubs can have many Membership objects:
        - a user can be a member of many clubs at a time
@@ -259,11 +363,13 @@ class Membership(models.Model):
         User,
         verbose_name=_("user"),
         related_name="memberships",
-        null=False,
-        blank=False,
+        on_delete=models.CASCADE,
     )
     club = models.ForeignKey(
-        Club, verbose_name=_("club"), related_name="members", null=False, blank=False
+        Club,
+        verbose_name=_("club"),
+        related_name="members",
+        on_delete=models.CASCADE,
     )
     start_date = models.DateField(_("start date"), default=timezone.now)
     end_date = models.DateField(_("end date"), null=True, blank=True)
@@ -276,48 +382,153 @@ class Membership(models.Model):
         _("description"), max_length=128, null=False, blank=True
     )
 
+    objects = MembershipQuerySet.as_manager()
+
+    class Meta:
+        constraints = [
+            models.CheckConstraint(
+                condition=Q(end_date__gte=F("start_date")), name="end_after_start"
+            ),
+        ]
+
     def __str__(self):
         return (
-            self.club.name
-            + " - "
-            + self.user.username
-            + " - "
-            + str(settings.SITH_CLUB_ROLES[self.role])
-            + str(" - " + str(_("past member")) if self.end_date is not None else "")
+            f"{self.club.name} - {self.user.username} "
+            f"- {settings.SITH_CLUB_ROLES[self.role]} "
+            f"- {str(_('past member')) if self.end_date is not None else ''}"
         )
 
-    def is_owned_by(self, user):
-        """
-        Method to see if that object can be super edited by the given user
-        """
-        return user.is_in_group(settings.SITH_MAIN_BOARD_GROUP)
-
-    def can_be_edited_by(self, user, membership=None):
-        """
-        Method to see if that object can be edited by the given user
-        """
-        if user.memberships:
-            if membership:  # This is for optimisation purpose
-                ms = membership
-            else:
-                ms = user.memberships.filter(club=self.club, end_date=None).first()
-            return (ms and ms.role >= self.role) or user.is_in_group(
-                settings.SITH_MAIN_BOARD_GROUP
-            )
-        return user.is_in_group(settings.SITH_MAIN_BOARD_GROUP)
+    def save(self, *args, **kwargs):
+        super().save(*args, **kwargs)
+        # a save may either be an update or a creation
+        # and may result in either an ongoing or an ended membership.
+        # It could also be a retrogradation from the board to being a simple member.
+        # To avoid problems, the user is removed from the club groups beforehand ;
+        # he will be added back if necessary
+        self._remove_club_groups([self])
+        if self.end_date is None:
+            self._add_club_groups([self])
+            cache.set(f"membership_{self.club_id}_{self.user_id}", self)
+        else:
+            cache.set(f"membership_{self.club_id}_{self.user_id}", "not_member")
 
     def get_absolute_url(self):
-        return reverse("club:club_members", kwargs={"club_id": self.club.id})
+        return reverse("club:club_members", kwargs={"club_id": self.club_id})
+
+    def is_owned_by(self, user: User) -> bool:
+        """Method to see if that object can be super edited by the given user."""
+        if user.is_anonymous:
+            return False
+        return user.is_root or user.is_board_member
+
+    def can_be_edited_by(self, user: User) -> bool:
+        """Check if that object can be edited by the given user."""
+        if user.is_root or user.is_board_member:
+            return True
+        membership = self.club.get_membership_for(user)
+        return membership is not None and membership.role >= self.role
+
+    def delete(self, *args, **kwargs):
+        self._remove_club_groups([self])
+        super().delete(*args, **kwargs)
+        cache.delete(f"membership_{self.club_id}_{self.user_id}")
+
+    @staticmethod
+    def _remove_club_groups(
+        memberships: Iterable[Membership],
+    ) -> tuple[int, dict[str, int]]:
+        """Remove users of those memberships from the club groups.
+
+        For example, if a user is in the Troll club board,
+        he is in the board group and the members group of the Troll.
+        After calling this function, he will be in neither.
+
+        Returns:
+            The result of the deletion queryset.
+
+        Warnings:
+            If this function isn't used in combination
+            with an actual deletion of the memberships,
+            it will result in an inconsistent state,
+            where users will be in the clubs, without
+            having the associated rights.
+        """
+        clubs = {m.club_id for m in memberships}
+        users = {m.user_id for m in memberships}
+        groups = Group.objects.filter(Q(club__in=clubs) | Q(club_board__in=clubs))
+        return User.groups.through.objects.filter(
+            Q(group__in=groups) & Q(user__in=users)
+        ).delete()
+
+    @staticmethod
+    def _add_club_groups(
+        memberships: Iterable[Membership],
+    ) -> list[User.groups.through]:
+        """Add users of those memberships to the club groups.
+
+        For example, if a user just joined the Troll club board,
+        he will be added in both the members group and the board group
+        of the club.
+
+        Returns:
+            The created User-Group relations.
+
+        Warnings:
+            If this function isn't used in combination
+            with an actual update/creation of the memberships,
+            it will result in an inconsistent state,
+            where users will have the rights associated to the
+            club, without actually being part of it.
+        """
+        # only active membership (i.e. `end_date=None`)
+        # grant the attribution of club groups.
+        memberships = [m for m in memberships if m.end_date is None]
+        if not memberships:
+            return []
+
+        if sum(1 for m in memberships if not hasattr(m, "club")) > 1:
+            # if more than one membership hasn't its `club` attribute set
+            # it's less expensive to reload the whole query with
+            # a select_related than perform a distinct query
+            # to fetch each club.
+            ids = {m.id for m in memberships}
+            memberships = list(
+                Membership.objects.filter(id__in=ids).select_related("club")
+            )
+        club_groups = []
+        for membership in memberships:
+            club_groups.append(
+                User.groups.through(
+                    user_id=membership.user_id,
+                    group_id=membership.club.members_group_id,
+                )
+            )
+            if membership.role > settings.SITH_MAXIMUM_FREE_ROLE:
+                club_groups.append(
+                    User.groups.through(
+                        user_id=membership.user_id,
+                        group_id=membership.club.board_group_id,
+                    )
+                )
+        return User.groups.through.objects.bulk_create(
+            club_groups, ignore_conflicts=True
+        )
 
 
 class Mailing(models.Model):
-    """
-    This class correspond to a mailing list
-    Remember that mailing lists should be validated by UTBM
+    """A Mailing list for a club.
+
+    Warning:
+        Remember that mailing lists should be validated by UTBM.
     """
 
     club = models.ForeignKey(
-        Club, verbose_name=_("Club"), related_name="mailings", null=False, blank=False
+        Club,
+        verbose_name=_("Club"),
+        related_name="mailings",
+        null=False,
+        blank=False,
+        on_delete=models.CASCADE,
     )
     email = models.CharField(
         _("Email address"),
@@ -334,9 +545,32 @@ class Mailing(models.Model):
     )
     is_moderated = models.BooleanField(_("is moderated"), default=False)
     moderator = models.ForeignKey(
-        User, related_name="moderated_mailings", verbose_name=_("moderator"), null=True
+        User,
+        related_name="moderated_mailings",
+        verbose_name=_("moderator"),
+        null=True,
+        on_delete=models.CASCADE,
     )
 
+    def __str__(self):
+        return "%s - %s" % (self.club, self.email_full)
+
+    def save(self, *args, **kwargs):
+        if not self.is_moderated:
+            unread_notif_subquery = Notification.objects.filter(
+                user=OuterRef("pk"), type="MAILING_MODERATION", viewed=False
+            )
+            for user in User.objects.filter(
+                ~Exists(unread_notif_subquery),
+                groups__id__in=[settings.SITH_GROUP_COM_ADMIN_ID],
+            ):
+                Notification(
+                    user=user,
+                    url=reverse("com:mailing_admin"),
+                    type="MAILING_MODERATION",
+                ).save(*args, **kwargs)
+        super().save(*args, **kwargs)
+
     def clean(self):
         if Mailing.objects.filter(email=self.email).exists():
             raise ValidationError(_("This mailing list already exists."))
@@ -344,21 +578,19 @@ class Mailing(models.Model):
             self.is_moderated = True
         else:
             self.moderator = None
-        super(Mailing, self).clean()
+        super().clean()
 
     @property
     def email_full(self):
         return self.email + "@" + settings.SITH_MAILING_DOMAIN
 
     def can_moderate(self, user):
-        return user.is_root or user.is_in_group(settings.SITH_GROUP_COM_ADMIN_ID)
+        return user.is_root or user.is_com_admin
 
     def is_owned_by(self, user):
-        return (
-            user.is_in_group(self)
-            or user.is_root
-            or user.is_in_group(settings.SITH_GROUP_COM_ADMIN_ID)
-        )
+        if user.is_anonymous:
+            return False
+        return user.is_root or user.is_com_admin
 
     def can_view(self, user):
         return self.club.has_rights_in_club(user)
@@ -366,42 +598,17 @@ class Mailing(models.Model):
     def can_be_edited_by(self, user):
         return self.club.has_rights_in_club(user)
 
-    def delete(self):
-        for sub in self.subscriptions.all():
-            sub.delete()
-        super(Mailing, self).delete()
+    def delete(self, *args, **kwargs):
+        self.subscriptions.all().delete()
+        super().delete()
 
     def fetch_format(self):
-        resp = self.email + ": "
-        for sub in self.subscriptions.all():
-            resp += sub.fetch_format()
-        return resp
-
-    def save(self):
-        if not self.is_moderated:
-            for user in (
-                RealGroup.objects.filter(id=settings.SITH_GROUP_COM_ADMIN_ID)
-                .first()
-                .users.all()
-            ):
-                if not user.notifications.filter(
-                    type="MAILING_MODERATION", viewed=False
-                ).exists():
-                    Notification(
-                        user=user,
-                        url=reverse("com:mailing_admin"),
-                        type="MAILING_MODERATION",
-                    ).save()
-        super(Mailing, self).save()
-
-    def __str__(self):
-        return "%s - %s" % (self.club, self.email_full)
+        destination = "".join(s.fetch_format() for s in self.subscriptions.all())
+        return f"{self.email}: {destination}"
 
 
 class MailingSubscription(models.Model):
-    """
-    This class makes the link between user and mailing list
-    """
+    """Link between user and mailing list."""
 
     mailing = models.ForeignKey(
         Mailing,
@@ -409,6 +616,7 @@ class MailingSubscription(models.Model):
         related_name="subscriptions",
         null=False,
         blank=False,
+        on_delete=models.CASCADE,
     )
     user = models.ForeignKey(
         User,
@@ -416,12 +624,16 @@ class MailingSubscription(models.Model):
         related_name="mailing_subscriptions",
         null=True,
         blank=True,
+        on_delete=models.CASCADE,
     )
     email = models.EmailField(_("Email address"), blank=False, null=False)
 
     class Meta:
         unique_together = (("user", "email", "mailing"),)
 
+    def __str__(self):
+        return "(%s) - %s : %s" % (self.mailing, self.get_username, self.email)
+
     def clean(self):
         if not self.user and not self.email:
             raise ValidationError(_("At least user or email is required"))
@@ -436,13 +648,15 @@ class MailingSubscription(models.Model):
                     )
         except ObjectDoesNotExist:
             pass
-        super(MailingSubscription, self).clean()
+        super().clean()
 
     def is_owned_by(self, user):
+        if user.is_anonymous:
+            return False
         return (
             self.mailing.club.has_rights_in_club(user)
             or user.is_root
-            or self.user.is_in_group(settings.SITH_GROUP_COM_ADMIN_ID)
+            or self.user.is_com_admin
         )
 
     def can_be_edited_by(self, user):
@@ -462,6 +676,3 @@ class MailingSubscription(models.Model):
 
     def fetch_format(self):
         return self.get_email + " "
-
-    def __str__(self):
-        return "(%s) - %s : %s" % (self.mailing, self.get_username, self.email)

club/schemas.py

@@ -0,0 +1,57 @@
+from typing import Annotated
+
+from annotated_types import MinLen
+from django.db.models import Q
+from ninja import Field, FilterSchema, ModelSchema
+
+from club.models import Club, Membership
+from core.schemas import SimpleUserSchema
+
+
+class ClubSearchFilterSchema(FilterSchema):
+    search: Annotated[str, MinLen(1)] | None = Field(None, q="name__icontains")
+    is_active: bool | None = None
+    parent_id: int | None = None
+    parent_name: str | None = Field(None, q="parent__name__icontains")
+    exclude_ids: set[int] | None = None
+
+    def filter_exclude_ids(self, value: set[int] | None):
+        if value is None:
+            return Q()
+        return ~Q(id__in=value)
+
+
+class SimpleClubSchema(ModelSchema):
+    class Meta:
+        model = Club
+        fields = ["id", "name"]
+
+
+class ClubProfileSchema(ModelSchema):
+    """The infos needed to display a simple club profile."""
+
+    class Meta:
+        model = Club
+        fields = ["id", "name", "logo"]
+
+    url: str
+
+    @staticmethod
+    def resolve_url(obj: Club) -> str:
+        return obj.get_absolute_url()
+
+
+class ClubMemberSchema(ModelSchema):
+    class Meta:
+        model = Membership
+        fields = ["start_date", "end_date", "role", "description"]
+
+    user: SimpleUserSchema
+
+
+class ClubSchema(ModelSchema):
+    class Meta:
+        model = Club
+        fields = ["id", "name", "logo", "is_active", "short_description", "address"]
+
+    members: list[ClubMemberSchema]

club/static/bundled/club/components/ajax-select-index.ts

@@ -0,0 +1,30 @@
+import { AjaxSelect } from "#core:core/components/ajax-select-base";
+import { registerComponent } from "#core:utils/web-components";
+import type { TomOption } from "tom-select/dist/types/types";
+import type { escape_html } from "tom-select/dist/types/utils";
+import { type ClubSchema, clubSearchClub } from "#openapi";
+
+@registerComponent("club-ajax-select")
+export class ClubAjaxSelect extends AjaxSelect {
+  protected valueField = "id";
+  protected labelField = "name";
+  protected searchField = ["code", "name"];
+
+  protected async search(query: string): Promise<TomOption[]> {
+    const resp = await clubSearchClub({ query: { search: query } });
+    if (resp.data) {
+      return resp.data.results;
+    }
+    return [];
+  }
+
+  protected renderOption(item: ClubSchema, sanitize: typeof escape_html) {
+    return `<div class="select-item">
+            <span class="select-item-text">${sanitize(item.name)}</span>
+          </div>`;
+  }
+
+  protected renderItem(item: ClubSchema, sanitize: typeof escape_html) {
+    return `<span>${sanitize(item.name)}</span>`;
+  }
+}

club/static/club/members.scss

@@ -0,0 +1,24 @@
+#club_members_table {
+  tbody label {
+    margin: 0;
+    padding: 0;
+  }
+}
+
+#add_club_members_form {
+  fieldset {
+    display: flex;
+    flex-direction: row;
+    column-gap: 2em;
+    row-gap: 1em;
+    flex-wrap: wrap;
+
+    @media (max-width: 1100px) {
+      justify-content: space-evenly;
+    }
+
+    .errorlist {
+      max-width: 300px;
+    }
+  }
+}

club/templates/club/club_detail.jinja

@@ -1,17 +1,25 @@
 {% extends "core/base.jinja" %}
 {% from 'core/macros.jinja' import user_profile_link %}
 
+{% block title -%}
+  {{ club.name }}
+{%- endblock %}
+
+{% block description -%}
+  {{ club.short_description }}
+{%- endblock %}
+
 {% block content %}
-	<div id="club_detail">
-		{% if club.logo %}
-			<div class="club_logo"><img src="{{ club.logo.url }}" alt="{{ club.unix_name }}"></div>
-		{% endif %}
-		{% if page_revision %}
-			{{ page_revision|markdown }}
- 		{% else %}
- 		<h3>{% trans %}Club{% endtrans %}</h3>
-	    {% endif %}
-    </div>
+  <div id="club_detail">
+    {% if club.logo %}
+      <div class="club_logo"><img src="{{ club.logo.url }}" alt="{{ club.name }}"></div>
+    {% endif %}
+    {% if page_revision %}
+      {{ page_revision|markdown }}
+    {% else %}
+      <h3>{% trans %}Club{% endtrans %}</h3>
+    {% endif %}
+  </div>
 {% endblock %}
 
 

club/templates/club/club_list.jinja

@@ -1,48 +1,52 @@
 {% extends "core/base.jinja" %}
 
-{% block title %}
-{% trans %}Club list{% endtrans %}
-{% endblock %}
+{% block title -%}
+  {% trans %}Club list{% endtrans %}
+{%- endblock %}
+
+{% block description -%}
+  {% trans %}The list of all clubs existing at UTBM.{% endtrans %}
+{%- endblock %}
 
 {% macro display_club(club) -%}
 
-        {% if club.is_active or user.is_root %}
-        
-        <li><a href="{{ url('club:club_view', club_id=club.id) }}">{{ club.name }}</a>
-        
-        {% if not club.is_active %}
-            ({% trans %}inactive{% endtrans %})
-        {% endif %}
+  {% if club.is_active or user.is_root %}
 
-        {% if club.president %} - <a href="{{ url('core:user_profile', user_id=club.president.user.id) }}">{{ club.president.user }}</a>{% endif %}
-        {% if club.short_description %}<p>{{ club.short_description|markdown }}</p>{% endif %}
-            
-        {% endif %}
+    <li><a href="{{ url('club:club_view', club_id=club.id) }}">{{ club.name }}</a>
 
-        {%- if club.children.all()|length != 0 %}
-        <ul>
-            {%- for c in club.children.order_by('name') %}
-                {{ display_club(c) }}
-            {%- endfor %}
-        </ul>
-        {%- endif -%}
-    </li>
+      {% if not club.is_active %}
+        ({% trans %}inactive{% endtrans %})
+      {% endif %}
+
+      {% if club.president %} - <a href="{{ url('core:user_profile', user_id=club.president.user.id) }}">{{ club.president.user }}</a>{% endif %}
+      {% if club.short_description %}<p>{{ club.short_description|markdown }}</p>{% endif %}
+
+  {% endif %}
+
+  {%- if club.children.all()|length != 0 %}
+    <ul>
+      {%- for c in club.children.order_by('name').prefetch_related("children") %}
+        {{ display_club(c) }}
+      {%- endfor %}
+    </ul>
+  {%- endif -%}
+  </li>
 {%- endmacro %}
 
 {% block content %}
-    {% if user.is_root %}
+  {% if user.is_root %}
     <p><a href="{{ url('club:club_new') }}">{% trans %}New club{% endtrans %}</a></p>
-    {% endif %}
-    {% if club_list %}
+  {% endif %}
+  {% if club_list %}
     <h3>{% trans %}Club list{% endtrans %}</h3>
     <ul>
-        {%- for c in club_list.all().order_by('name') if c.parent is none %}
-        {{ display_club(c) }}
-        {%- endfor %}
+      {%- for club in club_list %}
+        {{ display_club(club) }}
+      {%- endfor %}
     </ul>
-    {% else %}
+  {% else %}
     {% trans %}There is no club in this website.{% endtrans %}
-    {% endif %}
+  {% endif %}
 {% endblock %}