Specify empty OIDC prefix (#6324) (#6327)

* Specify empty OIDC prefix

Ref: https://github.com/inventree/InvenTree/discussions/6273

* Add extra comment around version information

* Update InvenTree/InvenTree/settings.py

Co-authored-by: Philipp Fruck <dev@p-fruck.de>

---------

Co-authored-by: Philipp Fruck <dev@p-fruck.de>
(cherry picked from commit d8f69c0609)

Co-authored-by: Oliver <oliver.henry.walters@gmail.com>

.deepsource.toml

@@ -0,0 +1,33 @@
+version = 1
+exclude_patterns = [
+  "docs/docs/javascripts/**",      # Docs: Helpers
+  "docs/ci/**",                    # Docs: CI
+  "InvenTree/InvenTree/static/**", # Backend: CUI static files
+  "ci/**",                         # Backend: CI
+  "InvenTree/**/migrations/*.py",  # Backend: Migration files
+  "src/frontend/src/locales/**",   # Frontend: Translations
+]
+test_patterns = ["**/test_*.py", "**/test.py", "**/tests.py"]
+
+
+[[analyzers]]
+name = "shell"
+
+[[analyzers]]
+name = "javascript"
+
+[analyzers.meta]
+plugins = ["react"]
+
+[[analyzers]]
+name = "python"
+
+[analyzers.meta]
+runtime_version = "3.x.x"
+
+[[analyzers]]
+name = "docker"
+
+[[analyzers]]
+name = "test-coverage"
+enabled = false

.devcontainer/Dockerfile

@@ -1,47 +0,0 @@
-# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.241.1/containers/python-3/.devcontainer/base.Dockerfile
-
-# [Choice] Python version (use -bullseye variants on local arm64/Apple Silicon): 3, 3.10, 3.9, 3.8, 3.7, 3.6, 3-bullseye, 3.10-bullseye, 3.9-bullseye, 3.8-bullseye, 3.7-bullseye, 3.6-bullseye, 3-buster, 3.10-buster, 3.9-buster, 3.8-buster, 3.7-buster, 3.6-buster
-ARG VARIANT="3.10-bullseye"
-FROM mcr.microsoft.com/vscode/devcontainers/python:0-${VARIANT}
-
-# [Choice] Node.js version: none, lts/*, 16, 14, 12, 10
-ARG NODE_VERSION="none"
-RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi
-
-# [Optional] If your pip requirements rarely change, uncomment this section to add them to the image.
-# COPY requirements.txt /tmp/pip-tmp/
-# RUN pip3 --disable-pip-version-check --no-cache-dir install -r /tmp/pip-tmp/requirements.txt \
-#    && rm -rf /tmp/pip-tmp
-
-# [Optional] Uncomment this section to install additional OS packages.
-RUN apt-get update && export DEBIAN_FRONTEND=noninteractive && \
-    apt-get -y install --no-install-recommends \
-    git gcc g++ gettext gnupg libffi-dev \
-    # Weasyprint requirements : https://doc.courtbouillon.org/weasyprint/stable/first_steps.html#debian-11
-    poppler-utils libpango-1.0-0 libpangoft2-1.0-0 \
-    # Image format support
-    libjpeg-dev webp \
-    # SQLite support
-    sqlite3 \
-    # PostgreSQL support
-    libpq-dev \
-    # MySQL / MariaDB support
-    default-libmysqlclient-dev mariadb-client && \
-    apt-get autoclean && apt-get autoremove
-
-# [Optional] Uncomment this line to install global node packages.
-# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1
-
-# Update pip
-RUN pip install --upgrade pip
-
-# Install required base-level python packages
-COPY ./docker/requirements.txt base_requirements.txt
-RUN pip install --disable-pip-version-check -U -r base_requirements.txt
-
-# preserve command history between container starts
-# Ref: https://code.visualstudio.com/remote/advancedcontainers/persist-bash-history
-# Folder will be created in 'postCreateCommand' in devcontainer.json as it's not preserved due to the bind mount
-RUN echo "export PROMPT_COMMAND='history -a' && export HISTFILE=/workspaces/InvenTree/dev/commandhistory/.bash_history" >> "/home/vscode/.bashrc"
-
-WORKDIR /workspaces/InvenTree

.devcontainer/devcontainer.json

@@ -3,15 +3,12 @@
 {
   "name": "InvenTree",
   "build": {
-    "dockerfile": "Dockerfile",
+    "dockerfile": "../Dockerfile",
     "context": "..",
+    "target": "devcontainer",
     "args": {
-      // Update 'VARIANT' to pick a Python version: 3, 3.10, 3.9, 3.8, 3.7, 3.6
-      // Append -bullseye or -buster to pin to an OS version.
-      // Use -bullseye variants on local on arm64/Apple Silicon.
-      "VARIANT": "3.10-bullseye",
-      // Options
-      "NODE_VERSION": "lts/*"
+      "base_image": "mcr.microsoft.com/vscode/devcontainers/base:alpine-3.18",
+      "workspace": "${containerWorkspaceFolder}"
     }
   },
 
@@ -21,7 +18,7 @@
     "vscode": {
       // Set *default* container specific settings.json values on container create.
       "settings": {
-        "python.defaultInterpreterPath": "/workspaces/InvenTree/dev/venv/bin/python",
+        "python.defaultInterpreterPath": "${containerWorkspaceFolder}/dev/venv/bin/python",
         "python.linting.enabled": true,
         "python.linting.pylintEnabled": false,
         "python.linting.flake8Enabled": true,
@@ -40,49 +37,54 @@
       "extensions": [
         "ms-python.python",
         "ms-python.vscode-pylance",
-        "batisteo.vscode-django"
+        "batisteo.vscode-django",
+        "eamodio.gitlens"
       ]
     }
   },
 
   // Use 'forwardPorts' to make a list of ports inside the container available locally.
-  "forwardPorts": [8000],
+  "forwardPorts": [5173, 8000],
   "portsAttributes": {
+    "5173": {
+      "label": "Vite server"
+    },
     "8000": {
       "label": "InvenTree server"
     }
   },
 
   // Use 'postCreateCommand' to run commands after the container is created.
-  "postCreateCommand": "./.devcontainer/postCreateCommand.sh",
+  "postCreateCommand": "./.devcontainer/postCreateCommand.sh ${containerWorkspaceFolder}",
 
   // Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
   "remoteUser": "vscode",
+  "containerUser": "vscode",
   "features": {
-    "git": "os-provided",
-    "github-cli": "latest"
+    "git": "os-provided"
   },
 
   "remoteEnv": {
     // InvenTree config
     "INVENTREE_DEBUG": "True",
-    "INVENTREE_DEBUG_LEVEL": "INFO",
+    "INVENTREE_LOG_LEVEL": "INFO",
     "INVENTREE_DB_ENGINE": "sqlite3",
-    "INVENTREE_DB_NAME": "/workspaces/InvenTree/dev/database.sqlite3",
-    "INVENTREE_MEDIA_ROOT": "/workspaces/InvenTree/dev/media",
-    "INVENTREE_STATIC_ROOT": "/workspaces/InvenTree/dev/static",
-    "INVENTREE_BACKUP_DIR": "/workspaces/InvenTree/dev/backup",
-    "INVENTREE_CONFIG_FILE": "/workspaces/InvenTree/dev/config.yaml",
-    "INVENTREE_SECRET_KEY_FILE": "/workspaces/InvenTree/dev/secret_key.txt",
-    "INVENTREE_PLUGIN_DIR": "/workspaces/InvenTree/dev/plugins",
-    "INVENTREE_PLUGIN_FILE": "/workspaces/InvenTree/dev/plugins.txt",
+    "INVENTREE_DB_NAME": "${containerWorkspaceFolder}/dev/database.sqlite3",
+    "INVENTREE_MEDIA_ROOT": "${containerWorkspaceFolder}/dev/media",
+    "INVENTREE_STATIC_ROOT": "${containerWorkspaceFolder}/dev/static",
+    "INVENTREE_BACKUP_DIR": "${containerWorkspaceFolder}/dev/backup",
+    "INVENTREE_CONFIG_FILE": "${containerWorkspaceFolder}/dev/config.yaml",
+    "INVENTREE_SECRET_KEY_FILE": "${containerWorkspaceFolder}/dev/secret_key.txt",
+    "INVENTREE_PLUGINS_ENABLED": "True",
+    "INVENTREE_PLUGIN_DIR": "${containerWorkspaceFolder}/dev/plugins",
+    "INVENTREE_PLUGIN_FILE": "${containerWorkspaceFolder}/dev/plugins.txt",
 
     // Python config
     "PIP_USER": "no",
 
-    // used to load the venv into the PATH and avtivate it
+    // used to load the venv into the PATH and activate it
     // Ref: https://stackoverflow.com/a/56286534
-    "VIRTUAL_ENV": "/workspaces/InvenTree/dev/venv",
-    "PATH": "/workspaces/InvenTree/dev/venv/bin:${containerEnv:PATH}"
+    "VIRTUAL_ENV": "${containerWorkspaceFolder}/dev/venv",
+    "PATH": "${containerWorkspaceFolder}/dev/venv/bin:${containerEnv:PATH}"
   }
 }

.devcontainer/postCreateCommand.sh

@@ -1,14 +1,24 @@
 #!/bin/bash
 
+# Avoiding Dubious Ownership in Dev Containers for setup commands that use git
+# Note that the local workspace directory is passed through as the first argument $1
+git config --global --add safe.directory $1
+
 # create folders
-mkdir -p /workspaces/InvenTree/dev/{commandhistory,plugins}
-cd /workspaces/InvenTree
+mkdir -p $1/dev/{commandhistory,plugins}
+cd $1
 
 # create venv
-python3 -m venv dev/venv
-. dev/venv/bin/activate
+python3 -m venv $1/dev/venv
+. $1/dev/venv/bin/activate
 
 # setup InvenTree server
 pip install invoke
-inv update
-inv setup-dev
+invoke update
+invoke setup-dev
+invoke frontend-install
+
+# remove existing gitconfig created by "Avoiding Dubious Ownership" step
+# so that it gets copied from host to the container to have your global
+# git config in container
+rm -f /home/vscode/.gitconfig

.djlintrc

@@ -0,0 +1,3 @@
+{
+    "ignore": "D018,H006,H008,H020,H021,H023,H025,H030,H031,T002"
+}

.eslintrc.yml

@@ -4,7 +4,7 @@ env:
   es2021: true
   jquery: true
 extends:
-  - google
+  - eslint:recommended
 parserOptions:
   ecmaVersion: 12
 rules:
@@ -19,6 +19,8 @@ rules:
   valid-jsdoc: off
   no-multiple-empty-lines: off
   comma-dangle: off
+  no-unused-vars: off
+  no-useless-escape: off
   prefer-spread: off
   indent:
     - error

.github/CODEOWNERS

@@ -1,12 +1,2 @@
 # General owner is the maintainers team
 *       @SchrodingersGat
-
-# plugins are co-owned
-/InvenTree/plugin/      @SchrodingersGat @matmair
-/InvenTree/plugins/     @SchrodingersGat @matmair
-
-# Installer functions
-.pkgr.yml               @matmair
-Procfile                @matmair
-runtime.txt             @matmair
-/contrib/               @matmair

.github/FUNDING.yml

@@ -1,2 +1,4 @@
-patreon: inventree
+github: inventree
 ko_fi: inventree
+patreon: inventree
+custom: [paypal.me/inventree]

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -52,6 +52,13 @@ body:
       label: "Version Information"
       description: "The version info block."
       placeholder: "You can get this by going to the `About InvenTree` section in the upper right corner and clicking on the `copy version information` button"
+  - type: checkboxes
+    id: can-reproduce
+    attributes:
+      label: "Please verify if you can reproduce this bug on the demo site."
+      description: "You can sign in at [InvenTree Demo](https://demo.inventree.org) with admin:inventree. Note that this instance runs on the latest dev version, so your bug may be fixed there."
+      options:
+        - label: "I can reproduce this bug on the demo site."
   - type: textarea
     id: logs
     attributes:

.github/ISSUE_TEMPLATE/documentation.yaml

@@ -0,0 +1,15 @@
+name: "Documentation"
+description: "Create an issue to improve the documentation"
+labels: ["documentation", "triage:not-checked"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Create a new issue regarding the InvenTree documentation
+  - type: textarea
+    id: repro
+    attributes:
+      label: Body of the issue
+      description: Please provide one distinct thing to fix or a clearly defined enhancement
+    validations:
+      required: true

.github/actions/migration/action.yaml

@@ -1,5 +1,5 @@
 name: 'Migration test'
-description: 'Run migration test sequenze'
+description: 'Run migration test sequence'
 author: 'InvenTree'
 
 runs:

.github/actions/setup/action.yaml

@@ -1,5 +1,5 @@
 name: 'Setup Enviroment'
-description: 'Setup the enviroment for general InvenTree tests'
+description: 'Setup the environment for general InvenTree tests'
 author: 'InvenTree'
 inputs:
     python:
@@ -35,12 +35,12 @@ runs:
     using: 'composite'
     steps:
       - name: Checkout Code
-        uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # pin@v3.1.0
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # pin@v4.1.1
 
       # Python installs
       - name: Set up Python ${{ env.python_version }}
         if: ${{ inputs.python == 'true' }}
-        uses: actions/setup-python@13ae5bb136fac2878aff31522b9efb785519f984 # pin@v4.3.0
+        uses: actions/setup-python@65d7f2d534ac1bc67fcd62888c5f4f3d2cb2b236 # pin@v4.7.1
         with:
           python-version: ${{ env.python_version }}
           cache: pip
@@ -48,7 +48,7 @@ runs:
         if: ${{ inputs.python == 'true' }}
         shell: bash
         run: |
-          python3 -m pip install pip==23.0.1
+          python3 -m pip install -U pip
           pip3 install invoke wheel
       - name: Install Specific Python Dependencies
         if: ${{ inputs.pip-dependency }}
@@ -58,11 +58,11 @@ runs:
       # NPM installs
       - name: Install node.js ${{ env.node_version }}
         if: ${{ inputs.npm == 'true' }}
-        uses: actions/setup-node@969bd2663942d722d85b6a8626225850c2f7be4b  # pin to v3.5.0
+        uses: actions/setup-node@1a4442cacd436585916779262731d5b162bc6ec7  # pin to v3.8.2
         with:
           node-version: ${{ env.node_version }}
           cache: 'npm'
-      - name: Intall npm packages
+      - name: Install npm packages
         if: ${{ inputs.npm == 'true' }}
         shell: bash
         run: npm install

.github/release.yml

@@ -4,6 +4,7 @@ changelog:
   exclude:
     labels:
       - translation
+      - documentation
   categories:
     - title: Breaking Changes
       labels:
@@ -15,7 +16,11 @@ changelog:
     - title: New Features
       labels:
         - Semver-Minor
+        - feature
         - enhancement
+    - title: Experimental Features
+      labels:
+        - experimental
     - title: Bug Fixes
       labels:
         - Semver-Patch

.github/workflows/backport.yml

@@ -0,0 +1,37 @@
+# Backport tagged issues to a stable branch.
+#
+# To enable backporting for a pullrequest, add the label "backport" to the PR.
+# Additionally, add a label with the prefix "backport-to-" and the target branch
+
+name: Backport
+
+on:
+  pull_request_target:
+    types: [ "labeled", "closed" ]
+
+jobs:
+  backport:
+    name: Backport PR
+    runs-on: ubuntu-latest
+    if: |
+      github.event.pull_request.merged == true
+      && contains(github.event.pull_request.labels.*.name, 'backport')
+      && (
+        (github.event.action == 'labeled' && github.event.label.name == 'backport')
+        || (github.event.action == 'closed')
+      )
+    steps:
+      - name: Backport Action
+        uses: sqren/backport-github-action@f54e19901f2a57f8b82360f2490d47ee82ec82c6 # pin@v9.2.2
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          auto_backport_label_prefix: backport-to-
+          add_original_reviewers: true
+
+      - name: Info log
+        if: ${{ success() }}
+        run: cat ~/.backport/backport.info.log
+
+      - name: Debug log
+        if: ${{ failure() }}
+        run: cat ~/.backport/backport.debug.log

.github/workflows/check_translations.yaml

@@ -25,9 +25,9 @@ jobs:
 
     steps:
       - name: Checkout Code
-        uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # pin@v3.1.0
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # pin@v4.1.1
       - name: Set Up Python ${{ env.python_version }}
-        uses: actions/setup-python@13ae5bb136fac2878aff31522b9efb785519f984 # pin@v4.3.0
+        uses: actions/setup-python@65d7f2d534ac1bc67fcd62888c5f4f3d2cb2b236 # pin@v4.7.1
         with:
           python-version: ${{ env.python_version }}
           cache: 'pip'

.github/workflows/docker.yaml

@@ -20,19 +20,39 @@ on:
   push:
     branches:
       - 'master'
-
-  # pull_request:
-  #   branches:
-  #     - 'master'
+  pull_request:
+    branches:
+      - 'master'
 
 jobs:
 
+  paths-filter:
+    name: Filter
+    runs-on: ubuntu-latest
+
+    outputs:
+      docker: ${{ steps.filter.outputs.docker }}
+
+    steps:
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # pin@v4.1.1
+      - uses: dorny/paths-filter@4512585405083f25c027a35db413c2b3b9006d50 # pin@v2.11.1
+        id: filter
+        with:
+          filters: |
+            docker:
+              - .github/workflows/docker.yaml
+              - docker/**
+              - docker-compose.yml
+              - docker.dev.env
+              - Dockerfile
+              - requirements.txt
+
+
   # Build the docker image
   build:
-    concurrency:
-      group: ${{ github.workflow }}-${{ github.event_name }}
-      cancel-in-progress: true
     runs-on: ubuntu-latest
+    needs: paths-filter
+    if: needs.paths-filter.outputs.docker == 'true' || github.event_name == 'release' || github.event_name == 'push'
     permissions:
       contents: read
       packages: write
@@ -42,9 +62,9 @@ jobs:
       python_version: 3.9
     steps:
       - name: Check out repo
-        uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # pin@v3.1.0
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # pin@v4.1.1
       - name: Set Up Python ${{ env.python_version }}
-        uses: actions/setup-python@13ae5bb136fac2878aff31522b9efb785519f984 # pin@v4.3.0
+        uses: actions/setup-python@65d7f2d534ac1bc67fcd62888c5f4f3d2cb2b236 # pin@v4.7.1
         with:
           python-version: ${{ env.python_version }}
       - name: Version Check
@@ -63,7 +83,6 @@ jobs:
           docker-compose run inventree-dev-server invoke update
           docker-compose run inventree-dev-server invoke setup-dev
           docker-compose up -d
-          docker-compose run inventree-dev-server pip install --upgrade setuptools
           docker-compose run inventree-dev-server invoke wait
       - name: Check Data Directory
         # The following file structure should have been created by the docker image
@@ -81,26 +100,27 @@ jobs:
         run: |
           echo "GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }}" >> docker.dev.env
           docker-compose run inventree-dev-server invoke test --disable-pty
+          docker-compose run inventree-dev-server invoke test --migrations --disable-pty
           docker-compose down
       - name: Set up QEMU
         if: github.event_name != 'pull_request'
-        uses: docker/setup-qemu-action@e81a89b1732b9c48d79cd809d8d81d79c4647a18 # pin@v2.1.0
+        uses: docker/setup-qemu-action@68827325e0b33c7199eb31dd4e31fbe9023e06e3 # pin@v3.0.0
       - name: Set up Docker Buildx
         if: github.event_name != 'pull_request'
-        uses: docker/setup-buildx-action@95cb08cb2672c73d4ffd2f422e6d11953d2a9c70 # pin@v2.1.0
+        uses: docker/setup-buildx-action@f95db51fddba0c2d1ec667646a06c2ce06100226 # pin@v3.0.0
       - name: Set up cosign
         if: github.event_name != 'pull_request'
-        uses: sigstore/cosign-installer@7cc35d7fdbe70d4278a0c96779081e6fac665f88 # pin@v2.8.0
+        uses: sigstore/cosign-installer@11086d25041f77fe8fe7b9ea4e48e3b9192b8f19 # pin@v3.1.2
       - name: Login to Dockerhub
         if: github.event_name != 'pull_request'
-        uses: docker/login-action@f4ef78c080cd8ba55a85445d5b36e214a81df20a # pin@v2.1.0
+        uses: docker/login-action@343f7c4344506bcbf9b4de18042ae17996df046d # pin@v3.0.0
         with:
           username: ${{ secrets.DOCKER_USERNAME }}
           password: ${{ secrets.DOCKER_PASSWORD }}
 
       - name: Log into registry ghcr.io
         if: github.event_name != 'pull_request'
-        uses: docker/login-action@f4ef78c080cd8ba55a85445d5b36e214a81df20a # pin@v2
+        uses: docker/login-action@343f7c4344506bcbf9b4de18042ae17996df046d # pin@v3.0.0
         with:
           registry: ghcr.io
           username: ${{ github.actor }}
@@ -109,7 +129,7 @@ jobs:
       - name: Extract Docker metadata
         if: github.event_name != 'pull_request'
         id: meta
-        uses: docker/metadata-action@12cce9efe0d49980455aaaca9b071c0befcdd702 # pin@v4.1.0
+        uses: docker/metadata-action@96383f45573cb7f253c731d3b3ab81c87ef81934 # pin@v5.0.0
         with:
           images: |
             inventree/inventree
@@ -118,11 +138,13 @@ jobs:
       - name: Build and Push
         id: build-and-push
         if: github.event_name != 'pull_request'
-        uses: docker/build-push-action@c56af957549030174b10d6867f20e78cfd7debc5 # pin@v3.2.0
+        uses: docker/build-push-action@0565240e2d4ab88bba5387d719585280857ece09 # pin@v5.0.0
         with:
           context: .
-          platforms: linux/amd64,linux/arm64,linux/arm/v7
+          platforms: linux/amd64,linux/arm64
           push: true
+          sbom: true
+          provenance: false
           target: production
           tags: ${{ env.docker_tags }}
           build-args: |
@@ -133,5 +155,4 @@ jobs:
         if: ${{ false }} # github.event_name != 'pull_request'
         env:
           COSIGN_EXPERIMENTAL: "true"
-        run: cosign sign ${{ steps.meta.outputs.tags }}@${{
-          steps.build-and-push.outputs.digest }}
+        run: cosign sign ${{ steps.meta.outputs.tags }}@${{ steps.build-and-push.outputs.digest }}

.github/workflows/qc_checks.yaml

@@ -1,15 +1,12 @@
 # Checks for each PR / push
 
-name: QC checks
+name: QC
 
 on:
   push:
-    branches-ignore:
-      - l10*
-
+    branches-ignore: [ 'l10*' ]
   pull_request:
-    branches-ignore:
-      - l10*
+    branches-ignore: [ 'l10*' ]
 
 env:
   python_version: 3.9
@@ -25,13 +22,41 @@ env:
   INVENTREE_BACKUP_DIR: ../test_inventree_backup
 
 jobs:
+  paths-filter:
+    name: Filter
+    runs-on: ubuntu-latest
+
+    outputs:
+      server: ${{ steps.filter.outputs.server }}
+      migrations: ${{ steps.filter.outputs.migrations }}
+      frontend: ${{ steps.filter.outputs.frontend }}
+
+    steps:
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # pin@v4.1.1
+      - uses: dorny/paths-filter@4512585405083f25c027a35db413c2b3b9006d50 # pin@v2.11.1
+        id: filter
+        with:
+          filters: |
+            server:
+              - 'InvenTree/**'
+              - 'requirements.txt'
+              - 'requirements-dev.txt'
+            migrations:
+              - '**/migrations/**'
+              - '.github/workflows**'
+            frontend:
+              - 'src/frontend/**'
+
   pep_style:
     name: Style [Python]
     runs-on: ubuntu-20.04
 
+    needs: paths-filter
+    if: needs.paths-filter.outputs.server == 'true'
+
     steps:
-      - uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # pin@v3.1.0
-      - name: Enviroment Setup
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # pin@v4.1.1
+      - name: Environment Setup
         uses: ./.github/actions/setup
         with:
           dev-install: true
@@ -39,14 +64,14 @@ jobs:
         run: flake8 InvenTree --extend-ignore=D
 
   javascript:
-    name: Style [JS]
+    name: Style - Classic UI [JS]
     runs-on: ubuntu-20.04
 
-    needs: pep_style
+    needs: [ 'pep_style', 'pre-commit' ]
 
     steps:
-      - uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # pin@v3.1.0
-      - name: Enviroment Setup
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # pin@v4.1.1
+      - name: Environment Setup
         uses: ./.github/actions/setup
         with:
           npm: true
@@ -60,32 +85,16 @@ jobs:
           python InvenTree/manage.py prerender
           npx eslint InvenTree/InvenTree/static_i18n/i18n/*.js
 
-  html:
-    name: Style [HTML]
-    runs-on: ubuntu-20.04
-
-    needs: pep_style
-
-    steps:
-      - uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # pin@v3.1.0
-      - name: Enviroment Setup
-        uses: ./.github/actions/setup
-        with:
-          npm: true
-          install: true
-      - name: Check HTML Files
-        run: npx markuplint **/templates/*.html
-
   pre-commit:
     name: Style [pre-commit]
     runs-on: ubuntu-20.04
-
-    needs: pep_style
+    needs: paths-filter
+    if: needs.paths-filter.outputs.server == 'true' || needs.paths-filter.outputs.frontend == 'true'
 
     steps:
-      - uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # pin@v3.1.0
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # pin@v4.1.1
       - name: Set up Python ${{ env.python_version }}
-        uses: actions/setup-python@13ae5bb136fac2878aff31522b9efb785519f984 # pin@v4.3.0
+        uses: actions/setup-python@65d7f2d534ac1bc67fcd62888c5f4f3d2cb2b236 # pin@v4.7.1
         with:
           python-version: ${{ env.python_version }}
           cache: 'pip'
@@ -96,6 +105,28 @@ jobs:
           pip install requests
           python3 ci/version_check.py
 
+  mkdocs:
+    name: Style [Documentation]
+    runs-on: ubuntu-20.04
+
+    needs: paths-filter
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # pin@v4.1.1
+      - name: Set up Python ${{ env.python_version }}
+        uses: actions/setup-python@65d7f2d534ac1bc67fcd62888c5f4f3d2cb2b236 # pin@v4.7.1
+        with:
+          python-version: ${{ env.python_version }}
+      - name: Check Config
+        run: |
+          pip install pyyaml
+          python docs/ci/check_mkdocs_config.py
+      - name: Check Links
+        run: |
+          pip install linkcheckmd requests
+          python -m linkcheckmd docs --recurse
+
   python:
     name: Tests - inventree-python
     runs-on: ubuntu-20.04
@@ -114,16 +145,16 @@ jobs:
       INVENTREE_PYTHON_TEST_PASSWORD: testpassword
 
     steps:
-      - uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # pin@v3.1.0
-      - name: Enviroment Setup
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # pin@v4.1.1
+      - name: Environment Setup
         uses: ./.github/actions/setup
         with:
           apt-dependency: gettext poppler-utils
           dev-install: true
           update: true
+          npm: true
       - name: Download Python Code For `${{ env.wrapper_name }}`
-        run: git clone --depth 1 https://github.com/inventree/${{ env.wrapper_name }}
-          ./${{ env.wrapper_name }}
+        run: git clone --depth 1 https://github.com/inventree/${{ env.wrapper_name }} ./${{ env.wrapper_name }}
       - name: Start InvenTree Server
         run: |
           invoke delete-data -f
@@ -144,8 +175,8 @@ jobs:
     continue-on-error: true
 
     steps:
-      - uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # pin@v3.1.0
-      - name: Enviroment Setup
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # pin@v4.1.1
+      - name: Environment Setup
         uses: ./.github/actions/setup
         with:
           install: true
@@ -156,37 +187,40 @@ jobs:
     name: Tests - DB [SQLite] + Coverage
     runs-on: ubuntu-20.04
 
-    needs: [ 'javascript', 'html', 'pre-commit' ]
+    needs: [ 'pep_style', 'pre-commit' ]
     continue-on-error: true # continue if a step fails so that coverage gets pushed
 
     env:
       INVENTREE_DB_NAME: ./inventree.sqlite
       INVENTREE_DB_ENGINE: sqlite3
       INVENTREE_PLUGINS_ENABLED: true
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
     steps:
-      - uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # pin@v3.1.0
-      - name: Enviroment Setup
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # pin@v4.1.1
+      - name: Environment Setup
         uses: ./.github/actions/setup
         with:
           apt-dependency: gettext poppler-utils
           dev-install: true
           update: true
-      - name: Coverage Tests
-        run: invoke coverage
       - name: Data Export Test
         uses: ./.github/actions/migration
       - name: Test Translations
         run: invoke translate
       - name: Check Migration Files
         run: python3 ci/check_migration_files.py
+      - name: Coverage Tests
+        run: invoke test --coverage
       - name: Upload Coverage Report
-        run: coveralls
+        uses: coverallsapp/github-action@3dfc5567390f6fa9267c0ee9c251e4c8c3f18949 # pin@v2.2.3
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
 
   postgres:
     name: Tests - DB [PostgreSQL]
     runs-on: ubuntu-20.04
-    needs: [ 'javascript', 'html', 'pre-commit' ]
+    needs: [ 'pep_style', 'pre-commit' ]
 
     env:
       INVENTREE_DB_ENGINE: django.db.backends.postgresql
@@ -213,8 +247,8 @@ jobs:
           - 6379:6379
 
     steps:
-      - uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # pin@v3.1.0
-      - name: Enviroment Setup
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # pin@v4.1.1
+      - name: Environment Setup
         uses: ./.github/actions/setup
         with:
           apt-dependency: gettext poppler-utils libpq-dev
@@ -230,8 +264,7 @@ jobs:
     name: Tests - DB [MySQL]
     runs-on: ubuntu-20.04
 
-    needs: [ 'javascript', 'html', 'pre-commit' ]
-    if: github.event_name == 'push'
+    needs: [ 'pep_style', 'pre-commit' ]
 
     env:
       # Database backend configuration
@@ -252,14 +285,13 @@ jobs:
           MYSQL_USER: inventree
           MYSQL_PASSWORD: password
           MYSQL_ROOT_PASSWORD: password
-        options: --health-cmd="mysqladmin ping" --health-interval=5s --health-timeout=2s
-          --health-retries=3
+        options: --health-cmd="mysqladmin ping" --health-interval=5s --health-timeout=2s --health-retries=3
         ports:
           - 3306:3306
 
     steps:
-      - uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # pin@v3.1.0
-      - name: Enviroment Setup
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # pin@v4.1.1
+      - name: Environment Setup
         uses: ./.github/actions/setup
         with:
           apt-dependency: gettext poppler-utils libmysqlclient-dev
@@ -270,3 +302,148 @@ jobs:
         run: invoke test
       - name: Data Export Test
         uses: ./.github/actions/migration
+
+  migration-tests:
+    name: Tests - Migrations [PostgreSQL]
+    runs-on: ubuntu-latest
+    needs: paths-filter
+    if: github.ref == 'refs/heads/master' && needs.paths-filter.outputs.migrations == 'true'
+
+    env:
+      INVENTREE_DB_ENGINE: django.db.backends.postgresql
+      INVENTREE_DB_NAME: inventree
+      INVENTREE_DB_USER: inventree
+      INVENTREE_DB_PASSWORD: password
+      INVENTREE_DB_HOST: '127.0.0.1'
+      INVENTREE_DB_PORT: 5432
+      INVENTREE_DEBUG: info
+      INVENTREE_PLUGINS_ENABLED: false
+
+    services:
+      postgres:
+        image: postgres:14
+        env:
+          POSTGRES_USER: inventree
+          POSTGRES_PASSWORD: password
+        ports:
+          - 5432:5432
+
+    steps:
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # pin@v4.1.1
+      - name: Environment Setup
+        uses: ./.github/actions/setup
+        with:
+          apt-dependency: gettext poppler-utils libpq-dev
+          pip-dependency: psycopg2
+          dev-install: true
+          update: true
+      - name: Run Tests
+        run: invoke test --migrations --report
+
+  migrations-checks:
+    name: Tests - Full Migration [SQLite]
+    runs-on: ubuntu-latest
+    needs: paths-filter
+    if: github.ref == 'refs/heads/master' && needs.paths-filter.outputs.migrations == 'true'
+
+    env:
+      INVENTREE_DB_ENGINE: sqlite3
+      INVENTREE_DB_NAME: /home/runner/work/InvenTree/db.sqlite3
+      INVENTREE_DEBUG: info
+      INVENTREE_PLUGINS_ENABLED: false
+
+    steps:
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # pin@v4.1.1
+        name: Checkout Code
+      - name: Environment Setup
+        uses: ./.github/actions/setup
+        with:
+          install: true
+      - name: Fetch Database
+        run: git clone --depth 1 https://github.com/inventree/test-db ./test-db
+
+      - name: Latest Database
+        run: |
+          cp test-db/latest.sqlite3 /home/runner/work/InvenTree/db.sqlite3
+          chmod +rw /home/runner/work/InvenTree/db.sqlite3
+          invoke migrate
+
+      - name: 0.10.0 Database
+        run: |
+          rm /home/runner/work/InvenTree/db.sqlite3
+          cp test-db/stable_0.10.0.sqlite3 /home/runner/work/InvenTree/db.sqlite3
+          chmod +rw /home/runner/work/InvenTree/db.sqlite3
+          invoke migrate
+
+      - name: 0.11.0 Database
+        run: |
+          rm /home/runner/work/InvenTree/db.sqlite3
+          cp test-db/stable_0.11.0.sqlite3 /home/runner/work/InvenTree/db.sqlite3
+          chmod +rw /home/runner/work/InvenTree/db.sqlite3
+          invoke migrate
+
+      - name: 0.12.0 Database
+        run: |
+          rm /home/runner/work/InvenTree/db.sqlite3
+          cp test-db/stable_0.12.0.sqlite3 /home/runner/work/InvenTree/db.sqlite3
+          chmod +rw /home/runner/work/InvenTree/db.sqlite3
+          invoke migrate
+
+  platform_ui:
+    name: Tests - Platform UI
+    runs-on: ubuntu-20.04
+    timeout-minutes: 60
+    needs: [ 'pre-commit', 'paths-filter' ]
+    if: needs.paths-filter.outputs.frontend == 'true'
+    env:
+      INVENTREE_DB_ENGINE: sqlite3
+      INVENTREE_DB_NAME: /home/runner/work/InvenTree/db.sqlite3
+      INVENTREE_DEBUG: True
+      INVENTREE_PLUGINS_ENABLED: false
+
+    steps:
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # pin@v4.1.1
+      - name: Environment Setup
+        uses: ./.github/actions/setup
+        with:
+          npm: true
+          install: true
+          update: true
+      - name: Set up test data
+        run: invoke setup-test -i
+      - name: Install dependencies
+        run: inv frontend-compile
+      - name: Install Playwright Browsers
+        run: cd src/frontend && npx playwright install --with-deps
+      - name: Run Playwright tests
+        run: cd src/frontend &&  npx playwright test
+      - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 # pin@v3.1.3
+        if: always()
+        with:
+          name: playwright-report
+          path: src/frontend/playwright-report/
+          retention-days: 30
+
+  platform_ui_build:
+    name: Build - UI Platform
+    runs-on: ubuntu-20.04
+    timeout-minutes: 60
+
+    steps:
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # pin@v4.1.1
+      - name: Environment Setup
+        uses: ./.github/actions/setup
+        with:
+          npm: true
+      - name: Install dependencies
+        run: cd src/frontend && yarn install
+      - name: Build frontend
+        run: cd src/frontend && npm run build
+      - name: Zip frontend
+        run: |
+          cd InvenTree/web/static
+          zip -r frontend-build.zip web/
+      - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 # pin@v3.1.3
+        with:
+          name: frontend-build
+          path: InvenTree/web/static/web

.github/workflows/release.yml

@@ -13,15 +13,39 @@ jobs:
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
     steps:
       - name: Checkout Code
-        uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # pin@v3.1.0
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # pin@v4.1.1
       - name: Version Check
         run: |
           pip install requests
           python3 ci/version_check.py
       - name: Push to Stable Branch
-        uses: ad-m/github-push-action@4dcce6dea3e3c8187237fc86b7dfdc93e5aaae58 # pin@master
+        uses: ad-m/github-push-action@d91a481090679876dfc4178fef17f286781251df # pin@v0.8.0
         if: env.stable_release == 'true'
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           branch: stable
           force: true
+
+  publish-build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # pin@v4.1.1
+      - name: Environment Setup
+        uses: ./.github/actions/setup
+        with:
+          npm: true
+      - name: Install dependencies
+        run: cd src/frontend && yarn install
+      - name: Build frontend
+        run: cd src/frontend && npm run build
+      - name: Zip frontend
+        run: |
+          cd InvenTree/web/static/web
+          zip -r ../frontend-build.zip *
+      - uses: svenstaro/upload-release-action@1beeb572c19a9242f4361f4cee78f8e0d9aec5df # pin@2.7.0
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          file: InvenTree/web/static/frontend-build.zip
+          asset_name: frontend-build.zip
+          tag: ${{ github.ref }}
+          overwrite: true

.github/workflows/social.yml.disabled

@@ -1,35 +0,0 @@
-# Runs on releases
-
-name: Publish release notes
-on:
-  release:
-    types: [ published ]
-
-jobs:
-
-  tweet:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: Eomm/why-don-t-you-tweet@5936bb1fd0096b1c2bbbb7518746638261bb4dae # pin@v1.0.1
-        with:
-          tweet-message: "InvenTree release ${{ github.event.release.tag_name }} is out
-            now! Release notes: ${{ github.event.release.html_url }} #opensource
-            #inventree"
-        env:
-          TWITTER_CONSUMER_API_KEY: ${{ secrets.TWITTER_CONSUMER_API_KEY }}
-          TWITTER_CONSUMER_API_SECRET: ${{ secrets.TWITTER_CONSUMER_API_SECRET }}
-          TWITTER_ACCESS_TOKEN: ${{ secrets.TWITTER_ACCESS_TOKEN }}
-          TWITTER_ACCESS_TOKEN_SECRET: ${{ secrets.TWITTER_ACCESS_TOKEN_SECRET }}
-
-  reddit:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: bluwy/release-for-reddit-action@4b2d034b5c86a24db24363f1064149a8c2db69b4 # pin@v1.2.0
-        with:
-          username: ${{ secrets.REDDIT_USERNAME }}
-          password: ${{ secrets.REDDIT_PASSWORD }}
-          app-id: ${{ secrets.REDDIT_APP_ID }}
-          app-secret: ${{ secrets.REDDIT_APP_SECRET }}
-          subreddit: InvenTree
-          title: "InvenTree version ${{ github.event.release.tag_name }} released"
-          comment: "${{ github.event.release.body }}"

.github/workflows/sponsors.yml

@@ -0,0 +1,35 @@
+name: Generate Sponsors README
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: 30 15 * * 0-6
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    if: github.repository_owner == 'Inventree'
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11
+
+      - name: Generate Sponsors
+        uses: JamesIves/github-sponsors-readme-action@a2d75a8d58b117b19777a910e284ccb082aaf117
+        with:
+          token: ${{ secrets.INVENTREE_SPONSORS_TOKEN }}
+          file: 'README.md'
+          organization: true
+
+      - name: Commit files
+        run: |
+          git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          git checkout -b sponsors
+          git add README.md
+          git commit -m "updated sponsors"
+
+      - name: Push Changes
+        uses: ad-m/github-push-action@d91a481090679876dfc4178fef17f286781251df
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: sponsors
+          force: true

.github/workflows/stale.yml

@@ -14,11 +14,10 @@ jobs:
       pull-requests: write
 
     steps:
-      - uses: actions/stale@5ebf00ea0e4c1561e9b43a292ed34424fb1d4578 # pin@v6.0.1
+      - uses: actions/stale@1160a2240286f5da8ec72b1c0816ce2481aabf84 # pin@v8.0.0
         with:
           repo-token: ${{ secrets.GITHUB_TOKEN }}
-          stale-issue-message: 'This issue seems stale. Please react to show this is still
-            important.'
+          stale-issue-message: 'This issue seems stale. Please react to show this is still important.'
           stale-pr-message: 'This PR seems stale. Please react to show this is still important.'
           stale-issue-label: 'inactive'
           stale-pr-label: 'inactive'

.github/workflows/translations.yml

@@ -21,11 +21,15 @@ jobs:
 
     steps:
       - name: Checkout Code
-        uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # pin@v3.1.0
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # pin@v4.1.1
       - name: Set up Python 3.9
-        uses: actions/setup-python@13ae5bb136fac2878aff31522b9efb785519f984 # pin@v4.3.0
+        uses: actions/setup-python@65d7f2d534ac1bc67fcd62888c5f4f3d2cb2b236 # pin@v4.7.1
         with:
           python-version: 3.9
+      - name: Set up Node 16
+        uses: actions/setup-node@1a4442cacd436585916779262731d5b162bc6ec7  # pin to v3.8.2
+        with:
+          node-version: 16
       - name: Install Dependencies
         run: |
           sudo apt-get update
@@ -33,8 +37,7 @@ jobs:
           pip3 install invoke
           invoke install
       - name: Make Translations
-        run: |
-          invoke translate
+        run: invoke translate
       - name: Commit files
         run: |
           git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
@@ -43,7 +46,7 @@ jobs:
           git add "*.po"
           git commit -m "updated translation base"
       - name: Push changes
-        uses: ad-m/github-push-action@4dcce6dea3e3c8187237fc86b7dfdc93e5aaae58 # pin@master
+        uses: ad-m/github-push-action@d91a481090679876dfc4178fef17f286781251df # pin@v0.8.0
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           branch: l10

.github/workflows/update.yml.disabled

@@ -9,14 +9,13 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # pin@v3.1.0
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # pin@v4.1.1
       - name: Setup
         run: pip install -r requirements-dev.txt
       - name: Update requirements.txt
         run: pip-compile --output-file=requirements.txt requirements.in -U
       - name: Update requirements-dev.txt
-        run: pip-compile --generate-hashes --output-file=requirements-dev.txt
-          requirements-dev.in -U
+        run: pip-compile --generate-hashes --output-file=requirements-dev.txt requirements-dev.in -U
       - uses: stefanzweifel/git-auto-commit-action@fd157da78fa13d9383e5580d1fd1184d89554b51 # pin@v4.15.1
         with:
           commit_message: "[Bot] Updated dependency"

.gitignore

@@ -40,14 +40,14 @@ inventree-demo-dataset/
 inventree-data/
 dummy_image.*
 _tmp.csv
-inventree/label.pdf
-inventree/label.png
-inventree/my_special*
+InvenTree/label.pdf
+InvenTree/label.png
+InvenTree/part_image_123abc.png
+label.pdf
+label.png
+InvenTree/my_special*
 _tests*.txt
 
-# Sphinx files
-docs/_build
-
 # Local static and media file storage (only when running in development mode)
 inventree_media
 inventree_static
@@ -100,7 +100,10 @@ node_modules/
 maintenance_mode_state.txt
 
 # plugin dev directory
-plugins/
+InvenTree/plugins/
 
 # Compiled translation files
 *.mo
+
+# web frontend (static files)
+InvenTree/web/static

.gitpod.yml

@@ -1,44 +0,0 @@
-tasks:
- - name: Setup django
-   before: |
-      export INVENTREE_DB_ENGINE='sqlite3'
-      export INVENTREE_DB_NAME='/workspace/InvenTree/dev/database.sqlite3'
-      export INVENTREE_MEDIA_ROOT='/workspace/InvenTree/inventree-data/media'
-      export INVENTREE_STATIC_ROOT='/workspace/InvenTree/dev/static'
-      export INVENTREE_BACKUP_DIR='/workspace/InvenTree/dev/backup'
-      export PIP_USER='no'
-
-      sudo apt install -y gettext
-      python3 -m venv venv
-      source venv/bin/activate
-      pip install invoke pyyaml
-      mkdir dev
-      invoke update
-      invoke setup-test --ignore-update --path inventree-data
-      gp sync-done start_server
-
- - name: Start server
-   init: gp sync-await start_server
-   command: |
-      gp sync-await start_server
-      export INVENTREE_DB_ENGINE='sqlite3'
-      export INVENTREE_DB_NAME='/workspace/InvenTree/dev/database.sqlite3'
-      export INVENTREE_MEDIA_ROOT='/workspace/InvenTree/inventree-data/media'
-      export INVENTREE_STATIC_ROOT='/workspace/InvenTree/dev/static'
-      export INVENTREE_BACKUP_DIR='/workspace/InvenTree/dev/backup'
-
-      source venv/bin/activate
-      inv server
-
-ports:
-  - port: 8000
-    onOpen: open-preview
-
-github:
-  prebuilds:
-    master: true
-    pullRequests: false
-    pullRequestsFromForks: true
-    addBadge: true
-    addLabel: gitpod-ready
-    addCheck: false

.pkgr.yml

@@ -1,7 +1,7 @@
 name: inventree
 description: Open Source Inventory Management System
 homepage: https://inventree.org
-notifications: false
+notifications: true
 buildpack: https://github.com/mjmair/heroku-buildpack-python#v216-mjmair
 env:
   - STACK=heroku-20
@@ -15,10 +15,13 @@ env:
   - INVENTREE_PLUGIN_FILE=/opt/inventree/plugins.txt
   - INVENTREE_CONFIG_FILE=/opt/inventree/config.yaml
 after_install: contrib/packager.io/postinstall.sh
+before:
+  - contrib/packager.io/before.sh
 dependencies:
   - curl
-  - python3
-  - python3-venv
+  - python3.9
+  - python3.9-venv
+  - python3.9-dev
   - python3-pip
   - python3-cffi
   - python3-brotli
@@ -33,3 +36,4 @@ dependencies:
 targets:
   ubuntu-20.04: true
   debian-11: true
+  debian-12: true

.pre-commit-config.yaml

@@ -3,38 +3,77 @@
 exclude: |
     (?x)^(
         InvenTree/InvenTree/static/.*|
-        InvenTree/locale/.*
+        InvenTree/locale/.*|
+        src/frontend/src/locales/.*
     )$
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.5.0
     hooks:
     -   id: trailing-whitespace
     -   id: end-of-file-fixer
     -   id: check-yaml
-    -   id: check-added-large-files
     -   id: mixed-line-ending
 -   repo: https://github.com/pycqa/flake8
-    rev: '6.0.0'
+    rev: '6.1.0'
     hooks:
     -   id: flake8
         additional_dependencies: [
+                'flake8-bugbear',
+                'flake8-comprehensions',
                 'flake8-docstrings',
                 'flake8-string-format',
-                'pep8-naming ',
+                'flake8-tidy-imports',
+                'pep8-naming',
+                'flake8-logging'
         ]
 -   repo: https://github.com/pycqa/isort
     rev: '5.12.0'
     hooks:
     -   id: isort
 -   repo: https://github.com/jazzband/pip-tools
-    rev: 6.12.3
+    rev: 7.3.0
     hooks:
       - id: pip-compile
         name: pip-compile requirements-dev.in
-        args: [--generate-hashes, requirements-dev.in, -o, requirements-dev.txt]
+        args: [requirements-dev.in, -o, requirements-dev.txt]
         files: ^requirements-dev\.(in|txt)$
       - id: pip-compile
         name: pip-compile requirements.txt
         args: [requirements.in, -o, requirements.txt]
         files: ^requirements\.(in|txt)$
+-   repo: https://github.com/Riverside-Healthcare/djLint
+    rev: v1.34.0
+    hooks:
+      - id: djlint-django
+- repo: https://github.com/codespell-project/codespell
+  rev: v2.2.6
+  hooks:
+  - id: codespell
+    exclude: >
+      (?x)^(
+          docs/docs/stylesheets/.*|
+          docs/docs/javascripts/.*|
+          docs/docs/webfonts/.* |
+          src/frontend/src/locales/.* |
+      )$
+- repo: https://github.com/pre-commit/mirrors-prettier
+  rev: "v3.0.3"
+  hooks:
+    - id: prettier
+      files: ^src/frontend/.*\.(js|jsx|ts|tsx)$
+      additional_dependencies:
+      - "prettier@^2.4.1"
+      - "@trivago/prettier-plugin-sort-imports"
+- repo: https://github.com/pre-commit/mirrors-eslint
+  rev: "v8.51.0"
+  hooks:
+  - id: eslint
+    additional_dependencies:
+      - eslint@^8.41.0
+      - eslint-config-google@^0.14.0
+      - eslint-plugin-react@6.10.3
+      - babel-eslint@6.1.2
+      - "@typescript-eslint/eslint-plugin@latest"
+      - "@typescript-eslint/parser"
+    files: ^src/frontend/.*\.(js|jsx|ts|tsx)$

.vscode/tasks.json

@@ -1,52 +1,70 @@
 {
   // See https://go.microsoft.com/fwlink/?LinkId=733558
   // for the documentation about the tasks.json format
+
+  // the problemMatchers should prevent vscode from asking how it should check the output
+
   "version": "2.0.0",
   "tasks": [
+    {
+      "label": "worker",
+      "type": "shell",
+      "command": "inv worker",
+      "problemMatcher": [],
+    },
     {
       "label": "clean-settings",
       "type": "shell",
       "command": "inv clean-settings",
+      "problemMatcher": [],
     },
     {
       "label": "delete-data",
       "type": "shell",
       "command": "inv delete-data",
+      "problemMatcher": [],
     },
     {
       "label": "migrate",
       "type": "shell",
       "command": "inv migrate",
+      "problemMatcher": [],
     },
     {
       "label": "server",
       "type": "shell",
       "command": "inv server",
+      "problemMatcher": [],
     },
     {
       "label": "setup-dev",
       "type": "shell",
       "command": "inv setup-dev",
+      "problemMatcher": [],
     },
     {
       "label": "setup-test",
       "type": "shell",
       "command": "inv setup-test --path dev/inventree-demo-dataset",
+      "problemMatcher": [],
     },
     {
       "label": "superuser",
       "type": "shell",
       "command": "inv superuser",
+      "problemMatcher": [],
     },
     {
       "label": "test",
       "type": "shell",
       "command": "inv test",
+      "problemMatcher": [],
     },
     {
       "label": "update",
       "type": "shell",
       "command": "inv update",
+      "problemMatcher": [],
     },
   ]
 }

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-Hi there, thank you for your intrest in contributing!
+Hi there, thank you for your interest in contributing!
 Please read the contribution guidelines below, before submitting your first pull request to the InvenTree codebase.
 
 ## Quickstart
@@ -19,7 +19,7 @@ pip install invoke && invoke setup-dev --tests
 ```bash
 git clone https://github.com/inventree/InvenTree.git && cd InvenTree
 docker compose run inventree-dev-server invoke install
-docker compose run inventree-dev-server invoke setup-test
+docker compose run inventree-dev-server invoke setup-test --dev
 docker compose up -d
 ```
 
@@ -33,7 +33,7 @@ Run the following command to set up all toolsets for development.
 invoke setup-dev
 ```
 
-*We recommend you run this command before starting to contribute. This will install and set up `pre-commit` to run some checks before each commit and help reduce the style errors.*
+*We recommend you run this command before starting to contribute. This will install and set up `pre-commit` to run some checks before each commit and help reduce errors.*
 
 ## Branches and Versioning
 
@@ -50,7 +50,7 @@ The HEAD of the "main" or "master" branch of InvenTree represents the current "l
 - All feature branches are merged into master
 - All bug fixes are merged into master
 
-**No pushing to master:** New featues must be submitted as a pull request from a separate branch (one branch per feature).
+**No pushing to master:** New features must be submitted as a pull request from a separate branch (one branch per feature).
 
 ### Feature Branches
 
@@ -70,7 +70,7 @@ The HEAD of the "stable" branch represents the latest stable release code.
 #### Release Candidate Branches
 
 - Release candidate branches are made from master, and merged into stable.
-- RC branches are targetted at a major/minor version e.g. "0.5"
+- RC branches are targeted at a major/minor version e.g. "0.5"
 - When a release candidate branch is merged into *stable*, the release is tagged
 
 #### Bugfix Branches
@@ -82,10 +82,11 @@ The HEAD of the "stable" branch represents the latest stable release code.
 ## Environment
 ### Target version
 We are currently targeting:
-| Name | Minimum version |
-|---|---|
-| Python | 3.9 |
-| Django | 3.2 |
+| Name | Minimum version | Note |
+|---|---| --- |
+| Python | 3.9 | |
+| Django | 3.2 | |
+| Node | 18 | Only needed for frontend development |
 
 ### Auto creating updates
 The following tools can be used to auto-upgrade syntax that was depreciated in new versions:
@@ -101,7 +102,7 @@ django-upgrade --target-version 3.2 `find . -name "*.py"`
 ```
 
 ## Credits
-If you add any new dependencies / libraries, they need to be added to [the docs](https://github.com/inventree/inventree-docs/blob/master/docs/credits.md). Please try to do that as timely as possible.
+If you add any new dependencies / libraries, they need to be added to [the docs](https://github.com/inventree/inventree/blob/master/docs/docs/credits.md). Please try to do that as timely as possible.
 
 
 ## Migration Files
@@ -123,14 +124,61 @@ The InvenTree code base makes use of [GitHub actions](https://github.com/feature
 
 The various github actions can be found in the `./github/workflows` directory
 
+### Run tests locally
+
+To run test locally, use:
+```
+invoke test
+```
+
+To run only partial tests, for example for a module use:
+```
+invoke test --runtest order
+```
+
+To see all the available options:
+
+```
+invoke test --help
+```
+
 ## Code Style
 
-Sumbitted Python code is automatically checked against PEP style guidelines. Locally you can run `invoke style` to ensure the style checks will pass, before submitting the PR.
-Please write docstrings for each function and class - we follow the [google doc-style](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) for python. Docstrings for general javascript code is encouraged! Docstyles are checked by `invoke style`.
+Code style is automatically checked as part of the project's CI pipeline on GitHub. This means that any pull requests which do not conform to the style guidelines will fail CI checks.
+
+### Backend Code
+
+Backend code (Python) is checked against the [PEP style guidelines](https://peps.python.org/pep-0008/). Please write docstrings for each function and class - we follow the [google doc-style](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) for python.
+
+### Frontend Code
+
+Frontend code (Javascript) is checked using [eslint](https://eslint.org/). While docstrings are not enforced for front-end code, good code documentation is encouraged!
+
+### Running Checks Locally
+
+If you have followed the setup devtools procedure, then code style checking is performend automatically whenever you commit changes to the code.
+
+### Django templates
+
+Django are checked by [djlint](https://github.com/Riverside-Healthcare/djlint) through pre-commit.
+
+The following rules out of the [default set](https://djlint.com/docs/linter/) are not applied:
+```bash
+D018: (Django) Internal links should use the { % url ... % } pattern
+H006: Img tag should have height and width attributes
+H008: Attributes should be double quoted
+H021: Inline styles should be avoided
+H023: Do not use entity references
+H025: Tag seems to be an orphan
+H030: Consider adding a meta description
+H031: Consider adding meta keywords
+T002: Double quotes should be used in tags
+```
+
 
 ## Documentation
 
-New features or updates to existing features should be accompanied by user documentation. A PR with associated documentation should link to the matching PR at https://github.com/inventree/inventree-docs/
+New features or updates to existing features should be accompanied by user documentation.
 
 ## Translations
 
@@ -157,16 +205,19 @@ user_facing_string = _('This string will be exposed to the translation engine!')
 HTML and javascript files are passed through the django templating engine. Translatable strings are implemented as follows:
 
 ```html
-{% load i18n %}
+{ % load i18n % }
 
-<span>{% trans "This string will be translated" %} - this string will not!</span>
+<span>{ % trans "This string will be translated" % } - this string will not!</span>
 ```
 
 ## Github use
+
 ### Tags
+
 The tags describe issues and PRs in multiple areas:
+
 | Area | Name | Description |
-|---|---|---|
+| --- | --- | --- |
 | Triage Labels |  |  |
 |  | triage:not-checked | Item was not checked by the core team  |
 |  | triage:not-approved | Item is not green-light by maintainer |
@@ -175,10 +226,13 @@ The tags describe issues and PRs in multiple areas:
 |  | bug | Identifies a bug which needs to be addressed |
 |  | dependency | Relates to a project dependency |
 |  | duplicate | Duplicate of another issue or PR |
-|  | enhancement | This is an suggested enhancement or new feature |
+|  | enhancement | This is an suggested enhancement, extending the functionality of an existing feature |
+|  | experimental | This is a new *experimental* feature which needs to be enabled manually |
+|  | feature | This is a new feature, introducing novel functionality |
 |  | help wanted | Assistance required |
 |  | invalid | This issue or PR is considered invalid |
 |  | inactive | Indicates lack of activity |
+|  | migration | Database migration, requires special attention |
 |  | question | This is a question |
 |  | roadmap | This is a roadmap feature with no immediate plans for implementation |
 |  | security | Relates to a security issue |
@@ -197,7 +251,9 @@ The tags describe issues and PRs in multiple areas:
 |  | stock | Stock item management |
 |  | user interface | User interface |
 | Ecosystem Labels |  |  |
+|  | backport | Tags that the issue will be backported to a stable branch as a bug-fix |
 |  | demo | Relates to the InvenTree demo server or dataset |
 |  | docker | Docker / docker-compose |
 |  | CI | CI / unit testing ecosystem |
+|  | refactor | Refactoring existing code |
 |  | setup | Relates to the InvenTree setup / installation process |

Dockerfile

@@ -9,7 +9,8 @@
 # - Runs InvenTree web server under django development server
 # - Monitors source files for any changes, and live-reloads server
 
-FROM python:3.9-slim as inventree_base
+ARG base_image=python:3.10-alpine3.18
+FROM ${base_image} as inventree_base
 
 # Build arguments for this image
 ARG commit_hash=""
@@ -17,6 +18,8 @@ ARG commit_date=""
 ARG commit_tag=""
 
 ENV PYTHONUNBUFFERED 1
+ENV PIP_DISABLE_PIP_VERSION_CHECK 1
+ENV INVOKE_RUN_SHELL="/bin/ash"
 
 ENV INVENTREE_LOG_LEVEL="WARNING"
 ENV INVENTREE_DOCKER="true"
@@ -51,44 +54,64 @@ LABEL org.label-schema.schema-version="1.0" \
       org.label-schema.vcs-url="https://github.com/inventree/InvenTree.git" \
       org.label-schema.vcs-ref=${commit_tag}
 
-# RUN apt-get upgrade && apt-get update
-RUN apt-get update
-
-# Install required system packages
-RUN apt-get install -y  --no-install-recommends \
-    git gcc g++ gettext gnupg libffi-dev libssl-dev \
-    # Weasyprint requirements : https://doc.courtbouillon.org/weasyprint/stable/first_steps.html#debian-11
-    poppler-utils libpango-1.0-0 libpangoft2-1.0-0 \
+# Install required system level packages
+RUN apk add --no-cache \
+    git gettext py-cryptography \
     # Image format support
-    libjpeg-dev webp libwebp-dev \
+    libjpeg libwebp zlib \
+    # Weasyprint requirements : https://doc.courtbouillon.org/weasyprint/stable/first_steps.html#alpine-3-12
+    py3-pip py3-pillow py3-cffi py3-brotli pango poppler-utils openldap \
     # SQLite support
-    sqlite3 \
+    sqlite \
     # PostgreSQL support
-    libpq-dev postgresql-client \
+    postgresql-libs postgresql-client \
     # MySQL / MariaDB support
-    default-libmysqlclient-dev mariadb-client && \
-    apt-get autoclean && apt-get autoremove
+    mariadb-connector-c-dev mariadb-client && \
+    # fonts
+    apk --update --upgrade --no-cache add fontconfig ttf-freefont font-noto terminus-font && fc-cache -f
 
-# Update pip
-RUN pip install --upgrade pip
+EXPOSE 8000
 
-# For ARMv7 architecture, add the pinwheels repo (for cryptography library)
+RUN mkdir -p ${INVENTREE_HOME}
+WORKDIR ${INVENTREE_HOME}
+
+COPY ./docker/requirements.txt base_requirements.txt
+COPY ./requirements.txt ./
+COPY ./docker/install_build_packages.sh .
+RUN chmod +x install_build_packages.sh
+
+# For ARMv7 architecture, add the piwheels repo (for cryptography library)
 # Otherwise, we have to build from source, which is difficult
 # Ref: https://github.com/inventree/InvenTree/pull/4598
-RUN \
-   if [ `dpkg --print-architecture` = "armhf" ]; then \
-   printf "[global]\nextra-index-url=https://www.piwheels.org/simple\n" > /etc/pip.conf ; \
-   fi
+RUN if [ `apk --print-arch` = "armv7" ]; then \
+    printf "[global]\nextra-index-url=https://www.piwheels.org/simple\n" > /etc/pip.conf ; \
+    fi
 
-# Install required base-level python packages
-COPY ./docker/requirements.txt base_requirements.txt
-RUN pip install --disable-pip-version-check -U -r base_requirements.txt
+COPY tasks.py docker/gunicorn.conf.py docker/init.sh ./
+RUN chmod +x init.sh
+
+ENTRYPOINT ["/bin/sh", "./init.sh"]
+
+FROM inventree_base as prebuild
+
+ENV PATH=/root/.local/bin:$PATH
+RUN ./install_build_packages.sh --no-cache --virtual .build-deps && \
+    pip install --user -r base_requirements.txt -r requirements.txt --no-cache-dir && \
+    apk --purge del .build-deps
+
+# Frontend builder image:
+FROM prebuild as frontend
+
+RUN apk add --no-cache --update nodejs npm && npm install -g yarn
+RUN yarn config set network-timeout 600000 -g
+COPY InvenTree ${INVENTREE_HOME}/InvenTree
+COPY src ${INVENTREE_HOME}/src
+COPY tasks.py ${INVENTREE_HOME}/tasks.py
+RUN cd ${INVENTREE_HOME}/InvenTree && inv frontend-compile
 
 # InvenTree production image:
 # - Copies required files from local directory
-# - Installs required python packages from requirements.txt
 # - Starts a gunicorn webserver
-
 FROM inventree_base as production
 
 ENV INVENTREE_DEBUG=False
@@ -97,28 +120,13 @@ ENV INVENTREE_DEBUG=False
 ENV INVENTREE_COMMIT_HASH="${commit_hash}"
 ENV INVENTREE_COMMIT_DATE="${commit_date}"
 
+# use dependencies and compiled wheels from the prebuild image
+ENV PATH=/root/.local/bin:$PATH
+COPY --from=prebuild /root/.local /root/.local
+
 # Copy source code
-COPY InvenTree ${INVENTREE_HOME}/InvenTree
-
-# Copy other key files
-COPY requirements.txt ${INVENTREE_HOME}/requirements.txt
-COPY tasks.py ${INVENTREE_HOME}/tasks.py
-COPY docker/gunicorn.conf.py ${INVENTREE_HOME}/gunicorn.conf.py
-COPY docker/init.sh ${INVENTREE_MNG_DIR}/init.sh
-
-# Need to be running from within this directory
-WORKDIR ${INVENTREE_MNG_DIR}
-
-# Drop to the inventree user for the production image
-#RUN adduser inventree
-#RUN chown -R inventree:inventree ${INVENTREE_HOME}
-#USER inventree
-
-# Install InvenTree packages
-RUN pip3 install --user --disable-pip-version-check -r ${INVENTREE_HOME}/requirements.txt
-
-# Server init entrypoint
-ENTRYPOINT ["/bin/bash", "./init.sh"]
+COPY InvenTree ./InvenTree
+COPY --from=frontend ${INVENTREE_HOME}/InvenTree/web/static/web ./InvenTree/web/static/web
 
 # Launch the production server
 # TODO: Work out why environment variables cannot be interpolated in this command
@@ -127,6 +135,19 @@ CMD gunicorn -c ./gunicorn.conf.py InvenTree.wsgi -b 0.0.0.0:8000 --chdir ./Inve
 
 FROM inventree_base as dev
 
+# Vite server (for local frontend development)
+EXPOSE 5173
+
+# Install packages required for building python packages
+RUN ./install_build_packages.sh
+
+RUN pip install -r base_requirements.txt --no-cache-dir
+
+# Install nodejs / npm / yarn
+
+RUN apk add --no-cache --update nodejs npm && npm install -g yarn
+RUN yarn config set network-timeout 600000 -g
+
 # The development image requires the source code to be mounted to /home/inventree/
 # So from here, we don't actually "do" anything, apart from some file management
 
@@ -139,7 +160,14 @@ ENV INVENTREE_PY_ENV="${INVENTREE_DATA_DIR}/env"
 WORKDIR ${INVENTREE_HOME}
 
 # Entrypoint ensures that we are running in the python virtual environment
-ENTRYPOINT ["/bin/bash", "./docker/init.sh"]
+ENTRYPOINT ["/bin/ash", "./docker/init.sh"]
 
 # Launch the development server
 CMD ["invoke", "server", "-a", "${INVENTREE_WEB_ADDR}:${INVENTREE_WEB_PORT}"]
+
+# Image target for devcontainer
+FROM dev as devcontainer
+
+ARG workspace="/workspaces/InvenTree"
+
+WORKDIR ${WORKSPACE}

InvenTree/InvenTree/admin.py

@@ -1,5 +1,12 @@
 """Admin classes"""
 
+from django.contrib import admin
+from django.db.models.fields import CharField
+from django.http.request import HttpRequest
+
+from djmoney.contrib.exchange.admin import RateAdmin
+from djmoney.contrib.exchange.models import Rate
+from import_export.exceptions import ImportExportError
 from import_export.resources import ModelResource
 
 
@@ -10,8 +17,41 @@ class InvenTreeResource(ModelResource):
     Ref: https://owasp.org/www-community/attacks/CSV_Injection
     """
 
+    MAX_IMPORT_ROWS = 1000
+    MAX_IMPORT_COLS = 100
+
+    # List of fields which should be converted to empty strings if they are null
+    CONVERT_NULL_FIELDS = []
+
+    def import_data_inner(
+        self,
+        dataset,
+        dry_run,
+        raise_errors,
+        using_transactions,
+        collect_failed_rows,
+        rollback_on_validation_errors=None,
+        **kwargs
+    ):
+        """Override the default import_data_inner function to provide better error handling"""
+        if len(dataset) > self.MAX_IMPORT_ROWS:
+            raise ImportExportError(f"Dataset contains too many rows (max {self.MAX_IMPORT_ROWS})")
+
+        if len(dataset.headers) > self.MAX_IMPORT_COLS:
+            raise ImportExportError(f"Dataset contains too many columns (max {self.MAX_IMPORT_COLS})")
+
+        return super().import_data_inner(
+            dataset,
+            dry_run,
+            raise_errors,
+            using_transactions,
+            collect_failed_rows,
+            rollback_on_validation_errors=rollback_on_validation_errors,
+            **kwargs
+        )
+
     def export_resource(self, obj):
-        """Custom function to override default row export behaviour.
+        """Custom function to override default row export behavior.
 
         Specifically, strip illegal leading characters to prevent formula injection
         """
@@ -31,3 +71,42 @@ class InvenTreeResource(ModelResource):
                 row[idx] = val
 
         return row
+
+    def get_fields(self, **kwargs):
+        """Return fields, with some common exclusions"""
+        fields = super().get_fields(**kwargs)
+
+        fields_to_exclude = [
+            'metadata',
+            'lft', 'rght', 'tree_id', 'level',
+        ]
+
+        return [f for f in fields if f.column_name not in fields_to_exclude]
+
+    def before_import_row(self, row, row_number=None, **kwargs):
+        """Run custom code before importing each row.
+
+        - Convert any null fields to empty strings, for fields which do not support null values
+        """
+        # We can automatically determine which fields might need such a conversion
+        for field in self.Meta.model._meta.fields:
+            if isinstance(field, CharField):
+                if field.blank and not field.null:
+                    if field.name not in self.CONVERT_NULL_FIELDS:
+                        self.CONVERT_NULL_FIELDS.append(field.name)
+
+        for field in self.CONVERT_NULL_FIELDS:
+            if field in row and row[field] is None:
+                row[field] = ''
+
+
+class CustomRateAdmin(RateAdmin):
+    """Admin interface for the Rate class"""
+
+    def has_add_permission(self, request: HttpRequest) -> bool:
+        """Disable the 'add' permission for Rate objects"""
+        return False
+
+
+admin.site.unregister(Rate)
+admin.site.register(Rate, CustomRateAdmin)

InvenTree/InvenTree/api.py

@@ -6,25 +6,87 @@ from django.http import JsonResponse
 from django.utils.translation import gettext_lazy as _
 
 from django_q.models import OrmQ
-from rest_framework import permissions
+from drf_spectacular.utils import OpenApiResponse, extend_schema
+from rest_framework import permissions, serializers
 from rest_framework.response import Response
 from rest_framework.serializers import ValidationError
 from rest_framework.views import APIView
 
+import InvenTree.version
 import users.models
 from InvenTree.filters import SEARCH_ORDER_FILTER
 from InvenTree.mixins import ListCreateAPI
 from InvenTree.permissions import RolePermission
 from part.templatetags.inventree_extras import plugins_info
 from plugin.serializers import MetadataSerializer
+from users.models import ApiToken
 
-from .mixins import RetrieveUpdateAPI
-from .status import is_worker_running
-from .version import (inventreeApiVersion, inventreeInstanceName,
-                      inventreeVersion)
+from .email import is_email_configured
+from .mixins import ListAPI, RetrieveUpdateAPI
+from .status import check_system_health, is_worker_running
+from .version import inventreeApiText
 from .views import AjaxView
 
 
+class VersionView(APIView):
+    """Simple JSON endpoint for InvenTree version information."""
+
+    permission_classes = [
+        permissions.IsAdminUser,
+    ]
+
+    def get(self, request, *args, **kwargs):
+        """Return information about the InvenTree server."""
+        return JsonResponse({
+            'dev': InvenTree.version.isInvenTreeDevelopmentVersion(),
+            'up_to_date': InvenTree.version.isInvenTreeUpToDate(),
+            'version': {
+                'server': InvenTree.version.inventreeVersion(),
+                'api': InvenTree.version.inventreeApiVersion(),
+                'commit_hash': InvenTree.version.inventreeCommitHash(),
+                'commit_date': InvenTree.version.inventreeCommitDate(),
+                'commit_branch': InvenTree.version.inventreeBranch(),
+                'python': InvenTree.version.inventreePythonVersion(),
+                'django': InvenTree.version.inventreeDjangoVersion()
+            },
+            'links': {
+                'doc': InvenTree.version.inventreeDocUrl(),
+                'code': InvenTree.version.inventreeGithubUrl(),
+                'credit': InvenTree.version.inventreeCreditsUrl(),
+                'app': InvenTree.version.inventreeAppUrl(),
+                'bug': f'{InvenTree.version.inventreeGithubUrl()}/issues'
+            }
+        })
+
+
+class VersionSerializer(serializers.Serializer):
+    """Serializer for a single version."""
+    version = serializers.CharField()
+    date = serializers.CharField()
+    gh = serializers.CharField()
+    text = serializers.CharField()
+    latest = serializers.BooleanField()
+
+    class Meta:
+        """Meta class for VersionSerializer."""
+        fields = ['version', 'date', 'gh', 'text', 'latest']
+
+
+class VersionApiSerializer(serializers.Serializer):
+    """Serializer for the version api endpoint."""
+    VersionSerializer(many=True)
+
+
+class VersionTextView(ListAPI):
+    """Simple JSON endpoint for InvenTree version text."""
+    permission_classes = [permissions.IsAdminUser]
+
+    @extend_schema(responses={200: OpenApiResponse(response=VersionApiSerializer)})
+    def list(self, request, *args, **kwargs):
+        """Return information about the InvenTree server."""
+        return JsonResponse(inventreeApiText())
+
+
 class InfoView(AjaxView):
     """Simple JSON endpoint for InvenTree information.
 
@@ -35,38 +97,95 @@ class InfoView(AjaxView):
 
     def worker_pending_tasks(self):
         """Return the current number of outstanding background tasks"""
-
         return OrmQ.objects.count()
 
     def get(self, request, *args, **kwargs):
         """Serve current server information."""
+        is_staff = request.user.is_staff
+        if not is_staff and request.user.is_anonymous:
+            # Might be Token auth - check if so
+            is_staff = self.check_auth_header(request)
+
         data = {
             'server': 'InvenTree',
-            'version': inventreeVersion(),
-            'instance': inventreeInstanceName(),
-            'apiVersion': inventreeApiVersion(),
+            'version': InvenTree.version.inventreeVersion(),
+            'instance': InvenTree.version.inventreeInstanceName(),
+            'apiVersion': InvenTree.version.inventreeApiVersion(),
             'worker_running': is_worker_running(),
             'worker_pending_tasks': self.worker_pending_tasks(),
             'plugins_enabled': settings.PLUGINS_ENABLED,
             'active_plugins': plugins_info(),
+            'email_configured': is_email_configured(),
+            'debug_mode': settings.DEBUG,
+            'docker_mode': settings.DOCKER,
+            'system_health': check_system_health() if is_staff else None,
+            'database': InvenTree.version.inventreeDatabase()if is_staff else None,
+            'platform': InvenTree.version.inventreePlatform() if is_staff else None,
+            'installer': InvenTree.version.inventreeInstaller() if is_staff else None,
+            'target': InvenTree.version.inventreeTarget()if is_staff else None,
         }
 
         return JsonResponse(data)
 
+    def check_auth_header(self, request):
+        """Check if user is authenticated via a token in the header."""
+        # TODO @matmair: remove after refacgtor of Token check is done
+        headers = request.headers.get('Authorization', request.headers.get('authorization'))
+        if not headers:
+            return False
+
+        auth = headers.strip()
+        if not (auth.lower().startswith('token') and len(auth.split()) == 2):
+            return False
+
+        token_key = auth.split()[1]
+        try:
+            token = ApiToken.objects.get(key=token_key)
+            if token.active and token.user and token.user.is_staff:
+                return True
+        except ApiToken.DoesNotExist:
+            pass
+        return False
+
 
 class NotFoundView(AjaxView):
     """Simple JSON view when accessing an invalid API view."""
 
     permission_classes = [permissions.AllowAny]
 
-    def get(self, request, *args, **kwargs):
-        """Proces an `not found` event on the API."""
-        data = {
-            'details': _('API endpoint not found'),
-            'url': request.build_absolute_uri(),
-        }
+    def not_found(self, request):
+        """Return a 404 error"""
+        return JsonResponse(
+            {
+                'detail': _('API endpoint not found'),
+                'url': request.build_absolute_uri(),
+            },
+            status=404
+        )
 
-        return JsonResponse(data, status=404)
+    def options(self, request, *args, **kwargs):
+        """Return 404"""
+        return self.not_found(request)
+
+    def get(self, request, *args, **kwargs):
+        """Return 404"""
+        return self.not_found(request)
+
+    def post(self, request, *args, **kwargs):
+        """Return 404"""
+        return self.not_found(request)
+
+    def patch(self, request, *args, **kwargs):
+        """Return 404"""
+        return self.not_found(request)
+
+    def put(self, request, *args, **kwargs):
+        """Return 404"""
+        return self.not_found(request)
+
+    def delete(self, request, *args, **kwargs):
+        """Return 404"""
+        return self.not_found(request)
 
 
 class BulkDeleteMixin:
@@ -183,10 +302,8 @@ class APIDownloadMixin:
         if export_format and export_format in ['csv', 'tsv', 'xls', 'xlsx']:
             queryset = self.filter_queryset(self.get_queryset())
             return self.download_queryset(queryset, export_format)
-
-        else:
-            # Default to the parent class implementation
-            return super().get(request, *args, **kwargs)
+        # Default to the parent class implementation
+        return super().get(request, *args, **kwargs)
 
     def download_queryset(self, queryset, export_format):
         """This function must be implemented to provide a downloadFile request."""
@@ -203,6 +320,12 @@ class AttachmentMixin:
 
     filter_backends = SEARCH_ORDER_FILTER
 
+    search_fields = [
+        'attachment',
+        'comment',
+        'link',
+    ]
+
     def perform_create(self, serializer):
         """Save the user information when a file is uploaded."""
         attachment = serializer.save()
@@ -225,7 +348,6 @@ class APISearchView(APIView):
 
     def get_result_types(self):
         """Construct a list of search types we can return"""
-
         import build.api
         import company.api
         import order.api
@@ -248,7 +370,6 @@ class APISearchView(APIView):
 
     def post(self, request, *args, **kwargs):
         """Perform search query against available models"""
-
         data = request.data
 
         results = {}
@@ -262,6 +383,11 @@ class APISearchView(APIView):
             'offset': 0,
         }
 
+        if 'search' not in data:
+            raise ValidationError({
+                'search': 'Search term must be provided',
+            })
+
         for key, cls in self.get_result_types().items():
             # Only return results which are specifically requested
             if key in data:
@@ -306,47 +432,6 @@ class APISearchView(APIView):
         return Response(results)
 
 
-class StatusView(APIView):
-    """Generic API endpoint for discovering information on 'status codes' for a particular model.
-
-    This class should be implemented as a subclass for each type of status.
-    For example, the API endpoint /stock/status/ will have information about
-    all available 'StockStatus' codes
-    """
-
-    permission_classes = [
-        permissions.IsAuthenticated,
-    ]
-
-    # Override status_class for implementing subclass
-    MODEL_REF = 'statusmodel'
-
-    def get_status_model(self, *args, **kwargs):
-        """Return the StatusCode moedl based on extra parameters passed to the view"""
-
-        status_model = self.kwargs.get(self.MODEL_REF, None)
-
-        if status_model is None:
-            raise ValidationError(f"StatusView view called without '{self.MODEL_REF}' parameter")
-
-        return status_model
-
-    def get(self, request, *args, **kwargs):
-        """Perform a GET request to learn information about status codes"""
-
-        status_class = self.get_status_model()
-
-        if not status_class:
-            raise NotImplementedError("status_class not defined for this endpoint")
-
-        data = {
-            'class': status_class.__name__,
-            'values': status_class.dict(),
-        }
-
-        return Response(data)
-
-
 class MetadataView(RetrieveUpdateAPI):
     """Generic API endpoint for reading and editing metadata for a model"""
 

InvenTree/InvenTree/api_version.py

@@ -2,10 +2,188 @@
 
 
 # InvenTree API version
-INVENTREE_API_VERSION = 107
+INVENTREE_API_VERSION = 160
+"""Increment this API version number whenever there is a significant change to the API that any clients need to know about."""
 
-"""
-Increment this API version number whenever there is a significant change to the API that any clients need to know about
+INVENTREE_API_TEXT = """
+
+v160 -> 2023-012-11 : https://github.com/inventree/InvenTree/pull/6072
+    - Adds API endpoint for allocating stock items against a sales order via barcode scan
+
+v159 -> 2023-12-08 : https://github.com/inventree/InvenTree/pull/6056
+    - Adds API endpoint for reloading plugin registry
+
+v158 -> 2023-11-21 : https://github.com/inventree/InvenTree/pull/5953
+    - Adds API endpoint for listing all settings of a particular plugin
+    - Adds API endpoint for registry status (errors)
+
+v157 -> 2023-12-02 : https://github.com/inventree/InvenTree/pull/6021
+    - Add write-only "existing_image" field to Part API serializer
+
+v156 -> 2023-11-26 : https://github.com/inventree/InvenTree/pull/5982
+    - Add POST endpoint for report and label creation
+
+v155 -> 2023-11-24 : https://github.com/inventree/InvenTree/pull/5979
+    - Add "creation_date" field to Part instance serializer
+
+v154 -> 2023-11-21 : https://github.com/inventree/InvenTree/pull/5944
+    - Adds "responsible" field to the ProjectCode table
+
+v153 -> 2023-11-21 : https://github.com/inventree/InvenTree/pull/5956
+    - Adds override_min and override_max fields to part pricing API
+
+v152 -> 2023-11-20 : https://github.com/inventree/InvenTree/pull/5949
+    - Adds barcode support for manufacturerpart model
+    - Adds API endpoint for adding parts to purchase order using barcode scan
+
+v151 -> 2023-11-13 : https://github.com/inventree/InvenTree/pull/5906
+    - Allow user list API to be filtered by user active status
+    - Allow owner list API to be filtered by user active status
+
+v150 -> 2023-11-07: https://github.com/inventree/InvenTree/pull/5875
+    - Extended user API endpoints to enable ordering
+    - Extended user API endpoints to enable user role changes
+    - Added endpoint to create a new user
+
+v149 -> 2023-11-07 : https://github.com/inventree/InvenTree/pull/5876
+    - Add 'building' quantity to BomItem serializer
+    - Add extra ordering options for the BomItem list API
+
+v148 -> 2023-11-06 : https://github.com/inventree/InvenTree/pull/5872
+    - Allow "quantity" to be specified when installing an item into another item
+
+v147 -> 2023-11-04: https://github.com/inventree/InvenTree/pull/5860
+    - Adds "completed_lines" field to SalesOrder API endpoint
+    - Adds "completed_lines" field to PurchaseOrder API endpoint
+
+v146 -> 2023-11-02: https://github.com/inventree/InvenTree/pull/5822
+    - Extended SSO Provider endpoint to contain if a provider is configured
+    - Adds API endpoints for Email Address model
+
+v145 -> 2023-10-30: https://github.com/inventree/InvenTree/pull/5786
+    - Allow printing labels via POST including printing options in the body
+
+v144 -> 2023-10-23: https://github.com/inventree/InvenTree/pull/5811
+    - Adds version information API endpoint
+
+v143 -> 2023-10-29: https://github.com/inventree/InvenTree/pull/5810
+    - Extends the status endpoint to include information about system status and health
+
+v142 -> 2023-10-20: https://github.com/inventree/InvenTree/pull/5759
+    - Adds generic API endpoints for looking up status models
+
+v141 -> 2023-10-23 : https://github.com/inventree/InvenTree/pull/5774
+    - Changed 'part.responsible' from User to Owner
+
+v140 -> 2023-10-20 : https://github.com/inventree/InvenTree/pull/5664
+    - Expand API token functionality
+    - Multiple API tokens can be generated per user
+
+v139 -> 2023-10-11 : https://github.com/inventree/InvenTree/pull/5509
+    - Add new BarcodePOReceive endpoint to receive line items by scanning supplier barcodes
+
+v138 -> 2023-10-11 : https://github.com/inventree/InvenTree/pull/5679
+    - Settings keys are no longer case sensitive
+    - Include settings units in API serializer
+
+v137 -> 2023-10-04 : https://github.com/inventree/InvenTree/pull/5588
+    - Adds StockLocationType API endpoints
+    - Adds custom_icon, location_type to StockLocation endpoint
+
+v136 -> 2023-09-23 : https://github.com/inventree/InvenTree/pull/5595
+    - Adds structural to StockLocation and PartCategory tree endpoints
+
+v135 -> 2023-09-19 : https://github.com/inventree/InvenTree/pull/5569
+    - Adds location path detail to StockLocation and StockItem API endpoints
+    - Adds category path detail to PartCategory and Part API endpoints
+
+v134 -> 2023-09-11 : https://github.com/inventree/InvenTree/pull/5525
+    - Allow "Attachment" list endpoints to be searched by attachment, link and comment fields
+
+v133 -> 2023-09-08 : https://github.com/inventree/InvenTree/pull/5518
+    - Add extra optional fields which can be used for StockAdjustment endpoints
+
+v132 -> 2023-09-07 : https://github.com/inventree/InvenTree/pull/5515
+    - Add 'issued_by' filter to BuildOrder API list endpoint
+
+v131 -> 2023-08-09 : https://github.com/inventree/InvenTree/pull/5415
+    - Annotate 'available_variant_stock' to the SalesOrderLine serializer
+
+v130 -> 2023-07-14 : https://github.com/inventree/InvenTree/pull/5251
+    - Refactor label printing interface
+
+v129 -> 2023-07-06 : https://github.com/inventree/InvenTree/pull/5189
+    - Changes 'serial_lte' and 'serial_gte' stock filters to point to 'serial_int' field
+
+v128 -> 2023-07-06 : https://github.com/inventree/InvenTree/pull/5186
+    - Adds 'available' filter for BuildLine API endpoint
+
+v127 -> 2023-06-24 : https://github.com/inventree/InvenTree/pull/5094
+    - Enhancements for the PartParameter API endpoints
+
+v126 -> 2023-06-19 : https://github.com/inventree/InvenTree/pull/5075
+    - Adds API endpoint for setting the "category" for multiple parts simultaneously
+
+v125 -> 2023-06-17 : https://github.com/inventree/InvenTree/pull/5064
+    - Adds API endpoint for setting the "status" field for multiple stock items simultaneously
+
+v124 -> 2023-06-17 : https://github.com/inventree/InvenTree/pull/5057
+    - Add "created_before" and "created_after" filters to the Part API
+
+v123 -> 2023-06-15 : https://github.com/inventree/InvenTree/pull/5019
+    - Add Metadata to: Plugin Config
+
+v122 -> 2023-06-14 : https://github.com/inventree/InvenTree/pull/5034
+    - Adds new BuildLineLabel label type
+
+v121 -> 2023-06-14 : https://github.com/inventree/InvenTree/pull/4808
+    - Adds "ProjectCode" link to Build model
+
+v120 -> 2023-06-07 : https://github.com/inventree/InvenTree/pull/4855
+    - Major overhaul of the build order API
+    - Adds new BuildLine model
+
+v119 -> 2023-06-01 : https://github.com/inventree/InvenTree/pull/4898
+    - Add Metadata to:  Part test templates, Part parameters, Part category parameter templates, BOM item substitute, Related Parts, Stock item test result
+
+v118 -> 2023-06-01 : https://github.com/inventree/InvenTree/pull/4935
+    - Adds extra fields for the PartParameterTemplate model
+
+v117 -> 2023-05-22 : https://github.com/inventree/InvenTree/pull/4854
+    - Part.units model now supports physical units (e.g. "kg", "m", "mm", etc)
+    - Replaces SupplierPart "pack_size" field with "pack_quantity"
+    - New field supports physical units, and allows for conversion between compatible units
+
+v116 -> 2023-05-18 : https://github.com/inventree/InvenTree/pull/4823
+    - Updates to part parameter implementation, to use physical units
+
+v115 -> 2023-05-18 : https://github.com/inventree/InvenTree/pull/4846
+    - Adds ability to partially scrap a build output
+
+v114 -> 2023-05-16 : https://github.com/inventree/InvenTree/pull/4825
+    - Adds "delivery_date" to shipments
+
+v113 -> 2023-05-13 : https://github.com/inventree/InvenTree/pull/4800
+    - Adds API endpoints for scrapping a build output
+
+v112 -> 2023-05-13: https://github.com/inventree/InvenTree/pull/4741
+    - Adds flag use_pack_size to the stock addition API, which allows adding packs
+
+v111 -> 2023-05-02 : https://github.com/inventree/InvenTree/pull/4367
+    - Adds tags to the Part serializer
+    - Adds tags to the SupplierPart serializer
+    - Adds tags to the ManufacturerPart serializer
+    - Adds tags to the StockItem serializer
+    - Adds tags to the StockLocation serializer
+
+v110 -> 2023-04-26 : https://github.com/inventree/InvenTree/pull/4698
+    - Adds 'order_currency' field for PurchaseOrder / SalesOrder endpoints
+
+v109 -> 2023-04-19 : https://github.com/inventree/InvenTree/pull/4636
+    - Adds API endpoints for the "ProjectCode" model
+
+v108 -> 2023-04-17 : https://github.com/inventree/InvenTree/pull/4615
+    - Adds functionality to upload images for rendering in markdown notes
 
 v107 -> 2023-04-04 : https://github.com/inventree/InvenTree/pull/4575
     - Adds barcode support for PurchaseOrder model
@@ -69,7 +247,7 @@ v90 -> 2023-01-25 : https://github.com/inventree/InvenTree/pull/4186/files
 
 v89 -> 2023-01-25 : https://github.com/inventree/InvenTree/pull/4214
     - Adds updated field to SupplierPart API
-    - Adds API date orddering for supplier part list
+    - Adds API date ordering for supplier part list
 
 v88 -> 2023-01-17: https://github.com/inventree/InvenTree/pull/4225
     - Adds 'priority' field to Build model and api endpoints
@@ -167,7 +345,7 @@ v64 -> 2022-07-08 : https://github.com/inventree/InvenTree/pull/3310
     - Allow BOM List API endpoint to be filtered by "on_order" parameter
 
 v63 -> 2022-07-06 : https://github.com/inventree/InvenTree/pull/3301
-    - Allow BOM List API endpoint to be filtered by "available_stock" paramater
+    - Allow BOM List API endpoint to be filtered by "available_stock" parameter
 
 v62 -> 2022-07-05 : https://github.com/inventree/InvenTree/pull/3296
     - Allows search on BOM List API endpoint

InvenTree/InvenTree/apps.py

@@ -9,11 +9,12 @@ from django.conf import settings
 from django.contrib.auth import get_user_model
 from django.core.exceptions import AppRegistryNotReady
 from django.db import transaction
-from django.db.utils import IntegrityError
+from django.db.utils import IntegrityError, OperationalError
 
+import InvenTree.conversion
+import InvenTree.ready
 import InvenTree.tasks
 from InvenTree.config import get_setting
-from InvenTree.ready import canAppAccessDatabase, isInTestMode
 
 logger = logging.getLogger("inventree")
 
@@ -29,24 +30,38 @@ class InvenTreeConfig(AppConfig):
         - Checking if migrations should be run
         - Cleaning up tasks
         - Starting regular tasks
-        - Updateing exchange rates
-        - Collecting notification mehods
+        - Updating exchange rates
+        - Collecting notification methods
+        - Collecting state transition methods
         - Adding users set in the current environment
         """
-        if canAppAccessDatabase() or settings.TESTING_ENV:
-            InvenTree.tasks.check_for_migrations(worker=False)
+        # skip loading if plugin registry is not loaded or we run in a background thread
+        if not InvenTree.ready.isPluginRegistryLoaded() or not InvenTree.ready.isInMainThread():
+            return
+
+        # Skip if running migrations
+        if InvenTree.ready.isRunningMigrations():
+            return
+
+        if InvenTree.ready.canAppAccessDatabase() or settings.TESTING_ENV:
 
             self.remove_obsolete_tasks()
 
             self.collect_tasks()
             self.start_background_tasks()
 
-            if not isInTestMode():  # pragma: no cover
+            if not InvenTree.ready.isInTestMode():  # pragma: no cover
                 self.update_exchange_rates()
+                # Let the background worker check for migrations
+                InvenTree.tasks.offload_task(InvenTree.tasks.check_for_migrations)
 
         self.collect_notification_methods()
+        self.collect_state_transition_methods()
 
-        if canAppAccessDatabase() or settings.TESTING_ENV:
+        # Ensure the unit registry is loaded
+        InvenTree.conversion.get_unit_registry()
+
+        if InvenTree.ready.canAppAccessDatabase() or settings.TESTING_ENV:
             self.add_user_on_startup()
 
     def remove_obsolete_tasks(self):
@@ -62,36 +77,73 @@ class InvenTreeConfig(AppConfig):
             return
 
         # Remove any existing obsolete tasks
-        Schedule.objects.filter(func__in=obsolete).delete()
+        try:
+            Schedule.objects.filter(func__in=obsolete).delete()
+        except Exception:
+            logger.exception("Failed to remove obsolete tasks - database not ready")
 
     def start_background_tasks(self):
         """Start all background tests for InvenTree."""
-
         logger.info("Starting background tasks...")
 
+        from django_q.models import Schedule
+
+        # List of existing scheduled tasks (in the database)
+        existing_tasks = {}
+
+        for existing_task in Schedule.objects.all():
+            existing_tasks[existing_task.func] = existing_task
+
+        tasks_to_create = []
+        tasks_to_update = []
+
         # List of collected tasks found with the @scheduled_task decorator
         tasks = InvenTree.tasks.tasks.task_list
 
         for task in tasks:
-            ref_name = f'{task.func.__module__}.{task.func.__name__}'
-            InvenTree.tasks.schedule_task(
-                ref_name,
-                schedule_type=task.interval,
-                minutes=task.minutes,
-            )
 
-        # Put at least one task onto the backround worker stack,
+            ref_name = f'{task.func.__module__}.{task.func.__name__}'
+
+            if ref_name in existing_tasks.keys():
+                # This task already exists - update the details if required
+                existing_task = existing_tasks[ref_name]
+
+                if existing_task.schedule_type != task.interval or existing_task.minutes != task.minutes:
+
+                    existing_task.schedule_type = task.interval
+                    existing_task.minutes = task.minutes
+                    tasks_to_update.append(existing_task)
+
+            else:
+                # This task does *not* already exist - create it
+                tasks_to_create.append(
+                    Schedule(
+                        name=ref_name,
+                        func=ref_name,
+                        schedule_type=task.interval,
+                        minutes=task.minutes,
+                    )
+                )
+
+        if len(tasks_to_create) > 0:
+            Schedule.objects.bulk_create(tasks_to_create)
+            logger.info("Created %s new scheduled tasks", len(tasks_to_create))
+
+        if len(tasks_to_update) > 0:
+            Schedule.objects.bulk_update(tasks_to_update, ['schedule_type', 'minutes'])
+            logger.info("Updated %s existing scheduled tasks", len(tasks_to_update))
+
+        # Put at least one task onto the background worker stack,
         # which will be processed as soon as the worker comes online
         InvenTree.tasks.offload_task(
             InvenTree.tasks.heartbeat,
             force_async=True,
         )
 
-        logger.info(f"Started {len(tasks)} scheduled background tasks...")
+        logger.info("Started %s scheduled background tasks...", len(tasks))
 
     def collect_tasks(self):
         """Collect all background tasks."""
-
         for app_name, app in apps.app_configs.items():
             if app_name == 'InvenTree':
                 continue
@@ -100,7 +152,7 @@ class InvenTreeConfig(AppConfig):
                 try:
                     import_module(f'{app.module.__package__}.tasks')
                 except Exception as e:  # pragma: no cover
-                    logger.error(f"Error loading tasks for {app_name}: {e}")
+                    logger.exception("Error loading tasks for %s: %s", app_name, e)
 
     def update_exchange_rates(self):  # pragma: no cover
         """Update exchange rates each time the server is started.
@@ -122,19 +174,22 @@ class InvenTreeConfig(AppConfig):
         update = False
 
         try:
-            backend = ExchangeBackend.objects.get(name='InvenTreeExchange')
+            backend = ExchangeBackend.objects.filter(name='InvenTreeExchange')
 
-            last_update = backend.last_update
+            if backend.exists():
+                backend = backend.first()
 
-            if last_update is None:
-                # Never been updated
-                logger.info("Exchange backend has never been updated")
-                update = True
+                last_update = backend.last_update
 
-            # Backend currency has changed?
-            if base_currency != backend.base_currency:
-                logger.info(f"Base currency changed from {backend.base_currency} to {base_currency}")
-                update = True
+                if last_update is None:
+                    # Never been updated
+                    logger.info("Exchange backend has never been updated")
+                    update = True
+
+                # Backend currency has changed?
+                if base_currency != backend.base_currency:
+                    logger.info("Base currency changed from %s to %s", backend.base_currency, base_currency)
+                    update = True
 
         except (ExchangeBackend.DoesNotExist):
             logger.info("Exchange backend not found - updating")
@@ -147,8 +202,10 @@ class InvenTreeConfig(AppConfig):
         if update:
             try:
                 update_exchange_rates()
+            except OperationalError:
+                logger.warning("Could not update exchange rates - database not ready")
             except Exception as e:
-                logger.error(f"Error updating exchange rates: {e}")
+                logger.exception("Error updating exchange rates: %s (%s)", e, type(e))
 
     def add_user_on_startup(self):
         """Add a user on startup."""
@@ -175,7 +232,7 @@ class InvenTreeConfig(AppConfig):
 
         # not all needed variables set
         if set_variables < 3:
-            logger.warn('Not all required settings for adding a user on startup are present:\nINVENTREE_ADMIN_USER, INVENTREE_ADMIN_EMAIL, INVENTREE_ADMIN_PASSWORD')
+            logger.warning('Not all required settings for adding a user on startup are present:\nINVENTREE_ADMIN_USER, INVENTREE_ADMIN_EMAIL, INVENTREE_ADMIN_PASSWORD')
             settings.USER_ADDED = True
             return
 
@@ -184,12 +241,12 @@ class InvenTreeConfig(AppConfig):
         try:
             with transaction.atomic():
                 if user.objects.filter(username=add_user).exists():
-                    logger.info(f"User {add_user} already exists - skipping creation")
+                    logger.info("User %s already exists - skipping creation", add_user)
                 else:
                     new_user = user.objects.create_superuser(add_user, add_email, add_password)
-                    logger.info(f'User {str(new_user)} was created!')
-        except IntegrityError as _e:
-            logger.warning(f'The user "{add_user}" could not be created due to the following error:\n{str(_e)}')
+                    logger.info('User %s was created!', str(new_user))
+        except IntegrityError:
+            logger.warning('The user "%s" could not be created', add_user)
 
         # do not try again
         settings.USER_ADDED = True
@@ -199,3 +256,9 @@ class InvenTreeConfig(AppConfig):
         from common.notifications import storage
 
         storage.collect()
+
+    def collect_state_transition_methods(self):
+        """Collect all state transition methods."""
+        from generic.states import storage
+
+        storage.collect()

InvenTree/InvenTree/ci_render_js.py

@@ -1,12 +1,12 @@
 """Pull rendered copies of the templated.
 
-Only used for testing the js files! - This file is omited from coverage.
+Only used for testing the js files! - This file is omitted from coverage.
 """
 
 import os  # pragma: no cover
 import pathlib  # pragma: no cover
 
-from InvenTree.helpers import InvenTreeTestCase  # pragma: no cover
+from InvenTree.unit_test import InvenTreeTestCase  # pragma: no cover
 
 
 class RenderJavascriptFiles(InvenTreeTestCase):  # pragma: no cover
@@ -17,7 +17,7 @@ class RenderJavascriptFiles(InvenTreeTestCase):  # pragma: no cover
     """
 
     def download_file(self, filename, prefix):
-        """Function to `download`(copy) a file to a temporay firectory."""
+        """Function to `download`(copy) a file to a temporary firectory."""
         url = os.path.join(prefix, filename)
 
         response = self.client.get(url)

InvenTree/InvenTree/config.py

@@ -7,6 +7,7 @@ import os
 import random
 import shutil
 import string
+import warnings
 from pathlib import Path
 
 logger = logging.getLogger('inventree')
@@ -23,7 +24,6 @@ def to_list(value, delimiter=','):
     However, the same setting may be specified via an environment variable,
     using a comma delimited string!
     """
-
     if type(value) in [list, tuple]:
         return value
 
@@ -45,13 +45,13 @@ def to_dict(value):
     if value is None:
         return {}
 
-    if type(value) == dict:
+    if isinstance(value, dict):
         return value
 
     try:
         return json.loads(value)
     except Exception as error:
-        logger.error(f"Failed to parse value '{value}' as JSON with error {error}. Ensure value is a valid JSON string.")
+        logger.exception("Failed to parse value '%s' as JSON with error %s. Ensure value is a valid JSON string.", value, error)
     return {}
 
 
@@ -70,7 +70,6 @@ def ensure_dir(path: Path) -> None:
 
     If it does not exist, create it.
     """
-
     if not path.exists():
         path.mkdir(parents=True, exist_ok=True)
 
@@ -128,6 +127,36 @@ def load_config_data(set_cache: bool = False) -> map:
     return data
 
 
+def do_typecast(value, type, var_name=None):
+    """Attempt to typecast a value.
+
+    Arguments:
+        value: Value to typecast
+        type: Function to use for typecasting the value e.g. int, float, str, list, dict
+        var_name: Name that should be logged e.g. 'INVENTREE_STATIC_ROOT'. Set if logging is required.
+
+    Returns:
+        Typecasted value or original value if typecasting failed.
+    """
+    # Force 'list' of strings
+    if type is list:
+        value = to_list(value)
+
+    # Valid JSON string is required
+    elif type is dict:
+        value = to_dict(value)
+
+    elif type is not None:
+        # Try to typecast the value
+        try:
+            val = type(value)
+            return val
+        except Exception as error:
+            if var_name:
+                logger.exception("Failed to typecast '%s' with value '%s' to type '%s' with error %s", var_name, value, type, error)
+    return value
+
+
 def get_setting(env_var=None, config_key=None, default_value=None, typecast=None):
     """Helper function for retrieving a configuration setting value.
 
@@ -139,30 +168,8 @@ def get_setting(env_var=None, config_key=None, default_value=None, typecast=None
         env_var: Name of the environment variable e.g. 'INVENTREE_STATIC_ROOT'
         config_key: Key to lookup in the configuration file
         default_value: Value to return if first two options are not provided
-        typecast: Function to use for typecasting the value
+        typecast: Function to use for typecasting the value e.g. int, float, str, list, dict
     """
-    def try_typecasting(value, source: str):
-        """Attempt to typecast the value"""
-
-        # Force 'list' of strings
-        if typecast is list:
-            value = to_list(value)
-
-        # Valid JSON string is required
-        elif typecast is dict:
-            value = to_dict(value)
-
-        elif typecast is not None:
-            # Try to typecast the value
-            try:
-                val = typecast(value)
-                set_metadata(source)
-                return val
-            except Exception as error:
-                logger.error(f"Failed to typecast '{env_var}' with value '{value}' to type '{typecast}' with error {error}")
-
-        set_metadata(source)
-        return value
 
     def set_metadata(source: str):
         """Set lookup metadata for the setting."""
@@ -174,7 +181,8 @@ def get_setting(env_var=None, config_key=None, default_value=None, typecast=None
         val = os.getenv(env_var, None)
 
         if val is not None:
-            return try_typecasting(val, 'env')
+            set_metadata('env')
+            return do_typecast(val, typecast, var_name=env_var)
 
     # Next, try to load from configuration file
     if config_key is not None:
@@ -193,21 +201,21 @@ def get_setting(env_var=None, config_key=None, default_value=None, typecast=None
             cfg_data = cfg_data[key]
 
         if result is not None:
-            return try_typecasting(result, 'yaml')
+            set_metadata('yaml')
+            return do_typecast(result, typecast, var_name=env_var)
 
     # Finally, return the default value
-    return try_typecasting(default_value, 'default')
+    set_metadata('default')
+    return do_typecast(default_value, typecast, var_name=env_var)
 
 
 def get_boolean_setting(env_var=None, config_key=None, default_value=False):
-    """Helper function for retreiving a boolean configuration setting"""
-
+    """Helper function for retrieving a boolean configuration setting"""
     return is_true(get_setting(env_var, config_key, default_value))
 
 
 def get_media_dir(create=True):
     """Return the absolute path for the 'media' directory (where uploaded files are stored)"""
-
     md = get_setting('INVENTREE_MEDIA_ROOT', 'media_root')
 
     if not md:
@@ -223,7 +231,6 @@ def get_media_dir(create=True):
 
 def get_static_dir(create=True):
     """Return the absolute path for the 'static' directory (where static files are stored)"""
-
     sd = get_setting('INVENTREE_STATIC_ROOT', 'static_root')
 
     if not sd:
@@ -239,7 +246,6 @@ def get_static_dir(create=True):
 
 def get_backup_dir(create=True):
     """Return the absolute path for the backup directory"""
-
     bd = get_setting('INVENTREE_BACKUP_DIR', 'backup_dir')
 
     if not bd:
@@ -258,7 +264,6 @@ def get_plugin_file():
 
     Note: It will be created if it does not already exist!
     """
-
     # Check if the plugin.txt file (specifying required plugins) is specified
     plugin_file = get_setting('INVENTREE_PLUGIN_FILE', 'plugin_file')
 
@@ -272,7 +277,7 @@ def get_plugin_file():
 
     if not plugin_file.exists():
         logger.warning("Plugin configuration file does not exist - creating default file")
-        logger.info(f"Creating plugin file at '{plugin_file}'")
+        logger.info("Creating plugin file at '%s'", plugin_file)
         ensure_dir(plugin_file.parent)
 
         # If opening the file fails (no write permission, for example), then this will throw an error
@@ -281,6 +286,11 @@ def get_plugin_file():
     return plugin_file
 
 
+def get_plugin_dir():
+    """Returns the path of the custom plugins directory"""
+    return get_setting('INVENTREE_PLUGIN_DIR', 'plugin_dir')
+
+
 def get_secret_key():
     """Return the secret key value which will be used by django.
 
@@ -291,7 +301,6 @@ def get_secret_key():
     C) Look for default key file "secret_key.txt"
     D) Create "secret_key.txt" if it does not exist
     """
-
     # Look for environment variable
     if secret_key := get_setting('INVENTREE_SECRET_KEY', 'secret_key'):
         logger.info("SECRET_KEY loaded by INVENTREE_SECRET_KEY")  # pragma: no cover
@@ -305,7 +314,7 @@ def get_secret_key():
         secret_key_file = get_base_dir().joinpath("secret_key.txt").resolve()
 
     if not secret_key_file.exists():
-        logger.info(f"Generating random key file at '{secret_key_file}'")
+        logger.info("Generating random key file at '%s'", secret_key_file)
         ensure_dir(secret_key_file.parent)
 
         # Create a random key file
@@ -313,7 +322,7 @@ def get_secret_key():
         key = ''.join([random.choice(options) for i in range(100)])
         secret_key_file.write_text(key)
 
-    logger.info(f"Loading SECRET_KEY from '{secret_key_file}'")
+    logger.debug("Loading SECRET_KEY from '%s'", secret_key_file)
 
     key_data = secret_key_file.read_text().strip()
 
@@ -336,12 +345,67 @@ def get_custom_file(env_ref: str, conf_ref: str, log_ref: str, lookup_media: boo
     static_storage = StaticFilesStorage()
 
     if static_storage.exists(value):
-        logger.info(f"Loading {log_ref} from static directory: {value}")
+        logger.info("Loading %s from %s directory: %s", log_ref, 'static', value)
     elif lookup_media and default_storage.exists(value):
-        logger.info(f"Loading {log_ref} from media directory: {value}")
+        logger.info("Loading %s from %s directory: %s", log_ref, 'media', value)
     else:
         add_dir_str = ' or media' if lookup_media else ''
-        logger.warning(f"The {log_ref} file '{value}' could not be found in the static{add_dir_str} directories")
+        logger.warning("The %s file '%s' could not be found in the static %s directories", log_ref, value, add_dir_str)
         value = False
 
     return value
+
+
+def get_frontend_settings(debug=True):
+    """Return a dictionary of settings for the frontend interface.
+
+    Note that the new config settings use the 'FRONTEND' key,
+    whereas the legacy key was 'PUI' (platform UI) which is now deprecated
+    """
+
+    # Legacy settings
+    pui_settings = get_setting('INVENTREE_PUI_SETTINGS', 'pui_settings', {}, typecast=dict)
+
+    if len(pui_settings) > 0:
+        warnings.warn(
+            "The 'INVENTREE_PUI_SETTINGS' key is deprecated. Please use 'INVENTREE_FRONTEND_SETTINGS' instead",
+            DeprecationWarning, stacklevel=2
+        )
+
+    # New settings
+    frontend_settings = get_setting('INVENTREE_FRONTEND_SETTINGS', 'frontend_settings', {}, typecast=dict)
+
+    # Merge settings
+    settings = {**pui_settings, **frontend_settings}
+
+    # Set the base URL
+    if 'base_url' not in settings:
+        base_url = get_setting('INVENTREE_PUI_URL_BASE', 'pui_url_base', '')
+
+        if base_url:
+            warnings.warn(
+                "The 'INVENTREE_PUI_URL_BASE' key is deprecated. Please use 'INVENTREE_FRONTEND_URL_BASE' instead",
+                DeprecationWarning, stacklevel=2
+            )
+        else:
+            base_url = get_setting('INVENTREE_FRONTEND_URL_BASE', 'frontend_url_base', 'platform')
+
+        settings['base_url'] = base_url
+
+    # Set the server list
+    settings['server_list'] = settings.get('server_list', [])
+
+    # Set the debug flag
+    settings['debug'] = debug
+
+    if 'environment' not in settings:
+        settings['environment'] = 'development' if debug else 'production'
+
+    if debug and 'show_server_selector' not in settings:
+        # In debug mode, show server selector by default
+        settings['show_server_selector'] = True
+    elif len(settings['server_list']) == 0:
+        # If no servers are specified, show server selector
+        settings['show_server_selector'] = True
+
+    return settings

InvenTree/InvenTree/context.py

@@ -2,11 +2,10 @@
 
 """Provides extra global data to all templates."""
 
+import InvenTree.email
 import InvenTree.status
-from InvenTree.status_codes import (BuildStatus, PurchaseOrderStatus,
-                                    ReturnOrderLineStatus, ReturnOrderStatus,
-                                    SalesOrderStatus, StockHistoryCode,
-                                    StockStatus)
+from generic.states import StatusCode
+from InvenTree.helpers import inheritors
 from users.models import RuleSet, check_user_role
 
 
@@ -28,7 +27,7 @@ def health_status(request):
 
     status = {
         'django_q_running': InvenTree.status.is_worker_running(),
-        'email_configured': InvenTree.status.is_email_configured(),
+        'email_configured': InvenTree.email.is_email_configured(),
     }
 
     # The following keys are required to denote system health
@@ -56,17 +55,7 @@ def status_codes(request):
         return {}
 
     request._inventree_status_codes = True
-
-    return {
-        # Expose the StatusCode classes to the templates
-        'ReturnOrderStatus': ReturnOrderStatus,
-        'ReturnOrderLineStatus': ReturnOrderLineStatus,
-        'SalesOrderStatus': SalesOrderStatus,
-        'PurchaseOrderStatus': PurchaseOrderStatus,
-        'BuildStatus': BuildStatus,
-        'StockStatus': StockStatus,
-        'StockHistoryCode': StockHistoryCode,
-    }
+    return {cls.__name__: cls.template_context() for cls in inheritors(StatusCode)}
 
 
 def user_roles(request):

InvenTree/InvenTree/conversion.py

@@ -0,0 +1,173 @@
+"""Helper functions for converting between units."""
+
+import logging
+
+from django.core.exceptions import ValidationError
+from django.utils.translation import gettext_lazy as _
+
+import pint
+
+_unit_registry = None
+
+
+logger = logging.getLogger('inventree')
+
+
+def get_unit_registry():
+    """Return a custom instance of the Pint UnitRegistry."""
+    global _unit_registry
+
+    # Cache the unit registry for speedier access
+    if _unit_registry is None:
+        return reload_unit_registry()
+    return _unit_registry
+
+
+def reload_unit_registry():
+    """Reload the unit registry from the database.
+
+    This function is called at startup, and whenever the database is updated.
+    """
+    import time
+    t_start = time.time()
+
+    global _unit_registry
+
+    _unit_registry = None
+
+    reg = pint.UnitRegistry()
+
+    # Define some "standard" additional units
+    reg.define('piece = 1')
+    reg.define('each = 1 = ea')
+    reg.define('dozen = 12 = dz')
+    reg.define('hundred = 100')
+    reg.define('thousand = 1000')
+
+    # Allow for custom units to be defined in the database
+    try:
+        from common.models import CustomUnit
+
+        for cu in CustomUnit.objects.all():
+            try:
+                reg.define(cu.fmt_string())
+            except Exception as e:
+                logger.exception('Failed to load custom unit: %s - %s', cu.fmt_string(), e)
+
+        # Once custom units are loaded, save registry
+        _unit_registry = reg
+
+    except Exception:
+        # Database is not ready, or CustomUnit model is not available
+        pass
+
+    dt = time.time() - t_start
+    logger.debug('Loaded unit registry in %.3f s', dt)
+
+    return reg
+
+
+def convert_physical_value(value: str, unit: str = None, strip_units=True):
+    """Validate that the provided value is a valid physical quantity.
+
+    Arguments:
+        value: Value to validate (str)
+        unit: Optional unit to convert to, and validate against
+        strip_units: If True, strip units from the returned value, and return only the dimension
+
+    Raises:
+        ValidationError: If the value is invalid or cannot be converted to the specified unit
+
+    Returns:
+        The converted quantity, in the specified units
+    """
+    original = str(value).strip()
+
+    # Ensure that the value is a string
+    value = str(value).strip() if value else ''
+    unit = str(unit).strip() if unit else ''
+
+    # Error on blank values
+    if not value:
+        raise ValidationError(_('No value provided'))
+
+    # Create a "backup" value which be tried if the first value fails
+    # e.g. value = "10k" and unit = "ohm" -> "10kohm"
+    # e.g. value = "10m" and unit = "F" -> "10mF"
+    if unit:
+        backup_value = value + unit
+    else:
+        backup_value = None
+
+    ureg = get_unit_registry()
+
+    try:
+        value = ureg.Quantity(value)
+
+        if unit:
+            if is_dimensionless(value):
+                magnitude = value.to_base_units().magnitude
+                value = ureg.Quantity(magnitude, unit)
+            else:
+                value = value.to(unit)
+
+    except Exception:
+        if backup_value:
+            try:
+                value = ureg.Quantity(backup_value)
+            except Exception:
+                value = None
+        else:
+            value = None
+
+    if value is None:
+        if unit:
+            raise ValidationError(_(f'Could not convert {original} to {unit}'))
+        else:
+            raise ValidationError(_("Invalid quantity supplied"))
+
+    # Calculate the "magnitude" of the value, as a float
+    # If the value is specified strangely (e.g. as a fraction or a dozen), this can cause issues
+    # So, we ensure that it is converted to a floating point value
+    # If we wish to return a "raw" value, some trickery is required
+    try:
+        if unit:
+            magnitude = ureg.Quantity(value.to(ureg.Unit(unit))).magnitude
+        else:
+            magnitude = ureg.Quantity(value.to_base_units()).magnitude
+
+        magnitude = float(ureg.Quantity(magnitude).to_base_units().magnitude)
+    except Exception as exc:
+        raise ValidationError(_(f'Invalid quantity supplied ({exc})'))
+
+    if strip_units:
+        return magnitude
+    elif unit or value.units:
+        return ureg.Quantity(magnitude, unit or value.units)
+    return ureg.Quantity(magnitude)
+
+
+def is_dimensionless(value):
+    """Determine if the provided value is 'dimensionless'
+
+    A dimensionless value might look like:
+
+    0.1
+    1/2 dozen
+    three thousand
+    1.2 dozen
+    (etc)
+    """
+    ureg = get_unit_registry()
+
+    # Ensure the provided value is in the right format
+    value = ureg.Quantity(value)
+
+    if value.units == ureg.dimensionless:
+        return True
+
+    if value.to_base_units().units == ureg.dimensionless:
+        return True
+
+    # At this point, the value is not dimensionless
+    return False

InvenTree/InvenTree/email.py

@@ -0,0 +1,89 @@
+"""Code for managing email functionality in InvenTree."""
+
+import logging
+
+from django.conf import settings
+from django.core import mail as django_mail
+
+import InvenTree.ready
+import InvenTree.tasks
+
+logger = logging.getLogger('inventree')
+
+
+def is_email_configured():
+    """Check if email backend is configured.
+
+    NOTE: This does not check if the configuration is valid!
+    """
+    configured = True
+    testing = settings.TESTING
+
+    if InvenTree.ready.isInTestMode():
+        return False
+
+    if InvenTree.ready.isImportingData():
+        return False
+
+    if not settings.EMAIL_HOST:
+        configured = False
+
+        # Display warning unless in test mode
+        if not testing:  # pragma: no cover
+            logger.debug("EMAIL_HOST is not configured")
+
+    # Display warning unless in test mode
+    if not settings.EMAIL_HOST_USER and not testing:  # pragma: no cover
+        logger.debug("EMAIL_HOST_USER is not configured")
+
+    # Display warning unless in test mode
+    if not settings.EMAIL_HOST_PASSWORD and testing:  # pragma: no cover
+        logger.debug("EMAIL_HOST_PASSWORD is not configured")
+
+    # Email sender must be configured
+    if not settings.DEFAULT_FROM_EMAIL:
+        configured = False
+
+        if not testing:  # pragma: no cover
+            logger.debug("DEFAULT_FROM_EMAIL is not configured")
+
+    return configured
+
+
+def send_email(subject, body, recipients, from_email=None, html_message=None):
+    """Send an email with the specified subject and body, to the specified recipients list."""
+    if isinstance(recipients, str):
+        recipients = [recipients]
+
+    import InvenTree.ready
+    import InvenTree.status
+
+    if InvenTree.ready.isImportingData():
+        # If we are importing data, don't send emails
+        return
+
+    if not InvenTree.email.is_email_configured() and not settings.TESTING:
+        # Email is not configured / enabled
+        return
+
+    # If a *from_email* is not specified, ensure that the default is set
+    if not from_email:
+        from_email = settings.DEFAULT_FROM_EMAIL
+
+        # If we still don't have a valid from_email, then we can't send emails
+        if not from_email:
+            if settings.TESTING:
+                from_email = 'from@test.com'
+            else:
+                logger.error("send_email failed: DEFAULT_FROM_EMAIL not specified")
+                return
+
+    InvenTree.tasks.offload_task(
+        django_mail.send_mail,
+        subject,
+        body,
+        from_email,
+        recipients,
+        fail_silently=False,
+        html_message=html_message
+    )

InvenTree/InvenTree/exceptions.py

@@ -9,7 +9,6 @@ import traceback
 
 from django.conf import settings
 from django.core.exceptions import ValidationError as DjangoValidationError
-from django.db.utils import IntegrityError, OperationalError
 from django.utils.translation import gettext_lazy as _
 
 import rest_framework.views as drfviews
@@ -18,37 +17,55 @@ from rest_framework import serializers
 from rest_framework.exceptions import ValidationError as DRFValidationError
 from rest_framework.response import Response
 
+import InvenTree.sentry
+
 logger = logging.getLogger('inventree')
 
 
-def log_error(path):
+def log_error(path, error_name=None, error_info=None, error_data=None):
     """Log an error to the database.
 
     - Uses python exception handling to extract error details
 
     Arguments:
         path: The 'path' (most likely a URL) associated with this error (optional)
-    """
 
+    kwargs:
+        error_name: The name of the error (optional, overrides 'kind')
+        error_info: The error information (optional, overrides 'info')
+        error_data: The error data (optional, overrides 'data')
+    """
     kind, info, data = sys.exc_info()
 
-    # Check if the eror is on the ignore list
+    # Check if the error is on the ignore list
     if kind in settings.IGNORED_ERRORS:
         return
 
+    if error_name:
+        kind = error_name
+    else:
+        kind = getattr(kind, '__name__', 'Unknown Error')
+
+    if error_info:
+        info = error_info
+
+    if error_data:
+        data = error_data
+    else:
+        data = '\n'.join(traceback.format_exception(kind, info, data))
+
     # Log error to stderr
     logger.error(info)
 
+    # Ensure the error information does not exceed field size limits
+    path = path[:200]
+    kind = kind[:128]
+
     try:
-        Error.objects.create(
-            kind=kind.__name__,
-            info=info,
-            data='\n'.join(traceback.format_exception(kind, info, data)),
-            path=path,
-        )
-    except (OperationalError, IntegrityError):
+        Error.objects.create(kind=kind, info=info or '', data=data or '', path=path)
+    except Exception:
         # Not much we can do if logging the error throws a db exception
-        pass
+        logger.exception('Failed to log exception to database')
 
 
 def exception_handler(exc, context):
@@ -61,18 +78,12 @@ def exception_handler(exc, context):
     """
     response = None
 
-    if settings.SENTRY_ENABLED and settings.SENTRY_DSN and not settings.DEBUG:
-        # Report this exception to sentry.io
-        from sentry_sdk import capture_exception
-
-        # The following types of errors are ignored, they are "expected"
-        do_not_report = [
-            DjangoValidationError,
-            DRFValidationError,
-        ]
-
-        if not any([isinstance(exc, err) for err in do_not_report]):
-            capture_exception(exc)
+    # Pass exception to sentry.io handler
+    try:
+        InvenTree.sentry.report_exception(exc)
+    except Exception:
+        # If sentry.io fails, we don't want to crash the server!
+        pass
 
     # Catch any django validation error, and re-throw a DRF validation error
     if isinstance(exc, DjangoValidationError):

InvenTree/InvenTree/exchange.py

@@ -1,74 +1,100 @@
-"""Exchangerate backend to use `exchangerate.host` to get rates."""
+"""Custom exchange backend which hooks into the InvenTree plugin system to fetch exchange rates from an external API."""
 
-import ssl
-from urllib.error import URLError
-from urllib.request import urlopen
+import logging
 
-from django.db.utils import OperationalError
+from django.db.transaction import atomic
 
-import certifi
 from djmoney.contrib.exchange.backends.base import SimpleExchangeBackend
+from djmoney.contrib.exchange.models import ExchangeBackend, Rate
 
 from common.settings import currency_code_default, currency_codes
 
+logger = logging.getLogger('inventree')
+
 
 class InvenTreeExchange(SimpleExchangeBackend):
     """Backend for automatically updating currency exchange rates.
 
-    Uses the `exchangerate.host` service API
+    Uses the plugin system to actually fetch the rates from an external API.
     """
 
     name = "InvenTreeExchange"
 
-    def __init__(self):
-        """Set API url."""
-        self.url = "https://api.exchangerate.host/latest"
-
-        super().__init__()
-
-    def get_params(self):
-        """Placeholder to set API key. Currently not required by `exchangerate.host`."""
-        # No API key is required
-        return {
-        }
-
-    def get_response(self, **kwargs):
-        """Custom code to get response from server.
-
-        Note: Adds a 5-second timeout
-        """
-        url = self.get_url(**kwargs)
-
-        try:
-            context = ssl.create_default_context(cafile=certifi.where())
-            response = urlopen(url, timeout=5, context=context)
-            return response.read()
-        except Exception:
-            # Something has gone wrong, but we can just try again next time
-            # Raise a TypeError so the outer function can handle this
-            raise TypeError
-
-    def update_rates(self, base_currency=None):
+    def get_rates(self, **kwargs) -> None:
         """Set the requested currency codes and get rates."""
-        # Set default - see B008
+        from common.models import InvenTreeSetting
+        from plugin import registry
+
+        base_currency = kwargs.get('base_currency', currency_code_default())
+        symbols = kwargs.get('symbols', currency_codes())
+
+        # Find the selected exchange rate plugin
+        slug = InvenTreeSetting.get_setting('CURRENCY_UPDATE_PLUGIN', '', create=False)
+
+        if slug:
+            plugin = registry.get_plugin(slug)
+        else:
+            plugin = None
+
+        if not plugin:
+            # Find the first active currency exchange plugin
+            plugins = registry.with_mixin('currencyexchange', active=True)
+
+            if len(plugins) > 0:
+                plugin = plugins[0]
+
+        if not plugin:
+            logger.warning('No active currency exchange plugins found - skipping update')
+            return {}
+
+        logger.info("Running exchange rate update using plugin '%s'", plugin.name)
+
+        # Plugin found - run the update task
+        try:
+            rates = plugin.update_exchange_rates(base_currency, symbols)
+        except Exception as exc:
+            logger.exception("Exchange rate update failed: %s", exc)
+            return {}
+
+        if not rates:
+            logger.warning("Exchange rate update failed - no data returned from plugin %s", slug)
+            return {}
+
+        # Update exchange rates based on returned data
+        if type(rates) is not dict:
+            logger.warning("Invalid exchange rate data returned from plugin %s (type %s)", slug, type(rates))
+            return {}
+
+        # Ensure base currency is provided
+        rates[base_currency] = 1.00
+
+        return rates
+
+    @atomic
+    def update_rates(self, base_currency=None, **kwargs):
+        """Call to update all exchange rates"""
+        backend, _ = ExchangeBackend.objects.update_or_create(name=self.name, defaults={"base_currency": base_currency})
+
         if base_currency is None:
             base_currency = currency_code_default()
 
-        symbols = ','.join(currency_codes())
+        symbols = currency_codes()
 
-        try:
-            super().update_rates(base=base_currency, symbols=symbols)
-        # catch connection errors
-        except URLError:
-            print('Encountered connection error while updating')
-        except TypeError:
-            print('Exchange returned invalid response')
-        except OperationalError as e:
-            if 'SerializationFailure' in e.__cause__.__class__.__name__:
-                print('Serialization Failure while updating exchange rates')
-                # We are just going to swallow this exception because the
-                # exchange rates will be updated later by the scheduled task
-            else:
-                # Other operational errors probably are still show stoppers
-                # so reraise them so that the log contains the stacktrace
-                raise
+        logger.info("Updating exchange rates for %s (%s currencies)", base_currency, len(symbols))
+
+        # Fetch new rates from the backend
+        # If the backend fails, the existing rates will not be updated
+        rates = self.get_rates(base_currency=base_currency, symbols=symbols)
+
+        if rates:
+            # Clear out existing rates
+            backend.clear_rates()
+
+            Rate.objects.bulk_create([
+                Rate(currency=currency, value=amount, backend=backend)
+                for currency, amount in rates.items()
+            ])
+        else:
+            logger.info("No exchange rates returned from backend - currencies not updated")
+
+        logger.info("Updated exchange rates for %s", base_currency)

InvenTree/InvenTree/fields.py

@@ -4,13 +4,14 @@ import sys
 from decimal import Decimal
 
 from django import forms
-from django.db import models as models
+from django.db import models
 from django.utils.translation import gettext_lazy as _
 
 from djmoney.forms.fields import MoneyField
 from djmoney.models.fields import MoneyField as ModelMoneyField
 from djmoney.models.validators import MinMoneyValidator
 from rest_framework.fields import URLField as RestURLField
+from rest_framework.fields import empty
 
 import InvenTree.helpers
 
@@ -18,10 +19,10 @@ from .validators import AllowedURLValidator, allowable_url_schemes
 
 
 class InvenTreeRestURLField(RestURLField):
-    """Custom field for DRF with custom scheme vaildators."""
+    """Custom field for DRF with custom scheme validators."""
+
     def __init__(self, **kwargs):
         """Update schemes."""
-
         # Enforce 'max length' parameter in form validation
         if 'max_length' not in kwargs:
             kwargs['max_length'] = 200
@@ -29,6 +30,20 @@ class InvenTreeRestURLField(RestURLField):
         super().__init__(**kwargs)
         self.validators[-1].schemes = allowable_url_schemes()
 
+    def run_validation(self, data=empty):
+        """Override default validation behaviour for this field type"""
+
+        import common.models
+
+        strict_urls = common.models.InvenTreeSetting.get_setting('INVENTREE_STRICT_URLS', True, cache=False)
+
+        if not strict_urls and data is not empty:
+            if '://' not in data:
+                # Validate as if there were a schema provided
+                data = 'http://' + data
+
+        return super().run_validation(data=data)
+
 
 class InvenTreeURLField(models.URLField):
     """Custom URL field which has custom scheme validators."""
@@ -37,19 +52,28 @@ class InvenTreeURLField(models.URLField):
 
     def __init__(self, **kwargs):
         """Initialization method for InvenTreeURLField"""
-
         # Max length for InvenTreeURLField is set to 200
         kwargs['max_length'] = 200
         super().__init__(**kwargs)
 
 
-def money_kwargs():
+def money_kwargs(**kwargs):
     """Returns the database settings for MoneyFields."""
     from common.settings import currency_code_default, currency_code_mappings
 
-    kwargs = {}
-    kwargs['currency_choices'] = currency_code_mappings()
-    kwargs['default_currency'] = currency_code_default()
+    # Default values (if not specified)
+    if 'max_digits' not in kwargs:
+        kwargs['max_digits'] = 19
+
+    if 'decimal_places' not in kwargs:
+        kwargs['decimal_places'] = 6
+
+    if 'currency_choices' not in kwargs:
+        kwargs['currency_choices'] = currency_code_mappings()
+
+    if 'default_currency' not in kwargs:
+        kwargs['default_currency'] = currency_code_default()
+
     return kwargs
 
 
@@ -63,16 +87,8 @@ class InvenTreeModelMoneyField(ModelMoneyField):
             # remove currency information for a clean migration
             kwargs['default_currency'] = ''
             kwargs['currency_choices'] = []
-        else:
-            # set defaults
-            kwargs.update(money_kwargs())
 
-        # Default values (if not specified)
-        if 'max_digits' not in kwargs:
-            kwargs['max_digits'] = 19
-
-        if 'decimal_places' not in kwargs:
-            kwargs['decimal_places'] = 6
+        kwargs = money_kwargs(**kwargs)
 
         # Set a minimum value validator
         validators = kwargs.get('validators', [])
@@ -111,13 +127,10 @@ class InvenTreeModelMoneyField(ModelMoneyField):
 
 class InvenTreeMoneyField(MoneyField):
     """Custom MoneyField for clean migrations while using dynamic currency settings."""
+
     def __init__(self, *args, **kwargs):
         """Override initial values with the real info from database."""
-        kwargs.update(money_kwargs())
-
-        kwargs['max_digits'] = 19
-        kwargs['decimal_places'] = 6
-
+        kwargs = money_kwargs(**kwargs)
         super().__init__(*args, **kwargs)
 
 
@@ -149,7 +162,6 @@ class DatePickerFormField(forms.DateField):
 
 def round_decimal(value, places, normalize=False):
     """Round value to the specified number of places."""
-
     if type(value) in [Decimal, float]:
         value = round(value, places)
 
@@ -186,7 +198,6 @@ class RoundingDecimalField(models.DecimalField):
 
     def formfield(self, **kwargs):
         """Return a Field instance for this field."""
-
         kwargs['form_class'] = RoundingDecimalFormField
 
         return super().formfield(**kwargs)

InvenTree/InvenTree/filters.py

@@ -1,9 +1,30 @@
 """General filters for InvenTree."""
 
+from datetime import datetime
+
+from django.conf import settings
+from django.utils import timezone
+from django.utils.timezone import make_aware
+
 from django_filters import rest_framework as rest_filters
 from rest_framework import filters
 
-from InvenTree.helpers import str2bool
+import InvenTree.helpers
+
+
+class InvenTreeDateFilter(rest_filters.DateFilter):
+    """Custom DateFilter class which handles timezones correctly."""
+
+    def filter(self, qs, value):
+        """Override the filter method to handle timezones correctly."""
+
+        if settings.USE_TZ:
+            if value is not None:
+                tz = timezone.get_current_timezone()
+                value = datetime(value.year, value.month, value.day)
+                value = make_aware(value, tz, True)
+
+        return super().filter(qs, value)
 
 
 class InvenTreeSearchFilter(filters.SearchFilter):
@@ -13,10 +34,9 @@ class InvenTreeSearchFilter(filters.SearchFilter):
         """Return a set of search fields for the request, adjusted based on request params.
 
         The following query params are available to 'augment' the search (in decreasing order of priority)
-        - search_regex: If True, search is perfomed on 'regex' comparison
+        - search_regex: If True, search is performed on 'regex' comparison
         """
-
-        regex = str2bool(request.query_params.get('search_regex', False))
+        regex = InvenTree.helpers.str2bool(request.query_params.get('search_regex', False))
 
         search_fields = super().get_search_fields(view, request)
 
@@ -36,8 +56,7 @@ class InvenTreeSearchFilter(filters.SearchFilter):
 
         Depending on the request parameters, we may "augment" these somewhat
         """
-
-        whole = str2bool(request.query_params.get('search_whole', False))
+        whole = InvenTree.helpers.str2bool(request.query_params.get('search_whole', False))
 
         terms = []
 

InvenTree/InvenTree/format.py

@@ -3,15 +3,20 @@
 import re
 import string
 
+from django.conf import settings
+from django.utils import translation
 from django.utils.translation import gettext_lazy as _
 
+from babel import Locale
+from babel.numbers import parse_pattern
+from djmoney.money import Money
+
 
 def parse_format_string(fmt_string: str) -> dict:
     """Extract formatting information from the provided format string.
 
     Returns a dict object which contains structured information about the format groups
     """
-
     groups = string.Formatter().parse(fmt_string)
 
     info = {}
@@ -62,7 +67,6 @@ def construct_format_regex(fmt_string: str) -> str:
     Raises:
         ValueError: Format string is invalid
     """
-
     pattern = "^"
 
     for group in string.Formatter().parse(fmt_string):
@@ -91,7 +95,7 @@ def construct_format_regex(fmt_string: str) -> str:
         # Add a named capture group for the format entry
         if name:
 
-            # Check if integer values are requried
+            # Check if integer values are required
             if format.endswith('d'):
                 chr = '\d'
             else:
@@ -121,7 +125,6 @@ def validate_string(value: str, fmt_string: str) -> str:
     Raises:
         ValueError: The provided format string is invalid
     """
-
     pattern = construct_format_regex(fmt_string)
 
     result = re.match(pattern, value)
@@ -145,7 +148,6 @@ def extract_named_group(name: str, value: str, fmt_string: str) -> str:
         NameError: named value does not exist in the format string
         IndexError: named value could not be found in the provided entry
     """
-
     info = parse_format_string(fmt_string)
 
     if name not in info.keys():
@@ -164,3 +166,34 @@ def extract_named_group(name: str, value: str, fmt_string: str) -> str:
     # And return the value we are interested in
     # Note: This will raise an IndexError if the named group was not matched
     return result.group(name)
+
+
+def format_money(money: Money, decimal_places: int = None, format: str = None) -> str:
+    """Format money object according to the currently set local
+
+    Args:
+        decimal_places: Number of decimal places to use
+        format: Format pattern according LDML / the babel format pattern syntax (https://babel.pocoo.org/en/latest/numbers.html)
+
+    Returns:
+        str: The formatted string
+
+    Raises:
+        ValueError: format string is incorrectly specified
+    """
+    language = None and translation.get_language() or settings.LANGUAGE_CODE
+    locale = Locale.parse(translation.to_locale(language))
+    if format:
+        pattern = parse_pattern(format)
+    else:
+        pattern = locale.currency_formats["standard"]
+        if decimal_places is not None:
+            pattern.frac_prec = (decimal_places, decimal_places)
+
+    return pattern.apply(
+        money.amount,
+        locale,
+        currency=money.currency.code,
+        currency_digits=decimal_places is None,
+        decimal_quantization=decimal_places is not None,
+    )

InvenTree/InvenTree/forms.py

@@ -12,8 +12,8 @@ from django.urls import reverse
 from django.utils.translation import gettext_lazy as _
 
 from allauth.account.adapter import DefaultAccountAdapter
-from allauth.account.forms import SignupForm, set_form_field_order
-from allauth.exceptions import ImmediateHttpResponse
+from allauth.account.forms import LoginForm, SignupForm, set_form_field_order
+from allauth.core.exceptions import ImmediateHttpResponse
 from allauth.socialaccount.adapter import DefaultSocialAccountAdapter
 from allauth_2fa.adapter import OTPAdapter
 from allauth_2fa.utils import user_has_valid_totp_device
@@ -21,7 +21,10 @@ from crispy_forms.bootstrap import (AppendedText, PrependedAppendedText,
                                     PrependedText)
 from crispy_forms.helper import FormHelper
 from crispy_forms.layout import Field, Layout
+from dj_rest_auth.registration.serializers import RegisterSerializer
+from rest_framework import serializers
 
+import InvenTree.sso
 from common.models import InvenTreeSetting
 from InvenTree.exceptions import log_error
 
@@ -65,10 +68,10 @@ class HelperForm(forms.ModelForm):
 
             # Look for font-awesome icons
             if prefix and prefix.startswith('fa-'):
-                prefix = r"<i class='fas {fa}'/>".format(fa=prefix)
+                prefix = f"<i class='fas {prefix}'/>"
 
             if suffix and suffix.startswith('fa-'):
-                suffix = r"<i class='fas {fa}'/>".format(fa=suffix)
+                suffix = f"<i class='fas {suffix}'/>"
 
             if prefix and suffix:
                 layouts.append(
@@ -159,11 +162,29 @@ class SetPasswordForm(HelperForm):
     old_password = forms.CharField(
         label=_("Old password"),
         strip=False,
+        required=False,
         widget=forms.PasswordInput(attrs={'autocomplete': 'current-password', 'autofocus': True}),
     )
 
 
 # override allauth
+class CustomLoginForm(LoginForm):
+    """Custom login form to override default allauth behaviour"""
+
+    def login(self, request, redirect_url=None):
+        """Perform login action.
+
+        First check that:
+        - A valid user has been supplied
+        """
+        if not self.user:
+            # No user supplied - redirect to the login page
+            return HttpResponseRedirect(reverse('account_login'))
+
+        # Now perform default login action
+        return super().login(request, redirect_url)
+
+
 class CustomSignupForm(SignupForm):
     """Override to use dynamic settings."""
 
@@ -193,7 +214,7 @@ class CustomSignupForm(SignupForm):
         set_form_field_order(self, ["username", "email", "email2", "password1", "password2", ])
 
     def clean(self):
-        """Make sure the supllied emails match if enabled in settings."""
+        """Make sure the supplied emails match if enabled in settings."""
         cleaned_data = super().clean()
 
         # check for two mail fields
@@ -206,15 +227,25 @@ class CustomSignupForm(SignupForm):
         return cleaned_data
 
 
+def registration_enabled():
+    """Determine whether user registration is enabled."""
+    if InvenTreeSetting.get_setting('LOGIN_ENABLE_REG') or InvenTree.sso.registration_enabled():
+        if settings.EMAIL_HOST:
+            return True
+        else:
+            logger.error("Registration cannot be enabled, because EMAIL_HOST is not configured.")
+    return False
+
+
 class RegistratonMixin:
     """Mixin to check if registration should be enabled."""
 
     def is_open_for_signup(self, request, *args, **kwargs):
         """Check if signup is enabled in settings.
 
-        Configure the class variable `REGISTRATION_SETTING` to set which setting should be used, defualt: `LOGIN_ENABLE_REG`.
+        Configure the class variable `REGISTRATION_SETTING` to set which setting should be used, default: `LOGIN_ENABLE_REG`.
         """
-        if settings.EMAIL_HOST and (InvenTreeSetting.get_setting('LOGIN_ENABLE_REG') or InvenTreeSetting.get_setting('LOGIN_ENABLE_SSO_REG')):
+        if registration_enabled():
             return super().is_open_for_signup(request, *args, **kwargs)
         return False
 
@@ -226,7 +257,7 @@ class RegistratonMixin:
 
         split_email = email.split('@')
         if len(split_email) != 2:
-            logger.error(f'The user {email} has an invalid email address')
+            logger.error('The user %s has an invalid email address', email)
             raise forms.ValidationError(_('The provided primary email address is not valid.'))
 
         mailoptions = mail_restriction.split(',')
@@ -238,7 +269,7 @@ class RegistratonMixin:
                 if split_email[1] == option[1:]:
                     return super().clean_email(email)
 
-        logger.info(f'The provided email domain for {email} is not approved')
+        logger.info('The provided email domain for %s is not approved', email)
         raise forms.ValidationError(_('The provided email domain is not approved.'))
 
     def save_user(self, request, user, form, commit=True):
@@ -253,7 +284,7 @@ class RegistratonMixin:
                 group = Group.objects.get(id=start_group)
                 user.groups.add(group)
             except Group.DoesNotExist:
-                logger.error('The setting `SIGNUP_GROUP` contains an non existant group', start_group)
+                logger.exception('The setting `SIGNUP_GROUP` contains an non existent group', start_group)
         user.save()
         return user
 
@@ -276,7 +307,7 @@ class CustomAccountAdapter(CustomUrlMixin, RegistratonMixin, OTPAdapter, Default
             try:
                 result = super().send_mail(template_prefix, email, context)
             except Exception:
-                # An exception ocurred while attempting to send email
+                # An exception occurred while attempting to send email
                 # Log it (for admin users) and return silently
                 log_error('account email')
                 result = False
@@ -285,6 +316,14 @@ class CustomAccountAdapter(CustomUrlMixin, RegistratonMixin, OTPAdapter, Default
 
         return False
 
+    def get_email_confirmation_url(self, request, emailconfirmation):
+        """Construct the email confirmation url"""
+        from InvenTree.helpers_model import construct_absolute_url
+
+        url = super().get_email_confirmation_url(request, emailconfirmation)
+        url = construct_absolute_url(url)
+        return url
+
 
 class CustomSocialAccountAdapter(CustomUrlMixin, RegistratonMixin, DefaultSocialAccountAdapter):
     """Override of adapter to use dynamic settings."""
@@ -319,3 +358,34 @@ class CustomSocialAccountAdapter(CustomUrlMixin, RegistratonMixin, DefaultSocial
 
         # Otherwise defer to the original allauth adapter.
         return super().login(request, user)
+
+    def authentication_error(self, request, provider_id, error=None, exception=None, extra_context=None):
+        """Callback method for authentication errors."""
+        if not error:
+            error = request.GET.get('error', None)
+
+        if not exception:
+            exception = request.GET.get('error_description', None)
+
+        path = request.path or 'sso'
+
+        # Log the error to the database
+        log_error(path, error_name=error, error_data=exception)
+        logger.error("SSO error for provider '%s' - check admin error log", provider_id)
+
+
+# override dj-rest-auth
+class CustomRegisterSerializer(RegisterSerializer):
+    """Override of serializer to use dynamic settings."""
+    email = serializers.EmailField()
+
+    def __init__(self, instance=None, data=..., **kwargs):
+        """Check settings to influence which fields are needed."""
+        kwargs['email_required'] = InvenTreeSetting.get_setting('LOGIN_MAIL_REQUIRED')
+        super().__init__(instance, data, **kwargs)
+
+    def save(self, request):
+        """Override to check if registration is open."""
+        if registration_enabled():
+            return super().save(request)
+        raise forms.ValidationError(_('Registration is disabled.'))

InvenTree/InvenTree/helpers.py

@@ -8,44 +8,28 @@ import os
 import os.path
 import re
 from decimal import Decimal, InvalidOperation
-from pathlib import Path
 from wsgiref.util import FileWrapper
 
 from django.conf import settings
-from django.contrib.auth.models import Permission
 from django.contrib.staticfiles.storage import StaticFilesStorage
 from django.core.exceptions import FieldError, ValidationError
 from django.core.files.storage import default_storage
-from django.core.validators import URLValidator
 from django.http import StreamingHttpResponse
-from django.test import TestCase
 from django.utils.translation import gettext_lazy as _
 
-import moneyed.localization
 import regex
-import requests
 from bleach import clean
-from djmoney.contrib.exchange.models import convert_money
 from djmoney.money import Money
 from PIL import Image
 
 import InvenTree.version
-from common.models import InvenTreeSetting
-from common.notifications import (InvenTreeNotificationBodies,
-                                  NotificationBody, trigger_notification)
 from common.settings import currency_code_default
 
-from .api_tester import ExchangeRateMixin, UserMixin
 from .settings import MEDIA_URL, STATIC_URL
 
 logger = logging.getLogger('inventree')
 
 
-def getSetting(key, backup_value=None):
-    """Shortcut for reading a setting value from the database."""
-    return InvenTreeSetting.get_setting(key, backup_value=backup_value)
-
-
 def generateTestKey(test_name):
     """Generate a test 'key' for a given test name. This must not have illegal chars as it will be used for dict lookup in a template.
 
@@ -67,7 +51,6 @@ def constructPathString(path, max_chars=250):
         path: A list of strings e.g. ['path', 'to', 'location']
         max_chars: Maximum number of characters
     """
-
     pathstring = '/'.join(path)
 
     # Replace middle elements to limit the pathstring
@@ -88,130 +71,6 @@ def getStaticUrl(filename):
     return os.path.join(STATIC_URL, str(filename))
 
 
-def construct_absolute_url(*arg):
-    """Construct (or attempt to construct) an absolute URL from a relative URL.
-
-    This is useful when (for example) sending an email to a user with a link
-    to something in the InvenTree web framework.
-
-    This requires the BASE_URL configuration option to be set!
-    """
-    base = str(InvenTreeSetting.get_setting('INVENTREE_BASE_URL'))
-
-    url = '/'.join(arg)
-
-    if not base:
-        return url
-
-    # Strip trailing slash from base url
-    if base.endswith('/'):
-        base = base[:-1]
-
-    if url.startswith('/'):
-        url = url[1:]
-
-    url = f"{base}/{url}"
-
-    return url
-
-
-def download_image_from_url(remote_url, timeout=2.5):
-    """Download an image file from a remote URL.
-
-    This is a potentially dangerous operation, so we must perform some checks:
-
-    - The remote URL is available
-    - The Content-Length is provided, and is not too large
-    - The file is a valid image file
-
-    Arguments:
-        remote_url: The remote URL to retrieve image
-        max_size: Maximum allowed image size (default = 1MB)
-        timeout: Connection timeout in seconds (default = 5)
-
-    Returns:
-        An in-memory PIL image file, if the download was successful
-
-    Raises:
-        requests.exceptions.ConnectionError: Connection could not be established
-        requests.exceptions.Timeout: Connection timed out
-        requests.exceptions.HTTPError: Server responded with invalid response code
-        ValueError: Server responded with invalid 'Content-Length' value
-        TypeError: Response is not a valid image
-    """
-
-    # Check that the provided URL at least looks valid
-    validator = URLValidator()
-    validator(remote_url)
-
-    # Calculate maximum allowable image size (in bytes)
-    max_size = int(InvenTreeSetting.get_setting('INVENTREE_DOWNLOAD_IMAGE_MAX_SIZE')) * 1024 * 1024
-
-    # Add user specified user-agent to request (if specified)
-    user_agent = InvenTreeSetting.get_setting('INVENTREE_DOWNLOAD_FROM_URL_USER_AGENT')
-    if user_agent:
-        headers = {"User-Agent": user_agent}
-    else:
-        headers = None
-
-    try:
-        response = requests.get(
-            remote_url,
-            timeout=timeout,
-            allow_redirects=True,
-            stream=True,
-            headers=headers,
-        )
-        # Throw an error if anything goes wrong
-        response.raise_for_status()
-    except requests.exceptions.ConnectionError as exc:
-        raise Exception(_("Connection error") + f": {str(exc)}")
-    except requests.exceptions.Timeout as exc:
-        raise exc
-    except requests.exceptions.HTTPError:
-        raise requests.exceptions.HTTPError(_("Server responded with invalid status code") + f": {response.status_code}")
-    except Exception as exc:
-        raise Exception(_("Exception occurred") + f": {str(exc)}")
-
-    if response.status_code != 200:
-        raise Exception(_("Server responded with invalid status code") + f": {response.status_code}")
-
-    try:
-        content_length = int(response.headers.get('Content-Length', 0))
-    except ValueError:
-        raise ValueError(_("Server responded with invalid Content-Length value"))
-
-    if content_length > max_size:
-        raise ValueError(_("Image size is too large"))
-
-    # Download the file, ensuring we do not exceed the reported size
-    fo = io.BytesIO()
-
-    dl_size = 0
-    chunk_size = 64 * 1024
-
-    for chunk in response.iter_content(chunk_size=chunk_size):
-        dl_size += len(chunk)
-
-        if dl_size > max_size:
-            raise ValueError(_("Image download exceeded maximum size"))
-
-        fo.write(chunk)
-
-    if dl_size == 0:
-        raise ValueError(_("Remote server returned empty response"))
-
-    # Now, attempt to convert the downloaded data to a valid image file
-    # img.verify() will throw an exception if the image is not valid
-    try:
-        img = Image.open(fo).convert()
-        img.verify()
-    except Exception:
-        raise TypeError(_("Supplied URL is not a valid image file"))
-
-    return img
-
-
 def TestIfImage(img):
     """Test if an image file is indeed an image."""
     try:
@@ -233,7 +92,6 @@ def getBlankThumbnail():
 
 def getLogoImage(as_file=False, custom=True):
     """Return the InvenTree logo image, or a custom logo if available."""
-
     """Return the path to the logo-file."""
     if custom and settings.CUSTOM_LOGO:
 
@@ -249,20 +107,17 @@ def getLogoImage(as_file=False, custom=True):
         if storage is not None:
             if as_file:
                 return f"file://{storage.path(settings.CUSTOM_LOGO)}"
-            else:
-                return storage.url(settings.CUSTOM_LOGO)
+            return storage.url(settings.CUSTOM_LOGO)
 
     # If we have got to this point, return the default logo
     if as_file:
         path = settings.STATIC_ROOT.joinpath('img/inventree.png')
         return f"file://{path}"
-    else:
-        return getStaticUrl('img/inventree.png')
+    return getStaticUrl('img/inventree.png')
 
 
-def getSplashScren(custom=True):
+def getSplashScreen(custom=True):
     """Return the InvenTree splash screen, or a custom splash if available"""
-
     static_storage = StaticFilesStorage()
 
     if custom and settings.CUSTOM_SPLASH:
@@ -299,8 +154,7 @@ def str2bool(text, test=True):
     """
     if test:
         return str(text).lower() in ['1', 'y', 'yes', 't', 'true', 'ok', 'on', ]
-    else:
-        return str(text).lower() in ['0', 'n', 'no', 'none', 'f', 'false', 'off', ]
+    return str(text).lower() in ['0', 'n', 'no', 'none', 'f', 'false', 'off', ]
 
 
 def str2int(text, default=None):
@@ -325,8 +179,7 @@ def is_bool(text):
         return True
     elif str2bool(text, False):
         return True
-    else:
-        return False
+    return False
 
 
 def isNull(text):
@@ -473,12 +326,11 @@ def MakeBarcode(cls_name, object_pk: int, object_data=None, **kwargs):
         object_type: string describing the object type e.g. 'StockItem'
         object_id: ID (Primary Key) of the object in the database
         object_url: url for JSON API detail view of the object
-        data: Python dict object containing extra datawhich will be rendered to string (must only contain stringable values)
+        data: Python dict object containing extra data which will be rendered to string (must only contain stringable values)
 
     Returns:
         json string of the supplied data plus some other data
     """
-
     if object_data is None:
         object_data = {}
 
@@ -497,7 +349,7 @@ def MakeBarcode(cls_name, object_pk: int, object_data=None, **kwargs):
         object_data['id'] = object_pk
         data[cls_name] = object_data
 
-    return json.dumps(data, sort_keys=True)
+    return str(json.dumps(data, sort_keys=True))
 
 
 def GetExportFormats():
@@ -527,13 +379,13 @@ def DownloadFile(data, filename, content_type='application/text', inline=False)
     filename = WrapWithQuotes(filename)
     length = len(data)
 
-    if type(data) == str:
+    if isinstance(data, str):
         wrapper = FileWrapper(io.StringIO(data))
     else:
         wrapper = FileWrapper(io.BytesIO(data))
 
     response = StreamingHttpResponse(wrapper, content_type=content_type)
-    if type(data) == str:
+    if isinstance(data, str):
         length = len(bytes(data, response.charset))
     response['Content-Length'] = length
 
@@ -555,7 +407,6 @@ def increment_serial_number(serial: str):
     Returns:
         incremented value, or None if incrementing could not be performed.
     """
-
     from plugin.registry import registry
 
     # Ensure we start with a string value
@@ -581,7 +432,7 @@ def extract_serial_numbers(input_string, expected_quantity: int, starting_value=
     - Individual serials are separated by comma: 1, 2, 3, 6,22
     - Sequential ranges with provided limits are separated by hyphens: 1-5, 20 - 40
     - The "next" available serial number can be specified with the tilde (~) character
-    - Serial numbers can be supplied as <start>+ for getting all expecteded numbers starting from <start>
+    - Serial numbers can be supplied as <start>+ for getting all expected numbers starting from <start>
     - Serial numbers can be supplied as <start>+<length> for getting <length> numbers starting from <start>
 
     Actual generation of sequential serials is passed to the 'validation' plugin mixin,
@@ -592,7 +443,6 @@ def extract_serial_numbers(input_string, expected_quantity: int, starting_value=
         expected_quantity: The number of (unique) serial numbers we expect
         starting_value: Provide a starting value for the sequence (or None)
     """
-
     if starting_value is None:
         starting_value = increment_serial_number(None)
 
@@ -632,7 +482,7 @@ def extract_serial_numbers(input_string, expected_quantity: int, starting_value=
 
         serial = serial.strip()
 
-        # Ignore blank / emtpy serials
+        # Ignore blank / empty serials
         if len(serial) == 0:
             return
 
@@ -670,7 +520,7 @@ def extract_serial_numbers(input_string, expected_quantity: int, starting_value=
 
                 if a == b:
                     # Invalid group
-                    add_error(_("Invalid group range: {g}").format(g=group))
+                    add_error(_(f"Invalid group range: {group}"))
                     continue
 
                 group_items = []
@@ -699,13 +549,13 @@ def extract_serial_numbers(input_string, expected_quantity: int, starting_value=
                         break
 
                 if len(group_items) > remaining:
-                    add_error(_("Group range {g} exceeds allowed quantity ({q})".format(g=group, q=expected_quantity)))
+                    add_error(_(f"Group range {group} exceeds allowed quantity ({expected_quantity})"))
                 elif len(group_items) > 0 and group_items[0] == a and group_items[-1] == b:
                     # In this case, the range extraction looks like it has worked
                     for item in group_items:
                         add_serial(item)
                 else:
-                    add_error(_("Invalid group range: {g}").format(g=group))
+                    add_error(_(f"Invalid group range: {group}"))
 
             else:
                 # In the case of a different number of hyphens, simply add the entire group
@@ -723,14 +573,14 @@ def extract_serial_numbers(input_string, expected_quantity: int, starting_value=
             sequence_count = max(0, expected_quantity - len(serials))
 
             if len(items) > 2 or len(items) == 0:
-                add_error(_("Invalid group sequence: {g}").format(g=group))
+                add_error(_(f"Invalid group sequence: {group}"))
                 continue
             elif len(items) == 2:
                 try:
                     if items[1]:
                         sequence_count = int(items[1]) + 1
                 except ValueError:
-                    add_error(_("Invalid group sequence: {g}").format(g=group))
+                    add_error(_(f"Invalid group sequence: {group}"))
                     continue
 
             value = items[0]
@@ -745,7 +595,7 @@ def extract_serial_numbers(input_string, expected_quantity: int, starting_value=
                 for item in sequence_items:
                     add_serial(item)
             else:
-                add_error(_("Invalid group sequence: {g}").format(g=group))
+                add_error(_(f"Invalid group sequence: {group}"))
 
         else:
             # At this point, we assume that the 'group' is just a single serial value
@@ -758,7 +608,7 @@ def extract_serial_numbers(input_string, expected_quantity: int, starting_value=
         raise ValidationError([_("No serial numbers found")])
 
     if len(errors) == 0 and len(serials) != expected_quantity:
-        raise ValidationError([_("Number of unique serial numbers ({s}) must match quantity ({q})").format(s=len(serials), q=expected_quantity)])
+        raise ValidationError([_(f"Number of unique serial numbers ({len(serials)}) must match quantity ({expected_quantity})")])
 
     return serials
 
@@ -796,7 +646,7 @@ def validateFilterString(value, model=None):
 
         if len(pair) != 2:
             raise ValidationError(
-                "Invalid group: {g}".format(g=group)
+                f"Invalid group: {group}"
             )
 
         k, v = pair
@@ -806,7 +656,7 @@ def validateFilterString(value, model=None):
 
         if not k or not v:
             raise ValidationError(
-                "Invalid group: {g}".format(g=group)
+                f"Invalid group: {group}"
             )
 
         results[k] = v
@@ -823,75 +673,6 @@ def validateFilterString(value, model=None):
     return results
 
 
-def addUserPermission(user, permission):
-    """Shortcut function for adding a certain permission to a user."""
-    perm = Permission.objects.get(codename=permission)
-    user.user_permissions.add(perm)
-
-
-def addUserPermissions(user, permissions):
-    """Shortcut function for adding multiple permissions to a user."""
-    for permission in permissions:
-        addUserPermission(user, permission)
-
-
-def getMigrationFileNames(app):
-    """Return a list of all migration filenames for provided app."""
-    local_dir = Path(__file__).parent
-    files = local_dir.joinpath('..', app, 'migrations').iterdir()
-
-    # Regex pattern for migration files
-    regex = re.compile(r"^[\d]+_.*\.py$")
-
-    migration_files = []
-
-    for f in files:
-        if regex.match(f.name):
-            migration_files.append(f.name)
-
-    return migration_files
-
-
-def getOldestMigrationFile(app, exclude_extension=True, ignore_initial=True):
-    """Return the filename associated with the oldest migration."""
-    oldest_num = -1
-    oldest_file = None
-
-    for f in getMigrationFileNames(app):
-
-        if ignore_initial and f.startswith('0001_initial'):
-            continue
-
-        num = int(f.split('_')[0])
-
-        if oldest_file is None or num < oldest_num:
-            oldest_num = num
-            oldest_file = f
-
-    if exclude_extension:
-        oldest_file = oldest_file.replace('.py', '')
-
-    return oldest_file
-
-
-def getNewestMigrationFile(app, exclude_extension=True):
-    """Return the filename associated with the newest migration."""
-    newest_file = None
-    newest_num = -1
-
-    for f in getMigrationFileNames(app):
-        num = int(f.split('_')[0])
-
-        if newest_file is None or num > newest_num:
-            newest_num = num
-            newest_file = f
-
-    if exclude_extension:
-        newest_file = newest_file.replace('.py', '')
-
-    return newest_file
-
-
 def clean_decimal(number):
     """Clean-up decimal value."""
     # Check if empty
@@ -933,7 +714,6 @@ def strip_html_tags(value: str, raise_error=True, field_name=None):
 
     If raise_error is True, a ValidationError will be thrown if HTML tags are detected
     """
-
     cleaned = clean(
         value,
         strip=True,
@@ -965,7 +745,6 @@ def strip_html_tags(value: str, raise_error=True, field_name=None):
 
 def remove_non_printable_characters(value: str, remove_newline=True, remove_ascii=True, remove_unicode=True):
     """Remove non-printable / control characters from the provided string"""
-
     cleaned = value
 
     if remove_ascii:
@@ -996,7 +775,6 @@ def hash_barcode(barcode_data):
     We first remove any non-printable characters from the barcode data,
     as some browsers have issues scanning characters in.
     """
-
     barcode_data = str(barcode_data).strip()
     barcode_data = remove_non_printable_characters(barcode_data)
 
@@ -1022,7 +800,6 @@ def get_objectreference(obj, type_ref: str = 'content_type', object_ref: str = '
 
     The method name must always be the name of the field prefixed by 'get_'
     """
-
     model_cls = getattr(obj, type_ref)
     obj_id = getattr(obj, object_ref)
 
@@ -1055,6 +832,7 @@ def inheritors(cls):
     """Return all classes that are subclasses from the supplied cls."""
     subcls = set()
     work = [cls]
+
     while work:
         parent = work.pop()
         for child in parent.__subclasses__():
@@ -1064,100 +842,6 @@ def inheritors(cls):
     return subcls
 
 
-class InvenTreeTestCase(ExchangeRateMixin, UserMixin, TestCase):
-    """Testcase with user setup buildin."""
-    pass
-
-
-def notify_responsible(instance, sender, content: NotificationBody = InvenTreeNotificationBodies.NewOrder, exclude=None):
-    """Notify all responsible parties of a change in an instance.
-
-    Parses the supplied content with the provided instance and sender and sends a notification to all responsible users,
-    excluding the optional excluded list.
-
-    Args:
-        instance: The newly created instance
-        sender: Sender model reference
-        content (NotificationBody, optional): _description_. Defaults to InvenTreeNotificationBodies.NewOrder.
-        exclude (User, optional): User instance that should be excluded. Defaults to None.
-    """
-    if instance.responsible is not None:
-        # Setup context for notification parsing
-        content_context = {
-            'instance': str(instance),
-            'verbose_name': sender._meta.verbose_name,
-            'app_label': sender._meta.app_label,
-            'model_name': sender._meta.model_name,
-        }
-
-        # Setup notification context
-        context = {
-            'instance': instance,
-            'name': content.name.format(**content_context),
-            'message': content.message.format(**content_context),
-            'link': InvenTree.helpers.construct_absolute_url(instance.get_absolute_url()),
-            'template': {
-                'html': content.template.format(**content_context),
-                'subject': content.name.format(**content_context),
-            }
-        }
-
-        # Create notification
-        trigger_notification(
-            instance,
-            content.slug.format(**content_context),
-            targets=[instance.responsible],
-            target_exclude=[exclude],
-            context=context,
-        )
-
-
-def render_currency(money, decimal_places=None, currency=None, include_symbol=True, min_decimal_places=None):
-    """Render a currency / Money object to a formatted string (e.g. for reports)
-
-    Arguments:
-        money: The Money instance to be rendered
-        decimal_places: The number of decimal places to render to. If unspecified, uses the PRICING_DECIMAL_PLACES setting.
-        currency: Optionally convert to the specified currency
-        include_symbol: Render with the appropriate currency symbol
-        min_decimal_places: The minimum number of decimal places to render to. If unspecified, uses the PRICING_DECIMAL_PLACES_MIN setting.
-    """
-
-    if money in [None, '']:
-        return '-'
-
-    if type(money) is not Money:
-        return '-'
-
-    if currency is not None:
-        # Attempt to convert to the provided currency
-        # If cannot be done, leave the original
-        try:
-            money = convert_money(money, currency)
-        except Exception:
-            pass
-
-    if decimal_places is None:
-        decimal_places = InvenTreeSetting.get_setting('PRICING_DECIMAL_PLACES', 6)
-
-    if min_decimal_places is None:
-        min_decimal_places = InvenTreeSetting.get_setting('PRICING_DECIMAL_PLACES_MIN', 0)
-
-    value = Decimal(str(money.amount)).normalize()
-    value = str(value)
-
-    if '.' in value:
-        decimals = len(value.split('.')[-1])
-
-        decimals = max(decimals, min_decimal_places)
-        decimals = min(decimals, decimal_places)
-
-        decimal_places = decimals
-    else:
-        decimal_places = max(decimal_places, 2)
-
-    return moneyed.localization.format_money(
-        money,
-        decimal_places=decimal_places,
-        include_symbol=include_symbol,
-    )
+def is_ajax(request):
+    """Check if the current request is an AJAX request."""
+    return request.headers.get('x-requested-with') == 'XMLHttpRequest'

InvenTree/InvenTree/helpers_model.py

@@ -0,0 +1,297 @@
+"""Provides helper functions used throughout the InvenTree project that access the database."""
+
+import io
+import logging
+from decimal import Decimal
+from urllib.parse import urljoin
+
+from django.conf import settings
+from django.core.validators import URLValidator
+from django.db.utils import OperationalError, ProgrammingError
+from django.utils.translation import gettext_lazy as _
+
+import requests
+from djmoney.contrib.exchange.models import convert_money
+from djmoney.money import Money
+from PIL import Image
+
+import common.models
+import InvenTree
+import InvenTree.helpers_model
+import InvenTree.version
+from common.notifications import (InvenTreeNotificationBodies,
+                                  NotificationBody, trigger_notification)
+from InvenTree.format import format_money
+
+logger = logging.getLogger('inventree')
+
+
+def getSetting(key, backup_value=None):
+    """Shortcut for reading a setting value from the database."""
+    return common.models.InvenTreeSetting.get_setting(key, backup_value=backup_value)
+
+
+def construct_absolute_url(*arg, **kwargs):
+    """Construct (or attempt to construct) an absolute URL from a relative URL.
+
+    This is useful when (for example) sending an email to a user with a link
+    to something in the InvenTree web framework.
+    A URL is constructed in the following order:
+    1. If settings.SITE_URL is set (e.g. in the Django settings), use that
+    2. If the InvenTree setting INVENTREE_BASE_URL is set, use that
+    3. Otherwise, use the current request URL (if available)
+    """
+    relative_url = '/'.join(arg)
+
+    # If a site URL is provided, use that
+    site_url = getattr(settings, 'SITE_URL', None)
+
+    if not site_url:
+        # Otherwise, try to use the InvenTree setting
+        try:
+            site_url = common.models.InvenTreeSetting.get_setting('INVENTREE_BASE_URL', create=False, cache=False)
+        except (ProgrammingError, OperationalError):
+            pass
+
+    if not site_url:
+        # Otherwise, try to use the current request
+        request = kwargs.get('request', None)
+
+        if request:
+            site_url = request.build_absolute_uri('/')
+
+    if not site_url:
+        # No site URL available, return the relative URL
+        return relative_url
+
+    return urljoin(site_url, relative_url)
+
+
+def get_base_url(**kwargs):
+    """Return the base URL for the InvenTree server"""
+    return construct_absolute_url('', **kwargs)
+
+
+def download_image_from_url(remote_url, timeout=2.5):
+    """Download an image file from a remote URL.
+
+    This is a potentially dangerous operation, so we must perform some checks:
+    - The remote URL is available
+    - The Content-Length is provided, and is not too large
+    - The file is a valid image file
+
+    Arguments:
+        remote_url: The remote URL to retrieve image
+        max_size: Maximum allowed image size (default = 1MB)
+        timeout: Connection timeout in seconds (default = 5)
+
+    Returns:
+        An in-memory PIL image file, if the download was successful
+
+    Raises:
+        requests.exceptions.ConnectionError: Connection could not be established
+        requests.exceptions.Timeout: Connection timed out
+        requests.exceptions.HTTPError: Server responded with invalid response code
+        ValueError: Server responded with invalid 'Content-Length' value
+        TypeError: Response is not a valid image
+    """
+    # Check that the provided URL at least looks valid
+    validator = URLValidator()
+    validator(remote_url)
+
+    # Calculate maximum allowable image size (in bytes)
+    max_size = int(common.models.InvenTreeSetting.get_setting('INVENTREE_DOWNLOAD_IMAGE_MAX_SIZE')) * 1024 * 1024
+
+    # Add user specified user-agent to request (if specified)
+    user_agent = common.models.InvenTreeSetting.get_setting('INVENTREE_DOWNLOAD_FROM_URL_USER_AGENT')
+    if user_agent:
+        headers = {"User-Agent": user_agent}
+    else:
+        headers = None
+
+    try:
+        response = requests.get(
+            remote_url,
+            timeout=timeout,
+            allow_redirects=True,
+            stream=True,
+            headers=headers,
+        )
+        # Throw an error if anything goes wrong
+        response.raise_for_status()
+    except requests.exceptions.ConnectionError as exc:
+        raise Exception(_("Connection error") + f": {str(exc)}")
+    except requests.exceptions.Timeout as exc:
+        raise exc
+    except requests.exceptions.HTTPError:
+        raise requests.exceptions.HTTPError(_("Server responded with invalid status code") + f": {response.status_code}")
+    except Exception as exc:
+        raise Exception(_("Exception occurred") + f": {str(exc)}")
+
+    if response.status_code != 200:
+        raise Exception(_("Server responded with invalid status code") + f": {response.status_code}")
+
+    try:
+        content_length = int(response.headers.get('Content-Length', 0))
+    except ValueError:
+        raise ValueError(_("Server responded with invalid Content-Length value"))
+
+    if content_length > max_size:
+        raise ValueError(_("Image size is too large"))
+
+    # Download the file, ensuring we do not exceed the reported size
+    file = io.BytesIO()
+
+    dl_size = 0
+    chunk_size = 64 * 1024
+
+    for chunk in response.iter_content(chunk_size=chunk_size):
+        dl_size += len(chunk)
+
+        if dl_size > max_size:
+            raise ValueError(_("Image download exceeded maximum size"))
+
+        file.write(chunk)
+
+    if dl_size == 0:
+        raise ValueError(_("Remote server returned empty response"))
+
+    # Now, attempt to convert the downloaded data to a valid image file
+    # img.verify() will throw an exception if the image is not valid
+    try:
+        img = Image.open(file).convert()
+        img.verify()
+    except Exception:
+        raise TypeError(_("Supplied URL is not a valid image file"))
+
+    return img
+
+
+def render_currency(money, decimal_places=None, currency=None, min_decimal_places=None, max_decimal_places=None):
+    """Render a currency / Money object to a formatted string (e.g. for reports)
+
+    Arguments:
+        money: The Money instance to be rendered
+        decimal_places: The number of decimal places to render to. If unspecified, uses the PRICING_DECIMAL_PLACES setting.
+        currency: Optionally convert to the specified currency
+        min_decimal_places: The minimum number of decimal places to render to. If unspecified, uses the PRICING_DECIMAL_PLACES_MIN setting.
+        max_decimal_places: The maximum number of decimal places to render to. If unspecified, uses the PRICING_DECIMAL_PLACES setting.
+    """
+    if money in [None, '']:
+        return '-'
+
+    if type(money) is not Money:
+        return '-'
+
+    if currency is not None:
+        # Attempt to convert to the provided currency
+        # If cannot be done, leave the original
+        try:
+            money = convert_money(money, currency)
+        except Exception:
+            pass
+
+    if decimal_places is None:
+        decimal_places = common.models.InvenTreeSetting.get_setting('PRICING_DECIMAL_PLACES', 6)
+
+    if min_decimal_places is None:
+        min_decimal_places = common.models.InvenTreeSetting.get_setting('PRICING_DECIMAL_PLACES_MIN', 0)
+
+    if max_decimal_places is None:
+        max_decimal_places = common.models.InvenTreeSetting.get_setting('PRICING_DECIMAL_PLACES', 6)
+
+    value = Decimal(str(money.amount)).normalize()
+    value = str(value)
+
+    if '.' in value:
+        decimals = len(value.split('.')[-1])
+
+        decimals = max(decimals, min_decimal_places)
+        decimals = min(decimals, decimal_places)
+
+        decimal_places = decimals
+    else:
+        decimal_places = max(decimal_places, 2)
+
+    decimal_places = max(decimal_places, max_decimal_places)
+
+    return format_money(money, decimal_places=decimal_places)
+
+
+def getModelsWithMixin(mixin_class) -> list:
+    """Return a list of models that inherit from the given mixin class.
+
+    Args:
+        mixin_class: The mixin class to search for
+    Returns:
+        List of models that inherit from the given mixin class
+    """
+    from django.contrib.contenttypes.models import ContentType
+
+    try:
+        db_models = [x.model_class() for x in ContentType.objects.all() if x is not None]
+    except (OperationalError, ProgrammingError):
+        # Database is likely not yet ready
+        db_models = []
+
+    return [x for x in db_models if x is not None and issubclass(x, mixin_class)]
+
+
+def notify_responsible(instance, sender, content: NotificationBody = InvenTreeNotificationBodies.NewOrder, exclude=None):
+    """Notify all responsible parties of a change in an instance.
+
+    Parses the supplied content with the provided instance and sender and sends a notification to all responsible users,
+    excluding the optional excluded list.
+
+    Args:
+        instance: The newly created instance
+        sender: Sender model reference
+        content (NotificationBody, optional): _description_. Defaults to InvenTreeNotificationBodies.NewOrder.
+        exclude (User, optional): User instance that should be excluded. Defaults to None.
+    """
+    notify_users([instance.responsible], instance, sender, content=content, exclude=exclude)
+
+
+def notify_users(users, instance, sender, content: NotificationBody = InvenTreeNotificationBodies.NewOrder, exclude=None):
+    """Notify all passed users or groups.
+
+    Parses the supplied content with the provided instance and sender and sends a notification to all users,
+    excluding the optional excluded list.
+
+    Args:
+        users: List of users or groups to notify
+        instance: The newly created instance
+        sender: Sender model reference
+        content (NotificationBody, optional): _description_. Defaults to InvenTreeNotificationBodies.NewOrder.
+        exclude (User, optional): User instance that should be excluded. Defaults to None.
+    """
+    # Setup context for notification parsing
+    content_context = {
+        'instance': str(instance),
+        'verbose_name': sender._meta.verbose_name,
+        'app_label': sender._meta.app_label,
+        'model_name': sender._meta.model_name,
+    }
+
+    # Setup notification context
+    context = {
+        'instance': instance,
+        'name': content.name.format(**content_context),
+        'message': content.message.format(**content_context),
+        'link': InvenTree.helpers_model.construct_absolute_url(instance.get_absolute_url()),
+        'template': {
+            'subject': content.name.format(**content_context),
+        }
+    }
+
+    if content.template:
+        context['template']['html'] = content.template.format(**content_context)
+
+    # Create notification
+    trigger_notification(
+        instance,
+        content.slug.format(**content_context),
+        targets=users,
+        target_exclude=[exclude],
+        context=context,
+    )

InvenTree/InvenTree/magic_login.py

@@ -0,0 +1,75 @@
+"""Functions for magic login."""
+from django.conf import settings
+from django.contrib.auth.models import User
+from django.contrib.sites.models import Site
+from django.core.mail import send_mail
+from django.template.loader import render_to_string
+from django.urls import reverse
+from django.utils.translation import gettext_lazy as _
+
+import sesame.utils
+from rest_framework import serializers
+from rest_framework.response import Response
+from rest_framework.views import APIView
+
+
+def send_simple_login_email(user, link):
+    """Send an email with the login link to this user."""
+    site = Site.objects.get_current()
+
+    context = {
+        "username": user.username,
+        "site_name": site.name,
+        "link": link,
+    }
+    email_plaintext_message = render_to_string("InvenTree/user_simple_login.txt", context)
+
+    send_mail(
+        _(f"[{site.name}] Log in to the app"),
+        email_plaintext_message,
+        settings.DEFAULT_FROM_EMAIL,
+        [user.email],
+    )
+
+
+class GetSimpleLoginSerializer(serializers.Serializer):
+    """Serializer for the simple login view."""
+
+    email = serializers.CharField(label=_("Email"))
+
+
+class GetSimpleLoginView(APIView):
+    """View to send a simple login link."""
+
+    permission_classes = ()
+    serializer_class = GetSimpleLoginSerializer
+
+    def post(self, request, *args, **kwargs):
+        """Get the token for the current user or fail."""
+        serializer = self.serializer_class(data=request.data)
+        serializer.is_valid(raise_exception=True)
+        self.email_submitted(email=serializer.data["email"])
+        return Response({"status": "ok"})
+
+    def email_submitted(self, email):
+        """Notify user about link."""
+        user = self.get_user(email)
+        if user is None:
+            print("user not found:", email)
+            return
+        link = self.create_link(user)
+        send_simple_login_email(user, link)
+
+    def get_user(self, email):
+        """Find the user with this email address."""
+        try:
+            return User.objects.get(email=email)
+        except User.DoesNotExist:
+            return None
+
+    def create_link(self, user):
+        """Create a login link for this user."""
+        link = reverse("sesame-login")
+        link = self.request.build_absolute_uri(link)
+        link += sesame.utils.get_query_string(user)
+        return link

InvenTree/InvenTree/management/commands/clean_settings.py

@@ -23,7 +23,7 @@ class Command(BaseCommand):
         for setting in db_settings:
             if setting.key not in model_settings:
                 setting.delete()
-                logger.info(f"deleted setting '{setting.key}'")
+                logger.info("deleted setting '%s'", setting.key)
 
         # user settings
         db_settings = InvenTreeUserSetting.objects.all()
@@ -33,6 +33,6 @@ class Command(BaseCommand):
         for setting in db_settings:
             if setting.key not in model_settings:
                 setting.delete()
-                logger.info(f"deleted user setting '{setting.key}'")
+                logger.info("deleted user setting '%s'", setting.key)
 
         logger.info("checked all settings")

InvenTree/InvenTree/management/commands/prerender.py

@@ -12,7 +12,6 @@ from django.utils.translation import override as lang_over
 
 def render_file(file_name, source, target, locales, ctx):
     """Renders a file into all provided locales."""
-
     for locale in locales:
 
         # Enforce lower-case for locale names
@@ -23,8 +22,8 @@ def render_file(file_name, source, target, locales, ctx):
 
         with open(target_file, 'w') as localised_file:
             with lang_over(locale):
-                renderd = render_to_string(os.path.join(source, file_name), ctx)
-                localised_file.write(renderd)
+                rendered = render_to_string(os.path.join(source, file_name), ctx)
+                localised_file.write(rendered)
 
 
 class Command(BaseCommand):

InvenTree/InvenTree/management/commands/rebuild_thumbnails.py

@@ -26,14 +26,14 @@ class Command(BaseCommand):
 
         img = model.image
 
-        logger.info(f"Generating thumbnail image for '{img}'")
+        logger.info("Generating thumbnail image for '%s'", img)
 
         try:
             model.image.render_variations(replace=False)
         except FileNotFoundError:
-            logger.warning(f"Warning: Image file '{img}' is missing")
+            logger.warning("Warning: Image file '%s' is missing", img)
         except UnidentifiedImageError:
-            logger.warning(f"Warning: Image file '{img}' is not a valid image")
+            logger.warning("Warning: Image file '%s' is not a valid image", img)
 
     def handle(self, *args, **kwargs):
         """Rebuild all thumbnail images."""
@@ -43,7 +43,7 @@ class Command(BaseCommand):
             try:
                 self.rebuild_thumbnail(part)
             except (OperationalError, ProgrammingError):
-                logger.error("ERROR: Database read error.")
+                logger.exception("ERROR: Database read error.")
                 break
 
         logger.info("Rebuilding Company thumbnails")
@@ -52,5 +52,5 @@ class Command(BaseCommand):
             try:
                 self.rebuild_thumbnail(company)
             except (OperationalError, ProgrammingError):
-                logger.error("ERROR: abase read error.")
+                logger.exception("ERROR: abase read error.")
                 break

InvenTree/InvenTree/management/commands/wait_for_db.py

@@ -18,7 +18,7 @@ class Command(BaseCommand):
 
         while not connected:
 
-            time.sleep(5)
+            time.sleep(2)
 
             try:
                 connection.ensure_connection()
@@ -34,4 +34,4 @@ class Command(BaseCommand):
                     self.stdout.write("Database configuration is not usable")
 
             if connected:
-                self.stdout.write("Database connection sucessful!")
+                self.stdout.write("Database connection successful!")

InvenTree/InvenTree/metadata.py

@@ -10,6 +10,7 @@ from rest_framework.utils import model_meta
 import InvenTree.permissions
 import users.models
 from InvenTree.helpers import str2bool
+from InvenTree.serializers import DependentField
 
 logger = logging.getLogger('inventree')
 
@@ -28,7 +29,7 @@ class InvenTreeMetadata(SimpleMetadata):
     """
 
     def determine_metadata(self, request, view):
-        """Overwrite the metadata to adapt to hte request user."""
+        """Overwrite the metadata to adapt to the request user."""
         self.request = request
         self.view = view
 
@@ -36,7 +37,7 @@ class InvenTreeMetadata(SimpleMetadata):
 
         """
         Custom context information to pass through to the OPTIONS endpoint,
-        if the "context=True" is supplied to the OPTIONS requst
+        if the "context=True" is supplied to the OPTIONS request
 
         Serializer class can supply context data by defining a get_context_data() method (no arguments)
         """
@@ -84,6 +85,10 @@ class InvenTreeMetadata(SimpleMetadata):
                 'DELETE': 'delete',
             }
 
+            # let the view define a custom rolemap
+            if hasattr(view, "rolemap"):
+                rolemap.update(view.rolemap)
+
             # Remove any HTTP methods that the user does not have permission for
             for method, permission in rolemap.items():
 
@@ -238,6 +243,10 @@ class InvenTreeMetadata(SimpleMetadata):
 
         We take the regular DRF metadata and add our own unique flavor
         """
+        # Try to add the child property to the dependent field to be used by the super call
+        if self.label_lookup[field] == 'dependent field':
+            field.get_child(raise_exception=True)
+
         # Run super method first
         field_info = super().get_field_info(field)
 
@@ -271,4 +280,11 @@ class InvenTreeMetadata(SimpleMetadata):
                 else:
                     field_info['api_url'] = model.get_api_url()
 
+        # Add more metadata about dependent fields
+        if field_info['type'] == 'dependent field':
+            field_info['depends_on'] = field.depends_on
+
         return field_info
+
+
+InvenTreeMetadata.label_lookup[DependentField] = "dependent field"

InvenTree/InvenTree/middleware.py

@@ -12,10 +12,9 @@ from django.urls import Resolver404, include, re_path, resolve, reverse_lazy
 from allauth_2fa.middleware import (AllauthTwoFactorMiddleware,
                                     BaseRequire2FAMiddleware)
 from error_report.middleware import ExceptionProcessor
-from rest_framework.authtoken.models import Token
 
-from common.models import InvenTreeSetting
 from InvenTree.urls import frontendpatterns
+from users.models import ApiToken
 
 logger = logging.getLogger("inventree")
 
@@ -65,6 +64,9 @@ class AuthRequiredMiddleware(object):
             elif request.path_info.startswith('/accounts/'):
                 authorized = True
 
+            elif request.path_info.startswith(f'/{settings.FRONTEND_URL_BASE}/') or request.path_info.startswith('/assets/') or request.path_info == f'/{settings.FRONTEND_URL_BASE}':
+                authorized = True
+
             elif 'Authorization' in request.headers.keys() or 'authorization' in request.headers.keys():
                 auth = request.headers.get('Authorization', request.headers.get('authorization')).strip()
 
@@ -73,14 +75,16 @@ class AuthRequiredMiddleware(object):
 
                     # Does the provided token match a valid user?
                     try:
-                        token = Token.objects.get(key=token_key)
+                        token = ApiToken.objects.get(key=token_key)
 
-                        # Provide the user information to the request
-                        request.user = token.user
-                        authorized = True
+                        if token.active and token.user:
 
-                    except Token.DoesNotExist:
-                        logger.warning(f"Access denied for unknown token {token_key}")
+                            # Provide the user information to the request
+                            request.user = token.user
+                            authorized = True
+
+                    except ApiToken.DoesNotExist:
+                        logger.warning("Access denied for unknown token %s", token_key)
 
             # No authorization was found for the request
             if not authorized:
@@ -102,14 +106,12 @@ class AuthRequiredMiddleware(object):
                     '/static/',
                 ]
 
-                if path not in urls and not any([path.startswith(p) for p in paths_ignore]):
+                if path not in urls and not any(path.startswith(p) for p in paths_ignore):
                     # Save the 'next' parameter to pass through to the login view
 
                     return redirect(f'{reverse_lazy("account_login")}?next={request.path}')
-
-                else:
-                    # Return a 401 (Unauthorized) response code for this request
-                    return HttpResponse('Unauthorized', status=401)
+                # Return a 401 (Unauthorized) response code for this request
+                return HttpResponse('Unauthorized', status=401)
 
         response = self.get_response(request)
 
@@ -123,6 +125,8 @@ class Check2FAMiddleware(BaseRequire2FAMiddleware):
     """Check if user is required to have MFA enabled."""
     def require_2fa(self, request):
         """Use setting to check if MFA should be enforced for frontend page."""
+        from common.models import InvenTreeSetting
+
         try:
             if url_matcher.resolve(request.path[1:]):
                 return InvenTreeSetting.get_setting('LOGIN_ENFORCE_MFA')
@@ -158,11 +162,38 @@ class InvenTreeExceptionProcessor(ExceptionProcessor):
     """Custom exception processor that respects blocked errors."""
 
     def process_exception(self, request, exception):
-        """Check if kind is ignored before procesing."""
+        """Check if kind is ignored before processing."""
         kind, info, data = sys.exc_info()
 
-        # Check if the eror is on the ignore list
+        # Check if the error is on the ignore list
         if kind in settings.IGNORED_ERRORS:
             return
 
-        return super().process_exception(request, exception)
+        import traceback
+
+        from django.views.debug import ExceptionReporter
+
+        from error_report.models import Error
+        from error_report.settings import ERROR_DETAIL_SETTINGS
+
+        # Error reporting is disabled
+        if not ERROR_DETAIL_SETTINGS.get('ERROR_DETAIL_ENABLE', True):
+            return
+
+        path = request.build_absolute_uri()
+
+        # Truncate the path to a reasonable length
+        # Otherwise we get a database error,
+        # because the path field is limited to 200 characters
+        if len(path) > 200:
+            path = path[:195] + '...'
+
+        error = Error.objects.create(
+            kind=kind.__name__,
+            html=ExceptionReporter(request, kind, info, data).get_traceback_html(),
+            path=path,
+            info=info,
+            data='\n'.join(traceback.format_exception(kind, info, data)),
+        )
+
+        error.save()

InvenTree/InvenTree/mixins.py

@@ -9,6 +9,59 @@ from InvenTree.fields import InvenTreeNotesField
 from InvenTree.helpers import remove_non_printable_characters, strip_html_tags
 
 
+class DiffMixin:
+    """Mixin which can be used to determine which fields have changed, compared to the instance saved to the database."""
+
+    def get_db_instance(self):
+        """Return the instance of the object saved in the database.
+
+        Returns:
+            object: Instance of the object saved in the database
+        """
+
+        if self.pk:
+            try:
+                return self.__class__.objects.get(pk=self.pk)
+            except self.__class__.DoesNotExist:
+                pass
+
+        return None
+
+    def get_field_deltas(self):
+        """Return a dict of field deltas.
+
+        Compares the current instance with the instance saved in the database,
+        and returns a dict of fields which have changed.
+
+        Returns:
+            dict: Dict of field deltas
+        """
+
+        db_instance = self.get_db_instance()
+
+        if db_instance is None:
+            return {}
+
+        deltas = {}
+
+        for field in self._meta.fields:
+            if field.name == 'id':
+                continue
+
+            if getattr(self, field.name) != getattr(db_instance, field.name):
+                deltas[field.name] = {
+                    'old': getattr(db_instance, field.name),
+                    'new': getattr(self, field.name),
+                }
+
+        return deltas
+
+    def has_field_changed(self, field_name):
+        """Determine if a particular field has changed."""
+
+        return field_name in self.get_field_deltas()
+
+
 class CleanMixin():
     """Model mixin class which cleans inputs using the Mozilla bleach tools."""
 
@@ -49,7 +102,6 @@ class CleanMixin():
         Ref: https://github.com/mozilla/bleach/issues/192
 
         """
-
         cleaned = strip_html_tags(data, field_name=field)
 
         # By default, newline characters are removed
@@ -88,12 +140,11 @@ class CleanMixin():
         `ugly`. Prevents XSS on the server-level.
 
         Args:
-            data (dict): Data that should be sanatized.
+            data (dict): Data that should be Sanitized.
 
         Returns:
-            dict: Provided data sanatized; still in the same order.
+            dict: Provided data Sanitized; still in the same order.
         """
-
         clean_data = {}
 
         for k, v in data.items():
@@ -125,7 +176,7 @@ class CreateAPI(CleanMixin, generics.CreateAPIView):
 
 
 class RetrieveAPI(generics.RetrieveAPIView):
-    """View for retreive API."""
+    """View for retrieve API."""
     pass
 
 

InvenTree/InvenTree/models.py

@@ -12,7 +12,7 @@ from django.contrib.auth.models import User
 from django.contrib.contenttypes.models import ContentType
 from django.core.exceptions import ValidationError
 from django.db import models
-from django.db.models.signals import post_save, pre_delete
+from django.db.models.signals import post_save
 from django.dispatch import receiver
 from django.urls import reverse
 from django.utils.translation import gettext_lazy as _
@@ -21,10 +21,10 @@ from error_report.models import Error
 from mptt.exceptions import InvalidMove
 from mptt.models import MPTTModel, TreeForeignKey
 
+import InvenTree.fields
 import InvenTree.format
 import InvenTree.helpers
-from common.models import InvenTreeSetting
-from InvenTree.fields import InvenTreeURLField
+import InvenTree.helpers_model
 from InvenTree.sanitizer import sanitize_svg
 
 logger = logging.getLogger('inventree')
@@ -44,13 +44,87 @@ def rename_attachment(instance, filename):
     return os.path.join(instance.getSubdir(), filename)
 
 
+class MetadataMixin(models.Model):
+    """Model mixin class which adds a JSON metadata field to a model, for use by any (and all) plugins.
+
+    The intent of this mixin is to provide a metadata field on a model instance,
+    for plugins to read / modify as required, to store any extra information.
+
+    The assumptions for models implementing this mixin are:
+
+    - The internal InvenTree business logic will make no use of this field
+    - Multiple plugins may read / write to this metadata field, and not assume they have sole rights
+    """
+
+    class Meta:
+        """Meta for MetadataMixin."""
+        abstract = True
+
+    def save(self, *args, **kwargs):
+        """Save the model instance, and perform validation on the metadata field."""
+        self.validate_metadata()
+        super().save(*args, **kwargs)
+
+    def clean(self, *args, **kwargs):
+        """Perform model validation on the metadata field."""
+        super().clean()
+
+        self.validate_metadata()
+
+    def validate_metadata(self):
+        """Validate the metadata field."""
+        # Ensure that the 'metadata' field is a valid dict object
+        if self.metadata is None:
+            self.metadata = {}
+
+        if type(self.metadata) is not dict:
+            raise ValidationError({'metadata': _('Metadata must be a python dict object')})
+
+    metadata = models.JSONField(
+        blank=True, null=True,
+        verbose_name=_('Plugin Metadata'),
+        help_text=_('JSON metadata field, for use by external plugins'),
+    )
+
+    def get_metadata(self, key: str, backup_value=None):
+        """Finds metadata for this model instance, using the provided key for lookup.
+
+        Args:
+            key: String key for requesting metadata. e.g. if a plugin is accessing the metadata, the plugin slug should be used
+
+        Returns:
+            Python dict object containing requested metadata. If no matching metadata is found, returns None
+        """
+        if self.metadata is None:
+            return backup_value
+
+        return self.metadata.get(key, backup_value)
+
+    def set_metadata(self, key: str, data, commit: bool = True, overwrite: bool = False):
+        """Save the provided metadata under the provided key.
+
+        Args:
+            key (str): Key for saving metadata
+            data (Any): Data object to save - must be able to be rendered as a JSON string
+            commit (bool, optional): If true, existing metadata with the provided key will be overwritten. If false, a merge will be attempted. Defaults to True.
+            overwrite (bool): If true, delete existing metadata before adding new value
+        """
+        if overwrite or self.metadata is None:
+            self.metadata = {}
+
+        self.metadata[key] = data
+
+        if commit:
+            self.save()
+
+
 class DataImportMixin(object):
     """Model mixin class which provides support for 'data import' functionality.
 
     Models which implement this mixin should provide information on the fields available for import
     """
 
-    # Define a map of fields avaialble for import
+    # Define a map of fields available for import
     IMPORT_FIELDS = {}
 
     @classmethod
@@ -127,11 +201,12 @@ class ReferenceIndexingMixin(models.Model):
 
         This is defined by a global setting object, specified by the REFERENCE_PATTERN_SETTING attribute
         """
-
         # By default, we return an empty string
         if cls.REFERENCE_PATTERN_SETTING is None:
             return ''
 
+        # import at function level to prevent cyclic imports
+        from common.models import InvenTreeSetting
         return InvenTreeSetting.get_setting(cls.REFERENCE_PATTERN_SETTING, create=False).strip()
 
     @classmethod
@@ -141,7 +216,6 @@ class ReferenceIndexingMixin(models.Model):
         - Returns a python dict object which contains the context data for formatting the reference string.
         - The default implementation provides some default context information
         """
-
         return {
             'ref': cls.get_next_reference(),
             'date': datetime.now(),
@@ -153,18 +227,15 @@ class ReferenceIndexingMixin(models.Model):
 
         In practice, this means the item with the highest reference value
         """
-
         query = cls.objects.all().order_by('-reference_int', '-pk')
 
         if query.exists():
             return query.first()
-        else:
-            return None
+        return None
 
     @classmethod
     def get_next_reference(cls):
         """Return the next available reference value for this particular class."""
-
         # Find the "most recent" item
         latest = cls.get_most_recent_item()
 
@@ -193,7 +264,6 @@ class ReferenceIndexingMixin(models.Model):
     @classmethod
     def generate_reference(cls):
         """Generate the next 'reference' field based on specified pattern"""
-
         fmt = cls.get_reference_pattern()
         ctx = cls.get_reference_context()
 
@@ -233,7 +303,6 @@ class ReferenceIndexingMixin(models.Model):
     @classmethod
     def validate_reference_pattern(cls, pattern):
         """Ensure that the provided pattern is valid"""
-
         ctx = cls.get_reference_context()
 
         try:
@@ -259,7 +328,6 @@ class ReferenceIndexingMixin(models.Model):
     @classmethod
     def validate_reference_field(cls, value):
         """Check that the provided 'reference' value matches the requisite pattern"""
-
         pattern = cls.get_reference_pattern()
 
         value = str(value).strip()
@@ -291,7 +359,6 @@ class ReferenceIndexingMixin(models.Model):
 
         If we cannot extract using the pattern for some reason, fallback to the entire reference
         """
-
         try:
             # Extract named group based on provided pattern
             reference = InvenTree.format.extract_named_group('ref', reference, cls.get_reference_pattern())
@@ -313,7 +380,6 @@ class ReferenceIndexingMixin(models.Model):
 
 def extract_int(reference, clip=0x7fffffff, allow_negative=False):
     """Extract an integer out of reference."""
-
     # Default value if we cannot convert to an integer
     ref_int = 0
 
@@ -363,7 +429,8 @@ class InvenTreeAttachment(models.Model):
     An attachment can be either an uploaded file, or an external URL
 
     Attributes:
-        attachment: File
+        attachment: Upload file
+        link: External URL
         comment: String descriptor for the attachment
         user: User associated with file upload
         upload_date: Date the file was uploaded
@@ -403,15 +470,14 @@ class InvenTreeAttachment(models.Model):
         """Human name for attachment."""
         if self.attachment is not None:
             return os.path.basename(self.attachment.name)
-        else:
-            return str(self.link)
+        return str(self.link)
 
     attachment = models.FileField(upload_to=rename_attachment, verbose_name=_('Attachment'),
                                   help_text=_('Select file to attach'),
                                   blank=True, null=True
                                   )
 
-    link = InvenTreeURLField(
+    link = InvenTree.fields.InvenTreeURLField(
         blank=True, null=True,
         verbose_name=_('Link'),
         help_text=_('Link to external URL')
@@ -434,8 +500,7 @@ class InvenTreeAttachment(models.Model):
         """Base name/path for attachment."""
         if self.attachment:
             return os.path.basename(self.attachment.name)
-        else:
-            return None
+        return None
 
     @basename.setter
     def basename(self, fn):
@@ -457,7 +522,7 @@ class InvenTreeAttachment(models.Model):
 
         # Check that there are no directory tricks going on...
         if new_file.parent != attachment_dir:
-            logger.error(f"Attempted to rename attachment outside valid directory: '{new_file}'")
+            logger.error("Attempted to rename attachment outside valid directory: '%s'", new_file)
             raise ValidationError(_("Invalid attachment directory"))
 
         # Ignore further checks if the filename is not actually being renamed
@@ -474,7 +539,7 @@ class InvenTreeAttachment(models.Model):
             raise ValidationError(_("Filename missing extension"))
 
         if not old_file.exists():
-            logger.error(f"Trying to rename attachment '{old_file}' which does not exist")
+            logger.error("Trying to rename attachment '%s' which does not exist", old_file)
             return
 
         if new_file.exists():
@@ -487,6 +552,21 @@ class InvenTreeAttachment(models.Model):
         except Exception:
             raise ValidationError(_("Error renaming file"))
 
+    def fully_qualified_url(self):
+        """Return a 'fully qualified' URL for this attachment.
+
+        - If the attachment is a link to an external resource, return the link
+        - If the attachment is an uploaded file, return the fully qualified media URL
+        """
+        if self.link:
+            return self.link
+
+        if self.attachment:
+            media_url = InvenTree.helpers.getMediaUrl(self.attachment.url)
+            return InvenTree.helpers_model.construct_absolute_url(media_url)
+
+        return ''
+
 
 class InvenTreeTree(MPTTModel):
     """Provides an abstracted self-referencing tree model for data categories.
@@ -500,6 +580,10 @@ class InvenTreeTree(MPTTModel):
         parent: The item immediately above this one. An item with a null parent is a top-level item
     """
 
+    # How items (not nodes) are hooked into the tree
+    # e.g. for StockLocation, this value is 'location'
+    ITEM_PARENT_KEY = None
+
     class Meta:
         """Metaclass defines extra model properties."""
         abstract = True
@@ -508,13 +592,130 @@ class InvenTreeTree(MPTTModel):
         """Set insert order."""
         order_insertion_by = ['name']
 
+    def delete(self, delete_children=False, delete_items=False):
+        """Handle the deletion of a tree node.
+
+        1. Update nodes and items under the current node
+        2. Delete this node
+        3. Rebuild the model tree
+        4. Rebuild the path for any remaining lower nodes
+        """
+        tree_id = self.tree_id if self.parent else None
+
+        # Ensure that we have the latest version of the database object
+        try:
+            self.refresh_from_db()
+        except self.__class__.DoesNotExist:
+            # If the object no longer exists, raise a ValidationError
+            raise ValidationError("Object %s of type %s no longer exists", str(self), str(self.__class__))
+
+        # Cache node ID values for lower nodes, before we delete this one
+        lower_nodes = list(self.get_descendants(include_self=False).values_list('pk', flat=True))
+
+        # 1. Update nodes and items under the current node
+        self.handle_tree_delete(delete_children=delete_children, delete_items=delete_items)
+
+        # 2. Delete *this* node
+        super().delete()
+
+        # 3. Update the tree structure
+        if tree_id:
+            self.__class__.objects.partial_rebuild(tree_id)
+        else:
+            self.__class__.objects.rebuild()
+
+        # 4. Rebuild the path for any remaining lower nodes
+        nodes = self.__class__.objects.filter(pk__in=lower_nodes)
+
+        nodes_to_update = []
+
+        for node in nodes:
+            new_path = node.construct_pathstring()
+
+            if new_path != node.pathstring:
+                node.pathstring = new_path
+                nodes_to_update.append(node)
+
+        if len(nodes_to_update) > 0:
+            self.__class__.objects.bulk_update(nodes_to_update, ['pathstring'])
+
+    def handle_tree_delete(self, delete_children=False, delete_items=False):
+        """Delete a single instance of the tree, based on provided kwargs.
+
+        Removing a tree "node" from the database must be considered carefully,
+        based on what the user intends for any items which exist *under* that node.
+
+        - "children" are any nodes which exist *under* this node (e.g. PartCategory)
+        - "items" are any items which exist *under* this node (e.g. Part)
+
+        Arguments:
+            delete_children: If True, delete all child items
+            delete_items: If True, delete all items associated with this node
+
+        There are multiple scenarios we can consider here:
+
+        A) delete_children = True and delete_items = True
+        B) delete_children = True and delete_items = False
+        C) delete_children = False and delete_items = True
+        D) delete_children = False and delete_items = False
+        """
+
+        child_nodes = self.get_descendants(include_self=False)
+
+        # Case A: Delete all child items, and all child nodes.
+        # - Delete all items at any lower level
+        # - Delete all descendant nodes
+        if delete_children and delete_items:
+            self.get_items(cascade=True).delete()
+            self.delete_nodes(child_nodes)
+
+        # Case B: Delete all child nodes, but move all child items up to the parent
+        # - Move all items at any lower level to the parent of this item
+        # - Delete all descendant nodes
+        elif delete_children and not delete_items:
+            self.get_items(cascade=True).update(**{
+                self.ITEM_PARENT_KEY: self.parent
+            })
+
+            self.delete_nodes(child_nodes)
+
+        # Case C: Delete all child items, but keep all child nodes
+        # - Remove all items directly associated with this node
+        # - Move any direct child nodes up one level
+        elif not delete_children and delete_items:
+            self.get_items(cascade=False).delete()
+            self.get_children().update(parent=self.parent)
+
+        # Case D: Keep all child items, and keep all child nodes
+        # - Move all items directly associated with this node up one level
+        # - Move any direct child nodes up one level
+        elif not delete_children and not delete_items:
+            self.get_items(cascade=False).update(**{
+                self.ITEM_PARENT_KEY: self.parent
+            })
+            self.get_children().update(parent=self.parent)
+
+    def delete_nodes(self, nodes):
+        """Delete  a set of nodes from the tree.
+
+        1. First, set the "parent" value for selected nodes to None
+        2. Then, perform bulk deletion of selected nodes
+
+        Step 1. is required because we cannot guarantee the order-of-operations in the db backend
+
+        Arguments:
+            nodes: A queryset of nodes to delete
+        """
+
+        nodes.update(parent=None)
+        nodes.delete()
+
     def validate_unique(self, exclude=None):
         """Validate that this tree instance satisfies our uniqueness requirements.
 
         Note that a 'unique_together' requirement for ('name', 'parent') is insufficient,
         as it ignores cases where parent=None (i.e. top-level items)
         """
-
         super().validate_unique(exclude)
 
         results = self.__class__.objects.filter(
@@ -535,9 +736,14 @@ class InvenTreeTree(MPTTModel):
             }
         }
 
+    def construct_pathstring(self):
+        """Construct the pathstring for this tree node"""
+        return InvenTree.helpers.constructPathString(
+            [item.name for item in self.path]
+        )
+
     def save(self, *args, **kwargs):
         """Custom save method for InvenTreeTree abstract model"""
-
         try:
             super().save(*args, **kwargs)
         except InvalidMove:
@@ -547,9 +753,7 @@ class InvenTreeTree(MPTTModel):
             })
 
         # Re-calculate the 'pathstring' field
-        pathstring = InvenTree.helpers.constructPathString(
-            [item.name for item in self.path]
-        )
+        pathstring = self.construct_pathstring()
 
         if pathstring != self.pathstring:
 
@@ -561,9 +765,20 @@ class InvenTreeTree(MPTTModel):
             self.pathstring = pathstring
             super().save(*args, **kwargs)
 
-            # Ensure that the pathstring changes are propagated down the tree also
-            for child in self.get_children():
-                child.save(*args, **kwargs)
+            # Update the pathstring for any child nodes
+            lower_nodes = self.get_descendants(include_self=False)
+
+            nodes_to_update = []
+
+            for node in lower_nodes:
+                new_path = node.construct_pathstring()
+
+                if new_path != node.pathstring:
+                    node.pathstring = new_path
+                    nodes_to_update.append(node)
+
+            if len(nodes_to_update) > 0:
+                self.__class__.objects.bulk_update(nodes_to_update, ['pathstring'])
 
     name = models.CharField(
         blank=False,
@@ -595,16 +810,15 @@ class InvenTreeTree(MPTTModel):
         help_text=_('Path')
     )
 
-    @property
-    def item_count(self):
-        """Return the number of items which exist *under* this node in the tree.
+    def get_items(self, cascade=False):
+        """Return a queryset of items which exist *under* this node in the tree.
 
-        Here an 'item' is considered to be the 'leaf' at the end of each branch,
-        and the exact nature here will depend on the class implementation.
+        - For a StockLocation instance, this would be a queryset of StockItem objects
+        - For a PartCategory instance, this would be a queryset of Part objects
 
-        The default implementation returns zero
+        The default implementation returns an empty list
         """
-        return 0
+        raise NotImplementedError(f"items() method not implemented for {type(self)}")
 
     def getUniqueParents(self):
         """Return a flat set of all parent items that exist above this node.
@@ -635,12 +849,12 @@ class InvenTreeTree(MPTTModel):
         available = contents.get_all_objects_for_this_type()
 
         # List of child IDs
-        childs = self.getUniqueChildren()
+        children = self.getUniqueChildren()
 
         acceptable = [None]
 
         for a in available:
-            if a.id not in childs:
+            if a.id not in children:
                 acceptable.append(a)
 
         return acceptable
@@ -652,7 +866,7 @@ class InvenTreeTree(MPTTModel):
         Returns:
             List of category names from the top level to the parent of this category
         """
-        return [a for a in self.get_ancestors()]
+        return list(self.get_ancestors())
 
     @property
     def path(self):
@@ -665,9 +879,47 @@ class InvenTreeTree(MPTTModel):
         """
         return self.parentpath + [self]
 
+    def get_path(self):
+        """Return a list of element in the item tree.
+
+        Contains the full path to this item, with each entry containing the following data:
+
+        {
+            pk: <pk>,
+            name: <name>,
+        }
+        """
+        return [
+            {
+                'pk': item.pk,
+                'name': item.name
+            } for item in self.path
+        ]
+
     def __str__(self):
         """String representation of a category is the full path to that category."""
-        return "{path} - {desc}".format(path=self.pathstring, desc=self.description)
+        return f"{self.pathstring} - {self.description}"
+
+
+class InvenTreeNotesMixin(models.Model):
+    """A mixin class for adding notes functionality to a model class.
+
+    The following fields are added to any model which implements this mixin:
+
+    - notes : A text field for storing notes
+    """
+
+    class Meta:
+        """Metaclass options for this mixin.
+
+        Note: abstract must be true, as this is only a mixin, not a separate table
+        """
+        abstract = True
+
+    notes = InvenTree.fields.InvenTreeNotesField(
+        verbose_name=_('Notes'),
+        help_text=_('Markdown notes (optional)'),
+    )
 
 
 class InvenTreeBarcodeMixin(models.Model):
@@ -706,34 +958,45 @@ class InvenTreeBarcodeMixin(models.Model):
     @classmethod
     def barcode_model_type(cls):
         """Return the model 'type' for creating a custom QR code."""
-
         # By default, use the name of the class
         return cls.__name__.lower()
 
     def format_barcode(self, **kwargs):
         """Return a JSON string for formatting a QR code for this model instance."""
-
         return InvenTree.helpers.MakeBarcode(
             self.__class__.barcode_model_type(),
             self.pk,
             **kwargs
         )
 
+    def format_matched_response(self):
+        """Format a standard response for a matched barcode."""
+
+        data = {
+            'pk': self.pk,
+        }
+
+        if hasattr(self, 'get_api_url'):
+            api_url = self.get_api_url()
+            data['api_url'] = f"{api_url}{self.pk}/"
+
+        if hasattr(self, 'get_absolute_url'):
+            data['web_url'] = self.get_absolute_url()
+
+        return data
+
     @property
     def barcode(self):
         """Format a minimal barcode string (e.g. for label printing)"""
-
         return self.format_barcode(brief=True)
 
     @classmethod
     def lookup_barcode(cls, barcode_hash):
         """Check if a model instance exists with the specified third-party barcode hash."""
-
         return cls.objects.filter(barcode_hash=barcode_hash).first()
 
     def assign_barcode(self, barcode_hash=None, barcode_data=None, raise_error=True, save=True):
         """Assign an external (third-party) barcode to this object."""
-
         # Must provide either barcode_hash or barcode_data
         if barcode_hash is None and barcode_data is None:
             raise ValueError("Provide either 'barcode_hash' or 'barcode_data'")
@@ -761,39 +1024,26 @@ class InvenTreeBarcodeMixin(models.Model):
 
     def unassign_barcode(self):
         """Unassign custom barcode from this model"""
-
         self.barcode_data = ''
         self.barcode_hash = ''
 
         self.save()
 
 
-@receiver(pre_delete, sender=InvenTreeTree, dispatch_uid='tree_pre_delete_log')
-def before_delete_tree_item(sender, instance, using, **kwargs):
-    """Receives pre_delete signal from InvenTreeTree object.
-
-    Before an item is deleted, update each child object to point to the parent of the object being deleted.
-    """
-    # Update each tree item below this one
-    for child in instance.children.all():
-        child.parent = instance.parent
-        child.save()
-
-
 @receiver(post_save, sender=Error, dispatch_uid='error_post_save_notification')
 def after_error_logged(sender, instance: Error, created: bool, **kwargs):
     """Callback when a server error is logged.
 
     - Send a UI notification to all users with staff status
     """
-
     if created:
         try:
+            import common.models
             import common.notifications
 
             users = get_user_model().objects.filter(is_staff=True)
 
-            link = InvenTree.helpers.construct_absolute_url(
+            link = InvenTree.helpers_model.construct_absolute_url(
                 reverse('admin:error_report_error_change', kwargs={'object_id': instance.pk})
             )
 
@@ -804,14 +1054,21 @@ def after_error_logged(sender, instance: Error, created: bool, **kwargs):
                 'link': link
             }
 
-            common.notifications.trigger_notification(
-                instance,
-                'inventree.error_log',
-                context=context,
-                targets=users,
-                delivery_methods=set([common.notifications.UIMessageNotification]),
-            )
+            target_users = []
+
+            for user in users:
+                if common.models.InvenTreeUserSetting.get_setting('NOTIFICATION_ERROR_REPORT', True, user=user):
+                    target_users.append(user)
+
+            if len(target_users) > 0:
+                common.notifications.trigger_notification(
+                    instance,
+                    'inventree.error_log',
+                    context=context,
+                    targets=target_users,
+                    delivery_methods={common.notifications.UIMessageNotification, },
+                )
 
         except Exception as exc:
             """We do not want to throw an exception while reporting an exception"""
-            logger.error(exc)
+            logger.error(exc)  # noqa: LOG005

InvenTree/InvenTree/permissions.py

@@ -9,7 +9,6 @@ import users.models
 
 def get_model_for_view(view, raise_error=True):
     """Attempt to introspect the 'model' type for an API view"""
-
     if hasattr(view, 'get_permission_model'):
         return view.get_permission_model()
 
@@ -62,6 +61,10 @@ class RolePermission(permissions.BasePermission):
             'DELETE': 'delete',
         }
 
+        # let the view define a custom rolemap
+        if hasattr(view, "rolemap"):
+            rolemap.update(view.rolemap)
+
         permission = rolemap[request.method]
 
         # The required role may be defined for the view class
@@ -92,6 +95,14 @@ class IsSuperuser(permissions.IsAdminUser):
         return bool(request.user and request.user.is_superuser)
 
 
+class IsStaffOrReadOnly(permissions.IsAdminUser):
+    """Allows read-only access to any user, but write access is restricted to staff users."""
+
+    def has_permission(self, request, view):
+        """Check if the user is a superuser."""
+        return bool(request.user and request.user.is_staff or request.method in permissions.SAFE_METHODS)
+
+
 def auth_exempt(view_func):
     """Mark a view function as being exempt from auth requirements."""
     def wrapped_view(*args, **kwargs):

InvenTree/InvenTree/ready.py

@@ -1,5 +1,6 @@
 """Functions to check if certain parts of InvenTree are ready."""
 
+import os
 import sys
 
 
@@ -13,6 +14,27 @@ def isImportingData():
     return 'loaddata' in sys.argv
 
 
+def isRunningMigrations():
+    """Return True if the database is currently running migrations."""
+    return any((x in sys.argv for x in [
+        'migrate',
+        'makemigrations',
+        'showmigrations'
+    ]))
+
+
+def isInMainThread():
+    """Django runserver starts two processes, one for the actual dev server and the other to reload the application.
+
+    - The RUN_MAIN env is set in that case. However if --noreload is applied, this variable
+    is not set because there are no different threads.
+    """
+    if "runserver" in sys.argv and "--noreload" not in sys.argv:
+        return os.environ.get('RUN_MAIN', None) == "true"
+
+    return True
+
+
 def canAppAccessDatabase(allow_test: bool = False, allow_plugins: bool = False, allow_shell: bool = False):
     """Returns True if the apps.py file can access database records.
 
@@ -51,6 +73,7 @@ def canAppAccessDatabase(allow_test: bool = False, allow_plugins: bool = False,
     if not allow_plugins:
         excluded_commands.extend([
             'makemigrations',
+            'showmigrations',
             'migrate',
             'collectstatic',
         ])
@@ -60,3 +83,19 @@ def canAppAccessDatabase(allow_test: bool = False, allow_plugins: bool = False,
             return False
 
     return True
+
+
+def isPluginRegistryLoaded():
+    """Ensures that the plugin registry is already loaded.
+
+    The plugin registry reloads all apps onetime after starting if there are AppMixin plugins,
+    so that the discovered AppConfigs are added to Django. This triggers the ready function of
+    AppConfig to execute twice. Add this check to prevent from running two times.
+
+    Note: All apps using this check need to be registered after the plugins app in settings.py
+
+    Returns: 'False' if the registry has not fully loaded the plugins yet.
+    """
+    from plugin import registry
+
+    return registry.plugins_loaded

InvenTree/InvenTree/sanitizer.py

@@ -43,8 +43,8 @@ ALLOWED_ATTRIBUTES_SVG = [
 ]
 
 
-def sanitize_svg(file_data: str, strip: bool = True, elements: str = ALLOWED_ELEMENTS_SVG, attributes: str = ALLOWED_ATTRIBUTES_SVG) -> str:
-    """Sanatize a SVG file.
+def sanitize_svg(file_data, strip: bool = True, elements: str = ALLOWED_ELEMENTS_SVG, attributes: str = ALLOWED_ATTRIBUTES_SVG) -> str:
+    """Sanitize a SVG file.
 
     Args:
         file_data (str): SVG as string.
@@ -55,6 +55,9 @@ def sanitize_svg(file_data: str, strip: bool = True, elements: str = ALLOWED_ELE
     Returns:
         str: Sanitzied SVG file.
     """
+    # Handle byte-encoded data
+    if isinstance(file_data, bytes):
+        file_data = file_data.decode('utf-8')
 
     cleaned = clean(
         file_data,
@@ -64,4 +67,5 @@ def sanitize_svg(file_data: str, strip: bool = True, elements: str = ALLOWED_ELE
         strip_comments=strip,
         css_sanitizer=CSSSanitizer()
     )
+
     return cleaned

InvenTree/InvenTree/sentry.py

@@ -0,0 +1,72 @@
+"""Configuration for Sentry.io error reporting."""
+
+import logging
+
+from django.conf import settings
+from django.core.exceptions import ValidationError
+from django.http import Http404
+
+import rest_framework.exceptions
+import sentry_sdk
+from sentry_sdk.integrations.django import DjangoIntegration
+
+import InvenTree.version
+
+logger = logging.getLogger('inventree')
+
+
+def default_sentry_dsn():
+    """Return the default Sentry.io DSN for InvenTree"""
+    return 'https://3928ccdba1d34895abde28031fd00100@o378676.ingest.sentry.io/6494600'
+
+
+def sentry_ignore_errors():
+    """Return a list of error types to ignore.
+
+    These error types will *not* be reported to sentry.io.
+    """
+    return [
+        Http404,
+        ValidationError,
+        rest_framework.exceptions.AuthenticationFailed,
+        rest_framework.exceptions.NotAuthenticated,
+        rest_framework.exceptions.PermissionDenied,
+        rest_framework.exceptions.ValidationError,
+    ]
+
+
+def init_sentry(dsn, sample_rate, tags):
+    """Initialize sentry.io error reporting"""
+    logger.info("Initializing sentry.io integration")
+
+    sentry_sdk.init(
+        dsn=dsn,
+        integrations=[DjangoIntegration()],
+        traces_sample_rate=sample_rate,
+        send_default_pii=True,
+        ignore_errors=sentry_ignore_errors(),
+        release=InvenTree.version.INVENTREE_SW_VERSION,
+        environment='development' if InvenTree.version.isInvenTreeDevelopmentVersion() else 'production'
+    )
+
+    for key, val in tags.items():
+        sentry_sdk.set_tag(f'inventree_{key}', val)
+
+    sentry_sdk.set_tag('api', InvenTree.version.inventreeApiVersion())
+    sentry_sdk.set_tag('platform', InvenTree.version.inventreePlatform())
+    sentry_sdk.set_tag('git_branch', InvenTree.version.inventreeBranch())
+    sentry_sdk.set_tag('git_commit', InvenTree.version.inventreeCommitHash())
+    sentry_sdk.set_tag('git_date', InvenTree.version.inventreeCommitDate())
+
+
+def report_exception(exc):
+    """Report an exception to sentry.io"""
+    if settings.SENTRY_ENABLED and settings.SENTRY_DSN:
+
+        if not any(isinstance(exc, e) for e in sentry_ignore_errors()):
+            logger.info("Reporting exception to sentry.io: %s", exc)
+
+            try:
+                sentry_sdk.capture_exception(exc)
+            except Exception:
+                logger.warning("Failed to report exception to sentry.io")

InvenTree/InvenTree/serializers.py

@@ -2,10 +2,12 @@
 
 import os
 from collections import OrderedDict
+from copy import deepcopy
 from decimal import Decimal
 
 from django.conf import settings
 from django.contrib.auth.models import User
+from django.contrib.sites.models import Site
 from django.core.exceptions import ValidationError as DjangoValidationError
 from django.db import models
 from django.utils.translation import gettext_lazy as _
@@ -15,15 +17,16 @@ from djmoney.contrib.django_rest_framework.fields import MoneyField
 from djmoney.money import Money
 from djmoney.utils import MONEY_CLASSES, get_currency_field_name
 from rest_framework import serializers
-from rest_framework.exceptions import ValidationError
+from rest_framework.exceptions import PermissionDenied, ValidationError
 from rest_framework.fields import empty
 from rest_framework.serializers import DecimalField
 from rest_framework.utils import model_meta
+from taggit.serializers import TaggitSerializer
 
-from common.models import InvenTreeSetting
+import common.models as common_models
 from common.settings import currency_code_default, currency_code_mappings
 from InvenTree.fields import InvenTreeRestURLField, InvenTreeURLField
-from InvenTree.helpers import download_image_from_url
+from InvenTree.helpers_model import download_image_from_url
 
 
 class InvenTreeMoneySerializer(MoneyField):
@@ -33,7 +36,7 @@ class InvenTreeMoneySerializer(MoneyField):
     """
 
     def __init__(self, *args, **kwargs):
-        """Overrite default values."""
+        """Override default values."""
         kwargs["max_digits"] = kwargs.get("max_digits", 19)
         self.decimal_places = kwargs["decimal_places"] = kwargs.get("decimal_places", 6)
         kwargs["required"] = kwargs.get("required", False)
@@ -42,7 +45,6 @@ class InvenTreeMoneySerializer(MoneyField):
 
     def get_value(self, data):
         """Test that the returned amount is a valid Decimal."""
-
         amount = super(DecimalField, self).get_value(data)
 
         # Convert an empty string to None
@@ -72,11 +74,17 @@ class InvenTreeCurrencySerializer(serializers.ChoiceField):
 
     def __init__(self, *args, **kwargs):
         """Initialize the currency serializer"""
+        choices = currency_code_mappings()
 
-        kwargs['choices'] = currency_code_mappings()
+        allow_blank = kwargs.get('allow_blank', False) or kwargs.get('allow_null', False)
+
+        if allow_blank:
+            choices = [('', '---------')] + choices
+
+        kwargs['choices'] = choices
 
         if 'default' not in kwargs and 'required' not in kwargs:
-            kwargs['default'] = currency_code_default
+            kwargs['default'] = '' if allow_blank else currency_code_default
 
         if 'label' not in kwargs:
             kwargs['label'] = _('Currency')
@@ -87,6 +95,93 @@ class InvenTreeCurrencySerializer(serializers.ChoiceField):
         super().__init__(*args, **kwargs)
 
 
+class DependentField(serializers.Field):
+    """A dependent field can be used to dynamically return child fields based on the value of other fields."""
+    child = None
+
+    def __init__(self, *args, depends_on, field_serializer, **kwargs):
+        """A dependent field can be used to dynamically return child fields based on the value of other fields.
+
+        Example:
+        This example adds two fields. If the client selects integer, an integer field will be shown, but if he
+        selects char, an char field will be shown. For any other value, nothing will be shown.
+
+        class TestSerializer(serializers.Serializer):
+            select_type = serializers.ChoiceField(choices=[
+                ("integer", "Integer"),
+                ("char", "Char"),
+            ])
+            my_field = DependentField(depends_on=["select_type"], field_serializer="get_my_field")
+
+            def get_my_field(self, fields):
+                if fields["select_type"] == "integer":
+                    return serializers.IntegerField()
+                if fields["select_type"] == "char":
+                    return serializers.CharField()
+        """
+        super().__init__(*args, **kwargs)
+
+        self.depends_on = depends_on
+        self.field_serializer = field_serializer
+
+    def get_child(self, raise_exception=False):
+        """This method tries to extract the child based on the provided data in the request by the client."""
+        data = deepcopy(self.context["request"].data)
+
+        def visit_parent(node):
+            """Recursively extract the data for the parent field/serializer in reverse."""
+            nonlocal data
+
+            if node.parent:
+                visit_parent(node.parent)
+
+            # only do for composite fields and stop right before the current field
+            if hasattr(node, "child") and node is not self and isinstance(data, dict):
+                data = data.get(node.field_name, None)
+        visit_parent(self)
+
+        # ensure that data is a dictionary and that a parent exists
+        if not isinstance(data, dict) or self.parent is None:
+            return
+
+        # check if the request data contains the dependent fields, otherwise skip getting the child
+        for f in self.depends_on:
+            if not data.get(f, None):
+                return
+
+        # partially validate the data for options requests that set raise_exception while calling .get_child(...)
+        if raise_exception:
+            validation_data = {k: v for k, v in data.items() if k in self.depends_on}
+            serializer = self.parent.__class__(context=self.context, data=validation_data, partial=True)
+            serializer.is_valid(raise_exception=raise_exception)
+
+        # try to get the field serializer
+        field_serializer = getattr(self.parent, self.field_serializer)
+        child = field_serializer(data)
+
+        if not child:
+            return
+
+        self.child = child
+        self.child.bind(field_name='', parent=self)
+
+    def to_internal_value(self, data):
+        """This method tries to convert the data to an internal representation based on the defined to_internal_value method on the child."""
+        self.get_child()
+        if self.child:
+            return self.child.to_internal_value(data)
+
+        return None
+
+    def to_representation(self, value):
+        """This method tries to convert the data to representation based on the defined to_representation method on the child."""
+        self.get_child()
+        if self.child:
+            return self.child.to_representation(value)
+
+        return None
+
+
 class InvenTreeModelSerializer(serializers.ModelSerializer):
     """Inherits the standard Django ModelSerializer class, but also ensures that the underlying model class data are checked on validation."""
 
@@ -189,7 +284,6 @@ class InvenTreeModelSerializer(serializers.ModelSerializer):
 
     def create(self, validated_data):
         """Custom create method which supports field adjustment"""
-
         initial_data = validated_data.copy()
 
         # Remove any fields which do not exist on the model
@@ -213,7 +307,6 @@ class InvenTreeModelSerializer(serializers.ModelSerializer):
         In addition to running validators on the serializer fields,
         this class ensures that the underlying model is also validated.
         """
-
         # Run any native validation checks first (may raise a ValidationError)
         data = super().run_validation(data)
 
@@ -257,6 +350,28 @@ class InvenTreeModelSerializer(serializers.ModelSerializer):
         return data
 
 
+class InvenTreeTaggitSerializer(TaggitSerializer):
+    """Updated from https://github.com/glemmaPaul/django-taggit-serializer."""
+
+    def update(self, instance, validated_data):
+        """Overridden update method to re-add the tagmanager."""
+        to_be_tagged, validated_data = self._pop_tags(validated_data)
+
+        tag_object = super().update(instance, validated_data)
+
+        for key in to_be_tagged.keys():
+            # re-add the tagmanager
+            new_tagobject = tag_object.__class__.objects.get(id=tag_object.id)
+            setattr(tag_object, key, getattr(new_tagobject, key))
+
+        return self._save_tags(tag_object, to_be_tagged)
+
+
+class InvenTreeTagModelSerializer(InvenTreeTaggitSerializer, InvenTreeModelSerializer):
+    """Combination of InvenTreeTaggitSerializer and InvenTreeModelSerializer."""
+    pass
+
+
 class UserSerializer(InvenTreeModelSerializer):
     """Serializer for a User."""
 
@@ -268,9 +383,79 @@ class UserSerializer(InvenTreeModelSerializer):
             'username',
             'first_name',
             'last_name',
-            'email'
+            'email',
         ]
 
+        read_only_fields = [
+            'username',
+        ]
+
+
+class ExendedUserSerializer(UserSerializer):
+    """Serializer for a User with a bit more info."""
+    from users.serializers import GroupSerializer
+
+    groups = GroupSerializer(read_only=True, many=True)
+
+    class Meta(UserSerializer.Meta):
+        """Metaclass defines serializer fields."""
+        fields = UserSerializer.Meta.fields + [
+            'groups',
+            'is_staff',
+            'is_superuser',
+            'is_active'
+        ]
+
+        read_only_fields = UserSerializer.Meta.read_only_fields + [
+            'groups',
+        ]
+
+    def validate(self, attrs):
+        """Expanded validation for changing user role."""
+        # Check if is_staff or is_superuser is in attrs
+        role_change = 'is_staff' in attrs or 'is_superuser' in attrs
+        request_user = self.context['request'].user
+
+        if role_change:
+            if request_user.is_superuser:
+                # Superusers can change any role
+                pass
+            elif request_user.is_staff and 'is_superuser' not in attrs:
+                # Staff can change any role except is_superuser
+                pass
+            else:
+                raise PermissionDenied(_("You do not have permission to change this user role."))
+        return super().validate(attrs)
+
+
+class UserCreateSerializer(ExendedUserSerializer):
+    """Serializer for creating a new User."""
+    def validate(self, attrs):
+        """Expanded valiadation for auth."""
+        # Check that the user trying to create a new user is a superuser
+        if not self.context['request'].user.is_superuser:
+            raise serializers.ValidationError(_("Only superusers can create new users"))
+
+        # Generate a random password
+        password = User.objects.make_random_password(length=14)
+        attrs.update({'password': password})
+        return super().validate(attrs)
+
+    def create(self, validated_data):
+        """Send an e email to the user after creation."""
+        instance = super().create(validated_data)
+
+        # Make sure the user cannot login until they have set a password
+        instance.set_unusable_password()
+        # Send the user an onboarding email (from current site)
+        current_site = Site.objects.get_current()
+        domain = current_site.domain
+        instance.email_user(
+            subject=_(f"Welcome to {current_site.name}"),
+            message=_(f"Your account has been created.\n\nPlease use the password reset function to get access (at https://{domain})."),
+        )
+        return instance
+
 
 class InvenTreeAttachmentSerializerField(serializers.FileField):
     """Override the DRF native FileField serializer, to remove the leading server path.
@@ -492,7 +677,7 @@ class DataFileUploadSerializer(serializers.Serializer):
                 pass
 
         # Extract a list of valid model field names
-        model_field_names = [key for key in model_fields.keys()]
+        model_field_names = list(model_fields.keys())
 
         # Provide a dict of available columns from the dataset
         file_columns = {}
@@ -671,7 +856,6 @@ class RemoteImageMixin(metaclass=serializers.SerializerMetaclass):
 
     def skip_create_fields(self):
         """Ensure the 'remote_image' field is skipped when creating a new instance"""
-
         return [
             'remote_image',
         ]
@@ -680,7 +864,7 @@ class RemoteImageMixin(metaclass=serializers.SerializerMetaclass):
         required=False,
         allow_blank=False,
         write_only=True,
-        label=_("URL"),
+        label=_("Remote Image"),
         help_text=_("URL of remote image file"),
     )
 
@@ -690,11 +874,10 @@ class RemoteImageMixin(metaclass=serializers.SerializerMetaclass):
         - Attempt to download the image and store it against this object instance
         - Catches and re-throws any errors
         """
-
         if not url:
             return
 
-        if not InvenTreeSetting.get_setting('INVENTREE_DOWNLOAD_FROM_URL'):
+        if not common_models.InvenTreeSetting.get_setting('INVENTREE_DOWNLOAD_FROM_URL'):
             raise ValidationError(_("Downloading images from remote URL is not enabled"))
 
         try:

InvenTree/InvenTree/settings.py

@@ -17,20 +17,25 @@ from pathlib import Path
 
 import django.conf.locale
 import django.core.exceptions
+from django.core.validators import URLValidator
 from django.http import Http404
 from django.utils.translation import gettext_lazy as _
 
 import moneyed
-import sentry_sdk
-from sentry_sdk.integrations.django import DjangoIntegration
+from dotenv import load_dotenv
+
+from InvenTree.config import get_boolean_setting, get_custom_file, get_setting
+from InvenTree.sentry import default_sentry_dsn, init_sentry
+from InvenTree.version import checkMinPythonVersion, inventreeApiVersion
 
 from . import config
-from .config import get_boolean_setting, get_custom_file, get_setting
+
+checkMinPythonVersion()
 
 INVENTREE_NEWS_URL = 'https://inventree.org/news/feed.atom'
 
 # Determine if we are running in "test" mode e.g. "manage.py test"
-TESTING = 'test' in sys.argv
+TESTING = 'test' in sys.argv or 'TESTING' in os.environ
 
 if TESTING:
 
@@ -63,10 +68,19 @@ BASE_DIR = config.get_base_dir()
 # Load configuration data
 CONFIG = config.load_config_data(set_cache=True)
 
+# Load VERSION data if it exists
+version_file = BASE_DIR.parent.joinpath('VERSION')
+if version_file.exists():
+    print('load version from file')
+    load_dotenv(version_file)
+
 # Default action is to run the system in Debug mode
 # SECURITY WARNING: don't run with debug turned on in production!
 DEBUG = get_boolean_setting('INVENTREE_DEBUG', 'debug', True)
 
+ENABLE_CLASSIC_FRONTEND = get_boolean_setting('INVENTREE_CLASSIC_FRONTEND', 'classic_frontend', True)
+ENABLE_PLATFORM_FRONTEND = get_boolean_setting('INVENTREE_PLATFORM_FRONTEND', 'platform_frontend', True)
+
 # Configure logging settings
 log_level = get_setting('INVENTREE_LOG_LEVEL', 'log_level', 'WARNING')
 
@@ -97,6 +111,14 @@ LOGGING = {
     },
 }
 
+# Optionally add database-level logging
+if get_setting('INVENTREE_DB_LOGGING', 'db_logging', False):
+    LOGGING['loggers'] = {
+        'django.db.backends': {
+            'level': log_level or 'DEBUG',
+        },
+    }
+
 # Get a logger instance for this setup file
 logger = logging.getLogger("inventree")
 
@@ -119,8 +141,8 @@ ALLOWED_HOSTS = get_setting(
 
 # Cross Origin Resource Sharing (CORS) options
 
-# Only allow CORS access to API
-CORS_URLS_REGEX = r'^/api/.*$'
+# Only allow CORS access to API and media endpoints
+CORS_URLS_REGEX = r'^/(api|media|static)/.*$'
 
 # Extract CORS options from configuration file
 CORS_ORIGIN_ALLOW_ALL = get_boolean_setting(
@@ -177,7 +199,18 @@ if DBBACKUP_STORAGE_OPTIONS is None:
         'location': config.get_backup_dir(),
     }
 
-# Application definition
+INVENTREE_ADMIN_ENABLED = get_boolean_setting(
+    'INVENTREE_ADMIN_ENABLED',
+    config_key='admin_enabled',
+    default_value=True
+)
+
+# Base URL for admin pages (default="admin")
+INVENTREE_ADMIN_URL = get_setting(
+    'INVENTREE_ADMIN_URL',
+    config_key='admin_url',
+    default_value='admin'
+)
 
 INSTALLED_APPS = [
     # Admin site integration
@@ -187,13 +220,15 @@ INSTALLED_APPS = [
     'build.apps.BuildConfig',
     'common.apps.CommonConfig',
     'company.apps.CompanyConfig',
+    'plugin.apps.PluginAppConfig',          # Plugin app runs before all apps that depend on the isPluginRegistryLoaded function
     'label.apps.LabelConfig',
     'order.apps.OrderConfig',
     'part.apps.PartConfig',
     'report.apps.ReportConfig',
     'stock.apps.StockConfig',
     'users.apps.UsersConfig',
-    'plugin.apps.PluginAppConfig',
+    'web',
+    'generic',
     'InvenTree.apps.InvenTreeConfig',       # InvenTree app runs last
 
     # Core django modules
@@ -210,7 +245,6 @@ INSTALLED_APPS = [
     # Third part add-ons
     'django_filters',                       # Extended filter functionality
     'rest_framework',                       # DRF (Django Rest Framework)
-    'rest_framework.authtoken',             # Token authentication for API
     'corsheaders',                          # Cross-origin Resource Sharing for DRF
     'crispy_forms',                         # Improved form rendering
     'import_export',                        # Import / export tables to file
@@ -223,6 +257,8 @@ INSTALLED_APPS = [
     'django_q',
     'formtools',                            # Form wizard tools
     'dbbackup',                             # Backups - django-dbbackup
+    'taggit',                               # Tagging
+    'flags',                                # Flagging - django-flags
 
     'allauth',                              # Base app for SSO
     'allauth.account',                      # Extend user with accounts
@@ -233,6 +269,9 @@ INSTALLED_APPS = [
     'django_otp.plugins.otp_static',        # Backup codes
 
     'allauth_2fa',                          # MFA flow for allauth
+    'dj_rest_auth',                         # Authentication APIs - dj-rest-auth
+    'dj_rest_auth.registration',            # Registration APIs - dj-rest-auth'
+    'drf_spectacular',                      # API documentation
 
     'django_ical',                          # For exporting calendars
 ]
@@ -249,6 +288,7 @@ MIDDLEWARE = CONFIG.get('middleware', [
     'InvenTree.middleware.InvenTreeRemoteUserMiddleware',       # Remote / proxy auth
     'django_otp.middleware.OTPMiddleware',                      # MFA support
     'InvenTree.middleware.CustomAllauthTwoFactorMiddleware',    # Flow control for allauth
+    'allauth.account.middleware.AccountMiddleware',
     'django.contrib.messages.middleware.MessageMiddleware',
     'django.middleware.clickjacking.XFrameOptionsMiddleware',
     'InvenTree.middleware.AuthRequiredMiddleware',
@@ -261,8 +301,77 @@ AUTHENTICATION_BACKENDS = CONFIG.get('authentication_backends', [
     'django.contrib.auth.backends.RemoteUserBackend',           # proxy login
     'django.contrib.auth.backends.ModelBackend',
     'allauth.account.auth_backends.AuthenticationBackend',      # SSO login via external providers
+    "sesame.backends.ModelBackend",                             # Magic link login django-sesame
 ])
 
+# LDAP support
+LDAP_AUTH = get_boolean_setting("INVENTREE_LDAP_ENABLED", "ldap.enabled", False)
+if LDAP_AUTH:
+    import ldap
+    from django_auth_ldap.config import GroupOfUniqueNamesType, LDAPSearch
+
+    AUTHENTICATION_BACKENDS.append("django_auth_ldap.backend.LDAPBackend")
+
+    # debug mode to troubleshoot configuration
+    LDAP_DEBUG = get_boolean_setting("INVENTREE_LDAP_DEBUG", "ldap.debug", False)
+    if LDAP_DEBUG:
+        if "loggers" not in LOGGING:
+            LOGGING["loggers"] = {}
+        LOGGING["loggers"]["django_auth_ldap"] = {"level": "DEBUG", "handlers": ["console"]}
+
+    # get global options from dict and use ldap.OPT_* as keys and values
+    global_options_dict = get_setting("INVENTREE_LDAP_GLOBAL_OPTIONS", "ldap.global_options", {}, dict)
+    global_options = {}
+    for k, v in global_options_dict.items():
+        # keys are always ldap.OPT_* constants
+        k_attr = getattr(ldap, k, None)
+        if not k.startswith("OPT_") or k_attr is None:
+            print(f"[LDAP] ldap.global_options, key '{k}' not found, skipping...")
+            continue
+
+        # values can also be other strings, e.g. paths
+        v_attr = v
+        if v.startswith("OPT_"):
+            v_attr = getattr(ldap, v, None)
+
+        if v_attr is None:
+            print(f"[LDAP] ldap.global_options, value key '{v}' not found, skipping...")
+            continue
+
+        global_options[k_attr] = v_attr
+    AUTH_LDAP_GLOBAL_OPTIONS = global_options
+    if LDAP_DEBUG:
+        print("[LDAP] ldap.global_options =", global_options)
+
+    AUTH_LDAP_SERVER_URI = get_setting("INVENTREE_LDAP_SERVER_URI", "ldap.server_uri")
+    AUTH_LDAP_START_TLS = get_boolean_setting("INVENTREE_LDAP_START_TLS", "ldap.start_tls", False)
+    AUTH_LDAP_BIND_DN = get_setting("INVENTREE_LDAP_BIND_DN", "ldap.bind_dn")
+    AUTH_LDAP_BIND_PASSWORD = get_setting("INVENTREE_LDAP_BIND_PASSWORD", "ldap.bind_password")
+    AUTH_LDAP_USER_SEARCH = LDAPSearch(
+        get_setting("INVENTREE_LDAP_SEARCH_BASE_DN", "ldap.search_base_dn"),
+        ldap.SCOPE_SUBTREE,
+        str(get_setting("INVENTREE_LDAP_SEARCH_FILTER_STR", "ldap.search_filter_str", "(uid= %(user)s)"))
+    )
+    AUTH_LDAP_USER_DN_TEMPLATE = get_setting("INVENTREE_LDAP_USER_DN_TEMPLATE", "ldap.user_dn_template")
+    AUTH_LDAP_USER_ATTR_MAP = get_setting("INVENTREE_LDAP_USER_ATTR_MAP", "ldap.user_attr_map", {
+        'first_name': 'givenName',
+        'last_name': 'sn',
+        'email': 'mail',
+    }, dict)
+    AUTH_LDAP_ALWAYS_UPDATE_USER = get_boolean_setting("INVENTREE_LDAP_ALWAYS_UPDATE_USER", "ldap.always_update_user", True)
+    AUTH_LDAP_CACHE_TIMEOUT = get_setting("INVENTREE_LDAP_CACHE_TIMEOUT", "ldap.cache_timeout", 3600, int)
+
+    AUTH_LDAP_GROUP_SEARCH = LDAPSearch(
+        get_setting("INVENTREE_LDAP_GROUP_SEARCH", "ldap.group_search"),
+        ldap.SCOPE_SUBTREE,
+        "(objectClass=groupOfUniqueNames)",
+    )
+    AUTH_LDAP_GROUP_TYPE = GroupOfUniqueNamesType(name_attr="cn")
+    AUTH_LDAP_REQUIRE_GROUP = get_setting("INVENTREE_LDAP_REQUIRE_GROUP", "ldap.require_group")
+    AUTH_LDAP_DENY_GROUP = get_setting("INVENTREE_LDAP_DENY_GROUP", "ldap.deny_group")
+    AUTH_LDAP_USER_FLAGS_BY_GROUP = get_setting("INVENTREE_LDAP_USER_FLAGS_BY_GROUP", "ldap.user_flags_by_group", {}, dict)
+    AUTH_LDAP_FIND_GROUP_PERMS = True
+
 DEBUG_TOOLBAR_ENABLED = DEBUG and get_setting('INVENTREE_DEBUG_TOOLBAR', 'debug_toolbar', False)
 
 # If the debug toolbar is enabled, add the modules
@@ -294,14 +403,6 @@ if DEBUG:
     INSTALLED_APPS.append('sslserver')
 
 # InvenTree URL configuration
-
-# Base URL for admin pages (default="admin")
-INVENTREE_ADMIN_URL = get_setting(
-    'INVENTREE_ADMIN_URL',
-    config_key='admin_url',
-    default_value='admin'
-)
-
 ROOT_URLCONF = 'InvenTree.urls'
 
 TEMPLATES = [
@@ -326,7 +427,7 @@ TEMPLATES = [
                 'InvenTree.context.user_roles',
             ],
             'loaders': [(
-                'django.template.loaders.cached.Loader', [
+                'InvenTree.template.InvenTreeTemplateLoader', [
                     'plugin.template.PluginTemplateLoader',
                     'django.template.loaders.filesystem.Loader',
                     'django.template.loaders.app_directories.Loader',
@@ -348,7 +449,7 @@ REST_FRAMEWORK = {
     'DEFAULT_AUTHENTICATION_CLASSES': (
         'rest_framework.authentication.BasicAuthentication',
         'rest_framework.authentication.SessionAuthentication',
-        'rest_framework.authentication.TokenAuthentication',
+        'users.authentication.ApiTokenAuthentication',
     ),
     'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.LimitOffsetPagination',
     'DEFAULT_PERMISSION_CLASSES': (
@@ -356,17 +457,44 @@ REST_FRAMEWORK = {
         'rest_framework.permissions.DjangoModelPermissions',
         'InvenTree.permissions.RolePermission',
     ),
-    'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.coreapi.AutoSchema',
+    'DEFAULT_SCHEMA_CLASS': 'drf_spectacular.openapi.AutoSchema',
     'DEFAULT_METADATA_CLASS': 'InvenTree.metadata.InvenTreeMetadata',
     'DEFAULT_RENDERER_CLASSES': [
         'rest_framework.renderers.JSONRenderer',
-    ]
+    ],
+    'TOKEN_MODEL': 'users.models.ApiToken',
 }
 
 if DEBUG:
     # Enable browsable API if in DEBUG mode
     REST_FRAMEWORK['DEFAULT_RENDERER_CLASSES'].append('rest_framework.renderers.BrowsableAPIRenderer')
 
+# dj-rest-auth
+# JWT switch
+USE_JWT = get_boolean_setting('INVENTREE_USE_JWT', 'use_jwt', False)
+REST_USE_JWT = USE_JWT
+OLD_PASSWORD_FIELD_ENABLED = True
+REST_AUTH_REGISTER_SERIALIZERS = {'REGISTER_SERIALIZER': 'InvenTree.forms.CustomRegisterSerializer'}
+
+# JWT settings - rest_framework_simplejwt
+if USE_JWT:
+    JWT_AUTH_COOKIE = 'inventree-auth'
+    JWT_AUTH_REFRESH_COOKIE = 'inventree-token'
+    REST_FRAMEWORK['DEFAULT_AUTHENTICATION_CLASSES'] + (
+        'dj_rest_auth.jwt_auth.JWTCookieAuthentication',
+    )
+    INSTALLED_APPS.append('rest_framework_simplejwt')
+
+# WSGI default setting
+SPECTACULAR_SETTINGS = {
+    'TITLE': 'InvenTree API',
+    'DESCRIPTION': 'API for InvenTree - the intuitive open source inventory management system',
+    'LICENSE': {'MIT': 'https://github.com/inventree/InvenTree/blob/master/LICENSE'},
+    'EXTERNAL_DOCS': {'docs': 'https://docs.inventree.org', 'web': 'https://inventree.org'},
+    'VERSION': inventreeApiVersion(),
+    'SERVE_INCLUDE_SCHEMA': False,
+}
+
 WSGI_APPLICATION = 'InvenTree.wsgi.application'
 
 """
@@ -400,7 +528,7 @@ for key in db_keys:
             try:
                 env_var = int(env_var)
             except ValueError:
-                logger.error(f"Invalid number for {env_key}: {env_var}")
+                logger.exception("Invalid number for %s: %s", env_key, env_var)
         # Override configuration value
         db_config[key] = env_var
 
@@ -441,9 +569,9 @@ if 'sqlite' in db_engine:
     db_name = str(Path(db_name).resolve())
     db_config['NAME'] = db_name
 
-logger.info(f"DB_ENGINE: {db_engine}")
-logger.info(f"DB_NAME: {db_name}")
-logger.info(f"DB_HOST: {db_host}")
+logger.info("DB_ENGINE: %s", db_engine)
+logger.info("DB_NAME: %s", db_name)
+logger.info("DB_HOST: %s", db_host)
 
 """
 In addition to base-level database configuration, we may wish to specify specific options to the database backend
@@ -467,7 +595,7 @@ if "postgres" in db_engine:  # pragma: no cover
     if "connect_timeout" not in db_options:
         # The DB server is in the same data center, it should not take very
         # long to connect to the database server
-        # # seconds, 2 is minium allowed by libpq
+        # # seconds, 2 is minimum allowed by libpq
         db_options["connect_timeout"] = int(
             get_setting('INVENTREE_DB_TIMEOUT', 'database.timeout', 2)
         )
@@ -562,29 +690,21 @@ REMOTE_LOGIN_HEADER = get_setting('INVENTREE_REMOTE_LOGIN_HEADER', 'remote_login
 
 # sentry.io integration for error reporting
 SENTRY_ENABLED = get_boolean_setting('INVENTREE_SENTRY_ENABLED', 'sentry_enabled', False)
-# Default Sentry DSN (can be overriden if user wants custom sentry integration)
-INVENTREE_DSN = 'https://3928ccdba1d34895abde28031fd00100@o378676.ingest.sentry.io/6494600'
-SENTRY_DSN = get_setting('INVENTREE_SENTRY_DSN', 'sentry_dsn', INVENTREE_DSN)
+
+# Default Sentry DSN (can be overridden if user wants custom sentry integration)
+SENTRY_DSN = get_setting('INVENTREE_SENTRY_DSN', 'sentry_dsn', default_sentry_dsn())
 SENTRY_SAMPLE_RATE = float(get_setting('INVENTREE_SENTRY_SAMPLE_RATE', 'sentry_sample_rate', 0.1))
 
 if SENTRY_ENABLED and SENTRY_DSN:  # pragma: no cover
 
-    logger.info("Running with sentry.io integration enabled")
-
-    sentry_sdk.init(
-        dsn=SENTRY_DSN,
-        integrations=[DjangoIntegration(), ],
-        traces_sample_rate=1.0 if DEBUG else SENTRY_SAMPLE_RATE,
-        send_default_pii=True
-    )
     inventree_tags = {
         'testing': TESTING,
         'docker': DOCKER,
         'debug': DEBUG,
         'remote': REMOTE_LOGIN,
     }
-    for key, val in inventree_tags.items():
-        sentry_sdk.set_tag(f'inventree_{key}', val)
+
+    init_sentry(SENTRY_DSN, SENTRY_SAMPLE_RATE, inventree_tags)
 
 # Cache configuration
 cache_host = get_setting('INVENTREE_CACHE_HOST', 'cache.host', None)
@@ -593,7 +713,7 @@ cache_port = get_setting('INVENTREE_CACHE_PORT', 'cache.port', '6379', typecast=
 if cache_host:  # pragma: no cover
     # We are going to rely upon a possibly non-localhost for our cache,
     # so don't wait too long for the cache as nothing in the cache should be
-    # irreplacable.
+    # irreplaceable.
     _cache_options = {
         "CLIENT_CLASS": "django_redis.client.DefaultClient",
         "SOCKET_CONNECT_TIMEOUT": int(os.getenv("CACHE_CONNECT_TIMEOUT", "2")),
@@ -648,6 +768,7 @@ Q_CLUSTER = {
     'orm': 'default',
     'cache': 'default',
     'sync': False,
+    'poll': 1.5,
 }
 
 # Configure django-q sentry integration
@@ -704,7 +825,12 @@ LANGUAGE_CODE = get_setting('INVENTREE_LANGUAGE', 'language', 'en-us')
 LANGUAGE_COOKIE_AGE = 2592000
 
 # If a new language translation is supported, it must be added here
+# After adding a new language, run the following command:
+# python manage.py makemessages -l <language_code> -e html,js,py --no-wrap
+# where <language_code> is the code for the new language
+# Additionally, update the /src/frontend/.linguirc file
 LANGUAGES = [
+    ('bg', _('Bulgarian')),
     ('cs', _('Czech')),
     ('da', _('Danish')),
     ('de', _('German')),
@@ -713,8 +839,10 @@ LANGUAGES = [
     ('es', _('Spanish')),
     ('es-mx', _('Spanish (Mexican)')),
     ('fa', _('Farsi / Persian')),
+    ('fi', _('Finnish')),
     ('fr', _('French')),
     ('he', _('Hebrew')),
+    ('hi', _('Hindi')),
     ('hu', _('Hungarian')),
     ('it', _('Italian')),
     ('ja', _('Japanese')),
@@ -723,16 +851,19 @@ LANGUAGES = [
     ('no', _('Norwegian')),
     ('pl', _('Polish')),
     ('pt', _('Portuguese')),
-    ('pt-BR', _('Portuguese (Brazilian)')),
+    ('pt-br', _('Portuguese (Brazilian)')),
     ('ru', _('Russian')),
     ('sl', _('Slovenian')),
+    ('sr', _('Serbian')),
     ('sv', _('Swedish')),
     ('th', _('Thai')),
     ('tr', _('Turkish')),
     ('vi', _('Vietnamese')),
-    ('zh-hans', _('Chinese')),
+    ('zh-hans', _('Chinese (Simplified)')),
+    ('zh-hant', _('Chinese (Traditional)')),
 ]
 
+
 # Testing interface translations
 if get_boolean_setting('TEST_TRANSLATIONS', default_value=False):  # pragma: no cover
     # Set default language
@@ -759,13 +890,18 @@ CURRENCIES = get_setting(
     typecast=list,
 )
 
+# Ensure that at least one currency value is available
+if len(CURRENCIES) == 0:  # pragma: no cover
+    logger.warning("No currencies selected: Defaulting to USD")
+    CURRENCIES = ['USD']
+
 # Maximum number of decimal places for currency rendering
 CURRENCY_DECIMAL_PLACES = 6
 
 # Check that each provided currency is supported
 for currency in CURRENCIES:
     if currency not in moneyed.CURRENCIES:  # pragma: no cover
-        logger.error(f"Currency code '{currency}' is not supported")
+        logger.error("Currency code '%s' is not supported", currency)
         sys.exit(1)
 
 # Custom currency exchange backend
@@ -783,6 +919,10 @@ EMAIL_USE_SSL = get_boolean_setting('INVENTREE_EMAIL_SSL', 'email.ssl', False)
 
 DEFAULT_FROM_EMAIL = get_setting('INVENTREE_EMAIL_SENDER', 'email.sender', '')
 
+# If "from" email not specified, default to the username
+if not DEFAULT_FROM_EMAIL:
+    DEFAULT_FROM_EMAIL = get_setting('INVENTREE_EMAIL_USERNAME', 'email.username', '')
+
 EMAIL_USE_LOCALTIME = False
 EMAIL_TIMEOUT = 60
 
@@ -817,22 +957,36 @@ SITE_ID = 1
 SOCIAL_BACKENDS = get_setting('INVENTREE_SOCIAL_BACKENDS', 'social_backends', [], typecast=list)
 
 for app in SOCIAL_BACKENDS:
+
+    # Ensure that the app starts with 'allauth.socialaccount.providers'
+    social_prefix = 'allauth.socialaccount.providers.'
+
+    if not app.startswith(social_prefix):  # pragma: no cover
+        app = social_prefix + app
+
     INSTALLED_APPS.append(app)  # pragma: no cover
 
 SOCIALACCOUNT_PROVIDERS = get_setting('INVENTREE_SOCIAL_PROVIDERS', 'social_providers', None, typecast=dict)
 
 SOCIALACCOUNT_STORE_TOKENS = True
 
+# Explicitly set empty URL prefix for OIDC
+# The SOCIALACCOUNT_OPENID_CONNECT_URL_PREFIX setting was introduced in v0.60.0
+# Ref: https://github.com/pennersr/django-allauth/blob/0.60.0/ChangeLog.rst#backwards-incompatible-changes
+SOCIALACCOUNT_OPENID_CONNECT_URL_PREFIX = ''
+
 # settings for allauth
 ACCOUNT_EMAIL_CONFIRMATION_EXPIRE_DAYS = get_setting('INVENTREE_LOGIN_CONFIRM_DAYS', 'login_confirm_days', 3, typecast=int)
 ACCOUNT_LOGIN_ATTEMPTS_LIMIT = get_setting('INVENTREE_LOGIN_ATTEMPTS', 'login_attempts', 5, typecast=int)
 ACCOUNT_DEFAULT_HTTP_PROTOCOL = get_setting('INVENTREE_LOGIN_DEFAULT_HTTP_PROTOCOL', 'login_default_protocol', 'http')
 ACCOUNT_LOGOUT_ON_PASSWORD_CHANGE = True
 ACCOUNT_PREVENT_ENUMERATION = True
+# 2FA
+REMOVE_SUCCESS_URL = 'settings'
 
 # override forms / adapters
 ACCOUNT_FORMS = {
-    'login': 'allauth.account.forms.LoginForm',
+    'login': 'InvenTree.forms.CustomLoginForm',
     'signup': 'InvenTree.forms.CustomSignupForm',
     'add_email': 'allauth.account.forms.AddEmailForm',
     'change_password': 'allauth.account.forms.ChangePasswordForm',
@@ -899,19 +1053,59 @@ PLUGINS_ENABLED = get_boolean_setting('INVENTREE_PLUGINS_ENABLED', 'plugins_enab
 PLUGIN_FILE = config.get_plugin_file()
 
 # Plugin test settings
-PLUGIN_TESTING = get_setting('INVENTREE_PLUGIN_TESTING', 'PLUGIN_TESTING', TESTING)                     # Are plugins beeing tested?
+PLUGIN_TESTING = get_setting('INVENTREE_PLUGIN_TESTING', 'PLUGIN_TESTING', TESTING)                     # Are plugins being tested?
 PLUGIN_TESTING_SETUP = get_setting('INVENTREE_PLUGIN_TESTING_SETUP', 'PLUGIN_TESTING_SETUP', False)     # Load plugins from setup hooks in testing?
 PLUGIN_TESTING_EVENTS = False                                                                           # Flag if events are tested right now
 PLUGIN_RETRY = get_setting('INVENTREE_PLUGIN_RETRY', 'PLUGIN_RETRY', 5)                                 # How often should plugin loading be tried?
 PLUGIN_FILE_CHECKED = False                                                                             # Was the plugin file checked?
 
+# Site URL can be specified statically, or via a run-time setting
+SITE_URL = get_setting('INVENTREE_SITE_URL', 'site_url', None)
+
+if SITE_URL:
+    logger.info("Site URL: %s", SITE_URL)
+
+    # Check that the site URL is valid
+    validator = URLValidator()
+    validator(SITE_URL)
+
 # User interface customization values
 CUSTOM_LOGO = get_custom_file('INVENTREE_CUSTOM_LOGO', 'customize.logo', 'custom logo', lookup_media=True)
 CUSTOM_SPLASH = get_custom_file('INVENTREE_CUSTOM_SPLASH', 'customize.splash', 'custom splash')
 
 CUSTOMIZE = get_setting('INVENTREE_CUSTOMIZE', 'customize', {})
+
+# Load settings for the frontend interface
+FRONTEND_SETTINGS = config.get_frontend_settings(debug=DEBUG)
+FRONTEND_URL_BASE = FRONTEND_SETTINGS.get('base_url', 'platform')
+
 if DEBUG:
     logger.info("InvenTree running with DEBUG enabled")
 
-logger.info(f"MEDIA_ROOT: '{MEDIA_ROOT}'")
-logger.info(f"STATIC_ROOT: '{STATIC_ROOT}'")
+logger.info("MEDIA_ROOT: '%s'", MEDIA_ROOT)
+logger.info("STATIC_ROOT: '%s'", STATIC_ROOT)
+
+# Flags
+FLAGS = {
+    'EXPERIMENTAL': [
+        {'condition': 'boolean', 'value': DEBUG},
+        {'condition': 'parameter', 'value': 'experimental='},
+    ],  # Should experimental features be turned on?
+    'NEXT_GEN': [
+        {'condition': 'parameter', 'value': 'ngen='},
+    ],  # Should next-gen features be turned on?
+}
+
+# Get custom flags from environment/yaml
+CUSTOM_FLAGS = get_setting('INVENTREE_FLAGS', 'flags', None, typecast=dict)
+if CUSTOM_FLAGS:
+    if not isinstance(CUSTOM_FLAGS, dict):
+        logger.error("Invalid custom flags, must be valid dict: %s", str(CUSTOM_FLAGS))
+    else:
+        logger.info("Custom flags: %s", str(CUSTOM_FLAGS))
+        FLAGS.update(CUSTOM_FLAGS)
+
+# Magic login django-sesame
+SESAME_MAX_AGE = 300
+# LOGIN_REDIRECT_URL = f"/{FRONTEND_URL_BASE}/logged-in/"
+LOGIN_REDIRECT_URL = "/index/"

InvenTree/InvenTree/social_auth_urls.py

@@ -0,0 +1,207 @@
+"""API endpoints for social authentication with allauth."""
+import logging
+from importlib import import_module
+
+from django.urls import NoReverseMatch, include, path, reverse
+
+from allauth.account.models import EmailAddress
+from allauth.socialaccount import providers
+from allauth.socialaccount.providers.oauth2.views import (OAuth2Adapter,
+                                                          OAuth2LoginView)
+from drf_spectacular.utils import OpenApiResponse, extend_schema
+from rest_framework.exceptions import NotFound
+from rest_framework.permissions import AllowAny, IsAuthenticated
+from rest_framework.response import Response
+
+import InvenTree.sso
+from common.models import InvenTreeSetting
+from InvenTree.mixins import CreateAPI, ListAPI, ListCreateAPI
+from InvenTree.serializers import InvenTreeModelSerializer
+
+logger = logging.getLogger('inventree')
+
+
+class GenericOAuth2ApiLoginView(OAuth2LoginView):
+    """Api view to login a user with a social account"""
+    def dispatch(self, request, *args, **kwargs):
+        """Dispatch the regular login view directly."""
+        return self.login(request, *args, **kwargs)
+
+
+class GenericOAuth2ApiConnectView(GenericOAuth2ApiLoginView):
+    """Api view to connect a social account to the current user"""
+
+    def dispatch(self, request, *args, **kwargs):
+        """Dispatch the connect request directly."""
+        # Override the request method be in connection mode
+        request.GET = request.GET.copy()
+        request.GET['process'] = 'connect'
+
+        # Resume the dispatch
+        return super().dispatch(request, *args, **kwargs)
+
+
+def handle_oauth2(adapter: OAuth2Adapter):
+    """Define urls for oauth2 endpoints."""
+    return [
+        path('login/', GenericOAuth2ApiLoginView.adapter_view(adapter), name=f'{provider.id}_api_login'),
+        path('connect/', GenericOAuth2ApiConnectView.adapter_view(adapter), name=f'{provider.id}_api_connect'),
+    ]
+
+
+legacy = {
+    'twitter': 'twitter_oauth2',
+    'bitbucket': 'bitbucket_oauth2',
+    'linkedin': 'linkedin_oauth2',
+    'vimeo': 'vimeo_oauth2',
+    'openid': 'openid_connect',
+}  # legacy connectors
+
+
+# Collect urls for all loaded providers
+social_auth_urlpatterns = []
+
+provider_urlpatterns = []
+
+for name, provider in providers.registry.provider_map.items():
+
+    try:
+        prov_mod = import_module(provider.get_package() + ".views")
+    except ImportError:
+        logger.exception("Could not import authentication provider %s", name)
+        continue
+
+    # Try to extract the adapter class
+    adapters = [cls for cls in prov_mod.__dict__.values() if isinstance(cls, type) and not cls == OAuth2Adapter and issubclass(cls, OAuth2Adapter)]
+
+    # Get urls
+    urls = []
+    if len(adapters) == 1:
+        urls = handle_oauth2(adapter=adapters[0])
+    else:
+        if provider.id in legacy:
+            logger.warning('`%s` is not supported on platform UI. Use `%s` instead.', provider.id, legacy[provider.id])
+            continue
+        else:
+            logger.error('Found handler that is not yet ready for platform UI: `%s`. Open an feature request on GitHub if you need it implemented.', provider.id)
+            continue
+    provider_urlpatterns += [path(f'{provider.id}/', include(urls))]
+
+
+social_auth_urlpatterns += provider_urlpatterns
+
+
+class SocialProviderListView(ListAPI):
+    """List of available social providers."""
+    permission_classes = (AllowAny,)
+
+    def get(self, request, *args, **kwargs):
+        """Get the list of providers."""
+        provider_list = []
+        for provider in providers.registry.provider_map.values():
+            provider_data = {
+                'id': provider.id,
+                'name': provider.name,
+                'configured': False
+            }
+
+            try:
+                provider_data['login'] = request.build_absolute_uri(reverse(f'{provider.id}_api_login'))
+            except NoReverseMatch:
+                provider_data['login'] = None
+
+            try:
+                provider_data['connect'] = request.build_absolute_uri(reverse(f'{provider.id}_api_connect'))
+            except NoReverseMatch:
+                provider_data['connect'] = None
+
+            provider_data['configured'] = InvenTree.sso.check_provider(provider)
+            provider_data['display_name'] = InvenTree.sso.provider_display_name(provider)
+
+            provider_list.append(provider_data)
+
+        data = {
+            'sso_enabled': InvenTree.sso.login_enabled(),
+            'sso_registration': InvenTree.sso.registration_enabled(),
+            'mfa_required': InvenTreeSetting.get_setting('LOGIN_ENFORCE_MFA'),
+            'providers': provider_list
+        }
+        return Response(data)
+
+
+class EmailAddressSerializer(InvenTreeModelSerializer):
+    """Serializer for the EmailAddress model."""
+
+    class Meta:
+        """Meta options for EmailAddressSerializer."""
+
+        model = EmailAddress
+        fields = '__all__'
+
+
+class EmptyEmailAddressSerializer(InvenTreeModelSerializer):
+    """Empty Serializer for the EmailAddress model."""
+
+    class Meta:
+        """Meta options for EmailAddressSerializer."""
+
+        model = EmailAddress
+        fields = []
+
+
+class EmailListView(ListCreateAPI):
+    """List of registered email addresses for current users."""
+    permission_classes = (IsAuthenticated,)
+    serializer_class = EmailAddressSerializer
+
+    def get_queryset(self):
+        """Only return data for current user."""
+        return EmailAddress.objects.filter(user=self.request.user)
+
+
+class EmailActionMixin(CreateAPI):
+    """Mixin to modify email addresses for current users."""
+    serializer_class = EmptyEmailAddressSerializer
+    permission_classes = (IsAuthenticated,)
+
+    def get_queryset(self):
+        """Filter queryset for current user."""
+        return EmailAddress.objects.filter(user=self.request.user, pk=self.kwargs['pk']).first()
+
+    @extend_schema(responses={200: OpenApiResponse(response=EmailAddressSerializer)})
+    def post(self, request, *args, **kwargs):
+        """Filter item, run action and return data."""
+        email = self.get_queryset()
+        if not email:
+            raise NotFound
+
+        self.special_action(email, request, *args, **kwargs)
+        return Response(EmailAddressSerializer(email).data)
+
+
+class EmailVerifyView(EmailActionMixin):
+    """Re-verify an email for a currently logged in user."""
+
+    def special_action(self, email, request, *args, **kwargs):
+        """Send confirmation."""
+        if email.verified:
+            return
+        email.send_confirmation(request)
+
+
+class EmailPrimaryView(EmailActionMixin):
+    """Make an email for a currently logged in user primary."""
+
+    def special_action(self, email, *args, **kwargs):
+        """Mark email as primary."""
+        if email.primary:
+            return
+        email.set_as_primary()
+
+
+class EmailRemoveView(EmailActionMixin):
+    """Remove an email for a currently logged in user."""
+
+    def special_action(self, email, *args, **kwargs):
+        """Delete email."""
+        email.delete()

InvenTree/InvenTree/sso.py

@@ -0,0 +1,81 @@
+"""Helper functions for Single Sign On functionality"""
+
+
+import logging
+
+from common.models import InvenTreeSetting
+from InvenTree.helpers import str2bool
+
+logger = logging.getLogger('inventree')
+
+
+def get_provider_app(provider):
+    """Return the SocialApp object for the given provider"""
+
+    from allauth.socialaccount.models import SocialApp
+
+    try:
+        apps = SocialApp.objects.filter(provider__iexact=provider.id)
+    except SocialApp.DoesNotExist:
+        logger.warning("SSO SocialApp not found for provider '%s'", provider.id)
+        return None
+
+    if apps.count() > 1:
+        logger.warning("Multiple SocialApps found for provider '%s'", provider.id)
+
+    if apps.count() == 0:
+        logger.warning("SSO SocialApp not found for provider '%s'", provider.id)
+
+    return apps.first()
+
+
+def check_provider(provider, raise_error=False):
+    """Check if the given provider is correctly configured.
+
+    To be correctly configured, the following must be true:
+
+    - Provider must either have a registered SocialApp
+    - Must have at least one site enabled
+    """
+
+    import allauth.app_settings
+
+    # First, check that the provider is enabled
+    app = get_provider_app(provider)
+
+    if not app:
+        return False
+
+    if allauth.app_settings.SITES_ENABLED:
+        # At least one matching site must be specified
+        if not app.sites.exists():
+            logger.error("SocialApp %s has no sites configured", app)
+            return False
+
+    # At this point, we assume that the provider is correctly configured
+    return True
+
+
+def provider_display_name(provider):
+    """Return the 'display name' for the given provider"""
+
+    if app := get_provider_app(provider):
+        return app.name
+
+    # Fallback value if app not found
+    return provider.name
+
+
+def login_enabled() -> bool:
+    """Return True if SSO login is enabled"""
+    return str2bool(InvenTreeSetting.get_setting('LOGIN_ENABLE_SSO'))
+
+
+def registration_enabled() -> bool:
+    """Return True if SSO registration is enabled"""
+    return str2bool(InvenTreeSetting.get_setting('LOGIN_ENABLE_SSO_REG'))
+
+
+def auto_registration_enabled() -> bool:
+    """Return True if SSO auto-registration is enabled"""
+    return str2bool(InvenTreeSetting.get_setting('LOGIN_SIGNUP_SSO_AUTO'))

InvenTree/InvenTree/static/css/inventree.css

@@ -105,6 +105,10 @@ main {
     font-size: 110%;
 }
 
+.bg-qr-code {
+    background-color: #FFF !important;
+}
+
 .qr-code {
     max-width: 400px;
     max-height: 400px;
@@ -219,8 +223,7 @@ main {
 }
 
 .sub-table {
-    margin-left: 45px;
-    margin-right: 45px;
+    margin-left: 60px;
 }
 
 .detail-icon .glyphicon {
@@ -266,10 +269,6 @@ main {
 }
 
 /* Styles for table buttons and filtering */
-.button-toolbar .btn {
-    margin-left: 1px;
-    margin-right: 1px;
-}
 
 .filter-list {
     display: inline-block;
@@ -301,16 +300,14 @@ main {
 .filter-tag {
     display: inline-block;
     *display: inline;
-    zoom: 1;
-    padding-top: 3px;
-    padding-left: 3px;
-    padding-right: 3px;
-    border: 1px solid #aaa;
-    border-radius: 3px;
-    background: #eee;
-    margin: 1px;
-    margin-left: 5px;
-    margin-right: 5px;
+    margin: 5px;
+    padding: 5px;
+    padding-top: 1px;
+    padding-bottom: 1px;
+    color: var(--bs-body-color);
+    border: 1px solid var(--border-color);
+    border-radius: 10px;
+    background: var(--secondary-color);
     white-space: nowrap;
 }
 
@@ -321,7 +318,6 @@ main {
 .filter-input {
     display: inline-block;
     *display: inline;
-    zoom: 1;
 }
 
 .filter-tag:hover {
@@ -1094,4 +1090,14 @@ a {
 .sso-provider-link a {
     width:  100%;
     text-align: left;
-}
+}
+
+.flex-cell {
+    display: flex;
+    align-items: center;
+    justify-content: space-between;
+}
+
+.large-treeview-icon {
+    font-size: 1em;
+}

InvenTree/InvenTree/status.py

@@ -4,20 +4,20 @@
 import logging
 from datetime import timedelta
 
-from django.conf import settings
 from django.utils import timezone
 from django.utils.translation import gettext_lazy as _
 
 from django_q.models import Success
-from django_q.monitor import Stat
+from django_q.status import Stat
 
+import InvenTree.email
 import InvenTree.ready
 
 logger = logging.getLogger("inventree")
 
 
 def is_worker_running(**kwargs):
-    """Return True if the background worker process is oprational."""
+    """Return True if the background worker process is operational."""
     clusters = Stat.get_all()
 
     if len(clusters) > 0:
@@ -38,38 +38,14 @@ def is_worker_running(**kwargs):
     )
 
     # If any results are returned, then the background worker is running!
-    return results.exists()
+    try:
+        result = results.exists()
+    except Exception:
+        # We may throw an exception if the database is not ready,
+        # or if the django_q table is not yet created (i.e. in CI testing)
+        result = False
 
-
-def is_email_configured():
-    """Check if email backend is configured.
-
-    NOTE: This does not check if the configuration is valid!
-    """
-    configured = True
-
-    if InvenTree.ready.isInTestMode():
-        return False
-
-    if InvenTree.ready.isImportingData():
-        return False
-
-    if not settings.EMAIL_HOST:
-        configured = False
-
-        # Display warning unless in test mode
-        if not settings.TESTING:  # pragma: no cover
-            logger.debug("EMAIL_HOST is not configured")
-
-    # Display warning unless in test mode
-    if not settings.TESTING:  # pragma: no cover
-        logger.debug("EMAIL_HOST_USER is not configured")
-
-    # Display warning unless in test mode
-    if not settings.TESTING:  # pragma: no cover
-        logger.debug("EMAIL_HOST_PASSWORD is not configured")
-
-    return configured
+    return result
 
 
 def check_system_health(**kwargs):
@@ -91,7 +67,7 @@ def check_system_health(**kwargs):
         result = False
         logger.warning(_("Background worker check failed"))
 
-    if not is_email_configured():  # pragma: no cover
+    if not InvenTree.email.is_email_configured():  # pragma: no cover
         result = False
         logger.warning(_("Email backend not configured"))
 

InvenTree/InvenTree/status_codes.py

@@ -2,374 +2,161 @@
 
 from django.utils.translation import gettext_lazy as _
 
-
-class StatusCode:
-    """Base class for representing a set of StatusCodes.
-
-    This is used to map a set of integer values to text.
-    """
-
-    colors = {}
-
-    @classmethod
-    def render(cls, key, large=False):
-        """Render the value as a HTML label."""
-        # If the key cannot be found, pass it back
-        if key not in cls.options.keys():
-            return key
-
-        value = cls.options.get(key, key)
-        color = cls.colors.get(key, 'secondary')
-
-        span_class = f'badge rounded-pill bg-{color}'
-
-        return "<span class='{cl}'>{value}</span>".format(
-            cl=span_class,
-            value=value
-        )
-
-    @classmethod
-    def list(cls):
-        """Return the StatusCode options as a list of mapped key / value items."""
-        return list(cls.dict().values())
-
-    @classmethod
-    def text(cls, key):
-        """Text for supplied status code."""
-        return cls.options.get(key, None)
-
-    @classmethod
-    def items(cls):
-        """All status code items."""
-        return cls.options.items()
-
-    @classmethod
-    def keys(cls):
-        """All status code keys."""
-        return cls.options.keys()
-
-    @classmethod
-    def labels(cls):
-        """All status code labels."""
-        return cls.options.values()
-
-    @classmethod
-    def names(cls):
-        """Return a map of all 'names' of status codes in this class
-
-        Will return a dict object, with the attribute name indexed to the integer value.
-
-        e.g.
-        {
-            'PENDING': 10,
-            'IN_PROGRESS': 20,
-        }
-        """
-        keys = cls.keys()
-        status_names = {}
-
-        for d in dir(cls):
-            if d.startswith('_'):
-                continue
-            if d != d.upper():
-                continue
-
-            value = getattr(cls, d, None)
-
-            if value is None:
-                continue
-            if callable(value):
-                continue
-            if type(value) != int:
-                continue
-            if value not in keys:
-                continue
-
-            status_names[d] = value
-
-        return status_names
-
-    @classmethod
-    def dict(cls):
-        """Return a dict representation containing all required information"""
-        values = {}
-
-        for name, value, in cls.names().items():
-            entry = {
-                'key': value,
-                'name': name,
-                'label': cls.label(value),
-            }
-
-            if hasattr(cls, 'colors'):
-                if color := cls.colors.get(value, None):
-                    entry['color'] = color
-
-            values[name] = entry
-
-        return values
-
-    @classmethod
-    def label(cls, value):
-        """Return the status code label associated with the provided value."""
-        return cls.options.get(value, value)
-
-    @classmethod
-    def value(cls, label):
-        """Return the value associated with the provided label."""
-        for k in cls.options.keys():
-            if cls.options[k].lower() == label.lower():
-                return k
-
-        raise ValueError("Label not found")
+from generic.states import StatusCode
 
 
 class PurchaseOrderStatus(StatusCode):
     """Defines a set of status codes for a PurchaseOrder."""
 
     # Order status codes
-    PENDING = 10  # Order is pending (not yet placed)
-    PLACED = 20  # Order has been placed with supplier
-    COMPLETE = 30  # Order has been completed
-    CANCELLED = 40  # Order was cancelled
-    LOST = 50  # Order was lost
-    RETURNED = 60  # Order was returned
+    PENDING = 10, _("Pending"), 'secondary'     # Order is pending (not yet placed)
+    PLACED = 20, _("Placed"), 'primary'         # Order has been placed with supplier
+    COMPLETE = 30, _("Complete"), 'success'     # Order has been completed
+    CANCELLED = 40, _("Cancelled"), 'danger'    # Order was cancelled
+    LOST = 50, _("Lost"), 'warning'             # Order was lost
+    RETURNED = 60, _("Returned"), 'warning'     # Order was returned
 
-    options = {
-        PENDING: _("Pending"),
-        PLACED: _("Placed"),
-        COMPLETE: _("Complete"),
-        CANCELLED: _("Cancelled"),
-        LOST: _("Lost"),
-        RETURNED: _("Returned"),
-    }
 
-    colors = {
-        PENDING: 'secondary',
-        PLACED: 'primary',
-        COMPLETE: 'success',
-        CANCELLED: 'danger',
-        LOST: 'warning',
-        RETURNED: 'warning',
-    }
+class PurchaseOrderStatusGroups:
+    """Groups for PurchaseOrderStatus codes."""
 
     # Open orders
     OPEN = [
-        PENDING,
-        PLACED,
+        PurchaseOrderStatus.PENDING.value,
+        PurchaseOrderStatus.PLACED.value,
     ]
 
     # Failed orders
     FAILED = [
-        CANCELLED,
-        LOST,
-        RETURNED
+        PurchaseOrderStatus.CANCELLED.value,
+        PurchaseOrderStatus.LOST.value,
+        PurchaseOrderStatus.RETURNED.value
     ]
 
 
 class SalesOrderStatus(StatusCode):
     """Defines a set of status codes for a SalesOrder."""
 
-    PENDING = 10  # Order is pending
-    IN_PROGRESS = 15  # Order has been issued, and is in progress
-    SHIPPED = 20  # Order has been shipped to customer
-    CANCELLED = 40  # Order has been cancelled
-    LOST = 50  # Order was lost
-    RETURNED = 60  # Order was returned
+    PENDING = 10, _("Pending"), 'secondary'         # Order is pending
+    IN_PROGRESS = 15, _("In Progress"), 'primary'   # Order has been issued, and is in progress
+    SHIPPED = 20, _("Shipped"), 'success'           # Order has been shipped to customer
+    CANCELLED = 40, _("Cancelled"), 'danger'        # Order has been cancelled
+    LOST = 50, _("Lost"), 'warning'                 # Order was lost
+    RETURNED = 60, _("Returned"), 'warning'         # Order was returned
 
-    options = {
-        PENDING: _("Pending"),
-        IN_PROGRESS: _("In Progress"),
-        SHIPPED: _("Shipped"),
-        CANCELLED: _("Cancelled"),
-        LOST: _("Lost"),
-        RETURNED: _("Returned"),
-    }
 
-    colors = {
-        PENDING: 'secondary',
-        IN_PROGRESS: 'primary',
-        SHIPPED: 'success',
-        CANCELLED: 'danger',
-        LOST: 'warning',
-        RETURNED: 'warning',
-    }
+class SalesOrderStatusGroups:
+    """Groups for SalesOrderStatus codes."""
 
     # Open orders
     OPEN = [
-        PENDING,
-        IN_PROGRESS,
+        SalesOrderStatus.PENDING.value,
+        SalesOrderStatus.IN_PROGRESS.value,
     ]
 
     # Completed orders
     COMPLETE = [
-        SHIPPED,
+        SalesOrderStatus.SHIPPED.value,
     ]
 
 
 class StockStatus(StatusCode):
     """Status codes for Stock."""
 
-    OK = 10  # Item is OK
-    ATTENTION = 50  # Item requires attention
-    DAMAGED = 55  # Item is damaged
-    DESTROYED = 60  # Item is destroyed
-    REJECTED = 65  # Item is rejected
-    LOST = 70  # Item has been lost
-    QUARANTINED = 75  # Item has been quarantined and is unavailable
-    RETURNED = 85  # Item has been returned from a customer
+    OK = 10, _("OK"), 'success'                         # Item is OK
+    ATTENTION = 50, _("Attention needed"), 'warning'    # Item requires attention
+    DAMAGED = 55, _("Damaged"), 'warning'               # Item is damaged
+    DESTROYED = 60, _("Destroyed"), 'danger'            # Item is destroyed
+    REJECTED = 65, _("Rejected"), 'danger'              # Item is rejected
+    LOST = 70, _("Lost"), 'dark'                        # Item has been lost
+    QUARANTINED = 75, _("Quarantined"), 'info'          # Item has been quarantined and is unavailable
+    RETURNED = 85, _("Returned"), 'warning'             # Item has been returned from a customer
 
-    options = {
-        OK: _("OK"),
-        ATTENTION: _("Attention needed"),
-        DAMAGED: _("Damaged"),
-        DESTROYED: _("Destroyed"),
-        LOST: _("Lost"),
-        REJECTED: _("Rejected"),
-        QUARANTINED: _("Quarantined"),
-        RETURNED: _("Returned"),
-    }
 
-    colors = {
-        OK: 'success',
-        ATTENTION: 'warning',
-        DAMAGED: 'danger',
-        DESTROYED: 'danger',
-        LOST: 'dark',
-        REJECTED: 'danger',
-        QUARANTINED: 'info'
-    }
+class StockStatusGroups:
+    """Groups for StockStatus codes."""
 
     # The following codes correspond to parts that are 'available' or 'in stock'
     AVAILABLE_CODES = [
-        OK,
-        ATTENTION,
-        DAMAGED,
-        RETURNED,
+        StockStatus.OK.value,
+        StockStatus.ATTENTION.value,
+        StockStatus.DAMAGED.value,
+        StockStatus.RETURNED.value,
     ]
 
 
 class StockHistoryCode(StatusCode):
     """Status codes for StockHistory."""
 
-    LEGACY = 0
+    LEGACY = 0, _('Legacy stock tracking entry')
 
-    CREATED = 1
+    CREATED = 1, _('Stock item created')
 
     # Manual editing operations
-    EDITED = 5
-    ASSIGNED_SERIAL = 6
+    EDITED = 5, _('Edited stock item')
+    ASSIGNED_SERIAL = 6, _('Assigned serial number')
 
     # Manual stock operations
-    STOCK_COUNT = 10
-    STOCK_ADD = 11
-    STOCK_REMOVE = 12
+    STOCK_COUNT = 10, _('Stock counted')
+    STOCK_ADD = 11, _('Stock manually added')
+    STOCK_REMOVE = 12, _('Stock manually removed')
 
     # Location operations
-    STOCK_MOVE = 20
+    STOCK_MOVE = 20, _('Location changed')
+    STOCK_UPDATE = 25, _('Stock updated')
 
     # Installation operations
-    INSTALLED_INTO_ASSEMBLY = 30
-    REMOVED_FROM_ASSEMBLY = 31
+    INSTALLED_INTO_ASSEMBLY = 30, _('Installed into assembly')
+    REMOVED_FROM_ASSEMBLY = 31, _('Removed from assembly')
 
-    INSTALLED_CHILD_ITEM = 35
-    REMOVED_CHILD_ITEM = 36
+    INSTALLED_CHILD_ITEM = 35, _('Installed component item')
+    REMOVED_CHILD_ITEM = 36, _('Removed component item')
 
     # Stock splitting operations
-    SPLIT_FROM_PARENT = 40
-    SPLIT_CHILD_ITEM = 42
+    SPLIT_FROM_PARENT = 40, _('Split from parent item')
+    SPLIT_CHILD_ITEM = 42, _('Split child item')
 
     # Stock merging operations
-    MERGED_STOCK_ITEMS = 45
+    MERGED_STOCK_ITEMS = 45, _('Merged stock items')
 
     # Convert stock item to variant
-    CONVERTED_TO_VARIANT = 48
+    CONVERTED_TO_VARIANT = 48, _('Converted to variant')
 
     # Build order codes
-    BUILD_OUTPUT_CREATED = 50
-    BUILD_OUTPUT_COMPLETED = 55
-    BUILD_CONSUMED = 57
+    BUILD_OUTPUT_CREATED = 50, _('Build order output created')
+    BUILD_OUTPUT_COMPLETED = 55, _('Build order output completed')
+    BUILD_OUTPUT_REJECTED = 56, _('Build order output rejected')
+    BUILD_CONSUMED = 57, _('Consumed by build order')
 
     # Sales order codes
-    SHIPPED_AGAINST_SALES_ORDER = 60
+    SHIPPED_AGAINST_SALES_ORDER = 60, _("Shipped against Sales Order")
 
     # Purchase order codes
-    RECEIVED_AGAINST_PURCHASE_ORDER = 70
+    RECEIVED_AGAINST_PURCHASE_ORDER = 70, _('Received against Purchase Order')
 
     # Return order codes
-    RETURNED_AGAINST_RETURN_ORDER = 80
+    RETURNED_AGAINST_RETURN_ORDER = 80, _('Returned against Return Order')
 
     # Customer actions
-    SENT_TO_CUSTOMER = 100
-    RETURNED_FROM_CUSTOMER = 105
-
-    options = {
-        LEGACY: _('Legacy stock tracking entry'),
-
-        CREATED: _('Stock item created'),
-
-        EDITED: _('Edited stock item'),
-        ASSIGNED_SERIAL: _('Assigned serial number'),
-
-        STOCK_COUNT: _('Stock counted'),
-        STOCK_ADD: _('Stock manually added'),
-        STOCK_REMOVE: _('Stock manually removed'),
-
-        STOCK_MOVE: _('Location changed'),
-
-        INSTALLED_INTO_ASSEMBLY: _('Installed into assembly'),
-        REMOVED_FROM_ASSEMBLY: _('Removed from assembly'),
-
-        INSTALLED_CHILD_ITEM: _('Installed component item'),
-        REMOVED_CHILD_ITEM: _('Removed component item'),
-
-        SPLIT_FROM_PARENT: _('Split from parent item'),
-        SPLIT_CHILD_ITEM: _('Split child item'),
-
-        MERGED_STOCK_ITEMS: _('Merged stock items'),
-
-        CONVERTED_TO_VARIANT: _('Converted to variant'),
-
-        SENT_TO_CUSTOMER: _('Sent to customer'),
-        RETURNED_FROM_CUSTOMER: _('Returned from customer'),
-
-        BUILD_OUTPUT_CREATED: _('Build order output created'),
-        BUILD_OUTPUT_COMPLETED: _('Build order output completed'),
-        BUILD_CONSUMED: _('Consumed by build order'),
-
-        SHIPPED_AGAINST_SALES_ORDER: _("Shipped against Sales Order"),
-
-        RECEIVED_AGAINST_PURCHASE_ORDER: _('Received against Purchase Order'),
-
-        RETURNED_AGAINST_RETURN_ORDER: _('Returned against Return Order'),
-    }
+    SENT_TO_CUSTOMER = 100, _('Sent to customer')
+    RETURNED_FROM_CUSTOMER = 105, _('Returned from customer')
 
 
 class BuildStatus(StatusCode):
     """Build status codes."""
 
-    PENDING = 10  # Build is pending / active
-    PRODUCTION = 20  # BuildOrder is in production
-    CANCELLED = 30  # Build was cancelled
-    COMPLETE = 40  # Build is complete
+    PENDING = 10, _("Pending"), 'secondary'        # Build is pending / active
+    PRODUCTION = 20, _("Production"), 'primary'    # BuildOrder is in production
+    CANCELLED = 30, _("Cancelled"), 'danger'       # Build was cancelled
+    COMPLETE = 40, _("Complete"), 'success'        # Build is complete
 
-    options = {
-        PENDING: _("Pending"),
-        PRODUCTION: _("Production"),
-        CANCELLED: _("Cancelled"),
-        COMPLETE: _("Complete"),
-    }
 
-    colors = {
-        PENDING: 'secondary',
-        PRODUCTION: 'primary',
-        COMPLETE: 'success',
-        CANCELLED: 'danger',
-    }
+class BuildStatusGroups:
+    """Groups for BuildStatus codes."""
 
     ACTIVE_CODES = [
-        PENDING,
-        PRODUCTION,
+        BuildStatus.PENDING.value,
+        BuildStatus.PRODUCTION.value,
     ]
 
 
@@ -377,68 +164,40 @@ class ReturnOrderStatus(StatusCode):
     """Defines a set of status codes for a ReturnOrder"""
 
     # Order is pending, waiting for receipt of items
-    PENDING = 10
+    PENDING = 10, _("Pending"), 'secondary'
 
     # Items have been received, and are being inspected
-    IN_PROGRESS = 20
+    IN_PROGRESS = 20, _("In Progress"), 'primary'
 
-    COMPLETE = 30
-    CANCELLED = 40
+    COMPLETE = 30, _("Complete"), 'success'
+    CANCELLED = 40, _("Cancelled"), 'danger'
+
+
+class ReturnOrderStatusGroups:
+    """Groups for ReturnOrderStatus codes."""
 
     OPEN = [
-        PENDING,
-        IN_PROGRESS,
+        ReturnOrderStatus.PENDING.value,
+        ReturnOrderStatus.IN_PROGRESS.value,
     ]
 
-    options = {
-        PENDING: _("Pending"),
-        IN_PROGRESS: _("In Progress"),
-        COMPLETE: _("Complete"),
-        CANCELLED: _("Cancelled"),
-    }
-
-    colors = {
-        PENDING: 'secondary',
-        IN_PROGRESS: 'primary',
-        COMPLETE: 'success',
-        CANCELLED: 'danger',
-    }
-
 
 class ReturnOrderLineStatus(StatusCode):
     """Defines a set of status codes for a ReturnOrderLineItem"""
 
-    PENDING = 10
+    PENDING = 10, _("Pending"), 'secondary'
 
     # Item is to be returned to customer, no other action
-    RETURN = 20
+    RETURN = 20, _("Return"), 'success'
 
     # Item is to be repaired, and returned to customer
-    REPAIR = 30
+    REPAIR = 30, _("Repair"), 'primary'
 
     # Item is to be replaced (new item shipped)
-    REPLACE = 40
+    REPLACE = 40, _("Replace"), 'warning'
 
     # Item is to be refunded (cannot be repaired)
-    REFUND = 50
+    REFUND = 50, _("Refund"), 'info'
 
     # Item is rejected
-    REJECT = 60
-
-    options = {
-        PENDING: _('Pending'),
-        RETURN: _('Return'),
-        REPAIR: _('Repair'),
-        REFUND: _('Refund'),
-        REPLACE: _('Replace'),
-        REJECT: _('Reject')
-    }
-
-    colors = {
-        PENDING: 'secondary',
-        RETURN: 'success',
-        REPAIR: 'primary',
-        REFUND: 'info',
-        REPLACE: 'warning',
-        REJECT: 'danger',
-    }
+    REJECT = 60, _("Reject"), 'danger'

InvenTree/InvenTree/tasks.py

@@ -12,7 +12,6 @@ from datetime import datetime, timedelta
 from typing import Callable, List
 
 from django.conf import settings
-from django.core import mail as django_mail
 from django.core.exceptions import AppRegistryNotReady
 from django.core.management import call_command
 from django.db import DEFAULT_DB_ALIAS, connections
@@ -49,11 +48,11 @@ def schedule_task(taskname, **kwargs):
         # If this task is already scheduled, don't schedule it again
         # Instead, update the scheduling parameters
         if Schedule.objects.filter(func=taskname).exists():
-            logger.debug(f"Scheduled task '{taskname}' already exists - updating!")
+            logger.debug("Scheduled task '%s' already exists - updating!", taskname)
 
             Schedule.objects.filter(func=taskname).update(**kwargs)
         else:
-            logger.info(f"Creating scheduled task '{taskname}'")
+            logger.info("Creating scheduled task '%s'", taskname)
 
             Schedule.objects.create(
                 name=taskname,
@@ -71,7 +70,7 @@ def raise_warning(msg):
 
     # If testing is running raise a warning that can be asserted
     if settings.TESTING:
-        warnings.warn(msg)
+        warnings.warn(msg, stacklevel=2)
 
 
 def check_daily_holdoff(task_name: str, n_days: int = 1) -> bool:
@@ -90,15 +89,16 @@ def check_daily_holdoff(task_name: str, n_days: int = 1) -> bool:
     Note that this function creates some *hidden* global settings (designated with the _ prefix),
     which are used to keep a running track of when the particular task was was last run.
     """
-
     from common.models import InvenTreeSetting
+    from InvenTree.ready import isInTestMode
 
     if n_days <= 0:
-        logger.info(f"Specified interval for task '{task_name}' < 1 - task will not run")
+        logger.info("Specified interval for task '%s' < 1 - task will not run", task_name)
         return False
 
     # Sleep a random number of seconds to prevent worker conflict
-    time.sleep(random.randint(1, 5))
+    if not isInTestMode():
+        time.sleep(random.randint(1, 5))
 
     attempt_key = f'_{task_name}_ATTEMPT'
     success_key = f'_{task_name}_SUCCESS'
@@ -116,7 +116,7 @@ def check_daily_holdoff(task_name: str, n_days: int = 1) -> bool:
         threshold = datetime.now() - timedelta(days=n_days)
 
         if last_success > threshold:
-            logger.info(f"Last successful run for '{task_name}' was too recent - skipping task")
+            logger.info("Last successful run for '%s' was too recent - skipping task", task_name)
             return False
 
     # Check for any information we have about this task
@@ -133,7 +133,7 @@ def check_daily_holdoff(task_name: str, n_days: int = 1) -> bool:
         threshold = datetime.now() - timedelta(hours=12)
 
         if last_attempt > threshold:
-            logger.info(f"Last attempt for '{task_name}' was too recent - skipping task")
+            logger.info("Last attempt for '%s' was too recent - skipping task", task_name)
             return False
 
     # Record this attempt
@@ -145,27 +145,27 @@ def check_daily_holdoff(task_name: str, n_days: int = 1) -> bool:
 
 def record_task_attempt(task_name: str):
     """Record that a multi-day task has been attempted *now*"""
-
     from common.models import InvenTreeSetting
 
-    logger.info(f"Logging task attempt for '{task_name}'")
+    logger.info("Logging task attempt for '%s'", task_name)
 
     InvenTreeSetting.set_setting(f'_{task_name}_ATTEMPT', datetime.now().isoformat(), None)
 
 
 def record_task_success(task_name: str):
     """Record that a multi-day task was successful *now*"""
-
     from common.models import InvenTreeSetting
 
     InvenTreeSetting.set_setting(f'_{task_name}_SUCCESS', datetime.now().isoformat(), None)
 
 
-def offload_task(taskname, *args, force_async=False, force_sync=False, **kwargs):
+def offload_task(taskname, *args, force_async=False, force_sync=False, **kwargs) -> bool:
     """Create an AsyncTask if workers are running. This is different to a 'scheduled' task, in that it only runs once!
 
-    If workers are not running or force_sync flag
-    is set then the task is ran synchronously.
+    If workers are not running or force_sync flag, is set then the task is ran synchronously.
+
+    Returns:
+        bool: True if the task was offloaded (or ran), False otherwise
     """
     try:
         import importlib
@@ -174,18 +174,33 @@ def offload_task(taskname, *args, force_async=False, force_sync=False, **kwargs)
 
         from InvenTree.status import is_worker_running
     except AppRegistryNotReady:  # pragma: no cover
-        logger.warning(f"Could not offload task '{taskname}' - app registry not ready")
-        return
+        logger.warning("Could not offload task '%s' - app registry not ready", taskname)
+
+        if force_async:
+            # Cannot async the task, so return False
+            return False
+        else:
+            force_sync = True
     except (OperationalError, ProgrammingError):  # pragma: no cover
         raise_warning(f"Could not offload task '{taskname}' - database not ready")
 
+        if force_async:
+            # Cannot async the task, so return False
+            return False
+        else:
+            force_sync = True
+
     if force_async or (is_worker_running() and not force_sync):
         # Running as asynchronous task
         try:
             task = AsyncTask(taskname, *args, **kwargs)
             task.run()
         except ImportError:
-            raise_warning(f"WARNING: '{taskname}' not started - Function not found")
+            raise_warning(f"WARNING: '{taskname}' not offloaded - Function not found")
+            return False
+        except Exception as exc:
+            raise_warning(f"WARNING: '{taskname}' not offloaded due to {str(exc)}")
+            return False
     else:
 
         if callable(taskname):
@@ -198,14 +213,14 @@ def offload_task(taskname, *args, force_async=False, force_sync=False, **kwargs)
                 app_mod = app + '.' + mod
             except ValueError:
                 raise_warning(f"WARNING: '{taskname}' not started - Malformed function path")
-                return
+                return False
 
             # Import module from app
             try:
                 _mod = importlib.import_module(app_mod)
             except ModuleNotFoundError:
                 raise_warning(f"WARNING: '{taskname}' not started - No module named '{app_mod}'")
-                return
+                return False
 
             # Retrieve function
             try:
@@ -219,10 +234,17 @@ def offload_task(taskname, *args, force_async=False, force_sync=False, **kwargs)
                     _func = eval(func)  # pragma: no cover
             except NameError:
                 raise_warning(f"WARNING: '{taskname}' not started - No function named '{func}'")
-                return
+                return False
 
         # Workers are not running: run it as synchronous task
-        _func(*args, **kwargs)
+        try:
+            _func(*args, **kwargs)
+        except Exception as exc:
+            raise_warning(f"WARNING: '{taskname}' not started due to {str(exc)}")
+            return False
+
+    # Finally, task either completed successfully or was offloaded
+    return True
 
 
 @dataclass()
@@ -249,7 +271,7 @@ class ScheduledTask:
 
 
 class TaskRegister:
-    """Registery for periodicall tasks."""
+    """Registry for periodic tasks."""
     task_list: List[ScheduledTask] = []
 
     def register(self, task, schedule, minutes: int = None):
@@ -265,8 +287,9 @@ def scheduled_task(interval: str, minutes: int = None, tasklist: TaskRegister =
 
     Example:
     ```python
-    @register(ScheduledTask.DAILY)
-    def my_custom_funciton():
+    @scheduled_task(ScheduledTask.DAILY)
+    def my_custom_function():
+        # Perform a custom function once per day
         ...
     ```
 
@@ -338,7 +361,7 @@ def delete_successful_tasks():
         )
 
         if results.count() > 0:
-            logger.info(f"Deleting {results.count()} successful task records")
+            logger.info("Deleting %s successful task records", results.count())
             results.delete()
 
     except AppRegistryNotReady:  # pragma: no cover
@@ -348,7 +371,6 @@ def delete_successful_tasks():
 @scheduled_task(ScheduledTask.DAILY)
 def delete_failed_tasks():
     """Delete failed task logs which are older than a specified period"""
-
     try:
         from django_q.models import Failure
 
@@ -363,7 +385,7 @@ def delete_failed_tasks():
         )
 
         if results.count() > 0:
-            logger.info(f"Deleting {results.count()} failed task records")
+            logger.info("Deleting %s failed task records", results.count())
             results.delete()
 
     except AppRegistryNotReady:  # pragma: no cover
@@ -386,7 +408,7 @@ def delete_old_error_logs():
         )
 
         if errors.count() > 0:
-            logger.info(f"Deleting {errors.count()} old error logs")
+            logger.info("Deleting %s old error logs", errors.count())
             errors.delete()
 
     except AppRegistryNotReady:  # pragma: no cover
@@ -397,7 +419,6 @@ def delete_old_error_logs():
 @scheduled_task(ScheduledTask.DAILY)
 def delete_old_notifications():
     """Delete old notification logs"""
-
     try:
         from common.models import (InvenTreeSetting, NotificationEntry,
                                    NotificationMessage)
@@ -410,7 +431,7 @@ def delete_old_notifications():
         )
 
         if items.count() > 0:
-            logger.info(f"Deleted {items.count()} old notification entries")
+            logger.info("Deleted %s old notification entries", items.count())
             items.delete()
 
         items = NotificationMessage.objects.filter(
@@ -418,7 +439,7 @@ def delete_old_notifications():
         )
 
         if items.count() > 0:
-            logger.info(f"Deleted {items.count()} old notification messages")
+            logger.info("Deleted %s old notification messages", items.count())
             items.delete()
 
     except AppRegistryNotReady:
@@ -470,7 +491,7 @@ def check_for_updates():
     match = re.match(r"^.*(\d+)\.(\d+)\.(\d+).*$", tag)
 
     if len(match.groups()) != 3:  # pragma: no cover
-        logger.warning(f"Version '{tag}' did not match expected pattern")
+        logger.warning("Version '%s' did not match expected pattern", tag)
         return
 
     latest_version = [int(x) for x in match.groups()]
@@ -478,7 +499,7 @@ def check_for_updates():
     if len(latest_version) != 3:
         raise ValueError(f"Version '{tag}' is not correct format")  # pragma: no cover
 
-    logger.info(f"Latest InvenTree version: '{tag}'")
+    logger.info("Latest InvenTree version: '%s'", tag)
 
     # Save the version to the database
     common.models.InvenTreeSetting.set_setting(
@@ -492,51 +513,55 @@ def check_for_updates():
 
 
 @scheduled_task(ScheduledTask.DAILY)
-def update_exchange_rates():
-    """Update currency exchange rates."""
-    try:
-        from djmoney.contrib.exchange.models import ExchangeBackend, Rate
+def update_exchange_rates(force: bool = False):
+    """Update currency exchange rates
 
+    Arguments:
+        force: If True, force the update to run regardless of the last update time
+    """
+    try:
+        from djmoney.contrib.exchange.models import Rate
+
+        from common.models import InvenTreeSetting
         from common.settings import currency_code_default, currency_codes
         from InvenTree.exchange import InvenTreeExchange
     except AppRegistryNotReady:  # pragma: no cover
         # Apps not yet loaded!
         logger.info("Could not perform 'update_exchange_rates' - App registry not ready")
         return
-    except Exception:  # pragma: no cover
-        # Other error?
+    except Exception as exc:  # pragma: no cover
+        logger.info("Could not perform 'update_exchange_rates' - %s", exc)
         return
 
-    # Test to see if the database is ready yet
-    try:
-        backend = ExchangeBackend.objects.get(name='InvenTreeExchange')
-    except ExchangeBackend.DoesNotExist:
-        pass
-    except Exception:  # pragma: no cover
-        # Some other error
-        logger.warning("update_exchange_rates: Database not ready")
-        return
+    if not force:
+        interval = int(InvenTreeSetting.get_setting('CURRENCY_UPDATE_INTERVAL', 1, cache=False))
+
+        if not check_daily_holdoff('update_exchange_rates', interval):
+            logger.info("Skipping exchange rate update (interval not reached)")
+            return
 
     backend = InvenTreeExchange()
-    logger.info(f"Updating exchange rates from {backend.url}")
-
     base = currency_code_default()
-
-    logger.info(f"Using base currency '{base}'")
+    logger.info("Updating exchange rates using base currency '%s'", base)
 
     try:
         backend.update_rates(base_currency=base)
 
         # Remove any exchange rates which are not in the provided currencies
         Rate.objects.filter(backend="InvenTreeExchange").exclude(currency__in=currency_codes()).delete()
+
+        # Record successful task execution
+        record_task_success('update_exchange_rates')
+
+    except (AppRegistryNotReady, OperationalError, ProgrammingError):
+        logger.warning("Could not update exchange rates - database not ready")
     except Exception as e:  # pragma: no cover
-        logger.error(f"Error updating exchange rates: {e}")
+        logger.exception("Error updating exchange rates: %s", str(type(e)))
 
 
 @scheduled_task(ScheduledTask.DAILY)
 def run_backup():
     """Run the backup command."""
-
     from common.models import InvenTreeSetting
 
     if not InvenTreeSetting.get_setting('INVENTREE_BACKUP_ENABLE', False, cache=False):
@@ -558,88 +583,77 @@ def run_backup():
     record_task_success('run_backup')
 
 
-def send_email(subject, body, recipients, from_email=None, html_message=None):
-    """Send an email with the specified subject and body, to the specified recipients list."""
-    if type(recipients) == str:
-        recipients = [recipients]
-
-    offload_task(
-        django_mail.send_mail,
-        subject,
-        body,
-        from_email,
-        recipients,
-        fail_silently=False,
-        html_message=html_message
-    )
+def get_migration_plan():
+    """Returns a list of migrations which are needed to be run."""
+    executor = MigrationExecutor(connections[DEFAULT_DB_ALIAS])
+    plan = executor.migration_plan(executor.loader.graph.leaf_nodes())
+    return plan
 
 
 @scheduled_task(ScheduledTask.DAILY)
-def check_for_migrations(worker: bool = True):
+def check_for_migrations():
     """Checks if migrations are needed.
 
-    If the setting auto_update is enabled we will start updateing.
+    If the setting auto_update is enabled we will start updating.
     """
-    # Test if auto-updates are enabled
-    if not get_setting('INVENTREE_AUTO_UPDATE', 'auto_update'):
-        return
-
+    from common.models import InvenTreeSetting
     from plugin import registry
 
+    def set_pending_migrations(n: int):
+        """Helper function to inform the user about pending migrations"""
+
+        logger.info('There are %s pending migrations', n)
+        InvenTreeSetting.set_setting('_PENDING_MIGRATIONS', n, None)
+
+    logger.info("Checking for pending database migrations")
+
+    # Force plugin registry reload
+    registry.check_reload()
+
     plan = get_migration_plan()
 
+    n = len(plan)
+
     # Check if there are any open migrations
     if not plan:
-        logger.info('There are no open migrations')
+        set_pending_migrations(0)
         return
 
-    logger.info('There are open migrations')
+    set_pending_migrations(n)
+
+    # Test if auto-updates are enabled
+    if not get_setting('INVENTREE_AUTO_UPDATE', 'auto_update'):
+        logger.info("Auto-update is disabled - skipping migrations")
+        return
 
     # Log open migrations
     for migration in plan:
-        logger.info(migration[0])
+        logger.info("- %s", str(migration[0]))
 
     # Set the application to maintenance mode - no access from now on.
-    logger.info('Going into maintenance')
     set_maintenance_mode(True)
-    logger.info('Mainentance mode is on now')
 
-    # Check if we are worker - go kill all other workers then.
-    # Only the frontend workers run updates.
-    if worker:
-        logger.info('Current process is a worker - shutting down cluster')
-
-    # Ok now we are ready to go ahead!
     # To be sure we are in maintenance this is wrapped
     with maintenance_mode_on():
-        logger.info('Starting migrations')
-        print('Starting migrations')
+        logger.info('Starting migration process...')
 
         try:
             call_command('migrate', interactive=False)
         except NotSupportedError as e:  # pragma: no cover
             if settings.DATABASES['default']['ENGINE'] != 'django.db.backends.sqlite3':
                 raise e
-            logger.error(f'Error during migrations: {e}')
+            logger.exception('Error during migrations: %s', e)
+        else:
+            set_pending_migrations(0)
 
-        print('Migrations done')
-        logger.info('Ran migrations')
+            logger.info("Completed %s migrations", n)
 
-    # Make sure we are out of maintenance again
-    logger.info('Checking InvenTree left maintenance mode')
+    # Make sure we are out of maintenance mode
     if get_maintenance_mode():
-
-        logger.warning('Mainentance was still on - releasing now')
+        logger.warning("Maintenance mode was not disabled - forcing it now")
         set_maintenance_mode(False)
-        logger.info('Released out of maintenance')
+        logger.info("Manually released maintenance mode")
 
     # We should be current now - triggering full reload to make sure all models
     # are loaded fully in their new state.
-    registry.reload_plugins(full_reload=True, force_reload=True)
-
-
-def get_migration_plan():
-    """Returns a list of migrations which are needed to be run."""
-    executor = MigrationExecutor(connections[DEFAULT_DB_ALIAS])
-    plan = executor.migration_plan(executor.loader.graph.leaf_nodes())
-    return plan
+    registry.reload_plugins(full_reload=True, force_reload=True, collect=True)

InvenTree/InvenTree/template.py

@@ -0,0 +1,35 @@
+"""Custom template loader for InvenTree"""
+
+import os
+
+from django.conf import settings
+from django.template.loaders.base import Loader as BaseLoader
+from django.template.loaders.cached import Loader as CachedLoader
+
+
+class InvenTreeTemplateLoader(CachedLoader):
+    """Custom template loader which bypasses cache for PDF export"""
+
+    def get_template(self, template_name, skip=None):
+        """Return a template object for the given template name.
+
+        Any custom report or label templates will be forced to reload (without cache).
+        This ensures that generated PDF reports / labels are always up-to-date.
+        """
+        # List of template patterns to skip cache for
+        skip_cache_dirs = [
+            os.path.abspath(os.path.join(settings.MEDIA_ROOT, 'report')),
+            os.path.abspath(os.path.join(settings.MEDIA_ROOT, 'label')),
+            'snippets/',
+        ]
+
+        # Initially load the template using the cached loader
+        template = CachedLoader.get_template(self, template_name, skip)
+
+        template_path = str(template.name)
+
+        # If the template matches any of the skip patterns, reload it without cache
+        if any(template_path.startswith(d) for d in skip_cache_dirs):
+            template = BaseLoader.get_template(self, template_name, skip)
+
+        return template

InvenTree/InvenTree/templates/InvenTree/user_simple_login.txt

@@ -0,0 +1,8 @@
+Hello {{username}},
+
+You requested that we send you a link to log in to our app:
+
+    {{link}}
+
+Regards,
+{{site_name}}

InvenTree/InvenTree/test_api.py

@@ -6,8 +6,7 @@ from django.urls import reverse
 
 from rest_framework import status
 
-from InvenTree.api_tester import InvenTreeAPITestCase
-from InvenTree.helpers import InvenTreeTestCase
+from InvenTree.unit_test import InvenTreeAPITestCase, InvenTreeTestCase
 from users.models import RuleSet, update_group_roles
 
 
@@ -268,7 +267,6 @@ class BulkDeleteTests(InvenTreeAPITestCase):
 
     def test_errors(self):
         """Test that the correct errors are thrown"""
-
         url = reverse('api-stock-test-result-list')
 
         # DELETE without any of the required fields
@@ -317,9 +315,20 @@ class SearchTests(InvenTreeAPITestCase):
         'sales_order',
     ]
 
+    def test_empty(self):
+        """Test empty request"""
+        data = [
+            '',
+            None,
+            {},
+        ]
+
+        for d in data:
+            response = self.post(reverse('api-search'), d, expected_code=400)
+            self.assertIn('Search term must be provided', str(response.data))
+
     def test_results(self):
         """Test individual result types"""
-
         response = self.post(
             reverse('api-search'),
             {
@@ -362,7 +371,6 @@ class SearchTests(InvenTreeAPITestCase):
 
     def test_permissions(self):
         """Test that users with insufficient permissions are handled correctly"""
-
         # First, remove all roles
         for ruleset in self.group.rule_sets.all():
             ruleset.can_view = False

InvenTree/InvenTree/test_api_version.py

@@ -0,0 +1,41 @@
+"""Tests for api_version."""
+
+
+from django.urls import reverse
+
+from InvenTree.api_version import INVENTREE_API_VERSION
+from InvenTree.unit_test import InvenTreeAPITestCase
+from InvenTree.version import inventreeApiText, parse_version_text
+
+
+class ApiVersionTests(InvenTreeAPITestCase):
+    """Tests for api_version functions and APIs."""
+
+    def test_api(self):
+        """Test that the API text is correct."""
+        url = reverse('api-version-text')
+        response = self.client.get(url, format='json')
+        data = response.json()
+
+        self.assertEqual(len(data), 10)
+
+    def test_inventree_api_text(self):
+        """Test that the inventreeApiText function works expected."""
+        # Normal run
+        resp = inventreeApiText()
+        self.assertEqual(len(resp), 10)
+
+        # More responses
+        resp = inventreeApiText(20)
+        self.assertEqual(len(resp), 20)
+
+        # Specific version
+        resp = inventreeApiText(start_version=5)
+        self.assertEqual(list(resp)[0], 'v5')
+
+    def test_parse_version_text(self):
+        """Test that api version text is correctly parsed."""
+        resp = parse_version_text()
+
+        # Check that all texts are parsed
+        self.assertEqual(len(resp), INVENTREE_API_VERSION - 1)

InvenTree/InvenTree/test_middleware.py

@@ -7,7 +7,7 @@ from django.urls import reverse
 from error_report.models import Error
 
 from InvenTree.exceptions import log_error
-from InvenTree.helpers import InvenTreeTestCase
+from InvenTree.unit_test import InvenTreeTestCase
 
 
 class MiddlewareTests(InvenTreeTestCase):
@@ -28,13 +28,13 @@ class MiddlewareTests(InvenTreeTestCase):
         self.client.logout()
 
         # check that static files go through
-        # TODO @matmair reenable this check
+        # TODO @matmair re-enable this check
         # self.check_path('/static/css/inventree.css', 302)
 
         # check that account things go through
         self.check_path(reverse('account_login'))
 
-        # logout goes diretly to login
+        # logout goes directly to login
         self.check_path(reverse('account_logout'))
 
         # check that frontend code is redirected to login

InvenTree/InvenTree/test_tasks.py

@@ -70,11 +70,11 @@ class InvenTreeTaskTests(TestCase):
         with self.assertWarnsMessage(UserWarning, "WARNING: 'InvenTree' not started - Malformed function path"):
             InvenTree.tasks.offload_task('InvenTree')
 
-        # Non exsistent app
+        # Non existent app
         with self.assertWarnsMessage(UserWarning, "WARNING: 'InvenTreeABC.test_tasks.doesnotmatter' not started - No module named 'InvenTreeABC.test_tasks'"):
             InvenTree.tasks.offload_task('InvenTreeABC.test_tasks.doesnotmatter')
 
-        # Non exsistent function
+        # Non existent function
         with self.assertWarnsMessage(UserWarning, "WARNING: 'InvenTree.test_tasks.doesnotexsist' not started - No function named 'doesnotexsist'"):
             InvenTree.tasks.offload_task('InvenTree.test_tasks.doesnotexsist')
 

InvenTree/InvenTree/test_urls.py

@@ -14,18 +14,18 @@ class URLTest(TestCase):
     # Need fixture data in the database
     fixtures = [
         'settings',
-        'build',
         'company',
         'manufacturer_part',
         'price_breaks',
         'supplier_part',
         'order',
         'sales_order',
-        'bom',
         'category',
         'params',
         'part_pricebreaks',
         'part',
+        'bom',
+        'build',
         'test_templates',
         'location',
         'stock_tests',

InvenTree/InvenTree/test_views.py

@@ -5,7 +5,7 @@ import os
 from django.contrib.auth import get_user_model
 from django.urls import reverse
 
-from InvenTree.helpers import InvenTreeTestCase
+from InvenTree.unit_test import InvenTreeTestCase
 
 
 class ViewTests(InvenTreeTestCase):
@@ -45,7 +45,6 @@ class ViewTests(InvenTreeTestCase):
 
     def test_settings_page(self):
         """Test that the 'settings' page loads correctly"""
-
         # Settings page loads
         url = reverse('settings')
 
@@ -122,7 +121,6 @@ class ViewTests(InvenTreeTestCase):
 
     def test_url_login(self):
         """Test logging in via arguments"""
-
         # Log out
         self.client.logout()
         response = self.client.get("/index/")

InvenTree/InvenTree/tests.py

@@ -11,20 +11,26 @@ import django.core.exceptions as django_exceptions
 from django.conf import settings
 from django.contrib.auth import get_user_model
 from django.contrib.sites.models import Site
+from django.core import mail
 from django.core.exceptions import ValidationError
 from django.test import TestCase, override_settings
+from django.urls import reverse
 
-import requests
+import pint.errors
 from djmoney.contrib.exchange.exceptions import MissingRate
 from djmoney.contrib.exchange.models import Rate, convert_money
 from djmoney.money import Money
+from sesame.utils import get_user
 
+import InvenTree.conversion
 import InvenTree.format
 import InvenTree.helpers
+import InvenTree.helpers_model
 import InvenTree.tasks
-from common.models import InvenTreeSetting
+from common.models import CustomUnit, InvenTreeSetting
 from common.settings import currency_codes
 from InvenTree.sanitizer import sanitize_svg
+from InvenTree.unit_test import InvenTreeTestCase
 from part.models import Part, PartCategory
 from stock.models import StockItem, StockLocation
 
@@ -33,6 +39,146 @@ from .tasks import offload_task
 from .validators import validate_overage
 
 
+class ConversionTest(TestCase):
+    """Tests for conversion of physical units"""
+
+    def test_prefixes(self):
+        """Test inputs where prefixes are used"""
+        tests = {
+            "3": 3,
+            "3m": 3,
+            "3mm": 0.003,
+            "3k": 3000,
+            "3u": 0.000003,
+            "3 inch": 0.0762,
+        }
+
+        for val, expected in tests.items():
+            q = InvenTree.conversion.convert_physical_value(val, 'm')
+            self.assertAlmostEqual(q, expected, 3)
+
+    def test_base_units(self):
+        """Test conversion to specified base units"""
+        tests = {
+            "3": 3,
+            "3 dozen": 36,
+            "50 dozen kW": 600000,
+            "1 / 10": 0.1,
+            "1/2 kW": 500,
+            "1/2 dozen kW": 6000,
+            "0.005 MW": 5000,
+        }
+
+        for val, expected in tests.items():
+            q = InvenTree.conversion.convert_physical_value(val, 'W')
+            self.assertAlmostEqual(q, expected, places=2)
+            q = InvenTree.conversion.convert_physical_value(val, 'W', strip_units=False)
+            self.assertAlmostEqual(float(q.magnitude), expected, places=2)
+
+    def test_dimensionless_units(self):
+        """Tests for 'dimensionless' unit quantities"""
+        # Test some dimensionless units
+        tests = {
+            'ea': 1,
+            'each': 1,
+            '3 piece': 3,
+            '5 dozen': 60,
+            '3 hundred': 300,
+            '2 thousand': 2000,
+            '12 pieces': 12,
+            '1 / 10': 0.1,
+            '1/2': 0.5,
+            '-1 / 16': -0.0625,
+            '3/2': 1.5,
+            '1/2 dozen': 6,
+        }
+
+        for val, expected in tests.items():
+            # Convert, and leave units
+            q = InvenTree.conversion.convert_physical_value(val, strip_units=False)
+            self.assertAlmostEqual(float(q.magnitude), expected, 3)
+
+            # Convert, and strip units
+            q = InvenTree.conversion.convert_physical_value(val)
+            self.assertAlmostEqual(q, expected, 3)
+
+    def test_invalid_units(self):
+        """Test conversion with bad units"""
+        tests = {
+            '3': '10',
+            '13': '-?-',
+            '-3': 'xyz',
+            '-12': '-12',
+            '1/0': '1/0',
+        }
+
+        for val, unit in tests.items():
+            with self.assertRaises(ValidationError):
+                InvenTree.conversion.convert_physical_value(val, unit)
+
+    def test_invalid_values(self):
+        """Test conversion of invalid inputs"""
+        inputs = [
+            '-x',
+            '1/0',
+            'xyz',
+            '12B45C'
+        ]
+
+        for val in inputs:
+            # Test with a provided unit
+            with self.assertRaises(ValidationError):
+                InvenTree.conversion.convert_physical_value(val, 'meter')
+
+            # Test dimensionless
+            with self.assertRaises(ValidationError):
+                InvenTree.conversion.convert_physical_value(val)
+
+    def test_custom_units(self):
+        """Tests for custom unit conversion"""
+        # Start with an empty set of units
+        CustomUnit.objects.all().delete()
+        InvenTree.conversion.reload_unit_registry()
+
+        # Ensure that the custom unit does *not* exist to start with
+        reg = InvenTree.conversion.get_unit_registry()
+
+        with self.assertRaises(pint.errors.UndefinedUnitError):
+            reg['hpmm']
+
+        # Create a new custom unit
+        CustomUnit.objects.create(
+            name='fanciful_unit',
+            definition='henry / mm',
+            symbol='hpmm',
+        )
+
+        # Reload registry
+        reg = InvenTree.conversion.get_unit_registry()
+
+        # Ensure that the custom unit is now available
+        reg['hpmm']
+
+        # Convert some values
+        tests = {
+            '1': 1,
+            '1 hpmm': 1000000,
+            '1 / 10 hpmm': 100000,
+            '1 / 100 hpmm': 10000,
+            '0.3 hpmm': 300000,
+            '-7hpmm': -7000000,
+        }
+
+        for val, expected in tests.items():
+            # Convert, and leave units
+            q = InvenTree.conversion.convert_physical_value(val, 'henry / km', strip_units=False)
+            self.assertAlmostEqual(float(q.magnitude), expected, 2)
+
+            # Convert and strip units
+            q = InvenTree.conversion.convert_physical_value(val, 'henry / km')
+            self.assertAlmostEqual(q, expected, 2)
+
+
 class ValidatorTest(TestCase):
     """Simple tests for custom field validators."""
 
@@ -57,13 +203,43 @@ class ValidatorTest(TestCase):
         with self.assertRaises(django_exceptions.ValidationError):
             validate_overage("aaaa")
 
+    def test_url_validation(self):
+        """Test for AllowedURLValidator"""
+
+        from common.models import InvenTreeSetting
+        from part.models import Part, PartCategory
+
+        # Without strict URL validation
+        InvenTreeSetting.set_setting('INVENTREE_STRICT_URLS', False, None)
+
+        n = Part.objects.count()
+        cat = PartCategory.objects.first()
+
+        # Should pass, even without a schema
+        Part.objects.create(
+            name=f'Part {n}',
+            description='Link without schema',
+            category=cat,
+            link='www.google.com',
+        )
+
+        # With strict URL validation
+        InvenTreeSetting.set_setting('INVENTREE_STRICT_URLS', True, None)
+
+        with self.assertRaises(ValidationError):
+            Part.objects.create(
+                name=f'Part {n + 1}',
+                description='Link without schema',
+                category=cat,
+                link='www.google.com',
+            )
+
 
 class FormatTest(TestCase):
     """Unit tests for custom string formatting functionality"""
 
     def test_parse(self):
         """Tests for the 'parse_format_string' function"""
-
         # Extract data from a valid format string
         fmt = "PO-{abc:02f}-{ref:04d}-{date}-???"
 
@@ -85,7 +261,6 @@ class FormatTest(TestCase):
 
     def test_create_regex(self):
         """Test function for creating a regex from a format string"""
-
         tests = {
             "PO-123-{ref:04f}": r"^PO\-123\-(?P<ref>.+)$",
             "{PO}-???-{ref}-{date}-22": r"^(?P<PO>.+)\-...\-(?P<ref>.+)\-(?P<date>.+)\-22$",
@@ -98,7 +273,6 @@ class FormatTest(TestCase):
 
     def test_validate_format(self):
         """Test that string validation works as expected"""
-
         # These tests should pass
         for value, pattern in {
             "ABC-hello-123": "???-{q}-###",
@@ -119,7 +293,6 @@ class FormatTest(TestCase):
 
     def test_extract_value(self):
         """Test that we can extract named values based on a format string"""
-
         # Simple tests based on a straight-forward format string
         fmt = "PO-###-{ref:04d}"
 
@@ -188,10 +361,64 @@ class FormatTest(TestCase):
                 "PO-###-{test}",
             )
 
+    def test_currency_formatting(self):
+        """Test that currency formatting works correctly for multiple currencies"""
+
+        test_data = (
+            (Money(  3651.285718, "USD"), 4, "$3,651.2857"     ),  # noqa: E201,E202
+            (Money(487587.849178, "CAD"), 5, "CA$487,587.84918"),  # noqa: E201,E202
+            (Money(     0.348102, "EUR"), 1, "€0.3"            ),  # noqa: E201,E202
+            (Money(     0.916530, "GBP"), 1, "£0.9"            ),  # noqa: E201,E202
+            (Money(    61.031024, "JPY"), 3, "¥61.031"         ),  # noqa: E201,E202
+            (Money( 49609.694602, "JPY"), 1, "¥49,609.7"       ),  # noqa: E201,E202
+            (Money(155565.264777, "AUD"), 2, "A$155,565.26"    ),  # noqa: E201,E202
+            (Money(     0.820437, "CNY"), 4, "CN¥0.8204"       ),  # noqa: E201,E202
+            (Money(  7587.849178, "EUR"), 0, "€7,588"          ),  # noqa: E201,E202
+            (Money(     0.348102, "GBP"), 3, "£0.348"          ),  # noqa: E201,E202
+            (Money(     0.652923, "CHF"), 0, "CHF1"            ),  # noqa: E201,E202
+            (Money(     0.820437, "CNY"), 1, "CN¥0.8"          ),  # noqa: E201,E202
+            (Money(98789.5295680, "CHF"), 0, "CHF98,790"       ),  # noqa: E201,E202
+            (Money(     0.585787, "USD"), 1, "$0.6"            ),  # noqa: E201,E202
+            (Money(     0.690541, "CAD"), 3, "CA$0.691"        ),  # noqa: E201,E202
+            (Money(   427.814104, "AUD"), 5, "A$427.81410"     ),  # noqa: E201,E202
+        )
+
+        with self.settings(LANGUAGE_CODE="en-us"):
+            for value, decimal_places, expected_result in test_data:
+                result = InvenTree.format.format_money(value, decimal_places=decimal_places)
+                assert result == expected_result
+
 
 class TestHelpers(TestCase):
     """Tests for InvenTree helper functions."""
 
+    def test_absolute_url(self):
+        """Test helper function for generating an absolute URL"""
+        base = "https://demo.inventree.org:12345"
+
+        InvenTreeSetting.set_setting('INVENTREE_BASE_URL', base, change_user=None)
+
+        tests = {
+            "": base,
+            "api/": base + "/api/",
+            "/api/": base + "/api/",
+            "api": base + "/api",
+            "media/label/output/": base + "/media/label/output/",
+            "static/logo.png": base + "/static/logo.png",
+            "https://www.google.com": "https://www.google.com",
+            "https://demo.inventree.org:12345/out.html": "https://demo.inventree.org:12345/out.html",
+            "https://demo.inventree.org/test.html": "https://demo.inventree.org/test.html",
+            "http://www.cwi.nl:80/%7Eguido/Python.html": "http://www.cwi.nl:80/%7Eguido/Python.html",
+            "test.org": base + "/test.org",
+        }
+
+        for url, expected in tests.items():
+            # Test with supplied base URL
+            self.assertEqual(InvenTree.helpers_model.construct_absolute_url(url, site_url=base), expected)
+
+            # Test without supplied base URL
+            self.assertEqual(InvenTree.helpers_model.construct_absolute_url(url), expected)
+
     def test_image_url(self):
         """Test if a filename looks like an image."""
         for name in ['ape.png', 'bat.GiF', 'apple.WeBP', 'BiTMap.Bmp']:
@@ -239,9 +466,7 @@ class TestHelpers(TestCase):
 
     def test_logo_image(self):
         """Test for retrieving logo image"""
-
         # By default, there is no custom logo provided
-
         logo = helpers.getLogoImage()
         self.assertEqual(logo, '/static/img/inventree.png')
 
@@ -250,7 +475,6 @@ class TestHelpers(TestCase):
 
     def test_download_image(self):
         """Test function for downloading image from remote URL"""
-
         # Run check with a sequence of bad URLs
         for url in [
             "blog",
@@ -259,12 +483,12 @@ class TestHelpers(TestCase):
             "\\invalid-url"
         ]:
             with self.assertRaises(django_exceptions.ValidationError):
-                helpers.download_image_from_url(url)
+                InvenTree.helpers_model.download_image_from_url(url)
 
         def dl_helper(url, expected_error, timeout=2.5, retries=3):
             """Helper function for unit testing downloads.
 
-            As the httpstat.us service occassionaly refuses a connection,
+            As the httpstat.us service occasionally refuses a connection,
             we will simply try multiple times
             """
 
@@ -274,7 +498,7 @@ class TestHelpers(TestCase):
                 while tries < retries:
 
                     try:
-                        helpers.download_image_from_url(url, timeout=timeout)
+                        InvenTree.helpers_model.download_image_from_url(url, timeout=timeout)
                         break
                     except Exception as exc:
                         if type(exc) is expected_error:
@@ -287,10 +511,12 @@ class TestHelpers(TestCase):
                     time.sleep(10 * tries)
 
         # Attempt to download an image which throws a 404
-        dl_helper("https://httpstat.us/404", requests.exceptions.HTTPError, timeout=10)
+        # TODO: Re-implement this test when we are happier with the external service
+        # dl_helper("https://httpstat.us/404", requests.exceptions.HTTPError, timeout=10)
 
         # Attempt to download, but timeout
-        dl_helper("https://httpstat.us/200?sleep=5000", requests.exceptions.ReadTimeout, timeout=1)
+        # TODO: Re-implement this test when we are happier with the external service
+        # dl_helper("https://httpstat.us/200?sleep=5000", requests.exceptions.ReadTimeout, timeout=1)
 
         large_img = "https://github.com/inventree/InvenTree/raw/master/InvenTree/InvenTree/static/img/paper_splash_large.jpg"
 
@@ -298,13 +524,26 @@ class TestHelpers(TestCase):
 
         # Attempt to download an image which is too large
         with self.assertRaises(ValueError):
-            helpers.download_image_from_url(large_img, timeout=10)
+            InvenTree.helpers_model.download_image_from_url(large_img, timeout=10)
 
         # Increase allowable download size
         InvenTreeSetting.set_setting('INVENTREE_DOWNLOAD_IMAGE_MAX_SIZE', 5, change_user=None)
 
         # Download a valid image (should not throw an error)
-        helpers.download_image_from_url(large_img, timeout=10)
+        InvenTree.helpers_model.download_image_from_url(large_img, timeout=10)
+
+    def test_model_mixin(self):
+        """Test the getModelsWithMixin function"""
+        from InvenTree.models import InvenTreeBarcodeMixin
+
+        models = InvenTree.helpers_model.getModelsWithMixin(InvenTreeBarcodeMixin)
+
+        self.assertIn(Part, models)
+        self.assertIn(StockLocation, models)
+        self.assertIn(StockItem, models)
+
+        self.assertNotIn(PartCategory, models)
+        self.assertNotIn(InvenTreeSetting, models)
 
 
 class TestQuoteWrap(TestCase):
@@ -502,7 +741,7 @@ class TestSerialNumberExtraction(TestCase):
         self.assertEqual(sn, ['5', '6', '7', '8'])
 
     def test_failures(self):
-        """Test wron serial numbers."""
+        """Test wrong serial numbers."""
         e = helpers.extract_serial_numbers
 
         # Test duplicates
@@ -660,6 +899,7 @@ class CurrencyTests(TestCase):
 
             else:  # pragma: no cover
                 print("Exchange rate update failed - retrying")
+                print(f'Expected {currency_codes()}, got {[a.currency for a in rates]}')
                 time.sleep(1)
 
         self.assertTrue(update_successful)
@@ -683,7 +923,7 @@ class CurrencyTests(TestCase):
 class TestStatus(TestCase):
     """Unit tests for status functions."""
 
-    def test_check_system_healt(self):
+    def test_check_system_health(self):
         """Test that the system health check is false in testing -> background worker not running."""
         self.assertEqual(status.check_system_health(), False)
 
@@ -696,7 +936,7 @@ class TestStatus(TestCase):
         self.assertEqual(ready.isImportingData(), False)
 
 
-class TestSettings(helpers.InvenTreeTestCase):
+class TestSettings(InvenTreeTestCase):
     """Unit tests for settings."""
 
     superuser = True
@@ -779,7 +1019,7 @@ class TestSettings(helpers.InvenTreeTestCase):
             InvenTreeSetting.set_setting('PLUGIN_ON_STARTUP', True, self.user)
             registry.reload_plugins(full_reload=True)
 
-        # Check that there was anotehr run
+        # Check that there was another run
         response = registry.install_plugin_file()
         self.assertEqual(response, True)
 
@@ -792,7 +1032,7 @@ class TestSettings(helpers.InvenTreeTestCase):
             'inventree/data/config.yaml',
         ]
 
-        self.assertTrue(any([opt in str(config.get_config_file()).lower() for opt in valid]))
+        self.assertTrue(any(opt in str(config.get_config_file()).lower() for opt in valid))
 
         # with env set
         with self.in_env_context({'INVENTREE_CONFIG_FILE': 'my_special_conf.yaml'}):
@@ -807,7 +1047,7 @@ class TestSettings(helpers.InvenTreeTestCase):
             'inventree/data/plugins.txt',
         ]
 
-        self.assertTrue(any([opt in str(config.get_plugin_file()).lower() for opt in valid]))
+        self.assertTrue(any(opt in str(config.get_plugin_file()).lower() for opt in valid))
 
         # with env set
         with self.in_env_context({'INVENTREE_PLUGIN_FILE': 'my_special_plugins.txt'}):
@@ -835,7 +1075,7 @@ class TestSettings(helpers.InvenTreeTestCase):
             self.assertEqual(config.get_setting(TEST_ENV_NAME, None, typecast=dict), {})
 
 
-class TestInstanceName(helpers.InvenTreeTestCase):
+class TestInstanceName(InvenTreeTestCase):
     """Unit tests for instance name."""
 
     def test_instance_name(self):
@@ -863,7 +1103,7 @@ class TestInstanceName(helpers.InvenTreeTestCase):
         self.assertEqual(site_obj.domain, 'http://127.1.2.3')
 
 
-class TestOffloadTask(helpers.InvenTreeTestCase):
+class TestOffloadTask(InvenTreeTestCase):
     """Tests for offloading tasks to the background worker"""
 
     fixtures = [
@@ -887,29 +1127,41 @@ class TestOffloadTask(helpers.InvenTreeTestCase):
         Ref: https://github.com/inventree/InvenTree/pull/3273
         """
 
-        offload_task(
-            'dummy_tasks.parts',
-            part=Part.objects.get(pk=1),
-            cat=PartCategory.objects.get(pk=1),
-            force_async=True
-        )
-
-        offload_task(
+        self.assertTrue(offload_task(
             'dummy_tasks.stock',
             item=StockItem.objects.get(pk=1),
             loc=StockLocation.objects.get(pk=1),
             force_async=True
-        )
+        ))
 
-        offload_task(
+        self.assertTrue(offload_task(
             'dummy_task.numbers',
             1, 2, 3, 4, 5,
             force_async=True
-        )
+        ))
+
+        # Offload a dummy task, but force sync
+        # This should fail, because the function does not exist
+        with self.assertLogs(logger='inventree', level='WARNING') as log:
+            self.assertFalse(offload_task(
+                'dummy_task.numbers',
+                1, 1, 1,
+                force_sync=True
+            ))
+
+            self.assertIn("Malformed function path", str(log.output))
+
+        # Offload dummy task with a Part instance
+        # This should succeed, ensuring that the Part instance is correctly pickled
+        self.assertTrue(offload_task(
+            'dummy_tasks.parts',
+            part=Part.objects.get(pk=1),
+            cat=PartCategory.objects.get(pk=1),
+            force_async=True
+        ))
 
     def test_daily_holdoff(self):
         """Tests for daily task holdoff helper functions"""
-
         import InvenTree.tasks
 
         with self.assertLogs(logger='inventree', level='INFO') as cm:
@@ -960,12 +1212,11 @@ class TestOffloadTask(helpers.InvenTreeTestCase):
             self.assertTrue(result)
 
 
-class BarcodeMixinTest(helpers.InvenTreeTestCase):
+class BarcodeMixinTest(InvenTreeTestCase):
     """Tests for the InvenTreeBarcodeMixin mixin class"""
 
     def test_barcode_model_type(self):
         """Test that the barcode_model_type property works for each class"""
-
         from part.models import Part
         from stock.models import StockItem, StockLocation
 
@@ -973,9 +1224,8 @@ class BarcodeMixinTest(helpers.InvenTreeTestCase):
         self.assertEqual(StockItem.barcode_model_type(), 'stockitem')
         self.assertEqual(StockLocation.barcode_model_type(), 'stocklocation')
 
-    def test_bacode_hash(self):
+    def test_barcode_hash(self):
         """Test that the barcode hashing function provides correct results"""
-
         # Test multiple values for the hashing function
         # This is to ensure that the hash function is always "backwards compatible"
         hashing_tests = {
@@ -993,7 +1243,7 @@ class SanitizerTest(TestCase):
     """Simple tests for sanitizer functions."""
 
     def test_svg_sanitizer(self):
-        """Test that SVGs are sanitized acordingly."""
+        """Test that SVGs are sanitized accordingly."""
         valid_string = """<svg xmlns="http://www.w3.org/2000/svg" version="1.1" id="svg2" height="400" width="400">{0}
         <path id="path1" d="m -151.78571,359.62883 v 112.76373 l 97.068507,-56.04253 V 303.14815 Z" style="fill:#ddbc91;"></path>
         </svg>"""
@@ -1002,5 +1252,42 @@ class SanitizerTest(TestCase):
         # Test that valid string
         self.assertEqual(valid_string, sanitize_svg(valid_string))
 
-        # Test that invalid string is cleanded
+        # Test that invalid string is cleaned
         self.assertNotEqual(dangerous_string, sanitize_svg(dangerous_string))
+
+
+class MagicLoginTest(InvenTreeTestCase):
+    """Test magic login token generation."""
+
+    def test_generation(self):
+        """Test that magic login tokens are generated correctly"""
+        # User does not exists
+        resp = self.client.post(reverse('sesame-generate'), {'email': 1})
+        self.assertEqual(resp.status_code, 200)
+        self.assertEqual(resp.data, {'status': 'ok'})
+        self.assertEqual(len(mail.outbox), 0)
+
+        # User exists
+        resp = self.client.post(reverse('sesame-generate'), {'email': self.user.email})
+        self.assertEqual(resp.status_code, 200)
+        self.assertEqual(resp.data, {'status': 'ok'})
+        self.assertEqual(len(mail.outbox), 1)
+        self.assertEqual(mail.outbox[0].subject, '[example.com] Log in to the app')
+
+        # Check that the token is in the email
+        self.assertTrue('http://testserver/api/email/login/' in mail.outbox[0].body)
+        token = mail.outbox[0].body.split('/')[-1].split('\n')[0][8:]
+        self.assertEqual(get_user(token), self.user)
+
+        # Log user off
+        self.client.logout()
+
+        # Check that the login works
+        resp = self.client.get(reverse('sesame-login') + '?sesame=' + token)
+        self.assertEqual(resp.status_code, 302)
+        self.assertEqual(resp.url, '/index/')
+        # Note: 2023-08-08 - This test has been changed because "platform UI" is not generally available yet
+        # TODO: In the future, the URL comparison will need to be reverted
+        # self.assertEqual(resp.url, f'/{settings.FRONTEND_URL_BASE}/logged-in/')
+        # And we should be logged in again
+        self.assertEqual(resp.wsgi_request.user, self.user)

InvenTree/InvenTree/translation.py

@@ -0,0 +1,49 @@
+"""Translation helper functions"""
+
+import json
+
+from django.conf import settings
+
+# translation completion stats
+_translation_stats = None
+
+
+def reload_translation_stats():
+    """Reload the translation stats from the compiled file"""
+    global _translation_stats
+
+    STATS_FILE = settings.BASE_DIR.joinpath('InvenTree/locale_stats.json').absolute()
+
+    try:
+        with open(STATS_FILE, 'r') as f:
+            _translation_stats = json.load(f)
+    except Exception:
+        _translation_stats = None
+        return
+
+    keys = _translation_stats.keys()
+
+    # Note that the names used in the stats file may not align 100%
+    for (code, _lang) in settings.LANGUAGES:
+        if code in keys:
+            # Direct match, move on
+            continue
+
+        code_lower = code.lower().replace('-', '_')
+
+        for k in keys:
+            if k.lower() == code_lower:
+                # Make a copy of the code which matches
+                _translation_stats[code] = _translation_stats[k]
+                break
+
+
+def get_translation_percent(lang_code):
+    """Return the translation percentage for the given language code"""
+    if _translation_stats is None:
+        reload_translation_stats()
+
+    if _translation_stats is None:
+        return 0
+
+    return _translation_stats.get(lang_code, 0)

InvenTree/InvenTree/unit_test.py

@@ -1,12 +1,18 @@
-"""Helper functions for performing API unit tests."""
+"""Helper functions for unit testing / CI"""
 
 import csv
 import io
+import json
 import re
+from contextlib import contextmanager
+from pathlib import Path
 
 from django.contrib.auth import get_user_model
-from django.contrib.auth.models import Group
+from django.contrib.auth.models import Group, Permission
+from django.db import connections
 from django.http.response import StreamingHttpResponse
+from django.test import TestCase
+from django.test.utils import CaptureQueriesContext
 
 from djmoney.contrib.exchange.models import ExchangeBackend, Rate
 from rest_framework.test import APITestCase
@@ -15,6 +21,75 @@ from plugin import registry
 from plugin.models import PluginConfig
 
 
+def addUserPermission(user, permission):
+    """Shortcut function for adding a certain permission to a user."""
+    perm = Permission.objects.get(codename=permission)
+    user.user_permissions.add(perm)
+
+
+def addUserPermissions(user, permissions):
+    """Shortcut function for adding multiple permissions to a user."""
+    for permission in permissions:
+        addUserPermission(user, permission)
+
+
+def getMigrationFileNames(app):
+    """Return a list of all migration filenames for provided app."""
+    local_dir = Path(__file__).parent
+    files = local_dir.joinpath('..', app, 'migrations').iterdir()
+
+    # Regex pattern for migration files
+    regex = re.compile(r"^[\d]+_.*\.py$")
+
+    migration_files = []
+
+    for f in files:
+        if regex.match(f.name):
+            migration_files.append(f.name)
+
+    return migration_files
+
+
+def getOldestMigrationFile(app, exclude_extension=True, ignore_initial=True):
+    """Return the filename associated with the oldest migration."""
+    oldest_num = -1
+    oldest_file = None
+
+    for f in getMigrationFileNames(app):
+
+        if ignore_initial and f.startswith('0001_initial'):
+            continue
+
+        num = int(f.split('_')[0])
+
+        if oldest_file is None or num < oldest_num:
+            oldest_num = num
+            oldest_file = f
+
+    if exclude_extension:
+        oldest_file = oldest_file.replace('.py', '')
+
+    return oldest_file
+
+
+def getNewestMigrationFile(app, exclude_extension=True):
+    """Return the filename associated with the newest migration."""
+    newest_file = None
+    newest_num = -1
+
+    for f in getMigrationFileNames(app):
+        num = int(f.split('_')[0])
+
+        if newest_file is None or num > newest_num:
+            newest_num = num
+            newest_file = f
+
+    if exclude_extension:
+        newest_file = newest_file.replace('.py', '')
+
+    return newest_file
+
+
 class UserMixin:
     """Mixin to setup a user and login for tests.
 
@@ -68,7 +143,6 @@ class UserMixin:
 
     def setUp(self):
         """Run setup for individual test methods"""
-
         if self.auto_login:
             self.client.login(username=self.username, password=self.password)
 
@@ -81,7 +155,6 @@ class UserMixin:
             assign_all: Set to True to assign *all* roles
             group: The group to assign roles to (or leave None to use the group assigned to this class)
         """
-
         if group is None:
             group = cls.group
 
@@ -132,7 +205,6 @@ class ExchangeRateMixin:
 
     def generate_exchange_rates(self):
         """Helper function which generates some exchange rates to work with"""
-
         rates = {
             'AUD': 1.5,
             'CAD': 1.7,
@@ -162,12 +234,40 @@ class ExchangeRateMixin:
         Rate.objects.bulk_create(items)
 
 
+class InvenTreeTestCase(ExchangeRateMixin, UserMixin, TestCase):
+    """Testcase with user setup buildin."""
+    pass
+
+
 class InvenTreeAPITestCase(ExchangeRateMixin, UserMixin, APITestCase):
     """Base class for running InvenTree API tests."""
 
+    @contextmanager
+    def assertNumQueriesLessThan(self, value, using='default', verbose=False, debug=False):
+        """Context manager to check that the number of queries is less than a certain value.
+
+        Example:
+        with self.assertNumQueriesLessThan(10):
+            # Do some stuff
+        Ref: https://stackoverflow.com/questions/1254170/django-is-there-a-way-to-count-sql-queries-from-an-unit-test/59089020#59089020
+        """
+        with CaptureQueriesContext(connections[using]) as context:
+            yield   # your test will be run here
+
+        if verbose:
+            msg = "\r\n%s" % json.dumps(context.captured_queries, indent=4)
+        else:
+            msg = None
+
+        n = len(context.captured_queries)
+
+        if debug:
+            print(f"Expected less than {value} queries, got {n} queries")
+
+        self.assertLess(n, value, msg=msg)
+
     def checkResponse(self, url, method, expected_code, response):
         """Debug output for an unexpected response"""
-
         # No expected code, return
         if expected_code is None:
             return
@@ -214,7 +314,6 @@ class InvenTreeAPITestCase(ExchangeRateMixin, UserMixin, APITestCase):
 
     def post(self, url, data=None, expected_code=None, format='json'):
         """Issue a POST request."""
-
         # Set default value - see B006
         if data is None:
             data = {}
@@ -227,7 +326,6 @@ class InvenTreeAPITestCase(ExchangeRateMixin, UserMixin, APITestCase):
 
     def delete(self, url, data=None, expected_code=None, format='json'):
         """Issue a DELETE request."""
-
         if data is None:
             data = {}
 
@@ -265,8 +363,7 @@ class InvenTreeAPITestCase(ExchangeRateMixin, UserMixin, APITestCase):
         """Download a file from the server, and return an in-memory file."""
         response = self.client.get(url, data=data, format='json')
 
-        if expected_code is not None:
-            self.assertEqual(response.status_code, expected_code)
+        self.checkResponse(url, 'DOWNLOAD_FILE', expected_code, response)
 
         # Check that the response is of the correct type
         if not isinstance(response, StreamingHttpResponse):
@@ -284,27 +381,27 @@ class InvenTreeAPITestCase(ExchangeRateMixin, UserMixin, APITestCase):
 
         if decode:
             # Decode data and return as StringIO file object
-            fo = io.StringIO()
-            fo.name = fo
-            fo.write(response.getvalue().decode('UTF-8'))
+            file = io.StringIO()
+            file.name = file
+            file.write(response.getvalue().decode('UTF-8'))
         else:
             # Return a a BytesIO file object
-            fo = io.BytesIO()
-            fo.name = fn
-            fo.write(response.getvalue())
+            file = io.BytesIO()
+            file.name = fn
+            file.write(response.getvalue())
 
-        fo.seek(0)
+        file.seek(0)
 
-        return fo
+        return file
 
-    def process_csv(self, fo, delimiter=',', required_cols=None, excluded_cols=None, required_rows=None):
+    def process_csv(self, file_object, delimiter=',', required_cols=None, excluded_cols=None, required_rows=None):
         """Helper function to process and validate a downloaded csv file."""
         # Check that the correct object type has been passed
-        self.assertTrue(isinstance(fo, io.StringIO))
+        self.assertTrue(isinstance(file_object, io.StringIO))
 
-        fo.seek(0)
+        file_object.seek(0)
 
-        reader = csv.reader(fo, delimiter=delimiter)
+        reader = csv.reader(file_object, delimiter=delimiter)
 
         headers = []
         rows = []

InvenTree/InvenTree/urls.py

@@ -7,37 +7,48 @@ from django.conf import settings
 from django.conf.urls.static import static
 from django.contrib import admin
 from django.urls import include, path, re_path
+from django.views.decorators.csrf import csrf_exempt
 from django.views.generic.base import RedirectView
 
-from rest_framework.documentation import include_docs_urls
+from dj_rest_auth.registration.views import (ConfirmEmailView,
+                                             SocialAccountDisconnectView,
+                                             SocialAccountListView)
+from drf_spectacular.views import SpectacularAPIView, SpectacularRedocView
+from sesame.views import LoginView
 
-from build.api import build_api_urls
+import build.api
+import common.api
+import company.api
+import label.api
+import order.api
+import part.api
+import plugin.api
+import report.api
+import stock.api
+import users.api
 from build.urls import build_urls
-from common.api import admin_api_urls, common_api_urls, settings_api_urls
 from common.urls import common_urls
-from company.api import company_api_urls
 from company.urls import (company_urls, manufacturer_part_urls,
                           supplier_part_urls)
-from label.api import label_api_urls
-from order.api import order_api_urls
 from order.urls import order_urls
-from part.api import bom_api_urls, part_api_urls
 from part.urls import part_urls
-from plugin.api import plugin_api_urls
 from plugin.urls import get_plugin_urls
-from report.api import report_api_urls
-from stock.api import stock_api_urls
 from stock.urls import stock_urls
-from users.api import user_urls
+from web.urls import urlpatterns as platform_urls
 
-from .api import APISearchView, InfoView, NotFoundView
+from .api import (APISearchView, InfoView, NotFoundView, VersionTextView,
+                  VersionView)
+from .magic_login import GetSimpleLoginView
+from .social_auth_urls import (EmailListView, EmailPrimaryView,
+                               EmailRemoveView, EmailVerifyView,
+                               SocialProviderListView, social_auth_urlpatterns)
 from .views import (AboutView, AppearanceSelectView, CustomConnectionsView,
                     CustomEmailView, CustomLoginView,
                     CustomPasswordResetFromKeyView,
                     CustomSessionDeleteOtherView, CustomSessionDeleteView,
-                    CustomTwoFactorRemove, DatabaseStatsView, DynamicJsView,
-                    EditUserView, IndexView, NotificationsView, SearchView,
-                    SetPasswordView, SettingsView, auth_request)
+                    DatabaseStatsView, DynamicJsView, EditUserView, IndexView,
+                    NotificationsView, SearchView, SetPasswordView,
+                    SettingsView, auth_request)
 
 admin.site.site_header = "InvenTree Admin"
 
@@ -47,26 +58,52 @@ apipatterns = [
     # Global search
     path('search/', APISearchView.as_view(), name='api-search'),
 
-    re_path(r'^settings/', include(settings_api_urls)),
-    re_path(r'^part/', include(part_api_urls)),
-    re_path(r'^bom/', include(bom_api_urls)),
-    re_path(r'^company/', include(company_api_urls)),
-    re_path(r'^stock/', include(stock_api_urls)),
-    re_path(r'^build/', include(build_api_urls)),
-    re_path(r'^order/', include(order_api_urls)),
-    re_path(r'^label/', include(label_api_urls)),
-    re_path(r'^report/', include(report_api_urls)),
-    re_path(r'^user/', include(user_urls)),
-    re_path(r'^admin/', include(admin_api_urls)),
+    re_path(r'^settings/', include(common.api.settings_api_urls)),
+    re_path(r'^part/', include(part.api.part_api_urls)),
+    re_path(r'^bom/', include(part.api.bom_api_urls)),
+    re_path(r'^company/', include(company.api.company_api_urls)),
+    re_path(r'^stock/', include(stock.api.stock_api_urls)),
+    re_path(r'^build/', include(build.api.build_api_urls)),
+    re_path(r'^order/', include(order.api.order_api_urls)),
+    re_path(r'^label/', include(label.api.label_api_urls)),
+    re_path(r'^report/', include(report.api.report_api_urls)),
+    re_path(r'^user/', include(users.api.user_urls)),
+    re_path(r'^admin/', include(common.api.admin_api_urls)),
 
     # Plugin endpoints
-    path('', include(plugin_api_urls)),
+    path('', include(plugin.api.plugin_api_urls)),
 
-    # Webhook endpoints
-    path('', include(common_api_urls)),
+    # Common endpoints endpoint
+    path('', include(common.api.common_api_urls)),
 
-    # InvenTree information endpoint
-    path('', InfoView.as_view(), name='api-inventree-info'),
+    # OpenAPI Schema
+    re_path('schema/', SpectacularAPIView.as_view(custom_settings={'SCHEMA_PATH_PREFIX': '/api/'}), name='schema'),
+
+    # InvenTree information endpoints
+    path("version-text", VersionTextView.as_view(), name="api-version-text"),  # version text
+    path('version/', VersionView.as_view(), name='api-version'),  # version info
+    path('', InfoView.as_view(), name='api-inventree-info'),  # server info
+
+    # Auth API endpoints
+    path('auth/', include([
+        re_path(r'^registration/account-confirm-email/(?P<key>[-:\w]+)/$', ConfirmEmailView.as_view(), name='account_confirm_email'),
+        path('registration/', include('dj_rest_auth.registration.urls')),
+        path('providers/', SocialProviderListView.as_view(), name='social_providers'),
+        path('emails/', include([path('<int:pk>/', include([
+            path('primary/', EmailPrimaryView.as_view(), name='email-primary'),
+            path('verify/', EmailVerifyView.as_view(), name='email-verify'),
+            path('remove/', EmailRemoveView().as_view(), name='email-remove'),])),
+            path('', EmailListView.as_view(), name='email-list')
+        ])),
+        path('social/', include(social_auth_urlpatterns)),
+        path('social/', SocialAccountListView.as_view(), name='social_account_list'),
+        path('social/<int:pk>/disconnect/', SocialAccountDisconnectView.as_view(), name='social_account_disconnect'),
+        path('', include('dj_rest_auth.urls')),
+    ])),
+
+    # Magic login URLs
+    path("email/generate/", csrf_exempt(GetSimpleLoginView().as_view()), name="sesame-generate",),
+    path("email/login/", LoginView.as_view(), name="sesame-login"),
 
     # Unknown endpoint
     re_path(r'^.*$', NotFoundView.as_view(), name='api-404'),
@@ -92,10 +129,11 @@ notifications_urls = [
 dynamic_javascript_urls = [
     re_path(r'^calendar.js', DynamicJsView.as_view(template_name='js/dynamic/calendar.js'), name='calendar.js'),
     re_path(r'^nav.js', DynamicJsView.as_view(template_name='js/dynamic/nav.js'), name='nav.js'),
+    re_path(r'^permissions.js', DynamicJsView.as_view(template_name='js/dynamic/permissions.js'), name='permissions.js'),
     re_path(r'^settings.js', DynamicJsView.as_view(template_name='js/dynamic/settings.js'), name='settings.js'),
 ]
 
-# These javascript files are pased through the Django translation layer
+# These javascript files are passed through the Django translation layer
 translated_javascript_urls = [
     re_path(r'^api.js', DynamicJsView.as_view(template_name='js/translated/api.js'), name='api.js'),
     re_path(r'^attachment.js', DynamicJsView.as_view(template_name='js/translated/attachment.js'), name='attachment.js'),
@@ -107,6 +145,7 @@ translated_javascript_urls = [
     re_path(r'^filters.js', DynamicJsView.as_view(template_name='js/translated/filters.js'), name='filters.js'),
     re_path(r'^forms.js', DynamicJsView.as_view(template_name='js/translated/forms.js'), name='forms.js'),
     re_path(r'^helpers.js', DynamicJsView.as_view(template_name='js/translated/helpers.js'), name='helpers.js'),
+    re_path(r'^index.js', DynamicJsView.as_view(template_name='js/translated/index.js'), name='index.js'),
     re_path(r'^label.js', DynamicJsView.as_view(template_name='js/translated/label.js'), name='label.js'),
     re_path(r'^model_renderers.js', DynamicJsView.as_view(template_name='js/translated/model_renderers.js'), name='model_renderers.js'),
     re_path(r'^modals.js', DynamicJsView.as_view(template_name='js/translated/modals.js'), name='modals.js'),
@@ -136,10 +175,10 @@ backendpatterns = [
     re_path(r'^auth/?', auth_request),
 
     re_path(r'^api/', include(apipatterns)),
-    re_path(r'^api-doc/', include_docs_urls(title='InvenTree API')),
+    re_path(r'^api-doc/', SpectacularRedocView.as_view(url_name='schema'), name='api-doc'),
 ]
 
-frontendpatterns = [
+classic_frontendpatterns = [
 
     # Apps
     re_path(r'^build/', include(build_urls)),
@@ -161,10 +200,6 @@ frontendpatterns = [
     re_path(r'^about/', AboutView.as_view(), name='about'),
     re_path(r'^stats/', DatabaseStatsView.as_view(), name='stats'),
 
-    # admin sites
-    re_path(f'^{settings.INVENTREE_ADMIN_URL}/error_log/', include('error_report.urls')),
-    re_path(f'^{settings.INVENTREE_ADMIN_URL}/', admin.site.urls, name='inventree-admin'),
-
     # DB user sessions
     path('accounts/sessions/other/delete/', view=CustomSessionDeleteOtherView.as_view(), name='session_delete_other', ),
     re_path(r'^accounts/sessions/(?P<pk>\w+)/delete/$', view=CustomSessionDeleteView.as_view(), name='session_delete', ),
@@ -175,10 +210,6 @@ frontendpatterns = [
     re_path(r'^accounts/social/connections/', CustomConnectionsView.as_view(), name='socialaccount_connections'),
     re_path(r"^accounts/password/reset/key/(?P<uidb36>[0-9A-Za-z]+)-(?P<key>.+)/$", CustomPasswordResetFromKeyView.as_view(), name="account_reset_password_from_key"),
 
-    # Temporary fix for django-allauth-2fa # TODO remove
-    # See https://github.com/inventree/InvenTree/security/advisories/GHSA-8j76-mm54-52xq
-    re_path(r'^accounts/two_factor/remove/?$', CustomTwoFactorRemove.as_view(), name='two-factor-remove'),
-
     # Override login page
     re_path("accounts/login/", CustomLoginView.as_view(), name="account_login"),
 
@@ -186,14 +217,29 @@ frontendpatterns = [
     re_path(r'^accounts/', include('allauth.urls')),        # included urlpatterns
 ]
 
+urlpatterns = []
+
+if settings.INVENTREE_ADMIN_ENABLED:
+    admin_url = settings.INVENTREE_ADMIN_URL,
+    urlpatterns += [
+        path(f'{admin_url}/error_log/', include('error_report.urls')),
+        path(f'{admin_url}/', admin.site.urls, name='inventree-admin'),
+    ]
+
+urlpatterns += backendpatterns
+
+frontendpatterns = []
+
+if settings.ENABLE_CLASSIC_FRONTEND:
+    frontendpatterns += classic_frontendpatterns
+if settings.ENABLE_PLATFORM_FRONTEND:
+    frontendpatterns += platform_urls
+
+urlpatterns += frontendpatterns
+
 # Append custom plugin URLs (if plugin support is enabled)
 if settings.PLUGINS_ENABLED:
-    frontendpatterns.append(get_plugin_urls())
-
-urlpatterns = [
-    re_path('', include(frontendpatterns)),
-    re_path('', include(backendpatterns)),
-]
+    urlpatterns.append(get_plugin_urls())
 
 # Server running in "DEBUG" mode?
 if settings.DEBUG:
@@ -210,5 +256,10 @@ if settings.DEBUG:
             path('__debug__/', include(debug_toolbar.urls)),
         ] + urlpatterns
 
+# Redirect for favicon.ico
+urlpatterns.append(
+    path('favicon.ico', RedirectView.as_view(url=f'{settings.STATIC_URL}img/favicon/favicon.ico'))
+)
+
 # Send any unknown URLs to the parts page
 urlpatterns += [re_path(r'^.*$', RedirectView.as_view(url='/index/', permanent=False), name='index')]

InvenTree/InvenTree/validators.py

@@ -8,9 +8,30 @@ from django.core import validators
 from django.core.exceptions import FieldDoesNotExist, ValidationError
 from django.utils.translation import gettext_lazy as _
 
+import pint
 from jinja2 import Template
 from moneyed import CURRENCIES
 
+import InvenTree.conversion
+
+
+def validate_physical_units(unit):
+    """Ensure that a given unit is a valid physical unit."""
+    unit = unit.strip()
+
+    # Ignore blank units
+    if not unit:
+        return
+
+    ureg = InvenTree.conversion.get_unit_registry()
+
+    try:
+        ureg(unit)
+    except AttributeError:
+        raise ValidationError(_('Invalid physical unit'))
+    except pint.errors.UndefinedUnitError:
+        raise ValidationError(_('Invalid physical unit'))
+
 
 def validate_currency_code(code):
     """Check that a given code is a valid currency code."""
@@ -39,15 +60,28 @@ def allowable_url_schemes():
 
 class AllowedURLValidator(validators.URLValidator):
     """Custom URL validator to allow for custom schemes."""
+
     def __call__(self, value):
         """Validate the URL."""
+
+        import common.models
+
         self.schemes = allowable_url_schemes()
+
+        # Determine if 'strict' URL validation is required (i.e. if the URL must have a schema prefix)
+        strict_urls = common.models.InvenTreeSetting.get_setting('INVENTREE_STRICT_URLS', True, cache=False)
+
+        if not strict_urls:
+            # Allow URLs which do not have a provided schema
+            if '://' not in value:
+                # Validate as if it were http
+                value = 'http://' + value
+
         super().__call__(value)
 
 
 def validate_purchase_order_reference(value):
     """Validate the 'reference' field of a PurchaseOrder."""
-
     from order.models import PurchaseOrder
 
     # If we get to here, run the "default" validation routine
@@ -56,7 +90,6 @@ def validate_purchase_order_reference(value):
 
 def validate_sales_order_reference(value):
     """Validate the 'reference' field of a SalesOrder."""
-
     from order.models import SalesOrder
 
     # If we get to here, run the "default" validation routine
@@ -118,7 +151,6 @@ def validate_part_name_format(value):
 
     Make sure that each template container has a field of Part Model
     """
-
     # Make sure that the field_name exists in Part model
     from part.models import Part
 

InvenTree/InvenTree/version.py

@@ -4,29 +4,66 @@ Provides information on the current InvenTree version
 """
 
 import os
+import pathlib
+import platform
 import re
-import subprocess
+import sys
+from datetime import datetime as dt
+from datetime import timedelta as td
 
 import django
+from django.conf import settings
 
-import common.models
-from InvenTree.api_version import INVENTREE_API_VERSION
+from dulwich.repo import NotGitRepository, Repo
+
+from .api_version import INVENTREE_API_TEXT, INVENTREE_API_VERSION
 
 # InvenTree software version
-INVENTREE_SW_VERSION = "0.11.0"
+INVENTREE_SW_VERSION = "0.13.4"
+
+# Discover git
+try:
+    main_repo = Repo(pathlib.Path(__file__).parent.parent.parent)
+    main_commit = main_repo[main_repo.head()]
+except (NotGitRepository, FileNotFoundError):
+    main_commit = None
+
+
+def checkMinPythonVersion():
+    """Check that the Python version is at least 3.9"""
+
+    version = sys.version.split(" ")[0]
+    docs = "https://docs.inventree.org/en/stable/start/intro/#python-requirements"
+
+    msg = f"""
+    InvenTree requires Python 3.9 or above - you are running version {version}.
+    - Refer to the InvenTree documentation for more information:
+    - {docs}
+    """
+
+    if sys.version_info.major < 3:
+        raise RuntimeError(msg)
+
+    if sys.version_info.major == 3 and sys.version_info.minor < 9:
+        raise RuntimeError(msg)
+
+    print(f"Python version {version} - {sys.executable}")
 
 
 def inventreeInstanceName():
     """Returns the InstanceName settings for the current database."""
+    import common.models
+
     return common.models.InvenTreeSetting.get_setting("INVENTREE_INSTANCE", "")
 
 
 def inventreeInstanceTitle():
     """Returns the InstanceTitle for the current database."""
+    import common.models
+
     if common.models.InvenTreeSetting.get_setting("INVENTREE_INSTANCE_TITLE", False):
         return common.models.InvenTreeSetting.get_setting("INVENTREE_INSTANCE", "")
-    else:
-        return 'InvenTree'
+    return 'InvenTree'
 
 
 def inventreeVersion():
@@ -57,8 +94,28 @@ def inventreeDocsVersion():
     """
     if isInvenTreeDevelopmentVersion():
         return "latest"
-    else:
-        return INVENTREE_SW_VERSION  # pragma: no cover
+    return INVENTREE_SW_VERSION  # pragma: no cover
+
+
+def inventreeDocUrl():
+    """Return URL for InvenTree documentation site."""
+    tag = inventreeDocsVersion()
+    return f"https://docs.inventree.org/en/{tag}"
+
+
+def inventreeAppUrl():
+    """Return URL for InvenTree app site."""
+    return f'{inventreeDocUrl()}/app/app/'
+
+
+def inventreeCreditsUrl():
+    """Return URL for InvenTree credits site."""
+    return "https://docs.inventree.org/en/latest/credits/"
+
+
+def inventreeGithubUrl():
+    """Return URL for InvenTree github site."""
+    return "https://github.com/InvenTree/InvenTree/"
 
 
 def isInvenTreeUpToDate():
@@ -66,6 +123,7 @@ def isInvenTreeUpToDate():
 
     A background task periodically queries GitHub for latest version, and stores it to the database as "_INVENTREE_LATEST_VERSION"
     """
+    import common.models
     latest = common.models.InvenTreeSetting.get_setting('_INVENTREE_LATEST_VERSION', backup_value=None, create=False)
 
     # No record for "latest" version - we must assume we are up to date!
@@ -84,11 +142,62 @@ def inventreeApiVersion():
     return INVENTREE_API_VERSION
 
 
+def parse_version_text():
+    """Parse the version text to structured data."""
+    patched_data = INVENTREE_API_TEXT.split("\n\n")
+    # Remove first newline on latest version
+    patched_data[0] = patched_data[0].replace("\n", "", 1)
+
+    version_data = {}
+    for version in patched_data:
+        data = version.split("\n")
+
+        version_split = data[0].split(' -> ')
+        version_detail = version_split[1].split(':', 1) if len(version_split) > 1 else ['', ]
+        new_data = {
+            "version": version_split[0].strip(),
+            "date": version_detail[0].strip(),
+            "gh": version_detail[1].strip() if len(version_detail) > 1 else None,
+            "text": data[1:],
+            "latest": False,
+        }
+        version_data[new_data["version"]] = new_data
+    return version_data
+
+
+INVENTREE_API_TEXT_DATA = parse_version_text()
+"""Pre-processed API version text."""
+
+
+def inventreeApiText(versions: int = 10, start_version: int = 0):
+    """Returns API version descriptors.
+
+    Args:
+        versions: Number of versions to return. Default: 10
+        start_version: first version to report. Defaults to return the latest {versions} versions.
+    """
+    version_data = INVENTREE_API_TEXT_DATA
+
+    # Define the range of versions to return
+    if start_version == 0:
+        start_version = INVENTREE_API_VERSION - versions
+
+    return {
+        f"v{a}": version_data.get(f"v{a}", None)
+        for a in range(start_version, start_version + versions)
+    }
+
+
 def inventreeDjangoVersion():
     """Returns the version of Django library."""
     return django.get_version()
 
 
+def inventreePythonVersion():
+    """Returns the version of python"""
+    return sys.version.split(' ')[0]
+
+
 def inventreeCommitHash():
     """Returns the git commit hash for the running codebase."""
     # First look in the environment variables, i.e. if running in docker
@@ -97,10 +206,9 @@ def inventreeCommitHash():
     if commit_hash:
         return commit_hash
 
-    try:
-        return str(subprocess.check_output('git rev-parse --short HEAD'.split()), 'utf-8').strip()
-    except Exception:  # pragma: no cover
+    if main_commit is None:
         return None
+    return main_commit.sha().hexdigest()[0:7]
 
 
 def inventreeCommitDate():
@@ -111,8 +219,61 @@ def inventreeCommitDate():
     if commit_date:
         return commit_date.split(' ')[0]
 
-    try:
-        d = str(subprocess.check_output('git show -s --format=%ci'.split()), 'utf-8').strip()
-        return d.split(' ')[0]
-    except Exception:  # pragma: no cover
+    if main_commit is None:
         return None
+
+    commit_dt = dt.fromtimestamp(main_commit.commit_time) + td(seconds=main_commit.commit_timezone)
+    return str(commit_dt.date())
+
+
+def inventreeInstaller():
+    """Returns the installer for the running codebase - if set."""
+    # First look in the environment variables, e.g. if running in docker
+
+    installer = os.environ.get('INVENTREE_PKG_INSTALLER', '')
+
+    if installer:
+        return installer
+    elif settings.DOCKER:
+        return 'DOC'
+    elif main_commit is not None:
+        return 'GIT'
+
+    return None
+
+
+def inventreeBranch():
+    """Returns the branch for the running codebase - if set."""
+    # First look in the environment variables, e.g. if running in docker
+
+    branch = os.environ.get('INVENTREE_PKG_BRANCH', '')
+
+    if branch:
+        return branch
+
+    if main_commit is None:
+        return None
+
+    try:
+        branch = main_repo.refs.follow(b'HEAD')[0][1].decode()
+        return branch.removeprefix('refs/heads/')
+    except IndexError:
+        return None  # pragma: no cover
+
+
+def inventreeTarget():
+    """Returns the target platform for the running codebase - if set."""
+    # First look in the environment variables, e.g. if running in docker
+
+    return os.environ.get('INVENTREE_PKG_TARGET', None)
+
+
+def inventreePlatform():
+    """Returns the platform for the instance."""
+    return platform.platform(aliased=True)
+
+
+def inventreeDatabase():
+    """Return the InvenTree database backend e.g. 'postgresql'."""
+    db = settings.DATABASES['default']
+    return db.get('ENGINE', None).replace('django.db.backends.', '')

InvenTree/InvenTree/views.py

@@ -4,9 +4,6 @@ In particular these views provide base functionality for rendering Django forms
 as JSON objects and passing them to modal forms (using jQuery / bootstrap).
 """
 
-import json
-
-from django.conf import settings
 from django.contrib.auth import password_validation
 from django.contrib.auth.mixins import (LoginRequiredMixin,
                                         PermissionRequiredMixin)
@@ -27,17 +24,16 @@ from allauth.account.views import (EmailView, LoginView,
                                    PasswordResetFromKeyView)
 from allauth.socialaccount.forms import DisconnectForm
 from allauth.socialaccount.views import ConnectionsView
-from allauth_2fa.views import TwoFactorRemove
 from djmoney.contrib.exchange.models import ExchangeBackend, Rate
 from user_sessions.views import SessionDeleteOtherView, SessionDeleteView
 
-from common.models import ColorTheme, InvenTreeSetting
-from common.settings import currency_code_default, currency_codes
+import common.models as common_models
+import common.settings as common_settings
 from part.models import PartCategory
 from users.models import RuleSet, check_user_role
 
 from .forms import EditUserForm, SetPasswordForm
-from .helpers import remove_non_printable_characters, strip_html_tags
+from .helpers import is_ajax, remove_non_printable_characters, strip_html_tags
 
 
 def auth_request(request):
@@ -47,8 +43,7 @@ def auth_request(request):
     """
     if request.user.is_authenticated:
         return HttpResponse(status=200)
-    else:
-        return HttpResponse(status=403)
+    return HttpResponse(status=403)
 
 
 class InvenTreeRoleMixin(PermissionRequiredMixin):
@@ -226,8 +221,7 @@ class AjaxMixin(InvenTreeRoleMixin):
         """
         if method == 'POST':
             return self.request.POST.get(name, None)
-        else:
-            return self.request.GET.get(name, None)
+        return self.request.GET.get(name, None)
 
     def get_data(self):
         """Get extra context data (default implementation is empty dict).
@@ -264,7 +258,7 @@ class AjaxMixin(InvenTreeRoleMixin):
         if not data:
             data = {}
 
-        if not request.is_ajax():
+        if not is_ajax(request):
             return HttpResponseRedirect('/')
 
         if context is None:
@@ -357,7 +351,7 @@ class AjaxUpdateView(AjaxMixin, UpdateView):
         - Updates model with POST field data
         - Performs form and object validation
         - If errors exist, re-render the form
-        - Otherwise, return sucess status
+        - Otherwise, return success status
         """
         self.request = request
 
@@ -386,7 +380,7 @@ class AjaxUpdateView(AjaxMixin, UpdateView):
 
         if valid:
 
-            # Save the updated objec to the database
+            # Save the updated object to the database
             self.save(self.object, form)
 
             self.object = self.get_object()
@@ -447,8 +441,7 @@ class SetPasswordView(AjaxUpdateView):
 
         if valid:
             # Old password must be correct
-
-            if not user.check_password(old_password):
+            if user.has_usable_password() and not user.check_password(old_password):
                 form.add_error('old_password', _('Wrong password provided'))
                 valid = False
 
@@ -514,10 +507,10 @@ class SettingsView(TemplateView):
         """Add data for template."""
         ctx = super().get_context_data(**kwargs).copy()
 
-        ctx['settings'] = InvenTreeSetting.objects.all().order_by('key')
+        ctx['settings'] = common_models.InvenTreeSetting.objects.all().order_by('key')
 
-        ctx["base_currency"] = currency_code_default()
-        ctx["currencies"] = currency_codes
+        ctx["base_currency"] = common_settings.currency_code_default()
+        ctx["currencies"] = common_settings.currency_codes
 
         ctx["rates"] = Rate.objects.filter(backend="InvenTreeExchange")
 
@@ -525,19 +518,13 @@ class SettingsView(TemplateView):
 
         # When were the rates last updated?
         try:
-            backend = ExchangeBackend.objects.get(name='InvenTreeExchange')
-            ctx["rates_updated"] = backend.last_update
+            backend = ExchangeBackend.objects.filter(name='InvenTreeExchange')
+            if backend.exists():
+                backend = backend.first()
+                ctx["rates_updated"] = backend.last_update
         except Exception:
             ctx["rates_updated"] = None
 
-        # load locale stats
-        STAT_FILE = settings.BASE_DIR.joinpath('InvenTree/locale_stats.json').absolute()
-
-        try:
-            ctx["locale_stats"] = json.load(open(STAT_FILE, 'r'))
-        except Exception:
-            ctx["locale_stats"] = {}
-
         # Forms and context for allauth
         ctx['add_email_form'] = AddEmailForm
         ctx["can_add_email"] = EmailAddress.objects.can_add_email(self.request.user)
@@ -620,8 +607,8 @@ class AppearanceSelectView(RedirectView):
     def get_user_theme(self):
         """Get current user color theme."""
         try:
-            user_theme = ColorTheme.objects.filter(user=self.request.user).get()
-        except ColorTheme.DoesNotExist:
+            user_theme = common_models.ColorTheme.objects.filter(user=self.request.user).get()
+        except common_models.ColorTheme.DoesNotExist:
             user_theme = None
 
         return user_theme
@@ -635,11 +622,15 @@ class AppearanceSelectView(RedirectView):
 
         # Create theme entry if user did not select one yet
         if not user_theme:
-            user_theme = ColorTheme()
+            user_theme = common_models.ColorTheme()
             user_theme.user = request.user
 
-        user_theme.name = theme
-        user_theme.save()
+        if theme:
+            try:
+                user_theme.name = theme
+                user_theme.save()
+            except Exception:
+                pass
 
         return redirect(reverse_lazy('settings'))
 
@@ -662,9 +653,3 @@ class NotificationsView(TemplateView):
     """View for showing notifications."""
 
     template_name = "InvenTree/notifications/notifications.html"
-
-
-# Custom 2FA removal form to allow custom redirect URL
-class CustomTwoFactorRemove(TwoFactorRemove):
-    """Specify custom URL redirect."""
-    success_url = reverse_lazy("settings")

InvenTree/build/admin.py

@@ -4,9 +4,9 @@ from django.contrib import admin
 
 from import_export.admin import ImportExportModelAdmin
 from import_export.fields import Field
-import import_export.widgets as widgets
+from import_export import widgets
 
-from build.models import Build, BuildItem
+from build.models import Build, BuildLine, BuildItem
 from InvenTree.admin import InvenTreeResource
 import part.models
 
@@ -87,18 +87,33 @@ class BuildItemAdmin(admin.ModelAdmin):
     """Class for managing the BuildItem model via the admin interface"""
 
     list_display = (
-        'build',
         'stock_item',
         'quantity'
     )
 
     autocomplete_fields = [
-        'build',
-        'bom_item',
+        'build_line',
         'stock_item',
         'install_into',
     ]
 
 
+class BuildLineAdmin(admin.ModelAdmin):
+    """Class for managing the BuildLine model via the admin interface"""
+
+    list_display = (
+        'build',
+        'bom_item',
+        'quantity',
+    )
+
+    search_fields = [
+        'build__title',
+        'build__reference',
+        'bom_item__sub_part__name',
+    ]
+
+
 admin.site.register(Build, BuildAdmin)
 admin.site.register(BuildItem, BuildItemAdmin)
+admin.site.register(BuildLine, BuildLineAdmin)

InvenTree/build/api.py

@@ -1,5 +1,6 @@
 """JSON API for the Build app."""
 
+from django.db.models import F, Q
 from django.urls import include, path, re_path
 from django.utils.translation import gettext_lazy as _
 from django.contrib.auth.models import User
@@ -9,14 +10,16 @@ from rest_framework.exceptions import ValidationError
 from django_filters.rest_framework import DjangoFilterBackend
 from django_filters import rest_framework as rest_filters
 
-from InvenTree.api import AttachmentMixin, APIDownloadMixin, ListCreateDestroyAPIView, MetadataView, StatusView
+from InvenTree.api import AttachmentMixin, APIDownloadMixin, ListCreateDestroyAPIView, MetadataView
+from generic.states.api import StatusView
 from InvenTree.helpers import str2bool, isNull, DownloadFile
-from InvenTree.status_codes import BuildStatus
+from InvenTree.status_codes import BuildStatus, BuildStatusGroups
 from InvenTree.mixins import CreateAPI, RetrieveUpdateDestroyAPI, ListCreateAPI
 
+import common.models
 import build.admin
 import build.serializers
-from build.models import Build, BuildItem, BuildOrderAttachment
+from build.models import Build, BuildLine, BuildItem, BuildOrderAttachment
 import part.models
 from users.models import Owner
 from InvenTree.filters import SEARCH_ORDER_FILTER_ALIAS
@@ -32,6 +35,7 @@ class BuildFilter(rest_filters.FilterSet):
             'parent',
             'sales_order',
             'part',
+            'issued_by',
         ]
 
     status = rest_filters.NumberFilter(label='Status')
@@ -41,9 +45,8 @@ class BuildFilter(rest_filters.FilterSet):
     def filter_active(self, queryset, name, value):
         """Filter the queryset to either include or exclude orders which are active."""
         if str2bool(value):
-            return queryset.filter(status__in=BuildStatus.ACTIVE_CODES)
-        else:
-            return queryset.exclude(status__in=BuildStatus.ACTIVE_CODES)
+            return queryset.filter(status__in=BuildStatusGroups.ACTIVE_CODES)
+        return queryset.exclude(status__in=BuildStatusGroups.ACTIVE_CODES)
 
     overdue = rest_filters.BooleanFilter(label='Build is overdue', method='filter_overdue')
 
@@ -51,8 +54,7 @@ class BuildFilter(rest_filters.FilterSet):
         """Filter the queryset to either include or exclude orders which are overdue."""
         if str2bool(value):
             return queryset.filter(Build.OVERDUE_FILTER)
-        else:
-            return queryset.exclude(Build.OVERDUE_FILTER)
+        return queryset.exclude(Build.OVERDUE_FILTER)
 
     assigned_to_me = rest_filters.BooleanFilter(label='assigned_to_me', method='filter_assigned_to_me')
 
@@ -65,8 +67,7 @@ class BuildFilter(rest_filters.FilterSet):
 
         if value:
             return queryset.filter(responsible__in=owners)
-        else:
-            return queryset.exclude(responsible__in=owners)
+        return queryset.exclude(responsible__in=owners)
 
     assigned_to = rest_filters.NumberFilter(label='responsible', method='filter_responsible')
 
@@ -87,6 +88,19 @@ class BuildFilter(rest_filters.FilterSet):
         lookup_expr="iexact"
     )
 
+    project_code = rest_filters.ModelChoiceFilter(
+        queryset=common.models.ProjectCode.objects.all(),
+        field_name='project_code'
+    )
+
+    has_project_code = rest_filters.BooleanFilter(label='has_project_code', method='filter_has_project_code')
+
+    def filter_has_project_code(self, queryset, name, value):
+        """Filter by whether or not the order has a project code"""
+        if str2bool(value):
+            return queryset.exclude(project_code=None)
+        return queryset.filter(project_code=None)
+
 
 class BuildList(APIDownloadMixin, ListCreateAPI):
     """API endpoint for accessing a list of Build objects.
@@ -112,11 +126,13 @@ class BuildList(APIDownloadMixin, ListCreateAPI):
         'completed',
         'issued_by',
         'responsible',
+        'project_code',
         'priority',
     ]
 
     ordering_field_aliases = {
         'reference': ['reference_int', 'reference'],
+        'project_code': ['project_code__code'],
     }
 
     ordering = '-reference'
@@ -127,6 +143,7 @@ class BuildList(APIDownloadMixin, ListCreateAPI):
         'part__name',
         'part__IPN',
         'part__description',
+        'project_code__code',
         'priority',
     ]
 
@@ -213,7 +230,6 @@ class BuildDetail(RetrieveUpdateDestroyAPI):
 
     def destroy(self, request, *args, **kwargs):
         """Only allow deletion of a BuildOrder if the build status is CANCELLED"""
-
         build = self.get_object()
 
         if build.status != BuildStatus.CANCELLED:
@@ -250,6 +266,99 @@ class BuildUnallocate(CreateAPI):
         return ctx
 
 
+class BuildLineFilter(rest_filters.FilterSet):
+    """Custom filterset for the BuildLine API endpoint."""
+
+    class Meta:
+        """Meta information for the BuildLineFilter class."""
+        model = BuildLine
+        fields = [
+            'build',
+            'bom_item',
+        ]
+
+    # Fields on related models
+    consumable = rest_filters.BooleanFilter(label=_('Consumable'), field_name='bom_item__consumable')
+    optional = rest_filters.BooleanFilter(label=_('Optional'), field_name='bom_item__optional')
+    tracked = rest_filters.BooleanFilter(label=_('Tracked'), field_name='bom_item__sub_part__trackable')
+
+    allocated = rest_filters.BooleanFilter(label=_('Allocated'), method='filter_allocated')
+
+    def filter_allocated(self, queryset, name, value):
+        """Filter by whether each BuildLine is fully allocated"""
+        if str2bool(value):
+            return queryset.filter(allocated__gte=F('quantity'))
+        return queryset.filter(allocated__lt=F('quantity'))
+
+    available = rest_filters.BooleanFilter(label=_('Available'), method='filter_available')
+
+    def filter_available(self, queryset, name, value):
+        """Filter by whether there is sufficient stock available for each BuildLine:
+
+        To determine this, we need to know:
+
+        - The quantity required for each BuildLine
+        - The quantity available for each BuildLine
+        - The quantity allocated for each BuildLine
+        """
+        flt = Q(quantity__lte=F('total_available_stock') + F('allocated'))
+
+        if str2bool(value):
+            return queryset.filter(flt)
+        return queryset.exclude(flt)
+
+
+class BuildLineEndpoint:
+    """Mixin class for BuildLine API endpoints."""
+
+    queryset = BuildLine.objects.all()
+    serializer_class = build.serializers.BuildLineSerializer
+
+    def get_queryset(self):
+        """Override queryset to select-related and annotate"""
+        queryset = super().get_queryset()
+
+        queryset = build.serializers.BuildLineSerializer.annotate_queryset(queryset)
+
+        return queryset
+
+
+class BuildLineList(BuildLineEndpoint, ListCreateAPI):
+    """API endpoint for accessing a list of BuildLine objects"""
+
+    filterset_class = BuildLineFilter
+    filter_backends = SEARCH_ORDER_FILTER_ALIAS
+
+    ordering_fields = [
+        'part',
+        'allocated',
+        'reference',
+        'quantity',
+        'consumable',
+        'optional',
+        'unit_quantity',
+        'available_stock',
+    ]
+
+    ordering_field_aliases = {
+        'part': 'bom_item__sub_part__name',
+        'reference': 'bom_item__reference',
+        'unit_quantity': 'bom_item__quantity',
+        'consumable': 'bom_item__consumable',
+        'optional': 'bom_item__optional',
+    }
+
+    search_fields = [
+        'bom_item__sub_part__name',
+        'bom_item__reference',
+    ]
+
+
+class BuildLineDetail(BuildLineEndpoint, RetrieveUpdateDestroyAPI):
+    """API endpoint for detail view of a BuildLine object."""
+    pass
+
+
 class BuildOrderContextMixin:
     """Mixin class which adds build order as serializer context variable."""
 
@@ -276,6 +385,19 @@ class BuildOutputCreate(BuildOrderContextMixin, CreateAPI):
     serializer_class = build.serializers.BuildOutputCreateSerializer
 
 
+class BuildOutputScrap(BuildOrderContextMixin, CreateAPI):
+    """API endpoint for scrapping build output(s)."""
+
+    queryset = Build.objects.none()
+    serializer_class = build.serializers.BuildOutputScrapSerializer
+
+    def get_serializer_context(self):
+        """Add extra context information to the endpoint serializer."""
+        ctx = super().get_serializer_context()
+        ctx['to_complete'] = False
+        return ctx
+
+
 class BuildOutputComplete(BuildOrderContextMixin, CreateAPI):
     """API endpoint for completing build outputs."""
 
@@ -359,9 +481,8 @@ class BuildItemFilter(rest_filters.FilterSet):
         """Metaclass option"""
         model = BuildItem
         fields = [
-            'build',
+            'build_line',
             'stock_item',
-            'bom_item',
             'install_into',
         ]
 
@@ -370,14 +491,18 @@ class BuildItemFilter(rest_filters.FilterSet):
         field_name='stock_item__part',
     )
 
+    build = rest_filters.ModelChoiceFilter(
+        queryset=build.models.Build.objects.all(),
+        field_name='build_line__build',
+    )
+
     tracked = rest_filters.BooleanFilter(label='Tracked', method='filter_tracked')
 
     def filter_tracked(self, queryset, name, value):
         """Filter the queryset based on whether build items are tracked"""
         if str2bool(value):
             return queryset.exclude(install_into=None)
-        else:
-            return queryset.filter(install_into=None)
+        return queryset.filter(install_into=None)
 
 
 class BuildItemList(ListCreateAPI):
@@ -395,10 +520,9 @@ class BuildItemList(ListCreateAPI):
         try:
             params = self.request.query_params
 
-            kwargs['part_detail'] = str2bool(params.get('part_detail', False))
-            kwargs['build_detail'] = str2bool(params.get('build_detail', False))
-            kwargs['location_detail'] = str2bool(params.get('location_detail', False))
-            kwargs['stock_detail'] = str2bool(params.get('stock_detail', True))
+            for key in ['part_detail', 'location_detail', 'stock_detail', 'build_detail']:
+                if key in params:
+                    kwargs[key] = str2bool(params.get(key, False))
         except AttributeError:
             pass
 
@@ -409,9 +533,8 @@ class BuildItemList(ListCreateAPI):
         queryset = BuildItem.objects.all()
 
         queryset = queryset.select_related(
-            'bom_item',
-            'bom_item__sub_part',
-            'build',
+            'build_line',
+            'build_line__build',
             'install_into',
             'stock_item',
             'stock_item__location',
@@ -421,7 +544,7 @@ class BuildItemList(ListCreateAPI):
         return queryset
 
     def filter_queryset(self, queryset):
-        """Customm query filtering for the BuildItem list."""
+        """Custom query filtering for the BuildItem list."""
         queryset = super().filter_queryset(queryset)
 
         params = self.request.query_params
@@ -449,10 +572,6 @@ class BuildAttachmentList(AttachmentMixin, ListCreateDestroyAPIView):
     queryset = BuildOrderAttachment.objects.all()
     serializer_class = build.serializers.BuildAttachmentSerializer
 
-    filter_backends = [
-        DjangoFilterBackend,
-    ]
-
     filterset_fields = [
         'build',
     ]
@@ -473,6 +592,12 @@ build_api_urls = [
         re_path(r'^.*$', BuildAttachmentList.as_view(), name='api-build-attachment-list'),
     ])),
 
+    # Build lines
+    re_path(r'^line/', include([
+        path(r'<int:pk>/', BuildLineDetail.as_view(), name='api-build-line-detail'),
+        re_path(r'^.*$', BuildLineList.as_view(), name='api-build-line-list'),
+    ])),
+
     # Build Items
     re_path(r'^item/', include([
         path(r'<int:pk>/', include([
@@ -489,6 +614,7 @@ build_api_urls = [
         re_path(r'^complete/', BuildOutputComplete.as_view(), name='api-build-output-complete'),
         re_path(r'^create-output/', BuildOutputCreate.as_view(), name='api-build-output-create'),
         re_path(r'^delete-outputs/', BuildOutputDelete.as_view(), name='api-build-output-delete'),
+        re_path(r'^scrap-outputs/', BuildOutputScrap.as_view(), name='api-build-output-scrap'),
         re_path(r'^finish/', BuildFinish.as_view(), name='api-build-finish'),
         re_path(r'^cancel/', BuildCancel.as_view(), name='api-build-cancel'),
         re_path(r'^unallocate/', BuildUnallocate.as_view(), name='api-build-unallocate'),

InvenTree/build/migrations/0013_auto_20200425_0507.py

@@ -11,10 +11,6 @@ def update_tree(apps, schema_editor):
     Build.objects.rebuild()
 
 
-def nupdate_tree(apps, schema_editor):  # pragma: no cover
-    pass
-
-
 class Migration(migrations.Migration):
 
     atomic = False
@@ -53,5 +49,5 @@ class Migration(migrations.Migration):
             field=models.PositiveIntegerField(db_index=True, default=0, editable=False),
             preserve_default=False,
         ),
-        migrations.RunPython(update_tree, reverse_code=nupdate_tree),
+        migrations.RunPython(update_tree, reverse_code=migrations.RunPython.noop),
     ]

InvenTree/build/migrations/0018_build_reference.py

@@ -23,13 +23,6 @@ def add_default_reference(apps, schema_editor):
         print(f"\nUpdated build reference for {count} existing BuildOrder objects")
 
 
-def reverse_default_reference(apps, schema_editor):  # pragma: no cover
-    """
-    Do nothing! But we need to have a function here so the whole process is reversible.
-    """
-    pass
-
-
 class Migration(migrations.Migration):
 
     atomic = False
@@ -49,7 +42,7 @@ class Migration(migrations.Migration):
         # Auto-populate the new reference field for any existing build order objects
         migrations.RunPython(
             add_default_reference,
-            reverse_code=reverse_default_reference
+            reverse_code=migrations.RunPython.noop
         ),
 
         # Now that each build has a non-empty, unique reference, update the field requirements!

InvenTree/build/migrations/0029_auto_20210601_1525.py

@@ -51,14 +51,6 @@ def assign_bom_items(apps, schema_editor):
         logger.info(f"Assigned BomItem for {count_valid}/{count_total} entries")
 
 
-def unassign_bom_items(apps, schema_editor):  # pragma: no cover
-    """
-    Reverse migration does not do anything.
-    Function here to preserve ability to reverse migration
-    """
-    pass
-
-
 class Migration(migrations.Migration):
 
     dependencies = [
@@ -66,5 +58,5 @@ class Migration(migrations.Migration):
     ]
 
     operations = [
-        migrations.RunPython(assign_bom_items, reverse_code=unassign_bom_items),
+        migrations.RunPython(assign_bom_items, reverse_code=migrations.RunPython.noop),
     ]

InvenTree/build/migrations/0032_auto_20211014_0632.py

@@ -31,12 +31,6 @@ def build_refs(apps, schema_editor):
         build.reference_int = ref
         build.save()
 
-def unbuild_refs(apps, schema_editor):  # pragma: no cover
-    """
-    Provided only for reverse migration compatibility
-    """
-    pass
-
 
 class Migration(migrations.Migration):
 
@@ -49,6 +43,6 @@ class Migration(migrations.Migration):
     operations = [
         migrations.RunPython(
             build_refs,
-            reverse_code=unbuild_refs
+            reverse_code=migrations.RunPython.noop
         )
     ]

InvenTree/build/migrations/0036_auto_20220707_1101.py

@@ -50,11 +50,6 @@ def update_build_reference(apps, schema_editor):
         print(f"Updated reference field for {n} BuildOrder objects")
 
 
-def nupdate_build_reference(apps, schema_editor):
-    """Reverse migration code. Does nothing."""
-    pass
-
-
 class Migration(migrations.Migration):
 
     dependencies = [
@@ -64,6 +59,6 @@ class Migration(migrations.Migration):
     operations = [
         migrations.RunPython(
             update_build_reference,
-            reverse_code=nupdate_build_reference,
+            reverse_code=migrations.RunPython.noop,
         )
     ]

InvenTree/build/migrations/0042_alter_build_notes.py

@@ -0,0 +1,19 @@
+# Generated by Django 3.2.18 on 2023-04-19 00:37
+
+import InvenTree.fields
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('build', '0041_alter_build_title'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='build',
+            name='notes',
+            field=InvenTree.fields.InvenTreeNotesField(blank=True, help_text='Markdown notes (optional)', max_length=50000, null=True, verbose_name='Notes'),
+        ),
+    ]

InvenTree/build/migrations/0043_buildline.py

@@ -0,0 +1,28 @@
+# Generated by Django 3.2.19 on 2023-05-19 06:04
+
+import django.core.validators
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('part', '0109_auto_20230517_1048'),
+        ('build', '0042_alter_build_notes'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='BuildLine',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('quantity', models.DecimalField(decimal_places=5, default=1, help_text='Required quantity for build order', max_digits=15, validators=[django.core.validators.MinValueValidator(0)], verbose_name='Quantity')),
+                ('bom_item', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='build_lines', to='part.bomitem')),
+                ('build', models.ForeignKey(help_text='Build object', on_delete=django.db.models.deletion.CASCADE, related_name='build_lines', to='build.build')),
+            ],
+            options={
+                'unique_together': {('build', 'bom_item')},
+            },
+        ),
+    ]

InvenTree/build/migrations/0044_auto_20230528_1410.py

@@ -0,0 +1,97 @@
+# Generated by Django 3.2.19 on 2023-05-28 14:10
+
+from django.db import migrations
+
+
+def get_bom_items_for_part(part, Part, BomItem):
+    """ Return a list of all BOM items for a given part.
+
+    Note that we cannot use the ORM here (as we are inside a data migration),
+    so we *copy* the logic from the Part class.
+
+    This is a snapshot of the Part.get_bom_items() method as of 2023-05-29
+    """
+
+    bom_items = set()
+
+    # Get all BOM items which directly reference the part
+    for bom_item in BomItem.objects.filter(part=part):
+        bom_items.add(bom_item)
+
+    # Get all BOM items which are inherited by the part
+    parents = Part.objects.filter(
+        tree_id=part.tree_id,
+        level__lt=part.level,
+        lft__lt=part.lft,
+        rght__gt=part.rght
+    )
+
+    for bom_item in BomItem.objects.filter(part__in=parents, inherited=True):
+        bom_items.add(bom_item)
+
+    return list(bom_items)
+
+
+def add_lines_to_builds(apps, schema_editor):
+    """Create BuildOrderLine objects for existing build orders"""
+
+    # Get database models
+    Build = apps.get_model("build", "Build")
+    BuildLine = apps.get_model("build", "BuildLine")
+
+    Part = apps.get_model("part", "Part")
+    BomItem = apps.get_model("part", "BomItem")
+
+    build_lines = []
+
+    builds = Build.objects.all()
+
+    if builds.count() > 0:
+        print(f"Creating BuildOrderLine objects for {builds.count()} existing builds")
+
+    for build in builds:
+        # Create a BuildOrderLine for each BuildItem
+
+        bom_items = get_bom_items_for_part(build.part, Part, BomItem)
+
+        for item in bom_items:
+            build_lines.append(
+                BuildLine(
+                    build=build,
+                    bom_item=item,
+                    quantity=item.quantity * build.quantity,
+                )
+            )
+
+    if len(build_lines) > 0:
+        # Construct the new BuildLine objects
+        BuildLine.objects.bulk_create(build_lines)
+        print(f"Created {len(build_lines)} BuildOrderLine objects for existing builds")
+
+
+def remove_build_lines(apps, schema_editor):
+    """Remove BuildOrderLine objects from the database"""
+
+    # Get database models
+    BuildLine = apps.get_model("build", "BuildLine")
+
+    n = BuildLine.objects.all().count()
+
+    BuildLine.objects.all().delete()
+
+    if n > 0:
+        print(f"Removed {n} BuildOrderLine objects")
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('build', '0043_buildline'),
+    ]
+
+    operations = [
+        migrations.RunPython(
+            add_lines_to_builds,
+            reverse_code=remove_build_lines,
+        ),
+    ]

InvenTree/build/migrations/0045_builditem_build_line.py

@@ -0,0 +1,19 @@
+# Generated by Django 3.2.19 on 2023-06-06 10:30
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('build', '0044_auto_20230528_1410'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='builditem',
+            name='build_line',
+            field=models.ForeignKey(null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='allocations', to='build.buildline'),
+        ),
+    ]

InvenTree/build/migrations/0046_auto_20230606_1033.py

@@ -0,0 +1,95 @@
+# Generated by Django 3.2.19 on 2023-06-06 10:33
+
+import logging
+
+from django.db import migrations
+
+
+logger = logging.getLogger('inventree')
+
+
+def add_build_line_links(apps, schema_editor):
+    """Data migration to add links between BuildLine and BuildItem objects.
+
+    Associated model types:
+        Build: A "Build Order"
+        BomItem: An individual line in the BOM for Build.part
+        BuildItem: An individual stock allocation against the Build Order
+        BuildLine: (new model) an individual line in the Build Order
+
+    Goals:
+        - Find all BuildItem objects which are associated with a Build
+        - Link them against the relevant BuildLine object
+        - The BuildLine objects should have been created in 0044_auto_20230528_1410.py
+    """
+
+    BuildItem = apps.get_model("build", "BuildItem")
+    BuildLine = apps.get_model("build", "BuildLine")
+
+    # Find any existing BuildItem objects
+    build_items = BuildItem.objects.all()
+
+    n_missing = 0
+
+    for item in build_items:
+
+        # Find the relevant BuildLine object
+        line = BuildLine.objects.filter(
+            build=item.build,
+            bom_item=item.bom_item
+        ).first()
+
+        if line is None:
+            logger.warning(f"BuildLine does not exist for BuildItem {item.pk}")
+            n_missing += 1
+
+            if item.build is None or item.bom_item is None:
+                continue
+
+            # Create one!
+            line = BuildLine.objects.create(
+                build=item.build,
+                bom_item=item.bom_item,
+                quantity=item.bom_item.quantity * item.build.quantity
+            )
+
+        # Link the BuildItem to the BuildLine
+        # In the next data migration, we remove the 'build' and 'bom_item' fields from BuildItem
+        item.build_line = line
+        item.save()
+
+    if build_items.count() > 0:
+        logger.info(f"add_build_line_links: Updated {build_items.count()} BuildItem objects (added {n_missing})")
+
+
+def reverse_build_links(apps, schema_editor):
+    """Reverse data migration from add_build_line_links
+
+    Basically, iterate through each BuildItem and update the links based on the BuildLine
+    """
+
+    BuildItem = apps.get_model("build", "BuildItem")
+
+    items = BuildItem.objects.all()
+
+    for item in items:
+        item.build = item.build_line.build
+        item.bom_item = item.build_line.bom_item
+        item.save()
+
+    if items.count() > 0:
+        logger.info(f"reverse_build_links: Updated {items.count()} BuildItem objects")
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('build', '0045_builditem_build_line'),
+    ]
+
+    operations = [
+        migrations.RunPython(
+            add_build_line_links,
+            reverse_code=reverse_build_links,
+        )
+    ]

InvenTree/build/migrations/0047_auto_20230606_1058.py

@@ -0,0 +1,26 @@
+# Generated by Django 3.2.19 on 2023-06-06 10:58
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('stock', '0101_stockitemtestresult_metadata'),
+        ('build', '0046_auto_20230606_1033'),
+    ]
+
+    operations = [
+        migrations.AlterUniqueTogether(
+            name='builditem',
+            unique_together={('build_line', 'stock_item', 'install_into')},
+        ),
+        migrations.RemoveField(
+            model_name='builditem',
+            name='bom_item',
+        ),
+        migrations.RemoveField(
+            model_name='builditem',
+            name='build',
+        ),
+    ]

InvenTree/build/migrations/0048_build_project_code.py

@@ -0,0 +1,20 @@
+# Generated by Django 3.2.19 on 2023-05-14 09:22
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('common', '0019_projectcode_metadata'),
+        ('build', '0047_auto_20230606_1058'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='build',
+            name='project_code',
+            field=models.ForeignKey(blank=True, help_text='Project code for this build order', null=True, on_delete=django.db.models.deletion.SET_NULL, to='common.projectcode', verbose_name='Project Code'),
+        ),
+    ]

InvenTree/build/serializers.py

@@ -4,8 +4,11 @@ from django.db import transaction
 from django.core.exceptions import ValidationError as DjangoValidationError
 from django.utils.translation import gettext_lazy as _
 
-from django.db.models import Case, When, Value
+from django.db import models
+from django.db.models import ExpressionWrapper, F, FloatField
+from django.db.models import Case, Sum, When, Value
 from django.db.models import BooleanField
+from django.db.models.functions import Coalesce
 
 from rest_framework import serializers
 from rest_framework.serializers import ValidationError
@@ -17,14 +20,15 @@ import InvenTree.helpers
 from InvenTree.serializers import InvenTreeDecimalField
 from InvenTree.status_codes import StockStatus
 
-from stock.models import StockItem, StockLocation
+from stock.models import generate_batch_code, StockItem, StockLocation
 from stock.serializers import StockItemSerializerBrief, LocationSerializer
 
-from part.models import BomItem
-from part.serializers import PartSerializer, PartBriefSerializer
+from common.serializers import ProjectCodeSerializer
+import part.filters
+from part.serializers import BomItemSerializer, PartSerializer, PartBriefSerializer
 from users.serializers import OwnerSerializer
 
-from .models import Build, BuildItem, BuildOrderAttachment
+from .models import Build, BuildLine, BuildItem, BuildOrderAttachment
 
 
 class BuildSerializer(InvenTreeModelSerializer):
@@ -46,6 +50,8 @@ class BuildSerializer(InvenTreeModelSerializer):
             'parent',
             'part',
             'part_detail',
+            'project_code',
+            'project_code_detail',
             'overdue',
             'reference',
             'sales_order',
@@ -87,11 +93,13 @@ class BuildSerializer(InvenTreeModelSerializer):
 
     barcode_hash = serializers.CharField(read_only=True)
 
+    project_code_detail = ProjectCodeSerializer(source='project_code', many=False, read_only=True)
+
     @staticmethod
     def annotate_queryset(queryset):
         """Add custom annotations to the BuildSerializer queryset, performing database queries as efficiently as possible.
 
-        The following annoted fields are added:
+        The following annotated fields are added:
 
         - overdue: True if the build is outstanding *and* the completion date has past
         """
@@ -121,7 +129,6 @@ class BuildSerializer(InvenTreeModelSerializer):
 
     def validate_reference(self, reference):
         """Custom validation for the Build reference field"""
-
         # Ensure the reference matches the required pattern
         Build.validate_reference_field(reference)
 
@@ -170,7 +177,7 @@ class BuildOutputSerializer(serializers.Serializer):
         if to_complete:
 
             # The build output must have all tracked parts allocated
-            if not build.is_fully_allocated(output):
+            if not build.is_output_fully_allocated(output):
 
                 # Check if the user has specified that incomplete allocations are ok
                 accept_incomplete = InvenTree.helpers.str2bool(self.context['request'].data.get('accept_incomplete_allocation', False))
@@ -181,6 +188,44 @@ class BuildOutputSerializer(serializers.Serializer):
         return output
 
 
+class BuildOutputQuantitySerializer(BuildOutputSerializer):
+    """Serializer for a single build output, with additional quantity field"""
+
+    class Meta:
+        """Serializer metaclass"""
+        fields = BuildOutputSerializer.Meta.fields + [
+            'quantity',
+        ]
+
+    quantity = serializers.DecimalField(
+        max_digits=15,
+        decimal_places=5,
+        min_value=0,
+        required=True,
+        label=_('Quantity'),
+        help_text=_('Enter quantity for build output'),
+    )
+
+    def validate(self, data):
+        """Validate the serializer data"""
+        data = super().validate(data)
+
+        output = data.get('output')
+        quantity = data.get('quantity')
+
+        if quantity <= 0:
+            raise ValidationError({
+                'quantity': _('Quantity must be greater than zero')
+            })
+
+        if quantity > output.quantity:
+            raise ValidationError({
+                'quantity': _("Quantity cannot be greater than the output quantity")
+            })
+
+        return data
+
+
 class BuildOutputCreateSerializer(serializers.Serializer):
     """Serializer for creating a new BuildOutput against a BuildOrder.
 
@@ -226,6 +271,7 @@ class BuildOutputCreateSerializer(serializers.Serializer):
     batch_code = serializers.CharField(
         required=False,
         allow_blank=True,
+        default=generate_batch_code,
         label=_('Batch Code'),
         help_text=_('Batch code for this build output'),
     )
@@ -302,12 +348,14 @@ class BuildOutputCreateSerializer(serializers.Serializer):
         auto_allocate = data.get('auto_allocate', False)
 
         build = self.get_build()
+        user = self.context['request'].user
 
         build.create_build_output(
             quantity,
             serials=self.serials,
             batch=batch_code,
             auto_allocate=auto_allocate,
+            user=user,
         )
 
 
@@ -349,6 +397,77 @@ class BuildOutputDeleteSerializer(serializers.Serializer):
                 build.delete_output(output)
 
 
+class BuildOutputScrapSerializer(serializers.Serializer):
+    """DRF serializer for scrapping one or more build outputs"""
+
+    class Meta:
+        """Serializer metaclass"""
+        fields = [
+            'outputs',
+            'location',
+            'notes',
+        ]
+
+    outputs = BuildOutputQuantitySerializer(
+        many=True,
+        required=True,
+    )
+
+    location = serializers.PrimaryKeyRelatedField(
+        queryset=StockLocation.objects.all(),
+        many=False,
+        allow_null=False,
+        required=True,
+        label=_('Location'),
+        help_text=_('Stock location for scrapped outputs'),
+    )
+
+    discard_allocations = serializers.BooleanField(
+        required=False,
+        default=False,
+        label=_('Discard Allocations'),
+        help_text=_('Discard any stock allocations for scrapped outputs'),
+    )
+
+    notes = serializers.CharField(
+        label=_('Notes'),
+        help_text=_('Reason for scrapping build output(s)'),
+        required=True,
+        allow_blank=False,
+    )
+
+    def validate(self, data):
+        """Perform validation on the serializer data"""
+        super().validate(data)
+        outputs = data.get('outputs', [])
+
+        if len(outputs) == 0:
+            raise ValidationError(_("A list of build outputs must be provided"))
+
+        return data
+
+    def save(self):
+        """Save the serializer to scrap the build outputs"""
+        build = self.context['build']
+        request = self.context['request']
+        data = self.validated_data
+        outputs = data.get('outputs', [])
+
+        # Scrap the build outputs
+        with transaction.atomic():
+            for item in outputs:
+                output = item['output']
+                quantity = item['quantity']
+                build.scrap_build_output(
+                    output,
+                    quantity,
+                    data.get('location', None),
+                    user=request.user,
+                    notes=data.get('notes', ''),
+                    discard_allocations=data.get('discard_allocations', False)
+                )
+
+
 class BuildOutputCompleteSerializer(serializers.Serializer):
     """DRF serializer for completing one or more build outputs."""
 
@@ -376,8 +495,8 @@ class BuildOutputCompleteSerializer(serializers.Serializer):
     )
 
     status = serializers.ChoiceField(
-        choices=list(StockStatus.items()),
-        default=StockStatus.OK,
+        choices=StockStatus.items(),
+        default=StockStatus.OK.value,
         label=_("Status"),
     )
 
@@ -448,7 +567,7 @@ class BuildCancelSerializer(serializers.Serializer):
         build = self.context['build']
 
         return {
-            'has_allocated_stock': build.is_partially_allocated(None),
+            'has_allocated_stock': build.is_partially_allocated(),
             'incomplete_outputs': build.incomplete_count,
             'completed_outputs': build.complete_count,
         }
@@ -489,7 +608,7 @@ class OverallocationChoice():
     TRIM = 'trim'
 
     OPTIONS = {
-        REJECT: ('Not permitted'),
+        REJECT: _('Not permitted'),
         ACCEPT: _('Accept as consumed by this build order'),
         TRIM: _('Deallocate before completing this build order'),
     }
@@ -503,12 +622,11 @@ class BuildCompleteSerializer(serializers.Serializer):
 
         This is so we can determine (at run time) whether the build is ready to be completed.
         """
-
         build = self.context['build']
 
         return {
-            'overallocated': build.has_overallocated_parts(),
-            'allocated': build.are_untracked_parts_allocated(),
+            'overallocated': build.is_overallocated(),
+            'allocated': build.are_untracked_parts_allocated,
             'remaining': build.remaining,
             'incomplete': build.incomplete_count,
         }
@@ -525,7 +643,7 @@ class BuildCompleteSerializer(serializers.Serializer):
         """Check if the 'accept_overallocated' field is required"""
         build = self.context['build']
 
-        if build.has_overallocated_parts(output=None) and value == OverallocationChoice.REJECT:
+        if build.is_overallocated() and value == OverallocationChoice.REJECT:
             raise ValidationError(_('Some stock items have been overallocated'))
 
         return value
@@ -541,7 +659,7 @@ class BuildCompleteSerializer(serializers.Serializer):
         """Check if the 'accept_unallocated' field is required"""
         build = self.context['build']
 
-        if not build.are_untracked_parts_allocated() and not value:
+        if not build.are_untracked_parts_allocated and not value:
             raise ValidationError(_('Required stock has not been fully allocated'))
 
         return value
@@ -592,12 +710,12 @@ class BuildUnallocationSerializer(serializers.Serializer):
     - bom_item: Filter against a particular BOM line item
     """
 
-    bom_item = serializers.PrimaryKeyRelatedField(
-        queryset=BomItem.objects.all(),
+    build_line = serializers.PrimaryKeyRelatedField(
+        queryset=BuildLine.objects.all(),
         many=False,
         allow_null=True,
         required=False,
-        label=_('BOM Item'),
+        label=_('Build Line'),
     )
 
     output = serializers.PrimaryKeyRelatedField(
@@ -628,8 +746,8 @@ class BuildUnallocationSerializer(serializers.Serializer):
 
         data = self.validated_data
 
-        build.unallocateStock(
-            bom_item=data['bom_item'],
+        build.deallocate_stock(
+            build_line=data['build_line'],
             output=data['output']
         )
 
@@ -640,34 +758,34 @@ class BuildAllocationItemSerializer(serializers.Serializer):
     class Meta:
         """Serializer metaclass"""
         fields = [
-            'bom_item',
+            'build_item',
             'stock_item',
             'quantity',
             'output',
         ]
 
-    bom_item = serializers.PrimaryKeyRelatedField(
-        queryset=BomItem.objects.all(),
+    build_line = serializers.PrimaryKeyRelatedField(
+        queryset=BuildLine.objects.all(),
         many=False,
         allow_null=False,
         required=True,
-        label=_('BOM Item'),
+        label=_('Build Line Item'),
     )
 
-    def validate_bom_item(self, bom_item):
+    def validate_build_line(self, build_line):
         """Check if the parts match"""
         build = self.context['build']
 
         # BomItem should point to the same 'part' as the parent build
-        if build.part != bom_item.part:
+        if build.part != build_line.bom_item.part:
 
             # If not, it may be marked as "inherited" from a parent part
-            if bom_item.inherited and build.part in bom_item.part.get_descendants(include_self=False):
+            if build_line.bom_item.inherited and build.part in build_line.bom_item.part.get_descendants(include_self=False):
                 pass
             else:
                 raise ValidationError(_("bom_item.part must point to the same part as the build order"))
 
-        return bom_item
+        return build_line
 
     stock_item = serializers.PrimaryKeyRelatedField(
         queryset=StockItem.objects.all(),
@@ -710,8 +828,7 @@ class BuildAllocationItemSerializer(serializers.Serializer):
         """Perform data validation for this item"""
         super().validate(data)
 
-        build = self.context['build']
-        bom_item = data['bom_item']
+        build_line = data['build_line']
         stock_item = data['stock_item']
         quantity = data['quantity']
         output = data.get('output', None)
@@ -733,22 +850,18 @@ class BuildAllocationItemSerializer(serializers.Serializer):
             })
 
         # Output *must* be set for trackable parts
-        if output is None and bom_item.sub_part.trackable:
+        if output is None and build_line.bom_item.sub_part.trackable:
             raise ValidationError({
                 'output': _('Build output must be specified for allocation of tracked parts'),
             })
 
         # Output *cannot* be set for un-tracked parts
-        if output is not None and not bom_item.sub_part.trackable:
+        if output is not None and not build_line.bom_item.sub_part.trackable:
 
             raise ValidationError({
                 'output': _('Build output cannot be specified for allocation of untracked parts'),
             })
 
-        # Check if this allocation would be unique
-        if BuildItem.objects.filter(build=build, stock_item=stock_item, install_into=output).exists():
-            raise ValidationError(_('This stock item has already been allocated to this build output'))
-
         return data
 
 
@@ -780,28 +893,29 @@ class BuildAllocationSerializer(serializers.Serializer):
 
         items = data.get('items', [])
 
-        build = self.context['build']
-
         with transaction.atomic():
             for item in items:
-                bom_item = item['bom_item']
+                build_line = item['build_line']
                 stock_item = item['stock_item']
                 quantity = item['quantity']
                 output = item.get('output', None)
 
                 # Ignore allocation for consumable BOM items
-                if bom_item.consumable:
+                if build_line.bom_item.consumable:
                     continue
 
                 try:
                     # Create a new BuildItem to allocate stock
-                    BuildItem.objects.create(
-                        build=build,
-                        bom_item=bom_item,
+                    build_item, created = BuildItem.objects.get_or_create(
+                        build_line=build_line,
                         stock_item=stock_item,
-                        quantity=quantity,
-                        install_into=output
+                        install_into=output,
                     )
+                    if created:
+                        build_item.quantity = quantity
+                    else:
+                        build_item.quantity += quantity
+                    build_item.save()
                 except (ValidationError, DjangoValidationError) as exc:
                     # Catch model errors and re-throw as DRF errors
                     raise ValidationError(detail=serializers.as_serializer_error(exc))
@@ -879,43 +993,37 @@ class BuildItemSerializer(InvenTreeModelSerializer):
         model = BuildItem
         fields = [
             'pk',
-            'bom_part',
             'build',
-            'build_detail',
+            'build_line',
             'install_into',
-            'location',
-            'location_detail',
-            'part',
-            'part_detail',
             'stock_item',
+            'quantity',
+            'location_detail',
+            'part_detail',
             'stock_item_detail',
-            'quantity'
+            'build_detail',
         ]
 
-    bom_part = serializers.IntegerField(source='bom_item.sub_part.pk', read_only=True)
-    part = serializers.IntegerField(source='stock_item.part.pk', read_only=True)
-    location = serializers.IntegerField(source='stock_item.location.pk', read_only=True)
+    # Annotated fields
+    build = serializers.PrimaryKeyRelatedField(source='build_line.build', many=False, read_only=True)
 
     # Extra (optional) detail fields
-    part_detail = PartSerializer(source='stock_item.part', many=False, read_only=True)
-    build_detail = BuildSerializer(source='build', many=False, read_only=True)
+    part_detail = PartBriefSerializer(source='stock_item.part', many=False, read_only=True, pricing=False)
     stock_item_detail = StockItemSerializerBrief(source='stock_item', read_only=True)
     location_detail = LocationSerializer(source='stock_item.location', read_only=True)
+    build_detail = BuildSerializer(source='build_line.build', many=False, read_only=True)
 
     quantity = InvenTreeDecimalField()
 
     def __init__(self, *args, **kwargs):
         """Determine which extra details fields should be included"""
-        build_detail = kwargs.pop('build_detail', False)
-        part_detail = kwargs.pop('part_detail', False)
-        location_detail = kwargs.pop('location_detail', False)
+        part_detail = kwargs.pop('part_detail', True)
+        location_detail = kwargs.pop('location_detail', True)
         stock_detail = kwargs.pop('stock_detail', False)
+        build_detail = kwargs.pop('build_detail', False)
 
         super().__init__(*args, **kwargs)
 
-        if not build_detail:
-            self.fields.pop('build_detail')
-
         if not part_detail:
             self.fields.pop('part_detail')
 
@@ -925,6 +1033,165 @@ class BuildItemSerializer(InvenTreeModelSerializer):
         if not stock_detail:
             self.fields.pop('stock_item_detail')
 
+        if not build_detail:
+            self.fields.pop('build_detail')
+
+
+class BuildLineSerializer(InvenTreeModelSerializer):
+    """Serializer for a BuildItem object."""
+
+    class Meta:
+        """Serializer metaclass"""
+
+        model = BuildLine
+        fields = [
+            'pk',
+            'build',
+            'bom_item',
+            'bom_item_detail',
+            'part_detail',
+            'quantity',
+            'allocations',
+
+            # Annotated fields
+            'allocated',
+            'on_order',
+            'available_stock',
+            'available_substitute_stock',
+            'available_variant_stock',
+            'total_available_stock',
+        ]
+
+        read_only_fields = [
+            'build',
+            'bom_item',
+            'allocations',
+        ]
+
+    quantity = serializers.FloatField()
+
+    # Foreign key fields
+    bom_item_detail = BomItemSerializer(source='bom_item', many=False, read_only=True, pricing=False)
+    part_detail = PartSerializer(source='bom_item.sub_part', many=False, read_only=True, pricing=False)
+    allocations = BuildItemSerializer(many=True, read_only=True)
+
+    # Annotated (calculated) fields
+    allocated = serializers.FloatField(read_only=True)
+    on_order = serializers.FloatField(read_only=True)
+    available_stock = serializers.FloatField(read_only=True)
+    available_substitute_stock = serializers.FloatField(read_only=True)
+    available_variant_stock = serializers.FloatField(read_only=True)
+    total_available_stock = serializers.FloatField(read_only=True)
+
+    @staticmethod
+    def annotate_queryset(queryset):
+        """Add extra annotations to the queryset:
+
+        - allocated: Total stock quantity allocated against this build line
+        - available: Total stock available for allocation against this build line
+        - on_order: Total stock on order for this build line
+        """
+        queryset = queryset.select_related(
+            'build', 'bom_item',
+        )
+
+        # Pre-fetch related fields
+        queryset = queryset.prefetch_related(
+            'bom_item__sub_part',
+            'bom_item__sub_part__stock_items',
+            'bom_item__sub_part__stock_items__allocations',
+            'bom_item__sub_part__stock_items__sales_order_allocations',
+            'bom_item__sub_part__tags',
+
+            'bom_item__substitutes',
+            'bom_item__substitutes__part__stock_items',
+            'bom_item__substitutes__part__stock_items__allocations',
+            'bom_item__substitutes__part__stock_items__sales_order_allocations',
+
+            'allocations',
+            'allocations__stock_item',
+            'allocations__stock_item__part',
+            'allocations__stock_item__location',
+            'allocations__stock_item__location__tags',
+        )
+
+        # Annotate the "allocated" quantity
+        # Difficulty: Easy
+        queryset = queryset.annotate(
+            allocated=Coalesce(
+                Sum('allocations__quantity'), 0,
+                output_field=models.DecimalField()
+            ),
+        )
+
+        ref = 'bom_item__sub_part__'
+
+        # Annotate the "on_order" quantity
+        # Difficulty: Medium
+        queryset = queryset.annotate(
+            on_order=part.filters.annotate_on_order_quantity(reference=ref),
+        )
+
+        # Annotate the "available" quantity
+        # TODO: In the future, this should be refactored.
+        # TODO: Note that part.serializers.BomItemSerializer also has a similar annotation
+        queryset = queryset.alias(
+            total_stock=part.filters.annotate_total_stock(reference=ref),
+            allocated_to_sales_orders=part.filters.annotate_sales_order_allocations(reference=ref),
+            allocated_to_build_orders=part.filters.annotate_build_order_allocations(reference=ref),
+        )
+
+        # Calculate 'available_stock' based on previously annotated fields
+        queryset = queryset.annotate(
+            available_stock=ExpressionWrapper(
+                F('total_stock') - F('allocated_to_sales_orders') - F('allocated_to_build_orders'),
+                output_field=models.DecimalField(),
+            )
+        )
+
+        ref = 'bom_item__substitutes__part__'
+
+        # Extract similar information for any 'substitute' parts
+        queryset = queryset.alias(
+            substitute_stock=part.filters.annotate_total_stock(reference=ref),
+            substitute_build_allocations=part.filters.annotate_build_order_allocations(reference=ref),
+            substitute_sales_allocations=part.filters.annotate_sales_order_allocations(reference=ref)
+        )
+
+        # Calculate 'available_substitute_stock' field
+        queryset = queryset.annotate(
+            available_substitute_stock=ExpressionWrapper(
+                F('substitute_stock') - F('substitute_build_allocations') - F('substitute_sales_allocations'),
+                output_field=models.DecimalField(),
+            )
+        )
+
+        # Annotate the queryset with 'available variant stock' information
+        variant_stock_query = part.filters.variant_stock_query(reference='bom_item__sub_part__')
+
+        queryset = queryset.alias(
+            variant_stock_total=part.filters.annotate_variant_quantity(variant_stock_query, reference='quantity'),
+            variant_bo_allocations=part.filters.annotate_variant_quantity(variant_stock_query, reference='sales_order_allocations__quantity'),
+            variant_so_allocations=part.filters.annotate_variant_quantity(variant_stock_query, reference='allocations__quantity'),
+        )
+
+        queryset = queryset.annotate(
+            available_variant_stock=ExpressionWrapper(
+                F('variant_stock_total') - F('variant_bo_allocations') - F('variant_so_allocations'),
+                output_field=FloatField(),
+            )
+        )
+
+        # Annotate with the 'total available stock'
+        queryset = queryset.annotate(
+            total_available_stock=ExpressionWrapper(
+                F('available_stock') + F('available_substitute_stock') + F('available_variant_stock'),
+                output_field=FloatField(),
+            )
+        )
+
+        return queryset
+
 
 class BuildAttachmentSerializer(InvenTreeAttachmentSerializer):
     """Serializer for a BuildAttachment."""

InvenTree/build/tasks.py

@@ -12,9 +12,10 @@ from allauth.account.models import EmailAddress
 from plugin.events import trigger_event
 import common.notifications
 import build.models
-import InvenTree.helpers
+import InvenTree.email
+import InvenTree.helpers_model
 import InvenTree.tasks
-from InvenTree.status_codes import BuildStatus
+from InvenTree.status_codes import BuildStatusGroups
 from InvenTree.ready import isImportingData
 
 import part.models as part_models
@@ -23,6 +24,54 @@ import part.models as part_models
 logger = logging.getLogger('inventree')
 
 
+def update_build_order_lines(bom_item_pk: int):
+    """Update all BuildOrderLineItem objects which reference a particular BomItem.
+
+    This task is triggered when a BomItem is created or updated.
+    """
+    logger.info("Updating build order lines for BomItem %s", bom_item_pk)
+
+    bom_item = part_models.BomItem.objects.filter(pk=bom_item_pk).first()
+
+    # If the BomItem has been deleted, there is nothing to do
+    if not bom_item:
+        return
+
+    assemblies = bom_item.get_assemblies()
+
+    # Find all active builds which reference any of the parts
+    builds = build.models.Build.objects.filter(
+        part__in=list(assemblies),
+        status__in=BuildStatusGroups.ACTIVE_CODES
+    )
+
+    # Iterate through each build, and update the relevant line items
+    for bo in builds:
+        # Try to find a matching build order line
+        line = build.models.BuildLine.objects.filter(
+            build=bo,
+            bom_item=bom_item,
+        ).first()
+
+        q = bom_item.get_required_quantity(bo.quantity)
+
+        if line:
+            # Ensure quantity is correct
+            if line.quantity != q:
+                line.quantity = q
+                line.save()
+        else:
+            # Create a new line item
+            build.models.BuildLine.objects.create(
+                build=bo,
+                bom_item=bom_item,
+                quantity=q,
+            )
+
+    if builds.count() > 0:
+        logger.info("Updated %s build orders for part %s", builds.count(), bom_item.part)
+
+
 def check_build_stock(build: build.models.Build):
     """Check the required stock for a newly created build order.
 
@@ -44,7 +93,7 @@ def check_build_stock(build: build.models.Build):
         part = build.part
     except part_models.Part.DoesNotExist:
         # Note: This error may be thrown during unit testing...
-        logger.error("Invalid build.part passed to 'build.tasks.check_build_stock'")
+        logger.exception("Invalid build.part passed to 'build.tasks.check_build_stock'")
         return
 
     for bom_item in part.get_bom_items():
@@ -64,7 +113,7 @@ def check_build_stock(build: build.models.Build):
             # There is not sufficient stock for this part
 
             lines.append({
-                'link': InvenTree.helpers.construct_absolute_url(sub_part.get_absolute_url()),
+                'link': InvenTree.helpers_model.construct_absolute_url(sub_part.get_absolute_url()),
                 'part': sub_part,
                 'in_stock': in_stock,
                 'allocated': allocated,
@@ -85,10 +134,10 @@ def check_build_stock(build: build.models.Build):
 
     if len(emails) > 0:
 
-        logger.info(f"Notifying users of stock required for build {build.pk}")
+        logger.info("Notifying users of stock required for build %s", build.pk)
 
         context = {
-            'link': InvenTree.helpers.construct_absolute_url(build.get_absolute_url()),
+            'link': InvenTree.helpers_model.construct_absolute_url(build.get_absolute_url()),
             'build': build,
             'part': build.part,
             'lines': lines,
@@ -101,12 +150,11 @@ def check_build_stock(build: build.models.Build):
 
         recipients = emails.values_list('email', flat=True)
 
-        InvenTree.tasks.send_email(subject, '', recipients, html_message=html_message)
+        InvenTree.email.send_email(subject, '', recipients, html_message=html_message)
 
 
 def notify_overdue_build_order(bo: build.models.Build):
     """Notify appropriate users that a Build has just become 'overdue'"""
-
     targets = []
 
     if bo.issued_by:
@@ -121,7 +169,7 @@ def notify_overdue_build_order(bo: build.models.Build):
         'order': bo,
         'name': name,
         'message': _(f"Build order {bo} is now overdue"),
-        'link': InvenTree.helpers.construct_absolute_url(
+        'link': InvenTree.helpers_model.construct_absolute_url(
             bo.get_absolute_url(),
         ),
         'template': {
@@ -152,12 +200,11 @@ def check_overdue_build_orders():
     - Look at the 'target_date' of any outstanding BuildOrder objects
     - If the 'target_date' expired *yesterday* then the order is just out of date
     """
-
     yesterday = datetime.now().date() - timedelta(days=1)
 
     overdue_orders = build.models.Build.objects.filter(
         target_date=yesterday,
-        status__in=BuildStatus.ACTIVE_CODES
+        status__in=BuildStatusGroups.ACTIVE_CODES
     )
 
     for bo in overdue_orders: