Version number:

- Update to 0.14.0

.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

@@ -1,19 +1,11 @@
 // For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
 // https://github.com/microsoft/vscode-dev-containers/tree/v0.241.1/containers/python-3
 {
-  "name": "InvenTree",
-  "build": {
-    "dockerfile": "Dockerfile",
-    "context": "..",
-    "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/*"
-    }
-  },
+  "name": "InvenTree devcontainer",
+  "dockerComposeFile": "docker-compose.yml",
+  "service": "inventree",
+  "overrideCommand": true,
+  "workspaceFolder": "/home/inventree/",
 
   // Configure tool-specific properties.
   "customizations": {
@@ -21,15 +13,13 @@
     "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,
         "python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8",
         "python.formatting.blackPath": "/usr/local/py-utils/bin/black",
         "python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf",
         "python.linting.banditPath": "/usr/local/py-utils/bin/bandit",
-        "python.linting.flake8Path": "/usr/local/py-utils/bin/flake8",
         "python.linting.mypyPath": "/usr/local/py-utils/bin/mypy",
         "python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle",
         "python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle",
@@ -40,49 +30,41 @@
       "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, 8080],
   "portsAttributes": {
+    "5173": {
+      "label": "Vite Server"
+    },
     "8000": {
-      "label": "InvenTree server"
+      "label": "InvenTree Server"
+    },
+    "8080": {
+      "label": "mkdocs server"
     }
   },
 
   // Use 'postCreateCommand' to run commands after the container is created.
-  "postCreateCommand": "./.devcontainer/postCreateCommand.sh",
+  "postCreateCommand": ".devcontainer/postCreateCommand.sh",
 
   // Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
   "remoteUser": "vscode",
-  "features": {
-    "git": "os-provided",
-    "github-cli": "latest"
-  },
+  "containerUser": "vscode",
 
   "remoteEnv": {
-    // InvenTree config
-    "INVENTREE_DEBUG": "True",
-    "INVENTREE_DEBUG_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",
 
     // 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/docker-compose.yml

@@ -0,0 +1,40 @@
+version: "3"
+
+services:
+  db:
+    image: postgres:13
+    restart: unless-stopped
+    expose:
+      - 5432/tcp
+    volumes:
+      - inventreedatabase:/var/lib/postgresql/data:z
+    environment:
+      POSTGRES_DB: inventree
+      POSTGRES_USER: inventree_user
+      POSTGRES_PASSWORD: inventree_password
+
+  inventree:
+    build:
+      context: ..
+      target: dev
+      args:
+        base_image: "mcr.microsoft.com/vscode/devcontainers/base:alpine-3.18"
+        data_dir: "dev"
+    volumes:
+      - ../:/home/inventree:z
+
+    environment:
+      INVENTREE_DEBUG: True
+      INVENTREE_DB_ENGINE: postgresql
+      INVENTREE_DB_NAME: inventree
+      INVENTREE_DB_HOST: db
+      INVENTREE_DB_USER: inventree_user
+      INVENTREE_DB_PASSWORD: inventree_password
+      INVENTREE_PLUGINS_ENABLED: True
+      INVENTREE_PY_ENV: /home/inventree/dev/venv
+
+    depends_on:
+      - db
+
+volumes:
+  inventreedatabase:

.devcontainer/postCreateCommand.sh

@@ -1,14 +1,22 @@
 #!/bin/bash
 
-# create folders
-mkdir -p /workspaces/InvenTree/dev/{commandhistory,plugins}
-cd /workspaces/InvenTree
+# Avoiding Dubious Ownership in Dev Containers for setup commands that use git
+git config --global --add safe.directory /home/inventree
 
 # create venv
-python3 -m venv dev/venv
-. dev/venv/bin/activate
+python3 -m venv /home/inventree/dev/venv --system-site-packages --upgrade-deps
+. /home/inventree/dev/venv/bin/activate
 
-# setup InvenTree server
-pip install invoke
-inv update
-inv setup-dev
+# Run initial InvenTree server setup
+invoke update -s
+
+# Configure dev environment
+invoke setup-dev
+
+# Install required frontend packages
+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

.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,21 +48,24 @@ runs:
         if: ${{ inputs.python == 'true' }}
         shell: bash
         run: |
-          python3 -m pip install pip==23.0.1
-          pip3 install invoke wheel
+          python3 -m pip install -U pip
+          pip3 install invoke wheel uv
+      - name: Set the VIRTUAL_ENV variable for uv to work
+        run: echo "VIRTUAL_ENV=${Python_ROOT_DIR}" >> $GITHUB_ENV
+        shell: bash
       - name: Install Specific Python Dependencies
         if: ${{ inputs.pip-dependency }}
         shell: bash
-        run: pip3 install ${{ inputs.pip-dependency }}
+        run: uv pip install ${{ inputs.pip-dependency }}
 
       # 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
@@ -79,12 +82,12 @@ runs:
       - name: Install dev requirements
         if: ${{ inputs.dev-install == 'true' ||inputs.install == 'true' }}
         shell: bash
-        run: pip install -r requirements-dev.txt
+        run: uv pip install -r requirements-dev.txt
       - name: Run invoke install
         if: ${{ inputs.install == 'true' }}
         shell: bash
-        run: invoke install
+        run: invoke install --uv
       - name: Run invoke update
         if: ${{ inputs.update == 'true' }}
         shell: bash
-        run: invoke update
+        run: invoke update --uv

.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

@@ -8,6 +8,9 @@ on:
     branches:
       - l10
 
+env:
+  python_version: 3.9
+
 jobs:
 
   check:
@@ -21,22 +24,15 @@ jobs:
       INVENTREE_MEDIA_ROOT: ./media
       INVENTREE_STATIC_ROOT: ./static
       INVENTREE_BACKUP_DIR: ./backup
-      python_version: 3.9
 
     steps:
       - name: Checkout Code
-        uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # pin@v3.1.0
-      - name: Set Up Python ${{ env.python_version }}
-        uses: actions/setup-python@13ae5bb136fac2878aff31522b9efb785519f984 # pin@v4.3.0
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # pin@v4.1.1
+      - name: Environment Setup
+        uses: ./.github/actions/setup
         with:
-          python-version: ${{ env.python_version }}
-          cache: 'pip'
-      - name: Install Dependencies
-        run: |
-          sudo apt-get update
-          sudo apt-get install gettext
-          pip3 install invoke
-          invoke install
+          install: true
+          apt-dependency: gettext
       - name: Test Translations
         run: invoke translate
       - name: Check Migration Files

.github/workflows/docker.yaml

@@ -20,31 +20,51 @@ 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
+              - tasks.py
 
   # 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
       id-token: write
     env:
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      python_version: 3.9
+      python_version: "3.11"
+    runs-on: ubuntu-latest  # in the future we can try to use alternative runners here
+
     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
@@ -56,14 +76,12 @@ jobs:
           echo "git_commit_date=$(git show -s --format=%ci)" >> $GITHUB_ENV
       - name: Build Docker Image
         # Build the development docker image (using docker-compose.yml)
-        run: |
-          docker-compose build --no-cache
+        run: docker-compose build --no-cache
       - name: Update Docker Image
         run: |
           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 +99,30 @@ 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: Clean up test folder
+        run: |
+          rm -rf InvenTree/_testfolder
       - 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 +131,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 +140,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 +157,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,28 +22,43 @@ env:
   INVENTREE_BACKUP_DIR: ../test_inventree_backup
 
 jobs:
-  pep_style:
-    name: Style [Python]
-    runs-on: ubuntu-20.04
+  paths-filter:
+    name: Filter
+    runs-on: ubuntu-latest
+
+    outputs:
+      server: ${{ steps.filter.outputs.server }}
+      migrations: ${{ steps.filter.outputs.migrations }}
+      frontend: ${{ steps.filter.outputs.frontend }}
+      api: ${{ steps.filter.outputs.api }}
 
     steps:
-      - uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # pin@v3.1.0
-      - name: Enviroment Setup
-        uses: ./.github/actions/setup
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # pin@v4.1.1
+      - uses: dorny/paths-filter@4512585405083f25c027a35db413c2b3b9006d50 # pin@v2.11.1
+        id: filter
         with:
-          dev-install: true
-      - name: Run flake8
-        run: flake8 InvenTree --extend-ignore=D
+          filters: |
+            server:
+              - 'InvenTree/**'
+              - 'requirements.txt'
+              - 'requirements-dev.txt'
+            migrations:
+              - '**/migrations/**'
+              - '.github/workflows**'
+            api:
+              - 'InvenTree/InvenTree/api_version.py'
+            frontend:
+              - 'src/frontend/**'
 
   javascript:
-    name: Style [JS]
+    name: Style - Classic UI [JS]
     runs-on: ubuntu-20.04
 
-    needs: pep_style
+    needs: [ '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 +72,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 +92,117 @@ 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
+          pip install -r docs/requirements.txt
+          python docs/ci/check_mkdocs_config.py
+      - name: Check Links
+        uses: gaurav-nelson/github-action-markdown-link-check@v1
+        with:
+          folder-path: docs
+          config-file: docs/mlc_config.json
+          check-modified-files-only: 'yes'
+          use-quiet-mode: 'yes'
+
+  schema:
+    name: Tests - API Schema Documentation
+    runs-on: ubuntu-20.04
+    needs: paths-filter
+    if: needs.paths-filter.outputs.server == 'true'
+    env:
+      INVENTREE_DB_ENGINE: django.db.backends.sqlite3
+      INVENTREE_DB_NAME: ../inventree_unit_test_db.sqlite3
+      INVENTREE_ADMIN_USER: testuser
+      INVENTREE_ADMIN_PASSWORD: testpassword
+      INVENTREE_ADMIN_EMAIL: test@test.com
+      INVENTREE_PYTHON_TEST_SERVER: http://localhost:12345
+      INVENTREE_PYTHON_TEST_USERNAME: testuser
+      INVENTREE_PYTHON_TEST_PASSWORD: testpassword
+    outputs:
+      version: ${{ steps.version.outputs.version }}
+
+    steps:
+      - 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: Export API Documentation
+        run: invoke schema --ignore-warnings --filename InvenTree/schema.yml
+      - name: Upload schema
+        uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 # pin@v3.1.3
+        with:
+          name: schema.yml
+          path: InvenTree/schema.yml
+      - name: Download public schema
+        if: needs.paths-filter.outputs.api == 'false'
+        run: |
+          pip install requests >/dev/null 2>&1
+          version="$(python3 ci/version_check.py only_version 2>&1)"
+          echo "Version: $version"
+          url="https://raw.githubusercontent.com/inventree/schema/main/export/${version}/api.yaml"
+          echo "URL: $url"
+          curl -s -o api.yaml $url
+          echo "Downloaded api.yaml"
+      - name: Check for differences in API Schema
+        if: needs.paths-filter.outputs.api == 'false'
+        run: |
+          diff --color -u InvenTree/schema.yml api.yaml
+          diff -u InvenTree/schema.yml api.yaml && echo "no difference in API schema " || exit 2
+      - name: Check schema - including warnings
+        run: invoke schema
+        continue-on-error: true
+      - name: Extract version for publishing
+        id: version
+        if: github.ref == 'refs/heads/master' && needs.paths-filter.outputs.api == 'true'
+        run: |
+          pip install requests >/dev/null 2>&1
+          version="$(python3 ci/version_check.py only_version 2>&1)"
+          echo "Version: $version"
+          echo "version=$version" >> "$GITHUB_OUTPUT"
+
+  schema-push:
+            name: Push new schema
+            runs-on: ubuntu-20.04
+            needs: [paths-filter, schema]
+            if: needs.schema.result == 'success' && github.ref == 'refs/heads/master' && needs.paths-filter.outputs.api == 'true'
+            env:
+              version: ${{ needs.schema.outputs.version }}
+
+            steps:
+              - uses: actions/checkout@v4
+                with:
+                    repository: inventree/schema
+                    token: ${{ secrets.SCHEMA_PAT }}
+              - name: Download schema artifact
+                uses: actions/download-artifact@v3
+                with:
+                  name: schema.yml
+              - name: Move schema to correct location
+                run: |
+                  echo "Version: $version"
+                  mkdir export/${version}
+                  mv schema.yml export/${version}/api.yaml
+              - uses: stefanzweifel/git-auto-commit-action@v5
+                with:
+                  commit_message: "Update API schema for ${version}"
+
   python:
     name: Tests - inventree-python
     runs-on: ubuntu-20.04
@@ -114,16 +221,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
@@ -136,57 +243,44 @@ jobs:
           invoke check-server
           coverage run -m unittest discover -s test/
 
-  docstyle:
-    name: Style [Python Docstrings]
-    runs-on: ubuntu-20.04
-
-    needs: pre-commit
-    continue-on-error: true
-
-    steps:
-      - uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # pin@v3.1.0
-      - name: Enviroment Setup
-        uses: ./.github/actions/setup
-        with:
-          install: true
-      - name: Run flake8
-        run: flake8 InvenTree --statistics
-
   coverage:
     name: Tests - DB [SQLite] + Coverage
     runs-on: ubuntu-20.04
 
-    needs: [ 'javascript', 'html', 'pre-commit' ]
+    needs: [ '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: [ 'pre-commit' ]
 
     env:
       INVENTREE_DB_ENGINE: django.db.backends.postgresql
@@ -213,12 +307,12 @@ 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
-          pip-dependency: psycopg2 django-redis>=5.0.0
+          pip-dependency: psycopg django-redis>=5.0.0
           dev-install: true
           update: true
       - name: Run Tests
@@ -230,8 +324,7 @@ jobs:
     name: Tests - DB [MySQL]
     runs-on: ubuntu-20.04
 
-    needs: [ 'javascript', 'html', 'pre-commit' ]
-    if: github.event_name == 'push'
+    needs: [ 'pre-commit' ]
 
     env:
       # Database backend configuration
@@ -252,14 +345,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 +362,155 @@ 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: psycopg
+          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
+
+      - name: 0.13.5 Database
+        run: |
+          rm /home/runner/work/InvenTree/db.sqlite3
+          cp test-db/stable_0.13.5.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/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

@@ -5,6 +5,10 @@ on:
     branches:
       - master
 
+env:
+  python_version: 3.9
+  node_version: 16
+
 jobs:
   build:
 
@@ -21,20 +25,15 @@ jobs:
 
     steps:
       - name: Checkout Code
-        uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # pin@v3.1.0
-      - name: Set up Python 3.9
-        uses: actions/setup-python@13ae5bb136fac2878aff31522b9efb785519f984 # pin@v4.3.0
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # pin@v4.1.1
+      - name: Environment Setup
+        uses: ./.github/actions/setup
         with:
-          python-version: 3.9
-      - name: Install Dependencies
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y gettext
-          pip3 install invoke
-          invoke install
+          install: true
+          npm: true
+          apt-dependency: gettext
       - 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 +42,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

@@ -26,6 +26,7 @@ var/
 *.egg-info/
 .installed.cfg
 *.egg
+*.DS_Store
 
 # Django stuff:
 *.log
@@ -38,15 +39,6 @@ local_settings.py
 # Files used for testing
 inventree-demo-dataset/
 inventree-data/
-dummy_image.*
-_tmp.csv
-inventree/label.pdf
-inventree/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
@@ -69,6 +61,7 @@ secret_key.txt
 .idea/
 *.code-workspace
 .bash_history
+.DS_Store
 
 # https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
 .vscode/*
@@ -100,7 +93,18 @@ node_modules/
 maintenance_mode_state.txt
 
 # plugin dev directory
-plugins/
+InvenTree/plugins/
 
 # Compiled translation files
 *.mo
+messages.ts
+
+# Generated API schema file
+api.yaml
+
+# web frontend (static files)
+InvenTree/web/static
+
+# Generated docs files
+docs/docs/api/*.yml
+docs/docs/api/schema/*.yml

.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.10 | python3.11"
+  - "python3.9-venv | python3.10-venv | python3.11-venv"
+  - "python3.9-dev | python3.10-dev | python3.11-dev"
   - python3-pip
   - python3-cffi
   - python3-brotli

.pre-commit-config.yaml

@@ -3,38 +3,71 @@
 exclude: |
     (?x)^(
         InvenTree/InvenTree/static/.*|
-        InvenTree/locale/.*
+        InvenTree/locale/.*|
+        src/frontend/src/locales/.*|
+        .*/migrations/.*
     )$
 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'
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.2.2
     hooks:
-    -   id: flake8
-        additional_dependencies: [
-                'flake8-docstrings',
-                'flake8-string-format',
-                'pep8-naming ',
-        ]
--   repo: https://github.com/pycqa/isort
-    rev: '5.12.0'
-    hooks:
-    -   id: isort
--   repo: https://github.com/jazzband/pip-tools
-    rev: 6.12.3
+    - id: ruff-format
+      args: [--preview]
+    - id: ruff
+      args: [
+        --fix,
+        --preview
+      ]
+-   repo: https://github.com/matmair/ruff-pre-commit
+    rev: 830893bf46db844d9c99b6c468e285199adf2de6  # uv-018
     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, --python-version=3.9]
         files: ^requirements-dev\.(in|txt)$
       - id: pip-compile
         name: pip-compile requirements.txt
-        args: [requirements.in, -o, requirements.txt]
+        args: [requirements.in, -o, requirements.txt,--python-version=3.9]
         files: ^requirements\.(in|txt)$
+-   repo: https://github.com/Riverside-Healthcare/djLint
+    rev: v1.34.1
+    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: "v4.0.0-alpha.8"
+  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: "v9.0.0-beta.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/launch.json

@@ -14,13 +14,20 @@
       "justMyCode": true
     },
     {
-      "name": "Python: Django - 3rd party",
+      "name": "InvenTree Server - 3rd party",
       "type": "python",
       "request": "launch",
       "program": "${workspaceFolder}/InvenTree/manage.py",
       "args": ["runserver"],
       "django": true,
       "justMyCode": false
+    },
+    {
+      "name": "InvenTree Frontend - Vite",
+      "type": "chrome",
+      "request": "launch",
+      "url": "http://localhost:5173",
+      "webRoot": "${workspaceFolder}/src/frontend"
     }
   ]
 }

.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",
+      "command": "inv setup-test -i --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,203 +1,6 @@
-Hi there, thank you for your intrest in contributing!
-Please read the contribution guidelines below, before submitting your first pull request to the InvenTree codebase.
+### Contributing to InvenTree
 
-## Quickstart
+Hi there, thank you for your interest in contributing!
+Please read our contribution guidelines, before submitting your first pull request to the InvenTree codebase.
 
-The following commands will get you quickly configure and run a development server, complete with a demo dataset to work with:
-
-### Bare Metal
-
-```bash
-git clone https://github.com/inventree/InvenTree.git && cd InvenTree
-python3 -m venv env && source env/bin/activate
-pip install invoke && invoke
-pip install invoke && invoke setup-dev --tests
-```
-
-### Docker
-
-```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 up -d
-```
-
-Read the [InvenTree setup documentation](https://docs.inventree.org/en/latest/start/intro/) for a complete installation reference guide.
-
-### Setup Devtools
-
-Run the following command to set up all toolsets for development.
-
-```bash
-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.*
-
-## Branches and Versioning
-
-InvenTree roughly follow the [GitLab flow](https://docs.gitlab.com/ee/topics/gitlab_flow.html) branching style, to allow simple management of multiple tagged releases, short-lived branches, and development on the main branch.
-
-### Version Numbering
-
-InvenTree version numbering follows the [semantic versioning](https://semver.org/) specification.
-
-### Master Branch
-
-The HEAD of the "main" or "master" branch of InvenTree represents the current "latest" state of code development.
-
-- 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).
-
-### Feature Branches
-
-Feature branches should be branched *from* the *master* branch.
-
-- One major feature per branch / pull request
-- Feature pull requests are merged back *into* the master branch
-- Features *may* also be merged into a release candidate branch
-
-### Stable Branch
-
-The HEAD of the "stable" branch represents the latest stable release code.
-
-- Versioned releases are merged into the "stable" branch
-- Bug fix branches are made *from* the "stable" branch
-
-#### 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"
-- When a release candidate branch is merged into *stable*, the release is tagged
-
-#### Bugfix Branches
-
-- If a bug is discovered in a tagged release version of InvenTree, a "bugfix" or "hotfix" branch should be made *from* that tagged release
-- When approved, the branch is merged back *into* stable, with an incremented PATCH number (e.g. 0.4.1 -> 0.4.2)
-- The bugfix *must* also be cherry picked into the *master* branch.
-
-## Environment
-### Target version
-We are currently targeting:
-| Name | Minimum version |
-|---|---|
-| Python | 3.9 |
-| Django | 3.2 |
-
-### Auto creating updates
-The following tools can be used to auto-upgrade syntax that was depreciated in new versions:
-```bash
-pip install pyupgrade
-pip install django-upgrade
-```
-
-To update the codebase run the following script.
-```bash
-pyupgrade `find . -name "*.py"`
-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.
-
-
-## Migration Files
-
-Any required migration files **must** be included in the commit, or the pull-request will be rejected. If you change the underlying database schema, make sure you run `invoke migrate` and commit the migration files before submitting the PR.
-
-*Note: A github action checks for unstaged migration files and will reject the PR if it finds any!*
-
-## Unit Testing
-
-Any new code should be covered by unit tests - a submitted PR may not be accepted if the code coverage for any new features is insufficient, or the overall code coverage is decreased.
-
-The InvenTree code base makes use of [GitHub actions](https://github.com/features/actions) to run a suite of automated tests against the code base every time a new pull request is received. These actions include (but are not limited to):
-
-- Checking Python and Javascript code against standard style guides
-- Running unit test suite
-- Automated building and pushing of docker images
-- Generating translation files
-
-The various github actions can be found in the `./github/workflows` directory
-
-## 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`.
-
-## 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/
-
-## Translations
-
-Any user-facing strings *must* be passed through the translation engine.
-
-- InvenTree code is written in English
-- User translatable strings are provided in English as the primary language
-- Secondary language translations are provided [via Crowdin](https://crowdin.com/project/inventree)
-
-*Note: Translation files are updated via GitHub actions - you do not need to compile translations files before submitting a pull request!*
-
-### Python Code
-
-For strings exposed via Python code, use the following format:
-
-```python
-from django.utils.translation import gettext_lazy as _
-
-user_facing_string = _('This string will be exposed to the translation engine!')
-```
-
-### Templated Strings
-
-HTML and javascript files are passed through the django templating engine. Translatable strings are implemented as follows:
-
-```html
-{% load i18n %}
-
-<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 |
-| Type Labels |  |  |
-|  | breaking | Indicates a major update or change which breaks compatibility |
-|  | 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 |
-|  | help wanted | Assistance required |
-|  | invalid | This issue or PR is considered invalid |
-|  | inactive | Indicates lack of activity |
-|  | question | This is a question |
-|  | roadmap | This is a roadmap feature with no immediate plans for implementation |
-|  | security | Relates to a security issue |
-|  | starter | Good issue for a developer new to the project |
-|  | wontfix | No work will be done against this issue or PR |
-| Feature Labels |  |  |
-|  | API | Relates to the API |
-|  | barcode | Barcode scanning and integration |
-|  | build | Build orders |
-|  | importer | Data importing and processing |
-|  | order | Purchase order and sales orders |
-|  | part | Parts |
-|  | plugin | Plugin ecosystem |
-|  | pricing | Pricing functionality |
-|  | report | Report generation |
-|  | stock | Stock item management |
-|  | user interface | User interface |
-| Ecosystem Labels |  |  |
-|  | demo | Relates to the InvenTree demo server or dataset |
-|  | docker | Docker / docker-compose |
-|  | CI | CI / unit testing ecosystem |
-|  | setup | Relates to the InvenTree setup / installation process |
+Refer to our [contribution guidelines](https://docs.inventree.org/en/latest/develop/contributing/) for more information!

Dockerfile

@@ -9,14 +9,19 @@
 # - 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.11-alpine3.18
+FROM ${base_image} as inventree_base
 
 # Build arguments for this image
+ARG commit_tag=""
 ARG commit_hash=""
 ARG commit_date=""
-ARG commit_tag=""
+
+ARG data_dir="data"
 
 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"
@@ -24,7 +29,7 @@ ENV INVENTREE_DOCKER="true"
 # InvenTree paths
 ENV INVENTREE_HOME="/home/inventree"
 ENV INVENTREE_MNG_DIR="${INVENTREE_HOME}/InvenTree"
-ENV INVENTREE_DATA_DIR="${INVENTREE_HOME}/data"
+ENV INVENTREE_DATA_DIR="${INVENTREE_HOME}/${data_dir}"
 ENV INVENTREE_STATIC_ROOT="${INVENTREE_DATA_DIR}/static"
 ENV INVENTREE_MEDIA_ROOT="${INVENTREE_DATA_DIR}/media"
 ENV INVENTREE_BACKUP_DIR="${INVENTREE_DATA_DIR}/backup"
@@ -43,6 +48,8 @@ ENV INVENTREE_BACKGROUND_WORKERS="4"
 ENV INVENTREE_WEB_ADDR=0.0.0.0
 ENV INVENTREE_WEB_PORT=8000
 
+ENV VIRTUAL_ENV=/usr/local
+
 LABEL org.label-schema.schema-version="1.0" \
       org.label-schema.build-date=${DATE} \
       org.label-schema.vendor="inventree" \
@@ -51,44 +58,60 @@ 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 \
-    # SQLite support
-    sqlite3 \
-    # PostgreSQL support
-    libpq-dev postgresql-client \
-    # MySQL / MariaDB support
-    default-libmysqlclient-dev mariadb-client && \
-    apt-get autoclean && apt-get autoremove
+    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 \
+    # Core database packages
+    postgresql13-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/ash", "./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 uv --no-cache-dir && pip install -r base_requirements.txt -r requirements.txt --no-cache && \
+    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 uv --no-cache-dir && pip install -r base_requirements.txt --no-cache
+
+# 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,7 @@ 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}"]

InvenTree/InvenTree/admin.py

@@ -1,17 +1,61 @@
-"""Admin classes"""
+"""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
 
 
 class InvenTreeResource(ModelResource):
-    """Custom subclass of the ModelResource class provided by django-import-export"
+    """Custom subclass of the ModelResource class provided by django-import-export".
 
     Ensures that exported data are escaped to prevent malicious formula injection.
     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 +75,39 @@ 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

@@ -1,30 +1,130 @@
 """Main JSON interface views."""
 
+import sys
+
 from django.conf import settings
 from django.db import transaction
 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.generics import GenericAPIView
 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 InvenTree.templatetags.inventree_extras import plugins_info
+from part.models import Part
 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 VersionViewSerializer(serializers.Serializer):
+    """Serializer for a single version."""
+
+    class VersionSerializer(serializers.Serializer):
+        """Serializer for server version."""
+
+        server = serializers.CharField()
+        api = serializers.IntegerField()
+        commit_hash = serializers.CharField()
+        commit_date = serializers.CharField()
+        commit_branch = serializers.CharField()
+        python = serializers.CharField()
+        django = serializers.CharField()
+
+    class LinkSerializer(serializers.Serializer):
+        """Serializer for all possible links."""
+
+        doc = serializers.URLField()
+        code = serializers.URLField()
+        credit = serializers.URLField()
+        app = serializers.URLField()
+        bug = serializers.URLField()
+
+    dev = serializers.BooleanField()
+    up_to_date = serializers.BooleanField()
+    version = VersionSerializer()
+    links = LinkSerializer()
+
+
+class VersionView(APIView):
+    """Simple JSON endpoint for InvenTree version information."""
+
+    permission_classes = [permissions.IsAdminUser]
+
+    @extend_schema(responses={200: OpenApiResponse(response=VersionViewSerializer)})
+    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."""
+
+    serializer_class = VersionSerializer
+
+    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.
 
@@ -34,39 +134,96 @@ class InfoView(AjaxView):
     permission_classes = [permissions.AllowAny]
 
     def worker_pending_tasks(self):
-        """Return the current number of outstanding background tasks"""
-
+        """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,
+            'plugins_install_disabled': settings.PLUGINS_INSTALL_DISABLED,
             'active_plugins': plugins_info(),
+            'email_configured': is_email_configured(),
+            'debug_mode': settings.DEBUG,
+            'docker_mode': settings.DOCKER,
+            'default_locale': settings.LANGUAGE_CODE,
+            # Following fields are only available to staff users
+            '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."""
+        from InvenTree.middleware import get_token_from_request
+
+        if token := get_token_from_request(request):
+            # Does the provided token match a valid user?
+            try:
+                token = ApiToken.objects.get(key=token)
+
+                # Check if the token is active and the user is a staff member
+                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:
@@ -81,7 +238,7 @@ class BulkDeleteMixin:
     """
 
     def filter_delete_queryset(self, queryset, request):
-        """Provide custom filtering for the queryset *before* it is deleted"""
+        """Provide custom filtering for the queryset *before* it is deleted."""
         return queryset
 
     def delete(self, request, *args, **kwargs):
@@ -109,24 +266,25 @@ class BulkDeleteMixin:
 
         if not items and not filters:
             raise ValidationError({
-                "non_field_errors": ["List of items or filters must be provided for bulk deletion"],
+                'non_field_errors': [
+                    'List of items or filters must be provided for bulk deletion'
+                ]
             })
 
         if items and type(items) is not list:
             raise ValidationError({
-                "items": ["'items' must be supplied as a list object"]
+                'items': ["'items' must be supplied as a list object"]
             })
 
         if filters and type(filters) is not dict:
             raise ValidationError({
-                "filters": ["'filters' must be supplied as a dict object"]
+                'filters': ["'filters' must be supplied as a dict object"]
             })
 
         # Keep track of how many items we deleted
         n_deleted = 0
 
         with transaction.atomic():
-
             # Start with *all* models and perform basic filtering
             queryset = model.objects.all()
             queryset = self.filter_delete_queryset(queryset, request)
@@ -142,16 +300,12 @@ class BulkDeleteMixin:
             n_deleted = queryset.count()
             queryset.delete()
 
-        return Response(
-            {
-                'success': f"Deleted {n_deleted} items",
-            },
-            status=204
-        )
+        return Response({'success': f'Deleted {n_deleted} items'}, status=204)
 
 
 class ListCreateDestroyAPIView(BulkDeleteMixin, ListCreateAPI):
-    """Custom API endpoint which provides BulkDelete functionality in addition to List and Create"""
+    """Custom API endpoint which provides BulkDelete functionality in addition to List and Create."""
+
     ...
 
 
@@ -183,26 +337,23 @@ 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."""
-        raise NotImplementedError("download_queryset method not implemented!")
+        raise NotImplementedError('download_queryset method not implemented!')
 
 
 class AttachmentMixin:
     """Mixin for creating attachment objects, and ensuring the user information is saved correctly."""
 
-    permission_classes = [
-        permissions.IsAuthenticated,
-        RolePermission,
-    ]
+    permission_classes = [permissions.IsAuthenticated, RolePermission]
 
     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()
@@ -210,8 +361,18 @@ class AttachmentMixin:
         attachment.save()
 
 
-class APISearchView(APIView):
-    """A general-purpose 'search' API endpoint
+class APISearchViewSerializer(serializers.Serializer):
+    """Serializer for the APISearchView."""
+
+    search = serializers.CharField()
+    search_regex = serializers.BooleanField(default=False, required=False)
+    search_whole = serializers.BooleanField(default=False, required=False)
+    limit = serializers.IntegerField(default=1, required=False)
+    offset = serializers.IntegerField(default=0, required=False)
+
+
+class APISearchView(GenericAPIView):
+    """A general-purpose 'search' API endpoint.
 
     Returns hits against a number of different models simultaneously,
     to consolidate multiple API requests into a single query.
@@ -219,13 +380,11 @@ class APISearchView(APIView):
     Is much more efficient and simplifies code!
     """
 
-    permission_classes = [
-        permissions.IsAuthenticated,
-    ]
+    permission_classes = [permissions.IsAuthenticated]
+    serializer_class = APISearchViewSerializer
 
     def get_result_types(self):
-        """Construct a list of search types we can return"""
-
+        """Construct a list of search types we can return."""
         import build.api
         import company.api
         import order.api
@@ -247,8 +406,7 @@ class APISearchView(APIView):
         }
 
     def post(self, request, *args, **kwargs):
-        """Perform search query against available models"""
-
+        """Perform search query against available models."""
         data = request.data
 
         results = {}
@@ -262,10 +420,12 @@ 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:
-
                 params = data[key]
 
                 for k, v in pass_through_params.items():
@@ -292,83 +452,49 @@ class APISearchView(APIView):
                 table = f'{app_label}_{model_name}'
 
                 try:
-                    if users.models.RuleSet.check_table_permission(request.user, table, 'view'):
+                    if users.models.RuleSet.check_table_permission(
+                        request.user, table, 'view'
+                    ):
                         results[key] = view.list(request, *args, **kwargs).data
                     else:
                         results[key] = {
-                            'error': _('User does not have permission to view this model')
+                            'error': _(
+                                'User does not have permission to view this model'
+                            )
                         }
                 except Exception as exc:
-                    results[key] = {
-                        'error': str(exc)
-                    }
+                    results[key] = {'error': str(exc)}
 
         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"""
+    """Generic API endpoint for reading and editing metadata for a model."""
 
     MODEL_REF = 'model'
 
     def get_model_type(self):
-        """Return the model type associated with this API instance"""
+        """Return the model type associated with this API instance."""
         model = self.kwargs.get(self.MODEL_REF, None)
 
         if model is None:
-            raise ValidationError(f"MetadataView called without '{self.MODEL_REF}' parameter")
+            raise ValidationError(
+                f"MetadataView called without '{self.MODEL_REF}' parameter"
+            )
 
         return model
 
     def get_permission_model(self):
-        """Return the 'permission' model associated with this view"""
+        """Return the 'permission' model associated with this view."""
         return self.get_model_type()
 
     def get_queryset(self):
-        """Return the queryset for this endpoint"""
+        """Return the queryset for this endpoint."""
         return self.get_model_type().objects.all()
 
     def get_serializer(self, *args, **kwargs):
-        """Return MetadataSerializer instance"""
+        """Return MetadataSerializer instance."""
+        # Detect if we are currently generating the OpenAPI schema
+        if 'spectacular' in sys.argv:
+            return MetadataSerializer(Part, *args, **kwargs)
         return MetadataSerializer(self.get_model_type(), *args, **kwargs)

InvenTree/InvenTree/api_version.py

@@ -1,11 +1,268 @@
 """InvenTree API version information."""
 
-
 # InvenTree API version
-INVENTREE_API_VERSION = 107
+INVENTREE_API_VERSION = 180
+"""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 = """
+
+v180 - 2024-3-02 : https://github.com/inventree/InvenTree/pull/6463
+    - Tweaks to API documentation to allow automatic documentation generation
+
+v179 - 2024-03-01 : https://github.com/inventree/InvenTree/pull/6605
+    - Adds "subcategories" count to PartCategory serializer
+    - Adds "sublocations" count to StockLocation serializer
+    - Adds "image" field to PartBrief serializer
+    - Adds "image" field to CompanyBrief serializer
+
+v178 - 2024-02-29 : https://github.com/inventree/InvenTree/pull/6604
+    - Adds "external_stock" field to the Part API endpoint
+    - Adds "external_stock" field to the BomItem API endpoint
+    - Adds "external_stock" field to the BuildLine API endpoint
+    - Stock quantites represented in the BuildLine API endpoint are now filtered by Build.source_location
+
+v177 - 2024-02-27 : https://github.com/inventree/InvenTree/pull/6581
+    - Adds "subcategoies" count to PartCategoryTree serializer
+    - Adds "sublocations" count to StockLocationTree serializer
+
+v176 - 2024-02-26 : https://github.com/inventree/InvenTree/pull/6535
+    - Adds the field "plugins_install_disabled" to the Server info API endpoint
+
+v175 - 2024-02-21 : https://github.com/inventree/InvenTree/pull/6538
+    - Adds "parts" count to PartParameterTemplate serializer
+
+v174 - 2024-02-21 : https://github.com/inventree/InvenTree/pull/6536
+    - Expose PartCategory filters to the API documentation
+    - Expose StockLocation filters to the API documentation
+
+v173 - 2024-02-20 : https://github.com/inventree/InvenTree/pull/6483
+    - Adds "merge_items" to the PurchaseOrderLine create API endpoint
+    - Adds "auto_pricing" to the PurchaseOrderLine create/update API endpoint
+
+v172 - 2024-02-20 : https://github.com/inventree/InvenTree/pull/6526
+    - Adds "enabled" field to the PartTestTemplate API endpoint
+    - Adds "enabled" filter to the PartTestTemplate list
+    - Adds "enabled" filter to the StockItemTestResult list
+
+v171 - 2024-02-19 : https://github.com/inventree/InvenTree/pull/6516
+    - Adds "key" as a filterable parameter to PartTestTemplate list endpoint
+
+v170 -> 2024-02-19 : https://github.com/inventree/InvenTree/pull/6514
+    - Adds "has_results" filter to the PartTestTemplate list endpoint
+
+v169 -> 2024-02-14 : https://github.com/inventree/InvenTree/pull/6430
+    - Adds 'key' field to PartTestTemplate API endpoint
+    - Adds annotated 'results' field to PartTestTemplate API endpoint
+    - Adds 'template' field to StockItemTestResult API endpoint
+
+v168 -> 2024-02-14 : https://github.com/inventree/InvenTree/pull/4824
+    - Adds machine CRUD API endpoints
+    - Adds machine settings API endpoints
+    - Adds machine restart API endpoint
+    - Adds machine types/drivers list API endpoints
+    - Adds machine registry status API endpoint
+    - Adds 'required' field to the global Settings API
+    - Discover sub-sub classes of the StatusCode API
+
+v167 -> 2024-02-07: https://github.com/inventree/InvenTree/pull/6440
+    - Fixes for OpenAPI schema generation
+
+v166 -> 2024-02-04 : https://github.com/inventree/InvenTree/pull/6400
+    - Adds package_name to plugin API
+    - Adds mechanism for uninstalling plugins via the API
+
+v165 -> 2024-01-28 : https://github.com/inventree/InvenTree/pull/6040
+    - Adds supplier_part.name, part.creation_user, part.required_for_sales_order
+
+v164 -> 2024-01-24 : https://github.com/inventree/InvenTree/pull/6343
+    - Adds "building" quantity to BuildLine API serializer
+
+v163 -> 2024-01-22 : https://github.com/inventree/InvenTree/pull/6314
+    - Extends API endpoint to expose auth configuration information for signin pages
+
+v162 -> 2024-01-14 : https://github.com/inventree/InvenTree/pull/6230
+    - Adds API endpoints to provide information on background tasks
+
+v161 -> 2024-01-13 : https://github.com/inventree/InvenTree/pull/6222
+    - Adds API endpoint for system error information
+
+v160 -> 2023-12-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 +326,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 +424,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

@@ -1,4 +1,4 @@
-"""AppConfig for inventree app."""
+"""AppConfig for InvenTree app."""
 
 import logging
 from importlib import import_module
@@ -9,17 +9,19 @@ 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")
+logger = logging.getLogger('inventree')
 
 
 class InvenTreeConfig(AppConfig):
     """AppConfig for inventree app."""
+
     name = 'InvenTree'
 
     def ready(self):
@@ -29,25 +31,43 @@ 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.update_site_url()
         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()
+            self.add_user_from_file()
 
     def remove_obsolete_tasks(self):
         """Delete any obsolete scheduled tasks in the database."""
@@ -62,36 +82,81 @@ 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...')
 
-        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,
-        # which will be processed as soon as the worker comes online
-        InvenTree.tasks.offload_task(
-            InvenTree.tasks.heartbeat,
-            force_async=True,
-        )
+            if ref_name in existing_tasks.keys():
+                # This task already exists - update the details if required
+                existing_task = existing_tasks[ref_name]
 
-        logger.info(f"Started {len(tasks)} scheduled background tasks...")
+                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))
+
+        self.add_heartbeat()
+
+        logger.info('Started %s scheduled background tasks...', len(tasks))
+
+    def add_heartbeat(self):
+        """Ensure there is at least one background task in the queue."""
+        import django_q.models
+
+        try:
+            if django_q.models.OrmQ.objects.count() == 0:
+                InvenTree.tasks.offload_task(
+                    InvenTree.tasks.heartbeat, force_async=True
+                )
+        except Exception:
+            pass
 
     def collect_tasks(self):
         """Collect all background tasks."""
-
         for app_name, app in apps.app_configs.items():
             if app_name == 'InvenTree':
                 continue
@@ -100,7 +165,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,22 +187,29 @@ 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
 
-        except (ExchangeBackend.DoesNotExist):
-            logger.info("Exchange backend not found - updating")
+                # 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')
             update = True
 
         except Exception:
@@ -147,8 +219,50 @@ 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 update_site_url(self):
+        """Update the site URL setting.
+
+        - If a fixed SITE_URL is specified (via configuration), it should override the INVENTREE_BASE_URL setting
+        - If multi-site support is enabled, update the site URL for the current site
+        """
+        import common.models
+
+        if not InvenTree.ready.canAppAccessDatabase():
+            return
+
+        if InvenTree.ready.isImportingData() or InvenTree.ready.isRunningMigrations():
+            return
+
+        if settings.SITE_URL:
+            try:
+                if (
+                    common.models.InvenTreeSetting.get_setting('INVENTREE_BASE_URL')
+                    != settings.SITE_URL
+                ):
+                    common.models.InvenTreeSetting.set_setting(
+                        'INVENTREE_BASE_URL', settings.SITE_URL
+                    )
+                    logger.info('Updated INVENTREE_SITE_URL to %s', settings.SITE_URL)
+            except Exception:
+                pass
+
+            # If multi-site support is enabled, update the site URL for the current site
+            try:
+                from django.contrib.sites.models import Site
+
+                site = Site.objects.get_current()
+                site.domain = settings.SITE_URL
+                site.save()
+
+                logger.info('Updated current site URL to %s', settings.SITE_URL)
+
+            except Exception:
+                pass
 
     def add_user_on_startup(self):
         """Add a user on startup."""
@@ -160,6 +274,9 @@ class InvenTreeConfig(AppConfig):
         add_user = get_setting('INVENTREE_ADMIN_USER', 'admin_user')
         add_email = get_setting('INVENTREE_ADMIN_EMAIL', 'admin_email')
         add_password = get_setting('INVENTREE_ADMIN_PASSWORD', 'admin_password')
+        add_password_file = get_setting(
+            'INVENTREE_ADMIN_PASSWORD_FILE', 'admin_password_file', None
+        )
 
         # check if all values are present
         set_variables = 0
@@ -175,27 +292,77 @@ 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')
             settings.USER_ADDED = True
+
+            # if a password file is present, do not warn - will be handled later
+            if add_password_file:
+                return
+            logger.warning(
+                'Not all required settings for adding a user on startup are present:\nINVENTREE_ADMIN_USER, INVENTREE_ADMIN_EMAIL, INVENTREE_ADMIN_PASSWORD'
+            )
             return
 
         # good to go -> create user
+        self._create_admin_user(add_user, add_email, add_password)
+
+        # do not try again
+        settings.USER_ADDED = True
+
+    def _create_admin_user(self, add_user, add_email, add_password):
         user = get_user_model()
         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)}')
+                    new_user = user.objects.create_superuser(
+                        add_user, add_email, add_password
+                    )
+                    logger.info('User %s was created!', str(new_user))
+        except IntegrityError:
+            logger.warning('The user "%s" could not be created', add_user)
+
+    def add_user_from_file(self):
+        """Add the superuser from a file."""
+        # stop if checks were already created
+        if hasattr(settings, 'USER_ADDED_FILE') and settings.USER_ADDED_FILE:
+            return
+
+        # get values
+        add_password_file = get_setting(
+            'INVENTREE_ADMIN_PASSWORD_FILE', 'admin_password_file', None
+        )
+
+        # no variable set -> do not try anything
+        if not add_password_file:
+            settings.USER_ADDED_FILE = True
+            return
+
+        # check if file exists
+        add_password_file = Path(str(add_password_file))
+        if not add_password_file.exists():
+            logger.warning('The file "%s" does not exist', add_password_file)
+            settings.USER_ADDED_FILE = True
+            return
+
+        # good to go -> create user
+        self._create_admin_user(
+            get_setting('INVENTREE_ADMIN_USER', 'admin_user', 'admin'),
+            get_setting('INVENTREE_ADMIN_EMAIL', 'admin_email', ''),
+            add_password_file.read_text(encoding='utf-8'),
+        )
 
         # do not try again
-        settings.USER_ADDED = True
+        settings.USER_ADDED_FILE = True
 
     def collect_notification_methods(self):
         """Collect all notification methods."""
         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/backends.py

@@ -0,0 +1,85 @@
+"""Custom backend implementations."""
+
+import datetime
+import logging
+import time
+
+from django.db.utils import IntegrityError, OperationalError, ProgrammingError
+
+from maintenance_mode.backends import AbstractStateBackend
+
+import common.models
+
+logger = logging.getLogger('inventree')
+
+
+class InvenTreeMaintenanceModeBackend(AbstractStateBackend):
+    """Custom backend for managing state of maintenance mode.
+
+    Stores a timestamp in the database to determine when maintenance mode will elapse.
+    """
+
+    SETTING_KEY = '_MAINTENANCE_MODE'
+
+    def get_value(self) -> bool:
+        """Get the current state of the maintenance mode.
+
+        Returns:
+            bool: True if maintenance mode is active, False otherwise.
+        """
+        try:
+            setting = common.models.InvenTreeSetting.objects.get(key=self.SETTING_KEY)
+            value = str(setting.value).strip()
+        except common.models.InvenTreeSetting.DoesNotExist:
+            # Database is accessible, but setting is not available - assume False
+            return False
+        except (IntegrityError, OperationalError, ProgrammingError):
+            # Database is inaccessible - assume we are not in maintenance mode
+            logger.debug('Failed to read maintenance mode state - assuming True')
+            return True
+
+        # Extract timestamp from string
+        try:
+            # If the timestamp is in the past, we are now *out* of maintenance mode
+            timestamp = datetime.datetime.fromisoformat(value)
+            return timestamp > datetime.datetime.now()
+        except ValueError:
+            # If the value is not a valid timestamp, assume maintenance mode is not active
+            return False
+
+    def set_value(self, value: bool, retries: int = 5, minutes: int = 5):
+        """Set the state of the maintenance mode.
+
+        Instead of simply writing "true" or "false" to the setting,
+        we write a timestamp to the setting, which is used to determine
+        when maintenance mode will elapse.
+        This ensures that we will always *exit* maintenance mode after a certain time period.
+        """
+        logger.debug('Setting maintenance mode state: %s', value)
+
+        if value:
+            # Save as isoformat
+            timestamp = datetime.datetime.now() + datetime.timedelta(minutes=minutes)
+            timestamp = timestamp.isoformat()
+        else:
+            # Blank timestamp means maintenance mode is not active
+            timestamp = ''
+
+        while retries > 0:
+            try:
+                common.models.InvenTreeSetting.set_setting(self.SETTING_KEY, timestamp)
+
+                # Read the value back to confirm
+                if self.get_value() == value:
+                    break
+            except (IntegrityError, OperationalError, ProgrammingError):
+                # In the database is locked, then
+                logger.debug(
+                    'Failed to set maintenance mode state (%s retries left)', retries
+                )
+                time.sleep(0.1)
+
+            retries -= 1
+
+            if retries == 0:
+                logger.warning('Failed to set maintenance mode state')

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,29 +17,21 @@ 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)
 
         here = os.path.abspath(os.path.dirname(__file__))
 
-        output_dir = os.path.join(
-            here,
-            '..',
-            '..',
-            'js_tmp',
-        )
+        output_dir = os.path.join(here, '..', '..', 'js_tmp')
 
         output_dir = os.path.abspath(output_dir)
 
         if not os.path.exists(output_dir):
             os.mkdir(output_dir)
 
-        output_file = os.path.join(
-            output_dir,
-            filename,
-        )
+        output_file = os.path.join(output_dir, filename)
 
         with open(output_file, 'wb') as output:
             output.write(response.content)
@@ -48,12 +40,7 @@ class RenderJavascriptFiles(InvenTreeTestCase):  # pragma: no cover
         """Download files in directory."""
         here = os.path.abspath(os.path.dirname(__file__))
 
-        js_template_dir = os.path.join(
-            here,
-            '..',
-            'templates',
-            'js',
-        )
+        js_template_dir = os.path.join(here, '..', 'templates', 'js')
 
         directory = os.path.join(js_template_dir, subdir)
 
@@ -76,9 +63,9 @@ class RenderJavascriptFiles(InvenTreeTestCase):  # pragma: no cover
         """Look for all javascript files."""
         n = 0
 
-        print("Rendering javascript files...")
+        print('Rendering javascript files...')
 
         n += self.download_files('translated', '/js/i18n')
         n += self.download_files('dynamic', '/js/dynamic')
 
-        print(f"Rendered {n} javascript files.")
+        print(f'Rendered {n} javascript files.')

InvenTree/InvenTree/config.py

@@ -7,8 +7,12 @@ import os
 import random
 import shutil
 import string
+import warnings
 from pathlib import Path
 
+from django.core.files.base import ContentFile
+from django.core.files.storage import Storage
+
 logger = logging.getLogger('inventree')
 CONFIG_DATA = None
 CONFIG_LOOKUPS = {}
@@ -23,7 +27,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,18 +48,22 @@ 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 {}
 
 
 def is_true(x):
-    """Shortcut function to determine if a value "looks" like a boolean"""
+    """Shortcut function to determine if a value "looks" like a boolean."""
     return str(x).strip().lower() in ['1', 'y', 'yes', 't', 'true', 'on']
 
 
@@ -65,11 +72,15 @@ def get_base_dir() -> Path:
     return Path(__file__).parent.parent.resolve()
 
 
-def ensure_dir(path: Path) -> None:
+def ensure_dir(path: Path, storage=None) -> None:
     """Ensure that a directory exists.
 
     If it does not exist, create it.
     """
+    if storage and isinstance(storage, Storage):
+        if not storage.exists(str(path)):
+            storage.save(str(path / '.empty'), ContentFile(''))
+        return
 
     if not path.exists():
         path.mkdir(parents=True, exist_ok=True)
@@ -91,12 +102,14 @@ def get_config_file(create=True) -> Path:
         cfg_filename = base_dir.joinpath('config.yaml').resolve()
 
     if not cfg_filename.exists() and create:
-        print("InvenTree configuration file 'config.yaml' not found - creating default file")
+        print(
+            "InvenTree configuration file 'config.yaml' not found - creating default file"
+        )
         ensure_dir(cfg_filename.parent)
 
-        cfg_template = base_dir.joinpath("config_template.yaml")
+        cfg_template = base_dir.joinpath('config_template.yaml')
         shutil.copyfile(cfg_template, cfg_filename)
-        print(f"Created config file {cfg_filename}")
+        print(f'Created config file {cfg_filename}')
 
     return cfg_filename
 
@@ -128,6 +141,42 @@ 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,42 +188,26 @@ 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."""
         key = env_var or config_key
-        CONFIG_LOOKUPS[key] = {'env_var': env_var, 'config_key': config_key, 'source': source, 'accessed': datetime.datetime.now()}
+        CONFIG_LOOKUPS[key] = {
+            'env_var': env_var,
+            'config_key': config_key,
+            'source': source,
+            'accessed': datetime.datetime.now(),
+        }
 
     # First, try to load from the environment variables
     if env_var is not 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:
@@ -184,7 +217,6 @@ def get_setting(env_var=None, config_key=None, default_value=None, typecast=None
 
         # Hack to allow 'path traversal' in configuration file
         for key in config_key.strip().split('.'):
-
             if type(cfg_data) is not dict or key not in cfg_data:
                 result = None
                 break
@@ -193,21 +225,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)"""
-
+    """Return the absolute path for the 'media' directory (where uploaded files are stored)."""
     md = get_setting('INVENTREE_MEDIA_ROOT', 'media_root')
 
     if not md:
@@ -222,8 +254,7 @@ 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)"""
-
+    """Return the absolute path for the 'static' directory (where static files are stored)."""
     sd = get_setting('INVENTREE_STATIC_ROOT', 'static_root')
 
     if not sd:
@@ -238,8 +269,7 @@ def get_static_dir(create=True):
 
 
 def get_backup_dir(create=True):
-    """Return the absolute path for the backup directory"""
-
+    """Return the absolute path for the backup directory."""
     bd = get_setting('INVENTREE_BACKUP_DIR', 'backup_dir')
 
     if not bd:
@@ -258,7 +288,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')
 
@@ -271,16 +300,25 @@ def get_plugin_file():
         plugin_file = Path(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.warning(
+            'Plugin configuration file does not exist - creating default 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
-        plugin_file.write_text("# InvenTree Plugins (uses PIP framework to install)\n\n")
+        plugin_file.write_text(
+            '# InvenTree Plugins (uses PIP framework to install)\n\n'
+        )
 
     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,10 +329,9 @@ 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
+        logger.info('SECRET_KEY loaded by INVENTREE_SECRET_KEY')  # pragma: no cover
         return secret_key
 
     # Look for secret key file
@@ -302,10 +339,10 @@ def get_secret_key():
         secret_key_file = Path(secret_key_file).resolve()
     else:
         # Default location for secret key file
-        secret_key_file = get_base_dir().joinpath("secret_key.txt").resolve()
+        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,14 +350,16 @@ 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()
 
     return key_data
 
 
-def get_custom_file(env_ref: str, conf_ref: str, log_ref: str, lookup_media: bool = False):
+def get_custom_file(
+    env_ref: str, conf_ref: str, log_ref: str, lookup_media: bool = False
+):
     """Returns the checked path to a custom file.
 
     Set lookup_media to True to also search in the media folder.
@@ -336,12 +375,79 @@ 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,13 +27,11 @@ 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
-    health_keys = [
-        'django_q_running',
-    ]
+    health_keys = ['django_q_running']
 
     all_healthy = True
 
@@ -56,17 +53,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):
@@ -83,11 +70,9 @@ def user_roles(request):
     """
     user = request.user
 
-    roles = {
-    }
-
-    for role in RuleSet.RULESET_MODELS.keys():
+    roles = {}
 
+    for role in RuleSet.get_ruleset_models().keys():
         permissions = {}
 
         for perm in ['view', 'add', 'change', 'delete']:

InvenTree/InvenTree/conversion.py

@@ -0,0 +1,246 @@
+"""Helper functions for converting between units."""
+
+import logging
+import re
+
+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(autoconvert_offset_to_baseunit=True)
+
+    # Aliases for temperature units
+    reg.define('@alias degC = celsius = Celsius')
+    reg.define('@alias degF = fahrenheit = Fahrenheit')
+    reg.define('@alias degK = kelvin = Kelvin')
+
+    # 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 from_engineering_notation(value):
+    """Convert a provided value to 'natural' representation from 'engineering' notation.
+
+    Ref: https://en.wikipedia.org/wiki/Engineering_notation
+
+    In "engineering notation", the unit (or SI prefix) is often combined with the value,
+    and replaces the decimal point.
+
+    Examples:
+    - 1K2 -> 1.2K
+    - 3n05 -> 3.05n
+    - 8R6 -> 8.6R
+
+    And, we should also take into account any provided trailing strings:
+
+    - 1K2 ohm -> 1.2K ohm
+    - 10n005F -> 10.005nF
+    """
+    value = str(value).strip()
+
+    pattern = f'(\d+)([a-zA-Z]+)(\d+)(.*)'
+
+    if match := re.match(pattern, value):
+        left, prefix, right, suffix = match.groups()
+        return f'{left}.{right}{prefix}{suffix}'
+
+    return value
+
+
+def convert_value(value, unit):
+    """Attempt to convert a value to a specified unit.
+
+    Arguments:
+        value: The value to convert
+        unit: The target unit to convert to
+
+    Returns:
+        The converted value (ideally a pint.Quantity value)
+
+    Raises:
+        Exception if the value cannot be converted to the specified unit
+    """
+    ureg = get_unit_registry()
+
+    # Convert the provided value to a pint.Quantity object
+    value = ureg.Quantity(value)
+
+    # Convert to the specified unit
+    if unit:
+        if is_dimensionless(value):
+            magnitude = value.to_base_units().magnitude
+            value = ureg.Quantity(magnitude, unit)
+        else:
+            value = value.to(unit)
+
+    return value
+
+
+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
+    """
+    ureg = get_unit_registry()
+
+    # Check that the provided unit is available in the unit registry
+    if unit:
+        try:
+            valid = unit in ureg
+        except Exception as exc:
+            valid = False
+
+        if not valid:
+            raise ValidationError(_(f'Invalid unit provided ({unit})'))
+
+    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'))
+
+    # Construct a list of values to "attempt" to convert
+    attempts = [value]
+
+    # Attempt to convert from engineering notation
+    eng = from_engineering_notation(value)
+    attempts.append(eng)
+
+    # Append the unit, if provided
+    # These are the "final" attempts to convert the value, and *must* appear after previous attempts
+    if unit:
+        attempts.append(f'{value}{unit}')
+        attempts.append(f'{eng}{unit}')
+
+    value = None
+
+    # Run through the available "attempts", take the first successful result
+    for attempt in attempts:
+        try:
+            value = convert_value(attempt, unit)
+            break
+        except Exception as exc:
+            value = None
+            pass
+
+    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

@@ -18,37 +18,58 @@ 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:
+        try:
+            data = '\n'.join(traceback.format_exception(kind, info, data))
+        except AttributeError:
+            data = 'No traceback information available'
+
     # 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 +82,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):
@@ -91,7 +106,7 @@ def exception_handler(exc, context):
             # If in DEBUG mode, provide error information in the response
             error_detail = str(exc)
         else:
-            error_detail = _("Error details can be found in the admin panel")
+            error_detail = _('Error details can be found in the admin panel')
 
         response_data = {
             'error': type(exc).__name__,

InvenTree/InvenTree/exchange.py

@@ -1,74 +1,116 @@
-"""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"
+    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,21 @@ 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."""
@@ -36,20 +52,29 @@ class InvenTreeURLField(models.URLField):
     default_validators = [AllowedURLValidator()]
 
     def __init__(self, **kwargs):
-        """Initialization method for InvenTreeURLField"""
-
+        """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 +88,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', [])
@@ -81,11 +98,8 @@ class InvenTreeModelMoneyField(ModelMoneyField):
 
         # If no validators are provided, add some "standard" ones
         if len(validators) == 0:
-
             if not allow_negative:
-                validators.append(
-                    MinMoneyValidator(0),
-                )
+                validators.append(MinMoneyValidator(0))
 
         kwargs['validators'] = validators
 
@@ -111,13 +125,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)
 
 
@@ -131,11 +142,7 @@ class DatePickerFormField(forms.DateField):
         required = kwargs.get('required', False)
         initial = kwargs.get('initial', None)
 
-        widget = forms.DateInput(
-            attrs={
-                'type': 'date',
-            }
-        )
+        widget = forms.DateInput(attrs={'type': 'date'})
 
         forms.DateField.__init__(
             self,
@@ -143,13 +150,12 @@ class DatePickerFormField(forms.DateField):
             initial=initial,
             help_text=help_text,
             widget=widget,
-            label=label
+            label=label,
         )
 
 
 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,20 +192,19 @@ class RoundingDecimalField(models.DecimalField):
 
     def formfield(self, **kwargs):
         """Return a Field instance for this field."""
-
         kwargs['form_class'] = RoundingDecimalFormField
 
         return super().formfield(**kwargs)
 
 
 class InvenTreeNotesField(models.TextField):
-    """Custom implementation of a 'notes' field"""
+    """Custom implementation of a 'notes' field."""
 
     # Maximum character limit for the various 'notes' fields
     NOTES_MAX_LENGTH = 50000
 
     def __init__(self, **kwargs):
-        """Configure default initial values for this field"""
+        """Configure default initial values for this field."""
         kwargs['max_length'] = self.NOTES_MAX_LENGTH
         kwargs['verbose_name'] = _('Notes')
         kwargs['blank'] = True

InvenTree/InvenTree/filters.py

@@ -1,22 +1,43 @@
 """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):
-    """Custom search filter which allows adjusting of search terms dynamically"""
+    """Custom search filter which allows adjusting of search terms dynamically."""
 
     def get_search_fields(self, view, request):
         """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 +57,9 @@ 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 = []
 
@@ -53,7 +75,7 @@ class InvenTreeSearchFilter(filters.SearchFilter):
 
                 if whole:
                     # Wrap the search term to enable word-boundary matching
-                    term = r"\y" + term + r"\y"
+                    term = r'\y' + term + r'\y'
 
                 terms.append(term)
 
@@ -91,7 +113,6 @@ class InvenTreeOrderingFilter(filters.OrderingFilter):
             ordering = []
 
             for field in ordering_initial:
-
                 reverse = field.startswith('-')
 
                 if reverse:
@@ -145,7 +166,4 @@ SEARCH_ORDER_FILTER_ALIAS = [
     InvenTreeOrderingFilter,
 ]
 
-ORDER_FILTER = [
-    rest_filters.DjangoFilterBackend,
-    filters.OrderingFilter,
-]
+ORDER_FILTER = [rest_filters.DjangoFilterBackend, filters.OrderingFilter]

InvenTree/InvenTree/format.py

@@ -1,17 +1,22 @@
-"""Custom string formatting functions and helpers"""
+"""Custom string formatting functions and helpers."""
 
 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 = {}
@@ -31,16 +36,13 @@ def parse_format_string(fmt_string: str) -> dict:
         else:
             seen_groups.add(name)
 
-        info[group[1]] = {
-            'format': group[1],
-            'prefix': group[0],
-        }
+        info[group[1]] = {'format': group[1], 'prefix': group[0]}
 
     return info
 
 
 def construct_format_regex(fmt_string: str) -> str:
-    r"""Construct a regular expression based on a provided format string
+    r"""Construct a regular expression based on a provided format string.
 
     This function turns a python format string into a regular expression,
     which can be used for two purposes:
@@ -62,8 +64,7 @@ def construct_format_regex(fmt_string: str) -> str:
     Raises:
         ValueError: Format string is invalid
     """
-
-    pattern = "^"
+    pattern = '^'
 
     for group in string.Formatter().parse(fmt_string):
         prefix = group[0]  # Prefix (literal text appearing before this group)
@@ -71,9 +72,23 @@ def construct_format_regex(fmt_string: str) -> str:
         format = group[2]  # Format specifier e.g :04d
 
         rep = [
-            '+', '-', '.',
-            '{', '}', '(', ')',
-            '^', '$', '~', '!', '@', ':', ';', '|', '\'', '"',
+            '+',
+            '-',
+            '.',
+            '{',
+            '}',
+            '(',
+            ')',
+            '^',
+            '$',
+            '~',
+            '!',
+            '@',
+            ':',
+            ';',
+            '|',
+            "'",
+            '"',
         ]
 
         # Escape any special regex characters
@@ -90,8 +105,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:
@@ -101,9 +115,9 @@ def construct_format_regex(fmt_string: str) -> str:
             # TODO: Introspect required width
             w = '+'
 
-            pattern += f"(?P<{name}>{chr}{w})"
+            pattern += f'(?P<{name}>{chr}{w})'
 
-    pattern += "$"
+    pattern += '$'
 
     return pattern
 
@@ -121,7 +135,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)
@@ -130,7 +143,7 @@ def validate_string(value: str, fmt_string: str) -> str:
 
 
 def extract_named_group(name: str, value: str, fmt_string: str) -> str:
-    """Extract a named value from the provided string, given the provided format string
+    """Extract a named value from the provided string, given the provided format string.
 
     Args:
         name: Name of group to extract e.g. 'ref'
@@ -145,7 +158,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():
@@ -159,8 +171,49 @@ def extract_named_group(name: str, value: str, fmt_string: str) -> str:
     result = re.match(pattern, value)
 
     if not result:
-        raise ValueError(_("Provided value does not match required pattern: ") + fmt_string)
+        raise ValueError(
+            _('Provided value does not match required pattern: ') + fmt_string
+        )
 
     # 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,
+    include_symbol: bool = True,
+) -> str:
+    """Format money object according to the currently set local.
+
+    Args:
+        money (Money): The money object to format
+        decimal_places (int): Number of decimal places to use
+        format (str): 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)
+
+    result = pattern.apply(
+        money.amount,
+        locale,
+        currency=money.currency.code if include_symbol else '',
+        currency_digits=decimal_places is None,
+        decimal_quantization=decimal_places is not None,
+    )
+
+    return result

InvenTree/InvenTree/forms.py

@@ -6,22 +6,24 @@ from urllib.parse import urlencode
 from django import forms
 from django.conf import settings
 from django.contrib.auth.models import Group, User
-from django.contrib.sites.models import Site
 from django.http import HttpResponseRedirect
 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
-from crispy_forms.bootstrap import (AppendedText, PrependedAppendedText,
-                                    PrependedText)
+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.helpers_model
+import InvenTree.sso
 from common.models import InvenTreeSetting
 from InvenTree.exceptions import log_error
 
@@ -65,10 +67,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(
@@ -77,31 +79,19 @@ class HelperForm(forms.ModelForm):
                             field,
                             prepended_text=prefix,
                             appended_text=suffix,
-                            placeholder=placeholder
+                            placeholder=placeholder,
                         )
                     )
                 )
 
             elif prefix:
                 layouts.append(
-                    Field(
-                        PrependedText(
-                            field,
-                            prefix,
-                            placeholder=placeholder
-                        )
-                    )
+                    Field(PrependedText(field, prefix, placeholder=placeholder))
                 )
 
             elif suffix:
                 layouts.append(
-                    Field(
-                        AppendedText(
-                            field,
-                            suffix,
-                            placeholder=placeholder
-                        )
-                    )
+                    Field(AppendedText(field, suffix, placeholder=placeholder))
                 )
 
             else:
@@ -117,10 +107,7 @@ class EditUserForm(HelperForm):
         """Metaclass options."""
 
         model = User
-        fields = [
-            'first_name',
-            'last_name',
-        ]
+        fields = ['first_name', 'last_name']
 
 
 class SetPasswordForm(HelperForm):
@@ -130,11 +117,7 @@ class SetPasswordForm(HelperForm):
         """Metaclass options."""
 
         model = User
-        fields = [
-            'enter_password',
-            'confirm_password',
-            'old_password',
-        ]
+        fields = ['enter_password', 'confirm_password', 'old_password']
 
     enter_password = forms.CharField(
         max_length=100,
@@ -143,7 +126,7 @@ class SetPasswordForm(HelperForm):
         initial='',
         widget=forms.PasswordInput(attrs={'autocomplete': 'off'}),
         label=_('Enter password'),
-        help_text=_('Enter new password')
+        help_text=_('Enter new password'),
     )
 
     confirm_password = forms.CharField(
@@ -153,17 +136,37 @@ class SetPasswordForm(HelperForm):
         initial='',
         widget=forms.PasswordInput(attrs={'autocomplete': 'off'}),
         label=_('Confirm password'),
-        help_text=_('Confirm new password')
+        help_text=_('Confirm new password'),
     )
 
     old_password = forms.CharField(
-        label=_("Old password"),
+        label=_('Old password'),
         strip=False,
-        widget=forms.PasswordInput(attrs={'autocomplete': 'current-password', 'autofocus': True}),
+        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."""
 
@@ -175,70 +178,93 @@ class CustomSignupForm(SignupForm):
 
         # check for two mail fields
         if InvenTreeSetting.get_setting('LOGIN_SIGNUP_MAIL_TWICE'):
-            self.fields["email2"] = forms.EmailField(
-                label=_("Email (again)"),
+            self.fields['email2'] = forms.EmailField(
+                label=_('Email (again)'),
                 widget=forms.TextInput(
                     attrs={
-                        "type": "email",
-                        "placeholder": _("Email address confirmation"),
+                        'type': 'email',
+                        'placeholder': _('Email address confirmation'),
                     }
                 ),
             )
 
         # check for two password fields
         if not InvenTreeSetting.get_setting('LOGIN_SIGNUP_PWD_TWICE'):
-            self.fields.pop("password2")
+            self.fields.pop('password2')
 
         # reorder fields
-        set_form_field_order(self, ["username", "email", "email2", "password1", "password2", ])
+        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
         if InvenTreeSetting.get_setting('LOGIN_SIGNUP_MAIL_TWICE'):
-            email = cleaned_data.get("email")
-            email2 = cleaned_data.get("email2")
+            email = cleaned_data.get('email')
+            email2 = cleaned_data.get('email2')
             if (email and email2) and email != email2:
-                self.add_error("email2", _("You must type the same email each time."))
+                self.add_error('email2', _('You must type the same email each time.'))
 
         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
 
     def clean_email(self, email):
         """Check if the mail is valid to the pattern in LOGIN_SIGNUP_MAIL_RESTRICTION (if enabled in settings)."""
-        mail_restriction = InvenTreeSetting.get_setting('LOGIN_SIGNUP_MAIL_RESTRICTION', None)
+        mail_restriction = InvenTreeSetting.get_setting(
+            'LOGIN_SIGNUP_MAIL_RESTRICTION', None
+        )
         if not mail_restriction:
             return super().clean_email(email)
 
         split_email = email.split('@')
         if len(split_email) != 2:
-            logger.error(f'The user {email} has an invalid email address')
-            raise forms.ValidationError(_('The provided primary email address is not valid.'))
+            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(',')
         for option in mailoptions:
             if not option.startswith('@'):
                 log_error('LOGIN_SIGNUP_MAIL_RESTRICTION is not configured correctly')
-                raise forms.ValidationError(_('The provided primary email address is not valid.'))
+                raise forms.ValidationError(
+                    _('The provided primary email address is not valid.')
+                )
             else:
                 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 +279,10 @@ 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
 
@@ -263,11 +292,14 @@ class CustomUrlMixin:
 
     def get_email_confirmation_url(self, request, emailconfirmation):
         """Custom email confirmation (activation) url."""
-        url = reverse("account_confirm_email", args=[emailconfirmation.key])
-        return Site.objects.get_current().domain + url
+        url = reverse('account_confirm_email', args=[emailconfirmation.key])
+
+        return InvenTree.helpers_model.construct_absolute_url(url)
 
 
-class CustomAccountAdapter(CustomUrlMixin, RegistratonMixin, OTPAdapter, DefaultAccountAdapter):
+class CustomAccountAdapter(
+    CustomUrlMixin, RegistratonMixin, OTPAdapter, DefaultAccountAdapter
+):
     """Override of adapter to use dynamic settings."""
 
     def send_mail(self, template_prefix, email, context):
@@ -276,7 +308,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,8 +317,18 @@ 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
 
-class CustomSocialAccountAdapter(CustomUrlMixin, RegistratonMixin, DefaultSocialAccountAdapter):
+        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."""
 
     def is_auto_signup_allowed(self, request, sociallogin):
@@ -313,9 +355,41 @@ class CustomSocialAccountAdapter(CustomUrlMixin, RegistratonMixin, DefaultSocial
             if request.GET:
                 redirect_url += '?' + urlencode(request.GET)
 
-            raise ImmediateHttpResponse(
-                response=HttpResponseRedirect(redirect_url)
-            )
+            raise ImmediateHttpResponse(response=HttpResponseRedirect(redirect_url))
 
         # 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,54 +8,91 @@ import os
 import os.path
 import re
 from decimal import Decimal, InvalidOperation
-from pathlib import Path
+from typing import TypeVar
 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 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
+
+    reference = str(reference).strip()
+
+    # Ignore empty string
+    if len(reference) == 0:
+        return 0
+
+    # Look at the start of the string - can it be "integerized"?
+    result = re.match(r'^(\d+)', reference)
+
+    if result and len(result.groups()) == 1:
+        ref = result.groups()[0]
+        try:
+            ref_int = int(ref)
+        except Exception:
+            ref_int = 0
+    else:
+        # Look at the "end" of the string
+        result = re.search(r'(\d+)$', reference)
+
+        if result and len(result.groups()) == 1:
+            ref = result.groups()[0]
+            try:
+                ref_int = int(ref)
+            except Exception:
+                ref_int = 0
+
+    # Ensure that the returned values are within the range that can be stored in an IntegerField
+    # Note: This will result in large values being "clipped"
+    if clip is not None:
+        if ref_int > clip:
+            ref_int = clip
+        elif ref_int < -clip:
+            ref_int = -clip
+
+    if not allow_negative and ref_int < 0:
+        ref_int = abs(ref_int)
+
+    return ref_int
 
 
-def generateTestKey(test_name):
+def generateTestKey(test_name: str) -> str:
     """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.
 
     Tests must be named such that they will have unique keys.
     """
+    if test_name is None:
+        test_name = ''
+
     key = test_name.strip().lower()
-    key = key.replace(" ", "")
+    key = key.replace(' ', '')
 
     # Remove any characters that cannot be used to represent a variable
-    key = re.sub(r'[^a-zA-Z0-9]', '', key)
+    key = re.sub(r'[^a-zA-Z0-9_]', '', key)
+
+    # If the key starts with a digit, prefix with an underscore
+    if key[0].isdigit():
+        key = '_' + key
 
     return key
 
@@ -67,13 +104,12 @@ 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
     if len(pathstring) > max_chars:
         n = int(max_chars / 2 - 2)
-        pathstring = pathstring[:n] + "..." + pathstring[-n:]
+        pathstring = pathstring[:n] + '...' + pathstring[-n:]
 
     return pathstring
 
@@ -88,130 +124,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:
@@ -223,20 +135,18 @@ def TestIfImage(img):
 
 def getBlankImage():
     """Return the qualified path for the 'blank image' placeholder."""
-    return getStaticUrl("img/blank_image.png")
+    return getStaticUrl('img/blank_image.png')
 
 
 def getBlankThumbnail():
     """Return the qualified path for the 'blank image' thumbnail placeholder."""
-    return getStaticUrl("img/blank_image.thumbnail.png")
+    return getStaticUrl('img/blank_image.thumbnail.png')
 
 
 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:
-
         static_storage = StaticFilesStorage()
 
         if static_storage.exists(settings.CUSTOM_LOGO):
@@ -248,30 +158,26 @@ 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 f'file://{storage.path(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 f'file://{path}'
+    return getStaticUrl('img/inventree.png')
 
 
-def getSplashScren(custom=True):
-    """Return the InvenTree splash screen, or a custom splash if available"""
-
+def getSplashScreen(custom=True):
+    """Return the InvenTree splash screen, or a custom splash if available."""
     static_storage = StaticFilesStorage()
 
     if custom and settings.CUSTOM_SPLASH:
-
         if static_storage.exists(settings.CUSTOM_SPLASH):
             return static_storage.url(settings.CUSTOM_SPLASH)
 
     # No custom splash screen
-    return static_storage.url("img/inventree_splash.jpg")
+    return static_storage.url('img/inventree_splash.jpg')
 
 
 def TestIfImageURL(url):
@@ -280,10 +186,15 @@ def TestIfImageURL(url):
     Simply tests the extension against a set of allowed values
     """
     return os.path.splitext(os.path.basename(url))[-1].lower() in [
-        '.jpg', '.jpeg', '.j2k',
-        '.png', '.bmp',
-        '.tif', '.tiff',
-        '.webp', '.gif',
+        '.jpg',
+        '.jpeg',
+        '.j2k',
+        '.png',
+        '.bmp',
+        '.tif',
+        '.tiff',
+        '.webp',
+        '.gif',
     ]
 
 
@@ -298,13 +209,12 @@ def str2bool(text, test=True):
         True if the text looks like the selected boolean value
     """
     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 ['1', 'y', 'yes', 't', 'true', 'ok', 'on']
+    return str(text).lower() in ['0', 'n', 'no', 'none', 'f', 'false', 'off']
 
 
 def str2int(text, default=None):
-    """Convert a string to int if possible
+    """Convert a string to int if possible.
 
     Args:
         text: Int like string
@@ -325,8 +235,7 @@ def is_bool(text):
         return True
     elif str2bool(text, False):
         return True
-    else:
-        return False
+    return False
 
 
 def isNull(text):
@@ -338,7 +247,15 @@ def isNull(text):
     Returns:
         True if the text looks like a null value
     """
-    return str(text).strip().lower() in ['top', 'null', 'none', 'empty', 'false', '-1', '']
+    return str(text).strip().lower() in [
+        'top',
+        'null',
+        'none',
+        'empty',
+        'false',
+        '-1',
+        '',
+    ]
 
 
 def normalize(d):
@@ -370,7 +287,7 @@ def increment(value):
         # Provide a default value if provided with a null input
         return '1'
 
-    pattern = r"(.*?)(\d+)?$"
+    pattern = r'(.*?)(\d+)?$'
 
     result = re.search(pattern, value)
 
@@ -429,7 +346,7 @@ def decimal2string(d):
     if '.' not in s:
         return s
 
-    return s.rstrip("0").rstrip(".")
+    return s.rstrip('0').rstrip('.')
 
 
 def decimal2money(d, currency=None):
@@ -470,15 +387,13 @@ def MakeBarcode(cls_name, object_pk: int, object_data=None, **kwargs):
     """Generate a string for a barcode. Adds some global InvenTree parameters.
 
     Args:
-        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)
+        cls_name: string describing the object type e.g. 'StockItem'
+        object_pk (int): ID (Primary Key) of the object in the database
+        object_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,22 +412,17 @@ 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():
     """Return a list of allowable file formats for exporting data."""
-    return [
-        'csv',
-        'tsv',
-        'xls',
-        'xlsx',
-        'json',
-        'yaml',
-    ]
+    return ['csv', 'tsv', 'xls', 'xlsx', 'json', 'yaml']
 
 
-def DownloadFile(data, filename, content_type='application/text', inline=False) -> StreamingHttpResponse:
+def DownloadFile(
+    data, filename, content_type='application/text', inline=False
+) -> StreamingHttpResponse:
     """Create a dynamic file for the user to download.
 
     Args:
@@ -527,20 +437,22 @@ 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
 
-    disposition = "inline" if inline else "attachment"
-
-    response['Content-Disposition'] = f'{disposition}; filename={filename}'
+    if inline:
+        disposition = f'inline; filename={filename}'
+    else:
+        disposition = f'attachment; filename={filename}'
 
+    response['Content-Disposition'] = disposition
     return response
 
 
@@ -555,7 +467,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 +492,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,14 +503,13 @@ 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)
 
     try:
         expected_quantity = int(expected_quantity)
     except ValueError:
-        raise ValidationError([_("Invalid quantity provided")])
+        raise ValidationError([_('Invalid quantity provided')])
 
     if input_string:
         input_string = str(input_string).strip()
@@ -607,7 +517,7 @@ def extract_serial_numbers(input_string, expected_quantity: int, starting_value=
         input_string = ''
 
     if len(input_string) == 0:
-        raise ValidationError([_("Empty serial number string")])
+        raise ValidationError([_('Empty serial number string')])
 
     next_value = increment_serial_number(starting_value)
 
@@ -617,27 +527,26 @@ def extract_serial_numbers(input_string, expected_quantity: int, starting_value=
         next_value = increment_serial_number(next_value)
 
     # Split input string by whitespace or comma (,) characters
-    groups = re.split(r"[\s,]+", input_string)
+    groups = re.split(r'[\s,]+', input_string)
 
     serials = []
     errors = []
 
     def add_error(error: str):
-        """Helper function for adding an error message"""
+        """Helper function for adding an error message."""
         if error not in errors:
             errors.append(error)
 
     def add_serial(serial):
-        """Helper function to check for duplicated values"""
-
+        """Helper function to check for duplicated values."""
         serial = serial.strip()
 
-        # Ignore blank / emtpy serials
+        # Ignore blank / empty serials
         if len(serial) == 0:
             return
 
         if serial in serials:
-            add_error(_("Duplicate serial") + f": {serial}")
+            add_error(_('Duplicate serial') + f': {serial}')
         else:
             serials.append(serial)
 
@@ -652,7 +561,6 @@ def extract_serial_numbers(input_string, expected_quantity: int, starting_value=
             return serials
 
     for group in groups:
-
         # Calculate the "remaining" quantity of serial numbers
         remaining = expected_quantity - len(serials)
 
@@ -670,7 +578,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 +607,21 @@ 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)))
-                elif len(group_items) > 0 and group_items[0] == a and group_items[-1] == b:
+                    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,20 +639,24 @@ 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]
 
             # Keep incrementing up to the specified quantity
-            while value is not None and value not in sequence_items and counter < sequence_count:
+            while (
+                value is not None
+                and value not in sequence_items
+                and counter < sequence_count
+            ):
                 sequence_items.append(value)
                 value = increment_serial_number(value)
                 counter += 1
@@ -745,7 +665,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
@@ -755,10 +675,14 @@ def extract_serial_numbers(input_string, expected_quantity: int, starting_value=
         raise ValidationError(errors)
 
     if len(serials) == 0:
-        raise ValidationError([_("No serial numbers found")])
+        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
 
@@ -795,9 +719,7 @@ def validateFilterString(value, model=None):
         pair = group.split('=')
 
         if len(pair) != 2:
-            raise ValidationError(
-                "Invalid group: {g}".format(g=group)
-            )
+            raise ValidationError(f'Invalid group: {group}')
 
         k, v = pair
 
@@ -805,9 +727,7 @@ def validateFilterString(value, model=None):
         v = v.strip()
 
         if not k or not v:
-            raise ValidationError(
-                "Invalid group: {g}".format(g=group)
-            )
+            raise ValidationError(f'Invalid group: {group}')
 
         results[k] = v
 
@@ -816,82 +736,11 @@ def validateFilterString(value, model=None):
         try:
             model.objects.filter(**results)
         except FieldError as e:
-            raise ValidationError(
-                str(e),
-            )
+            raise ValidationError(str(e))
 
     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
@@ -925,7 +774,11 @@ def clean_decimal(number):
         # Number cannot be converted to Decimal (eg. a string containing letters)
         return Decimal(0)
 
-    return clean_number.quantize(Decimal(1)) if clean_number == clean_number.to_integral() else clean_number.normalize()
+    return (
+        clean_number.quantize(Decimal(1))
+        if clean_number == clean_number.to_integral()
+        else clean_number.normalize()
+    )
 
 
 def strip_html_tags(value: str, raise_error=True, field_name=None):
@@ -933,57 +786,45 @@ 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,
-        tags=[],
-        attributes=[],
-    )
+    cleaned = clean(value, strip=True, tags=[], attributes=[])
 
     # Add escaped characters back in
-    replacements = {
-        '&gt;': '>',
-        '&lt;': '<',
-        '&amp;': '&',
-    }
+    replacements = {'&gt;': '>', '&lt;': '<', '&amp;': '&'}
 
     for o, r in replacements.items():
         cleaned = cleaned.replace(o, r)
 
     # If the length changed, it means that HTML tags were removed!
     if len(cleaned) != len(value) and raise_error:
-
         field = field_name or 'non_field_errors'
 
-        raise ValidationError({
-            field: [_("Remove HTML tags from this value")]
-        })
+        raise ValidationError({field: [_('Remove HTML tags from this value')]})
 
     return cleaned
 
 
-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"""
-
+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:
         # Remove ASCII control characters
         # Note that we do not sub out 0x0A (\n) here, it is done separately below
-        cleaned = regex.sub(u'[\x00-\x09]+', '', cleaned)
-        cleaned = regex.sub(u'[\x0b-\x1F\x7F]+', '', cleaned)
+        cleaned = regex.sub('[\x00-\x09]+', '', cleaned)
+        cleaned = regex.sub('[\x0b-\x1f\x7f]+', '', cleaned)
 
     if remove_newline:
-        cleaned = regex.sub(u'[\x0a]+', '', cleaned)
+        cleaned = regex.sub('[\x0a]+', '', cleaned)
 
     if remove_unicode:
         # Remove Unicode control characters
         if remove_newline:
-            cleaned = regex.sub(u'[^\P{C}]+', '', cleaned)
+            cleaned = regex.sub('[^\P{C}]+', '', cleaned)
         else:
             # Use 'negative-lookahead' to exclude newline character
-            cleaned = regex.sub(u'(?![\x0A])[^\P{C}]+', '', cleaned)
+            cleaned = regex.sub('(?![\x0a])[^\P{C}]+', '', cleaned)
 
     return cleaned
 
@@ -996,7 +837,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)
 
@@ -1005,7 +845,14 @@ def hash_barcode(barcode_data):
     return str(hash.hexdigest())
 
 
-def get_objectreference(obj, type_ref: str = 'content_type', object_ref: str = 'object_id'):
+def hash_file(filename: str):
+    """Return the MD5 hash of a file."""
+    return hashlib.md5(open(filename, 'rb').read()).hexdigest()
+
+
+def get_objectreference(
+    obj, type_ref: str = 'content_type', object_ref: str = 'object_id'
+):
     """Lookup method for the GenericForeignKey fields.
 
     Attributes:
@@ -1022,7 +869,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)
 
@@ -1044,17 +890,17 @@ def get_objectreference(obj, type_ref: str = 'content_type', object_ref: str = '
     ret = {}
     if url_fnc:
         ret['link'] = url_fnc()
-    return {
-        'name': str(item),
-        'model': str(model_cls._meta.verbose_name),
-        **ret
-    }
+    return {'name': str(item), 'model': str(model_cls._meta.verbose_name), **ret}
 
 
-def inheritors(cls):
+Inheritors_T = TypeVar('Inheritors_T')
+
+
+def inheritors(cls: type[Inheritors_T]) -> set[type[Inheritors_T]]:
     """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 +910,13 @@ def inheritors(cls):
     return subcls
 
 
-class InvenTreeTestCase(ExchangeRateMixin, UserMixin, TestCase):
-    """Testcase with user setup buildin."""
-    pass
+def is_ajax(request):
+    """Check if the current request is an AJAX request."""
+    return request.headers.get('x-requested-with') == 'XMLHttpRequest'
 
 
-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 pui_url(subpath: str) -> str:
+    """Return the URL for a PUI subpath."""
+    if not subpath.startswith('/'):
+        subpath = '/' + subpath
+    return f'/{settings.FRONTEND_URL_BASE}{subpath}'

InvenTree/InvenTree/helpers_mixin.py

@@ -0,0 +1,106 @@
+"""Provides helper mixins that are used throughout the InvenTree project."""
+
+import inspect
+from pathlib import Path
+
+from django.conf import settings
+
+from plugin import registry as plg_registry
+
+
+class ClassValidationMixin:
+    """Mixin to validate class attributes and overrides.
+
+    Class attributes:
+        required_attributes: List of class attributes that need to be defined
+        required_overrides: List of functions that need override, a nested list mean either one of them needs an override
+
+    Example:
+    ```py
+    class Parent(ClassValidationMixin):
+        NAME: str
+        def test(self):
+            pass
+
+        required_attributes = ["NAME"]
+        required_overrides = [test]
+
+    class MyClass(Parent):
+        pass
+
+    myClass = MyClass()
+    myClass.validate() # raises NotImplementedError
+    ```
+    """
+
+    required_attributes = []
+    required_overrides = []
+
+    @classmethod
+    def validate(cls):
+        """Validate the class against the required attributes/overrides."""
+
+        def attribute_missing(key):
+            """Check if attribute is missing."""
+            return not hasattr(cls, key) or getattr(cls, key) == ''
+
+        def override_missing(base_implementation):
+            """Check if override is missing."""
+            if isinstance(base_implementation, list):
+                return all(override_missing(x) for x in base_implementation)
+
+            return base_implementation == getattr(
+                cls, base_implementation.__name__, None
+            )
+
+        missing_attributes = list(filter(attribute_missing, cls.required_attributes))
+        missing_overrides = list(filter(override_missing, cls.required_overrides))
+
+        errors = []
+
+        if len(missing_attributes) > 0:
+            errors.append(
+                f"did not provide the following attributes: {', '.join(missing_attributes)}"
+            )
+        if len(missing_overrides) > 0:
+            missing_overrides_list = []
+            for base_implementation in missing_overrides:
+                if isinstance(base_implementation, list):
+                    missing_overrides_list.append(
+                        'one of '
+                        + ' or '.join(attr.__name__ for attr in base_implementation)
+                    )
+                else:
+                    missing_overrides_list.append(base_implementation.__name__)
+            errors.append(
+                f"did not override the required attributes: {', '.join(missing_overrides_list)}"
+            )
+
+        if len(errors) > 0:
+            raise NotImplementedError(f"'{cls}' " + ' and '.join(errors))
+
+
+class ClassProviderMixin:
+    """Mixin to get metadata about a class itself, e.g. the plugin that provided that class."""
+
+    @classmethod
+    def get_provider_file(cls):
+        """File that contains the Class definition."""
+        return inspect.getfile(cls)
+
+    @classmethod
+    def get_provider_plugin(cls):
+        """Plugin that contains the Class definition, otherwise None."""
+        for plg in plg_registry.plugins.values():
+            if plg.package_path == cls.__module__:
+                return plg
+
+    @classmethod
+    def get_is_builtin(cls):
+        """Is this Class build in the Inventree source code?"""
+        try:
+            Path(cls.get_provider_file()).relative_to(settings.BASE_DIR)
+            return True
+        except ValueError:
+            # Path(...).relative_to throws an ValueError if its not relative to the InvenTree source base dir
+            return False

InvenTree/InvenTree/helpers_model.py

@@ -0,0 +1,364 @@
+"""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 get_base_url(request=None):
+    """Return the base URL for the InvenTree server.
+
+    The base URL is determined in the following order of decreasing priority:
+
+    1. If a request object is provided, use the request URL
+    2. Multi-site is enabled, and the current site has a valid URL
+    3. If settings.SITE_URL is set (e.g. in the Django settings), use that
+    4. If the InvenTree setting INVENTREE_BASE_URL is set, use that
+    """
+    # Check if a request is provided
+    if request:
+        return request.build_absolute_uri('/')
+
+    # Check if multi-site is enabled
+    try:
+        from django.contrib.sites.models import Site
+
+        return Site.objects.get_current().domain
+    except (ImportError, RuntimeError):
+        pass
+
+    # Check if a global site URL is provided
+    if site_url := getattr(settings, 'SITE_URL', None):
+        return site_url
+
+    # Check if a global InvenTree setting is provided
+    try:
+        if site_url := common.models.InvenTreeSetting.get_setting(
+            'INVENTREE_BASE_URL', create=False, cache=False
+        ):
+            return site_url
+    except (ProgrammingError, OperationalError):
+        pass
+
+    # No base URL available
+    return ''
+
+
+def construct_absolute_url(*arg, base_url=None, request=None):
+    """Construct (or attempt to construct) an absolute URL from a relative URL.
+
+    Args:
+        *arg: The relative URL to construct
+        base_url: The base URL to use for the construction (if not provided, will attempt to determine from settings)
+        request: The request object to use for the construction (optional)
+    """
+    relative_url = '/'.join(arg)
+
+    if not base_url:
+        base_url = get_base_url(request=request)
+
+    return urljoin(base_url, relative_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(
+            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,
+    include_symbol=True,
+):
+    """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.
+        include_symbol: If True, include the currency symbol in the output
+    """
+    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, include_symbol=include_symbol
+    )
+
+
+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.
+    """
+    import InvenTree.ready
+
+    if InvenTree.ready.isImportingData() or InvenTree.ready.isRunningMigrations():
+        return
+
+    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/locales.py

@@ -0,0 +1,48 @@
+"""Support translation locales for InvenTree.
+
+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 following files with the new locale code:
+
+- /src/frontend/.linguirc file
+- /src/frontend/src/context/LanguageContext.tsx
+"""
+
+from django.utils.translation import gettext_lazy as _
+
+LOCALES = [
+    ('bg', _('Bulgarian')),
+    ('cs', _('Czech')),
+    ('da', _('Danish')),
+    ('de', _('German')),
+    ('el', _('Greek')),
+    ('en', _('English')),
+    ('es', _('Spanish')),
+    ('es-mx', _('Spanish (Mexican)')),
+    ('fa', _('Farsi / Persian')),
+    ('fi', _('Finnish')),
+    ('fr', _('French')),
+    ('he', _('Hebrew')),
+    ('hi', _('Hindi')),
+    ('hu', _('Hungarian')),
+    ('it', _('Italian')),
+    ('ja', _('Japanese')),
+    ('ko', _('Korean')),
+    ('nl', _('Dutch')),
+    ('no', _('Norwegian')),
+    ('pl', _('Polish')),
+    ('pt', _('Portuguese')),
+    ('pt-br', _('Portuguese (Brazilian)')),
+    ('ru', _('Russian')),
+    ('sk', _('Slovak')),
+    ('sl', _('Slovenian')),
+    ('sr', _('Serbian')),
+    ('sv', _('Swedish')),
+    ('th', _('Thai')),
+    ('tr', _('Turkish')),
+    ('vi', _('Vietnamese')),
+    ('zh-hans', _('Chinese (Simplified)')),
+    ('zh-hant', _('Chinese (Traditional)')),
+]

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.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.generics import GenericAPIView
+from rest_framework.response import Response
+
+import InvenTree.version
+
+
+def send_simple_login_email(user, link):
+    """Send an email with the login link to this user."""
+    site_name = InvenTree.version.inventreeInstanceName()
+
+    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(GenericAPIView):
+    """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/check_migrations.py

@@ -0,0 +1,19 @@
+"""Check if there are any pending database migrations, and run them."""
+
+import logging
+
+from django.core.management.base import BaseCommand
+
+from InvenTree.tasks import check_for_migrations
+
+logger = logging.getLogger('inventree')
+
+
+class Command(BaseCommand):
+    """Check if there are any pending database migrations, and run them."""
+
+    def handle(self, *args, **kwargs):
+        """Check for any pending database migrations."""
+        logger.info('Checking for pending database migrations')
+        check_for_migrations(force=True, reload_registry=False)
+        logger.info('Database migrations complete')

InvenTree/InvenTree/management/commands/clean_settings.py

@@ -12,7 +12,7 @@ class Command(BaseCommand):
 
     def handle(self, *args, **kwargs):
         """Cleanup old (undefined) settings in the database."""
-        logger.info("Collecting settings")
+        logger.info('Collecting settings')
         from common.models import InvenTreeSetting, InvenTreeUserSetting
 
         # general settings
@@ -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")
+        logger.info('checked all settings')

InvenTree/InvenTree/management/commands/prerender.py

@@ -12,9 +12,7 @@ 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
         locale = locale.lower()
         locale = locale.replace('_', '-')
@@ -23,8 +21,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):
@@ -51,15 +49,18 @@ class Command(BaseCommand):
         # render!
         request = HttpRequest()
         ctx = {}
-        processors = tuple(import_string(path) for path in settings.STATFILES_I18_PROCESSORS)
+        processors = tuple(
+            import_string(path) for path in settings.STATFILES_I18_PROCESSORS
+        )
         for processor in processors:
             ctx.update(processor(request))
 
-        for file in os.listdir(SOURCE_DIR, ):
+        for file in os.listdir(SOURCE_DIR):
             path = os.path.join(SOURCE_DIR, file)
             if os.path.exists(path) and os.path.isfile(path):
-                print(f"render {file}")
                 render_file(file, SOURCE_DIR, TARGET_DIR, locales, ctx)
             else:
-                raise NotImplementedError('Using multi-level directories is not implemented at this point')  # TODO multilevel dir if needed
-        print(f"rendered all files in {SOURCE_DIR}")
+                raise NotImplementedError(
+                    'Using multi-level directories is not implemented at this point'
+                )  # TODO multilevel dir if needed
+        print(f'Rendered all files in {SOURCE_DIR}')

InvenTree/InvenTree/management/commands/rebuild_models.py

@@ -3,55 +3,73 @@
 - This is crucial after importing any fixtures, etc
 """
 
+import logging
+
 from django.core.management.base import BaseCommand
 
+from maintenance_mode.core import maintenance_mode_on, set_maintenance_mode
+
+logger = logging.getLogger('inventree')
+
 
 class Command(BaseCommand):
     """Rebuild all database models which leverage the MPTT structure."""
 
     def handle(self, *args, **kwargs):
         """Rebuild all database models which leverage the MPTT structure."""
+        with maintenance_mode_on():
+            self.rebuild_models()
+
+        set_maintenance_mode(False)
+
+    def rebuild_models(self):
+        """Rebuild all MPTT models in the database."""
         # Part model
         try:
-            print("Rebuilding Part objects")
+            logger.info('Rebuilding Part objects')
 
             from part.models import Part
+
             Part.objects.rebuild()
         except Exception:
-            print("Error rebuilding Part objects")
+            logger.info('Error rebuilding Part objects')
 
         # Part category
         try:
-            print("Rebuilding PartCategory objects")
+            logger.info('Rebuilding PartCategory objects')
 
             from part.models import PartCategory
+
             PartCategory.objects.rebuild()
         except Exception:
-            print("Error rebuilding PartCategory objects")
+            logger.info('Error rebuilding PartCategory objects')
 
         # StockItem model
         try:
-            print("Rebuilding StockItem objects")
+            logger.info('Rebuilding StockItem objects')
 
             from stock.models import StockItem
+
             StockItem.objects.rebuild()
         except Exception:
-            print("Error rebuilding StockItem objects")
+            logger.info('Error rebuilding StockItem objects')
 
         # StockLocation model
         try:
-            print("Rebuilding StockLocation objects")
+            logger.info('Rebuilding StockLocation objects')
 
             from stock.models import StockLocation
+
             StockLocation.objects.rebuild()
         except Exception:
-            print("Error rebuilding StockLocation objects")
+            logger.info('Error rebuilding StockLocation objects')
 
         # Build model
         try:
-            print("Rebuilding Build objects")
+            logger.info('Rebuilding Build objects')
 
             from build.models import Build
+
             Build.objects.rebuild()
         except Exception:
-            print("Error rebuilding Build objects")
+            logger.info('Error rebuilding Build objects')

InvenTree/InvenTree/management/commands/rebuild_thumbnails.py

@@ -4,6 +4,7 @@
 """
 
 import logging
+import os
 
 from django.core.management.base import BaseCommand
 from django.db.utils import OperationalError, ProgrammingError
@@ -26,31 +27,43 @@ class Command(BaseCommand):
 
         img = model.image
 
-        logger.info(f"Generating thumbnail image for '{img}'")
+        # Check for image paths
+        img_paths = []
+
+        for x in [model.image, model.image.thumbnail, model.image.preview]:
+            if x and x.path:
+                img_paths.append(x.path)
+
+        if len(img_paths) > 0:
+            if all((os.path.exists(path) for path in img_paths)):
+                # All images exist - skip further work
+                return
+
+        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."""
-        logger.info("Rebuilding Part thumbnails")
+        logger.info('Rebuilding Part thumbnails')
 
         for part in Part.objects.exclude(image=None):
             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")
+        logger.info('Rebuilding Company thumbnails')
 
         for company in Company.objects.exclude(image=None):
             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/remove_mfa.py

@@ -18,7 +18,12 @@ class Command(BaseCommand):
         if not mail:
             raise KeyError('A mail is required')
         user = get_user_model()
-        mfa_user = [*set(user.objects.filter(email=mail) | user.objects.filter(emailaddress__email=mail))]
+        mfa_user = [
+            *set(
+                user.objects.filter(email=mail)
+                | user.objects.filter(emailaddress__email=mail)
+            )
+        ]
 
         if len(mfa_user) == 0:
             print('No user with this mail associated')

InvenTree/InvenTree/management/commands/runmigrations.py

@@ -0,0 +1,19 @@
+"""Check if there are any pending database migrations, and run them."""
+
+import logging
+
+from django.core.management.base import BaseCommand
+
+from InvenTree.tasks import check_for_migrations
+
+logger = logging.getLogger('inventree')
+
+
+class Command(BaseCommand):
+    """Check if there are any pending database migrations, and run them."""
+
+    def handle(self, *args, **kwargs):
+        """Check for any pending database migrations."""
+        logger.info('Checking for pending database migrations')
+        check_for_migrations(force=True, reload_registry=False)
+        logger.info('Database migrations complete')

InvenTree/InvenTree/management/commands/wait_for_db.py

@@ -12,13 +12,12 @@ class Command(BaseCommand):
 
     def handle(self, *args, **kwargs):
         """Wait till the database is ready."""
-        self.stdout.write("Waiting for database...")
+        self.stdout.write('Waiting for database...')
 
         connected = False
 
         while not connected:
-
-            time.sleep(5)
+            time.sleep(2)
 
             try:
                 connection.ensure_connection()
@@ -26,12 +25,12 @@ class Command(BaseCommand):
                 connected = True
 
             except OperationalError as e:
-                self.stdout.write(f"Could not connect to database: {e}")
+                self.stdout.write(f'Could not connect to database: {e}')
             except ImproperlyConfigured as e:
-                self.stdout.write(f"Improperly configured: {e}")
+                self.stdout.write(f'Improperly configured: {e}')
             else:
                 if not connection.is_usable():
-                    self.stdout.write("Database configuration is not usable")
+                    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

@@ -7,9 +7,11 @@ from rest_framework.fields import empty
 from rest_framework.metadata import SimpleMetadata
 from rest_framework.utils import model_meta
 
+import common.models
 import InvenTree.permissions
 import users.models
 from InvenTree.helpers import str2bool
+from InvenTree.serializers import DependentField
 
 logger = logging.getLogger('inventree')
 
@@ -28,7 +30,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 +38,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)
         """
@@ -44,8 +46,9 @@ class InvenTreeMetadata(SimpleMetadata):
         context = {}
 
         if str2bool(request.query_params.get('context', False)):
-
-            if hasattr(self, 'serializer') and hasattr(self.serializer, 'get_context_data'):
+            if hasattr(self, 'serializer') and hasattr(
+                self.serializer, 'get_context_data'
+            ):
                 context = self.serializer.get_context_data()
 
             metadata['context'] = context
@@ -67,7 +70,7 @@ class InvenTreeMetadata(SimpleMetadata):
 
             metadata['model'] = tbl_label
 
-            table = f"{app_label}_{tbl_label}"
+            table = f'{app_label}_{tbl_label}'
 
             actions = metadata.get('actions', None)
 
@@ -84,9 +87,12 @@ 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():
-
                 result = check(user, table, permission)
 
                 if method in actions and not result:
@@ -118,10 +124,7 @@ class InvenTreeMetadata(SimpleMetadata):
         model_class = None
 
         # Attributes to copy extra attributes from the model to the field (if they don't exist)
-        extra_attributes = [
-            'help_text',
-            'max_length',
-        ]
+        extra_attributes = ['help_text', 'max_length']
 
         try:
             model_class = serializer.Meta.model
@@ -137,11 +140,8 @@ class InvenTreeMetadata(SimpleMetadata):
 
             # Iterate through simple fields
             for name, field in model_fields.fields.items():
-
                 if name in serializer_info.keys():
-
                     if field.has_default():
-
                         default = field.default
 
                         if callable(default):
@@ -157,13 +157,11 @@ class InvenTreeMetadata(SimpleMetadata):
 
                     for attr in extra_attributes:
                         if attr not in serializer_info[name]:
-
                             if hasattr(field, attr):
                                 serializer_info[name][attr] = getattr(field, attr)
 
             # Iterate through relations
             for name, relation in model_fields.relations.items():
-
                 if name not in serializer_info.keys():
                     # Skip relation not defined in serializer
                     continue
@@ -174,11 +172,17 @@ class InvenTreeMetadata(SimpleMetadata):
 
                 # Extract and provide the "limit_choices_to" filters
                 # This is used to automatically filter AJAX requests
-                serializer_info[name]['filters'] = relation.model_field.get_limit_choices_to()
+                serializer_info[name]['filters'] = (
+                    relation.model_field.get_limit_choices_to()
+                )
 
                 for attr in extra_attributes:
-                    if attr not in serializer_info[name] and hasattr(relation.model_field, attr):
-                        serializer_info[name][attr] = getattr(relation.model_field, attr)
+                    if attr not in serializer_info[name] and hasattr(
+                        relation.model_field, attr
+                    ):
+                        serializer_info[name][attr] = getattr(
+                            relation.model_field, attr
+                        )
 
                 if name in model_default_values:
                     serializer_info[name]['default'] = model_default_values[name]
@@ -205,7 +209,10 @@ class InvenTreeMetadata(SimpleMetadata):
                         pk = kwargs[field]
                         break
 
-                if pk is not None:
+                if issubclass(model_class, common.models.BaseInvenTreeSetting):
+                    instance = model_class.get_setting_object(**kwargs, create=False)
+
+                elif pk is not None:
                     try:
                         instance = model_class.objects.get(pk=pk)
                     except (ValueError, model_class.DoesNotExist):
@@ -215,11 +222,9 @@ class InvenTreeMetadata(SimpleMetadata):
             """If there is an instance associated with this API View, introspect that instance to find any specific API info."""
 
             if hasattr(instance, 'api_instance_filters'):
-
                 instance_filters = instance.api_instance_filters()
 
                 for field_name, field_filters in instance_filters.items():
-
                     if field_name not in serializer_info.keys():
                         # The field might be missing, but is added later on
                         # This function seems to get called multiple times?
@@ -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)
 
@@ -247,17 +256,20 @@ class InvenTreeMetadata(SimpleMetadata):
 
         # Force non-nullable fields to read as "required"
         # (even if there is a default value!)
-        if not field.allow_null and not (hasattr(field, 'allow_blank') and field.allow_blank):
+        if not field.allow_null and not (
+            hasattr(field, 'allow_blank') and field.allow_blank
+        ):
             field_info['required'] = True
 
         # Introspect writable related fields
         if field_info['type'] == 'field' and not field_info['read_only']:
-
             # If the field is a PrimaryKeyRelatedField, we can extract the model from the queryset
             if isinstance(field, serializers.PrimaryKeyRelatedField):
                 model = field.queryset.model
             else:
-                logger.debug("Could not extract model for:", field_info.get('label'), '->', field)
+                logger.debug(
+                    'Could not extract model for:', field_info.get('label'), '->', field
+                )
                 model = None
 
             if model:
@@ -271,4 +283,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

@@ -7,17 +7,32 @@ from django.conf import settings
 from django.contrib.auth.middleware import PersistentRemoteUserMiddleware
 from django.http import HttpResponse
 from django.shortcuts import redirect
-from django.urls import Resolver404, include, re_path, resolve, reverse_lazy
+from django.urls import Resolver404, include, path, resolve, reverse_lazy
 
-from allauth_2fa.middleware import (AllauthTwoFactorMiddleware,
-                                    BaseRequire2FAMiddleware)
+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")
+logger = logging.getLogger('inventree')
+
+
+def get_token_from_request(request):
+    """Extract token information from a request object."""
+    auth_keys = ['Authorization', 'authorization']
+    token_keys = ['token', 'bearer']
+
+    for k in auth_keys:
+        if auth_header := request.headers.get(k, None):
+            auth_header = auth_header.strip().lower().split()
+
+            if len(auth_header) > 1:
+                if auth_header[0].strip().lower().replace(':', '') in token_keys:
+                    token = auth_header[1]
+                    return token
+
+    return None
 
 
 class AuthRequiredMiddleware(object):
@@ -27,6 +42,22 @@ class AuthRequiredMiddleware(object):
         """Save response object."""
         self.get_response = get_response
 
+    def check_token(self, request) -> bool:
+        """Check if the user is authenticated via token."""
+        if token := get_token_from_request(request):
+            # Does the provided token match a valid user?
+            try:
+                token = ApiToken.objects.get(key=token)
+
+                if token.active and token.user:
+                    # Provide the user information to the request
+                    request.user = token.user
+                    return True
+            except ApiToken.DoesNotExist:
+                logger.warning('Access denied for unknown token %s', token)
+
+        return False
+
     def __call__(self, request):
         """Check if user needs to be authenticated and is.
 
@@ -65,22 +96,15 @@ class AuthRequiredMiddleware(object):
             elif request.path_info.startswith('/accounts/'):
                 authorized = True
 
-            elif 'Authorization' in request.headers.keys() or 'authorization' in request.headers.keys():
-                auth = request.headers.get('Authorization', request.headers.get('authorization')).strip()
+            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
 
-                if auth.lower().startswith('token') and len(auth.split()) == 2:
-                    token_key = auth.split()[1]
-
-                    # Does the provided token match a valid user?
-                    try:
-                        token = Token.objects.get(key=token_key)
-
-                        # Provide the user information to the request
-                        request.user = token.user
-                        authorized = True
-
-                    except Token.DoesNotExist:
-                        logger.warning(f"Access denied for unknown token {token_key}")
+            elif self.check_token(request):
+                authorized = True
 
             # No authorization was found for the request
             if not authorized:
@@ -95,34 +119,34 @@ class AuthRequiredMiddleware(object):
                 ]
 
                 # Do not redirect requests to any of these paths
-                paths_ignore = [
-                    '/api/',
-                    '/js/',
-                    '/media/',
-                    '/static/',
-                ]
+                paths_ignore = ['/api/', '/js/', '/media/', '/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 redirect(
+                        f'{reverse_lazy("account_login")}?next={request.path}'
+                    )
+                # Return a 401 (Unauthorized) response code for this request
+                return HttpResponse('Unauthorized', status=401)
 
         response = self.get_response(request)
 
         return response
 
 
-url_matcher = re_path('', include(frontendpatterns))
+url_matcher = path('', include(frontendpatterns))
 
 
 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')
@@ -133,6 +157,7 @@ class Check2FAMiddleware(BaseRequire2FAMiddleware):
 
 class CustomAllauthTwoFactorMiddleware(AllauthTwoFactorMiddleware):
     """This function ensures only frontend code triggers the MFA auth cycle."""
+
     def process_request(self, request):
         """Check if requested url is forntend and enforce MFA check."""
         try:
@@ -144,6 +169,7 @@ class CustomAllauthTwoFactorMiddleware(AllauthTwoFactorMiddleware):
 
 class InvenTreeRemoteUserMiddleware(PersistentRemoteUserMiddleware):
     """Middleware to check if HTTP-header based auth is enabled and to set it up."""
+
     header = settings.REMOTE_LOGIN_HEADER
 
     def process_request(self, request):
@@ -158,11 +184,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,7 +9,7 @@ from InvenTree.fields import InvenTreeNotesField
 from InvenTree.helpers import remove_non_printable_characters, strip_html_tags
 
 
-class CleanMixin():
+class CleanMixin:
     """Model mixin class which cleans inputs using the Mozilla bleach tools."""
 
     # Define a list of field names which will *not* be cleaned
@@ -21,13 +21,17 @@ class CleanMixin():
         serializer.is_valid(raise_exception=True)
         self.perform_create(serializer)
         headers = self.get_success_headers(serializer.data)
-        return Response(serializer.data, status=status.HTTP_201_CREATED, headers=headers)
+        return Response(
+            serializer.data, status=status.HTTP_201_CREATED, headers=headers
+        )
 
     def update(self, request, *args, **kwargs):
         """Override to clean data before processing it."""
         partial = kwargs.pop('partial', False)
         instance = self.get_object()
-        serializer = self.get_serializer(instance, data=self.clean_data(request.data), partial=partial)
+        serializer = self.get_serializer(
+            instance, data=self.clean_data(request.data), partial=partial
+        )
         serializer.is_valid(raise_exception=True)
         self.perform_update(serializer)
 
@@ -49,7 +53,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
@@ -61,9 +64,7 @@ class CleanMixin():
                 field = model._meta.get_field(field)
 
                 # The following field types allow newline characters
-                allow_newline = [
-                    InvenTreeNotesField,
-                ]
+                allow_newline = [InvenTreeNotesField]
 
                 for field_type in allow_newline:
                     if issubclass(type(field), field_type):
@@ -75,7 +76,9 @@ class CleanMixin():
         except FieldDoesNotExist:
             pass
 
-        cleaned = remove_non_printable_characters(cleaned, remove_newline=remove_newline)
+        cleaned = remove_non_printable_characters(
+            cleaned, remove_newline=remove_newline
+        )
 
         return cleaned
 
@@ -88,16 +91,14 @@ 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():
-
             if k in self.SAFE_FIELDS:
                 ret = v
             elif isinstance(v, str):
@@ -125,17 +126,20 @@ class CreateAPI(CleanMixin, generics.CreateAPIView):
 
 
 class RetrieveAPI(generics.RetrieveAPIView):
-    """View for retreive API."""
+    """View for retrieve API."""
+
     pass
 
 
 class RetrieveUpdateAPI(CleanMixin, generics.RetrieveUpdateAPIView):
     """View for retrieve and update API."""
+
     pass
 
 
 class CustomDestroyModelMixin:
     """This mixin was created pass the kwargs from the API to the models."""
+
     def destroy(self, request, *args, **kwargs):
         """Custom destroy method to pass kwargs."""
         instance = self.get_object()
@@ -147,11 +151,14 @@ class CustomDestroyModelMixin:
         instance.delete(**kwargs)
 
 
-class CustomRetrieveUpdateDestroyAPIView(mixins.RetrieveModelMixin,
-                                         mixins.UpdateModelMixin,
-                                         CustomDestroyModelMixin,
-                                         generics.GenericAPIView):
+class CustomRetrieveUpdateDestroyAPIView(
+    mixins.RetrieveModelMixin,
+    mixins.UpdateModelMixin,
+    CustomDestroyModelMixin,
+    generics.GenericAPIView,
+):
     """This APIView was created pass the kwargs from the API to the models."""
+
     def get(self, request, *args, **kwargs):
         """Custom get method to pass kwargs."""
         return self.retrieve(request, *args, **kwargs)

InvenTree/InvenTree/permissions.py

@@ -8,8 +8,7 @@ import users.models
 
 
 def get_model_for_view(view, raise_error=True):
-    """Attempt to introspect the 'model' type for an API view"""
-
+    """Attempt to introspect the 'model' type for an API view."""
     if hasattr(view, 'get_permission_model'):
         return view.get_permission_model()
 
@@ -19,7 +18,7 @@ def get_model_for_view(view, raise_error=True):
     if hasattr(view, 'get_serializer_class'):
         return view.get_serializr_class().Meta.model
 
-    raise AttributeError(f"Serializer class not specified for {view.__class__}")
+    raise AttributeError(f'Serializer class not specified for {view.__class__}')
 
 
 class RolePermission(permissions.BasePermission):
@@ -62,10 +61,18 @@ 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
         if role := getattr(view, 'role_required', None):
+            # If the role is specified as "role.permission", split it
+            if '.' in role:
+                role, permission = role.split('.')
+
             return users.models.check_user_role(user, role, permission)
 
         try:
@@ -75,7 +82,7 @@ class RolePermission(permissions.BasePermission):
             app_label = model._meta.app_label
             model_name = model._meta.model_name
 
-            table = f"{app_label}_{model_name}"
+            table = f'{app_label}_{model_name}'
         except AttributeError:
             # We will assume that if the serializer class does *not* have a Meta,
             # then we don't need a permission
@@ -92,9 +99,23 @@ 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):
         return view_func(*args, **kwargs)
+
     wrapped_view.auth_exempt = True
     return wraps(view_func)(wrapped_view)

InvenTree/InvenTree/ready.py

@@ -1,5 +1,6 @@
 """Functions to check if certain parts of InvenTree are ready."""
 
+import os
 import sys
 
 
@@ -9,36 +10,110 @@ def isInTestMode():
 
 
 def isImportingData():
-    """Returns True if the database is currently importing data, e.g. 'loaddata' command is performed."""
-    return 'loaddata' in sys.argv
+    """Returns True if the database is currently importing (or exporting) data, e.g. 'loaddata' command is performed."""
+    return any((x in sys.argv for x in ['flush', 'loaddata', 'dumpdata']))
 
 
-def canAppAccessDatabase(allow_test: bool = False, allow_plugins: bool = False, allow_shell: bool = False):
+def isRunningMigrations():
+    """Return True if the database is currently running migrations."""
+    return any(
+        (
+            x in sys.argv
+            for x in ['migrate', 'makemigrations', 'showmigrations', 'runmigrations']
+        )
+    )
+
+
+def isRebuildingData():
+    """Return true if any of the rebuilding commands are being executed."""
+    return any(
+        (
+            x in sys.argv
+            for x in ['prerender', 'rebuild_models', 'rebuild_thumbnails', 'rebuild']
+        )
+    )
+
+
+def isRunningBackup():
+    """Return true if any of the backup commands are being executed."""
+    return any(
+        (
+            x in sys.argv
+            for x in [
+                'backup',
+                'restore',
+                'dbbackup',
+                'dbresotore',
+                'mediabackup',
+                'mediarestore',
+            ]
+        )
+    )
+
+
+def isInWorkerThread():
+    """Returns True if the current thread is a background worker thread."""
+    return 'qcluster' in sys.argv
+
+
+def isInServerThread():
+    """Returns True if the current thread is a server thread."""
+    if isInWorkerThread():
+        return False
+
+    if 'runserver' in sys.argv:
+        return True
+
+    if 'gunicorn' in sys.argv[0]:
+        return True
+
+    return False
+
+
+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 not isInWorkerThread()
+
+
+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.
 
     There are some circumstances where we don't want the ready function in apps.py
     to touch the database
     """
+    # Prevent database access if we are running backups
+    if isRunningBackup():
+        return False
+
+    # Prevent database access if we are importing data
+    if isImportingData():
+        return False
+
+    # Prevent database access if we are rebuilding data
+    if isRebuildingData():
+        return False
+
+    # Prevent database access if we are running migrations
+    if not allow_plugins and isRunningMigrations():
+        return False
+
     # If any of the following management commands are being executed,
     # prevent custom "on load" code from running!
     excluded_commands = [
-        'flush',
-        'loaddata',
-        'dumpdata',
         'check',
         'createsuperuser',
         'wait_for_db',
-        'prerender',
-        'rebuild_models',
-        'rebuild_thumbnails',
         'makemessages',
         'compilemessages',
-        'backup',
-        'dbbackup',
-        'mediabackup',
-        'restore',
-        'dbrestore',
-        'mediarestore',
     ]
 
     if not allow_shell:
@@ -49,14 +124,26 @@ def canAppAccessDatabase(allow_test: bool = False, allow_plugins: bool = False,
         excluded_commands.append('test')
 
     if not allow_plugins:
-        excluded_commands.extend([
-            'makemigrations',
-            'migrate',
-            'collectstatic',
-        ])
+        excluded_commands.extend(['collectstatic'])
 
     for cmd in excluded_commands:
         if cmd in sys.argv:
             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

@@ -1,50 +1,197 @@
 """Functions to sanitize user input files."""
+
 from bleach import clean
 from bleach.css_sanitizer import CSSSanitizer
 
 ALLOWED_ELEMENTS_SVG = [
-    'a', 'animate', 'animateColor', 'animateMotion',
-    'animateTransform', 'circle', 'defs', 'desc', 'ellipse', 'font-face',
-    'font-face-name', 'font-face-src', 'g', 'glyph', 'hkern',
-    'linearGradient', 'line', 'marker', 'metadata', 'missing-glyph',
-    'mpath', 'path', 'polygon', 'polyline', 'radialGradient', 'rect',
-    'set', 'stop', 'svg', 'switch', 'text', 'title', 'tspan', 'use'
+    'a',
+    'animate',
+    'animateColor',
+    'animateMotion',
+    'animateTransform',
+    'circle',
+    'defs',
+    'desc',
+    'ellipse',
+    'font-face',
+    'font-face-name',
+    'font-face-src',
+    'g',
+    'glyph',
+    'hkern',
+    'linearGradient',
+    'line',
+    'marker',
+    'metadata',
+    'missing-glyph',
+    'mpath',
+    'path',
+    'polygon',
+    'polyline',
+    'radialGradient',
+    'rect',
+    'set',
+    'stop',
+    'svg',
+    'switch',
+    'text',
+    'title',
+    'tspan',
+    'use',
 ]
 
 ALLOWED_ATTRIBUTES_SVG = [
-    'accent-height', 'accumulate', 'additive', 'alphabetic',
-    'arabic-form', 'ascent', 'attributeName', 'attributeType',
-    'baseProfile', 'bbox', 'begin', 'by', 'calcMode', 'cap-height',
-    'class', 'color', 'color-rendering', 'content', 'cx', 'cy', 'd', 'dx',
-    'dy', 'descent', 'display', 'dur', 'end', 'fill', 'fill-opacity',
-    'fill-rule', 'font-family', 'font-size', 'font-stretch', 'font-style',
-    'font-variant', 'font-weight', 'from', 'fx', 'fy', 'g1', 'g2',
-    'glyph-name', 'gradientUnits', 'hanging', 'height', 'horiz-adv-x',
-    'horiz-origin-x', 'id', 'ideographic', 'k', 'keyPoints',
-    'keySplines', 'keyTimes', 'lang', 'marker-end', 'marker-mid',
-    'marker-start', 'markerHeight', 'markerUnits', 'markerWidth',
-    'mathematical', 'max', 'min', 'name', 'offset', 'opacity', 'orient',
-    'origin', 'overline-position', 'overline-thickness', 'panose-1',
-    'path', 'pathLength', 'points', 'preserveAspectRatio', 'r', 'refX',
-    'refY', 'repeatCount', 'repeatDur', 'requiredExtensions',
-    'requiredFeatures', 'restart', 'rotate', 'rx', 'ry', 'slope',
-    'stemh', 'stemv', 'stop-color', 'stop-opacity',
-    'strikethrough-position', 'strikethrough-thickness', 'stroke',
-    'stroke-dasharray', 'stroke-dashoffset', 'stroke-linecap',
-    'stroke-linejoin', 'stroke-miterlimit', 'stroke-opacity',
-    'stroke-width', 'systemLanguage', 'target', 'text-anchor', 'to',
-    'transform', 'type', 'u1', 'u2', 'underline-position',
-    'underline-thickness', 'unicode', 'unicode-range', 'units-per-em',
-    'values', 'version', 'viewBox', 'visibility', 'width', 'widths', 'x',
-    'x-height', 'x1', 'x2', 'xlink:actuate', 'xlink:arcrole',
-    'xlink:href', 'xlink:role', 'xlink:show', 'xlink:title',
-    'xlink:type', 'xml:base', 'xml:lang', 'xml:space', 'xmlns',
-    'xmlns:xlink', 'y', 'y1', 'y2', 'zoomAndPan', 'style'
+    'accent-height',
+    'accumulate',
+    'additive',
+    'alphabetic',
+    'arabic-form',
+    'ascent',
+    'attributeName',
+    'attributeType',
+    'baseProfile',
+    'bbox',
+    'begin',
+    'by',
+    'calcMode',
+    'cap-height',
+    'class',
+    'color',
+    'color-rendering',
+    'content',
+    'cx',
+    'cy',
+    'd',
+    'dx',
+    'dy',
+    'descent',
+    'display',
+    'dur',
+    'end',
+    'fill',
+    'fill-opacity',
+    'fill-rule',
+    'font-family',
+    'font-size',
+    'font-stretch',
+    'font-style',
+    'font-variant',
+    'font-weight',
+    'from',
+    'fx',
+    'fy',
+    'g1',
+    'g2',
+    'glyph-name',
+    'gradientUnits',
+    'hanging',
+    'height',
+    'horiz-adv-x',
+    'horiz-origin-x',
+    'id',
+    'ideographic',
+    'k',
+    'keyPoints',
+    'keySplines',
+    'keyTimes',
+    'lang',
+    'marker-end',
+    'marker-mid',
+    'marker-start',
+    'markerHeight',
+    'markerUnits',
+    'markerWidth',
+    'mathematical',
+    'max',
+    'min',
+    'name',
+    'offset',
+    'opacity',
+    'orient',
+    'origin',
+    'overline-position',
+    'overline-thickness',
+    'panose-1',
+    'path',
+    'pathLength',
+    'points',
+    'preserveAspectRatio',
+    'r',
+    'refX',
+    'refY',
+    'repeatCount',
+    'repeatDur',
+    'requiredExtensions',
+    'requiredFeatures',
+    'restart',
+    'rotate',
+    'rx',
+    'ry',
+    'slope',
+    'stemh',
+    'stemv',
+    'stop-color',
+    'stop-opacity',
+    'strikethrough-position',
+    'strikethrough-thickness',
+    'stroke',
+    'stroke-dasharray',
+    'stroke-dashoffset',
+    'stroke-linecap',
+    'stroke-linejoin',
+    'stroke-miterlimit',
+    'stroke-opacity',
+    'stroke-width',
+    'systemLanguage',
+    'target',
+    'text-anchor',
+    'to',
+    'transform',
+    'type',
+    'u1',
+    'u2',
+    'underline-position',
+    'underline-thickness',
+    'unicode',
+    'unicode-range',
+    'units-per-em',
+    'values',
+    'version',
+    'viewBox',
+    'visibility',
+    'width',
+    'widths',
+    'x',
+    'x-height',
+    'x1',
+    'x2',
+    'xlink:actuate',
+    'xlink:arcrole',
+    'xlink:href',
+    'xlink:role',
+    'xlink:show',
+    'xlink:title',
+    'xlink:type',
+    'xml:base',
+    'xml:lang',
+    'xml:space',
+    'xmlns',
+    'xmlns:xlink',
+    'y',
+    'y1',
+    'y2',
+    'zoomAndPan',
+    'style',
 ]
 
 
-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 +202,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,
@@ -62,6 +212,7 @@ def sanitize_svg(file_data: str, strip: bool = True, elements: str = ALLOWED_ELE
         attributes=attributes,
         strip=strip,
         strip_comments=strip,
-        css_sanitizer=CSSSanitizer()
+        css_sanitizer=CSSSanitizer(),
     )
+
     return cleaned

InvenTree/InvenTree/sentry.py

@@ -0,0 +1,73 @@
+"""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,6 +2,7 @@
 
 import os
 from collections import OrderedDict
+from copy import deepcopy
 from decimal import Decimal
 
 from django.conf import settings
@@ -15,15 +16,19 @@ 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
+
+
+class EmptySerializer(serializers.Serializer):
+    """Empty serializer for use in testing."""
 
 
 class InvenTreeMoneySerializer(MoneyField):
@@ -33,16 +38,15 @@ class InvenTreeMoneySerializer(MoneyField):
     """
 
     def __init__(self, *args, **kwargs):
-        """Overrite 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)
+        """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)
 
         super().__init__(*args, **kwargs)
 
     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
@@ -55,28 +59,41 @@ class InvenTreeMoneySerializer(MoneyField):
                 amount = Decimal(amount)
                 amount = round(amount, self.decimal_places)
         except Exception:
-            raise ValidationError({
-                self.field_name: [_("Must be a valid number")],
-            })
+            raise ValidationError({self.field_name: [_('Must be a valid number')]})
 
-        currency = data.get(get_currency_field_name(self.field_name), self.default_currency)
+        currency = data.get(
+            get_currency_field_name(self.field_name), self.default_currency
+        )
 
-        if currency and amount is not None and not isinstance(amount, MONEY_CLASSES) and amount is not empty:
+        if (
+            currency
+            and amount is not None
+            and not isinstance(amount, MONEY_CLASSES)
+            and amount is not empty
+        ):
             return Money(amount, currency)
 
         return amount
 
 
 class InvenTreeCurrencySerializer(serializers.ChoiceField):
-    """Custom serializers for selecting currency option"""
+    """Custom serializers for selecting currency option."""
 
     def __init__(self, *args, **kwargs):
-        """Initialize the currency serializer"""
+        """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 +104,104 @@ 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 data.get(f, None) is None:
+                if (
+                    self.parent
+                    and (v := getattr(self.parent.fields[f], 'default', None))
+                    is not None
+                ):
+                    data[f] = v
+                else:
+                    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."""
 
@@ -101,7 +216,6 @@ class InvenTreeModelSerializer(serializers.ModelSerializer):
         """Custom __init__ routine to ensure that *default* values (as specified in the ORM) are used by the DRF serializers, *if* the values are not provided by the user."""
         # If instance is None, we are creating a new instance
         if instance is None and data is not empty:
-
             if data is None:
                 data = OrderedDict()
             else:
@@ -116,7 +230,6 @@ class InvenTreeModelSerializer(serializers.ModelSerializer):
             fields = model_meta.get_field_info(ModelClass)
 
             for field_name, field in fields.fields.items():
-
                 """
                 Update the field IF (and ONLY IF):
 
@@ -124,7 +237,6 @@ class InvenTreeModelSerializer(serializers.ModelSerializer):
                 - The field does not already have a value set
                 """
                 if field.has_default() and field_name not in data:
-
                     value = field.default
 
                     # Account for callable functions
@@ -152,9 +264,7 @@ class InvenTreeModelSerializer(serializers.ModelSerializer):
             fields = model_meta.get_field_info(ModelClass)
 
             for field_name, field in fields.fields.items():
-
                 if field.has_default() and field_name not in initials:
-
                     value = field.default
 
                     # Account for callable functions
@@ -188,8 +298,7 @@ class InvenTreeModelSerializer(serializers.ModelSerializer):
         return self.instance
 
     def create(self, validated_data):
-        """Custom create method which supports field adjustment"""
-
+        """Custom create method which supports field adjustment."""
         initial_data = validated_data.copy()
 
         # Remove any fields which do not exist on the model
@@ -213,7 +322,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)
 
@@ -244,7 +352,6 @@ class InvenTreeModelSerializer(serializers.ModelSerializer):
         try:
             instance.full_clean()
         except (ValidationError, DjangoValidationError) as exc:
-
             data = exc.message_dict
 
             # Change '__all__' key (django style) to 'non_field_errors' (DRF style)
@@ -257,20 +364,119 @@ 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."""
 
     class Meta:
         """Metaclass defines serializer fields."""
+
         model = User
-        fields = [
-            'pk',
-            'username',
-            'first_name',
-            'last_name',
-            'email'
+        fields = ['pk', 'username', 'first_name', 'last_name', '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."""
+        from InvenTree.helpers_model import get_base_url
+
+        base_url = get_base_url()
+
+        instance = super().create(validated_data)
+
+        # Make sure the user cannot login until they have set a password
+        instance.set_unusable_password()
+
+        message = (
+            _('Your account has been created.')
+            + '\n\n'
+            + _('Please use the password reset function to login')
+        )
+
+        if base_url:
+            message += f'\n\nURL: {base_url}'
+
+        # Send the user an onboarding email (from current site)
+        instance.email_user(subject=_('Welcome to InvenTree'), message=message)
+
+        return instance
+
 
 class InvenTreeAttachmentSerializerField(serializers.FileField):
     """Override the DRF native FileField serializer, to remove the leading server path.
@@ -305,7 +511,7 @@ class InvenTreeAttachmentSerializer(InvenTreeModelSerializer):
 
     @staticmethod
     def attachment_fields(extra_fields=None):
-        """Default set of fields for an attachment serializer"""
+        """Default set of fields for an attachment serializer."""
         fields = [
             'pk',
             'attachment',
@@ -324,17 +530,11 @@ class InvenTreeAttachmentSerializer(InvenTreeModelSerializer):
 
     user_detail = UserSerializer(source='user', read_only=True, many=False)
 
-    attachment = InvenTreeAttachmentSerializerField(
-        required=False,
-        allow_null=False,
-    )
+    attachment = InvenTreeAttachmentSerializerField(required=False, allow_null=False)
 
     # The 'filename' field must be present in the serializer
     filename = serializers.CharField(
-        label=_('Filename'),
-        required=False,
-        source='basename',
-        allow_blank=False,
+        label=_('Filename'), required=False, source='basename', allow_blank=False
     )
 
     upload_date = serializers.DateField(read_only=True)
@@ -368,7 +568,7 @@ class InvenTreeDecimalField(serializers.FloatField):
         try:
             return Decimal(str(data))
         except Exception:
-            raise serializers.ValidationError(_("Invalid value"))
+            raise serializers.ValidationError(_('Invalid value'))
 
 
 class DataFileUploadSerializer(serializers.Serializer):
@@ -385,13 +585,11 @@ class DataFileUploadSerializer(serializers.Serializer):
     class Meta:
         """Metaclass options."""
 
-        fields = [
-            'data_file',
-        ]
+        fields = ['data_file']
 
     data_file = serializers.FileField(
-        label=_("Data File"),
-        help_text=_("Select data file for upload"),
+        label=_('Data File'),
+        help_text=_('Select data file for upload'),
         required=True,
         allow_empty_file=False,
     )
@@ -405,20 +603,16 @@ class DataFileUploadSerializer(serializers.Serializer):
         # Remove the leading . from the extension
         ext = ext[1:]
 
-        accepted_file_types = [
-            'xls', 'xlsx',
-            'csv', 'tsv',
-            'xml',
-        ]
+        accepted_file_types = ['xls', 'xlsx', 'csv', 'tsv', 'xml']
 
         if ext not in accepted_file_types:
-            raise serializers.ValidationError(_("Unsupported file type"))
+            raise serializers.ValidationError(_('Unsupported file type'))
 
         # Impose a 50MB limit on uploaded BOM files
         max_upload_file_size = 50 * 1024 * 1024
 
         if data_file.size > max_upload_file_size:
-            raise serializers.ValidationError(_("File is too large"))
+            raise serializers.ValidationError(_('File is too large'))
 
         # Read file data into memory (bytes object)
         try:
@@ -439,10 +633,10 @@ class DataFileUploadSerializer(serializers.Serializer):
             raise serializers.ValidationError(str(e))
 
         if len(self.dataset.headers) == 0:
-            raise serializers.ValidationError(_("No columns found in file"))
+            raise serializers.ValidationError(_('No columns found in file'))
 
         if len(self.dataset) == 0:
-            raise serializers.ValidationError(_("No data rows found in file"))
+            raise serializers.ValidationError(_('No data rows found in file'))
 
         return data_file
 
@@ -492,7 +686,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 = {}
@@ -536,24 +730,14 @@ class DataFileExtractSerializer(serializers.Serializer):
     class Meta:
         """Metaclass options."""
 
-        fields = [
-            'columns',
-            'rows',
-        ]
+        fields = ['columns', 'rows']
 
     # Mapping of columns
-    columns = serializers.ListField(
-        child=serializers.CharField(
-            allow_blank=True,
-        ),
-    )
+    columns = serializers.ListField(child=serializers.CharField(allow_blank=True))
 
     rows = serializers.ListField(
         child=serializers.ListField(
-            child=serializers.CharField(
-                allow_blank=True,
-                allow_null=True,
-            ),
+            child=serializers.CharField(allow_blank=True, allow_null=True)
         )
     )
 
@@ -565,10 +749,10 @@ class DataFileExtractSerializer(serializers.Serializer):
         self.rows = data.get('rows', [])
 
         if len(self.rows) == 0:
-            raise serializers.ValidationError(_("No data rows provided"))
+            raise serializers.ValidationError(_('No data rows provided'))
 
         if len(self.columns) == 0:
-            raise serializers.ValidationError(_("No data columns supplied"))
+            raise serializers.ValidationError(_('No data columns supplied'))
 
         self.validate_extracted_columns()
 
@@ -591,16 +775,9 @@ class DataFileExtractSerializer(serializers.Serializer):
             processed_row = self.process_row(self.row_to_dict(row))
 
             if processed_row:
-                rows.append({
-                    "original": row,
-                    "data": processed_row,
-                })
+                rows.append({'original': row, 'data': processed_row})
 
-        return {
-            'fields': model_fields,
-            'columns': self.columns,
-            'rows': rows,
-        }
+        return {'fields': model_fields, 'columns': self.columns, 'rows': rows}
 
     def process_row(self, row):
         """Process a 'row' of data, which is a mapped column:value dict.
@@ -614,12 +791,9 @@ class DataFileExtractSerializer(serializers.Serializer):
 
     def row_to_dict(self, row):
         """Convert a "row" to a named data dict."""
-        row_dict = {
-            'errors': {},
-        }
+        row_dict = {'errors': {}}
 
         for idx, value in enumerate(row):
-
             if idx < len(self.columns):
                 col = self.columns[idx]
 
@@ -639,16 +813,16 @@ class DataFileExtractSerializer(serializers.Serializer):
         cols_seen = set()
 
         for name, field in model_fields.items():
-
             required = field.get('required', False)
 
             # Check for missing required columns
             if required:
                 if name not in self.columns:
-                    raise serializers.ValidationError(_(f"Missing required column: '{name}'"))
+                    raise serializers.ValidationError(
+                        _(f"Missing required column: '{name}'")
+                    )
 
         for col in self.columns:
-
             if not col:
                 continue
 
@@ -670,18 +844,15 @@ 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',
-        ]
+        """Ensure the 'remote_image' field is skipped when creating a new instance."""
+        return ['remote_image']
 
     remote_image = serializers.URLField(
         required=False,
         allow_blank=False,
         write_only=True,
-        label=_("URL"),
-        help_text=_("URL of remote image file"),
+        label=_('Remote Image'),
+        help_text=_('URL of remote image file'),
     )
 
     def validate_remote_image(self, url):
@@ -690,12 +861,17 @@ class RemoteImageMixin(metaclass=serializers.SerializerMetaclass):
         - Attempt to download the image and store it against this object instance
         - Catches and re-throws any errors
         """
+        from InvenTree.helpers_model import download_image_from_url
 
         if not url:
             return
 
-        if not InvenTreeSetting.get_setting('INVENTREE_DOWNLOAD_FROM_URL'):
-            raise ValidationError(_("Downloading images from remote URL is not enabled"))
+        if not common_models.InvenTreeSetting.get_setting(
+            'INVENTREE_DOWNLOAD_FROM_URL'
+        ):
+            raise ValidationError(
+                _('Downloading images from remote URL is not enabled')
+            )
 
         try:
             self.remote_image_file = download_image_from_url(url)

InvenTree/InvenTree/social_auth_urls.py

@@ -0,0 +1,269 @@
+"""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 import serializers
+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 EmptySerializer, 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 SocialProviderListResponseSerializer(serializers.Serializer):
+    """Serializer for the SocialProviderListView."""
+
+    class SocialProvider(serializers.Serializer):
+        """Serializer for the SocialProviderListResponseSerializer."""
+
+        id = serializers.CharField()
+        name = serializers.CharField()
+        configured = serializers.BooleanField()
+        login = serializers.URLField()
+        connect = serializers.URLField()
+        display_name = serializers.CharField()
+
+    sso_enabled = serializers.BooleanField()
+    sso_registration = serializers.BooleanField()
+    mfa_required = serializers.BooleanField()
+    providers = SocialProvider(many=True)
+    registration_enabled = serializers.BooleanField()
+    password_forgotten_enabled = serializers.BooleanField()
+
+
+class SocialProviderListView(ListAPI):
+    """List of available social providers."""
+
+    permission_classes = (AllowAny,)
+    serializer_class = EmptySerializer
+
+    @extend_schema(
+        responses={200: OpenApiResponse(response=SocialProviderListResponseSerializer)}
+    )
+    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,
+            'registration_enabled': InvenTreeSetting.get_setting('LOGIN_ENABLE_REG'),
+            'password_forgotten_enabled': InvenTreeSetting.get_setting(
+                'LOGIN_ENABLE_PWD_FORGOT'
+            ),
+        }
+        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,77 @@
+"""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")
+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:
@@ -33,43 +33,17 @@ def is_worker_running(**kwargs):
     now = timezone.now()
     past = now - timedelta(minutes=10)
 
-    results = Success.objects.filter(
-        started__gte=past
-    )
+    results = Success.objects.filter(started__gte=past)
 
     # 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):
@@ -89,13 +63,13 @@ def check_system_health(**kwargs):
 
     if not is_worker_running(**kwargs):  # pragma: no cover
         result = False
-        logger.warning(_("Background worker check failed"))
+        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"))
+        logger.warning(_('Email backend not configured'))
 
     if not result:  # pragma: no cover
-        logger.warning(_("InvenTree system health checks failed"))
+        logger.warning(_('InvenTree system health checks failed'))
 
     return result

InvenTree/InvenTree/status_codes.py

@@ -2,443 +2,196 @@
 
 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,
-    ]
+    OPEN = [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,
-    ]
+    OPEN = [SalesOrderStatus.PENDING.value, SalesOrderStatus.IN_PROGRESS.value]
 
     # Completed orders
-    COMPLETE = [
-        SHIPPED,
-    ]
+    COMPLETE = [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,
-    ]
+    ACTIVE_CODES = [BuildStatus.PENDING.value, BuildStatus.PRODUCTION.value]
 
 
 class ReturnOrderStatus(StatusCode):
-    """Defines a set of status codes for a ReturnOrder"""
+    """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'
 
-    OPEN = [
-        PENDING,
-        IN_PROGRESS,
-    ]
 
-    options = {
-        PENDING: _("Pending"),
-        IN_PROGRESS: _("In Progress"),
-        COMPLETE: _("Complete"),
-        CANCELLED: _("Cancelled"),
-    }
+class ReturnOrderStatusGroups:
+    """Groups for ReturnOrderStatus codes."""
 
-    colors = {
-        PENDING: 'secondary',
-        IN_PROGRESS: 'primary',
-        COMPLETE: 'success',
-        CANCELLED: 'danger',
-    }
+    OPEN = [ReturnOrderStatus.PENDING.value, ReturnOrderStatus.IN_PROGRESS.value]
 
 
 class ReturnOrderLineStatus(StatusCode):
-    """Defines a set of status codes for a ReturnOrderLineItem"""
+    """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

@@ -9,25 +9,29 @@ import time
 import warnings
 from dataclasses import dataclass
 from datetime import datetime, timedelta
-from typing import Callable, List
+from typing import Callable
 
 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
 from django.db.migrations.executor import MigrationExecutor
-from django.db.utils import (NotSupportedError, OperationalError,
-                             ProgrammingError)
+from django.db.utils import NotSupportedError, OperationalError, ProgrammingError
 from django.utils import timezone
 
 import requests
-from maintenance_mode.core import (get_maintenance_mode, maintenance_mode_on,
-                                   set_maintenance_mode)
+from maintenance_mode.core import (
+    get_maintenance_mode,
+    maintenance_mode_on,
+    set_maintenance_mode,
+)
 
 from InvenTree.config import get_setting
+from plugin import registry
 
-logger = logging.getLogger("inventree")
+from .version import isInvenTreeUpToDate
+
+logger = logging.getLogger('inventree')
 
 
 def schedule_task(taskname, **kwargs):
@@ -42,24 +46,20 @@ def schedule_task(taskname, **kwargs):
     try:
         from django_q.models import Schedule
     except AppRegistryNotReady:  # pragma: no cover
-        logger.info("Could not start background tasks - App registry not ready")
+        logger.info('Could not start background tasks - App registry not ready')
         return
 
     try:
         # 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,
-                func=taskname,
-                **kwargs
-            )
+            Schedule.objects.create(name=taskname, func=taskname, **kwargs)
     except (OperationalError, ProgrammingError):  # pragma: no cover
         # Required if the DB is not ready yet
         pass
@@ -71,15 +71,15 @@ 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:
     """Check if a periodic task should be run, based on the provided setting name.
 
     Arguments:
-        task_name: The name of the task being run, e.g. 'dummy_task'
-        setting_name: The name of the global setting, e.g. 'INVENTREE_DUMMY_TASK_INTERVAL'
+        task_name (str): The name of the task being run, e.g. 'dummy_task'
+        n_days (int): The number of days between task runs (default = 1)
 
     Returns:
         bool: If the task should be run *now*, or wait another day
@@ -90,15 +90,18 @@ 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 +119,9 @@ 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 +138,9 @@ 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
@@ -144,28 +151,34 @@ 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*"""
-
+    """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)
+    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*"""
-
+    """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)
+    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,20 +187,34 @@ 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):
             # function was passed - use that
             _func = taskname
@@ -197,15 +224,19 @@ def offload_task(taskname, *args, force_async=False, force_sync=False, **kwargs)
                 app, mod, func = taskname.split('.')
                 app_mod = app + '.' + mod
             except ValueError:
-                raise_warning(f"WARNING: '{taskname}' not started - Malformed function path")
-                return
+                raise_warning(
+                    f"WARNING: '{taskname}' not started - Malformed function path"
+                )
+                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
+                raise_warning(
+                    f"WARNING: '{taskname}' not started - No module named '{app_mod}'"
+                )
+                return False
 
             # Retrieve function
             try:
@@ -218,11 +249,20 @@ def offload_task(taskname, *args, force_async=False, force_sync=False, **kwargs)
                 if not _func:
                     _func = eval(func)  # pragma: no cover
             except NameError:
-                raise_warning(f"WARNING: '{taskname}' not started - No function named '{func}'")
-                return
+                raise_warning(
+                    f"WARNING: '{taskname}' not started - No function named '{func}'"
+                )
+                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()
@@ -238,19 +278,20 @@ class ScheduledTask:
     interval: str
     minutes: int = None
 
-    MINUTES = "I"
-    HOURLY = "H"
-    DAILY = "D"
-    WEEKLY = "W"
-    MONTHLY = "M"
-    QUARTERLY = "Q"
-    YEARLY = "Y"
+    MINUTES = 'I'
+    HOURLY = 'H'
+    DAILY = 'D'
+    WEEKLY = 'W'
+    MONTHLY = 'M'
+    QUARTERLY = 'Q'
+    YEARLY = 'Y'
     TYPE = [MINUTES, HOURLY, DAILY, WEEKLY, MONTHLY, QUARTERLY, YEARLY]
 
 
 class TaskRegister:
-    """Registery for periodicall tasks."""
-    task_list: List[ScheduledTask] = []
+    """Registry for periodic tasks."""
+
+    task_list: list[ScheduledTask] = []
 
     def register(self, task, schedule, minutes: int = None):
         """Register a task with the que."""
@@ -265,8 +306,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
         ...
     ```
 
@@ -294,6 +336,7 @@ def scheduled_task(interval: str, minutes: int = None, tasklist: TaskRegister =
         _tasks.register(admin_class, interval, minutes=minutes)
 
         return admin_class
+
     return _task_wrapper
 
 
@@ -304,9 +347,9 @@ def heartbeat():
     (There is probably a less "hacky" way of achieving this)?
     """
     try:
-        from django_q.models import Success
+        from django_q.models import OrmQ, Success
     except AppRegistryNotReady:  # pragma: no cover
-        logger.info("Could not perform heartbeat task - App registry not ready")
+        logger.info('Could not perform heartbeat task - App registry not ready')
         return
 
     threshold = timezone.now() - timedelta(minutes=30)
@@ -314,16 +357,20 @@ def heartbeat():
     # Delete heartbeat results more than half an hour old,
     # otherwise they just create extra noise
     heartbeats = Success.objects.filter(
-        func='InvenTree.tasks.heartbeat',
-        started__lte=threshold
+        func='InvenTree.tasks.heartbeat', started__lte=threshold
     )
 
     heartbeats.delete()
 
+    # Clear out any other pending heartbeat tasks
+    for task in OrmQ.objects.all():
+        if task.func() == 'InvenTree.tasks.heartbeat':
+            task.delete()
+
 
 @scheduled_task(ScheduledTask.DAILY)
 def delete_successful_tasks():
-    """Delete successful task logs which are older than a specified period"""
+    """Delete successful task logs which are older than a specified period."""
     try:
         from django_q.models import Success
 
@@ -333,22 +380,21 @@ def delete_successful_tasks():
         threshold = timezone.now() - timedelta(days=days)
 
         # Delete successful tasks
-        results = Success.objects.filter(
-            started__lte=threshold
-        )
+        results = Success.objects.filter(started__lte=threshold)
 
         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
-        logger.info("Could not perform 'delete_successful_tasks' - App registry not ready")
+        logger.info(
+            "Could not perform 'delete_successful_tasks' - App registry not ready"
+        )
 
 
 @scheduled_task(ScheduledTask.DAILY)
 def delete_failed_tasks():
-    """Delete failed task logs which are older than a specified period"""
-
+    """Delete failed task logs which are older than a specified period."""
     try:
         from django_q.models import Failure
 
@@ -358,12 +404,10 @@ def delete_failed_tasks():
         threshold = timezone.now() - timedelta(days=days)
 
         # Delete failed tasks
-        results = Failure.objects.filter(
-            started__lte=threshold
-        )
+        results = Failure.objects.filter(started__lte=threshold)
 
         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
@@ -381,48 +425,48 @@ def delete_old_error_logs():
         days = InvenTreeSetting.get_setting('INVENTREE_DELETE_ERRORS_DAYS', 30)
         threshold = timezone.now() - timedelta(days=days)
 
-        errors = Error.objects.filter(
-            when__lte=threshold,
-        )
+        errors = Error.objects.filter(when__lte=threshold)
 
         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
         # Apps not yet loaded
-        logger.info("Could not perform 'delete_old_error_logs' - App registry not ready")
+        logger.info(
+            "Could not perform 'delete_old_error_logs' - App registry not ready"
+        )
 
 
 @scheduled_task(ScheduledTask.DAILY)
 def delete_old_notifications():
-    """Delete old notification logs"""
-
+    """Delete old notification logs."""
     try:
-        from common.models import (InvenTreeSetting, NotificationEntry,
-                                   NotificationMessage)
+        from common.models import (
+            InvenTreeSetting,
+            NotificationEntry,
+            NotificationMessage,
+        )
 
         days = InvenTreeSetting.get_setting('INVENTREE_DELETE_NOTIFICATIONS_DAYS', 30)
         threshold = timezone.now() - timedelta(days=days)
 
-        items = NotificationEntry.objects.filter(
-            updated__lte=threshold
-        )
+        items = NotificationEntry.objects.filter(updated__lte=threshold)
 
         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(
-            creation__lte=threshold
-        )
+        items = NotificationMessage.objects.filter(creation__lte=threshold)
 
         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:
-        logger.info("Could not perform 'delete_old_notifications' - App registry not ready")
+        logger.info(
+            "Could not perform 'delete_old_notifications' - App registry not ready"
+        )
 
 
 @scheduled_task(ScheduledTask.DAILY)
@@ -430,18 +474,23 @@ def check_for_updates():
     """Check if there is an update for InvenTree."""
     try:
         import common.models
+        from common.notifications import trigger_superuser_notification
     except AppRegistryNotReady:  # pragma: no cover
         # Apps not yet loaded!
         logger.info("Could not perform 'check_for_updates' - App registry not ready")
         return
 
-    interval = int(common.models.InvenTreeSetting.get_setting('INVENTREE_UPDATE_CHECK_INTERVAL', 7, cache=False))
+    interval = int(
+        common.models.InvenTreeSetting.get_setting(
+            'INVENTREE_UPDATE_CHECK_INTERVAL', 7, cache=False
+        )
+    )
 
     # Check if we should check for updates *today*
     if not check_daily_holdoff('check_for_updates', interval):
         return
 
-    logger.info("Checking for InvenTree software updates")
+    logger.info('Checking for InvenTree software updates')
 
     headers = {}
 
@@ -450,15 +499,17 @@ def check_for_updates():
         token = os.getenv('GITHUB_TOKEN', None)
 
         if token:
-            headers['Authorization'] = f"Bearer {token}"
+            headers['Authorization'] = f'Bearer {token}'
 
     response = requests.get(
         'https://api.github.com/repos/inventree/inventree/releases/latest',
-        headers=headers
+        headers=headers,
     )
 
     if response.status_code != 200:
-        raise ValueError(f'Unexpected status code from GitHub API: {response.status_code}')  # pragma: no cover
+        raise ValueError(
+            f'Unexpected status code from GitHub API: {response.status_code}'
+        )  # pragma: no cover
 
     data = json.loads(response.text)
 
@@ -467,10 +518,10 @@ def check_for_updates():
     if not tag:
         raise ValueError("'tag_name' missing from GitHub response")  # pragma: no cover
 
-    match = re.match(r"^.*(\d+)\.(\d+)\.(\d+).*$", tag)
+    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,168 +529,185 @@ 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(
-        '_INVENTREE_LATEST_VERSION',
-        tag,
-        None
-    )
+    common.models.InvenTreeSetting.set_setting('_INVENTREE_LATEST_VERSION', tag, None)
 
     # Record that this task was successful
     record_task_success('check_for_updates')
 
+    # Send notification if there is a new version
+    if not isInvenTreeUpToDate():
+        logger.warning('InvenTree is not up-to-date, sending notification')
+
+        plg = registry.get_plugin('InvenTreeCoreNotificationsPlugin')
+        if not plg:
+            logger.warning('Cannot send notification - plugin not found')
+            return
+        plg = plg.plugin_config()
+        if not plg:
+            logger.warning('Cannot send notification - plugin config not found')
+            return
+        # Send notification
+        trigger_superuser_notification(
+            plg, f'An update for InvenTree to version {tag} is available'
+        )
+
 
 @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")
+        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()
+        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):
         # Backups are not enabled - exit early
         return
 
-    interval = int(InvenTreeSetting.get_setting('INVENTREE_BACKUP_DAYS', 1, cache=False))
+    interval = int(
+        InvenTreeSetting.get_setting('INVENTREE_BACKUP_DAYS', 1, cache=False)
+    )
 
     # Check if should run this task *today*
     if not check_daily_holdoff('run_backup', interval):
         return
 
-    logger.info("Performing automated database backup task")
+    logger.info('Performing automated database backup task')
 
-    call_command("dbbackup", noinput=True, clean=True, compress=True, interactive=False)
-    call_command("mediabackup", noinput=True, clean=True, compress=True, interactive=False)
+    call_command('dbbackup', noinput=True, clean=True, compress=True, interactive=False)
+    call_command(
+        'mediabackup', noinput=True, clean=True, compress=True, interactive=False
+    )
 
     # Record that this task was successful
     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
-    )
-
-
-@scheduled_task(ScheduledTask.DAILY)
-def check_for_migrations(worker: bool = True):
-    """Checks if migrations are needed.
-
-    If the setting auto_update is enabled we will start updateing.
-    """
-    # Test if auto-updates are enabled
-    if not get_setting('INVENTREE_AUTO_UPDATE', 'auto_update'):
-        return
-
-    from plugin import registry
-
-    plan = get_migration_plan()
-
-    # Check if there are any open migrations
-    if not plan:
-        logger.info('There are no open migrations')
-        return
-
-    logger.info('There are open migrations')
-
-    # Log open migrations
-    for migration in plan:
-        logger.info(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')
-
-        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}')
-
-        print('Migrations done')
-        logger.info('Ran migrations')
-
-    # Make sure we are out of maintenance again
-    logger.info('Checking InvenTree left maintenance mode')
-    if get_maintenance_mode():
-
-        logger.warning('Mainentance was still on - releasing now')
-        set_maintenance_mode(False)
-        logger.info('Released out of maintenance')
-
-    # 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
+
+
+@scheduled_task(ScheduledTask.DAILY)
+def check_for_migrations(force: bool = False, reload_registry: bool = True):
+    """Checks if migrations are needed.
+
+    If the setting auto_update is enabled we will start updating.
+    """
+    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')
+
+    if reload_registry:
+        # Force plugin registry reload
+        registry.check_reload()
+
+    plan = get_migration_plan()
+
+    n = len(plan)
+
+    # Check if there are any open migrations
+    if not plan:
+        set_pending_migrations(0)
+        return
+
+    set_pending_migrations(n)
+
+    # Test if auto-updates are enabled
+    if not force and 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('- %s', str(migration[0]))
+
+    # Set the application to maintenance mode - no access from now on.
+    set_maintenance_mode(True)
+
+    # To be sure we are in maintenance this is wrapped
+    with maintenance_mode_on():
+        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.exception('Error during migrations: %s', e)
+        else:
+            set_pending_migrations(0)
+
+            logger.info('Completed %s migrations', n)
+
+    # Make sure we are out of maintenance mode
+    if get_maintenance_mode():
+        logger.warning('Maintenance mode was not disabled - forcing it now')
+        set_maintenance_mode(False)
+        logger.info('Manually released maintenance mode')
+
+    if reload_registry:
+        # 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, 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/templatetags/__init__.py

@@ -0,0 +1 @@
+"""Custom InvenTree template tags for HTML template rendering."""

InvenTree/InvenTree/templatetags/i18n.py

@@ -0,0 +1,163 @@
+"""This module provides custom translation tags specifically for use with javascript code.
+
+Translated strings are escaped, such that they can be used as string literals in a javascript file.
+"""
+
+import django.templatetags.i18n
+from django import template
+from django.template import TemplateSyntaxError
+from django.templatetags.i18n import TranslateNode
+
+import bleach
+
+import InvenTree.translation
+
+register = template.Library()
+
+
+@register.simple_tag()
+def translation_stats(lang_code):
+    """Return the translation percentage for the given language code."""
+    if lang_code is None:
+        return None
+
+    return InvenTree.translation.get_translation_percent(lang_code)
+
+
+class CustomTranslateNode(TranslateNode):
+    """Custom translation node class, which sanitizes the translated strings for javascript use."""
+
+    def __init__(self, filter_expression, noop, asvar, message_context, escape=False):
+        """Custom constructor for TranslateNode class.
+
+        - Adds an 'escape' argument, which is passed to the render function
+        """
+        super().__init__(filter_expression, noop, asvar, message_context)
+        self.escape = escape
+
+    def render(self, context):
+        """Custom render function overrides / extends default behaviour."""
+        result = super().render(context)
+
+        result = bleach.clean(result)
+
+        # Remove any escape sequences
+        for seq in ['\a', '\b', '\f', '\n', '\r', '\t', '\v']:
+            result = result.replace(seq, '')
+
+        # Remove other disallowed characters
+        for c in ['\\', '`', ';', '|', '&']:
+            result = result.replace(c, '')
+
+        # Escape any quotes contained in the string, if the request is for a javascript file
+        request = context.get('request', None)
+
+        template = getattr(context, 'template_name', None)
+        request = context.get('request', None)
+
+        escape = self.escape
+
+        if template and str(template).endswith('.js'):
+            escape = True
+
+        if request and str(request.path).endswith('.js'):
+            escape = True
+
+        if escape:
+            result = result.replace("'", r'\'')
+            result = result.replace('"', r'\"')
+
+        # Return the 'clean' resulting string
+        return result
+
+
+@register.tag('translate')
+@register.tag('trans')
+def do_translate(parser, token):
+    """Custom translation function.
+
+    - Lifted from https://github.com/django/django/blob/main/django/templatetags/i18n.py.
+    - The only difference is that we pass this to our custom rendering node class
+    """
+    bits = token.split_contents()
+    if len(bits) < 2:
+        raise TemplateSyntaxError("'%s' takes at least one argument" % bits[0])
+    message_string = parser.compile_filter(bits[1])
+    remaining = bits[2:]
+
+    escape = False
+    noop = False
+    asvar = None
+    message_context = None
+    seen = set()
+    invalid_context = {'as', 'noop'}
+
+    while remaining:
+        option = remaining.pop(0)
+        if option in seen:
+            raise TemplateSyntaxError(
+                "The '%s' option was specified more than once." % option
+            )
+        elif option == 'noop':
+            noop = True
+        elif option == 'context':
+            try:
+                value = remaining.pop(0)
+            except IndexError:
+                raise TemplateSyntaxError(
+                    "No argument provided to the '%s' tag for the context option."
+                    % bits[0]
+                )
+            if value in invalid_context:
+                raise TemplateSyntaxError(
+                    "Invalid argument '%s' provided to the '%s' tag for the context "
+                    'option' % (value, bits[0])
+                )
+            message_context = parser.compile_filter(value)
+        elif option == 'as':
+            try:
+                value = remaining.pop(0)
+            except IndexError:
+                raise TemplateSyntaxError(
+                    "No argument provided to the '%s' tag for the as option." % bits[0]
+                )
+            asvar = value
+        elif option == 'escape':
+            escape = True
+        else:
+            raise TemplateSyntaxError(
+                "Unknown argument for '%s' tag: '%s'. The only options "
+                "available are 'noop', 'context' \"xxx\", and 'as VAR'."
+                % (bits[0], option)
+            )
+        seen.add(option)
+
+    return CustomTranslateNode(
+        message_string, noop, asvar, message_context, escape=escape
+    )
+
+
+# Re-register tags which we have not explicitly overridden
+register.tag('blocktrans', django.templatetags.i18n.do_block_translate)
+register.tag('blocktranslate', django.templatetags.i18n.do_block_translate)
+
+register.tag('language', django.templatetags.i18n.language)
+
+register.tag(
+    'get_available_languages', django.templatetags.i18n.do_get_available_languages
+)
+register.tag('get_language_info', django.templatetags.i18n.do_get_language_info)
+register.tag(
+    'get_language_info_list', django.templatetags.i18n.do_get_language_info_list
+)
+register.tag('get_current_language', django.templatetags.i18n.do_get_current_language)
+register.tag(
+    'get_current_language_bidi', django.templatetags.i18n.do_get_current_language_bidi
+)
+
+register.filter('language_name', django.templatetags.i18n.language_name)
+register.filter(
+    'language_name_translated', django.templatetags.i18n.language_name_translated
+)
+register.filter('language_name_local', django.templatetags.i18n.language_name_local)
+register.filter('language_bidi', django.templatetags.i18n.language_bidi)

InvenTree/InvenTree/templatetags/inventree_extras.py

@@ -2,23 +2,24 @@
 
 import logging
 import os
-import sys
 from datetime import date, datetime
 
 from django import template
 from django.conf import settings as djangosettings
 from django.templatetags.static import StaticNode
-from django.urls import reverse
+from django.urls import NoReverseMatch, reverse
 from django.utils.html import format_html
 from django.utils.safestring import mark_safe
 from django.utils.translation import gettext_lazy as _
 
+import common.models
 import InvenTree.helpers
-from common.models import ColorTheme, InvenTreeSetting, InvenTreeUserSetting
+import InvenTree.helpers_model
+import plugin.models
 from common.settings import currency_code_default
 from InvenTree import settings, version
 from plugin import registry
-from plugin.models import NotificationUserSetting, PluginSetting
+from plugin.plugin import InvenTreePlugin
 
 register = template.Library()
 
@@ -53,8 +54,7 @@ def render_date(context, date_object):
     if date_object is None:
         return None
 
-    if type(date_object) == str:
-
+    if isinstance(date_object, str):
         date_object = date_object.strip()
 
         # Check for empty string
@@ -65,29 +65,25 @@ def render_date(context, date_object):
         try:
             date_object = date.fromisoformat(date_object)
         except ValueError:
-            logger.warning(f"Tried to convert invalid date string: {date_object}")
+            logger.warning('Tried to convert invalid date string: %s', date_object)
             return None
 
     # We may have already pre-cached the date format by calling this already!
     user_date_format = context.get('user_date_format', None)
 
     if user_date_format is None:
-
         user = context.get('user', None)
 
         if user and user.is_authenticated:
             # User is specified - look for their date display preference
-            user_date_format = InvenTreeUserSetting.get_setting('DATE_DISPLAY_FORMAT', user=user)
+            user_date_format = common.models.InvenTreeUserSetting.get_setting(
+                'DATE_DISPLAY_FORMAT', user=user
+            )
         else:
             user_date_format = 'YYYY-MM-DD'
 
         # Convert the format string to Pythonic equivalent
-        replacements = [
-            ('YYYY', '%Y'),
-            ('MMM', '%b'),
-            ('MM', '%m'),
-            ('DD', '%d'),
-        ]
+        replacements = [('YYYY', '%Y'), ('MMM', '%b'), ('MM', '%m'), ('DD', '%d')]
 
         for o, n in replacements:
             user_date_format = user_date_format.replace(o, n)
@@ -102,9 +98,8 @@ def render_date(context, date_object):
 
 @register.simple_tag
 def render_currency(money, **kwargs):
-    """Render a currency / Money object"""
-
-    return InvenTree.helpers.render_currency(money, **kwargs)
+    """Render a currency / Money object."""
+    return InvenTree.helpers_model.render_currency(money, **kwargs)
 
 
 @register.simple_tag()
@@ -127,7 +122,7 @@ def to_list(*args):
 
 @register.simple_tag()
 def part_allocation_count(build, part, *args, **kwargs):
-    """Return the total number of <part> allocated to <build>"""
+    """Return the total number of <part> allocated to <build>."""
     return InvenTree.helpers.decimal2string(build.getAllocatedQuantity(part))
 
 
@@ -140,7 +135,7 @@ def inventree_in_debug_mode(*args, **kwargs):
 @register.simple_tag()
 def inventree_show_about(user, *args, **kwargs):
     """Return True if the about modal should be shown."""
-    if InvenTreeSetting.get_setting('INVENTREE_RESTRICT_ABOUT'):
+    if common.models.InvenTreeSetting.get_setting('INVENTREE_RESTRICT_ABOUT'):
         # Return False if the user is not a superuser, or no user information is provided
         if not user or not user.is_superuser:
             return False
@@ -160,6 +155,12 @@ def plugins_enabled(*args, **kwargs):
     return djangosettings.PLUGINS_ENABLED
 
 
+@register.simple_tag()
+def plugins_install_disabled(*args, **kwargs):
+    """Return True if plugin install is disabled for the server instance."""
+    return djangosettings.PLUGINS_INSTALL_DISABLED
+
+
 @register.simple_tag()
 def plugins_info(*args, **kwargs):
     """Return information about activated plugins."""
@@ -171,24 +172,15 @@ def plugins_info(*args, **kwargs):
     plug_list = [plg for plg in registry.plugins.values() if plg.plugin_config().active]
     # Format list
     return [
-        {
-            'name': plg.name,
-            'slug': plg.slug,
-            'version': plg.version
-        } for plg in plug_list
+        {'name': plg.name, 'slug': plg.slug, 'version': plg.version}
+        for plg in plug_list
     ]
 
 
 @register.simple_tag()
 def inventree_db_engine(*args, **kwargs):
     """Return the InvenTree database backend e.g. 'postgresql'."""
-    db = djangosettings.DATABASES['default']
-
-    engine = db.get('ENGINE', _('Unknown database'))
-
-    engine = engine.replace('django.db.backends.', '')
-
-    return engine
+    return version.inventreeDatabase() or _('Unknown database')
 
 
 @register.simple_tag()
@@ -199,7 +191,7 @@ def inventree_instance_name(*args, **kwargs):
 
 @register.simple_tag()
 def inventree_title(*args, **kwargs):
-    """Return the title for the current instance - respecting the settings"""
+    """Return the title for the current instance - respecting the settings."""
     return version.inventreeInstanceTitle()
 
 
@@ -209,55 +201,50 @@ def inventree_logo(**kwargs):
 
     Returns a path to an image file, which can be rendered in the web interface
     """
-
     return InvenTree.helpers.getLogoImage(**kwargs)
 
 
 @register.simple_tag()
 def inventree_splash(**kwargs):
     """Return the URL for the InvenTree splash screen, *or* a custom screen if the user has provided one."""
-
-    return InvenTree.helpers.getSplashScren(**kwargs)
+    return InvenTree.helpers.getSplashScreen(**kwargs)
 
 
 @register.simple_tag()
 def inventree_base_url(*args, **kwargs):
-    """Return the INVENTREE_BASE_URL setting."""
-    return InvenTreeSetting.get_setting('INVENTREE_BASE_URL')
+    """Return the base URL of the InvenTree server."""
+    return InvenTree.helpers_model.get_base_url()
 
 
 @register.simple_tag()
 def python_version(*args, **kwargs):
     """Return the current python version."""
-    return sys.version.split(' ')[0]
+    return version.inventreePythonVersion()
 
 
 @register.simple_tag()
 def inventree_version(shortstring=False, *args, **kwargs):
     """Return InvenTree version string."""
     if shortstring:
-        return _("{title} v{version}".format(
-            title=version.inventreeInstanceTitle(),
-            version=version.inventreeVersion()
-        ))
+        return f'{version.inventreeInstanceTitle()} v{version.inventreeVersion()}'
     return version.inventreeVersion()
 
 
 @register.simple_tag()
 def inventree_is_development(*args, **kwargs):
-    """Returns True if this is a development version of InvenTree"""
+    """Returns True if this is a development version of InvenTree."""
     return version.isInvenTreeDevelopmentVersion()
 
 
 @register.simple_tag()
 def inventree_is_release(*args, **kwargs):
-    """Returns True if this is a release version of InvenTree"""
+    """Returns True if this is a release version of InvenTree."""
     return not version.isInvenTreeDevelopmentVersion()
 
 
 @register.simple_tag()
 def inventree_docs_version(*args, **kwargs):
-    """Returns the InvenTree documentation version"""
+    """Returns the InvenTree documentation version."""
     return version.inventreeDocsVersion()
 
 
@@ -285,24 +272,52 @@ def inventree_commit_date(*args, **kwargs):
     return version.inventreeCommitDate()
 
 
+@register.simple_tag()
+def inventree_installer(*args, **kwargs):
+    """Return InvenTree package installer string."""
+    return version.inventreeInstaller()
+
+
+@register.simple_tag()
+def inventree_branch(*args, **kwargs):
+    """Return InvenTree git branch string."""
+    return version.inventreeBranch()
+
+
+@register.simple_tag()
+def inventree_target(*args, **kwargs):
+    """Return InvenTree target string."""
+    return version.inventreeTarget()
+
+
+@register.simple_tag()
+def inventree_platform(*args, **kwargs):
+    """Return InvenTree platform string."""
+    return version.inventreePlatform()
+
+
 @register.simple_tag()
 def inventree_github_url(*args, **kwargs):
     """Return URL for InvenTree github site."""
-    return "https://github.com/InvenTree/InvenTree/"
+    return version.inventreeGithubUrl()
 
 
 @register.simple_tag()
 def inventree_docs_url(*args, **kwargs):
-    """Return URL for InvenTree documenation site."""
-    tag = version.inventreeDocsVersion()
+    """Return URL for InvenTree documentation site."""
+    return version.inventreeDocUrl()
 
-    return f"https://docs.inventree.org/en/{tag}"
+
+@register.simple_tag()
+def inventree_app_url(*args, **kwargs):
+    """Return URL for InvenTree app site."""
+    return version.inventreeAppUrl()
 
 
 @register.simple_tag()
 def inventree_credits_url(*args, **kwargs):
     """Return URL for InvenTree credits site."""
-    return "https://docs.inventree.org/en/latest/credits/"
+    return version.inventreeCreditsUrl()
 
 
 @register.simple_tag()
@@ -313,58 +328,70 @@ def default_currency(*args, **kwargs):
 
 @register.simple_tag()
 def setting_object(key, *args, **kwargs):
-    """Return a setting object speciifed by the given key.
+    """Return a setting object specified by the given key.
 
     (Or return None if the setting does not exist)
     if a user-setting was requested return that
     """
-
     cache = kwargs.get('cache', True)
 
     if 'plugin' in kwargs:
         # Note, 'plugin' is an instance of an InvenTreePlugin class
 
-        plugin = kwargs['plugin']
+        plg = kwargs['plugin']
+        if issubclass(plg.__class__, InvenTreePlugin):
+            try:
+                plg = plg.plugin_config()
+            except plugin.models.PluginConfig.DoesNotExist:
+                return None
 
-        return PluginSetting.get_setting_object(key, plugin=plugin, cache=cache)
+        return plugin.models.PluginSetting.get_setting_object(
+            key, plugin=plg, cache=cache
+        )
 
     elif 'method' in kwargs:
-        return NotificationUserSetting.get_setting_object(key, user=kwargs['user'], method=kwargs['method'], cache=cache)
+        return plugin.models.NotificationUserSetting.get_setting_object(
+            key, user=kwargs['user'], method=kwargs['method'], cache=cache
+        )
 
     elif 'user' in kwargs:
-        return InvenTreeUserSetting.get_setting_object(key, user=kwargs['user'], cache=cache)
+        return common.models.InvenTreeUserSetting.get_setting_object(
+            key, user=kwargs['user'], cache=cache
+        )
 
     else:
-        return InvenTreeSetting.get_setting_object(key, cache=cache)
+        return common.models.InvenTreeSetting.get_setting_object(key, cache=cache)
 
 
 @register.simple_tag()
 def settings_value(key, *args, **kwargs):
     """Return a settings value specified by the given key."""
     if 'user' in kwargs:
-        if not kwargs['user'] or (kwargs['user'] and kwargs['user'].is_authenticated is False):
-            return InvenTreeUserSetting.get_setting(key)
-        return InvenTreeUserSetting.get_setting(key, user=kwargs['user'])
+        if not kwargs['user'] or (
+            kwargs['user'] and kwargs['user'].is_authenticated is False
+        ):
+            return common.models.InvenTreeUserSetting.get_setting(key)
+        return common.models.InvenTreeUserSetting.get_setting(key, user=kwargs['user'])
 
-    return InvenTreeSetting.get_setting(key)
+    return common.models.InvenTreeSetting.get_setting(key)
 
 
 @register.simple_tag()
 def user_settings(user, *args, **kwargs):
     """Return all USER settings as a key:value dict."""
-    return InvenTreeUserSetting.allValues(user=user)
+    return common.models.InvenTreeUserSetting.allValues(user=user)
 
 
 @register.simple_tag()
 def global_settings(*args, **kwargs):
     """Return all GLOBAL InvenTree settings as a key:value dict."""
-    return InvenTreeSetting.allValues()
+    return common.models.InvenTreeSetting.allValues()
 
 
 @register.simple_tag()
 def visible_global_settings(*args, **kwargs):
     """Return any global settings which are not marked as 'hidden'."""
-    return InvenTreeSetting.allValues(exclude_hidden=True)
+    return common.models.InvenTreeSetting.allValues(exclude_hidden=True)
 
 
 @register.simple_tag()
@@ -400,7 +427,7 @@ def progress_bar(val, max_val, *args, **kwargs):
         style_tags.append(f'max-width: {max_width};')
 
     html = f"""
-    <div id='{item_id}' class='progress' style='{" ".join(style_tags)}'>
+    <div id='{item_id}' class='progress' style='{' '.join(style_tags)}'>
         <div class='progress-bar {style}' role='progressbar' aria-valuemin='0' aria-valuemax='100' style='width:{percent}%'></div>
         <div class='progress-value'>{val} / {max_val}</div>
     </div>
@@ -411,7 +438,7 @@ def progress_bar(val, max_val, *args, **kwargs):
 
 @register.simple_tag()
 def get_color_theme_css(username):
-    """Return the cutsom theme .css file for the selected user"""
+    """Return the custom theme .css file for the selected user."""
     user_theme_name = get_user_color_theme(username)
     # Build path to CSS sheet
     inventree_css_sheet = os.path.join('css', 'color-themes', user_theme_name + '.css')
@@ -425,6 +452,8 @@ def get_color_theme_css(username):
 @register.simple_tag()
 def get_user_color_theme(username):
     """Get current user color theme."""
+    from common.models import ColorTheme
+
     try:
         user_theme = ColorTheme.objects.filter(user=username).get()
         user_theme_name = user_theme.name
@@ -441,11 +470,10 @@ def get_available_themes(*args, **kwargs):
     """Return the available theme choices."""
     themes = []
 
+    from common.models import ColorTheme
+
     for key, name in ColorTheme.get_color_themes_choices():
-        themes.append({
-            'key': key,
-            'name': name
-        })
+        themes.append({'key': key, 'name': name})
 
     return themes
 
@@ -462,20 +490,16 @@ def primitive_to_javascript(primitive):
 
     elif type(primitive) in [int, float]:
         return primitive
-
-    else:
-        # Wrap with quotes
-        return format_html("'{}'", primitive)  # noqa: P103
+    # Wrap with quotes
+    return format_html("'{}'", primitive)  # noqa: P103
 
 
 @register.simple_tag()
 def js_bool(val):
-    """Return a javascript boolean value (true or false)"""
-
+    """Return a javascript boolean value (true or false)."""
     if val:
         return 'true'
-    else:
-        return 'false'
+    return 'false'
 
 
 @register.filter
@@ -488,17 +512,6 @@ def keyvalue(dict, key):
     return dict.get(key)
 
 
-@register.simple_tag()
-def call_method(obj, method_name, *args):
-    """Enables calling model methods / functions from templates with arguments.
-
-    Usage:
-    {% call_method model_object 'fnc_name' argument1 %}
-    """
-    method = getattr(obj, method_name)
-    return method(*args)
-
-
 @register.simple_tag()
 def authorized_owners(group):
     """Return authorized owners."""
@@ -520,8 +533,11 @@ def authorized_owners(group):
 @register.simple_tag()
 def object_link(url_name, pk, ref):
     """Return highlighted link to object."""
-    ref_url = reverse(url_name, kwargs={'pk': pk})
-    return mark_safe(f'<b><a href="{ref_url}">{ref}</a></b>')
+    try:
+        ref_url = reverse(url_name, kwargs={'pk': pk})
+        return mark_safe(f'<b><a href="{ref_url}">{ref}</a></b>')
+    except NoReverseMatch:
+        return None
 
 
 @register.simple_tag()
@@ -551,7 +567,6 @@ class I18nStaticNode(StaticNode):
             self.original = self.path.var
 
         if hasattr(context, 'request'):
-
             # Convert the "requested" language code to a standard format
             language_code = context.request.LANGUAGE_CODE.lower().strip()
             language_code = language_code.replace('_', '-')
@@ -560,16 +575,11 @@ class I18nStaticNode(StaticNode):
             # - First, try the original requested code, e.g. 'pt-br'
             # - Next, try a simpler version of the code e.g. 'pt'
             # - Finally, fall back to english
-            options = [
-                language_code,
-                language_code.split('-')[0],
-                'en',
-            ]
+            options = [language_code, language_code.split('-')[0], 'en']
 
             for lng in options:
                 lng_file = os.path.join(
-                    djangosettings.STATIC_ROOT,
-                    self.original.format(lng=lng)
+                    djangosettings.STATIC_ROOT, self.original.format(lng=lng)
                 )
 
                 if os.path.exists(lng_file):
@@ -586,14 +596,14 @@ if settings.DEBUG:
 
     @register.simple_tag()
     def i18n_static(url_name):
-        """Simple tag to enable {% url %} functionality instead of {% static %}"""
+        """Simple tag to enable {% url %} functionality instead of {% static %}."""
         return reverse(url_name)
 
 else:  # pragma: no cover
 
     @register.tag('i18n_static')
     def do_i18n_static(parser, token):
-        """Overrides normal static, adds language - lookup for prerenderd files #1485
+        """Overrides normal static, adds language - lookup for prerenderd files #1485.
 
         Usage (like static):
         {% i18n_static path [as varname] %}
@@ -601,8 +611,55 @@ else:  # pragma: no cover
         bits = token.split_contents()
         loc_name = settings.STATICFILES_I18_PREFIX
 
-        # change path to called ressource
+        # change path to called resource
         bits[1] = f"'{loc_name}/{{lng}}.{bits[1][1:-1]}'"
         token.contents = ' '.join(bits)
 
         return I18nStaticNode.handle_token(parser, token)
+
+
+@register.simple_tag()
+def admin_index(user):
+    """Return a URL for the admin interface."""
+    if not djangosettings.INVENTREE_ADMIN_ENABLED:
+        return ''
+
+    if not user.is_staff:
+        return ''
+
+    return reverse('admin:index')
+
+
+@register.simple_tag()
+def admin_url(user, table, pk):
+    """Generate a link to the admin site for the given model instance.
+
+    - If the admin site is disabled, an empty URL is returned
+    - If the user is not a staff user, an empty URL is returned
+    - If the user does not have the correct permission, an empty URL is returned
+    """
+    app, model = table.strip().split('.')
+
+    from django.urls import reverse
+
+    if not djangosettings.INVENTREE_ADMIN_ENABLED:
+        return ''
+
+    if not user.is_staff:
+        return ''
+
+    # Check the user has the correct permission
+    perm_string = f'{app}.change_{model}'
+    if not user.has_perm(perm_string):
+        return ''
+
+    # Fallback URL
+    url = reverse(f'admin:{app}_{model}_changelist')
+
+    if pk:
+        try:
+            url = reverse(f'admin:{app}_{model}_change', args=(pk,))
+        except NoReverseMatch:
+            pass
+
+    return url

InvenTree/InvenTree/templatetags/sso.py

@@ -0,0 +1,31 @@
+"""This module provides template tags pertaining to SSO functionality."""
+
+from django import template
+
+import InvenTree.sso
+
+register = template.Library()
+
+
+@register.simple_tag()
+def sso_login_enabled():
+    """Return True if single-sign-on is enabled."""
+    return InvenTree.sso.login_enabled()
+
+
+@register.simple_tag()
+def sso_reg_enabled():
+    """Return True if single-sign-on is enabled for self-registration."""
+    return InvenTree.sso.registration_enabled()
+
+
+@register.simple_tag()
+def sso_auto_enabled():
+    """Return True if single-sign-on is enabled for auto-registration."""
+    return InvenTree.sso.auto_registration_enabled()
+
+
+@register.simple_tag()
+def sso_check_provider(provider):
+    """Return True if the given provider is correctly configured."""
+    return InvenTree.sso.check_provider(provider)

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
 
 
@@ -18,6 +17,7 @@ class HTMLAPITests(InvenTreeTestCase):
     which raised an AssertionError when using the HTML API interface,
     while the regular JSON interface continued to work as expected.
     """
+
     roles = 'all'
 
     def test_part_api(self):
@@ -25,7 +25,7 @@ class HTMLAPITests(InvenTreeTestCase):
         url = reverse('api-part-list')
 
         # Check JSON response
-        response = self.client.get(url, HTTP_ACCEPT='application/json')
+        response = self.client.get(url, headers={'accept': 'application/json'})
         self.assertEqual(response.status_code, 200)
 
     def test_build_api(self):
@@ -33,7 +33,7 @@ class HTMLAPITests(InvenTreeTestCase):
         url = reverse('api-build-list')
 
         # Check JSON response
-        response = self.client.get(url, HTTP_ACCEPT='application/json')
+        response = self.client.get(url, headers={'accept': 'application/json'})
         self.assertEqual(response.status_code, 200)
 
     def test_stock_api(self):
@@ -41,7 +41,7 @@ class HTMLAPITests(InvenTreeTestCase):
         url = reverse('api-stock-list')
 
         # Check JSON response
-        response = self.client.get(url, HTTP_ACCEPT='application/json')
+        response = self.client.get(url, headers={'accept': 'application/json'})
         self.assertEqual(response.status_code, 200)
 
     def test_company_list(self):
@@ -49,7 +49,7 @@ class HTMLAPITests(InvenTreeTestCase):
         url = reverse('api-company-list')
 
         # Check JSON response
-        response = self.client.get(url, HTTP_ACCEPT='application/json')
+        response = self.client.get(url, headers={'accept': 'application/json'})
         self.assertEqual(response.status_code, 200)
 
     def test_not_found(self):
@@ -61,12 +61,7 @@ class HTMLAPITests(InvenTreeTestCase):
 class APITests(InvenTreeAPITestCase):
     """Tests for the InvenTree API."""
 
-    fixtures = [
-        'location',
-        'category',
-        'part',
-        'stock'
-    ]
+    fixtures = ['location', 'category', 'part', 'stock']
     token = None
     auto_login = False
 
@@ -74,11 +69,11 @@ class APITests(InvenTreeAPITestCase):
         """Helper function to use basic auth."""
         # Use basic authentication
 
-        authstring = bytes("{u}:{p}".format(u=self.username, p=self.password), "ascii")
+        authstring = bytes('{u}:{p}'.format(u=self.username, p=self.password), 'ascii')
 
         # Use "basic" auth by default
-        auth = b64encode(authstring).decode("ascii")
-        self.client.credentials(HTTP_AUTHORIZATION="Basic {auth}".format(auth=auth))
+        auth = b64encode(authstring).decode('ascii')
+        self.client.credentials(HTTP_AUTHORIZATION='Basic {auth}'.format(auth=auth))
 
     def tokenAuth(self):
         """Helper function to use token auth."""
@@ -262,49 +257,35 @@ class APITests(InvenTreeAPITestCase):
 
 
 class BulkDeleteTests(InvenTreeAPITestCase):
-    """Unit tests for the BulkDelete endpoints"""
+    """Unit tests for the BulkDelete endpoints."""
 
     superuser = True
 
     def test_errors(self):
-        """Test that the correct errors are thrown"""
-
+        """Test that the correct errors are thrown."""
         url = reverse('api-stock-test-result-list')
 
         # DELETE without any of the required fields
-        response = self.delete(
-            url,
-            {},
-            expected_code=400
-        )
+        response = self.delete(url, {}, expected_code=400)
 
-        self.assertIn('List of items or filters must be provided for bulk deletion', str(response.data))
+        self.assertIn(
+            'List of items or filters must be provided for bulk deletion',
+            str(response.data),
+        )
 
         # DELETE with invalid 'items'
-        response = self.delete(
-            url,
-            {
-                'items': {"hello": "world"},
-            },
-            expected_code=400,
-        )
+        response = self.delete(url, {'items': {'hello': 'world'}}, expected_code=400)
 
         self.assertIn("'items' must be supplied as a list object", str(response.data))
 
         # DELETE with invalid 'filters'
-        response = self.delete(
-            url,
-            {
-                'filters': [1, 2, 3],
-            },
-            expected_code=400,
-        )
+        response = self.delete(url, {'filters': [1, 2, 3]}, expected_code=400)
 
         self.assertIn("'filters' must be supplied as a dict object", str(response.data))
 
 
 class SearchTests(InvenTreeAPITestCase):
-    """Unit tests for global search endpoint"""
+    """Unit tests for global search endpoint."""
 
     fixtures = [
         'category',
@@ -317,18 +298,20 @@ class SearchTests(InvenTreeAPITestCase):
         'sales_order',
     ]
 
-    def test_results(self):
-        """Test individual result types"""
+    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'),
-            {
-                'search': 'chair',
-                'limit': 3,
-                'part': {},
-                'build': {},
-            },
-            expected_code=200
+            {'search': 'chair', 'limit': 3, 'part': {}, 'build': {}},
+            expected_code=200,
         )
 
         # No build results
@@ -345,12 +328,7 @@ class SearchTests(InvenTreeAPITestCase):
         # Search for orders
         response = self.post(
             reverse('api-search'),
-            {
-                'search': '01',
-                'limit': 2,
-                'purchaseorder': {},
-                'salesorder': {},
-            },
+            {'search': '01', 'limit': 2, 'purchaseorder': {}, 'salesorder': {}},
             expected_code=200,
         )
 
@@ -361,8 +339,7 @@ class SearchTests(InvenTreeAPITestCase):
         self.assertNotIn('build', response.data)
 
     def test_permissions(self):
-        """Test that users with insufficient permissions are handled correctly"""
-
+        """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
@@ -384,33 +361,25 @@ class SearchTests(InvenTreeAPITestCase):
             'salesorder',
         ]
 
-        query = {
-            'search': 'c',
-            'limit': 3,
-        }
+        query = {'search': 'c', 'limit': 3}
 
         for mdl in models:
             query[mdl] = {}
 
-        response = self.post(
-            reverse('api-search'),
-            query,
-            expected_code=200
-        )
+        response = self.post(reverse('api-search'), query, expected_code=200)
 
         # Check for 'permission denied' error
         for mdl in models:
-            self.assertEqual(response.data[mdl]['error'], 'User does not have permission to view this model')
+            self.assertEqual(
+                response.data[mdl]['error'],
+                'User does not have permission to view this model',
+            )
 
         # Assign view roles for some parts
         self.assignRole('build.view')
         self.assignRole('part.view')
 
-        response = self.post(
-            reverse('api-search'),
-            query,
-            expected_code=200
-        )
+        response = self.post(reverse('api-search'), query, expected_code=200)
 
         # Check for expected results, based on permissions
         # We expect results to be returned for the following model types
@@ -430,4 +399,6 @@ class SearchTests(InvenTreeAPITestCase):
                 self.assertIn('count', result)
             else:
                 self.assertIn('error', result)
-                self.assertEqual(result['error'], 'User does not have permission to view this model')
+                self.assertEqual(
+                    result['error'], 'User does not have permission to view this model'
+                )

InvenTree/InvenTree/test_api_version.py

@@ -0,0 +1,45 @@
+"""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)
+
+        response = self.client.get(reverse('api-version'), format='json').json()
+        self.assertIn('version', response)
+        self.assertIn('dev', response)
+        self.assertIn('up_to_date', response)
+
+    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

@@ -2,20 +2,25 @@
 
 from django.conf import settings
 from django.http import Http404
+from django.test import tag
 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
 
 
+# TODO change test to not rely on CUI
+@tag('cui')
 class MiddlewareTests(InvenTreeTestCase):
     """Test for middleware functions."""
 
     def check_path(self, url, code=200, **kwargs):
         """Helper function to run a request."""
-        response = self.client.get(url, HTTP_ACCEPT='application/json', **kwargs)
+        response = self.client.get(
+            url, headers={'accept': 'application/json'}, **kwargs
+        )
         self.assertEqual(response.status_code, code)
         return response
 
@@ -28,13 +33,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
@@ -66,6 +71,7 @@ class MiddlewareTests(InvenTreeTestCase):
 
     def test_error_exceptions(self):
         """Test that ignored errors are not logged."""
+
         def check(excpected_nbr=0):
             # Check that errors are empty
             errors = Error.objects.all()

InvenTree/InvenTree/test_tasks.py

@@ -67,16 +67,24 @@ class InvenTreeTaskTests(TestCase):
 
         # Error runs
         # Malformed taskname
-        with self.assertWarnsMessage(UserWarning, "WARNING: 'InvenTree' not started - Malformed function path"):
+        with self.assertWarnsMessage(
+            UserWarning, "WARNING: 'InvenTree' not started - Malformed function path"
+        ):
             InvenTree.tasks.offload_task('InvenTree')
 
-        # Non exsistent app
-        with self.assertWarnsMessage(UserWarning, "WARNING: 'InvenTreeABC.test_tasks.doesnotmatter' not started - No module named 'InvenTreeABC.test_tasks'"):
+        # 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
-        with self.assertWarnsMessage(UserWarning, "WARNING: 'InvenTree.test_tasks.doesnotexsist' not started - No function named 'doesnotexsist'"):
-            InvenTree.tasks.offload_task('InvenTree.test_tasks.doesnotexsist')
+        # Non existent function
+        with self.assertWarnsMessage(
+            UserWarning,
+            "WARNING: 'InvenTree.test_tasks.doesnotexist' not started - No function named 'doesnotexist'",
+        ):
+            InvenTree.tasks.offload_task('InvenTree.test_tasks.doesnotexist')
 
     def test_task_hearbeat(self):
         """Test the task heartbeat."""
@@ -86,7 +94,9 @@ class InvenTreeTaskTests(TestCase):
         """Test the task delete_successful_tasks."""
         from django_q.models import Success
 
-        Success.objects.create(name='abc', func='abc', stopped=threshold, started=threshold_low)
+        Success.objects.create(
+            name='abc', func='abc', stopped=threshold, started=threshold_low
+        )
         InvenTree.tasks.offload_task(InvenTree.tasks.delete_successful_tasks)
         results = Success.objects.filter(started__lte=threshold)
         self.assertEqual(len(results), 0)
@@ -99,14 +109,14 @@ class InvenTreeTaskTests(TestCase):
         error_obj.save()
 
         # Check that it is not empty
-        errors = Error.objects.filter(when__lte=threshold,)
+        errors = Error.objects.filter(when__lte=threshold)
         self.assertNotEqual(len(errors), 0)
 
         # Run action
         InvenTree.tasks.offload_task(InvenTree.tasks.delete_old_error_logs)
 
         # Check that it is empty again
-        errors = Error.objects.filter(when__lte=threshold,)
+        errors = Error.objects.filter(when__lte=threshold)
         self.assertEqual(len(errors), 0)
 
     def test_task_check_for_updates(self):
@@ -146,7 +156,9 @@ class InvenTreeTaskTests(TestCase):
         # Cleanup
         try:
             migration_name = InvenTree.tasks.get_migration_plan()[0][0].name + '.py'
-            migration_path = settings.BASE_DIR / 'InvenTree' / 'migrations' / migration_name
+            migration_path = (
+                settings.BASE_DIR / 'InvenTree' / 'migrations' / migration_name
+            )
             migration_path.unlink()
         except IndexError:  # pragma: no cover
             pass

InvenTree/InvenTree/test_urls.py

@@ -4,28 +4,29 @@ import os
 import re
 from pathlib import Path
 
-from django.test import TestCase
+from django.test import TestCase, tag
 from django.urls import reverse
 
 
+@tag('cui')
 class URLTest(TestCase):
     """Test all files for broken url tags."""
 
     # 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',
@@ -44,7 +45,7 @@ class URLTest(TestCase):
             ('part', 'templates'),
             ('report', 'templates'),
             ('stock', 'templates'),
-            ('templates', ),
+            ('templates',),
         ]
 
         template_files = []
@@ -53,11 +54,9 @@ class URLTest(TestCase):
         tld = os.path.join(here, '..')
 
         for directory in template_dirs:
-
             template_dir = os.path.join(tld, *directory)
 
             for path in Path(template_dir).rglob(suffix):
-
                 f = os.path.abspath(path)
 
                 if f not in template_files:
@@ -69,25 +68,18 @@ class URLTest(TestCase):
         """Search for all instances of {% url %} in supplied template file."""
         urls = []
 
-        pattern = "{% url ['\"]([^'\"]+)['\"]([^%]*)%}"
+        pattern = '{% url [\'"]([^\'"]+)[\'"]([^%]*)%}'
 
         with open(input_file, 'r') as f:
-
             data = f.read()
 
             results = re.findall(pattern, data)
 
         for result in results:
             if len(result) == 2:
-                urls.append([
-                    result[0].strip(),
-                    result[1].strip()
-                ])
+                urls.append([result[0].strip(), result[1].strip()])
             elif len(result) == 1:  # pragma: no cover
-                urls.append([
-                    result[0].strip(),
-                    ''
-                ])
+                urls.append([result[0].strip(), ''])
 
         return urls
 
@@ -100,16 +92,16 @@ class URLTest(TestCase):
             pk = None
 
         # TODO: Handle reverse lookup of admin URLs!
-        if url.startswith("admin:"):
+        if url.startswith('admin:'):
             return
 
         # TODO can this be more elegant?
-        if url.startswith("account_"):
+        if url.startswith('account_'):
             return
 
         if pk:
             # We will assume that there is at least one item in the database
-            reverse(url, kwargs={"pk": 1})
+            reverse(url, kwargs={'pk': 1})
         else:
             reverse(url)
 
@@ -122,14 +114,14 @@ class URLTest(TestCase):
 
     def test_html_templates(self):
         """Test all HTML templates for broken url tags."""
-        template_files = self.find_files("*.html")
+        template_files = self.find_files('*.html')
 
         for f in template_files:
             self.check_file(f)
 
     def test_js_templates(self):
         """Test all JS templates for broken url tags."""
-        template_files = self.find_files("*.js")
+        template_files = self.find_files('*.js')
 
         for f in template_files:
             self.check_file(f)

InvenTree/InvenTree/test_views.py

@@ -3,9 +3,10 @@
 import os
 
 from django.contrib.auth import get_user_model
+from django.test import tag
 from django.urls import reverse
 
-from InvenTree.helpers import InvenTreeTestCase
+from InvenTree.unit_test import InvenTreeTestCase
 
 
 class ViewTests(InvenTreeTestCase):
@@ -23,18 +24,19 @@ class ViewTests(InvenTreeTestCase):
 
     def test_index_redirect(self):
         """Top-level URL should redirect to "index" page."""
-        response = self.client.get("/")
+        response = self.client.get('/')
 
         self.assertEqual(response.status_code, 302)
 
     def get_index_page(self):
-        """Retrieve the index page (used for subsequent unit tests)"""
-        response = self.client.get("/index/")
+        """Retrieve the index page (used for subsequent unit tests)."""
+        response = self.client.get('/index/')
 
         self.assertEqual(response.status_code, 200)
 
         return str(response.content.decode())
 
+    @tag('cui')
     def test_panels(self):
         """Test that the required 'panels' are present."""
         content = self.get_index_page()
@@ -43,9 +45,9 @@ class ViewTests(InvenTreeTestCase):
 
         # TODO: In future, run the javascript and ensure that the panels get created!
 
+    @tag('cui')
     def test_settings_page(self):
-        """Test that the 'settings' page loads correctly"""
-
+        """Test that the 'settings' page loads correctly."""
         # Settings page loads
         url = reverse('settings')
 
@@ -61,35 +63,20 @@ class ViewTests(InvenTreeTestCase):
         self.assertEqual(response.status_code, 200)
         content = response.content.decode()
 
-        user_panels = [
-            'account',
-            'user-display',
-            'user-home',
-            'user-reports',
-        ]
+        user_panels = ['account', 'user-display', 'user-home', 'user-reports']
 
-        staff_panels = [
-            'server',
-            'login',
-            'barcodes',
-            'pricing',
-            'parts',
-            'stock',
-        ]
+        staff_panels = ['server', 'login', 'barcodes', 'pricing', 'parts', 'stock']
 
-        plugin_panels = [
-            'plugin',
-        ]
+        plugin_panels = ['plugin']
 
         # Default user has staff access, so all panels will be present
         for panel in user_panels + staff_panels + plugin_panels:
-            self.assertIn(f"select-{panel}", content)
-            self.assertIn(f"panel-{panel}", content)
+            self.assertIn(f'select-{panel}', content)
+            self.assertIn(f'panel-{panel}', content)
 
         # Now create a user who does not have staff access
         pleb_user = get_user_model().objects.create_user(
-            username='pleb',
-            password='notstaff',
+            username='pleb', password='notstaff'
         )
 
         pleb_user.groups.add(self.group)
@@ -99,10 +86,7 @@ class ViewTests(InvenTreeTestCase):
 
         self.client.logout()
 
-        result = self.client.login(
-            username='pleb',
-            password='notstaff',
-        )
+        result = self.client.login(username='pleb', password='notstaff')
 
         self.assertTrue(result)
 
@@ -112,23 +96,26 @@ class ViewTests(InvenTreeTestCase):
 
         # Normal user still has access to user-specific panels
         for panel in user_panels:
-            self.assertIn(f"select-{panel}", content)
-            self.assertIn(f"panel-{panel}", content)
+            self.assertIn(f'select-{panel}', content)
+            self.assertIn(f'panel-{panel}', content)
 
         # Normal user does NOT have access to global or plugin settings
         for panel in staff_panels + plugin_panels:
-            self.assertNotIn(f"select-{panel}", content)
-            self.assertNotIn(f"panel-{panel}", content)
+            self.assertNotIn(f'select-{panel}', content)
+            self.assertNotIn(f'panel-{panel}', content)
 
+    # TODO: Replace this with a PUI test
+    @tag('cui')
     def test_url_login(self):
-        """Test logging in via arguments"""
-
+        """Test logging in via arguments."""
         # Log out
         self.client.logout()
-        response = self.client.get("/index/")
+        response = self.client.get('/index/')
         self.assertEqual(response.status_code, 302)
 
         # Try login with url
-        response = self.client.get(f"/accounts/login/?next=/&login={self.username}&password={self.password}")
+        response = self.client.get(
+            f'/accounts/login/?next=/&login={self.username}&password={self.password}'
+        )
         self.assertEqual(response.status_code, 302)
         self.assertEqual(response.url, '/')

InvenTree/InvenTree/tracing.py

@@ -0,0 +1,146 @@
+"""OpenTelemetry setup functions."""
+
+import base64
+import logging
+from typing import Optional
+
+from opentelemetry import metrics, trace
+from opentelemetry.instrumentation.django import DjangoInstrumentor
+from opentelemetry.instrumentation.redis import RedisInstrumentor
+from opentelemetry.instrumentation.requests import RequestsInstrumentor
+from opentelemetry.sdk import _logs as logs
+from opentelemetry.sdk import resources
+from opentelemetry.sdk._logs import export as logs_export
+from opentelemetry.sdk.metrics import MeterProvider
+from opentelemetry.sdk.metrics.export import (
+    ConsoleMetricExporter,
+    PeriodicExportingMetricReader,
+)
+from opentelemetry.sdk.trace import TracerProvider
+from opentelemetry.sdk.trace.export import BatchSpanProcessor, ConsoleSpanExporter
+
+import InvenTree.ready
+from InvenTree.version import inventreeVersion
+
+# Logger configuration
+logger = logging.getLogger('inventree')
+
+
+def setup_tracing(
+    endpoint: str,
+    headers: dict,
+    resources_input: Optional[dict] = None,
+    console: bool = False,
+    auth: Optional[dict] = None,
+    is_http: bool = False,
+    append_http: bool = True,
+):
+    """Set up tracing for the application in the current context.
+
+    Args:
+        endpoint: The endpoint to send the traces to.
+        headers: The headers to send with the traces.
+        resources_input: The resources to send with the traces.
+        console: Whether to output the traces to the console.
+    """
+    if InvenTree.ready.isImportingData() or InvenTree.ready.isRunningMigrations():
+        return
+
+    if resources_input is None:
+        resources_input = {}
+    if auth is None:
+        auth = {}
+
+    # Setup the auth headers
+    if 'basic' in auth:
+        basic_auth = auth['basic']
+        if 'username' in basic_auth and 'password' in basic_auth:
+            auth_raw = f'{basic_auth["username"]}:{basic_auth["password"]}'
+            auth_token = base64.b64encode(auth_raw.encode('utf-8')).decode('utf-8')
+            headers['Authorization'] = f'Basic {auth_token}'
+        else:
+            logger.warning('Basic auth is missing username or password')
+
+    # Clean up headers
+    headers = {k: v for k, v in headers.items() if v is not None}
+
+    # Initialize the OTLP Resource
+    resource = resources.Resource(
+        attributes={
+            resources.SERVICE_NAME: 'BACKEND',
+            resources.SERVICE_NAMESPACE: 'INVENTREE',
+            resources.SERVICE_VERSION: inventreeVersion(),
+            **resources_input,
+        }
+    )
+
+    # Import the OTLP exporters
+    if is_http:
+        from opentelemetry.exporter.otlp.proto.http._log_exporter import OTLPLogExporter
+        from opentelemetry.exporter.otlp.proto.http.metric_exporter import (
+            OTLPMetricExporter,
+        )
+        from opentelemetry.exporter.otlp.proto.http.trace_exporter import (
+            OTLPSpanExporter,
+        )
+    else:
+        from opentelemetry.exporter.otlp.proto.grpc._log_exporter import OTLPLogExporter
+        from opentelemetry.exporter.otlp.proto.grpc.metric_exporter import (
+            OTLPMetricExporter,
+        )
+        from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import (
+            OTLPSpanExporter,
+        )
+
+    # Spans / Tracs
+    span_exporter = OTLPSpanExporter(
+        headers=headers,
+        endpoint=endpoint if not (is_http and append_http) else f'{endpoint}/v1/traces',
+    )
+    trace_processor = BatchSpanProcessor(span_exporter)
+    trace_provider = TracerProvider(resource=resource)
+    trace.set_tracer_provider(trace_provider)
+    trace_provider.add_span_processor(trace_processor)
+    # For debugging purposes, export the traces to the console
+    if console:
+        trace_provider.add_span_processor(BatchSpanProcessor(ConsoleSpanExporter()))
+
+    # Metrics
+    metric_perodic_reader = PeriodicExportingMetricReader(
+        OTLPMetricExporter(
+            headers=headers,
+            endpoint=endpoint
+            if not (is_http and append_http)
+            else f'{endpoint}/v1/metrics',
+        )
+    )
+    metric_readers = [metric_perodic_reader]
+
+    # For debugging purposes, export the metrics to the console
+    if console:
+        console_metric_exporter = ConsoleMetricExporter()
+        console_metric_reader = PeriodicExportingMetricReader(console_metric_exporter)
+        metric_readers.append(console_metric_reader)
+
+    meter_provider = MeterProvider(resource=resource, metric_readers=metric_readers)
+    metrics.set_meter_provider(meter_provider)
+
+    # Logs
+    log_exporter = OTLPLogExporter(
+        headers=headers,
+        endpoint=endpoint if not (is_http and append_http) else f'{endpoint}/v1/logs',
+    )
+    log_provider = logs.LoggerProvider(resource=resource)
+    log_provider.add_log_record_processor(
+        logs_export.BatchLogRecordProcessor(log_exporter)
+    )
+    handler = logs.LoggingHandler(level=logging.INFO, logger_provider=log_provider)
+    logger = logging.getLogger('inventree')
+    logger.addHandler(handler)
+
+
+def setup_instruments():
+    """Run auto-insturmentation for OpenTelemetry tracing."""
+    DjangoInstrumentor().instrument()
+    RedisInstrumentor().instrument()
+    RequestsInstrumentor().instrument()

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,74 @@ 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.
 
@@ -35,14 +109,12 @@ class UserMixin:
 
     @classmethod
     def setUpTestData(cls):
-        """Run setup for all tests in a given class"""
+        """Run setup for all tests in a given class."""
         super().setUpTestData()
 
         # Create a user to log in with
         cls.user = get_user_model().objects.create_user(
-            username=cls.username,
-            password=cls.password,
-            email=cls.email
+            username=cls.username, password=cls.password, email=cls.email
         )
 
         # Create a group for the user
@@ -67,8 +139,7 @@ class UserMixin:
                 cls.assignRole(role=role, group=cls.group)
 
     def setUp(self):
-        """Run setup for individual test methods"""
-
+        """Run setup for individual test methods."""
         if self.auto_login:
             self.client.login(username=self.username, password=self.password)
 
@@ -81,7 +152,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
 
@@ -90,15 +160,15 @@ class UserMixin:
             raise TypeError('assignRole: assign_all must be a boolean value')
 
         if not role and not assign_all:
-            raise ValueError('assignRole: either role must be provided, or assign_all must be set')
+            raise ValueError(
+                'assignRole: either role must be provided, or assign_all must be set'
+            )
 
         if not assign_all and role:
             rule, perm = role.split('.')
 
         for ruleset in group.rule_sets.all():
-
             if assign_all or ruleset.name == rule:
-
                 if assign_all or perm == 'view':
                     ruleset.can_view = True
                 elif assign_all or perm == 'change':
@@ -128,53 +198,70 @@ class PluginMixin:
 
 
 class ExchangeRateMixin:
-    """Mixin class for generating exchange rate data"""
+    """Mixin class for generating exchange rate data."""
 
     def generate_exchange_rates(self):
-        """Helper function which generates some exchange rates to work with"""
-
-        rates = {
-            'AUD': 1.5,
-            'CAD': 1.7,
-            'GBP': 0.9,
-            'USD': 1.0,
-        }
+        """Helper function which generates some exchange rates to work with."""
+        rates = {'AUD': 1.5, 'CAD': 1.7, 'GBP': 0.9, 'USD': 1.0}
 
         # Create a dummy backend
-        ExchangeBackend.objects.create(
-            name='InvenTreeExchange',
-            base_currency='USD',
-        )
+        ExchangeBackend.objects.create(name='InvenTreeExchange', base_currency='USD')
 
         backend = ExchangeBackend.objects.get(name='InvenTreeExchange')
 
         items = []
 
         for currency, rate in rates.items():
-            items.append(
-                Rate(
-                    currency=currency,
-                    value=rate,
-                    backend=backend,
-                )
-            )
+            items.append(Rate(currency=currency, value=rate, backend=backend))
 
         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."""
 
-    def checkResponse(self, url, method, expected_code, response):
-        """Debug output for an unexpected response"""
+    @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
 
         if expected_code != response.status_code:
-
-            print(f"Unexpected {method} response at '{url}': status_code = {response.status_code}")
+            print(
+                f"Unexpected {method} response at '{url}': status_code = {response.status_code}"
+            )
 
             if hasattr(response, 'data'):
                 print('data:', response.data)
@@ -200,77 +287,78 @@ class InvenTreeAPITestCase(ExchangeRateMixin, UserMixin, APITestCase):
 
         return actions
 
-    def get(self, url, data=None, expected_code=200, format='json'):
+    def get(self, url, data=None, expected_code=200, format='json', **kwargs):
         """Issue a GET request."""
         # Set default - see B006
         if data is None:
             data = {}
 
-        response = self.client.get(url, data, format=format)
+        response = self.client.get(url, data, format=format, **kwargs)
 
         self.checkResponse(url, 'GET', expected_code, response)
 
         return response
 
-    def post(self, url, data=None, expected_code=None, format='json'):
+    def post(self, url, data=None, expected_code=None, format='json', **kwargs):
         """Issue a POST request."""
-
         # Set default value - see B006
         if data is None:
             data = {}
 
-        response = self.client.post(url, data=data, format=format)
+        response = self.client.post(url, data=data, format=format, **kwargs)
 
         self.checkResponse(url, 'POST', expected_code, response)
 
         return response
 
-    def delete(self, url, data=None, expected_code=None, format='json'):
+    def delete(self, url, data=None, expected_code=None, format='json', **kwargs):
         """Issue a DELETE request."""
-
         if data is None:
             data = {}
 
-        response = self.client.delete(url, data=data, format=format)
+        response = self.client.delete(url, data=data, format=format, **kwargs)
 
         self.checkResponse(url, 'DELETE', expected_code, response)
 
         return response
 
-    def patch(self, url, data, expected_code=None, format='json'):
+    def patch(self, url, data, expected_code=None, format='json', **kwargs):
         """Issue a PATCH request."""
-        response = self.client.patch(url, data=data, format=format)
+        response = self.client.patch(url, data=data, format=format, **kwargs)
 
         self.checkResponse(url, 'PATCH', expected_code, response)
 
         return response
 
-    def put(self, url, data, expected_code=None, format='json'):
+    def put(self, url, data, expected_code=None, format='json', **kwargs):
         """Issue a PUT request."""
-        response = self.client.put(url, data=data, format=format)
+        response = self.client.put(url, data=data, format=format, **kwargs)
 
         self.checkResponse(url, 'PUT', expected_code, response)
 
         return response
 
-    def options(self, url, expected_code=None):
+    def options(self, url, expected_code=None, **kwargs):
         """Issue an OPTIONS request."""
-        response = self.client.options(url, format='json')
+        response = self.client.options(url, format='json', **kwargs)
 
         self.checkResponse(url, 'OPTIONS', expected_code, response)
 
         return response
 
-    def download_file(self, url, data, expected_code=None, expected_fn=None, decode=True):
+    def download_file(
+        self, url, data, expected_code=None, expected_fn=None, decode=True
+    ):
         """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):
-            raise ValueError("Response is not a StreamingHttpResponse object as expected")
+            raise ValueError(
+                'Response is not a StreamingHttpResponse object as expected'
+            )
 
         # Extract filename
         disposition = response.headers['Content-Disposition']
@@ -284,27 +372,34 @@ 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,193 +7,454 @@ 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 machine.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 company.urls import company_urls, manufacturer_part_urls, supplier_part_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 api_urls as web_api_urls
+from web.urls import urlpatterns as platform_urls
 
-from .api import APISearchView, InfoView, NotFoundView
-from .views import (AboutView, AppearanceSelectView, CustomConnectionsView,
-                    CustomEmailView, CustomLoginView,
-                    CustomPasswordResetFromKeyView,
-                    CustomSessionDeleteOtherView, CustomSessionDeleteView,
-                    CustomTwoFactorRemove, DatabaseStatsView, DynamicJsView,
-                    EditUserView, IndexView, NotificationsView, SearchView,
-                    SetPasswordView, SettingsView, auth_request)
+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,
+    DatabaseStatsView,
+    DynamicJsView,
+    EditUserView,
+    IndexView,
+    NotificationsView,
+    SearchView,
+    SetPasswordView,
+    SettingsView,
+    auth_request,
+)
 
-admin.site.site_header = "InvenTree Admin"
+admin.site.site_header = 'InvenTree Admin'
 
 
 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)),
-
+    path('settings/', include(common.api.settings_api_urls)),
+    path('part/', include(part.api.part_api_urls)),
+    path('bom/', include(part.api.bom_api_urls)),
+    path('company/', include(company.api.company_api_urls)),
+    path('stock/', include(stock.api.stock_api_urls)),
+    path('build/', include(build.api.build_api_urls)),
+    path('order/', include(order.api.order_api_urls)),
+    path('label/', include(label.api.label_api_urls)),
+    path('report/', include(report.api.report_api_urls)),
+    path('machine/', include(machine.api.machine_api_urls)),
+    path('user/', include(users.api.user_urls)),
+    path('admin/', include(common.api.admin_api_urls)),
+    path('web/', include(web_api_urls)),
     # Plugin endpoints
-    path('', include(plugin_api_urls)),
-
-    # Webhook endpoints
-    path('', include(common_api_urls)),
-
-    # InvenTree information endpoint
-    path('', InfoView.as_view(), name='api-inventree-info'),
-
+    path('', include(plugin.api.plugin_api_urls)),
+    # Common endpoints endpoint
+    path('', include(common.api.common_api_urls)),
+    # OpenAPI Schema
+    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('logout/', users.api.Logout.as_view(), name='api-logout'),
+            path(
+                'login-redirect/',
+                users.api.LoginRedirect.as_view(),
+                name='api-login-redirect',
+            ),
+            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'),
 ]
 
 settings_urls = [
-
-    re_path(r'^i18n/?', include('django.conf.urls.i18n')),
-
-    re_path(r'^appearance/?', AppearanceSelectView.as_view(), name='settings-appearance'),
-
+    path('i18n/', include('django.conf.urls.i18n')),
+    path('appearance/', AppearanceSelectView.as_view(), name='settings-appearance'),
     # Catch any other urls
-    re_path(r'^.*$', SettingsView.as_view(template_name='InvenTree/settings/settings.html'), name='settings'),
+    path(
+        '',
+        SettingsView.as_view(template_name='InvenTree/settings/settings.html'),
+        name='settings',
+    ),
 ]
 
 notifications_urls = [
-
     # Catch any other urls
-    re_path(r'^.*$', NotificationsView.as_view(), name='notifications'),
+    path('', NotificationsView.as_view(), name='notifications')
 ]
 
 # These javascript files are served "dynamically" - i.e. rendered on demand
 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'^settings.js', DynamicJsView.as_view(template_name='js/dynamic/settings.js'), name='settings.js'),
+    path(
+        'calendar.js',
+        DynamicJsView.as_view(template_name='js/dynamic/calendar.js'),
+        name='calendar.js',
+    ),
+    path(
+        'nav.js',
+        DynamicJsView.as_view(template_name='js/dynamic/nav.js'),
+        name='nav.js',
+    ),
+    path(
+        'permissions.js',
+        DynamicJsView.as_view(template_name='js/dynamic/permissions.js'),
+        name='permissions.js',
+    ),
+    path(
+        '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'),
-    re_path(r'^barcode.js', DynamicJsView.as_view(template_name='js/translated/barcode.js'), name='barcode.js'),
-    re_path(r'^bom.js', DynamicJsView.as_view(template_name='js/translated/bom.js'), name='bom.js'),
-    re_path(r'^build.js', DynamicJsView.as_view(template_name='js/translated/build.js'), name='build.js'),
-    re_path(r'^charts.js', DynamicJsView.as_view(template_name='js/translated/charts.js'), name='charts.js'),
-    re_path(r'^company.js', DynamicJsView.as_view(template_name='js/translated/company.js'), name='company.js'),
-    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'^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'),
-    re_path(r'^order.js', DynamicJsView.as_view(template_name='js/translated/order.js'), name='order.js'),
-    re_path(r'^part.js', DynamicJsView.as_view(template_name='js/translated/part.js'), name='part.js'),
-    re_path(r'^purchase_order.js', DynamicJsView.as_view(template_name='js/translated/purchase_order.js'), name='purchase_order.js'),
-    re_path(r'^return_order.js', DynamicJsView.as_view(template_name='js/translated/return_order.js'), name='return_order.js'),
-    re_path(r'^report.js', DynamicJsView.as_view(template_name='js/translated/report.js'), name='report.js'),
-    re_path(r'^sales_order.js', DynamicJsView.as_view(template_name='js/translated/sales_order.js'), name='sales_order.js'),
-    re_path(r'^search.js', DynamicJsView.as_view(template_name='js/translated/search.js'), name='search.js'),
-    re_path(r'^stock.js', DynamicJsView.as_view(template_name='js/translated/stock.js'), name='stock.js'),
-    re_path(r'^status_codes.js', DynamicJsView.as_view(template_name='js/translated/status_codes.js'), name='status_codes.js'),
-    re_path(r'^plugin.js', DynamicJsView.as_view(template_name='js/translated/plugin.js'), name='plugin.js'),
-    re_path(r'^pricing.js', DynamicJsView.as_view(template_name='js/translated/pricing.js'), name='pricing.js'),
-    re_path(r'^news.js', DynamicJsView.as_view(template_name='js/translated/news.js'), name='news.js'),
-    re_path(r'^tables.js', DynamicJsView.as_view(template_name='js/translated/tables.js'), name='tables.js'),
-    re_path(r'^table_filters.js', DynamicJsView.as_view(template_name='js/translated/table_filters.js'), name='table_filters.js'),
-    re_path(r'^notification.js', DynamicJsView.as_view(template_name='js/translated/notification.js'), name='notification.js'),
+    path(
+        'api.js',
+        DynamicJsView.as_view(template_name='js/translated/api.js'),
+        name='api.js',
+    ),
+    path(
+        'attachment.js',
+        DynamicJsView.as_view(template_name='js/translated/attachment.js'),
+        name='attachment.js',
+    ),
+    path(
+        'barcode.js',
+        DynamicJsView.as_view(template_name='js/translated/barcode.js'),
+        name='barcode.js',
+    ),
+    path(
+        'bom.js',
+        DynamicJsView.as_view(template_name='js/translated/bom.js'),
+        name='bom.js',
+    ),
+    path(
+        'build.js',
+        DynamicJsView.as_view(template_name='js/translated/build.js'),
+        name='build.js',
+    ),
+    path(
+        'charts.js',
+        DynamicJsView.as_view(template_name='js/translated/charts.js'),
+        name='charts.js',
+    ),
+    path(
+        'company.js',
+        DynamicJsView.as_view(template_name='js/translated/company.js'),
+        name='company.js',
+    ),
+    path(
+        'filters.js',
+        DynamicJsView.as_view(template_name='js/translated/filters.js'),
+        name='filters.js',
+    ),
+    path(
+        'forms.js',
+        DynamicJsView.as_view(template_name='js/translated/forms.js'),
+        name='forms.js',
+    ),
+    path(
+        'helpers.js',
+        DynamicJsView.as_view(template_name='js/translated/helpers.js'),
+        name='helpers.js',
+    ),
+    path(
+        'index.js',
+        DynamicJsView.as_view(template_name='js/translated/index.js'),
+        name='index.js',
+    ),
+    path(
+        'label.js',
+        DynamicJsView.as_view(template_name='js/translated/label.js'),
+        name='label.js',
+    ),
+    path(
+        'model_renderers.js',
+        DynamicJsView.as_view(template_name='js/translated/model_renderers.js'),
+        name='model_renderers.js',
+    ),
+    path(
+        'modals.js',
+        DynamicJsView.as_view(template_name='js/translated/modals.js'),
+        name='modals.js',
+    ),
+    path(
+        'order.js',
+        DynamicJsView.as_view(template_name='js/translated/order.js'),
+        name='order.js',
+    ),
+    path(
+        'part.js',
+        DynamicJsView.as_view(template_name='js/translated/part.js'),
+        name='part.js',
+    ),
+    path(
+        'purchase_order.js',
+        DynamicJsView.as_view(template_name='js/translated/purchase_order.js'),
+        name='purchase_order.js',
+    ),
+    path(
+        'return_order.js',
+        DynamicJsView.as_view(template_name='js/translated/return_order.js'),
+        name='return_order.js',
+    ),
+    path(
+        'report.js',
+        DynamicJsView.as_view(template_name='js/translated/report.js'),
+        name='report.js',
+    ),
+    path(
+        'sales_order.js',
+        DynamicJsView.as_view(template_name='js/translated/sales_order.js'),
+        name='sales_order.js',
+    ),
+    path(
+        'search.js',
+        DynamicJsView.as_view(template_name='js/translated/search.js'),
+        name='search.js',
+    ),
+    path(
+        'stock.js',
+        DynamicJsView.as_view(template_name='js/translated/stock.js'),
+        name='stock.js',
+    ),
+    path(
+        'status_codes.js',
+        DynamicJsView.as_view(template_name='js/translated/status_codes.js'),
+        name='status_codes.js',
+    ),
+    path(
+        'plugin.js',
+        DynamicJsView.as_view(template_name='js/translated/plugin.js'),
+        name='plugin.js',
+    ),
+    path(
+        'pricing.js',
+        DynamicJsView.as_view(template_name='js/translated/pricing.js'),
+        name='pricing.js',
+    ),
+    path(
+        'news.js',
+        DynamicJsView.as_view(template_name='js/translated/news.js'),
+        name='news.js',
+    ),
+    path(
+        'tables.js',
+        DynamicJsView.as_view(template_name='js/translated/tables.js'),
+        name='tables.js',
+    ),
+    path(
+        'table_filters.js',
+        DynamicJsView.as_view(template_name='js/translated/table_filters.js'),
+        name='table_filters.js',
+    ),
+    path(
+        'notification.js',
+        DynamicJsView.as_view(template_name='js/translated/notification.js'),
+        name='notification.js',
+    ),
 ]
 
 backendpatterns = [
-    # "Dynamic" javascript files which are rendered using InvenTree templating.
-    re_path(r'^js/dynamic/', include(dynamic_javascript_urls)),
-    re_path(r'^js/i18n/', include(translated_javascript_urls)),
-
-    re_path(r'^auth/', include('rest_framework.urls', namespace='rest_framework')),
-    re_path(r'^auth/?', auth_request),
-
-    re_path(r'^api/', include(apipatterns)),
-    re_path(r'^api-doc/', include_docs_urls(title='InvenTree API')),
+    path('auth/', include('rest_framework.urls', namespace='rest_framework')),
+    path('auth/', auth_request),
+    path('api/', include(apipatterns)),
+    path('api-doc/', SpectacularRedocView.as_view(url_name='schema'), name='api-doc'),
 ]
 
-frontendpatterns = [
+if settings.ENABLE_CLASSIC_FRONTEND:
+    # "Dynamic" javascript files which are rendered using InvenTree templating.
+    backendpatterns += [
+        re_path(r'^js/dynamic/', include(dynamic_javascript_urls)),
+        re_path(r'^js/i18n/', include(translated_javascript_urls)),
+    ]
 
+classic_frontendpatterns = [
     # Apps
-    re_path(r'^build/', include(build_urls)),
-    re_path(r'^common/', include(common_urls)),
-    re_path(r'^company/', include(company_urls)),
-    re_path(r'^order/', include(order_urls)),
-    re_path(r'^manufacturer-part/', include(manufacturer_part_urls)),
-    re_path(r'^part/', include(part_urls)),
-    re_path(r'^stock/', include(stock_urls)),
-    re_path(r'^supplier-part/', include(supplier_part_urls)),
-
-    re_path(r'^edit-user/', EditUserView.as_view(), name='edit-user'),
-    re_path(r'^set-password/', SetPasswordView.as_view(), name='set-password'),
-
-    re_path(r'^index/', IndexView.as_view(), name='index'),
-    re_path(r'^notifications/', include(notifications_urls)),
-    re_path(r'^search/', SearchView.as_view(), name='search'),
-    re_path(r'^settings/', include(settings_urls)),
-    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'),
-
+    path('build/', include(build_urls)),
+    path('common/', include(common_urls)),
+    path('company/', include(company_urls)),
+    path('order/', include(order_urls)),
+    path('manufacturer-part/', include(manufacturer_part_urls)),
+    path('part/', include(part_urls)),
+    path('stock/', include(stock_urls)),
+    path('supplier-part/', include(supplier_part_urls)),
+    path('edit-user/', EditUserView.as_view(), name='edit-user'),
+    path('set-password/', SetPasswordView.as_view(), name='set-password'),
+    path('index/', IndexView.as_view(), name='index'),
+    path('notifications/', include(notifications_urls)),
+    path('search/', SearchView.as_view(), name='search'),
+    path('settings/', include(settings_urls)),
+    path('about/', AboutView.as_view(), name='about'),
+    path('stats/', DatabaseStatsView.as_view(), name='stats'),
     # 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', ),
-
+    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',
+    ),
     # Single Sign On / allauth
     # overrides of urlpatterns
-    re_path(r'^accounts/email/', CustomEmailView.as_view(), name='account_email'),
-    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'),
-
+    path('accounts/email/', CustomEmailView.as_view(), name='account_email'),
+    path(
+        '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',
+    ),
     # Override login page
-    re_path("accounts/login/", CustomLoginView.as_view(), name="account_login"),
-
-    re_path(r'^accounts/', include('allauth_2fa.urls')),    # MFA support
-    re_path(r'^accounts/', include('allauth.urls')),        # included urlpatterns
+    path('accounts/login/', CustomLoginView.as_view(), name='account_login'),
+    path('accounts/', include('allauth_2fa.urls')),  # MFA support
+    path('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
+    if not settings.ENABLE_CLASSIC_FRONTEND:
+        # Add a redirect for login views
+        frontendpatterns += [
+            path(
+                'accounts/login/',
+                RedirectView.as_view(url=settings.FRONTEND_URL_BASE, permanent=False),
+                name='account_login',
+            )
+        ]
+
+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:
@@ -203,12 +464,24 @@ if settings.DEBUG:
     # Media file access
     urlpatterns += static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)
 
-    # Debug toolbar access (only allowed in DEBUG mode)
-    if settings.DEBUG_TOOLBAR_ENABLED:
-        import debug_toolbar
-        urlpatterns = [
-            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')]
+urlpatterns += [
+    re_path(
+        r'^.*$',
+        RedirectView.as_view(
+            url='/index/'
+            if settings.ENABLE_CLASSIC_FRONTEND
+            else settings.FRONTEND_URL_BASE,
+            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,29 @@ 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 +91,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
@@ -84,7 +118,7 @@ def validate_overage(value):
         i = Decimal(value)
 
         if i < 0:
-            raise ValidationError(_("Overage value must not be negative"))
+            raise ValidationError(_('Overage value must not be negative'))
 
         # Looks like a number
         return True
@@ -100,17 +134,15 @@ def validate_overage(value):
             f = float(v)
 
             if f < 0:
-                raise ValidationError(_("Overage value must not be negative"))
+                raise ValidationError(_('Overage value must not be negative'))
             elif f > 100:
-                raise ValidationError(_("Overage must not exceed 100%"))
+                raise ValidationError(_('Overage must not exceed 100%'))
 
             return True
         except ValueError:
             pass
 
-    raise ValidationError(
-        _("Invalid value for overage")
-    )
+    raise ValidationError(_('Invalid value for overage'))
 
 
 def validate_part_name_format(value):
@@ -118,7 +150,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
 
@@ -147,8 +178,6 @@ def validate_part_name_format(value):
     try:
         Template(value).render({'part': p})
     except Exception as exc:
-        raise ValidationError({
-            'value': str(exc)
-        })
+        raise ValidationError({'value': str(exc)})
 
     return True

InvenTree/InvenTree/version.py

@@ -4,29 +4,65 @@ 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.14.0'
+
+# 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."""
-    return common.models.InvenTreeSetting.get_setting("INVENTREE_INSTANCE", "")
+    import common.models
+
+    return common.models.InvenTreeSetting.get_setting('INVENTREE_INSTANCE', '')
 
 
 def inventreeInstanceTitle():
     """Returns the InstanceTitle for the current database."""
-    if common.models.InvenTreeSetting.get_setting("INVENTREE_INSTANCE_TITLE", False):
-        return common.models.InvenTreeSetting.get_setting("INVENTREE_INSTANCE", "")
-    else:
-        return 'InvenTree'
+    import common.models
+
+    if common.models.InvenTreeSetting.get_setting('INVENTREE_INSTANCE_TITLE', False):
+        return common.models.InvenTreeSetting.get_setting('INVENTREE_INSTANCE', '')
+    return 'InvenTree'
 
 
 def inventreeVersion():
@@ -39,7 +75,7 @@ def inventreeVersionTuple(version=None):
     if version is None:
         version = INVENTREE_SW_VERSION
 
-    match = re.match(r"^.*(\d+)\.(\d+)\.(\d+).*$", str(version))
+    match = re.match(r'^.*(\d+)\.(\d+)\.(\d+).*$', str(version))
 
     return [int(g) for g in match.groups()]
 
@@ -56,9 +92,29 @@ def inventreeDocsVersion():
     Release -> "major.minor.sub" e.g. "0.5.2"
     """
     if isInvenTreeDevelopmentVersion():
-        return "latest"
-    else:
-        return INVENTREE_SW_VERSION  # pragma: no cover
+        return 'latest'
+    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,7 +122,11 @@ def isInvenTreeUpToDate():
 
     A background task periodically queries GitHub for latest version, and stores it to the database as "_INVENTREE_LATEST_VERSION"
     """
-    latest = common.models.InvenTreeSetting.get_setting('_INVENTREE_LATEST_VERSION', backup_value=None, create=False)
+    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!
     if not latest:
@@ -84,11 +144,64 @@ 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 +210,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 +223,63 @@ 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,12 +4,8 @@ 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)
+from django.contrib.auth.mixins import LoginRequiredMixin, PermissionRequiredMixin
 from django.core.exceptions import ValidationError
 from django.http import HttpResponse, HttpResponseRedirect, JsonResponse
 from django.shortcuts import redirect
@@ -23,21 +19,19 @@ from django.views.generic.base import RedirectView, TemplateView
 
 from allauth.account.forms import AddEmailForm
 from allauth.account.models import EmailAddress
-from allauth.account.views import (EmailView, LoginView,
-                                   PasswordResetFromKeyView)
+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 +41,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):
@@ -109,7 +102,6 @@ class InvenTreeRoleMixin(PermissionRequiredMixin):
             return True
 
         for required in roles_required:
-
             (role, permission) = required.split('.')
 
             if role not in RuleSet.RULESET_NAMES:
@@ -143,12 +135,14 @@ class InvenTreeRoleMixin(PermissionRequiredMixin):
             app_label = model._meta.app_label
             model_name = model._meta.model_name
 
-            table = f"{app_label}_{model_name}"
+            table = f'{app_label}_{model_name}'
 
             permission = self.get_permission_class()
 
             if not permission:
-                raise AttributeError(f"permission_class not defined for {type(self).__name__}")
+                raise AttributeError(
+                    f'permission_class not defined for {type(self).__name__}'
+                )
 
             # Check if the user has the required permission
             return RuleSet.check_table_permission(user, table, permission)
@@ -187,7 +181,6 @@ class InvenTreeRoleMixin(PermissionRequiredMixin):
         }
 
         for view_class in permission_map.keys():
-
             if issubclass(type(self), view_class):
                 return permission_map[view_class]
 
@@ -226,8 +219,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 +256,7 @@ class AjaxMixin(InvenTreeRoleMixin):
         if not data:
             data = {}
 
-        if not request.is_ajax():
+        if not is_ajax(request):
             return HttpResponseRedirect('/')
 
         if context is None:
@@ -288,9 +280,7 @@ class AjaxMixin(InvenTreeRoleMixin):
         data['title'] = self.get_form_title()
 
         data['html_form'] = render_to_string(
-            self.ajax_template_name,
-            context,
-            request=request
+            self.ajax_template_name, context, request=request
         )
 
         # Custom feedback`data
@@ -335,14 +325,16 @@ class AjaxUpdateView(AjaxMixin, UpdateView):
         """
         super(UpdateView, self).get(request, *args, **kwargs)
 
-        return self.renderJsonResponse(request, self.get_form(), context=self.get_context_data())
+        return self.renderJsonResponse(
+            request, self.get_form(), context=self.get_context_data()
+        )
 
     def save(self, object, form, **kwargs):
         """Method for updating the object in the database. Default implementation is very simple, but can be overridden if required.
 
         Args:
-            object - The current object, to be updated
-            form - The validated form
+            object: The current object, to be updated
+            form: The validated form
 
         Returns:
             object instance for supplied form
@@ -357,7 +349,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
 
@@ -385,8 +377,7 @@ class AjaxUpdateView(AjaxMixin, UpdateView):
             data[key] = value
 
         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()
@@ -405,8 +396,8 @@ class AjaxUpdateView(AjaxMixin, UpdateView):
 class EditUserView(AjaxUpdateView):
     """View for editing user information."""
 
-    ajax_template_name = "modal_form.html"
-    ajax_form_title = _("Edit User Information")
+    ajax_template_name = 'modal_form.html'
+    ajax_form_title = _('Edit User Information')
     form_class = EditUserForm
 
     def get_object(self):
@@ -417,8 +408,8 @@ class EditUserView(AjaxUpdateView):
 class SetPasswordView(AjaxUpdateView):
     """View for setting user password."""
 
-    ajax_template_name = "InvenTree/password.html"
-    ajax_form_title = _("Set Password")
+    ajax_template_name = 'InvenTree/password.html'
+    ajax_form_title = _('Set Password')
     form_class = SetPasswordForm
 
     def get_object(self):
@@ -447,8 +438,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
 
@@ -501,54 +491,52 @@ class SearchView(TemplateView):
 class DynamicJsView(TemplateView):
     """View for returning javacsript files, which instead of being served dynamically, are passed through the django translation engine!"""
 
-    template_name = ""
+    template_name = ''
     content_type = 'text/javascript'
 
 
 class SettingsView(TemplateView):
     """View for configuring User settings."""
 
-    template_name = "InvenTree/settings/settings.html"
+    template_name = 'InvenTree/settings/settings.html'
 
     def get_context_data(self, **kwargs):
         """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")
+        ctx['rates'] = Rate.objects.filter(backend='InvenTreeExchange')
 
-        ctx["categories"] = PartCategory.objects.all().order_by('tree_id', 'lft', 'name')
+        ctx['categories'] = PartCategory.objects.all().order_by(
+            'tree_id', 'lft', 'name'
+        )
 
         # 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"] = {}
+            ctx['rates_updated'] = None
 
         # Forms and context for allauth
         ctx['add_email_form'] = AddEmailForm
-        ctx["can_add_email"] = EmailAddress.objects.can_add_email(self.request.user)
+        ctx['can_add_email'] = EmailAddress.objects.can_add_email(self.request.user)
 
         # Form and context for allauth social-accounts
-        ctx["request"] = self.request
+        ctx['request'] = self.request
         ctx['social_form'] = DisconnectForm(request=self.request)
 
         # user db sessions
         ctx['session_key'] = self.request.session.session_key
-        ctx['session_list'] = self.request.user.session_set.filter(expire_date__gt=now()).order_by('-last_activity')
+        ctx['session_list'] = self.request.user.session_set.filter(
+            expire_date__gt=now()
+        ).order_by('-last_activity')
 
         return ctx
 
@@ -563,20 +551,23 @@ class AllauthOverrides(LoginRequiredMixin):
 
 class CustomEmailView(AllauthOverrides, EmailView):
     """Override of allauths EmailView to always show the settings but leave the functions allow."""
-    success_url = reverse_lazy("settings")
+
+    success_url = reverse_lazy('settings')
 
 
 class CustomConnectionsView(AllauthOverrides, ConnectionsView):
     """Override of allauths ConnectionsView to always show the settings but leave the functions allow."""
-    success_url = reverse_lazy("settings")
+
+    success_url = reverse_lazy('settings')
 
 
 class CustomPasswordResetFromKeyView(PasswordResetFromKeyView):
     """Override of allauths PasswordResetFromKeyView to always show the settings but leave the functions allow."""
-    success_url = reverse_lazy("account_login")
+
+    success_url = reverse_lazy('account_login')
 
 
-class UserSessionOverride():
+class UserSessionOverride:
     """Overrides sucessurl to lead to settings."""
 
     def get_success_url(self):
@@ -586,11 +577,13 @@ class UserSessionOverride():
 
 class CustomSessionDeleteView(UserSessionOverride, SessionDeleteView):
     """Revert to settings after session delete."""
+
     pass
 
 
 class CustomSessionDeleteOtherView(UserSessionOverride, SessionDeleteOtherView):
     """Revert to settings after session delete."""
+
     pass
 
 
@@ -620,8 +613,10 @@ 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 +630,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'))
 
@@ -647,24 +646,18 @@ class AppearanceSelectView(RedirectView):
 class DatabaseStatsView(AjaxView):
     """View for displaying database statistics."""
 
-    ajax_template_name = "stats.html"
-    ajax_form_title = _("System Information")
+    ajax_template_name = 'stats.html'
+    ajax_form_title = _('System Information')
 
 
 class AboutView(AjaxView):
-    """A view for displaying InvenTree version information"""
+    """A view for displaying InvenTree version information."""
 
-    ajax_template_name = "about.html"
-    ajax_form_title = _("About InvenTree")
+    ajax_template_name = 'about.html'
+    ajax_form_title = _('About InvenTree')
 
 
 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")
+    template_name = 'InvenTree/notifications/notifications.html'

InvenTree/InvenTree/wsgi.py

@@ -10,6 +10,8 @@ import os  # pragma: no cover
 
 from django.core.wsgi import get_wsgi_application  # pragma: no cover
 
-os.environ.setdefault("DJANGO_SETTINGS_MODULE", "InvenTree.settings")  # pragma: no cover
+os.environ.setdefault(
+    'DJANGO_SETTINGS_MODULE', 'InvenTree.settings'
+)  # pragma: no cover
 
 application = get_wsgi_application()  # pragma: no cover

InvenTree/_testfolder/.gitignore

@@ -0,0 +1,8 @@
+# Files used for testing
+dummy_image.*
+_tmp.csv
+part_image_123abc.png
+label.pdf
+label.png
+my_special*
+_tests*.txt

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
 
@@ -51,6 +51,7 @@ class BuildResource(InvenTreeResource):
     notes = Field(attribute='notes')
 
 
+@admin.register(Build)
 class BuildAdmin(ImportExportModelAdmin):
     """Class for managing the Build model via the admin interface"""
 
@@ -83,22 +84,34 @@ class BuildAdmin(ImportExportModelAdmin):
     ]
 
 
+@admin.register(BuildItem)
 class BuildItemAdmin(admin.ModelAdmin):
-    """Class for managing the BuildItem model via the admin interface"""
+    """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',
     ]
 
 
-admin.site.register(Build, BuildAdmin)
-admin.site.register(BuildItem, BuildItemAdmin)
+@admin.register(BuildLine)
+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',
+    ]

InvenTree/build/api.py

@@ -1,6 +1,7 @@
 """JSON API for the Build app."""
 
-from django.urls import include, path, re_path
+from django.db.models import F, Q
+from django.urls import include, 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,125 @@ 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_source_build(self) -> Build:
+        """Return the source Build object for the BuildLine queryset.
+
+        This source build is used to filter the available stock for each BuildLine.
+
+        - If this is a "detail" view, use the build associated with the line
+        - If this is a "list" view, use the build associated with the request
+        """
+        raise NotImplementedError("get_source_build must be implemented in the child class")
+
+    def get_queryset(self):
+        """Override queryset to select-related and annotate"""
+        queryset = super().get_queryset()
+        source_build = self.get_source_build()
+        queryset = build.serializers.BuildLineSerializer.annotate_queryset(queryset, build=source_build)
+
+        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',
+    ]
+
+    def get_source_build(self) -> Build:
+        """Return the target build for the BuildLine queryset."""
+
+        try:
+            build_id = self.request.query_params.get('build', None)
+            if build_id:
+                build = Build.objects.get(pk=build_id)
+                return build
+        except (Build.DoesNotExist, AttributeError, ValueError):
+            pass
+
+        return None
+
+class BuildLineDetail(BuildLineEndpoint, RetrieveUpdateDestroyAPI):
+    """API endpoint for detail view of a BuildLine object."""
+
+    def get_source_build(self) -> Build:
+        """Return the target source location for the BuildLine queryset."""
+
+        return None
+
+
 class BuildOrderContextMixin:
     """Mixin class which adds build order as serializer context variable."""
 
@@ -276,6 +411,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 +507,8 @@ class BuildItemFilter(rest_filters.FilterSet):
         """Metaclass option"""
         model = BuildItem
         fields = [
-            'build',
+            'build_line',
             'stock_item',
-            'bom_item',
             'install_into',
         ]
 
@@ -370,14 +517,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 +546,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 +559,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 +570,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 +598,6 @@ class BuildAttachmentList(AttachmentMixin, ListCreateDestroyAPIView):
     queryset = BuildOrderAttachment.objects.all()
     serializer_class = build.serializers.BuildAttachmentSerializer
 
-    filter_backends = [
-        DjangoFilterBackend,
-    ]
-
     filterset_fields = [
         'build',
     ]
@@ -468,37 +613,44 @@ class BuildAttachmentDetail(AttachmentMixin, RetrieveUpdateDestroyAPI):
 build_api_urls = [
 
     # Attachments
-    re_path(r'^attachment/', include([
-        path(r'<int:pk>/', BuildAttachmentDetail.as_view(), name='api-build-attachment-detail'),
-        re_path(r'^.*$', BuildAttachmentList.as_view(), name='api-build-attachment-list'),
+    path('attachment/', include([
+        path('<int:pk>/', BuildAttachmentDetail.as_view(), name='api-build-attachment-detail'),
+        path('', BuildAttachmentList.as_view(), name='api-build-attachment-list'),
+    ])),
+
+    # Build lines
+    path('line/', include([
+        path('<int:pk>/', BuildLineDetail.as_view(), name='api-build-line-detail'),
+        path('', BuildLineList.as_view(), name='api-build-line-list'),
     ])),
 
     # Build Items
-    re_path(r'^item/', include([
-        path(r'<int:pk>/', include([
-            re_path(r'^metadata/', MetadataView.as_view(), {'model': BuildItem}, name='api-build-item-metadata'),
-            re_path(r'^.*$', BuildItemDetail.as_view(), name='api-build-item-detail'),
+    path('item/', include([
+        path('<int:pk>/', include([
+            path('metadata/', MetadataView.as_view(), {'model': BuildItem}, name='api-build-item-metadata'),
+            path('', BuildItemDetail.as_view(), name='api-build-item-detail'),
         ])),
-        re_path(r'^.*$', BuildItemList.as_view(), name='api-build-item-list'),
+        path('', BuildItemList.as_view(), name='api-build-item-list'),
     ])),
 
     # Build Detail
-    path(r'<int:pk>/', include([
-        re_path(r'^allocate/', BuildAllocate.as_view(), name='api-build-allocate'),
-        re_path(r'^auto-allocate/', BuildAutoAllocate.as_view(), name='api-build-auto-allocate'),
-        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'^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'),
-        re_path(r'^metadata/', MetadataView.as_view(), {'model': Build}, name='api-build-metadata'),
-        re_path(r'^.*$', BuildDetail.as_view(), name='api-build-detail'),
+    path('<int:pk>/', include([
+        path('allocate/', BuildAllocate.as_view(), name='api-build-allocate'),
+        path('auto-allocate/', BuildAutoAllocate.as_view(), name='api-build-auto-allocate'),
+        path('complete/', BuildOutputComplete.as_view(), name='api-build-output-complete'),
+        path('create-output/', BuildOutputCreate.as_view(), name='api-build-output-create'),
+        path('delete-outputs/', BuildOutputDelete.as_view(), name='api-build-output-delete'),
+        path('scrap-outputs/', BuildOutputScrap.as_view(), name='api-build-output-scrap'),
+        path('finish/', BuildFinish.as_view(), name='api-build-finish'),
+        path('cancel/', BuildCancel.as_view(), name='api-build-cancel'),
+        path('unallocate/', BuildUnallocate.as_view(), name='api-build-unallocate'),
+        path('metadata/', MetadataView.as_view(), {'model': Build}, name='api-build-metadata'),
+        path('', BuildDetail.as_view(), name='api-build-detail'),
     ])),
 
     # Build order status code information
-    re_path(r'status/', StatusView.as_view(), {StatusView.MODEL_REF: BuildStatus}, name='api-build-status-codes'),
+    path('status/', StatusView.as_view(), {StatusView.MODEL_REF: BuildStatus}, name='api-build-status-codes'),
 
     # Build List
-    re_path(r'^.*$', BuildList.as_view(), name='api-build-list'),
+    path('', BuildList.as_view(), name='api-build-list'),
 ]

InvenTree/build/migrations/0013_auto_20200425_0507.py

@@ -3,16 +3,6 @@
 from django.db import migrations, models
 import django.db.models.deletion
 import mptt.fields
-from build.models import Build
-
-
-def update_tree(apps, schema_editor):
-    # Update the Build MPTT model
-    Build.objects.rebuild()
-
-
-def nupdate_tree(apps, schema_editor):  # pragma: no cover
-    pass
 
 
 class Migration(migrations.Migration):
@@ -53,5 +43,4 @@ 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),
     ]