mirror of
https://github.com/paperless-ngx/paperless-ngx.git
synced 2026-10-03 14:50:31 +00:00
Compare commits
81
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
6ce43be400 | ||
|
|
0204009b66 | ||
|
|
cec0b99d2e | ||
|
|
3615a5a2a5 | ||
|
|
56687614df | ||
|
|
f1ae9c00ac | ||
|
|
bc2ff953ed | ||
|
|
e17689a91b | ||
|
|
764d1a492d | ||
|
|
9d50a3b261 | ||
|
|
da3de299fc | ||
|
|
3a022e2dc4 | ||
|
|
58bda48682 | ||
|
|
b2a2e15ead | ||
|
|
e865185425 | ||
|
|
d02c19a09e | ||
|
|
4a106454ce | ||
|
|
4254100fae | ||
|
|
74f727b1f3 | ||
|
|
fb6fad952e | ||
|
|
f9b4e0c8e0 | ||
|
|
e5041097af | ||
|
|
61f36eb253 | ||
|
|
e50bcc2efb | ||
|
|
88000aab45 | ||
|
|
01b4ab392c | ||
|
|
52aa8758e3 | ||
|
|
4b7cc1c0c3 | ||
|
|
f02d7455be | ||
|
|
a61c35fcd8 | ||
|
|
64552d5d5b | ||
|
|
a59edf3e5b | ||
|
|
6a5d06ee26 | ||
|
|
126ec414a8 | ||
|
|
773744d04b | ||
|
|
7b98085b31 | ||
|
|
b3bf220f56 | ||
|
|
d4429c3cc7 | ||
|
|
4f777d7438 | ||
|
|
2a44d8b5ba | ||
|
|
abf5050ea7 | ||
|
|
091ddf7c45 | ||
|
|
c9f7f2cfbe | ||
|
|
b457610ffb | ||
|
|
969c2ea0e2 | ||
|
|
31b806a285 | ||
|
|
99851b418c | ||
|
|
e34eda07bb | ||
|
|
793459b416 | ||
|
|
04297fd02c | ||
|
|
1b277dd8e1 | ||
|
|
3c20abeb4c | ||
|
|
b11f1f8459 | ||
|
|
7424e7ce0b | ||
|
|
a53a3d3769 | ||
|
|
15b73b890c | ||
|
|
02d355061f | ||
|
|
d8b5b4d447 | ||
|
|
03ac4aed7e | ||
|
|
90d23bad9c | ||
|
|
e4367b5648 | ||
|
|
cb85441c2f | ||
|
|
cceaa559d4 | ||
|
|
a748d4c64f | ||
|
|
452ed005bd | ||
|
|
40058ff7d5 | ||
|
|
f502cd5e34 | ||
|
|
99ce6b5db3 | ||
|
|
2d955e9697 | ||
|
|
f440e8d33c | ||
|
|
4c264651e8 | ||
|
|
48d97b78bb | ||
|
|
659a0cb2ef | ||
|
|
d02d1e1711 | ||
|
|
3b41810e7b | ||
|
|
12314fcaa8 | ||
|
|
8705bd510a | ||
|
|
7575d60782 | ||
|
|
8b02a23b86 | ||
|
|
87d157096e | ||
|
|
54e332d259 |
@@ -15,6 +15,8 @@
|
|||||||
# Test related
|
# Test related
|
||||||
**/.pytest_cache
|
**/.pytest_cache
|
||||||
**/tests
|
**/tests
|
||||||
|
src/paperless_testing
|
||||||
|
src/conftest.py
|
||||||
**/*.spec.ts
|
**/*.spec.ts
|
||||||
**/htmlcov
|
**/htmlcov
|
||||||
# Local folders
|
# Local folders
|
||||||
|
|||||||
@@ -0,0 +1,53 @@
|
|||||||
|
name: Install apt packages
|
||||||
|
description: >
|
||||||
|
Installs apt packages with a per-attempt timeout and retries. The hosted runner's Azure apt mirror intermittently serves archives at a crawl, which apt's own timeout does not catch. A stuck attempt is killed and retried, which usually lands on a healthy mirror node.
|
||||||
|
|
||||||
|
inputs:
|
||||||
|
packages:
|
||||||
|
description: Space separated list of packages to install
|
||||||
|
required: true
|
||||||
|
attempts:
|
||||||
|
description: Maximum number of attempts
|
||||||
|
default: "3"
|
||||||
|
attempt-timeout:
|
||||||
|
description: Seconds before a single attempt is killed
|
||||||
|
default: "180"
|
||||||
|
runs:
|
||||||
|
using: composite
|
||||||
|
steps:
|
||||||
|
- name: Install ${{ inputs.packages }}
|
||||||
|
shell: bash
|
||||||
|
env:
|
||||||
|
PACKAGES: ${{ inputs.packages }}
|
||||||
|
ATTEMPTS: ${{ inputs.attempts }}
|
||||||
|
ATTEMPT_TIMEOUT: ${{ inputs.attempt-timeout }}
|
||||||
|
run: |
|
||||||
|
SUDO=""
|
||||||
|
if [ "$(id -u)" -ne 0 ]; then
|
||||||
|
SUDO="sudo"
|
||||||
|
fi
|
||||||
|
|
||||||
|
attempt_install() {
|
||||||
|
$SUDO apt-get update -q
|
||||||
|
# Intentionally unquoted, this is a list of package names
|
||||||
|
$SUDO apt-get install -q --yes --no-install-recommends $PACKAGES
|
||||||
|
}
|
||||||
|
export -f attempt_install
|
||||||
|
export SUDO PACKAGES
|
||||||
|
|
||||||
|
for attempt in $(seq 1 "${ATTEMPTS}"); do
|
||||||
|
echo "::group::apt install attempt ${attempt}/${ATTEMPTS}"
|
||||||
|
start=$(date +%s)
|
||||||
|
if timeout --kill-after=10 "${ATTEMPT_TIMEOUT}" bash -c attempt_install; then
|
||||||
|
echo "::endgroup::"
|
||||||
|
echo "Installed in $(( $(date +%s) - start ))s"
|
||||||
|
exit 0
|
||||||
|
fi
|
||||||
|
echo "::endgroup::"
|
||||||
|
echo "::warning::apt install attempt ${attempt}/${ATTEMPTS} failed or exceeded ${ATTEMPT_TIMEOUT}s"
|
||||||
|
# A killed attempt can leave dpkg half configured
|
||||||
|
$SUDO dpkg --configure -a || true
|
||||||
|
done
|
||||||
|
|
||||||
|
echo "::error::apt install failed after ${ATTEMPTS} attempts"
|
||||||
|
exit 1
|
||||||
@@ -59,7 +59,6 @@ updates:
|
|||||||
- "drf-*"
|
- "drf-*"
|
||||||
- "djangorestframework"
|
- "djangorestframework"
|
||||||
- "whitenoise"
|
- "whitenoise"
|
||||||
- "bleach"
|
|
||||||
- "jinja2"
|
- "jinja2"
|
||||||
# Async, Task Queuing & Caching
|
# Async, Task Queuing & Caching
|
||||||
async-tasks:
|
async-tasks:
|
||||||
|
|||||||
@@ -102,17 +102,16 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
python-version: "${{ matrix.python-version }}"
|
python-version: "${{ matrix.python-version }}"
|
||||||
- name: Install uv
|
- name: Install uv
|
||||||
uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
|
uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
|
||||||
with:
|
with:
|
||||||
version: ${{ env.DEFAULT_UV_VERSION }}
|
version: ${{ env.DEFAULT_UV_VERSION }}
|
||||||
enable-cache: true
|
enable-cache: true
|
||||||
python-version: ${{ steps.setup-python.outputs.python-version }}
|
python-version: ${{ steps.setup-python.outputs.python-version }}
|
||||||
- name: Install system dependencies
|
- name: Install system dependencies
|
||||||
timeout-minutes: 10
|
timeout-minutes: 12
|
||||||
run: |
|
uses: $/.github/actions/apt-install
|
||||||
sudo apt-get update -qq
|
with:
|
||||||
sudo apt-get install -qq --no-install-recommends \
|
packages: unpaper tesseract-ocr imagemagick ghostscript poppler-utils
|
||||||
unpaper tesseract-ocr imagemagick ghostscript poppler-utils
|
|
||||||
- name: Configure ImageMagick
|
- name: Configure ImageMagick
|
||||||
run: |
|
run: |
|
||||||
sudo cp docker/rootfs/etc/ImageMagick-6/paperless-policy.xml /etc/ImageMagick-6/policy.xml
|
sudo cp docker/rootfs/etc/ImageMagick-6/paperless-policy.xml /etc/ImageMagick-6/policy.xml
|
||||||
@@ -139,13 +138,13 @@ jobs:
|
|||||||
pytest
|
pytest
|
||||||
- name: Upload test results to Codecov
|
- name: Upload test results to Codecov
|
||||||
if: always()
|
if: always()
|
||||||
uses: codecov/codecov-action@fb8b3582c8e4def4969c97caa2f19720cb33a72f # v7.0.0
|
uses: codecov/codecov-action@303a32d7a59b442fa8d48b6a1cc6825c09c847a5 # v7.1.1
|
||||||
with:
|
with:
|
||||||
flags: backend-python-${{ matrix.python-version }}
|
flags: backend-python-${{ matrix.python-version }}
|
||||||
files: junit.xml
|
files: junit.xml
|
||||||
report_type: test_results
|
report_type: test_results
|
||||||
- name: Upload coverage to Codecov
|
- name: Upload coverage to Codecov
|
||||||
uses: codecov/codecov-action@fb8b3582c8e4def4969c97caa2f19720cb33a72f # v7.0.0
|
uses: codecov/codecov-action@303a32d7a59b442fa8d48b6a1cc6825c09c847a5 # v7.1.1
|
||||||
with:
|
with:
|
||||||
flags: backend-python-${{ matrix.python-version }}
|
flags: backend-python-${{ matrix.python-version }}
|
||||||
files: coverage.xml
|
files: coverage.xml
|
||||||
@@ -176,7 +175,7 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
python-version: "${{ env.DEFAULT_PYTHON }}"
|
python-version: "${{ env.DEFAULT_PYTHON }}"
|
||||||
- name: Install uv
|
- name: Install uv
|
||||||
uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
|
uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
|
||||||
with:
|
with:
|
||||||
version: ${{ env.DEFAULT_UV_VERSION }}
|
version: ${{ env.DEFAULT_UV_VERSION }}
|
||||||
enable-cache: true
|
enable-cache: true
|
||||||
|
|||||||
@@ -106,7 +106,7 @@ jobs:
|
|||||||
echo "repository=${repo_name}"
|
echo "repository=${repo_name}"
|
||||||
echo "name=${repo_name}" >> $GITHUB_OUTPUT
|
echo "name=${repo_name}" >> $GITHUB_OUTPUT
|
||||||
- name: Set up Docker Buildx
|
- name: Set up Docker Buildx
|
||||||
uses: docker/setup-buildx-action@37fe631027851001ddb9b187196cc803df7f5f0e # v4.3.0
|
uses: docker/setup-buildx-action@f87e5991a6d7451dcb8d9637bfbc97413f497069 # v4.4.1
|
||||||
- name: Login to GitHub Container Registry
|
- name: Login to GitHub Container Registry
|
||||||
uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4.6.0
|
uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4.6.0
|
||||||
with:
|
with:
|
||||||
@@ -132,7 +132,7 @@ jobs:
|
|||||||
type=semver,pattern={{major}}.{{minor}}
|
type=semver,pattern={{major}}.{{minor}}
|
||||||
- name: Build and push by digest
|
- name: Build and push by digest
|
||||||
id: build
|
id: build
|
||||||
uses: docker/build-push-action@53b7df96c91f9c12dcc8a07bcb9ccacbed38856a # v7.3.0
|
uses: docker/build-push-action@c3c9e263c25d99ce0380d002d59b67737d91b0dc # v7.4.0
|
||||||
with:
|
with:
|
||||||
context: .
|
context: .
|
||||||
file: ./Dockerfile
|
file: ./Dockerfile
|
||||||
@@ -182,7 +182,7 @@ jobs:
|
|||||||
echo "Downloaded digests:"
|
echo "Downloaded digests:"
|
||||||
ls -la /tmp/digests/
|
ls -la /tmp/digests/
|
||||||
- name: Set up Docker Buildx
|
- name: Set up Docker Buildx
|
||||||
uses: docker/setup-buildx-action@37fe631027851001ddb9b187196cc803df7f5f0e # v4.3.0
|
uses: docker/setup-buildx-action@f87e5991a6d7451dcb8d9637bfbc97413f497069 # v4.4.1
|
||||||
- name: Login to GitHub Container Registry
|
- name: Login to GitHub Container Registry
|
||||||
uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4.6.0
|
uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4.6.0
|
||||||
with:
|
with:
|
||||||
|
|||||||
@@ -78,7 +78,7 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
python-version: ${{ env.DEFAULT_PYTHON_VERSION }}
|
python-version: ${{ env.DEFAULT_PYTHON_VERSION }}
|
||||||
- name: Install uv
|
- name: Install uv
|
||||||
uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
|
uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
|
||||||
with:
|
with:
|
||||||
version: ${{ env.DEFAULT_UV_VERSION }}
|
version: ${{ env.DEFAULT_UV_VERSION }}
|
||||||
enable-cache: true
|
enable-cache: true
|
||||||
|
|||||||
@@ -174,13 +174,13 @@ jobs:
|
|||||||
run: cd src-ui && pnpm run test --max-workers=2 --shard=${{ matrix.shard-index }}/${{ matrix.shard-count }}
|
run: cd src-ui && pnpm run test --max-workers=2 --shard=${{ matrix.shard-index }}/${{ matrix.shard-count }}
|
||||||
- name: Upload test results to Codecov
|
- name: Upload test results to Codecov
|
||||||
if: always()
|
if: always()
|
||||||
uses: codecov/codecov-action@fb8b3582c8e4def4969c97caa2f19720cb33a72f # v7.0.0
|
uses: codecov/codecov-action@303a32d7a59b442fa8d48b6a1cc6825c09c847a5 # v7.1.1
|
||||||
with:
|
with:
|
||||||
flags: frontend-node-${{ matrix.node-version }}
|
flags: frontend-node-${{ matrix.node-version }}
|
||||||
directory: src-ui/
|
directory: src-ui/
|
||||||
report_type: test_results
|
report_type: test_results
|
||||||
- name: Upload coverage to Codecov
|
- name: Upload coverage to Codecov
|
||||||
uses: codecov/codecov-action@fb8b3582c8e4def4969c97caa2f19720cb33a72f # v7.0.0
|
uses: codecov/codecov-action@303a32d7a59b442fa8d48b6a1cc6825c09c847a5 # v7.1.1
|
||||||
with:
|
with:
|
||||||
flags: frontend-node-${{ matrix.node-version }}
|
flags: frontend-node-${{ matrix.node-version }}
|
||||||
directory: src-ui/coverage/
|
directory: src-ui/coverage/
|
||||||
@@ -216,7 +216,7 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
python-version: '3.12'
|
python-version: '3.12'
|
||||||
- name: Install uv
|
- name: Install uv
|
||||||
uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
|
uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
|
||||||
with:
|
with:
|
||||||
version: '0.12.x'
|
version: '0.12.x'
|
||||||
enable-cache: false
|
enable-cache: false
|
||||||
@@ -231,9 +231,10 @@ jobs:
|
|||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: cd src-ui && pnpm install --frozen-lockfile
|
run: cd src-ui && pnpm install --frozen-lockfile
|
||||||
- name: Install backend system dependencies
|
- name: Install backend system dependencies
|
||||||
run: |
|
timeout-minutes: 12
|
||||||
apt-get update
|
uses: $/.github/actions/apt-install
|
||||||
apt-get install --yes --quiet --no-install-recommends libmagic1
|
with:
|
||||||
|
packages: libmagic1
|
||||||
- name: Install backend dependencies
|
- name: Install backend dependencies
|
||||||
env:
|
env:
|
||||||
PYTHON_VERSION: ${{ steps.setup-python.outputs.python-version }}
|
PYTHON_VERSION: ${{ steps.setup-python.outputs.python-version }}
|
||||||
|
|||||||
@@ -59,7 +59,7 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
python-version: ${{ env.DEFAULT_PYTHON_VERSION }}
|
python-version: ${{ env.DEFAULT_PYTHON_VERSION }}
|
||||||
- name: Install uv
|
- name: Install uv
|
||||||
uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
|
uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
|
||||||
with:
|
with:
|
||||||
version: ${{ env.DEFAULT_UV_VERSION }}
|
version: ${{ env.DEFAULT_UV_VERSION }}
|
||||||
enable-cache: false
|
enable-cache: false
|
||||||
@@ -70,9 +70,10 @@ jobs:
|
|||||||
run: |
|
run: |
|
||||||
uv sync --python "${PYTHON_VERSION}" --dev --frozen
|
uv sync --python "${PYTHON_VERSION}" --dev --frozen
|
||||||
- name: Install system dependencies
|
- name: Install system dependencies
|
||||||
run: |
|
timeout-minutes: 12
|
||||||
sudo apt-get update -qq
|
uses: $/.github/actions/apt-install
|
||||||
sudo apt-get install -qq --no-install-recommends gettext liblept5
|
with:
|
||||||
|
packages: gettext liblept5
|
||||||
# ---- Build Documentation ----
|
# ---- Build Documentation ----
|
||||||
- name: Build documentation
|
- name: Build documentation
|
||||||
env:
|
env:
|
||||||
@@ -212,7 +213,7 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
python-version: ${{ env.DEFAULT_PYTHON_VERSION }}
|
python-version: ${{ env.DEFAULT_PYTHON_VERSION }}
|
||||||
- name: Install uv
|
- name: Install uv
|
||||||
uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
|
uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
|
||||||
with:
|
with:
|
||||||
version: ${{ env.DEFAULT_UV_VERSION }}
|
version: ${{ env.DEFAULT_UV_VERSION }}
|
||||||
enable-cache: false
|
enable-cache: false
|
||||||
|
|||||||
@@ -44,7 +44,7 @@ jobs:
|
|||||||
- name: Run Semgrep
|
- name: Run Semgrep
|
||||||
run: semgrep scan --config auto --sarif-output results.sarif
|
run: semgrep scan --config auto --sarif-output results.sarif
|
||||||
- name: Upload results to GitHub code scanning
|
- name: Upload results to GitHub code scanning
|
||||||
uses: github/codeql-action/upload-sarif@b96794f015dfd88f77b49b1c93e0fa7110f94c63 # v4.38.0
|
uses: github/codeql-action/upload-sarif@2892aa5e19bbd11bc0cff5427e3b750a04d9e3c2 # v4.38.2
|
||||||
if: always()
|
if: always()
|
||||||
with:
|
with:
|
||||||
sarif_file: results.sarif
|
sarif_file: results.sarif
|
||||||
|
|||||||
@@ -29,7 +29,7 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
- name: Clean temporary images
|
- name: Clean temporary images
|
||||||
if: "${{ env.TOKEN != '' }}"
|
if: "${{ env.TOKEN != '' }}"
|
||||||
uses: stumpylog/image-cleaner-action/ephemeral@4fe057d991d63b8f6d5d22c40f17c1bca2226537 # v0.12.0
|
uses: stumpylog/image-cleaner-action/ephemeral@21f875bab2376314e0525c614e923c669434f0e4 # v0.13.0
|
||||||
with:
|
with:
|
||||||
token: "${{ env.TOKEN }}"
|
token: "${{ env.TOKEN }}"
|
||||||
owner: "${{ github.repository_owner }}"
|
owner: "${{ github.repository_owner }}"
|
||||||
@@ -56,7 +56,7 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
- name: Clean untagged images
|
- name: Clean untagged images
|
||||||
if: "${{ env.TOKEN != '' }}"
|
if: "${{ env.TOKEN != '' }}"
|
||||||
uses: stumpylog/image-cleaner-action/untagged@4fe057d991d63b8f6d5d22c40f17c1bca2226537 # v0.12.0
|
uses: stumpylog/image-cleaner-action/untagged@21f875bab2376314e0525c614e923c669434f0e4 # v0.13.0
|
||||||
with:
|
with:
|
||||||
token: "${{ env.TOKEN }}"
|
token: "${{ env.TOKEN }}"
|
||||||
owner: "${{ github.repository_owner }}"
|
owner: "${{ github.repository_owner }}"
|
||||||
|
|||||||
@@ -39,7 +39,7 @@ jobs:
|
|||||||
persist-credentials: false
|
persist-credentials: false
|
||||||
# Initializes the CodeQL tools for scanning.
|
# Initializes the CodeQL tools for scanning.
|
||||||
- name: Initialize CodeQL
|
- name: Initialize CodeQL
|
||||||
uses: github/codeql-action/init@b96794f015dfd88f77b49b1c93e0fa7110f94c63 # v4.38.0
|
uses: github/codeql-action/init@2892aa5e19bbd11bc0cff5427e3b750a04d9e3c2 # v4.38.2
|
||||||
with:
|
with:
|
||||||
languages: ${{ matrix.language }}
|
languages: ${{ matrix.language }}
|
||||||
# If you wish to specify custom queries, you can do so here or in a config file.
|
# If you wish to specify custom queries, you can do so here or in a config file.
|
||||||
@@ -47,4 +47,4 @@ jobs:
|
|||||||
# Prefix the list here with "+" to use these queries and those in the config file.
|
# Prefix the list here with "+" to use these queries and those in the config file.
|
||||||
# queries: ./path/to/local/query, your-org/your-repo/queries@main
|
# queries: ./path/to/local/query, your-org/your-repo/queries@main
|
||||||
- name: Perform CodeQL Analysis
|
- name: Perform CodeQL Analysis
|
||||||
uses: github/codeql-action/analyze@b96794f015dfd88f77b49b1c93e0fa7110f94c63 # v4.38.0
|
uses: github/codeql-action/analyze@2892aa5e19bbd11bc0cff5427e3b750a04d9e3c2 # v4.38.2
|
||||||
|
|||||||
@@ -22,7 +22,7 @@ jobs:
|
|||||||
token: ${{ secrets.PNGX_BOT_PAT }}
|
token: ${{ secrets.PNGX_BOT_PAT }}
|
||||||
persist-credentials: false
|
persist-credentials: false
|
||||||
- name: crowdin action
|
- name: crowdin action
|
||||||
uses: crowdin/github-action@0d5670f539973aea2f01abce61a8989934df0025 # v3.0.2
|
uses: crowdin/github-action@9c23991700c0ec5256fd41089b9d9d7d540e424e # v3.3.0
|
||||||
with:
|
with:
|
||||||
upload_translations: false
|
upload_translations: false
|
||||||
download_translations: true
|
download_translations: true
|
||||||
|
|||||||
@@ -25,11 +25,12 @@ jobs:
|
|||||||
id: setup-python
|
id: setup-python
|
||||||
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
|
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
|
||||||
- name: Install system dependencies
|
- name: Install system dependencies
|
||||||
run: |
|
timeout-minutes: 12
|
||||||
sudo apt-get update -qq
|
uses: $/.github/actions/apt-install
|
||||||
sudo apt-get install -qq --no-install-recommends gettext
|
with:
|
||||||
|
packages: gettext
|
||||||
- name: Install uv
|
- name: Install uv
|
||||||
uses: astral-sh/setup-uv@bec219d24cd3e171d82865faccec33120bb574f4 # v10.1.0
|
uses: astral-sh/setup-uv@c18668ad3cf93ea998bef934396af7bb5c839dc7 # v10.2.0
|
||||||
with:
|
with:
|
||||||
version: ${{ env.DEFAULT_UV_VERSION }}
|
version: ${{ env.DEFAULT_UV_VERSION }}
|
||||||
enable-cache: true
|
enable-cache: true
|
||||||
|
|||||||
+706
-456
File diff suppressed because it is too large
Load Diff
@@ -38,7 +38,7 @@ repos:
|
|||||||
- json
|
- json
|
||||||
# See https://github.com/prettier/prettier/issues/15742 for the fork reason
|
# See https://github.com/prettier/prettier/issues/15742 for the fork reason
|
||||||
- repo: https://github.com/rbubley/mirrors-prettier
|
- repo: https://github.com/rbubley/mirrors-prettier
|
||||||
rev: 'v3.9.6'
|
rev: 'v3.9.8'
|
||||||
hooks:
|
hooks:
|
||||||
- id: prettier
|
- id: prettier
|
||||||
types_or:
|
types_or:
|
||||||
@@ -46,16 +46,16 @@ repos:
|
|||||||
- ts
|
- ts
|
||||||
- markdown
|
- markdown
|
||||||
additional_dependencies:
|
additional_dependencies:
|
||||||
- prettier@3.9.6
|
- prettier@3.9.8
|
||||||
- 'prettier-plugin-organize-imports@4.3.0'
|
- 'prettier-plugin-organize-imports@4.3.0'
|
||||||
# Python hooks
|
# Python hooks
|
||||||
- repo: https://github.com/astral-sh/ruff-pre-commit
|
- repo: https://github.com/astral-sh/ruff-pre-commit
|
||||||
rev: v0.16.5
|
rev: v0.16.8
|
||||||
hooks:
|
hooks:
|
||||||
- id: ruff-check
|
- id: ruff-check
|
||||||
- id: ruff-format
|
- id: ruff-format
|
||||||
- repo: https://github.com/tox-dev/pyproject-fmt
|
- repo: https://github.com/tox-dev/pyproject-fmt
|
||||||
rev: "v2.28.1"
|
rev: "v2.29.4"
|
||||||
hooks:
|
hooks:
|
||||||
- id: pyproject-fmt
|
- id: pyproject-fmt
|
||||||
additional_dependencies: [tomli]
|
additional_dependencies: [tomli]
|
||||||
|
|||||||
+4804
-12941
File diff suppressed because one or more lines are too long
+4
-2
@@ -30,7 +30,7 @@ RUN set -eux \
|
|||||||
# Purpose: Installs s6-overlay and rootfs
|
# Purpose: Installs s6-overlay and rootfs
|
||||||
# Comments:
|
# Comments:
|
||||||
# - Don't leave anything extra in here either
|
# - Don't leave anything extra in here either
|
||||||
FROM ghcr.io/astral-sh/uv:0.12.16-python3.14-trixie-slim AS s6-overlay-base
|
FROM ghcr.io/astral-sh/uv:0.12.20-python3.14-trixie-slim AS s6-overlay-base
|
||||||
|
|
||||||
WORKDIR /usr/src/s6
|
WORKDIR /usr/src/s6
|
||||||
|
|
||||||
@@ -171,7 +171,9 @@ RUN set -eux \
|
|||||||
&& cp /etc/ImageMagick-6/paperless-policy.xml /etc/ImageMagick-6/policy.xml \
|
&& cp /etc/ImageMagick-6/paperless-policy.xml /etc/ImageMagick-6/policy.xml \
|
||||||
&& echo "Cleaning up image layer" \
|
&& echo "Cleaning up image layer" \
|
||||||
&& rm --force --verbose *.deb \
|
&& rm --force --verbose *.deb \
|
||||||
&& rm --recursive --force --verbose /var/lib/apt/lists/*
|
&& rm --recursive --force --verbose /var/lib/apt/lists/* \
|
||||||
|
&& echo "Configuring interactive shells to source the s6 container environment" \
|
||||||
|
&& echo '. /etc/profile.d/contenv.sh' >> /etc/bash.bashrc
|
||||||
|
|
||||||
WORKDIR /usr/src/paperless/src/
|
WORKDIR /usr/src/paperless/src/
|
||||||
|
|
||||||
|
|||||||
@@ -24,7 +24,7 @@ services:
|
|||||||
network_mode: host
|
network_mode: host
|
||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
greenmail:
|
greenmail:
|
||||||
image: docker.io/greenmail/standalone:2.1.13
|
image: docker.io/greenmail/standalone:2.1.14
|
||||||
hostname: greenmail
|
hostname: greenmail
|
||||||
container_name: greenmail
|
container_name: greenmail
|
||||||
environment:
|
environment:
|
||||||
|
|||||||
Executable
+18
@@ -0,0 +1,18 @@
|
|||||||
|
#!/bin/sh
|
||||||
|
# Source s6 container environment for interactive shells.
|
||||||
|
# Ensures variables resolved from *_FILE secret injection are visible
|
||||||
|
# when using 'docker exec bash'. Does not affect s6 services (those
|
||||||
|
# use with-contenv directly). Has no effect in non-container contexts
|
||||||
|
# because the directory will not exist.
|
||||||
|
# Note: sh/dash shells opened via 'docker exec sh' are not covered;
|
||||||
|
# only bash-based sessions benefit from this file.
|
||||||
|
_pngx_contenv="/run/s6/container_environment"
|
||||||
|
if [ -d "${_pngx_contenv}" ]; then
|
||||||
|
for _pngx_f in "${_pngx_contenv}"/*; do
|
||||||
|
[ -f "${_pngx_f}" ] || continue
|
||||||
|
_pngx_name=$(basename "${_pngx_f}")
|
||||||
|
_pngx_val=$(cat "${_pngx_f}")
|
||||||
|
export "${_pngx_name}=${_pngx_val}"
|
||||||
|
done
|
||||||
|
fi
|
||||||
|
unset _pngx_contenv _pngx_f _pngx_name _pngx_val
|
||||||
@@ -2,6 +2,7 @@
|
|||||||
# shellcheck shell=bash
|
# shellcheck shell=bash
|
||||||
|
|
||||||
declare -r log_prefix="[svc-flower]"
|
declare -r log_prefix="[svc-flower]"
|
||||||
|
declare -r flower_config="${PAPERLESS_SRC_DIR}/paperless/flowerconfig.py"
|
||||||
|
|
||||||
echo "${log_prefix} Checking if we should start flower..."
|
echo "${log_prefix} Checking if we should start flower..."
|
||||||
|
|
||||||
@@ -9,12 +10,20 @@ if [[ -n "${PAPERLESS_ENABLE_FLOWER}" ]]; then
|
|||||||
# Small delay to allow celery to be up first
|
# Small delay to allow celery to be up first
|
||||||
echo "${log_prefix} Starting flower in 5s"
|
echo "${log_prefix} Starting flower in 5s"
|
||||||
sleep 5
|
sleep 5
|
||||||
cd ${PAPERLESS_SRC_DIR}
|
cd "${PAPERLESS_SRC_DIR}" || exit 1
|
||||||
|
|
||||||
|
# Only pass --conf if the file is actually there. The image does not ship one, and
|
||||||
|
# flower >= 2.1.0 exits with FileNotFoundError when an explicitly given --conf path
|
||||||
|
# does not exist (mher/flower#1391). Earlier versions silently ignored it.
|
||||||
|
declare -a conf_args=()
|
||||||
|
if [[ -f "${flower_config}" ]]; then
|
||||||
|
conf_args=(--conf="${flower_config}")
|
||||||
|
fi
|
||||||
|
|
||||||
if [[ -n "${USER_IS_NON_ROOT}" ]]; then
|
if [[ -n "${USER_IS_NON_ROOT}" ]]; then
|
||||||
exec /usr/local/bin/celery --app paperless flower --conf=${PAPERLESS_SRC_DIR}/paperless/flowerconfig.py
|
exec /usr/local/bin/celery --app paperless flower "${conf_args[@]}"
|
||||||
else
|
else
|
||||||
exec s6-setuidgid paperless /usr/local/bin/celery --app paperless flower --conf=${PAPERLESS_SRC_DIR}/paperless/flowerconfig.py
|
exec s6-setuidgid paperless /usr/local/bin/celery --app paperless flower "${conf_args[@]}"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
else
|
else
|
||||||
|
|||||||
+14
-9
@@ -136,13 +136,15 @@ for suggested generation and embedding models.
|
|||||||
### AI-assisted suggestions
|
### AI-assisted suggestions
|
||||||
|
|
||||||
With AI enabled, Paperless-ngx can suggest a title, tags, correspondent, document type,
|
With AI enabled, Paperless-ngx can suggest a title, tags, correspondent, document type,
|
||||||
storage path and dates by sending the document to the LLM. This is **opt-in per request**
|
storage path and dates by sending the document to the LLM using "Suggest" button on the document
|
||||||
and surfaces through the "Suggest" control on the document detail page, alongside the
|
detail page. You can choose which type of suggestions are requested by default under Settings >
|
||||||
classic classifier-based suggestions — it does not disable them. Suggestions are requested
|
Documents, either ML (classifier-based) suggestions, AI suggestions, or both. When both are requested
|
||||||
automatically when you open a document that carries an inbox tag unless "Automatically request
|
the results are combined.
|
||||||
suggestions for inbox documents" under Settings > Documents is disabled. Suggestion output
|
|
||||||
language can be steered with
|
Suggestions are requested automatically when you open a document that carries an inbox tag
|
||||||
[`PAPERLESS_AI_LLM_OUTPUT_LANGUAGE`](configuration.md#PAPERLESS_AI_LLM_OUTPUT_LANGUAGE)
|
unless "Automatically request suggestions for inbox documents" under Settings > Documents is disabled.
|
||||||
|
|
||||||
|
Suggestion output language can be steered with [`PAPERLESS_AI_LLM_OUTPUT_LANGUAGE`](configuration.md#PAPERLESS_AI_LLM_OUTPUT_LANGUAGE)
|
||||||
(otherwise it follows the user's UI language).
|
(otherwise it follows the user's UI language).
|
||||||
|
|
||||||
### The LLM index (RAG) and similar documents
|
### The LLM index (RAG) and similar documents
|
||||||
@@ -153,8 +155,11 @@ in similar existing documents, and the document chat can retrieve relevant conte
|
|||||||
|
|
||||||
Enable it by setting
|
Enable it by setting
|
||||||
[`PAPERLESS_AI_LLM_EMBEDDING_BACKEND`](configuration.md#PAPERLESS_AI_LLM_EMBEDDING_BACKEND)
|
[`PAPERLESS_AI_LLM_EMBEDDING_BACKEND`](configuration.md#PAPERLESS_AI_LLM_EMBEDDING_BACKEND)
|
||||||
(`huggingface` for fully-local embeddings, or `ollama` / `openai-like`). The index is only
|
(`huggingface` for fully-local embeddings, or `ollama` / `openai-like`). By default, the main
|
||||||
built when AI is enabled **and** an embedding backend is set.
|
LLM API key and endpoint are used, but an optional embedding-specific[API key](configuration.md#PAPERLESS_AI_LLM_EMBEDDING_API_KEY)
|
||||||
|
and [endpoint](configuration.md#PAPERLESS_AI_LLM_EMBEDDING_ENDPOINT) can be configured.
|
||||||
|
|
||||||
|
The index is only built when AI is enabled **and** an embedding backend is set.
|
||||||
|
|
||||||
The index is updated automatically on a schedule controlled by
|
The index is updated automatically on a schedule controlled by
|
||||||
[`PAPERLESS_LLM_INDEX_TASK_CRON`](configuration.md#PAPERLESS_LLM_INDEX_TASK_CRON) (daily by
|
[`PAPERLESS_LLM_INDEX_TASK_CRON`](configuration.md#PAPERLESS_LLM_INDEX_TASK_CRON) (daily by
|
||||||
|
|||||||
@@ -1,5 +1,30 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## paperless-ngx 3.2.1
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
- Fix: only pass --conf to flower when flowerconfig.py exists [@bitfoo1](https://github.com/bitfoo1) ([#14182](https://github.com/paperless-ngx/paperless-ngx/pull/14182))
|
||||||
|
- Fix: replace stale mail-fetch overlap check with a self-expiring lock [@stumpylog](https://github.com/stumpylog) ([#14189](https://github.com/paperless-ngx/paperless-ngx/pull/14189))
|
||||||
|
- Fix: bump ocrmypdf to 17.12 to pick up the ligature text-layer fix [@stumpylog](https://github.com/stumpylog) ([#14190](https://github.com/paperless-ngx/paperless-ngx/pull/14190))
|
||||||
|
- Fix: rebuild the search index automatically when it is missing Tantivy files [@stumpylog](https://github.com/stumpylog) ([#14180](https://github.com/paperless-ngx/paperless-ngx/pull/14180))
|
||||||
|
|
||||||
|
### Dependencies
|
||||||
|
|
||||||
|
- Chore(deps): Bump anyio from 4.12.1 to 4.14.2 in the uv group across 1 directory @[dependabot[bot]](https://github.com/apps/dependabot) ([#14175](https://github.com/paperless-ngx/paperless-ngx/pull/14175))
|
||||||
|
|
||||||
|
### All App Changes
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>4 changes</summary>
|
||||||
|
|
||||||
|
- Chore(deps): Bump anyio from 4.12.1 to 4.14.2 in the uv group across 1 directory @[dependabot[bot]](https://github.com/apps/dependabot) ([#14175](https://github.com/paperless-ngx/paperless-ngx/pull/14175))
|
||||||
|
- Fix: replace stale mail-fetch overlap check with a self-expiring lock [@stumpylog](https://github.com/stumpylog) ([#14189](https://github.com/paperless-ngx/paperless-ngx/pull/14189))
|
||||||
|
- Fix: bump ocrmypdf to 17.12 to pick up the ligature text-layer fix [@stumpylog](https://github.com/stumpylog) ([#14190](https://github.com/paperless-ngx/paperless-ngx/pull/14190))
|
||||||
|
- Fix: rebuild the search index automatically when it is missing Tantivy files [@stumpylog](https://github.com/stumpylog) ([#14180](https://github.com/paperless-ngx/paperless-ngx/pull/14180))
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
## paperless-ngx 3.2.0
|
## paperless-ngx 3.2.0
|
||||||
|
|
||||||
### Features / Enhancements
|
### Features / Enhancements
|
||||||
|
|||||||
@@ -2133,6 +2133,13 @@ for language and resource considerations.
|
|||||||
|
|
||||||
Defaults to None.
|
Defaults to None.
|
||||||
|
|
||||||
|
#### [`PAPERLESS_AI_LLM_EMBEDDING_API_KEY=<str>`](#PAPERLESS_AI_LLM_EMBEDDING_API_KEY) {#PAPERLESS_AI_LLM_EMBEDDING_API_KEY}
|
||||||
|
|
||||||
|
: The API key to use for the embedding backend. If not supplied, embeddings use
|
||||||
|
`PAPERLESS_AI_LLM_API_KEY`.
|
||||||
|
|
||||||
|
Defaults to None.
|
||||||
|
|
||||||
#### [`PAPERLESS_AI_LLM_EMBEDDING_ENDPOINT=<str>`](#PAPERLESS_AI_LLM_EMBEDDING_ENDPOINT) {#PAPERLESS_AI_LLM_EMBEDDING_ENDPOINT}
|
#### [`PAPERLESS_AI_LLM_EMBEDDING_ENDPOINT=<str>`](#PAPERLESS_AI_LLM_EMBEDDING_ENDPOINT) {#PAPERLESS_AI_LLM_EMBEDDING_ENDPOINT}
|
||||||
|
|
||||||
: The endpoint / url to use for the embedding backend. If not supplied, embeddings use
|
: The endpoint / url to use for the embedding backend. If not supplied, embeddings use
|
||||||
@@ -2217,6 +2224,19 @@ used with the OpenAI-compatible backend to target a custom provider or local gat
|
|||||||
|
|
||||||
Defaults to true, which allows internal endpoints.
|
Defaults to true, which allows internal endpoints.
|
||||||
|
|
||||||
|
#### [`PAPERLESS_AI_LLM_EXTRA_PARAMS=<json>`](#PAPERLESS_AI_LLM_EXTRA_PARAMS) {#PAPERLESS_AI_LLM_EXTRA_PARAMS}
|
||||||
|
|
||||||
|
: A JSON object of extra parameters sent with every LLM request, for providers that require a parameter Paperless does not
|
||||||
|
set itself. Values here override Paperless' own, and no validation is performed. Whatever you put here is passed to the
|
||||||
|
backend as-is, so an invalid parameter will simply be rejected by your provider. For example, current OpenAI reasoning
|
||||||
|
models refuse tool calls on the chat completions API unless reasoning is off:
|
||||||
|
|
||||||
|
```
|
||||||
|
PAPERLESS_AI_LLM_EXTRA_PARAMS={"reasoning_effort": "none"}
|
||||||
|
```
|
||||||
|
|
||||||
|
Defaults to empty, which adds nothing to requests.
|
||||||
|
|
||||||
#### [`PAPERLESS_LLM_INDEX_TASK_CRON=<cron expression>`](#PAPERLESS_LLM_INDEX_TASK_CRON) {#PAPERLESS_LLM_INDEX_TASK_CRON}
|
#### [`PAPERLESS_LLM_INDEX_TASK_CRON=<cron expression>`](#PAPERLESS_LLM_INDEX_TASK_CRON) {#PAPERLESS_LLM_INDEX_TASK_CRON}
|
||||||
|
|
||||||
: Configures the schedule to update the AI embeddings of text content and metadata for all documents. Only performed if
|
: Configures the schedule to update the AI embeddings of text content and metadata for all documents. Only performed if
|
||||||
|
|||||||
@@ -150,6 +150,7 @@ pnpm ng build --configuration production
|
|||||||
is loaded as well. However, the tests rely on the default
|
is loaded as well. However, the tests rely on the default
|
||||||
configuration. This is not ideal. But for now, make sure no settings
|
configuration. This is not ideal. But for now, make sure no settings
|
||||||
except for DEBUG are overridden when testing.
|
except for DEBUG are overridden when testing.
|
||||||
|
- Tests run in a random order each session, so that one test cannot quietly depend on another having run first. The seed is printed at the top of the run; pass `--randomly-seed=<seed>` to replay that exact order, or `--randomly-seed=last` to repeat the previous run.
|
||||||
|
|
||||||
!!! note
|
!!! note
|
||||||
|
|
||||||
|
|||||||
+24
-13
@@ -1,7 +1,9 @@
|
|||||||
[project]
|
[project]
|
||||||
name = "paperless-ngx"
|
name = "paperless-ngx"
|
||||||
version = "3.2.0"
|
version = "3.2.1"
|
||||||
description = "A community-supported supercharged document management system: scan, index and archive all your physical documents"
|
description = """\
|
||||||
|
A community-supported supercharged document management system: scan, index and archive all your physical documents\
|
||||||
|
"""
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
requires-python = ">=3.11"
|
requires-python = ">=3.11"
|
||||||
classifiers = [
|
classifiers = [
|
||||||
@@ -10,13 +12,13 @@ classifiers = [
|
|||||||
"Programming Language :: Python :: 3.12",
|
"Programming Language :: Python :: 3.12",
|
||||||
"Programming Language :: Python :: 3.13",
|
"Programming Language :: Python :: 3.13",
|
||||||
"Programming Language :: Python :: 3.14",
|
"Programming Language :: Python :: 3.14",
|
||||||
|
"Programming Language :: Python :: 3.15",
|
||||||
]
|
]
|
||||||
# TODO: Move certain things to groups and then utilize that further
|
# TODO: Move certain things to groups and then utilize that further
|
||||||
# This will allow testing to not install a webserver, mysql, etc
|
# This will allow testing to not install a webserver, mysql, etc
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"azure-ai-documentintelligence>=1.0.2",
|
"azure-ai-documentintelligence>=1.0.2",
|
||||||
"babel>=2.17",
|
"babel>=2.17",
|
||||||
"bleach~=6.4.0",
|
|
||||||
"celery[redis]~=5.6.2",
|
"celery[redis]~=5.6.2",
|
||||||
"channels~=4.2",
|
"channels~=4.2",
|
||||||
"channels-redis~=4.2",
|
"channels-redis~=4.2",
|
||||||
@@ -32,7 +34,7 @@ dependencies = [
|
|||||||
"django-cors-headers~=4.9.0",
|
"django-cors-headers~=4.9.0",
|
||||||
"django-extensions~=4.1",
|
"django-extensions~=4.1",
|
||||||
"django-filter~=25.1",
|
"django-filter~=25.1",
|
||||||
"django-guardian>=3.3.3,<3.5",
|
"django-guardian>=3.3.3,<3.6",
|
||||||
"django-multiselectfield~=1.0.1",
|
"django-multiselectfield~=1.0.1",
|
||||||
"django-rich~=2.2.0",
|
"django-rich~=2.2.0",
|
||||||
"django-soft-delete~=1.0.18",
|
"django-soft-delete~=1.0.18",
|
||||||
@@ -42,7 +44,7 @@ dependencies = [
|
|||||||
"drf-spectacular-sidecar>=2026.7.1,<2026.10",
|
"drf-spectacular-sidecar>=2026.7.1,<2026.10",
|
||||||
"drf-writable-nested~=0.7.1",
|
"drf-writable-nested~=0.7.1",
|
||||||
"filelock~=3.32.0",
|
"filelock~=3.32.0",
|
||||||
"flower>=2.0.1,<2.2",
|
"flower>=2.0.1,<2.3",
|
||||||
"gotenberg-client[httpx]~=1.0",
|
"gotenberg-client[httpx]~=1.0",
|
||||||
"httpx-oauth~=0.17",
|
"httpx-oauth~=0.17",
|
||||||
"ijson>=3.5.1",
|
"ijson>=3.5.1",
|
||||||
@@ -74,6 +76,7 @@ dependencies = [
|
|||||||
"tantivy~=0.26.0",
|
"tantivy~=0.26.0",
|
||||||
"tika-client[httpx]~=1.0",
|
"tika-client[httpx]~=1.0",
|
||||||
"torch>=2.13,<2.15",
|
"torch>=2.13,<2.15",
|
||||||
|
"turbohtml~=1.10.0",
|
||||||
"watchfiles>=1.2",
|
"watchfiles>=1.2",
|
||||||
"whitenoise~=6.11",
|
"whitenoise~=6.11",
|
||||||
"whoosh-compat[tantivy]==0.3",
|
"whoosh-compat[tantivy]==0.3",
|
||||||
@@ -81,13 +84,13 @@ dependencies = [
|
|||||||
]
|
]
|
||||||
[project.optional-dependencies]
|
[project.optional-dependencies]
|
||||||
mariadb = [
|
mariadb = [
|
||||||
"mysqlclient~=2.2.7",
|
"mysqlclient>=2.2.7,<2.4",
|
||||||
]
|
]
|
||||||
postgres = [
|
postgres = [
|
||||||
"psycopg[c,pool]==3.3.4",
|
"psycopg[c,pool]==3.3.4",
|
||||||
# Direct dependency for proper resolution of the pre-built wheels
|
# Direct dependency for proper resolution of the pre-built wheels
|
||||||
"psycopg-c==3.3.4",
|
"psycopg-c==3.3.4",
|
||||||
"psycopg-pool==3.3.1",
|
"psycopg-pool==3.3.2",
|
||||||
]
|
]
|
||||||
webserver = [
|
webserver = [
|
||||||
"granian[uvloop]>=2.7,<2.9",
|
"granian[uvloop]>=2.7,<2.9",
|
||||||
@@ -109,7 +112,7 @@ lint = [
|
|||||||
testing = [
|
testing = [
|
||||||
"daphne",
|
"daphne",
|
||||||
"factory-boy~=3.3.1",
|
"factory-boy~=3.3.1",
|
||||||
"faker>=40.36,<40.39",
|
"faker>=40.36,<40.40",
|
||||||
"imagehash",
|
"imagehash",
|
||||||
"pytest~=9.1.1",
|
"pytest~=9.1.1",
|
||||||
"pytest-cov~=7.1.0",
|
"pytest-cov~=7.1.0",
|
||||||
@@ -117,7 +120,7 @@ testing = [
|
|||||||
"pytest-env~=1.7.0",
|
"pytest-env~=1.7.0",
|
||||||
"pytest-httpx",
|
"pytest-httpx",
|
||||||
"pytest-mock~=3.15.1",
|
"pytest-mock~=3.15.1",
|
||||||
# "pytest-randomly~=4.0.1",
|
"pytest-randomly~=5.0.0",
|
||||||
"pytest-rerunfailures~=16.4",
|
"pytest-rerunfailures~=16.4",
|
||||||
"pytest-sugar",
|
"pytest-sugar",
|
||||||
"pytest-xdist~=3.8.0",
|
"pytest-xdist~=3.8.0",
|
||||||
@@ -133,7 +136,6 @@ typing = [
|
|||||||
"mypy",
|
"mypy",
|
||||||
"mypy-baseline",
|
"mypy-baseline",
|
||||||
"pyrefly",
|
"pyrefly",
|
||||||
"types-bleach",
|
|
||||||
"types-channels",
|
"types-channels",
|
||||||
"types-colorama",
|
"types-colorama",
|
||||||
"types-dateparser",
|
"types-dateparser",
|
||||||
@@ -148,6 +150,7 @@ typing = [
|
|||||||
|
|
||||||
[tool.uv]
|
[tool.uv]
|
||||||
required-version = ">=0.9.0"
|
required-version = ">=0.9.0"
|
||||||
|
prerelease = "disallow"
|
||||||
environments = [
|
environments = [
|
||||||
"sys_platform == 'darwin'",
|
"sys_platform == 'darwin'",
|
||||||
"sys_platform == 'linux'",
|
"sys_platform == 'linux'",
|
||||||
@@ -244,6 +247,10 @@ per-file-ignores."docker/wait-for-redis.py" = [
|
|||||||
per-file-ignores."src/documents/models.py" = [
|
per-file-ignores."src/documents/models.py" = [
|
||||||
"SIM115",
|
"SIM115",
|
||||||
]
|
]
|
||||||
|
per-file-ignores."src/documents/tests/*.py" = [
|
||||||
|
"TID251",
|
||||||
|
]
|
||||||
|
flake8-tidy-imports.banned-api."documents.tests".msg = "Shared test infrastructure lives in src/paperless_testing/."
|
||||||
isort.force-single-line = true
|
isort.force-single-line = true
|
||||||
|
|
||||||
[tool.codespell]
|
[tool.codespell]
|
||||||
@@ -271,9 +278,9 @@ plugins = [
|
|||||||
]
|
]
|
||||||
|
|
||||||
[tool.pyrefly]
|
[tool.pyrefly]
|
||||||
baseline = ".pyrefly-baseline.json"
|
|
||||||
python-platform = "linux"
|
python-platform = "linux"
|
||||||
search-path = [ "src" ]
|
search-path = [ "src" ]
|
||||||
|
baseline = ".pyrefly-baseline.json"
|
||||||
|
|
||||||
[tool.django-stubs]
|
[tool.django-stubs]
|
||||||
django_settings_module = "paperless.settings"
|
django_settings_module = "paperless.settings"
|
||||||
@@ -326,6 +333,8 @@ PAPERLESS_CACHE_BACKEND = "django.core.cache.backends.locmem.LocMemCache"
|
|||||||
PAPERLESS_CHANNELS_BACKEND = "channels.layers.InMemoryChannelLayer"
|
PAPERLESS_CHANNELS_BACKEND = "channels.layers.InMemoryChannelLayer"
|
||||||
# I don't think anything hits this, but just in case, basically infinite
|
# I don't think anything hits this, but just in case, basically infinite
|
||||||
PAPERLESS_TOKEN_THROTTLE_RATE = "1000/min"
|
PAPERLESS_TOKEN_THROTTLE_RATE = "1000/min"
|
||||||
|
# The 0.1s production default trips on a stalled CI runner, the date parsing tests then find no dates
|
||||||
|
PAPERLESS_MATCH_REGEX_TIMEOUT_SECONDS = "5"
|
||||||
|
|
||||||
[tool.coverage.run]
|
[tool.coverage.run]
|
||||||
source = [
|
source = [
|
||||||
@@ -334,13 +343,15 @@ source = [
|
|||||||
omit = [
|
omit = [
|
||||||
"*/tests/*",
|
"*/tests/*",
|
||||||
"manage.py",
|
"manage.py",
|
||||||
"paperless/wsgi.py",
|
|
||||||
"paperless/auth.py",
|
"paperless/auth.py",
|
||||||
|
"paperless/wsgi.py",
|
||||||
|
"src/conftest.py",
|
||||||
|
"src/paperless_testing/*",
|
||||||
]
|
]
|
||||||
[tool.coverage.report]
|
[tool.coverage.report]
|
||||||
exclude_also = [
|
exclude_also = [
|
||||||
"if settings.AUDIT_LOG_ENABLED:",
|
|
||||||
"if AUDIT_LOG_ENABLED:",
|
"if AUDIT_LOG_ENABLED:",
|
||||||
|
"if settings.AUDIT_LOG_ENABLED:",
|
||||||
"if TYPE_CHECKING:",
|
"if TYPE_CHECKING:",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|||||||
@@ -91,6 +91,11 @@
|
|||||||
"glob": "**/*",
|
"glob": "**/*",
|
||||||
"input": "node_modules/pdfjs-dist/iccs/",
|
"input": "node_modules/pdfjs-dist/iccs/",
|
||||||
"output": "/assets/iccs/"
|
"output": "/assets/iccs/"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"glob": "**/*",
|
||||||
|
"input": "node_modules/pdfjs-dist/cmaps/",
|
||||||
|
"output": "/assets/cmaps/"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"styles": [
|
"styles": [
|
||||||
|
|||||||
+315
-238
File diff suppressed because it is too large
Load Diff
+23
-23
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "paperless-ngx-ui",
|
"name": "paperless-ngx-ui",
|
||||||
"version": "3.2.0",
|
"version": "3.2.1",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"preinstall": "npx only-allow pnpm",
|
"preinstall": "npx only-allow pnpm",
|
||||||
"ng": "ng",
|
"ng": "ng",
|
||||||
@@ -15,16 +15,16 @@
|
|||||||
},
|
},
|
||||||
"private": true,
|
"private": true,
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@angular/cdk": "^22.1.6",
|
"@angular/cdk": "^22.2.0",
|
||||||
"@angular/common": "~22.1.6",
|
"@angular/common": "~22.2.0",
|
||||||
"@angular/compiler": "~22.1.6",
|
"@angular/compiler": "~22.2.0",
|
||||||
"@angular/core": "~22.1.6",
|
"@angular/core": "~22.2.0",
|
||||||
"@angular/forms": "~22.1.6",
|
"@angular/forms": "~22.2.0",
|
||||||
"@angular/localize": "~22.1.6",
|
"@angular/localize": "~22.2.0",
|
||||||
"@angular/platform-browser": "~22.1.6",
|
"@angular/platform-browser": "~22.2.0",
|
||||||
"@angular/router": "~22.1.6",
|
"@angular/router": "~22.2.0",
|
||||||
"@ng-bootstrap/ng-bootstrap": "^21.0.0",
|
"@ng-bootstrap/ng-bootstrap": "^21.0.0",
|
||||||
"@ng-select/ng-select": "~24.1.1",
|
"@ng-select/ng-select": "~24.1.2",
|
||||||
"@ngneat/dirty-check-forms": "^3.0.3",
|
"@ngneat/dirty-check-forms": "^3.0.3",
|
||||||
"@popperjs/core": "^2.11.8",
|
"@popperjs/core": "^2.11.8",
|
||||||
"bootstrap": "^5.3.8",
|
"bootstrap": "^5.3.8",
|
||||||
@@ -45,29 +45,29 @@
|
|||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@angular-builders/jest": "^22.0.1",
|
"@angular-builders/jest": "^22.0.1",
|
||||||
"@angular-devkit/core": "^22.1.8",
|
"@angular-devkit/core": "^22.2.0",
|
||||||
"@angular-devkit/schematics": "^22.1.8",
|
"@angular-devkit/schematics": "^22.2.0",
|
||||||
"@angular-eslint/builder": "22.5.0",
|
"@angular-eslint/builder": "22.5.0",
|
||||||
"@angular-eslint/eslint-plugin": "22.5.0",
|
"@angular-eslint/eslint-plugin": "22.5.0",
|
||||||
"@angular-eslint/eslint-plugin-template": "22.5.0",
|
"@angular-eslint/eslint-plugin-template": "22.5.0",
|
||||||
"@angular-eslint/schematics": "22.5.0",
|
"@angular-eslint/schematics": "22.5.0",
|
||||||
"@angular-eslint/template-parser": "22.5.0",
|
"@angular-eslint/template-parser": "22.5.0",
|
||||||
"@angular/build": "22.1.8",
|
"@angular/build": "22.2.0",
|
||||||
"@angular/cli": "22.1.8",
|
"@angular/cli": "22.2.0",
|
||||||
"@angular/compiler-cli": "~22.1.6",
|
"@angular/compiler-cli": "~22.2.0",
|
||||||
"@playwright/test": "^1.62.1",
|
"@playwright/test": "^1.62.1",
|
||||||
"@types/jest": "^30.0.0",
|
"@types/jest": "^30.0.0",
|
||||||
"@types/node": "^26.5.0",
|
"@types/node": "^26.6.2",
|
||||||
"@typescript-eslint/eslint-plugin": "^8.70.0",
|
"@typescript-eslint/eslint-plugin": "^8.70.1",
|
||||||
"@typescript-eslint/parser": "^8.70.0",
|
"@typescript-eslint/parser": "^8.70.1",
|
||||||
"@typescript-eslint/utils": "^8.70.0",
|
"@typescript-eslint/utils": "^8.70.1",
|
||||||
"eslint": "^10.10.0",
|
"eslint": "^10.11.0",
|
||||||
"jest": "30.5.1",
|
"jest": "30.5.2",
|
||||||
"jest-environment-jsdom": "^30.5.1",
|
"jest-environment-jsdom": "^30.5.2",
|
||||||
"jest-junit": "^17.0.0",
|
"jest-junit": "^17.0.0",
|
||||||
"jest-preset-angular": "^17.0.0",
|
"jest-preset-angular": "^17.0.0",
|
||||||
"jest-websocket-mock": "^2.5.0",
|
"jest-websocket-mock": "^2.5.0",
|
||||||
"prettier": "^3.9.6",
|
"prettier": "^3.9.9",
|
||||||
"prettier-plugin-organize-imports": "^4.3.0",
|
"prettier-plugin-organize-imports": "^4.3.0",
|
||||||
"ts-node": "~10.9.2",
|
"ts-node": "~10.9.2",
|
||||||
"typescript": "^6.0.3"
|
"typescript": "^6.0.3"
|
||||||
|
|||||||
Generated
+1312
-1960
File diff suppressed because it is too large
Load Diff
@@ -253,6 +253,24 @@
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
@if (aiEnabled) {
|
||||||
|
<div class="row mb-3">
|
||||||
|
<div class="col-md-3 col-form-label pt-0">
|
||||||
|
<span i18n>Suggestions default to</span>
|
||||||
|
</div>
|
||||||
|
<div class="col">
|
||||||
|
<fieldset class="btn-group btn-group-sm">
|
||||||
|
<input type="radio" class="btn-check" id="suggestionSourceBoth" [value]="SuggestionSource.Both" formControlName="documentEditingSuggestionSource">
|
||||||
|
<label class="btn btn-outline-primary" for="suggestionSourceBoth"><ng-container i18n>Both</ng-container></label>
|
||||||
|
<input type="radio" class="btn-check" id="suggestionSourceML" [value]="SuggestionSource.ML" formControlName="documentEditingSuggestionSource">
|
||||||
|
<label class="btn btn-outline-primary" for="suggestionSourceML"><i-bs class="me-1" name="cpu"></i-bs><ng-container i18n>ML only</ng-container></label>
|
||||||
|
<input type="radio" class="btn-check" id="suggestionSourceAI" [value]="SuggestionSource.AI" formControlName="documentEditingSuggestionSource">
|
||||||
|
<label class="btn btn-outline-primary" for="suggestionSourceAI"><i-bs class="me-1" name="stars"></i-bs><ng-container i18n>AI only</ng-container></label>
|
||||||
|
</fieldset>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
}
|
||||||
|
|
||||||
<div class="row">
|
<div class="row">
|
||||||
<div class="col">
|
<div class="col">
|
||||||
<pngx-input-check i18n-title title="Automatically request suggestions for inbox documents" i18n-hint hint="If un-checked, suggestions must be requested via the Suggest button." formControlName="documentEditingAutoSuggest"></pngx-input-check>
|
<pngx-input-check i18n-title title="Automatically request suggestions for inbox documents" i18n-hint hint="If un-checked, suggestions must be requested via the Suggest button." formControlName="documentEditingAutoSuggest"></pngx-input-check>
|
||||||
|
|||||||
@@ -307,7 +307,7 @@ describe('SettingsComponent', () => {
|
|||||||
expect(toastErrorSpy).toHaveBeenCalled()
|
expect(toastErrorSpy).toHaveBeenCalled()
|
||||||
expect(storeSpy).toHaveBeenCalled()
|
expect(storeSpy).toHaveBeenCalled()
|
||||||
expect(appearanceSettingsSpy).not.toHaveBeenCalled()
|
expect(appearanceSettingsSpy).not.toHaveBeenCalled()
|
||||||
expect(setSpy).toHaveBeenCalledTimes(34)
|
expect(setSpy).toHaveBeenCalledTimes(35)
|
||||||
expect(setSpy).toHaveBeenCalledWith(SETTINGS_KEYS.SIDEBAR_HIDDEN_ITEMS, [
|
expect(setSpy).toHaveBeenCalledWith(SETTINGS_KEYS.SIDEBAR_HIDDEN_ITEMS, [
|
||||||
HideableSidebarItemID.Workflows,
|
HideableSidebarItemID.Workflows,
|
||||||
])
|
])
|
||||||
|
|||||||
@@ -44,6 +44,7 @@ import {
|
|||||||
HIDEABLE_SIDEBAR_ITEM_IDS,
|
HIDEABLE_SIDEBAR_ITEM_IDS,
|
||||||
HideableSidebarItemID,
|
HideableSidebarItemID,
|
||||||
SETTINGS_KEYS,
|
SETTINGS_KEYS,
|
||||||
|
SuggestionSource,
|
||||||
} from 'src/app/data/ui-settings'
|
} from 'src/app/data/ui-settings'
|
||||||
import { User } from 'src/app/data/user'
|
import { User } from 'src/app/data/user'
|
||||||
import { IfPermissionsDirective } from 'src/app/directives/if-permissions.directive'
|
import { IfPermissionsDirective } from 'src/app/directives/if-permissions.directive'
|
||||||
@@ -184,6 +185,7 @@ export class SettingsComponent
|
|||||||
documentEditingRemoveInboxTags: new FormControl(null),
|
documentEditingRemoveInboxTags: new FormControl(null),
|
||||||
documentEditingOverlayThumbnail: new FormControl(null),
|
documentEditingOverlayThumbnail: new FormControl(null),
|
||||||
documentEditingAutoSuggest: new FormControl(null),
|
documentEditingAutoSuggest: new FormControl(null),
|
||||||
|
documentEditingSuggestionSource: new FormControl(null),
|
||||||
documentDetailsHiddenFields: new FormControl([]),
|
documentDetailsHiddenFields: new FormControl([]),
|
||||||
searchDbOnly: new FormControl(null),
|
searchDbOnly: new FormControl(null),
|
||||||
searchLink: new FormControl(null),
|
searchLink: new FormControl(null),
|
||||||
@@ -217,6 +219,11 @@ export class SettingsComponent
|
|||||||
public readonly PdfZoomScale = PdfZoomScale
|
public readonly PdfZoomScale = PdfZoomScale
|
||||||
|
|
||||||
public readonly PdfEditorEditMode = PdfEditorEditMode
|
public readonly PdfEditorEditMode = PdfEditorEditMode
|
||||||
|
public readonly SuggestionSource = SuggestionSource
|
||||||
|
|
||||||
|
get aiEnabled(): boolean {
|
||||||
|
return this.settings.get(SETTINGS_KEYS.AI_ENABLED)
|
||||||
|
}
|
||||||
|
|
||||||
public readonly documentDetailFieldOptions = documentDetailFieldOptions
|
public readonly documentDetailFieldOptions = documentDetailFieldOptions
|
||||||
public readonly sidebarItemOptions = HIDEABLE_SIDEBAR_ITEM_IDS.map((id) => ({
|
public readonly sidebarItemOptions = HIDEABLE_SIDEBAR_ITEM_IDS.map((id) => ({
|
||||||
@@ -404,6 +411,9 @@ export class SettingsComponent
|
|||||||
documentEditingAutoSuggest: this.settings.get(
|
documentEditingAutoSuggest: this.settings.get(
|
||||||
SETTINGS_KEYS.DOCUMENT_EDITING_AUTO_SUGGEST
|
SETTINGS_KEYS.DOCUMENT_EDITING_AUTO_SUGGEST
|
||||||
),
|
),
|
||||||
|
documentEditingSuggestionSource: this.settings.get(
|
||||||
|
SETTINGS_KEYS.DOCUMENT_EDITING_SUGGESTION_SOURCE
|
||||||
|
),
|
||||||
documentDetailsHiddenFields: this.settings.get(
|
documentDetailsHiddenFields: this.settings.get(
|
||||||
SETTINGS_KEYS.DOCUMENT_DETAILS_HIDDEN_FIELDS
|
SETTINGS_KEYS.DOCUMENT_DETAILS_HIDDEN_FIELDS
|
||||||
),
|
),
|
||||||
@@ -625,6 +635,10 @@ export class SettingsComponent
|
|||||||
SETTINGS_KEYS.DOCUMENT_EDITING_AUTO_SUGGEST,
|
SETTINGS_KEYS.DOCUMENT_EDITING_AUTO_SUGGEST,
|
||||||
this.settingsForm.value.documentEditingAutoSuggest
|
this.settingsForm.value.documentEditingAutoSuggest
|
||||||
)
|
)
|
||||||
|
this.settings.set(
|
||||||
|
SETTINGS_KEYS.DOCUMENT_EDITING_SUGGESTION_SOURCE,
|
||||||
|
this.settingsForm.value.documentEditingSuggestionSource
|
||||||
|
)
|
||||||
this.settings.set(
|
this.settings.set(
|
||||||
SETTINGS_KEYS.DOCUMENT_DETAILS_HIDDEN_FIELDS,
|
SETTINGS_KEYS.DOCUMENT_DETAILS_HIDDEN_FIELDS,
|
||||||
this.settingsForm.value.documentDetailsHiddenFields
|
this.settingsForm.value.documentDetailsHiddenFields
|
||||||
|
|||||||
-347
@@ -1,347 +0,0 @@
|
|||||||
<div class="modal-header">
|
|
||||||
<h4 class="modal-title" id="advanced-search-dialog-title" i18n>
|
|
||||||
Advanced search
|
|
||||||
</h4>
|
|
||||||
<button
|
|
||||||
type="button"
|
|
||||||
class="btn-close"
|
|
||||||
aria-label="Close"
|
|
||||||
i18n-aria-label
|
|
||||||
(click)="cancel()"
|
|
||||||
></button>
|
|
||||||
</div>
|
|
||||||
<div class="modal-body">
|
|
||||||
@if (unreadable) {
|
|
||||||
<div class="alert alert-warning d-flex flex-wrap gap-2 align-items-center">
|
|
||||||
<div class="flex-grow-1">
|
|
||||||
<span i18n
|
|
||||||
>The current query uses syntax this editor can't show. It still works
|
|
||||||
as typed.</span
|
|
||||||
>
|
|
||||||
</div>
|
|
||||||
<button
|
|
||||||
type="button"
|
|
||||||
class="btn btn-sm btn-outline-secondary"
|
|
||||||
(click)="startOver()"
|
|
||||||
i18n
|
|
||||||
>
|
|
||||||
Start a new query
|
|
||||||
</button>
|
|
||||||
</div>
|
|
||||||
}
|
|
||||||
|
|
||||||
<ng-container
|
|
||||||
*ngTemplateOutlet="
|
|
||||||
groupTemplate;
|
|
||||||
context: { group: root, parent: null, depth: 0 }
|
|
||||||
"
|
|
||||||
></ng-container>
|
|
||||||
|
|
||||||
<div class="mt-4">
|
|
||||||
<label
|
|
||||||
class="form-label small text-muted"
|
|
||||||
for="advanced-search-preview"
|
|
||||||
i18n
|
|
||||||
>Query</label
|
|
||||||
>
|
|
||||||
<pre
|
|
||||||
id="advanced-search-preview"
|
|
||||||
class="query-preview mb-0 p-2 rounded border"
|
|
||||||
>@if (generatedQuery) {{{ generatedQuery }}} @else {<span class="text-muted fst-italic" i18n>Nothing to search for yet</span>}</pre>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div class="modal-footer">
|
|
||||||
<button
|
|
||||||
type="button"
|
|
||||||
class="btn btn-outline-secondary"
|
|
||||||
(click)="cancel()"
|
|
||||||
i18n
|
|
||||||
>
|
|
||||||
Cancel
|
|
||||||
</button>
|
|
||||||
<button
|
|
||||||
type="button"
|
|
||||||
class="btn btn-primary"
|
|
||||||
(click)="apply()"
|
|
||||||
[disabled]="!generatedQuery"
|
|
||||||
i18n
|
|
||||||
>
|
|
||||||
Apply
|
|
||||||
</button>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<ng-template
|
|
||||||
#groupTemplate
|
|
||||||
let-group="group"
|
|
||||||
let-parent="parent"
|
|
||||||
let-depth="depth"
|
|
||||||
>
|
|
||||||
<div class="d-flex w-100 gap-2">
|
|
||||||
<div class="d-flex flex-grow-1 flex-column">
|
|
||||||
<div class="d-flex align-items-center flex-wrap">
|
|
||||||
<div
|
|
||||||
class="btn-group btn-group-xs"
|
|
||||||
role="group"
|
|
||||||
aria-label="Match"
|
|
||||||
i18n-aria-label
|
|
||||||
>
|
|
||||||
<input
|
|
||||||
type="radio"
|
|
||||||
class="btn-check"
|
|
||||||
[(ngModel)]="group.operator"
|
|
||||||
[ngModelOptions]="{ standalone: true }"
|
|
||||||
[value]="LogicalOperator.Or"
|
|
||||||
id="advancedSearchAny_{{ idFor(group) }}"
|
|
||||||
name="advancedSearchAny_{{ idFor(group) }}"
|
|
||||||
/>
|
|
||||||
<label
|
|
||||||
class="btn btn-outline-primary"
|
|
||||||
for="advancedSearchAny_{{ idFor(group) }}"
|
|
||||||
i18n
|
|
||||||
>Any</label
|
|
||||||
>
|
|
||||||
<input
|
|
||||||
type="radio"
|
|
||||||
class="btn-check"
|
|
||||||
[(ngModel)]="group.operator"
|
|
||||||
[ngModelOptions]="{ standalone: true }"
|
|
||||||
[value]="LogicalOperator.And"
|
|
||||||
id="advancedSearchAll_{{ idFor(group) }}"
|
|
||||||
name="advancedSearchAll_{{ idFor(group) }}"
|
|
||||||
/>
|
|
||||||
<label
|
|
||||||
class="btn btn-outline-primary"
|
|
||||||
for="advancedSearchAll_{{ idFor(group) }}"
|
|
||||||
i18n
|
|
||||||
>All</label
|
|
||||||
>
|
|
||||||
<input
|
|
||||||
type="radio"
|
|
||||||
class="btn-check"
|
|
||||||
[(ngModel)]="group.operator"
|
|
||||||
[ngModelOptions]="{ standalone: true }"
|
|
||||||
[value]="LogicalOperator.Not"
|
|
||||||
id="advancedSearchNot_{{ idFor(group) }}"
|
|
||||||
name="advancedSearchNot_{{ idFor(group) }}"
|
|
||||||
/>
|
|
||||||
<label
|
|
||||||
class="btn btn-outline-secondary"
|
|
||||||
for="advancedSearchNot_{{ idFor(group) }}"
|
|
||||||
i18n
|
|
||||||
>Not</label
|
|
||||||
>
|
|
||||||
</div>
|
|
||||||
<span class="small text-muted ms-2">
|
|
||||||
@switch (group.operator) {
|
|
||||||
@case (LogicalOperator.And) {
|
|
||||||
<ng-container i18n>match all of these</ng-container>
|
|
||||||
}
|
|
||||||
@case (LogicalOperator.Or) {
|
|
||||||
<ng-container i18n>match any of these</ng-container>
|
|
||||||
}
|
|
||||||
@case (LogicalOperator.Not) {
|
|
||||||
<ng-container i18n>match none of these</ng-container>
|
|
||||||
}
|
|
||||||
}
|
|
||||||
</span>
|
|
||||||
</div>
|
|
||||||
<div class="list-group list-group-flush">
|
|
||||||
@for (element of group.children; track element) {
|
|
||||||
<div class="list-group-item px-0 d-flex flex-nowrap">
|
|
||||||
@if (element.type === ElementType.Group) {
|
|
||||||
<ng-container
|
|
||||||
*ngTemplateOutlet="
|
|
||||||
groupTemplate;
|
|
||||||
context: { group: element, parent: group, depth: depth + 1 }
|
|
||||||
"
|
|
||||||
></ng-container>
|
|
||||||
} @else {
|
|
||||||
<ng-container
|
|
||||||
*ngTemplateOutlet="
|
|
||||||
atomTemplate;
|
|
||||||
context: { atom: element, parent: group }
|
|
||||||
"
|
|
||||||
></ng-container>
|
|
||||||
}
|
|
||||||
</div>
|
|
||||||
}
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<div
|
|
||||||
class="btn-group-vertical align-self-start ms-2 ps-2 border-start"
|
|
||||||
role="group"
|
|
||||||
aria-label="Group actions"
|
|
||||||
i18n-aria-label
|
|
||||||
>
|
|
||||||
<button
|
|
||||||
type="button"
|
|
||||||
class="btn btn-sm btn-outline-secondary text-primary"
|
|
||||||
title="Add condition"
|
|
||||||
i18n-title
|
|
||||||
(click)="addAtom(group)"
|
|
||||||
[disabled]="group.children.length >= maxAtoms"
|
|
||||||
>
|
|
||||||
<i-bs name="node-plus"></i-bs>
|
|
||||||
</button>
|
|
||||||
<button
|
|
||||||
type="button"
|
|
||||||
class="btn btn-sm btn-outline-secondary text-primary"
|
|
||||||
title="Add group"
|
|
||||||
i18n-title
|
|
||||||
(click)="addGroup(group)"
|
|
||||||
[disabled]="depth >= maxDepth"
|
|
||||||
>
|
|
||||||
<i-bs name="braces"></i-bs>
|
|
||||||
</button>
|
|
||||||
@if (parent) {
|
|
||||||
<button
|
|
||||||
type="button"
|
|
||||||
class="btn btn-sm btn-outline-secondary text-danger"
|
|
||||||
aria-label="Remove group"
|
|
||||||
i18n-aria-label
|
|
||||||
(click)="remove(parent, group)"
|
|
||||||
>
|
|
||||||
<i-bs name="x-circle"></i-bs>
|
|
||||||
</button>
|
|
||||||
}
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</ng-template>
|
|
||||||
|
|
||||||
<ng-template #atomTemplate let-atom="atom" let-parent="parent">
|
|
||||||
<div class="d-flex align-items-center gap-1 w-100">
|
|
||||||
<div class="input-group input-group-sm flex-wrap">
|
|
||||||
<select
|
|
||||||
class="form-select flex-grow-0 w-auto"
|
|
||||||
[(ngModel)]="atom.field"
|
|
||||||
[ngModelOptions]="{ standalone: true }"
|
|
||||||
(ngModelChange)="onFieldChange(atom)"
|
|
||||||
aria-label="Field"
|
|
||||||
i18n-aria-label
|
|
||||||
>
|
|
||||||
@for (fieldGroup of fieldGroups; track fieldGroup.label) {
|
|
||||||
<optgroup [label]="fieldGroup.label">
|
|
||||||
@for (field of fieldGroup.fields; track field) {
|
|
||||||
<option [ngValue]="field">{{ fieldLabels[field] }}</option>
|
|
||||||
}
|
|
||||||
</optgroup>
|
|
||||||
}
|
|
||||||
</select>
|
|
||||||
<select
|
|
||||||
class="form-select flex-grow-0 w-auto"
|
|
||||||
[(ngModel)]="atom.operator"
|
|
||||||
[ngModelOptions]="{ standalone: true }"
|
|
||||||
(ngModelChange)="onOperatorChange(atom)"
|
|
||||||
aria-label="Condition"
|
|
||||||
i18n-aria-label
|
|
||||||
>
|
|
||||||
@for (operator of operatorsFor(atom); track operator) {
|
|
||||||
<option [ngValue]="operator">
|
|
||||||
{{ operatorLabel(atom, operator) }}
|
|
||||||
</option>
|
|
||||||
}
|
|
||||||
</select>
|
|
||||||
|
|
||||||
@switch (atom.operator) {
|
|
||||||
@case (Operator.DateKeyword) {
|
|
||||||
<select
|
|
||||||
class="form-select"
|
|
||||||
[(ngModel)]="atom.value"
|
|
||||||
[ngModelOptions]="{ standalone: true }"
|
|
||||||
aria-label="Period"
|
|
||||||
i18n-aria-label
|
|
||||||
>
|
|
||||||
<option [ngValue]="''" disabled i18n>Choose a period</option>
|
|
||||||
@for (keyword of dateKeywords; track keyword) {
|
|
||||||
<option [ngValue]="keyword">
|
|
||||||
{{ dateKeywordLabels[keyword] }}
|
|
||||||
</option>
|
|
||||||
}
|
|
||||||
</select>
|
|
||||||
}
|
|
||||||
@case (Operator.WithinLast) {
|
|
||||||
<input
|
|
||||||
class="form-control amount"
|
|
||||||
type="number"
|
|
||||||
min="1"
|
|
||||||
[(ngModel)]="atom.value"
|
|
||||||
[ngModelOptions]="{ standalone: true }"
|
|
||||||
aria-label="Amount"
|
|
||||||
i18n-aria-label
|
|
||||||
/>
|
|
||||||
<select
|
|
||||||
class="form-select"
|
|
||||||
[(ngModel)]="atom.unit"
|
|
||||||
[ngModelOptions]="{ standalone: true }"
|
|
||||||
aria-label="Unit"
|
|
||||||
i18n-aria-label
|
|
||||||
>
|
|
||||||
@for (unit of dateUnits; track unit) {
|
|
||||||
<option [ngValue]="unit">{{ dateUnitLabels[unit] }}</option>
|
|
||||||
}
|
|
||||||
</select>
|
|
||||||
}
|
|
||||||
@case (Operator.Between) {
|
|
||||||
<input
|
|
||||||
class="form-control"
|
|
||||||
[type]="kindOf(atom) === FieldKind.Date ? 'date' : 'number'"
|
|
||||||
[(ngModel)]="atom.value"
|
|
||||||
[ngModelOptions]="{ standalone: true }"
|
|
||||||
aria-label="From"
|
|
||||||
i18n-aria-label
|
|
||||||
/>
|
|
||||||
<span class="input-group-text" i18n>and</span>
|
|
||||||
<input
|
|
||||||
class="form-control"
|
|
||||||
[type]="kindOf(atom) === FieldKind.Date ? 'date' : 'number'"
|
|
||||||
[(ngModel)]="atom.valueTo"
|
|
||||||
[ngModelOptions]="{ standalone: true }"
|
|
||||||
aria-label="To"
|
|
||||||
i18n-aria-label
|
|
||||||
/>
|
|
||||||
}
|
|
||||||
@default {
|
|
||||||
@if (kindOf(atom) === FieldKind.Date) {
|
|
||||||
<input
|
|
||||||
class="form-control"
|
|
||||||
type="date"
|
|
||||||
[(ngModel)]="atom.value"
|
|
||||||
[ngModelOptions]="{ standalone: true }"
|
|
||||||
aria-label="Date"
|
|
||||||
i18n-aria-label
|
|
||||||
/>
|
|
||||||
} @else if (kindOf(atom) === FieldKind.Number) {
|
|
||||||
<input
|
|
||||||
class="form-control"
|
|
||||||
type="number"
|
|
||||||
min="0"
|
|
||||||
[(ngModel)]="atom.value"
|
|
||||||
[ngModelOptions]="{ standalone: true }"
|
|
||||||
aria-label="Number"
|
|
||||||
i18n-aria-label
|
|
||||||
/>
|
|
||||||
} @else {
|
|
||||||
<input
|
|
||||||
class="form-control"
|
|
||||||
type="text"
|
|
||||||
[(ngModel)]="atom.value"
|
|
||||||
[ngModelOptions]="{ standalone: true }"
|
|
||||||
[placeholder]="placeholderFor(atom)"
|
|
||||||
aria-label="Value"
|
|
||||||
i18n-aria-label
|
|
||||||
/>
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
</div>
|
|
||||||
<button
|
|
||||||
class="btn btn-link btn-sm text-danger px-1"
|
|
||||||
type="button"
|
|
||||||
(click)="remove(parent, atom)"
|
|
||||||
aria-label="Remove condition"
|
|
||||||
i18n-aria-label
|
|
||||||
>
|
|
||||||
<i-bs name="x-circle"></i-bs>
|
|
||||||
</button>
|
|
||||||
</div>
|
|
||||||
</ng-template>
|
|
||||||
-11
@@ -1,11 +0,0 @@
|
|||||||
.query-preview {
|
|
||||||
font-size: 0.8125rem;
|
|
||||||
white-space: pre-wrap;
|
|
||||||
word-break: break-word;
|
|
||||||
background-color: var(--pngx-bg-darker);
|
|
||||||
border-color: var(--bs-border-color) !important;
|
|
||||||
}
|
|
||||||
|
|
||||||
.input-group .amount {
|
|
||||||
flex: 0 1 5rem;
|
|
||||||
}
|
|
||||||
-186
@@ -1,186 +0,0 @@
|
|||||||
import { ComponentFixture, TestBed } from '@angular/core/testing'
|
|
||||||
|
|
||||||
import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'
|
|
||||||
import { allIcons, NgxBootstrapIconsModule } from 'ngx-bootstrap-icons'
|
|
||||||
import {
|
|
||||||
AdvancedSearchDateUnit,
|
|
||||||
AdvancedSearchField,
|
|
||||||
AdvancedSearchLogicalOperator,
|
|
||||||
AdvancedSearchOperator,
|
|
||||||
AdvancedSearchQueryAtom,
|
|
||||||
AdvancedSearchQueryElementType,
|
|
||||||
AdvancedSearchQueryGroup,
|
|
||||||
} from 'src/app/data/advanced-search-query'
|
|
||||||
import { AdvancedSearchDialogComponent } from './advanced-search-dialog.component'
|
|
||||||
|
|
||||||
describe('AdvancedSearchDialogComponent', () => {
|
|
||||||
let component: AdvancedSearchDialogComponent
|
|
||||||
let fixture: ComponentFixture<AdvancedSearchDialogComponent>
|
|
||||||
let activeModal: NgbActiveModal
|
|
||||||
|
|
||||||
const firstAtom = (): AdvancedSearchQueryAtom =>
|
|
||||||
component.root.children[0] as AdvancedSearchQueryAtom
|
|
||||||
|
|
||||||
beforeEach(async () => {
|
|
||||||
await TestBed.configureTestingModule({
|
|
||||||
imports: [
|
|
||||||
AdvancedSearchDialogComponent,
|
|
||||||
NgxBootstrapIconsModule.pick(allIcons),
|
|
||||||
],
|
|
||||||
providers: [NgbActiveModal],
|
|
||||||
}).compileComponents()
|
|
||||||
|
|
||||||
fixture = TestBed.createComponent(AdvancedSearchDialogComponent)
|
|
||||||
activeModal = TestBed.inject(NgbActiveModal)
|
|
||||||
component = fixture.componentInstance
|
|
||||||
fixture.detectChanges()
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should start with one empty condition and nothing to search for', () => {
|
|
||||||
expect(component.root.children).toHaveLength(1)
|
|
||||||
expect(component.generatedQuery).toBe('')
|
|
||||||
expect(component.unreadable).toBeFalsy()
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should show an existing query as conditions', () => {
|
|
||||||
component.query = 'title:invoice AND NOT tag:paid'
|
|
||||||
expect(component.unreadable).toBeFalsy()
|
|
||||||
expect(component.root.children).toHaveLength(2)
|
|
||||||
expect(component.generatedQuery).toBe('title:invoice AND NOT tag:paid')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should flag a query it cannot show and start empty', () => {
|
|
||||||
component.query = 'title:invoice^2'
|
|
||||||
expect(component.unreadable).toBeTruthy()
|
|
||||||
expect(component.generatedQuery).toBe('')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should clear the warning when starting a new query', () => {
|
|
||||||
component.query = 'title:invoice^2'
|
|
||||||
component.startOver()
|
|
||||||
expect(component.unreadable).toBeFalsy()
|
|
||||||
expect(component.root.children).toHaveLength(1)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should treat an empty query as a fresh start', () => {
|
|
||||||
component.query = ' '
|
|
||||||
expect(component.unreadable).toBeFalsy()
|
|
||||||
expect(component.root.children).toHaveLength(1)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should write the query as conditions are filled in', () => {
|
|
||||||
const atom = firstAtom()
|
|
||||||
atom.field = AdvancedSearchField.Title
|
|
||||||
atom.value = 'unpaid invoice'
|
|
||||||
expect(component.generatedQuery).toBe('title:unpaid AND title:invoice')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should offer the conditions of the chosen field', () => {
|
|
||||||
const atom = firstAtom()
|
|
||||||
atom.field = AdvancedSearchField.Added
|
|
||||||
component.onFieldChange(atom)
|
|
||||||
expect(component.operatorsFor(atom)).toContain(
|
|
||||||
AdvancedSearchOperator.WithinLast
|
|
||||||
)
|
|
||||||
expect(component.operatorsFor(atom)).not.toContain(
|
|
||||||
AdvancedSearchOperator.Phrase
|
|
||||||
)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should keep a condition the new field still offers', () => {
|
|
||||||
const atom = firstAtom()
|
|
||||||
atom.operator = AdvancedSearchOperator.Phrase
|
|
||||||
atom.field = AdvancedSearchField.Correspondent
|
|
||||||
component.onFieldChange(atom)
|
|
||||||
expect(atom.operator).toBe(AdvancedSearchOperator.Phrase)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should replace a condition the new field does not offer, and clear the value', () => {
|
|
||||||
const atom = firstAtom()
|
|
||||||
atom.operator = AdvancedSearchOperator.Phrase
|
|
||||||
atom.value = 'invoice'
|
|
||||||
atom.field = AdvancedSearchField.ASN
|
|
||||||
component.onFieldChange(atom)
|
|
||||||
expect(atom.operator).toBe(AdvancedSearchOperator.Equals)
|
|
||||||
expect(atom.value).toBe('')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should give a within-the-last condition a unit to start from', () => {
|
|
||||||
const atom = firstAtom()
|
|
||||||
atom.field = AdvancedSearchField.Added
|
|
||||||
atom.operator = AdvancedSearchOperator.WithinLast
|
|
||||||
component.onOperatorChange(atom)
|
|
||||||
expect(atom.unit).toBe(AdvancedSearchDateUnit.Day)
|
|
||||||
atom.value = '3'
|
|
||||||
expect(component.generatedQuery).toBe('added:[-3 days to now]')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should label date comparisons as dates', () => {
|
|
||||||
const atom = firstAtom()
|
|
||||||
atom.field = AdvancedSearchField.Created
|
|
||||||
expect(
|
|
||||||
component.operatorLabel(atom, AdvancedSearchOperator.AtLeast)
|
|
||||||
).toEqual('is on or after')
|
|
||||||
atom.field = AdvancedSearchField.ASN
|
|
||||||
expect(
|
|
||||||
component.operatorLabel(atom, AdvancedSearchOperator.AtLeast)
|
|
||||||
).toEqual('is at least')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should add and remove conditions', () => {
|
|
||||||
component.addAtom(component.root)
|
|
||||||
expect(component.root.children).toHaveLength(2)
|
|
||||||
component.remove(component.root, component.root.children[1])
|
|
||||||
expect(component.root.children).toHaveLength(1)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should add a group, which starts as Any', () => {
|
|
||||||
component.addGroup(component.root)
|
|
||||||
const group = component.root.children[1] as AdvancedSearchQueryGroup
|
|
||||||
expect(group.type).toBe(AdvancedSearchQueryElementType.Group)
|
|
||||||
expect(group.operator).toBe(AdvancedSearchLogicalOperator.Or)
|
|
||||||
expect(group.children).toHaveLength(1)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should give every group its own id, once', () => {
|
|
||||||
component.addGroup(component.root)
|
|
||||||
const group = component.root.children[1] as AdvancedSearchQueryGroup
|
|
||||||
expect(component.idFor(component.root)).not.toEqual(component.idFor(group))
|
|
||||||
expect(component.idFor(group)).toEqual(component.idFor(group))
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should apply the query and close', () => {
|
|
||||||
const emitSpy = jest.spyOn(component.queryApplied, 'emit')
|
|
||||||
const closeSpy = jest.spyOn(activeModal, 'close')
|
|
||||||
const atom = firstAtom()
|
|
||||||
atom.value = 'invoice'
|
|
||||||
component.apply()
|
|
||||||
expect(emitSpy).toHaveBeenCalledWith('content:invoice')
|
|
||||||
expect(closeSpy).toHaveBeenCalled()
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should close without applying on cancel', () => {
|
|
||||||
const emitSpy = jest.spyOn(component.queryApplied, 'emit')
|
|
||||||
const closeSpy = jest.spyOn(activeModal, 'close')
|
|
||||||
component.cancel()
|
|
||||||
expect(emitSpy).not.toHaveBeenCalled()
|
|
||||||
expect(closeSpy).toHaveBeenCalled()
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should show the query it will apply', () => {
|
|
||||||
component.query = 'content:invoice OR content:receipt'
|
|
||||||
fixture.detectChanges()
|
|
||||||
const preview = fixture.nativeElement.querySelector(
|
|
||||||
'#advanced-search-preview'
|
|
||||||
)
|
|
||||||
expect(preview.textContent).toContain('content:invoice OR content:receipt')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should not offer to apply an empty query', () => {
|
|
||||||
fixture.detectChanges()
|
|
||||||
const apply = Array.from(
|
|
||||||
fixture.nativeElement.querySelectorAll('.modal-footer button')
|
|
||||||
).pop() as HTMLButtonElement
|
|
||||||
expect(apply.disabled).toBeTruthy()
|
|
||||||
})
|
|
||||||
})
|
|
||||||
-197
@@ -1,197 +0,0 @@
|
|||||||
import { NgTemplateOutlet } from '@angular/common'
|
|
||||||
import { Component, EventEmitter, inject, Input, Output } from '@angular/core'
|
|
||||||
import { FormsModule } from '@angular/forms'
|
|
||||||
import { NgbActiveModal } from '@ng-bootstrap/ng-bootstrap'
|
|
||||||
import { NgxBootstrapIconsModule } from 'ngx-bootstrap-icons'
|
|
||||||
import {
|
|
||||||
ADVANCED_SEARCH_DATE_KEYWORD_LABELS,
|
|
||||||
ADVANCED_SEARCH_DATE_KEYWORDS,
|
|
||||||
ADVANCED_SEARCH_DATE_OPERATOR_LABELS,
|
|
||||||
ADVANCED_SEARCH_DATE_UNIT_LABELS,
|
|
||||||
ADVANCED_SEARCH_FIELD_GROUPS,
|
|
||||||
ADVANCED_SEARCH_FIELD_KINDS,
|
|
||||||
ADVANCED_SEARCH_FIELD_LABELS,
|
|
||||||
ADVANCED_SEARCH_MAX_ATOMS,
|
|
||||||
ADVANCED_SEARCH_MAX_DEPTH,
|
|
||||||
ADVANCED_SEARCH_OPERATOR_LABELS,
|
|
||||||
ADVANCED_SEARCH_OPERATORS_BY_KIND,
|
|
||||||
AdvancedSearchDateUnit,
|
|
||||||
AdvancedSearchField,
|
|
||||||
AdvancedSearchFieldKind,
|
|
||||||
AdvancedSearchLogicalOperator,
|
|
||||||
AdvancedSearchOperator,
|
|
||||||
AdvancedSearchQueryAtom,
|
|
||||||
AdvancedSearchQueryElement,
|
|
||||||
AdvancedSearchQueryElementType,
|
|
||||||
AdvancedSearchQueryGroup,
|
|
||||||
} from 'src/app/data/advanced-search-query'
|
|
||||||
import {
|
|
||||||
parseAdvancedSearchQuery,
|
|
||||||
serializeAdvancedSearchQuery,
|
|
||||||
} from 'src/app/utils/advanced-search-query'
|
|
||||||
import { LoadingComponentWithPermissions } from '../../loading-component/loading.component'
|
|
||||||
|
|
||||||
@Component({
|
|
||||||
selector: 'pngx-advanced-search-dialog',
|
|
||||||
templateUrl: './advanced-search-dialog.component.html',
|
|
||||||
styleUrl: './advanced-search-dialog.component.scss',
|
|
||||||
imports: [FormsModule, NgTemplateOutlet, NgxBootstrapIconsModule],
|
|
||||||
})
|
|
||||||
export class AdvancedSearchDialogComponent extends LoadingComponentWithPermissions {
|
|
||||||
private activeModal = inject(NgbActiveModal)
|
|
||||||
|
|
||||||
public readonly ElementType = AdvancedSearchQueryElementType
|
|
||||||
public readonly LogicalOperator = AdvancedSearchLogicalOperator
|
|
||||||
public readonly Operator = AdvancedSearchOperator
|
|
||||||
public readonly FieldKind = AdvancedSearchFieldKind
|
|
||||||
public readonly fieldGroups = ADVANCED_SEARCH_FIELD_GROUPS
|
|
||||||
public readonly fieldLabels = ADVANCED_SEARCH_FIELD_LABELS
|
|
||||||
public readonly dateKeywords = ADVANCED_SEARCH_DATE_KEYWORDS
|
|
||||||
public readonly dateKeywordLabels = ADVANCED_SEARCH_DATE_KEYWORD_LABELS
|
|
||||||
public readonly dateUnits = Object.values(AdvancedSearchDateUnit)
|
|
||||||
public readonly dateUnitLabels = ADVANCED_SEARCH_DATE_UNIT_LABELS
|
|
||||||
public readonly maxDepth = ADVANCED_SEARCH_MAX_DEPTH
|
|
||||||
public readonly maxAtoms = ADVANCED_SEARCH_MAX_ATOMS
|
|
||||||
|
|
||||||
@Output()
|
|
||||||
public queryApplied = new EventEmitter<string>()
|
|
||||||
|
|
||||||
public root: AdvancedSearchQueryGroup = this.emptyRoot()
|
|
||||||
|
|
||||||
// True when the query in the search box uses syntax the editor cannot show
|
|
||||||
public unreadable: boolean = false
|
|
||||||
|
|
||||||
private _query: string = ''
|
|
||||||
|
|
||||||
@Input()
|
|
||||||
set query(query: string) {
|
|
||||||
this._query = query ?? ''
|
|
||||||
const parsed = parseAdvancedSearchQuery(this._query)
|
|
||||||
this.unreadable = !!this._query.trim() && !parsed
|
|
||||||
this.root = parsed ?? this.emptyRoot()
|
|
||||||
}
|
|
||||||
|
|
||||||
get query(): string {
|
|
||||||
return this._query
|
|
||||||
}
|
|
||||||
|
|
||||||
constructor() {
|
|
||||||
super()
|
|
||||||
this.loading.set(false)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Stable ids for the radio groups, without putting them in the query model
|
|
||||||
private ids = new WeakMap<object, number>()
|
|
||||||
private nextId = 0
|
|
||||||
|
|
||||||
public idFor(element: AdvancedSearchQueryElement): number {
|
|
||||||
if (!this.ids.has(element)) {
|
|
||||||
this.ids.set(element, this.nextId++)
|
|
||||||
}
|
|
||||||
return this.ids.get(element)
|
|
||||||
}
|
|
||||||
|
|
||||||
private emptyRoot(): AdvancedSearchQueryGroup {
|
|
||||||
return {
|
|
||||||
type: AdvancedSearchQueryElementType.Group,
|
|
||||||
operator: AdvancedSearchLogicalOperator.And,
|
|
||||||
children: [this.newAtom()],
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
private newAtom(): AdvancedSearchQueryAtom {
|
|
||||||
return {
|
|
||||||
type: AdvancedSearchQueryElementType.Atom,
|
|
||||||
field: AdvancedSearchField.Content,
|
|
||||||
operator: AdvancedSearchOperator.AllWords,
|
|
||||||
value: '',
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
public get generatedQuery(): string {
|
|
||||||
return serializeAdvancedSearchQuery(this.root)
|
|
||||||
}
|
|
||||||
|
|
||||||
public kindOf(atom: AdvancedSearchQueryAtom): AdvancedSearchFieldKind {
|
|
||||||
return ADVANCED_SEARCH_FIELD_KINDS[atom.field]
|
|
||||||
}
|
|
||||||
|
|
||||||
public operatorsFor(atom: AdvancedSearchQueryAtom): AdvancedSearchOperator[] {
|
|
||||||
return ADVANCED_SEARCH_OPERATORS_BY_KIND[this.kindOf(atom)]
|
|
||||||
}
|
|
||||||
|
|
||||||
public operatorLabel(
|
|
||||||
atom: AdvancedSearchQueryAtom,
|
|
||||||
operator: AdvancedSearchOperator
|
|
||||||
): string {
|
|
||||||
return this.kindOf(atom) === AdvancedSearchFieldKind.Date
|
|
||||||
? (ADVANCED_SEARCH_DATE_OPERATOR_LABELS[operator] ??
|
|
||||||
ADVANCED_SEARCH_OPERATOR_LABELS[operator])
|
|
||||||
: ADVANCED_SEARCH_OPERATOR_LABELS[operator]
|
|
||||||
}
|
|
||||||
|
|
||||||
public placeholderFor(atom: AdvancedSearchQueryAtom): string {
|
|
||||||
switch (atom.operator) {
|
|
||||||
case AdvancedSearchOperator.Phrase:
|
|
||||||
return $localize`phrase`
|
|
||||||
case AdvancedSearchOperator.StartsWith:
|
|
||||||
return $localize`beginning of a word`
|
|
||||||
default:
|
|
||||||
return $localize`words`
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
public onFieldChange(atom: AdvancedSearchQueryAtom) {
|
|
||||||
// Keep the condition only if the new field still offers it
|
|
||||||
if (!this.operatorsFor(atom).includes(atom.operator)) {
|
|
||||||
atom.operator = this.operatorsFor(atom)[0]
|
|
||||||
}
|
|
||||||
this.clearValues(atom)
|
|
||||||
}
|
|
||||||
|
|
||||||
public onOperatorChange(atom: AdvancedSearchQueryAtom) {
|
|
||||||
this.clearValues(atom)
|
|
||||||
}
|
|
||||||
|
|
||||||
private clearValues(atom: AdvancedSearchQueryAtom) {
|
|
||||||
atom.value = ''
|
|
||||||
atom.valueTo = undefined
|
|
||||||
atom.unit =
|
|
||||||
atom.operator === AdvancedSearchOperator.WithinLast
|
|
||||||
? AdvancedSearchDateUnit.Day
|
|
||||||
: undefined
|
|
||||||
}
|
|
||||||
|
|
||||||
public addAtom(group: AdvancedSearchQueryGroup) {
|
|
||||||
group.children.push(this.newAtom())
|
|
||||||
}
|
|
||||||
|
|
||||||
public addGroup(group: AdvancedSearchQueryGroup) {
|
|
||||||
group.children.push({
|
|
||||||
type: AdvancedSearchQueryElementType.Group,
|
|
||||||
operator: AdvancedSearchLogicalOperator.Or,
|
|
||||||
children: [this.newAtom()],
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
public remove(
|
|
||||||
parent: AdvancedSearchQueryGroup,
|
|
||||||
element: AdvancedSearchQueryElement
|
|
||||||
) {
|
|
||||||
parent.children = parent.children.filter((child) => child !== element)
|
|
||||||
}
|
|
||||||
|
|
||||||
public startOver() {
|
|
||||||
this.unreadable = false
|
|
||||||
this.root = this.emptyRoot()
|
|
||||||
}
|
|
||||||
|
|
||||||
public apply() {
|
|
||||||
this.queryApplied.emit(this.generatedQuery)
|
|
||||||
this.activeModal.close()
|
|
||||||
}
|
|
||||||
|
|
||||||
public cancel() {
|
|
||||||
this.activeModal.close()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -154,11 +154,29 @@
|
|||||||
& section {
|
& section {
|
||||||
position: absolute;
|
position: absolute;
|
||||||
text-align: initial;
|
text-align: initial;
|
||||||
|
pointer-events: auto;
|
||||||
box-sizing: border-box;
|
box-sizing: border-box;
|
||||||
transform-origin: 0 0;
|
transform-origin: 0 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
& :is(.linkAnnotation, .buttonWidgetAnnotation.pushButton) > a {
|
||||||
|
position: absolute;
|
||||||
|
inset: 0;
|
||||||
|
font-size: 1em;
|
||||||
|
transition: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
& :is(.linkAnnotation, .buttonWidgetAnnotation.pushButton):not(.hasBorder)
|
||||||
|
> a:hover {
|
||||||
|
opacity: 0.2;
|
||||||
|
background-color: rgb(255 255 0);
|
||||||
|
}
|
||||||
|
|
||||||
& .annotationTextContent {
|
& .annotationTextContent {
|
||||||
opacity: 0;
|
opacity: 0;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
:host ::ng-deep .textLayer.selecting ~ .annotationLayer section {
|
||||||
|
pointer-events: none;
|
||||||
|
}
|
||||||
|
|||||||
@@ -1,7 +1,11 @@
|
|||||||
import { SimpleChange } from '@angular/core'
|
import { SimpleChange } from '@angular/core'
|
||||||
import { ComponentFixture, TestBed } from '@angular/core/testing'
|
import { ComponentFixture, TestBed } from '@angular/core/testing'
|
||||||
import * as pdfjs from 'pdfjs-dist/legacy/build/pdf.mjs'
|
import * as pdfjs from 'pdfjs-dist/legacy/build/pdf.mjs'
|
||||||
import { PDFSinglePageViewer, PDFViewer } from 'pdfjs-dist/web/pdf_viewer.mjs'
|
import {
|
||||||
|
LinkTarget,
|
||||||
|
PDFSinglePageViewer,
|
||||||
|
PDFViewer,
|
||||||
|
} from 'pdfjs-dist/web/pdf_viewer.mjs'
|
||||||
import { PngxPdfViewerComponent } from './pdf-viewer.component'
|
import { PngxPdfViewerComponent } from './pdf-viewer.component'
|
||||||
import { PdfRenderMode, PdfZoomLevel, PdfZoomScale } from './pdf-viewer.types'
|
import { PdfRenderMode, PdfZoomLevel, PdfZoomScale } from './pdf-viewer.types'
|
||||||
|
|
||||||
@@ -58,6 +62,16 @@ describe('PngxPdfViewerComponent', () => {
|
|||||||
expect((component as any).pdfViewer).toBeInstanceOf(PDFViewer)
|
expect((component as any).pdfViewer).toBeInstanceOf(PDFViewer)
|
||||||
})
|
})
|
||||||
|
|
||||||
|
it('opens external links in a new tab', () => {
|
||||||
|
const linkService = (component as any).linkService
|
||||||
|
expect(linkService.options).toEqual(
|
||||||
|
expect.objectContaining({
|
||||||
|
externalLinkTarget: LinkTarget.BLANK,
|
||||||
|
externalLinkRel: 'noopener noreferrer nofollow',
|
||||||
|
})
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
it('resolves the worker source relative to the document base URI', async () => {
|
it('resolves the worker source relative to the document base URI', async () => {
|
||||||
setBaseHref('/paperless/')
|
setBaseHref('/paperless/')
|
||||||
const getDocumentSpy = jest.spyOn(pdfjs, 'getDocument')
|
const getDocumentSpy = jest.spyOn(pdfjs, 'getDocument')
|
||||||
@@ -76,6 +90,7 @@ describe('PngxPdfViewerComponent', () => {
|
|||||||
withCredentials: true,
|
withCredentials: true,
|
||||||
wasmUrl: expect.stringContaining('/paperless/assets/wasm/'),
|
wasmUrl: expect.stringContaining('/paperless/assets/wasm/'),
|
||||||
iccUrl: expect.stringContaining('/paperless/assets/iccs/'),
|
iccUrl: expect.stringContaining('/paperless/assets/iccs/'),
|
||||||
|
cMapUrl: expect.stringContaining('/paperless/assets/cmaps/'),
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|
||||||
|
|||||||
@@ -21,6 +21,7 @@ import {
|
|||||||
} from 'pdfjs-dist/legacy/build/pdf.mjs'
|
} from 'pdfjs-dist/legacy/build/pdf.mjs'
|
||||||
import {
|
import {
|
||||||
EventBus,
|
EventBus,
|
||||||
|
LinkTarget,
|
||||||
PDFFindController,
|
PDFFindController,
|
||||||
PDFLinkService,
|
PDFLinkService,
|
||||||
PDFSinglePageViewer,
|
PDFSinglePageViewer,
|
||||||
@@ -75,7 +76,11 @@ export class PngxPdfViewerComponent
|
|||||||
private lastViewerPage?: number
|
private lastViewerPage?: number
|
||||||
|
|
||||||
private readonly eventBus = new EventBus()
|
private readonly eventBus = new EventBus()
|
||||||
private readonly linkService = new PDFLinkService({ eventBus: this.eventBus })
|
private readonly linkService = new PDFLinkService({
|
||||||
|
eventBus: this.eventBus,
|
||||||
|
externalLinkTarget: LinkTarget.BLANK,
|
||||||
|
externalLinkRel: 'noopener noreferrer nofollow',
|
||||||
|
})
|
||||||
private readonly findController = new PDFFindController({
|
private readonly findController = new PDFFindController({
|
||||||
eventBus: this.eventBus,
|
eventBus: this.eventBus,
|
||||||
linkService: this.linkService,
|
linkService: this.linkService,
|
||||||
@@ -185,6 +190,7 @@ export class PngxPdfViewerComponent
|
|||||||
withCredentials: true,
|
withCredentials: true,
|
||||||
wasmUrl: new URL('assets/wasm/', this.document.baseURI).toString(),
|
wasmUrl: new URL('assets/wasm/', this.document.baseURI).toString(),
|
||||||
iccUrl: new URL('assets/iccs/', this.document.baseURI).toString(),
|
iccUrl: new URL('assets/iccs/', this.document.baseURI).toString(),
|
||||||
|
cMapUrl: new URL('assets/cmaps/', this.document.baseURI).toString(),
|
||||||
}
|
}
|
||||||
this.loadingTask = getDocument(initOptions)
|
this.loadingTask = getDocument(initOptions)
|
||||||
try {
|
try {
|
||||||
|
|||||||
+28
-2
@@ -1,11 +1,12 @@
|
|||||||
<div class="btn-group">
|
<div class="d-flex align-items-center">
|
||||||
|
<div class="btn-group">
|
||||||
<button type="button" class="btn btn-sm btn-outline-primary" (click)="clickSuggest()" [disabled]="disabled() || loading() || (suggestions() && !aiEnabled())" [aria-label]="noSuggestions ? 'No suggestions' : 'Suggest'" i18n-aria-label>
|
<button type="button" class="btn btn-sm btn-outline-primary" (click)="clickSuggest()" [disabled]="disabled() || loading() || (suggestions() && !aiEnabled())" [aria-label]="noSuggestions ? 'No suggestions' : 'Suggest'" i18n-aria-label>
|
||||||
@if (loading()) {
|
@if (loading()) {
|
||||||
<div class="spinner-border spinner-border-sm" role="status"></div>
|
<div class="spinner-border spinner-border-sm" role="status"></div>
|
||||||
} @else if (noSuggestions) {
|
} @else if (noSuggestions) {
|
||||||
<i-bs width="1.2em" height="1.2em" name="check-circle"></i-bs>
|
<i-bs width="1.2em" height="1.2em" name="check-circle"></i-bs>
|
||||||
} @else {
|
} @else {
|
||||||
<i-bs width="1.2em" height="1.2em" name="stars"></i-bs>
|
<i-bs width="1.2em" height="1.2em" name="lightbulb"></i-bs>
|
||||||
}
|
}
|
||||||
@if (noSuggestions) {
|
@if (noSuggestions) {
|
||||||
<span class="d-none d-lg-inline ps-1" i18n>No suggestions</span>
|
<span class="d-none d-lg-inline ps-1" i18n>No suggestions</span>
|
||||||
@@ -57,4 +58,29 @@
|
|||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
}
|
}
|
||||||
|
</div>
|
||||||
|
|
||||||
|
@if (aiEnabled()) {
|
||||||
|
<div ngbDropdown autoClose="outside" placement="bottom-end" [popperOptions]="popperOptions">
|
||||||
|
<button type="button" class="btn btn-sm btn-link position-relative" ngbDropdownToggle [disabled]="disabled() || loading()" i18n-title title="Suggestion options">
|
||||||
|
<i-bs name="three-dots"></i-bs>
|
||||||
|
@if (source() !== defaultSource()) {
|
||||||
|
<span class="position-absolute top-0 start-100 translate-middle p-1 bg-primary border border-light rounded-circle">
|
||||||
|
<span class="visually-hidden" i18n>Not using default</span>
|
||||||
|
</span>
|
||||||
|
}
|
||||||
|
</button>
|
||||||
|
<div ngbDropdownMenu class="shadow p-3">
|
||||||
|
<div class="small text-muted mb-2" i18n>Suggest using:</div>
|
||||||
|
<div class="form-check small">
|
||||||
|
<input class="form-check-input" type="checkbox" id="suggestionSourceML" [checked]="useML" [disabled]="useML && !useAI" (change)="setSources($event.target.checked, useAI)">
|
||||||
|
<label class="form-check-label d-inline-flex align-items-center gap-1" for="suggestionSourceML"><i-bs name="cpu"></i-bs><ng-container i18n>ML</ng-container></label>
|
||||||
|
</div>
|
||||||
|
<div class="form-check small">
|
||||||
|
<input class="form-check-input" type="checkbox" id="suggestionSourceAI" [checked]="useAI" [disabled]="useAI && !useML" (change)="setSources(useML, $event.target.checked)">
|
||||||
|
<label class="form-check-label d-inline-flex align-items-center gap-1" for="suggestionSourceAI"><i-bs name="stars"></i-bs><ng-container i18n>AI</ng-container></label>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
}
|
||||||
</div>
|
</div>
|
||||||
|
|||||||
+4
@@ -1,3 +1,7 @@
|
|||||||
.suggestions-dropdown {
|
.suggestions-dropdown {
|
||||||
min-width: 250px;
|
min-width: 250px;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
.btn-link.dropdown-toggle::after {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|||||||
+59
-1
@@ -1,6 +1,7 @@
|
|||||||
import { ComponentFixture, TestBed } from '@angular/core/testing'
|
import { ComponentFixture, TestBed } from '@angular/core/testing'
|
||||||
import { NgbDropdownModule } from '@ng-bootstrap/ng-bootstrap'
|
import { NgbDropdownModule } from '@ng-bootstrap/ng-bootstrap'
|
||||||
import { NgxBootstrapIconsModule, allIcons } from 'ngx-bootstrap-icons'
|
import { NgxBootstrapIconsModule, allIcons } from 'ngx-bootstrap-icons'
|
||||||
|
import { SuggestionSource } from 'src/app/data/ui-settings'
|
||||||
import { SuggestionsDropdownComponent } from './suggestions-dropdown.component'
|
import { SuggestionsDropdownComponent } from './suggestions-dropdown.component'
|
||||||
|
|
||||||
describe('SuggestionsDropdownComponent', () => {
|
describe('SuggestionsDropdownComponent', () => {
|
||||||
@@ -179,14 +180,71 @@ describe('SuggestionsDropdownComponent', () => {
|
|||||||
|
|
||||||
it('should toggle dropdown when clickSuggest is called and suggestions are not null', () => {
|
it('should toggle dropdown when clickSuggest is called and suggestions are not null', () => {
|
||||||
fixture.componentRef.setInput('aiEnabled', true)
|
fixture.componentRef.setInput('aiEnabled', true)
|
||||||
|
fixture.componentRef.setInput('fetchedSources', [SuggestionSource.ML])
|
||||||
fixture.detectChanges()
|
fixture.detectChanges()
|
||||||
fixture.componentRef.setInput('suggestions', {
|
fixture.componentRef.setInput('suggestions', {
|
||||||
suggested_correspondents: [],
|
suggested_correspondents: [],
|
||||||
suggested_tags: [],
|
suggested_tags: [],
|
||||||
suggested_document_types: [],
|
suggested_document_types: [],
|
||||||
})
|
})
|
||||||
|
fixture.detectChanges()
|
||||||
component.clickSuggest()
|
component.clickSuggest()
|
||||||
expect(component.dropdown.open).toBeTruthy()
|
expect(component.dropdown.isOpen()).toBeTruthy()
|
||||||
expect(fixture.nativeElement.textContent).toContain('No novel suggestions')
|
expect(fixture.nativeElement.textContent).toContain('No novel suggestions')
|
||||||
})
|
})
|
||||||
|
|
||||||
|
it('should fetch unfetched sources and show existing suggestions', () => {
|
||||||
|
jest.spyOn(component.getSuggestions, 'emit')
|
||||||
|
fixture.componentRef.setInput('aiEnabled', true)
|
||||||
|
fixture.componentRef.setInput('source', SuggestionSource.Both)
|
||||||
|
fixture.componentRef.setInput('fetchedSources', [SuggestionSource.ML])
|
||||||
|
fixture.componentRef.setInput('suggestions', { tags: [1] })
|
||||||
|
fixture.detectChanges()
|
||||||
|
component.clickSuggest()
|
||||||
|
expect(component.getSuggestions.emit).toHaveBeenCalledWith(
|
||||||
|
SuggestionSource.Both
|
||||||
|
)
|
||||||
|
expect(component.dropdown.isOpen()).toBeTruthy()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should only show source options when AI is enabled', () => {
|
||||||
|
expect(
|
||||||
|
fixture.nativeElement.querySelector('#suggestionSourceML')
|
||||||
|
).toBeNull()
|
||||||
|
fixture.componentRef.setInput('aiEnabled', true)
|
||||||
|
fixture.detectChanges()
|
||||||
|
fixture.nativeElement
|
||||||
|
.querySelector('button[title="Suggestion options"]')
|
||||||
|
.click()
|
||||||
|
fixture.detectChanges()
|
||||||
|
expect(
|
||||||
|
fixture.nativeElement.querySelector('#suggestionSourceML')
|
||||||
|
).not.toBeNull()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should emit source changes and never allow no source', () => {
|
||||||
|
const emitSpy = jest.spyOn(component.sourceChange, 'emit')
|
||||||
|
component.setSources(true, true)
|
||||||
|
expect(emitSpy).toHaveBeenCalledWith(SuggestionSource.Both)
|
||||||
|
component.setSources(true, false)
|
||||||
|
expect(emitSpy).toHaveBeenCalledWith(SuggestionSource.ML)
|
||||||
|
component.setSources(false, true)
|
||||||
|
expect(emitSpy).toHaveBeenCalledWith(SuggestionSource.AI)
|
||||||
|
|
||||||
|
emitSpy.mockClear()
|
||||||
|
component.setSources(false, false)
|
||||||
|
expect(emitSpy).not.toHaveBeenCalled()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should indicate a non-default source', () => {
|
||||||
|
fixture.componentRef.setInput('aiEnabled', true)
|
||||||
|
fixture.componentRef.setInput('source', SuggestionSource.AI)
|
||||||
|
fixture.componentRef.setInput('defaultSource', SuggestionSource.AI)
|
||||||
|
fixture.detectChanges()
|
||||||
|
expect(fixture.nativeElement.textContent).not.toContain('Not using default')
|
||||||
|
|
||||||
|
fixture.componentRef.setInput('source', SuggestionSource.Both)
|
||||||
|
fixture.detectChanges()
|
||||||
|
expect(fixture.nativeElement.textContent).toContain('Not using default')
|
||||||
|
})
|
||||||
})
|
})
|
||||||
|
|||||||
+40
-3
@@ -8,6 +8,7 @@ import {
|
|||||||
import { NgbDropdown, NgbDropdownModule } from '@ng-bootstrap/ng-bootstrap'
|
import { NgbDropdown, NgbDropdownModule } from '@ng-bootstrap/ng-bootstrap'
|
||||||
import { NgxBootstrapIconsModule } from 'ngx-bootstrap-icons'
|
import { NgxBootstrapIconsModule } from 'ngx-bootstrap-icons'
|
||||||
import { DocumentSuggestions } from 'src/app/data/document-suggestions'
|
import { DocumentSuggestions } from 'src/app/data/document-suggestions'
|
||||||
|
import { SuggestionSource } from 'src/app/data/ui-settings'
|
||||||
import { pngxPopperOptions } from 'src/app/utils/popper-options'
|
import { pngxPopperOptions } from 'src/app/utils/popper-options'
|
||||||
|
|
||||||
@Component({
|
@Component({
|
||||||
@@ -18,12 +19,16 @@ import { pngxPopperOptions } from 'src/app/utils/popper-options'
|
|||||||
})
|
})
|
||||||
export class SuggestionsDropdownComponent {
|
export class SuggestionsDropdownComponent {
|
||||||
public popperOptions = pngxPopperOptions
|
public popperOptions = pngxPopperOptions
|
||||||
|
public readonly SuggestionSource = SuggestionSource
|
||||||
|
|
||||||
@ViewChild('dropdown') dropdown: NgbDropdown
|
@ViewChild('dropdown') dropdown: NgbDropdown
|
||||||
readonly suggestions = input<DocumentSuggestions>(null)
|
readonly suggestions = input<DocumentSuggestions>(null)
|
||||||
readonly aiEnabled = input(false)
|
readonly aiEnabled = input(false)
|
||||||
readonly loading = input(false)
|
readonly loading = input(false)
|
||||||
readonly disabled = input(false)
|
readonly disabled = input(false)
|
||||||
|
readonly source = input<SuggestionSource>(SuggestionSource.ML)
|
||||||
|
readonly defaultSource = input<SuggestionSource>(SuggestionSource.ML)
|
||||||
|
readonly fetchedSources = input<SuggestionSource[]>([])
|
||||||
|
|
||||||
readonly appliedTags = input<number[]>([])
|
readonly appliedTags = input<number[]>([])
|
||||||
readonly appliedCorrespondent = input<number>(null)
|
readonly appliedCorrespondent = input<number>(null)
|
||||||
@@ -31,8 +36,10 @@ export class SuggestionsDropdownComponent {
|
|||||||
readonly appliedStoragePath = input<number>(null)
|
readonly appliedStoragePath = input<number>(null)
|
||||||
|
|
||||||
@Output()
|
@Output()
|
||||||
getSuggestions: EventEmitter<SuggestionsDropdownComponent> =
|
getSuggestions: EventEmitter<SuggestionSource> = new EventEmitter()
|
||||||
new EventEmitter()
|
|
||||||
|
@Output()
|
||||||
|
sourceChange: EventEmitter<SuggestionSource> = new EventEmitter()
|
||||||
|
|
||||||
@Output()
|
@Output()
|
||||||
addTag: EventEmitter<string> = new EventEmitter()
|
addTag: EventEmitter<string> = new EventEmitter()
|
||||||
@@ -53,12 +60,42 @@ export class SuggestionsDropdownComponent {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if (!this.suggestions()) {
|
if (!this.suggestions()) {
|
||||||
this.getSuggestions.emit(this)
|
this.getSuggestions.emit(this.source())
|
||||||
|
} else if (this.hasUnfetchedSources) {
|
||||||
|
// sources changed, fetch the rest and show what we have meanwhile
|
||||||
|
this.getSuggestions.emit(this.source())
|
||||||
|
this.dropdown?.open()
|
||||||
} else {
|
} else {
|
||||||
this.dropdown?.toggle()
|
this.dropdown?.toggle()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
get useML(): boolean {
|
||||||
|
return this.source() !== SuggestionSource.AI
|
||||||
|
}
|
||||||
|
|
||||||
|
get useAI(): boolean {
|
||||||
|
return this.source() !== SuggestionSource.ML
|
||||||
|
}
|
||||||
|
|
||||||
|
get hasUnfetchedSources(): boolean {
|
||||||
|
const fetched = this.fetchedSources()
|
||||||
|
return (
|
||||||
|
(this.useML && !fetched.includes(SuggestionSource.ML)) ||
|
||||||
|
(this.useAI && !fetched.includes(SuggestionSource.AI))
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
public setSources(ml: boolean, ai: boolean) {
|
||||||
|
if (ml && ai) {
|
||||||
|
this.sourceChange.emit(SuggestionSource.Both)
|
||||||
|
} else if (ml) {
|
||||||
|
this.sourceChange.emit(SuggestionSource.ML)
|
||||||
|
} else if (ai) {
|
||||||
|
this.sourceChange.emit(SuggestionSource.AI)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
get novelSuggestions(): number {
|
get novelSuggestions(): number {
|
||||||
return (
|
return (
|
||||||
(this.suggestions()?.suggested_correspondents?.length ?? 0) +
|
(this.suggestions()?.suggested_correspondents?.length ?? 0) +
|
||||||
|
|||||||
@@ -134,11 +134,15 @@
|
|||||||
[loading]="suggestionsLoading()"
|
[loading]="suggestionsLoading()"
|
||||||
[suggestions]="suggestions()"
|
[suggestions]="suggestions()"
|
||||||
[aiEnabled]="aiEnabled"
|
[aiEnabled]="aiEnabled"
|
||||||
|
[source]="suggestionSource"
|
||||||
|
[defaultSource]="defaultSuggestionSource"
|
||||||
|
[fetchedSources]="fetchedSuggestionSources()"
|
||||||
[appliedTags]="documentForm.value.tags"
|
[appliedTags]="documentForm.value.tags"
|
||||||
[appliedCorrespondent]="documentForm.value.correspondent"
|
[appliedCorrespondent]="documentForm.value.correspondent"
|
||||||
[appliedDocumentType]="documentForm.value.document_type"
|
[appliedDocumentType]="documentForm.value.document_type"
|
||||||
[appliedStoragePath]="documentForm.value.storage_path"
|
[appliedStoragePath]="documentForm.value.storage_path"
|
||||||
(getSuggestions)="getSuggestions()"
|
(getSuggestions)="getSuggestions($event)"
|
||||||
|
(sourceChange)="suggestionSourceOverride.set($event)"
|
||||||
(addTag)="createTag($event)"
|
(addTag)="createTag($event)"
|
||||||
(addDocumentType)="createDocumentType($event)"
|
(addDocumentType)="createDocumentType($event)"
|
||||||
(addCorrespondent)="createCorrespondent($event)">
|
(addCorrespondent)="createCorrespondent($event)">
|
||||||
|
|||||||
@@ -43,7 +43,7 @@ import {
|
|||||||
} from 'src/app/data/filter-rule-type'
|
} from 'src/app/data/filter-rule-type'
|
||||||
import { StoragePath } from 'src/app/data/storage-path'
|
import { StoragePath } from 'src/app/data/storage-path'
|
||||||
import { Tag } from 'src/app/data/tag'
|
import { Tag } from 'src/app/data/tag'
|
||||||
import { SETTINGS_KEYS } from 'src/app/data/ui-settings'
|
import { SETTINGS_KEYS, SuggestionSource } from 'src/app/data/ui-settings'
|
||||||
import { PermissionsGuard } from 'src/app/guards/permissions.guard'
|
import { PermissionsGuard } from 'src/app/guards/permissions.guard'
|
||||||
import { CustomDatePipe } from 'src/app/pipes/custom-date.pipe'
|
import { CustomDatePipe } from 'src/app/pipes/custom-date.pipe'
|
||||||
import { DocumentTitlePipe } from 'src/app/pipes/document-title.pipe'
|
import { DocumentTitlePipe } from 'src/app/pipes/document-title.pipe'
|
||||||
@@ -1528,6 +1528,113 @@ describe('DocumentDetailComponent', () => {
|
|||||||
expect(component.suggestionsLoading()).toBeFalsy()
|
expect(component.suggestionsLoading()).toBeFalsy()
|
||||||
})
|
})
|
||||||
|
|
||||||
|
it('should get and merge ML and AI suggestions when source is both', () => {
|
||||||
|
settingsService.set(
|
||||||
|
SETTINGS_KEYS.DOCUMENT_EDITING_SUGGESTION_SOURCE,
|
||||||
|
SuggestionSource.Both
|
||||||
|
)
|
||||||
|
const getSetting = settingsService.get.bind(settingsService)
|
||||||
|
jest
|
||||||
|
.spyOn(settingsService, 'get')
|
||||||
|
.mockImplementation((key) =>
|
||||||
|
key === SETTINGS_KEYS.AI_ENABLED ? true : getSetting(key)
|
||||||
|
)
|
||||||
|
const suggestionsSpy = jest
|
||||||
|
.spyOn(documentService, 'getSuggestions')
|
||||||
|
.mockReturnValue(of({ tags: [42], dates: ['2024-01-01'] }))
|
||||||
|
const aiSuggestionsSpy = jest
|
||||||
|
.spyOn(documentService, 'getAiSuggestions')
|
||||||
|
.mockReturnValue(
|
||||||
|
of({ title: 'AI title', tags: [42, 43], suggested_tags: ['New'] })
|
||||||
|
)
|
||||||
|
initNormally()
|
||||||
|
expect(suggestionsSpy).toHaveBeenCalled()
|
||||||
|
expect(aiSuggestionsSpy).toHaveBeenCalled()
|
||||||
|
expect(component.suggestions().title).toEqual('AI title')
|
||||||
|
expect(component.suggestions().tags).toEqual([42, 43])
|
||||||
|
expect(component.suggestions().suggested_tags).toEqual(['New'])
|
||||||
|
expect(component.suggestions().dates).toEqual(['2024-01-01'])
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should only fetch sources not yet fetched for the document', () => {
|
||||||
|
settingsService.set(SETTINGS_KEYS.DOCUMENT_EDITING_AUTO_SUGGEST, false)
|
||||||
|
settingsService.set(
|
||||||
|
SETTINGS_KEYS.DOCUMENT_EDITING_SUGGESTION_SOURCE,
|
||||||
|
SuggestionSource.ML
|
||||||
|
)
|
||||||
|
const getSetting = settingsService.get.bind(settingsService)
|
||||||
|
jest
|
||||||
|
.spyOn(settingsService, 'get')
|
||||||
|
.mockImplementation((key) =>
|
||||||
|
key === SETTINGS_KEYS.AI_ENABLED ? true : getSetting(key)
|
||||||
|
)
|
||||||
|
const suggestionsSpy = jest
|
||||||
|
.spyOn(documentService, 'getSuggestions')
|
||||||
|
.mockReturnValue(of({ tags: [42] }))
|
||||||
|
const aiSuggestionsSpy = jest
|
||||||
|
.spyOn(documentService, 'getAiSuggestions')
|
||||||
|
.mockReturnValue(of({ tags: [43] }))
|
||||||
|
initNormally()
|
||||||
|
|
||||||
|
component.getSuggestions()
|
||||||
|
expect(suggestionsSpy).toHaveBeenCalledTimes(1)
|
||||||
|
expect(aiSuggestionsSpy).not.toHaveBeenCalled()
|
||||||
|
|
||||||
|
component.getSuggestions(SuggestionSource.Both)
|
||||||
|
expect(suggestionsSpy).toHaveBeenCalledTimes(1)
|
||||||
|
expect(aiSuggestionsSpy).toHaveBeenCalledTimes(1)
|
||||||
|
expect(component.suggestions().tags).toEqual([42, 43])
|
||||||
|
|
||||||
|
component.getSuggestions(SuggestionSource.Both)
|
||||||
|
expect(suggestionsSpy).toHaveBeenCalledTimes(1)
|
||||||
|
expect(aiSuggestionsSpy).toHaveBeenCalledTimes(1)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should use the per-document source override and reset it on document change', () => {
|
||||||
|
settingsService.set(SETTINGS_KEYS.DOCUMENT_EDITING_AUTO_SUGGEST, false)
|
||||||
|
const getSetting = settingsService.get.bind(settingsService)
|
||||||
|
jest
|
||||||
|
.spyOn(settingsService, 'get')
|
||||||
|
.mockImplementation((key) =>
|
||||||
|
key === SETTINGS_KEYS.AI_ENABLED ? true : getSetting(key)
|
||||||
|
)
|
||||||
|
initNormally()
|
||||||
|
expect(component.suggestionSource).toEqual(SuggestionSource.AI)
|
||||||
|
component.suggestionSourceOverride.set(SuggestionSource.ML)
|
||||||
|
expect(component.suggestionSource).toEqual(SuggestionSource.ML)
|
||||||
|
|
||||||
|
jest
|
||||||
|
.spyOn(documentService, 'get')
|
||||||
|
.mockReturnValueOnce(of(Object.assign({}, doc)))
|
||||||
|
;(component as any).loadDocument(doc.id, true)
|
||||||
|
expect(component.suggestionSourceOverride()).toBeNull()
|
||||||
|
expect(component.fetchedSuggestionSources()).toEqual([])
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should keep suggestions from one source if the other fails', () => {
|
||||||
|
settingsService.set(
|
||||||
|
SETTINGS_KEYS.DOCUMENT_EDITING_SUGGESTION_SOURCE,
|
||||||
|
SuggestionSource.Both
|
||||||
|
)
|
||||||
|
const getSetting = settingsService.get.bind(settingsService)
|
||||||
|
jest
|
||||||
|
.spyOn(settingsService, 'get')
|
||||||
|
.mockImplementation((key) =>
|
||||||
|
key === SETTINGS_KEYS.AI_ENABLED ? true : getSetting(key)
|
||||||
|
)
|
||||||
|
const errorSpy = jest.spyOn(toastService, 'showError')
|
||||||
|
jest
|
||||||
|
.spyOn(documentService, 'getSuggestions')
|
||||||
|
.mockReturnValue(of({ tags: [42] }))
|
||||||
|
jest
|
||||||
|
.spyOn(documentService, 'getAiSuggestions')
|
||||||
|
.mockReturnValue(throwError(() => new Error('failed')))
|
||||||
|
initNormally()
|
||||||
|
expect(errorSpy).toHaveBeenCalled()
|
||||||
|
expect(component.suggestions().tags).toEqual([42])
|
||||||
|
expect(component.fetchedSuggestionSources()).toEqual([SuggestionSource.ML])
|
||||||
|
})
|
||||||
|
|
||||||
it('should show error if needed for get suggestions', () => {
|
it('should show error if needed for get suggestions', () => {
|
||||||
const suggestionsSpy = jest.spyOn(documentService, 'getSuggestions')
|
const suggestionsSpy = jest.spyOn(documentService, 'getSuggestions')
|
||||||
const errorSpy = jest.spyOn(toastService, 'showError')
|
const errorSpy = jest.spyOn(toastService, 'showError')
|
||||||
|
|||||||
@@ -28,7 +28,7 @@ import {
|
|||||||
import { dirtyCheck, DirtyComponent } from '@ngneat/dirty-check-forms'
|
import { dirtyCheck, DirtyComponent } from '@ngneat/dirty-check-forms'
|
||||||
import { NgxBootstrapIconsModule } from 'ngx-bootstrap-icons'
|
import { NgxBootstrapIconsModule } from 'ngx-bootstrap-icons'
|
||||||
import { DeviceDetectorService } from 'ngx-device-detector'
|
import { DeviceDetectorService } from 'ngx-device-detector'
|
||||||
import { BehaviorSubject, Observable, of, Subject, timer } from 'rxjs'
|
import { BehaviorSubject, merge, Observable, of, Subject, timer } from 'rxjs'
|
||||||
import {
|
import {
|
||||||
catchError,
|
catchError,
|
||||||
debounceTime,
|
debounceTime,
|
||||||
@@ -48,7 +48,10 @@ import { DataType } from 'src/app/data/datatype'
|
|||||||
import { Document, DocumentVersionInfo } from 'src/app/data/document'
|
import { Document, DocumentVersionInfo } from 'src/app/data/document'
|
||||||
import { DocumentMetadata } from 'src/app/data/document-metadata'
|
import { DocumentMetadata } from 'src/app/data/document-metadata'
|
||||||
import { DocumentNote } from 'src/app/data/document-note'
|
import { DocumentNote } from 'src/app/data/document-note'
|
||||||
import { DocumentSuggestions } from 'src/app/data/document-suggestions'
|
import {
|
||||||
|
DocumentSuggestions,
|
||||||
|
mergeSuggestions,
|
||||||
|
} from 'src/app/data/document-suggestions'
|
||||||
import { DocumentType } from 'src/app/data/document-type'
|
import { DocumentType } from 'src/app/data/document-type'
|
||||||
import { FilterRule } from 'src/app/data/filter-rule'
|
import { FilterRule } from 'src/app/data/filter-rule'
|
||||||
import {
|
import {
|
||||||
@@ -63,7 +66,7 @@ import {
|
|||||||
import { ObjectWithId } from 'src/app/data/object-with-id'
|
import { ObjectWithId } from 'src/app/data/object-with-id'
|
||||||
import { StoragePath } from 'src/app/data/storage-path'
|
import { StoragePath } from 'src/app/data/storage-path'
|
||||||
import { Tag } from 'src/app/data/tag'
|
import { Tag } from 'src/app/data/tag'
|
||||||
import { SETTINGS_KEYS } from 'src/app/data/ui-settings'
|
import { SETTINGS_KEYS, SuggestionSource } from 'src/app/data/ui-settings'
|
||||||
import { User } from 'src/app/data/user'
|
import { User } from 'src/app/data/user'
|
||||||
import { IfPermissionsDirective } from 'src/app/directives/if-permissions.directive'
|
import { IfPermissionsDirective } from 'src/app/directives/if-permissions.directive'
|
||||||
import { CustomDatePipe } from 'src/app/pipes/custom-date.pipe'
|
import { CustomDatePipe } from 'src/app/pipes/custom-date.pipe'
|
||||||
@@ -240,6 +243,10 @@ export class DocumentDetailComponent
|
|||||||
private readonly autoSuggestSetting = this.settings.getSignal<boolean>(
|
private readonly autoSuggestSetting = this.settings.getSignal<boolean>(
|
||||||
SETTINGS_KEYS.DOCUMENT_EDITING_AUTO_SUGGEST
|
SETTINGS_KEYS.DOCUMENT_EDITING_AUTO_SUGGEST
|
||||||
)
|
)
|
||||||
|
private readonly suggestionSourceSetting =
|
||||||
|
this.settings.getSignal<SuggestionSource>(
|
||||||
|
SETTINGS_KEYS.DOCUMENT_EDITING_SUGGESTION_SOURCE
|
||||||
|
)
|
||||||
private readonly hiddenFieldsSetting = this.settings.getSignal<
|
private readonly hiddenFieldsSetting = this.settings.getSignal<
|
||||||
DocumentDetailFieldID[]
|
DocumentDetailFieldID[]
|
||||||
>(SETTINGS_KEYS.DOCUMENT_DETAILS_HIDDEN_FIELDS)
|
>(SETTINGS_KEYS.DOCUMENT_DETAILS_HIDDEN_FIELDS)
|
||||||
@@ -261,6 +268,9 @@ export class DocumentDetailComponent
|
|||||||
readonly metadata = signal<DocumentMetadata>(undefined)
|
readonly metadata = signal<DocumentMetadata>(undefined)
|
||||||
readonly suggestions = signal<DocumentSuggestions>(undefined)
|
readonly suggestions = signal<DocumentSuggestions>(undefined)
|
||||||
readonly suggestionsLoading = signal(false)
|
readonly suggestionsLoading = signal(false)
|
||||||
|
// per-document, resets on navigation
|
||||||
|
readonly suggestionSourceOverride = signal<SuggestionSource>(null)
|
||||||
|
readonly fetchedSuggestionSources = signal<SuggestionSource[]>([])
|
||||||
readonly users = signal<User[]>(undefined)
|
readonly users = signal<User[]>(undefined)
|
||||||
|
|
||||||
readonly title = signal<string>(undefined)
|
readonly title = signal<string>(undefined)
|
||||||
@@ -365,6 +375,15 @@ export class DocumentDetailComponent
|
|||||||
return this.autoSuggestSetting()
|
return this.autoSuggestSetting()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
get defaultSuggestionSource(): SuggestionSource {
|
||||||
|
return this.aiEnabled ? this.suggestionSourceSetting() : SuggestionSource.ML
|
||||||
|
}
|
||||||
|
|
||||||
|
get suggestionSource(): SuggestionSource {
|
||||||
|
if (!this.aiEnabled) return SuggestionSource.ML
|
||||||
|
return this.suggestionSourceOverride() ?? this.defaultSuggestionSource
|
||||||
|
}
|
||||||
|
|
||||||
get archiveContentRenderType(): ContentRenderType {
|
get archiveContentRenderType(): ContentRenderType {
|
||||||
const hasArchiveVersion =
|
const hasArchiveVersion =
|
||||||
this.metadata()?.has_archive_version ??
|
this.metadata()?.has_archive_version ??
|
||||||
@@ -590,6 +609,8 @@ export class DocumentDetailComponent
|
|||||||
}
|
}
|
||||||
this.documentId.set(doc.id)
|
this.documentId.set(doc.id)
|
||||||
this.suggestions.set(null)
|
this.suggestions.set(null)
|
||||||
|
this.suggestionSourceOverride.set(null)
|
||||||
|
this.fetchedSuggestionSources.set([])
|
||||||
const openDocument = this.openDocumentService.getOpenDocument(
|
const openDocument = this.openDocumentService.getOpenDocument(
|
||||||
this.documentId()
|
this.documentId()
|
||||||
)
|
)
|
||||||
@@ -1077,29 +1098,44 @@ export class DocumentDetailComponent
|
|||||||
return this.documentForm.get('custom_fields') as FormArray
|
return this.documentForm.get('custom_fields') as FormArray
|
||||||
}
|
}
|
||||||
|
|
||||||
getSuggestions() {
|
getSuggestions(source: SuggestionSource = this.suggestionSource) {
|
||||||
|
const sources = (
|
||||||
|
source === SuggestionSource.Both
|
||||||
|
? [SuggestionSource.ML, SuggestionSource.AI]
|
||||||
|
: [source]
|
||||||
|
).filter((s) => !this.fetchedSuggestionSources().includes(s))
|
||||||
|
if (!sources.length) return
|
||||||
|
|
||||||
this.suggestionsLoading.set(true)
|
this.suggestionsLoading.set(true)
|
||||||
const suggestionsObservable = this.aiEnabled
|
merge(
|
||||||
|
...sources.map((s) =>
|
||||||
|
(s === SuggestionSource.AI
|
||||||
? this.documentsService.getAiSuggestions(this.documentId())
|
? this.documentsService.getAiSuggestions(this.documentId())
|
||||||
: this.documentsService.getSuggestions(this.documentId())
|
: this.documentsService.getSuggestions(this.documentId())
|
||||||
suggestionsObservable
|
).pipe(
|
||||||
.pipe(
|
|
||||||
first(),
|
first(),
|
||||||
takeUntil(this.unsubscribeNotifier),
|
map((result) => ({ source: s, result })),
|
||||||
takeUntil(this.docChangeNotifier),
|
catchError((error) => {
|
||||||
finalize(() => this.suggestionsLoading.set(false))
|
|
||||||
)
|
|
||||||
.subscribe({
|
|
||||||
next: (result) => {
|
|
||||||
this.suggestions.set(result)
|
|
||||||
},
|
|
||||||
error: (error) => {
|
|
||||||
this.suggestions.set(null)
|
|
||||||
this.toastService.showError(
|
this.toastService.showError(
|
||||||
$localize`Error retrieving suggestions.`,
|
$localize`Error retrieving suggestions.`,
|
||||||
error
|
error
|
||||||
)
|
)
|
||||||
},
|
return of(null)
|
||||||
|
})
|
||||||
|
)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
.pipe(
|
||||||
|
takeUntil(this.unsubscribeNotifier),
|
||||||
|
takeUntil(this.docChangeNotifier),
|
||||||
|
finalize(() => this.suggestionsLoading.set(false))
|
||||||
|
)
|
||||||
|
.subscribe((response) => {
|
||||||
|
if (!response) return
|
||||||
|
this.fetchedSuggestionSources.update((f) => [...f, response.source])
|
||||||
|
this.suggestions.set(
|
||||||
|
mergeSuggestions(this.suggestions(), response.result)
|
||||||
|
)
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -146,6 +146,19 @@ describe('DocumentListComponent', () => {
|
|||||||
expect(reloadSpy).toHaveBeenCalled()
|
expect(reloadSpy).toHaveBeenCalled()
|
||||||
})
|
})
|
||||||
|
|
||||||
|
it('should stop reloading on document deleted after destroy', () => {
|
||||||
|
const reloadSpy = jest.spyOn(documentListService, 'reload')
|
||||||
|
const documentDeletedSubject = new Subject<boolean>()
|
||||||
|
jest
|
||||||
|
.spyOn(websocketStatusService, 'onDocumentDeleted')
|
||||||
|
.mockReturnValue(documentDeletedSubject)
|
||||||
|
fixture.detectChanges()
|
||||||
|
fixture.destroy()
|
||||||
|
reloadSpy.mockClear()
|
||||||
|
documentDeletedSubject.next(true)
|
||||||
|
expect(reloadSpy).not.toHaveBeenCalled()
|
||||||
|
})
|
||||||
|
|
||||||
it('should show score sort fields on fulltext queries', () => {
|
it('should show score sort fields on fulltext queries', () => {
|
||||||
documentListService.setFilterRules([
|
documentListService.setFilterRules([
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -270,7 +270,10 @@ export class DocumentListComponent
|
|||||||
this.list.reload()
|
this.list.reload()
|
||||||
})
|
})
|
||||||
|
|
||||||
this.websocketStatusService.onDocumentDeleted().subscribe(() => {
|
this.websocketStatusService
|
||||||
|
.onDocumentDeleted()
|
||||||
|
.pipe(takeUntil(this.unsubscribeNotifier))
|
||||||
|
.subscribe(() => {
|
||||||
this.list.reload()
|
this.list.reload()
|
||||||
})
|
})
|
||||||
|
|
||||||
|
|||||||
@@ -17,12 +17,6 @@
|
|||||||
}
|
}
|
||||||
</select>
|
</select>
|
||||||
}
|
}
|
||||||
@if (advancedSearchEditorAvailable) {
|
|
||||||
<button class="btn btn-sm btn-outline-primary" type="button" (click)="openAdvancedSearchEditor()"
|
|
||||||
title="Edit query" i18n-title [disabled]="disabled">
|
|
||||||
<i-bs name="sliders"></i-bs>
|
|
||||||
</button>
|
|
||||||
}
|
|
||||||
@if (_textFilter) {
|
@if (_textFilter) {
|
||||||
<button class="btn btn-link btn-sm px-2 position-absolute top-0 end-0 z-10" (click)="resetTextField()" aria-label="Clear search" i18n-aria-label>
|
<button class="btn btn-link btn-sm px-2 position-absolute top-0 end-0 z-10" (click)="resetTextField()" aria-label="Clear search" i18n-aria-label>
|
||||||
<i-bs width="1em" height="1em" name="x"></i-bs>
|
<i-bs width="1em" height="1em" name="x"></i-bs>
|
||||||
|
|||||||
@@ -12,8 +12,6 @@ import {
|
|||||||
NgbDatepickerModule,
|
NgbDatepickerModule,
|
||||||
NgbDropdownItem,
|
NgbDropdownItem,
|
||||||
NgbDropdownModule,
|
NgbDropdownModule,
|
||||||
NgbModal,
|
|
||||||
NgbModalRef,
|
|
||||||
NgbTypeaheadModule,
|
NgbTypeaheadModule,
|
||||||
} from '@ng-bootstrap/ng-bootstrap'
|
} from '@ng-bootstrap/ng-bootstrap'
|
||||||
import { NgSelectComponent, NgSelectModule } from '@ng-select/ng-select'
|
import { NgSelectComponent, NgSelectModule } from '@ng-select/ng-select'
|
||||||
@@ -2517,45 +2515,4 @@ describe('FilterEditorComponent', () => {
|
|||||||
|
|
||||||
expect(component.textFilter).toEqual('help ')
|
expect(component.textFilter).toEqual('help ')
|
||||||
})
|
})
|
||||||
|
|
||||||
it('should open the advanced search editor with the current query and apply the result', () => {
|
|
||||||
const modalService: NgbModal = TestBed.inject(NgbModal)
|
|
||||||
let modal: NgbModalRef
|
|
||||||
modalService.activeInstances.subscribe(
|
|
||||||
(instances) => (modal = instances[0])
|
|
||||||
)
|
|
||||||
component.textFilterTarget = 'fulltext-query'
|
|
||||||
component.updateTextFilter('title:invoice')
|
|
||||||
fixture.detectChanges()
|
|
||||||
|
|
||||||
const editorButton = fixture.debugElement.query(
|
|
||||||
By.css('button[title="Edit query"]')
|
|
||||||
)
|
|
||||||
expect(editorButton).not.toBeNull()
|
|
||||||
editorButton.triggerEventHandler('click')
|
|
||||||
fixture.detectChanges()
|
|
||||||
|
|
||||||
expect(modal.componentInstance.query).toEqual('title:invoice')
|
|
||||||
|
|
||||||
const rulesSpy = jest.spyOn(component.filterRulesChange, 'next')
|
|
||||||
modal.componentInstance.queryApplied.emit('title:invoice AND NOT tag:paid')
|
|
||||||
expect(component.textFilter).toEqual('title:invoice AND NOT tag:paid')
|
|
||||||
expect(documentService.searchQuery).toEqual(
|
|
||||||
'title:invoice AND NOT tag:paid'
|
|
||||||
)
|
|
||||||
expect(rulesSpy).toHaveBeenCalledWith([
|
|
||||||
{
|
|
||||||
rule_type: FILTER_FULLTEXT_QUERY,
|
|
||||||
value: 'title:invoice AND NOT tag:paid',
|
|
||||||
},
|
|
||||||
])
|
|
||||||
})
|
|
||||||
|
|
||||||
it('should not offer the advanced search editor for other targets', () => {
|
|
||||||
component.textFilterTarget = 'title-content'
|
|
||||||
fixture.detectChanges()
|
|
||||||
expect(
|
|
||||||
fixture.debugElement.query(By.css('button[title="Edit query"]'))
|
|
||||||
).toBeNull()
|
|
||||||
})
|
|
||||||
})
|
})
|
||||||
|
|||||||
@@ -15,13 +15,12 @@ import {
|
|||||||
import { FormsModule, ReactiveFormsModule } from '@angular/forms'
|
import { FormsModule, ReactiveFormsModule } from '@angular/forms'
|
||||||
import {
|
import {
|
||||||
NgbDropdownModule,
|
NgbDropdownModule,
|
||||||
NgbModal,
|
|
||||||
NgbTypeahead,
|
NgbTypeahead,
|
||||||
NgbTypeaheadModule,
|
NgbTypeaheadModule,
|
||||||
} from '@ng-bootstrap/ng-bootstrap'
|
} from '@ng-bootstrap/ng-bootstrap'
|
||||||
import { NgxBootstrapIconsModule } from 'ngx-bootstrap-icons'
|
import { NgxBootstrapIconsModule } from 'ngx-bootstrap-icons'
|
||||||
import { TourNgBootstrap } from 'ngx-ui-tour-ng-bootstrap'
|
import { TourNgBootstrap } from 'ngx-ui-tour-ng-bootstrap'
|
||||||
import { first, Observable, Subject, from } from 'rxjs'
|
import { Observable, Subject, from } from 'rxjs'
|
||||||
import {
|
import {
|
||||||
catchError,
|
catchError,
|
||||||
debounceTime,
|
debounceTime,
|
||||||
@@ -122,7 +121,6 @@ import {
|
|||||||
PermissionsFilterDropdownComponent,
|
PermissionsFilterDropdownComponent,
|
||||||
PermissionsSelectionModel,
|
PermissionsSelectionModel,
|
||||||
} from '../../common/permissions-filter-dropdown/permissions-filter-dropdown.component'
|
} from '../../common/permissions-filter-dropdown/permissions-filter-dropdown.component'
|
||||||
import { AdvancedSearchDialogComponent } from '../../common/advanced-search-dialog/advanced-search-dialog.component'
|
|
||||||
import { LoadingComponentWithPermissions } from '../../loading-component/loading.component'
|
import { LoadingComponentWithPermissions } from '../../loading-component/loading.component'
|
||||||
|
|
||||||
const TEXT_FILTER_TARGET_TITLE = 'title'
|
const TEXT_FILTER_TARGET_TITLE = 'title'
|
||||||
@@ -288,7 +286,6 @@ export class FilterEditorComponent
|
|||||||
permissionsService = inject(PermissionsService)
|
permissionsService = inject(PermissionsService)
|
||||||
private customFieldService = inject(CustomFieldsService)
|
private customFieldService = inject(CustomFieldsService)
|
||||||
private searchService = inject(SearchService)
|
private searchService = inject(SearchService)
|
||||||
private modalService = inject(NgbModal)
|
|
||||||
|
|
||||||
generateFilterName() {
|
generateFilterName() {
|
||||||
if (this.filterRules.length == 1) {
|
if (this.filterRules.length == 1) {
|
||||||
@@ -1375,23 +1372,6 @@ export class FilterEditorComponent
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
get advancedSearchEditorAvailable(): boolean {
|
|
||||||
return this.textFilterTarget === TEXT_FILTER_TARGET_FULLTEXT_QUERY
|
|
||||||
}
|
|
||||||
|
|
||||||
openAdvancedSearchEditor() {
|
|
||||||
const modal = this.modalService.open(AdvancedSearchDialogComponent, {
|
|
||||||
backdrop: 'static',
|
|
||||||
size: 'lg',
|
|
||||||
})
|
|
||||||
modal.componentInstance.query = this._textFilter ?? ''
|
|
||||||
modal.componentInstance.queryApplied
|
|
||||||
.pipe(first())
|
|
||||||
.subscribe((query: string) => {
|
|
||||||
this.updateTextFilter(query)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
textFilterKeydown(event: KeyboardEvent) {
|
textFilterKeydown(event: KeyboardEvent) {
|
||||||
if (event.key == 'Enter') {
|
if (event.key == 'Enter') {
|
||||||
if (event.defaultPrevented) {
|
if (event.defaultPrevented) {
|
||||||
|
|||||||
@@ -1,262 +0,0 @@
|
|||||||
// Fields and forms documented in docs/usage.md > "Document searches"
|
|
||||||
|
|
||||||
export enum AdvancedSearchField {
|
|
||||||
Any = '',
|
|
||||||
Title = 'title',
|
|
||||||
Content = 'content',
|
|
||||||
OriginalFilename = 'original_filename',
|
|
||||||
NoteText = 'notes.note',
|
|
||||||
NoteAuthor = 'notes.user',
|
|
||||||
CustomFieldName = 'custom_fields.name',
|
|
||||||
CustomFieldValue = 'custom_fields.value',
|
|
||||||
Correspondent = 'correspondent',
|
|
||||||
DocumentType = 'document_type',
|
|
||||||
StoragePath = 'storage_path',
|
|
||||||
Tag = 'tag',
|
|
||||||
ASN = 'asn',
|
|
||||||
PageCount = 'page_count',
|
|
||||||
NumNotes = 'num_notes',
|
|
||||||
Created = 'created',
|
|
||||||
Added = 'added',
|
|
||||||
Modified = 'modified',
|
|
||||||
Checksum = 'checksum',
|
|
||||||
}
|
|
||||||
|
|
||||||
export enum AdvancedSearchFieldKind {
|
|
||||||
Text = 'text',
|
|
||||||
Number = 'number',
|
|
||||||
Date = 'date',
|
|
||||||
Checksum = 'checksum',
|
|
||||||
}
|
|
||||||
|
|
||||||
export const ADVANCED_SEARCH_FIELD_KINDS: Record<
|
|
||||||
AdvancedSearchField,
|
|
||||||
AdvancedSearchFieldKind
|
|
||||||
> = {
|
|
||||||
[AdvancedSearchField.Any]: AdvancedSearchFieldKind.Text,
|
|
||||||
[AdvancedSearchField.Title]: AdvancedSearchFieldKind.Text,
|
|
||||||
[AdvancedSearchField.Content]: AdvancedSearchFieldKind.Text,
|
|
||||||
[AdvancedSearchField.OriginalFilename]: AdvancedSearchFieldKind.Text,
|
|
||||||
[AdvancedSearchField.NoteText]: AdvancedSearchFieldKind.Text,
|
|
||||||
[AdvancedSearchField.NoteAuthor]: AdvancedSearchFieldKind.Text,
|
|
||||||
[AdvancedSearchField.CustomFieldName]: AdvancedSearchFieldKind.Text,
|
|
||||||
[AdvancedSearchField.CustomFieldValue]: AdvancedSearchFieldKind.Text,
|
|
||||||
[AdvancedSearchField.Correspondent]: AdvancedSearchFieldKind.Text,
|
|
||||||
[AdvancedSearchField.DocumentType]: AdvancedSearchFieldKind.Text,
|
|
||||||
[AdvancedSearchField.StoragePath]: AdvancedSearchFieldKind.Text,
|
|
||||||
[AdvancedSearchField.Tag]: AdvancedSearchFieldKind.Text,
|
|
||||||
[AdvancedSearchField.ASN]: AdvancedSearchFieldKind.Number,
|
|
||||||
[AdvancedSearchField.PageCount]: AdvancedSearchFieldKind.Number,
|
|
||||||
[AdvancedSearchField.NumNotes]: AdvancedSearchFieldKind.Number,
|
|
||||||
[AdvancedSearchField.Created]: AdvancedSearchFieldKind.Date,
|
|
||||||
[AdvancedSearchField.Added]: AdvancedSearchFieldKind.Date,
|
|
||||||
[AdvancedSearchField.Modified]: AdvancedSearchFieldKind.Date,
|
|
||||||
[AdvancedSearchField.Checksum]: AdvancedSearchFieldKind.Checksum,
|
|
||||||
}
|
|
||||||
|
|
||||||
export enum AdvancedSearchOperator {
|
|
||||||
AllWords = 'all',
|
|
||||||
AnyWord = 'any',
|
|
||||||
Phrase = 'phrase',
|
|
||||||
StartsWith = 'prefix',
|
|
||||||
Equals = 'eq',
|
|
||||||
AtLeast = 'gte',
|
|
||||||
AtMost = 'lte',
|
|
||||||
Between = 'between',
|
|
||||||
DateKeyword = 'keyword',
|
|
||||||
WithinLast = 'within',
|
|
||||||
}
|
|
||||||
|
|
||||||
export const ADVANCED_SEARCH_OPERATORS_BY_KIND: Record<
|
|
||||||
AdvancedSearchFieldKind,
|
|
||||||
AdvancedSearchOperator[]
|
|
||||||
> = {
|
|
||||||
[AdvancedSearchFieldKind.Text]: [
|
|
||||||
AdvancedSearchOperator.AllWords,
|
|
||||||
AdvancedSearchOperator.AnyWord,
|
|
||||||
AdvancedSearchOperator.Phrase,
|
|
||||||
AdvancedSearchOperator.StartsWith,
|
|
||||||
],
|
|
||||||
[AdvancedSearchFieldKind.Number]: [
|
|
||||||
AdvancedSearchOperator.Equals,
|
|
||||||
AdvancedSearchOperator.AtLeast,
|
|
||||||
AdvancedSearchOperator.AtMost,
|
|
||||||
AdvancedSearchOperator.Between,
|
|
||||||
],
|
|
||||||
[AdvancedSearchFieldKind.Date]: [
|
|
||||||
AdvancedSearchOperator.DateKeyword,
|
|
||||||
AdvancedSearchOperator.WithinLast,
|
|
||||||
AdvancedSearchOperator.AtLeast,
|
|
||||||
AdvancedSearchOperator.AtMost,
|
|
||||||
AdvancedSearchOperator.Between,
|
|
||||||
],
|
|
||||||
[AdvancedSearchFieldKind.Checksum]: [AdvancedSearchOperator.StartsWith],
|
|
||||||
}
|
|
||||||
|
|
||||||
export const ADVANCED_SEARCH_DATE_KEYWORDS = [
|
|
||||||
'today',
|
|
||||||
'yesterday',
|
|
||||||
'tomorrow',
|
|
||||||
'previous week',
|
|
||||||
'this month',
|
|
||||||
'previous month',
|
|
||||||
'previous quarter',
|
|
||||||
'this year',
|
|
||||||
'previous year',
|
|
||||||
] as const
|
|
||||||
|
|
||||||
export type AdvancedSearchDateKeyword =
|
|
||||||
(typeof ADVANCED_SEARCH_DATE_KEYWORDS)[number]
|
|
||||||
|
|
||||||
export enum AdvancedSearchDateUnit {
|
|
||||||
Day = 'day',
|
|
||||||
Week = 'week',
|
|
||||||
Month = 'month',
|
|
||||||
Year = 'year',
|
|
||||||
}
|
|
||||||
|
|
||||||
export enum AdvancedSearchLogicalOperator {
|
|
||||||
And = 'AND',
|
|
||||||
Or = 'OR',
|
|
||||||
Not = 'NOT',
|
|
||||||
}
|
|
||||||
|
|
||||||
export enum AdvancedSearchQueryElementType {
|
|
||||||
Atom = 'atom',
|
|
||||||
Group = 'group',
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface AdvancedSearchQueryAtom {
|
|
||||||
type: AdvancedSearchQueryElementType.Atom
|
|
||||||
field: AdvancedSearchField
|
|
||||||
operator: AdvancedSearchOperator
|
|
||||||
value?: string
|
|
||||||
valueTo?: string
|
|
||||||
unit?: AdvancedSearchDateUnit // for WithinLast
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface AdvancedSearchQueryGroup {
|
|
||||||
type: AdvancedSearchQueryElementType.Group
|
|
||||||
operator: AdvancedSearchLogicalOperator
|
|
||||||
children: AdvancedSearchQueryElement[]
|
|
||||||
}
|
|
||||||
|
|
||||||
export type AdvancedSearchQueryElement =
|
|
||||||
AdvancedSearchQueryAtom | AdvancedSearchQueryGroup
|
|
||||||
|
|
||||||
export const ADVANCED_SEARCH_MAX_DEPTH = 2
|
|
||||||
export const ADVANCED_SEARCH_MAX_ATOMS = 10
|
|
||||||
|
|
||||||
export const ADVANCED_SEARCH_FIELD_LABELS: Record<AdvancedSearchField, string> =
|
|
||||||
{
|
|
||||||
[AdvancedSearchField.Any]: $localize`Any field`,
|
|
||||||
[AdvancedSearchField.Title]: $localize`Title`,
|
|
||||||
[AdvancedSearchField.Content]: $localize`Content`,
|
|
||||||
[AdvancedSearchField.OriginalFilename]: $localize`File name`,
|
|
||||||
[AdvancedSearchField.NoteText]: $localize`Note text`,
|
|
||||||
[AdvancedSearchField.NoteAuthor]: $localize`Note author`,
|
|
||||||
[AdvancedSearchField.CustomFieldName]: $localize`Custom field name`,
|
|
||||||
[AdvancedSearchField.CustomFieldValue]: $localize`Custom field value`,
|
|
||||||
[AdvancedSearchField.Correspondent]: $localize`Correspondent name`,
|
|
||||||
[AdvancedSearchField.DocumentType]: $localize`Document type name`,
|
|
||||||
[AdvancedSearchField.StoragePath]: $localize`Storage path name`,
|
|
||||||
[AdvancedSearchField.Tag]: $localize`Tag name`,
|
|
||||||
[AdvancedSearchField.ASN]: $localize`ASN`,
|
|
||||||
[AdvancedSearchField.PageCount]: $localize`Pages`,
|
|
||||||
[AdvancedSearchField.NumNotes]: $localize`Number of notes`,
|
|
||||||
[AdvancedSearchField.Created]: $localize`Created`,
|
|
||||||
[AdvancedSearchField.Added]: $localize`Added`,
|
|
||||||
[AdvancedSearchField.Modified]: $localize`Modified`,
|
|
||||||
[AdvancedSearchField.Checksum]: $localize`Checksum`,
|
|
||||||
}
|
|
||||||
|
|
||||||
export const ADVANCED_SEARCH_FIELD_GROUPS: {
|
|
||||||
label: string
|
|
||||||
fields: AdvancedSearchField[]
|
|
||||||
}[] = [
|
|
||||||
{
|
|
||||||
label: $localize`Text`,
|
|
||||||
fields: [
|
|
||||||
AdvancedSearchField.Any,
|
|
||||||
AdvancedSearchField.Title,
|
|
||||||
AdvancedSearchField.Content,
|
|
||||||
AdvancedSearchField.OriginalFilename,
|
|
||||||
AdvancedSearchField.NoteText,
|
|
||||||
AdvancedSearchField.NoteAuthor,
|
|
||||||
AdvancedSearchField.CustomFieldName,
|
|
||||||
AdvancedSearchField.CustomFieldValue,
|
|
||||||
],
|
|
||||||
},
|
|
||||||
{
|
|
||||||
label: $localize`Names`,
|
|
||||||
fields: [
|
|
||||||
AdvancedSearchField.Correspondent,
|
|
||||||
AdvancedSearchField.DocumentType,
|
|
||||||
AdvancedSearchField.StoragePath,
|
|
||||||
AdvancedSearchField.Tag,
|
|
||||||
],
|
|
||||||
},
|
|
||||||
{
|
|
||||||
label: $localize`Numbers`,
|
|
||||||
fields: [
|
|
||||||
AdvancedSearchField.ASN,
|
|
||||||
AdvancedSearchField.PageCount,
|
|
||||||
AdvancedSearchField.NumNotes,
|
|
||||||
],
|
|
||||||
},
|
|
||||||
{
|
|
||||||
label: $localize`Dates`,
|
|
||||||
fields: [
|
|
||||||
AdvancedSearchField.Created,
|
|
||||||
AdvancedSearchField.Added,
|
|
||||||
AdvancedSearchField.Modified,
|
|
||||||
],
|
|
||||||
},
|
|
||||||
{ label: $localize`Other`, fields: [AdvancedSearchField.Checksum] },
|
|
||||||
]
|
|
||||||
|
|
||||||
export const ADVANCED_SEARCH_OPERATOR_LABELS: Record<
|
|
||||||
AdvancedSearchOperator,
|
|
||||||
string
|
|
||||||
> = {
|
|
||||||
[AdvancedSearchOperator.AllWords]: $localize`contains all words`,
|
|
||||||
[AdvancedSearchOperator.AnyWord]: $localize`contains any word`,
|
|
||||||
[AdvancedSearchOperator.Phrase]: $localize`contains the phrase`,
|
|
||||||
[AdvancedSearchOperator.StartsWith]: $localize`starts with`,
|
|
||||||
[AdvancedSearchOperator.Equals]: $localize`is`,
|
|
||||||
[AdvancedSearchOperator.AtLeast]: $localize`is at least`,
|
|
||||||
[AdvancedSearchOperator.AtMost]: $localize`is at most`,
|
|
||||||
[AdvancedSearchOperator.Between]: $localize`is between`,
|
|
||||||
[AdvancedSearchOperator.DateKeyword]: $localize`is`,
|
|
||||||
[AdvancedSearchOperator.WithinLast]: $localize`is within the last`,
|
|
||||||
}
|
|
||||||
|
|
||||||
// Comparing dates reads differently than comparing counts
|
|
||||||
export const ADVANCED_SEARCH_DATE_OPERATOR_LABELS: Partial<
|
|
||||||
Record<AdvancedSearchOperator, string>
|
|
||||||
> = {
|
|
||||||
[AdvancedSearchOperator.AtLeast]: $localize`is on or after`,
|
|
||||||
[AdvancedSearchOperator.AtMost]: $localize`is on or before`,
|
|
||||||
}
|
|
||||||
|
|
||||||
export const ADVANCED_SEARCH_DATE_KEYWORD_LABELS: Record<string, string> = {
|
|
||||||
today: $localize`today`,
|
|
||||||
yesterday: $localize`yesterday`,
|
|
||||||
tomorrow: $localize`tomorrow`,
|
|
||||||
'previous week': $localize`previous week`,
|
|
||||||
'this month': $localize`this month`,
|
|
||||||
'previous month': $localize`previous month`,
|
|
||||||
'previous quarter': $localize`previous quarter`,
|
|
||||||
'this year': $localize`this year`,
|
|
||||||
'previous year': $localize`previous year`,
|
|
||||||
}
|
|
||||||
|
|
||||||
export const ADVANCED_SEARCH_DATE_UNIT_LABELS: Record<
|
|
||||||
AdvancedSearchDateUnit,
|
|
||||||
string
|
|
||||||
> = {
|
|
||||||
[AdvancedSearchDateUnit.Day]: $localize`days`,
|
|
||||||
[AdvancedSearchDateUnit.Week]: $localize`weeks`,
|
|
||||||
[AdvancedSearchDateUnit.Month]: $localize`months`,
|
|
||||||
[AdvancedSearchDateUnit.Year]: $localize`years`,
|
|
||||||
}
|
|
||||||
@@ -15,3 +15,33 @@ export interface DocumentSuggestions {
|
|||||||
|
|
||||||
dates?: string[] // ISO-formatted date string e.g. 2022-11-03
|
dates?: string[] // ISO-formatted date string e.g. 2022-11-03
|
||||||
}
|
}
|
||||||
|
|
||||||
|
const union = <T>(a: T[] = [], b: T[] = []): T[] => [...new Set([...a, ...b])]
|
||||||
|
|
||||||
|
export function mergeSuggestions(
|
||||||
|
a: DocumentSuggestions,
|
||||||
|
b: DocumentSuggestions
|
||||||
|
): DocumentSuggestions {
|
||||||
|
if (!a) return b
|
||||||
|
return {
|
||||||
|
title: a.title || b.title,
|
||||||
|
tags: union(a.tags, b.tags),
|
||||||
|
suggested_tags: union(a.suggested_tags, b.suggested_tags),
|
||||||
|
correspondents: union(a.correspondents, b.correspondents),
|
||||||
|
suggested_correspondents: union(
|
||||||
|
a.suggested_correspondents,
|
||||||
|
b.suggested_correspondents
|
||||||
|
),
|
||||||
|
document_types: union(a.document_types, b.document_types),
|
||||||
|
suggested_document_types: union(
|
||||||
|
a.suggested_document_types,
|
||||||
|
b.suggested_document_types
|
||||||
|
),
|
||||||
|
storage_paths: union(a.storage_paths, b.storage_paths),
|
||||||
|
suggested_storage_paths: union(
|
||||||
|
a.suggested_storage_paths,
|
||||||
|
b.suggested_storage_paths
|
||||||
|
),
|
||||||
|
dates: union(a.dates, b.dates),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -353,6 +353,14 @@ export const PaperlessConfigOptions: ConfigOption[] = [
|
|||||||
config_key: 'PAPERLESS_AI_LLM_EMBEDDING_MODEL',
|
config_key: 'PAPERLESS_AI_LLM_EMBEDDING_MODEL',
|
||||||
category: ConfigCategory.AI,
|
category: ConfigCategory.AI,
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
key: 'llm_embedding_api_key',
|
||||||
|
title: $localize`LLM Embedding API Key`,
|
||||||
|
type: ConfigOptionType.Password,
|
||||||
|
note: $localize`Used for embeddings when set, otherwise LLM API key is used.`,
|
||||||
|
config_key: 'PAPERLESS_AI_LLM_EMBEDDING_API_KEY',
|
||||||
|
category: ConfigCategory.AI,
|
||||||
|
},
|
||||||
{
|
{
|
||||||
key: 'llm_embedding_endpoint',
|
key: 'llm_embedding_endpoint',
|
||||||
title: $localize`LLM Embedding Endpoint`,
|
title: $localize`LLM Embedding Endpoint`,
|
||||||
@@ -457,6 +465,7 @@ export interface PaperlessConfig extends ObjectWithId {
|
|||||||
ai_enabled: boolean
|
ai_enabled: boolean
|
||||||
llm_embedding_backend: string
|
llm_embedding_backend: string
|
||||||
llm_embedding_model: string
|
llm_embedding_model: string
|
||||||
|
llm_embedding_api_key: string
|
||||||
llm_embedding_endpoint: string
|
llm_embedding_endpoint: string
|
||||||
llm_embedding_chunk_size: number
|
llm_embedding_chunk_size: number
|
||||||
llm_context_size: number
|
llm_context_size: number
|
||||||
|
|||||||
@@ -20,6 +20,12 @@ export enum GlobalSearchType {
|
|||||||
TITLE_CONTENT = 'title-content',
|
TITLE_CONTENT = 'title-content',
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export enum SuggestionSource {
|
||||||
|
ML = 'ml',
|
||||||
|
AI = 'ai',
|
||||||
|
Both = 'both',
|
||||||
|
}
|
||||||
|
|
||||||
export enum CollapsibleSection {
|
export enum CollapsibleSection {
|
||||||
ATTRIBUTES = 'attributes',
|
ATTRIBUTES = 'attributes',
|
||||||
}
|
}
|
||||||
@@ -98,6 +104,8 @@ export const SETTINGS_KEYS = {
|
|||||||
'general-settings:document-editing:overlay-thumbnail',
|
'general-settings:document-editing:overlay-thumbnail',
|
||||||
DOCUMENT_EDITING_AUTO_SUGGEST:
|
DOCUMENT_EDITING_AUTO_SUGGEST:
|
||||||
'general-settings:document-editing:auto-suggest',
|
'general-settings:document-editing:auto-suggest',
|
||||||
|
DOCUMENT_EDITING_SUGGESTION_SOURCE:
|
||||||
|
'general-settings:document-editing:suggestion-source',
|
||||||
DOCUMENT_DETAILS_HIDDEN_FIELDS:
|
DOCUMENT_DETAILS_HIDDEN_FIELDS:
|
||||||
'general-settings:document-details:hidden-fields',
|
'general-settings:document-details:hidden-fields',
|
||||||
SEARCH_DB_ONLY: 'general-settings:search:db-only',
|
SEARCH_DB_ONLY: 'general-settings:search:db-only',
|
||||||
@@ -326,6 +334,11 @@ export const SETTINGS: UiSetting[] = [
|
|||||||
type: 'boolean',
|
type: 'boolean',
|
||||||
default: true,
|
default: true,
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
key: SETTINGS_KEYS.DOCUMENT_EDITING_SUGGESTION_SOURCE,
|
||||||
|
type: 'string',
|
||||||
|
default: SuggestionSource.AI,
|
||||||
|
},
|
||||||
{
|
{
|
||||||
key: SETTINGS_KEYS.DOCUMENT_DETAILS_HIDDEN_FIELDS,
|
key: SETTINGS_KEYS.DOCUMENT_DETAILS_HIDDEN_FIELDS,
|
||||||
type: 'array',
|
type: 'array',
|
||||||
|
|||||||
@@ -1,515 +0,0 @@
|
|||||||
import {
|
|
||||||
AdvancedSearchDateUnit,
|
|
||||||
AdvancedSearchField,
|
|
||||||
AdvancedSearchLogicalOperator,
|
|
||||||
AdvancedSearchOperator,
|
|
||||||
AdvancedSearchQueryAtom,
|
|
||||||
AdvancedSearchQueryElement,
|
|
||||||
AdvancedSearchQueryElementType,
|
|
||||||
AdvancedSearchQueryGroup,
|
|
||||||
} from '../data/advanced-search-query'
|
|
||||||
import {
|
|
||||||
parseAdvancedSearchQuery,
|
|
||||||
serializeAdvancedSearchQuery,
|
|
||||||
} from './advanced-search-query'
|
|
||||||
|
|
||||||
const atom = (
|
|
||||||
field: AdvancedSearchField,
|
|
||||||
operator: AdvancedSearchOperator,
|
|
||||||
value?: string,
|
|
||||||
extra: Partial<AdvancedSearchQueryAtom> = {}
|
|
||||||
): AdvancedSearchQueryAtom => ({
|
|
||||||
type: AdvancedSearchQueryElementType.Atom,
|
|
||||||
field,
|
|
||||||
operator,
|
|
||||||
value,
|
|
||||||
...extra,
|
|
||||||
})
|
|
||||||
|
|
||||||
const group = (
|
|
||||||
operator: AdvancedSearchLogicalOperator,
|
|
||||||
...children: AdvancedSearchQueryElement[]
|
|
||||||
): AdvancedSearchQueryGroup => ({
|
|
||||||
type: AdvancedSearchQueryElementType.Group,
|
|
||||||
operator,
|
|
||||||
children,
|
|
||||||
})
|
|
||||||
|
|
||||||
const { And, Or, Not } = AdvancedSearchLogicalOperator
|
|
||||||
|
|
||||||
describe('serializeAdvancedSearchQuery', () => {
|
|
||||||
describe('text fields', () => {
|
|
||||||
it.each([
|
|
||||||
[AdvancedSearchOperator.AllWords, 'invoice', 'title:invoice'],
|
|
||||||
[
|
|
||||||
AdvancedSearchOperator.AllWords,
|
|
||||||
' invoice unpaid ',
|
|
||||||
'title:invoice AND title:unpaid',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
AdvancedSearchOperator.AnyWord,
|
|
||||||
'invoice unpaid',
|
|
||||||
'title:invoice OR title:unpaid',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
AdvancedSearchOperator.Phrase,
|
|
||||||
'quick brown fox',
|
|
||||||
'title:"quick brown fox"',
|
|
||||||
],
|
|
||||||
[AdvancedSearchOperator.Phrase, 'say "hi"', 'title:"say hi"'],
|
|
||||||
[AdvancedSearchOperator.StartsWith, 'invoi', 'title:invoi*'],
|
|
||||||
[AdvancedSearchOperator.StartsWith, 'in*v?oi', 'title:invoi*'],
|
|
||||||
])('%s %j writes %s', (operator, value, expected) => {
|
|
||||||
expect(
|
|
||||||
serializeAdvancedSearchQuery(
|
|
||||||
atom(AdvancedSearchField.Title, operator, value)
|
|
||||||
)
|
|
||||||
).toBe(expected)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('writes bare words for the Any field', () => {
|
|
||||||
expect(
|
|
||||||
serializeAdvancedSearchQuery(
|
|
||||||
atom(AdvancedSearchField.Any, AdvancedSearchOperator.AllWords, 'a b')
|
|
||||||
)
|
|
||||||
).toBe('a AND b')
|
|
||||||
})
|
|
||||||
|
|
||||||
it.each([
|
|
||||||
['A-1312/99', 'custom_fields.value:A-1312/99'],
|
|
||||||
["O'Brien", "custom_fields.value:O'Brien"],
|
|
||||||
["'quoted'", `custom_fields.value:"'quoted'"`],
|
|
||||||
['foo:bar', 'custom_fields.value:"foo:bar"'],
|
|
||||||
['(x)', 'custom_fields.value:"(x)"'],
|
|
||||||
['2024*', 'custom_fields.value:"2024*"'],
|
|
||||||
['a,b', 'custom_fields.value:"a,b"'],
|
|
||||||
['OR', 'custom_fields.value:"OR"'],
|
|
||||||
['or', 'custom_fields.value:or'],
|
|
||||||
])(
|
|
||||||
'quotes %j only when the grammar would read it as syntax',
|
|
||||||
(value, expected) => {
|
|
||||||
expect(
|
|
||||||
serializeAdvancedSearchQuery(
|
|
||||||
atom(
|
|
||||||
AdvancedSearchField.CustomFieldValue,
|
|
||||||
AdvancedSearchOperator.AllWords,
|
|
||||||
value
|
|
||||||
)
|
|
||||||
)
|
|
||||||
).toBe(expected)
|
|
||||||
}
|
|
||||||
)
|
|
||||||
|
|
||||||
it('uses the dotted names for custom fields', () => {
|
|
||||||
expect(
|
|
||||||
serializeAdvancedSearchQuery(
|
|
||||||
group(
|
|
||||||
And,
|
|
||||||
atom(
|
|
||||||
AdvancedSearchField.CustomFieldName,
|
|
||||||
AdvancedSearchOperator.Phrase,
|
|
||||||
'status'
|
|
||||||
),
|
|
||||||
atom(
|
|
||||||
AdvancedSearchField.CustomFieldValue,
|
|
||||||
AdvancedSearchOperator.AllWords,
|
|
||||||
'paid'
|
|
||||||
)
|
|
||||||
)
|
|
||||||
)
|
|
||||||
).toBe('custom_fields.name:"status" AND custom_fields.value:paid')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('uses the dotted names for notes', () => {
|
|
||||||
expect(
|
|
||||||
serializeAdvancedSearchQuery(
|
|
||||||
group(
|
|
||||||
And,
|
|
||||||
atom(
|
|
||||||
AdvancedSearchField.NoteText,
|
|
||||||
AdvancedSearchOperator.AllWords,
|
|
||||||
'call'
|
|
||||||
),
|
|
||||||
atom(
|
|
||||||
AdvancedSearchField.NoteAuthor,
|
|
||||||
AdvancedSearchOperator.AllWords,
|
|
||||||
'alice'
|
|
||||||
)
|
|
||||||
)
|
|
||||||
)
|
|
||||||
).toBe('notes.note:call AND notes.user:alice')
|
|
||||||
})
|
|
||||||
|
|
||||||
it.each([
|
|
||||||
[AdvancedSearchOperator.AllWords, ''],
|
|
||||||
[AdvancedSearchOperator.AllWords, ' '],
|
|
||||||
[AdvancedSearchOperator.AllWords, '!! --'],
|
|
||||||
[AdvancedSearchOperator.Phrase, '""'],
|
|
||||||
[AdvancedSearchOperator.StartsWith, 'two words'],
|
|
||||||
[AdvancedSearchOperator.StartsWith, '***'],
|
|
||||||
[AdvancedSearchOperator.StartsWith, undefined],
|
|
||||||
])('leaves out %s %j', (operator, value) => {
|
|
||||||
expect(
|
|
||||||
serializeAdvancedSearchQuery(
|
|
||||||
atom(AdvancedSearchField.Title, operator, value)
|
|
||||||
)
|
|
||||||
).toBe('')
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('checksum', () => {
|
|
||||||
it('lowercases the prefix', () => {
|
|
||||||
expect(
|
|
||||||
serializeAdvancedSearchQuery(
|
|
||||||
atom(
|
|
||||||
AdvancedSearchField.Checksum,
|
|
||||||
AdvancedSearchOperator.StartsWith,
|
|
||||||
'9F86D081'
|
|
||||||
)
|
|
||||||
)
|
|
||||||
).toBe('checksum:9f86d081*')
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('number fields', () => {
|
|
||||||
it.each([
|
|
||||||
[AdvancedSearchOperator.Equals, '42', undefined, 'asn:42'],
|
|
||||||
[AdvancedSearchOperator.AtLeast, '50', undefined, 'asn:[50 to]'],
|
|
||||||
[AdvancedSearchOperator.AtMost, '50', undefined, 'asn:[to 50]'],
|
|
||||||
[AdvancedSearchOperator.Between, '50', '150', 'asn:[50 to 150]'],
|
|
||||||
[AdvancedSearchOperator.Equals, '4.2', undefined, ''],
|
|
||||||
[AdvancedSearchOperator.Equals, '-1', undefined, ''],
|
|
||||||
[AdvancedSearchOperator.Equals, '2024-01-01', undefined, ''],
|
|
||||||
[AdvancedSearchOperator.Between, '50', '', ''],
|
|
||||||
])('%s %j %j writes %j', (operator, value, valueTo, expected) => {
|
|
||||||
expect(
|
|
||||||
serializeAdvancedSearchQuery(
|
|
||||||
atom(AdvancedSearchField.ASN, operator, value, { valueTo })
|
|
||||||
)
|
|
||||||
).toBe(expected)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('date fields', () => {
|
|
||||||
it.each([
|
|
||||||
['today', 'added:today'],
|
|
||||||
['previous month', 'added:"previous month"'],
|
|
||||||
['last tuesday', ''],
|
|
||||||
['', ''],
|
|
||||||
])('keyword %j writes %j', (value, expected) => {
|
|
||||||
expect(
|
|
||||||
serializeAdvancedSearchQuery(
|
|
||||||
atom(
|
|
||||||
AdvancedSearchField.Added,
|
|
||||||
AdvancedSearchOperator.DateKeyword,
|
|
||||||
value
|
|
||||||
)
|
|
||||||
)
|
|
||||||
).toBe(expected)
|
|
||||||
})
|
|
||||||
|
|
||||||
it.each([
|
|
||||||
['1', AdvancedSearchDateUnit.Day, 'added:[-1 day to now]'],
|
|
||||||
['3', AdvancedSearchDateUnit.Month, 'added:[-3 months to now]'],
|
|
||||||
['2', AdvancedSearchDateUnit.Week, 'added:[-2 weeks to now]'],
|
|
||||||
['0', AdvancedSearchDateUnit.Year, ''],
|
|
||||||
['1.5', AdvancedSearchDateUnit.Year, ''],
|
|
||||||
['3', undefined, ''],
|
|
||||||
['3', 'fortnight' as AdvancedSearchDateUnit, ''],
|
|
||||||
])('within the last %j %j writes %j', (value, unit, expected) => {
|
|
||||||
expect(
|
|
||||||
serializeAdvancedSearchQuery(
|
|
||||||
atom(
|
|
||||||
AdvancedSearchField.Added,
|
|
||||||
AdvancedSearchOperator.WithinLast,
|
|
||||||
value,
|
|
||||||
{
|
|
||||||
unit,
|
|
||||||
}
|
|
||||||
)
|
|
||||||
)
|
|
||||||
).toBe(expected)
|
|
||||||
})
|
|
||||||
|
|
||||||
it.each([
|
|
||||||
[
|
|
||||||
AdvancedSearchOperator.AtLeast,
|
|
||||||
'2024-01-01',
|
|
||||||
undefined,
|
|
||||||
'created:[2024-01-01 to]',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
AdvancedSearchOperator.AtMost,
|
|
||||||
'2024-01-01',
|
|
||||||
undefined,
|
|
||||||
'created:[to 2024-01-01]',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
AdvancedSearchOperator.Between,
|
|
||||||
'2024-01-01',
|
|
||||||
'2024-03-31',
|
|
||||||
'created:[2024-01-01 to 2024-03-31]',
|
|
||||||
],
|
|
||||||
[AdvancedSearchOperator.AtLeast, '2024', undefined, ''],
|
|
||||||
[AdvancedSearchOperator.Between, '2024-01-01', 'now', ''],
|
|
||||||
])('%s %j %j writes %j', (operator, value, valueTo, expected) => {
|
|
||||||
expect(
|
|
||||||
serializeAdvancedSearchQuery(
|
|
||||||
atom(AdvancedSearchField.Created, operator, value, { valueTo })
|
|
||||||
)
|
|
||||||
).toBe(expected)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('groups', () => {
|
|
||||||
const invoice = atom(
|
|
||||||
AdvancedSearchField.Content,
|
|
||||||
AdvancedSearchOperator.AllWords,
|
|
||||||
'invoice'
|
|
||||||
)
|
|
||||||
const letter = atom(
|
|
||||||
AdvancedSearchField.Title,
|
|
||||||
AdvancedSearchOperator.AllWords,
|
|
||||||
'letter'
|
|
||||||
)
|
|
||||||
const paid = atom(
|
|
||||||
AdvancedSearchField.Tag,
|
|
||||||
AdvancedSearchOperator.AllWords,
|
|
||||||
'paid'
|
|
||||||
)
|
|
||||||
const twoWords = atom(
|
|
||||||
AdvancedSearchField.Title,
|
|
||||||
AdvancedSearchOperator.AllWords,
|
|
||||||
'a b'
|
|
||||||
)
|
|
||||||
const anyWords = atom(
|
|
||||||
AdvancedSearchField.Title,
|
|
||||||
AdvancedSearchOperator.AnyWord,
|
|
||||||
'a b'
|
|
||||||
)
|
|
||||||
const empty = atom(
|
|
||||||
AdvancedSearchField.Title,
|
|
||||||
AdvancedSearchOperator.AllWords,
|
|
||||||
''
|
|
||||||
)
|
|
||||||
|
|
||||||
it.each([
|
|
||||||
['an empty group', group(And), ''],
|
|
||||||
['a group of empty atoms', group(Or, empty, group(And, empty)), ''],
|
|
||||||
[
|
|
||||||
'a single child without parentheses',
|
|
||||||
group(Or, invoice),
|
|
||||||
'content:invoice',
|
|
||||||
],
|
|
||||||
['All', group(And, invoice, letter), 'content:invoice AND title:letter'],
|
|
||||||
['Any', group(Or, invoice, letter), 'content:invoice OR title:letter'],
|
|
||||||
[
|
|
||||||
'skipped empty atoms',
|
|
||||||
group(And, empty, invoice, empty),
|
|
||||||
'content:invoice',
|
|
||||||
],
|
|
||||||
['Not with one child', group(Not, paid), 'NOT tag:paid'],
|
|
||||||
[
|
|
||||||
'Not as none of',
|
|
||||||
group(Not, paid, letter),
|
|
||||||
'NOT (tag:paid OR title:letter)',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
'Not with a compound child',
|
|
||||||
group(Not, twoWords),
|
|
||||||
'NOT (title:a AND title:b)',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
'Not inside All',
|
|
||||||
group(And, invoice, group(Not, paid)),
|
|
||||||
'content:invoice AND NOT tag:paid',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
'Not inside Any',
|
|
||||||
group(Or, invoice, group(Not, paid)),
|
|
||||||
'content:invoice OR NOT tag:paid',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
'Any inside All',
|
|
||||||
group(And, invoice, group(Or, letter, paid)),
|
|
||||||
'content:invoice AND (title:letter OR tag:paid)',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
'All inside Any',
|
|
||||||
group(Or, invoice, group(And, letter, paid)),
|
|
||||||
'content:invoice OR (title:letter AND tag:paid)',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
'All inside All flattened',
|
|
||||||
group(And, invoice, group(And, letter, paid)),
|
|
||||||
'content:invoice AND title:letter AND tag:paid',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
'an all-words atom inside Any',
|
|
||||||
group(Or, invoice, twoWords),
|
|
||||||
'content:invoice OR (title:a AND title:b)',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
'an any-word atom inside All',
|
|
||||||
group(And, invoice, anyWords),
|
|
||||||
'content:invoice AND (title:a OR title:b)',
|
|
||||||
],
|
|
||||||
[
|
|
||||||
'an all-words atom inside Not with siblings',
|
|
||||||
group(Not, paid, twoWords),
|
|
||||||
'NOT (tag:paid OR (title:a AND title:b))',
|
|
||||||
],
|
|
||||||
])('writes %s', (_, tree, expected) => {
|
|
||||||
expect(serializeAdvancedSearchQuery(tree)).toBe(expected)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('writes the mockup example', () => {
|
|
||||||
expect(
|
|
||||||
serializeAdvancedSearchQuery(
|
|
||||||
group(
|
|
||||||
And,
|
|
||||||
invoice,
|
|
||||||
group(
|
|
||||||
Or,
|
|
||||||
atom(
|
|
||||||
AdvancedSearchField.Correspondent,
|
|
||||||
AdvancedSearchOperator.Phrase,
|
|
||||||
'acme corp'
|
|
||||||
),
|
|
||||||
atom(
|
|
||||||
AdvancedSearchField.Content,
|
|
||||||
AdvancedSearchOperator.Phrase,
|
|
||||||
'acme corporation'
|
|
||||||
)
|
|
||||||
),
|
|
||||||
atom(
|
|
||||||
AdvancedSearchField.Added,
|
|
||||||
AdvancedSearchOperator.WithinLast,
|
|
||||||
'3',
|
|
||||||
{
|
|
||||||
unit: AdvancedSearchDateUnit.Month,
|
|
||||||
}
|
|
||||||
),
|
|
||||||
group(Not, paid)
|
|
||||||
)
|
|
||||||
)
|
|
||||||
).toBe(
|
|
||||||
'content:invoice AND (correspondent:"acme corp" OR content:"acme corporation") AND added:[-3 months to now] AND NOT tag:paid'
|
|
||||||
)
|
|
||||||
})
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
describe('parseAdvancedSearchQuery', () => {
|
|
||||||
const canonical = [
|
|
||||||
'title:invoice',
|
|
||||||
'title:invoice AND title:unpaid',
|
|
||||||
'content:invoice OR content:receipt',
|
|
||||||
'a AND b',
|
|
||||||
'title:"quick brown fox"',
|
|
||||||
'title:invoi*',
|
|
||||||
"custom_fields.value:O'Brien",
|
|
||||||
'custom_fields.value:"foo:bar"',
|
|
||||||
'custom_fields.name:"status" AND custom_fields.value:paid',
|
|
||||||
'notes.note:call AND notes.user:alice',
|
|
||||||
'checksum:9f86d081*',
|
|
||||||
'asn:42',
|
|
||||||
'asn:[50 to 150]',
|
|
||||||
'asn:[50 to]',
|
|
||||||
'asn:[to 50]',
|
|
||||||
'page_count:[10 to]',
|
|
||||||
'added:today',
|
|
||||||
'added:"previous month"',
|
|
||||||
'added:[-1 day to now]',
|
|
||||||
'added:[-3 months to now]',
|
|
||||||
'created:[2024-01-01 to 2024-03-31]',
|
|
||||||
'created:[2024-01-01 to]',
|
|
||||||
'created:[to 2024-01-01]',
|
|
||||||
'NOT tag:paid',
|
|
||||||
'NOT (tag:paid OR title:letter)',
|
|
||||||
'NOT (title:a AND title:b)',
|
|
||||||
'content:invoice OR NOT tag:paid',
|
|
||||||
'content:invoice AND (title:letter OR tag:paid)',
|
|
||||||
'content:invoice OR (title:letter AND tag:paid)',
|
|
||||||
'content:invoice AND (correspondent:"acme corp" OR content:"acme corporation") AND added:[-3 months to now] AND NOT tag:paid',
|
|
||||||
]
|
|
||||||
|
|
||||||
it.each(canonical)('reads back %s unchanged', (query) => {
|
|
||||||
const tree = parseAdvancedSearchQuery(query)
|
|
||||||
expect(tree).not.toBeNull()
|
|
||||||
expect(serializeAdvancedSearchQuery(tree)).toBe(query)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('reads surrounding whitespace', () => {
|
|
||||||
expect(
|
|
||||||
serializeAdvancedSearchQuery(
|
|
||||||
parseAdvancedSearchQuery(' title:invoice ')
|
|
||||||
)
|
|
||||||
).toBe('title:invoice')
|
|
||||||
})
|
|
||||||
|
|
||||||
it('puts the words of one condition back together', () => {
|
|
||||||
expect(parseAdvancedSearchQuery('title:invoice AND title:unpaid')).toEqual(
|
|
||||||
group(
|
|
||||||
And,
|
|
||||||
atom(
|
|
||||||
AdvancedSearchField.Title,
|
|
||||||
AdvancedSearchOperator.AllWords,
|
|
||||||
'invoice unpaid'
|
|
||||||
)
|
|
||||||
)
|
|
||||||
)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('keeps words of different fields apart', () => {
|
|
||||||
expect(parseAdvancedSearchQuery('title:a OR content:b')).toEqual(
|
|
||||||
group(
|
|
||||||
Or,
|
|
||||||
atom(AdvancedSearchField.Title, AdvancedSearchOperator.AllWords, 'a'),
|
|
||||||
atom(AdvancedSearchField.Content, AdvancedSearchOperator.AllWords, 'b')
|
|
||||||
)
|
|
||||||
)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('reads a range as its condition', () => {
|
|
||||||
expect(parseAdvancedSearchQuery('added:[-3 months to now]')).toEqual(
|
|
||||||
group(
|
|
||||||
And,
|
|
||||||
atom(
|
|
||||||
AdvancedSearchField.Added,
|
|
||||||
AdvancedSearchOperator.WithinLast,
|
|
||||||
'3',
|
|
||||||
{
|
|
||||||
unit: AdvancedSearchDateUnit.Month,
|
|
||||||
}
|
|
||||||
)
|
|
||||||
)
|
|
||||||
)
|
|
||||||
})
|
|
||||||
|
|
||||||
it.each([
|
|
||||||
['', 'nothing'],
|
|
||||||
[' ', 'whitespace'],
|
|
||||||
['type:invoice', 'a field alias'],
|
|
||||||
['notes:call', 'a bare notes prefix'],
|
|
||||||
['unknown:x', 'an unknown field'],
|
|
||||||
['title:a AND content:b OR title:c', 'AND and OR mixed at one level'],
|
|
||||||
['title:a b', 'an implicit AND'],
|
|
||||||
['title:"unterminated', 'an unterminated phrase'],
|
|
||||||
['asn:[50 to', 'an unterminated range'],
|
|
||||||
['title:a*b', 'a wildcard in the middle'],
|
|
||||||
['title:invoice^2', 'a boost'],
|
|
||||||
['asn:[50 to abc]', 'a non-numeric bound'],
|
|
||||||
['asn:invoice', 'a word on a number field'],
|
|
||||||
['created:[2024 to 2025]', 'a year-only date range'],
|
|
||||||
['added:"last tuesday"', 'a date keyword paperless does not have'],
|
|
||||||
['title:[a to b]', 'a range on a text field'],
|
|
||||||
['checksum:9f86d081', 'a checksum without a wildcard'],
|
|
||||||
['(title:invoice)', 'parentheses the editor would not write'],
|
|
||||||
['title:invoice AND', 'a trailing operator'],
|
|
||||||
['title:"a"b', 'a value running into the next'],
|
|
||||||
['ADDED:today', 'an uppercase field name'],
|
|
||||||
])('leaves %s alone, having %s', (query) => {
|
|
||||||
expect(parseAdvancedSearchQuery(query)).toBeNull()
|
|
||||||
})
|
|
||||||
})
|
|
||||||
@@ -1,500 +0,0 @@
|
|||||||
import {
|
|
||||||
ADVANCED_SEARCH_DATE_KEYWORDS,
|
|
||||||
ADVANCED_SEARCH_FIELD_KINDS,
|
|
||||||
AdvancedSearchDateUnit,
|
|
||||||
AdvancedSearchField,
|
|
||||||
AdvancedSearchFieldKind,
|
|
||||||
AdvancedSearchLogicalOperator,
|
|
||||||
AdvancedSearchOperator,
|
|
||||||
AdvancedSearchQueryAtom,
|
|
||||||
AdvancedSearchQueryElement,
|
|
||||||
AdvancedSearchQueryElementType,
|
|
||||||
AdvancedSearchQueryGroup,
|
|
||||||
} from '../data/advanced-search-query'
|
|
||||||
|
|
||||||
// Anything the query grammar would read as syntax rather than as a word
|
|
||||||
const SYNTAX_CHARS = /[\s():"[\]*?,{}^~\\]/
|
|
||||||
const SYNTAX_CHARS_GLOBAL = new RegExp(SYNTAX_CHARS, 'g')
|
|
||||||
// A word wrapped in single quotes is also syntax, an apostrophe inside one is not
|
|
||||||
const EDGE_SINGLE_QUOTE = /^'|'$/
|
|
||||||
const RESERVED_WORDS = /^(AND|OR|NOT|TO)$/
|
|
||||||
const HAS_WORD_CHAR = /[\p{L}\p{N}]/u
|
|
||||||
const WHOLE_NUMBER = /^\d+$/
|
|
||||||
const ISO_DATE = /^\d{4}-\d{2}-\d{2}$/
|
|
||||||
|
|
||||||
interface Serialized {
|
|
||||||
text: string
|
|
||||||
// The operator joining the top level of `text`, null when it is self-delimiting
|
|
||||||
join:
|
|
||||||
AdvancedSearchLogicalOperator.And | AdvancedSearchLogicalOperator.Or | null
|
|
||||||
}
|
|
||||||
|
|
||||||
const prefix = (field: AdvancedSearchField) => (field ? `${field}:` : '')
|
|
||||||
|
|
||||||
const quote = (text: string) => `"${text.replace(/"/g, '')}"`
|
|
||||||
|
|
||||||
const words = (value: string) =>
|
|
||||||
value
|
|
||||||
.trim()
|
|
||||||
.split(/\s+/)
|
|
||||||
.filter((word) => HAS_WORD_CHAR.test(word))
|
|
||||||
|
|
||||||
const word = (w: string) =>
|
|
||||||
SYNTAX_CHARS.test(w) || EDGE_SINGLE_QUOTE.test(w) || RESERVED_WORDS.test(w)
|
|
||||||
? quote(w)
|
|
||||||
: w
|
|
||||||
|
|
||||||
const atomic = (text: string): Serialized => ({ text, join: null })
|
|
||||||
|
|
||||||
function serializeWords(
|
|
||||||
atom: AdvancedSearchQueryAtom,
|
|
||||||
join: AdvancedSearchLogicalOperator.And | AdvancedSearchLogicalOperator.Or
|
|
||||||
): Serialized {
|
|
||||||
// A field applies only to the word right after it, so repeat it per word
|
|
||||||
const terms = words(atom.value ?? '').map(
|
|
||||||
(w) => `${prefix(atom.field)}${word(w)}`
|
|
||||||
)
|
|
||||||
if (terms.length === 0) return null
|
|
||||||
if (terms.length === 1) return atomic(terms[0])
|
|
||||||
return { text: terms.join(` ${join} `), join }
|
|
||||||
}
|
|
||||||
|
|
||||||
function serializeRange(
|
|
||||||
atom: AdvancedSearchQueryAtom,
|
|
||||||
isValid: (v: string) => boolean
|
|
||||||
): Serialized {
|
|
||||||
const lo = atom.value?.trim() ?? ''
|
|
||||||
const hi = atom.valueTo?.trim() ?? ''
|
|
||||||
const field = prefix(atom.field)
|
|
||||||
switch (atom.operator) {
|
|
||||||
case AdvancedSearchOperator.Equals:
|
|
||||||
return isValid(lo) ? atomic(`${field}${lo}`) : null
|
|
||||||
case AdvancedSearchOperator.AtLeast:
|
|
||||||
return isValid(lo) ? atomic(`${field}[${lo} to]`) : null
|
|
||||||
case AdvancedSearchOperator.AtMost:
|
|
||||||
return isValid(lo) ? atomic(`${field}[to ${lo}]`) : null
|
|
||||||
case AdvancedSearchOperator.Between:
|
|
||||||
return isValid(lo) && isValid(hi)
|
|
||||||
? atomic(`${field}[${lo} to ${hi}]`)
|
|
||||||
: null
|
|
||||||
}
|
|
||||||
return null
|
|
||||||
}
|
|
||||||
|
|
||||||
function serializeAtom(atom: AdvancedSearchQueryAtom): Serialized {
|
|
||||||
const field = prefix(atom.field)
|
|
||||||
const value = atom.value?.trim() ?? ''
|
|
||||||
|
|
||||||
switch (atom.operator) {
|
|
||||||
case AdvancedSearchOperator.AllWords:
|
|
||||||
return serializeWords(atom, AdvancedSearchLogicalOperator.And)
|
|
||||||
case AdvancedSearchOperator.AnyWord:
|
|
||||||
return serializeWords(atom, AdvancedSearchLogicalOperator.Or)
|
|
||||||
case AdvancedSearchOperator.Phrase:
|
|
||||||
return HAS_WORD_CHAR.test(value)
|
|
||||||
? atomic(`${field}${quote(value)}`)
|
|
||||||
: null
|
|
||||||
case AdvancedSearchOperator.StartsWith: {
|
|
||||||
if (/\s/.test(value)) return null
|
|
||||||
let stem = value.replace(SYNTAX_CHARS_GLOBAL, '')
|
|
||||||
if (!HAS_WORD_CHAR.test(stem)) return null
|
|
||||||
// checksum is indexed as-is, in lowercase
|
|
||||||
if (atom.field === AdvancedSearchField.Checksum) {
|
|
||||||
stem = stem.toLowerCase()
|
|
||||||
}
|
|
||||||
return atomic(`${field}${stem}*`)
|
|
||||||
}
|
|
||||||
case AdvancedSearchOperator.DateKeyword:
|
|
||||||
return (ADVANCED_SEARCH_DATE_KEYWORDS as readonly string[]).includes(
|
|
||||||
value
|
|
||||||
)
|
|
||||||
? atomic(`${field}${word(value)}`)
|
|
||||||
: null
|
|
||||||
case AdvancedSearchOperator.WithinLast: {
|
|
||||||
const amount = parseInt(value, 10)
|
|
||||||
const units = Object.values(AdvancedSearchDateUnit) as string[]
|
|
||||||
if (!WHOLE_NUMBER.test(value) || amount < 1) return null
|
|
||||||
if (!units.includes(atom.unit)) return null
|
|
||||||
const unit = amount === 1 ? atom.unit : `${atom.unit}s`
|
|
||||||
return atomic(`${field}[-${amount} ${unit} to now]`)
|
|
||||||
}
|
|
||||||
case AdvancedSearchOperator.Equals:
|
|
||||||
case AdvancedSearchOperator.AtLeast:
|
|
||||||
case AdvancedSearchOperator.AtMost:
|
|
||||||
case AdvancedSearchOperator.Between:
|
|
||||||
return serializeRange(
|
|
||||||
atom,
|
|
||||||
ADVANCED_SEARCH_FIELD_KINDS[atom.field] === AdvancedSearchFieldKind.Date
|
|
||||||
? (v) => ISO_DATE.test(v)
|
|
||||||
: (v) => WHOLE_NUMBER.test(v)
|
|
||||||
)
|
|
||||||
}
|
|
||||||
return null
|
|
||||||
}
|
|
||||||
|
|
||||||
function wrap(
|
|
||||||
child: Serialized,
|
|
||||||
parentJoin: AdvancedSearchLogicalOperator
|
|
||||||
): string {
|
|
||||||
return child.join === null || child.join === parentJoin
|
|
||||||
? child.text
|
|
||||||
: `(${child.text})`
|
|
||||||
}
|
|
||||||
|
|
||||||
function serializeGroup(group: AdvancedSearchQueryGroup): Serialized {
|
|
||||||
const children = group.children.map(serializeElement).filter(Boolean)
|
|
||||||
if (children.length === 0) return null
|
|
||||||
|
|
||||||
if (group.operator === AdvancedSearchLogicalOperator.Not) {
|
|
||||||
// A Not group matches documents matching none of its children
|
|
||||||
if (children.length === 1 && children[0].join === null) {
|
|
||||||
return atomic(`NOT ${children[0].text}`)
|
|
||||||
}
|
|
||||||
const inner =
|
|
||||||
children.length === 1
|
|
||||||
? children[0].text
|
|
||||||
: children
|
|
||||||
.map((c) => wrap(c, AdvancedSearchLogicalOperator.Or))
|
|
||||||
.join(' OR ')
|
|
||||||
return atomic(`NOT (${inner})`)
|
|
||||||
}
|
|
||||||
|
|
||||||
if (children.length === 1) return children[0]
|
|
||||||
return {
|
|
||||||
text: children
|
|
||||||
.map((c) => wrap(c, group.operator))
|
|
||||||
.join(` ${group.operator} `),
|
|
||||||
join: group.operator,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function serializeElement(element: AdvancedSearchQueryElement): Serialized {
|
|
||||||
return element.type === AdvancedSearchQueryElementType.Group
|
|
||||||
? serializeGroup(element)
|
|
||||||
: serializeAtom(element)
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Writes an editor tree as a full-text query. Atoms that are not filled in
|
|
||||||
* (or not valid) are left out, and empty groups with them.
|
|
||||||
*/
|
|
||||||
export function serializeAdvancedSearchQuery(
|
|
||||||
element: AdvancedSearchQueryElement
|
|
||||||
): string {
|
|
||||||
return serializeElement(element)?.text ?? ''
|
|
||||||
}
|
|
||||||
|
|
||||||
// --- Reading a query back into the editor --------------------------------
|
|
||||||
//
|
|
||||||
// Deliberately narrow: this reads the forms serializeAdvancedSearchQuery
|
|
||||||
// writes, and nothing else. A query it cannot read is not a failure, it just
|
|
||||||
// stays text, so there is never a lossy or surprising conversion. The final
|
|
||||||
// round-trip check below is what holds that promise: a tree is only returned
|
|
||||||
// when writing it out again reproduces the query exactly.
|
|
||||||
|
|
||||||
const RELATIVE_BOUND = /^-(\d+) (day|week|month|year)s?$/
|
|
||||||
const FIELD_PREFIX = /^([a-z_]+(?:\.[a-z_]+)?):/
|
|
||||||
const KEYWORD_TOKEN = /^(AND|OR|NOT)(?=[\s(]|$)/
|
|
||||||
// Either bound may be missing: [50 to 150], [50 to], [to 50]
|
|
||||||
const RANGE_BOUNDS = /^(?:(.+?) )?to(?: (.+))?$/
|
|
||||||
const TRAILING_WILDCARD = /^([^*?]+)\*$/
|
|
||||||
|
|
||||||
class UnreadableQuery extends Error {}
|
|
||||||
|
|
||||||
interface Token {
|
|
||||||
type: 'term' | 'AND' | 'OR' | 'NOT' | '(' | ')'
|
|
||||||
field?: string
|
|
||||||
value?: string
|
|
||||||
quoted?: boolean
|
|
||||||
range?: boolean
|
|
||||||
}
|
|
||||||
|
|
||||||
// A parsed element, plus what it takes to merge the per-word terms the
|
|
||||||
// serializer writes for "contains all words" back into a single condition
|
|
||||||
interface Parsed {
|
|
||||||
element: AdvancedSearchQueryElement
|
|
||||||
word?: { field: AdvancedSearchField; text: string }
|
|
||||||
}
|
|
||||||
|
|
||||||
function tokenize(query: string): Token[] {
|
|
||||||
const tokens: Token[] = []
|
|
||||||
let i = 0
|
|
||||||
while (i < query.length) {
|
|
||||||
const rest = query.slice(i)
|
|
||||||
if (/^\s/.test(rest)) {
|
|
||||||
i++
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
if (rest[0] === '(' || rest[0] === ')') {
|
|
||||||
tokens.push({ type: rest[0] as '(' | ')' })
|
|
||||||
i++
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
const keyword = KEYWORD_TOKEN.exec(rest)
|
|
||||||
if (keyword) {
|
|
||||||
tokens.push({ type: keyword[1] as 'AND' | 'OR' | 'NOT' })
|
|
||||||
i += keyword[1].length
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
const fieldMatch = FIELD_PREFIX.exec(rest)
|
|
||||||
const field = fieldMatch ? fieldMatch[1] : ''
|
|
||||||
i += fieldMatch ? fieldMatch[0].length : 0
|
|
||||||
|
|
||||||
const value = query.slice(i)
|
|
||||||
if (value.startsWith('"')) {
|
|
||||||
const end = query.indexOf('"', i + 1)
|
|
||||||
if (end < 0) throw new UnreadableQuery()
|
|
||||||
tokens.push({
|
|
||||||
type: 'term',
|
|
||||||
field,
|
|
||||||
value: query.slice(i + 1, end),
|
|
||||||
quoted: true,
|
|
||||||
})
|
|
||||||
i = end + 1
|
|
||||||
} else if (value.startsWith('[')) {
|
|
||||||
const end = query.indexOf(']', i + 1)
|
|
||||||
if (end < 0) throw new UnreadableQuery()
|
|
||||||
tokens.push({
|
|
||||||
type: 'term',
|
|
||||||
field,
|
|
||||||
value: query.slice(i + 1, end),
|
|
||||||
range: true,
|
|
||||||
})
|
|
||||||
i = end + 1
|
|
||||||
} else {
|
|
||||||
const bare = /^[^\s()]+/.exec(value)
|
|
||||||
if (!bare) throw new UnreadableQuery()
|
|
||||||
tokens.push({ type: 'term', field, value: bare[0] })
|
|
||||||
i += bare[0].length
|
|
||||||
}
|
|
||||||
// Nothing may run on directly after a value, e.g. title:"a"b
|
|
||||||
if (i < query.length && !/[\s)]/.test(query[i])) throw new UnreadableQuery()
|
|
||||||
}
|
|
||||||
return tokens
|
|
||||||
}
|
|
||||||
|
|
||||||
function resolveField(name: string): AdvancedSearchField {
|
|
||||||
const fields = Object.values(AdvancedSearchField) as string[]
|
|
||||||
// Aliases (type:, path:, notes:) are left to the text box on purpose:
|
|
||||||
// reading one would mean rewriting the user's query as it was read
|
|
||||||
if (!fields.includes(name)) throw new UnreadableQuery()
|
|
||||||
return name as AdvancedSearchField
|
|
||||||
}
|
|
||||||
|
|
||||||
function atomFrom(
|
|
||||||
field: AdvancedSearchField,
|
|
||||||
operator: AdvancedSearchOperator,
|
|
||||||
value: string,
|
|
||||||
extra: Partial<AdvancedSearchQueryAtom> = {}
|
|
||||||
): AdvancedSearchQueryAtom {
|
|
||||||
return {
|
|
||||||
type: AdvancedSearchQueryElementType.Atom,
|
|
||||||
field,
|
|
||||||
operator,
|
|
||||||
value,
|
|
||||||
...extra,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function parseRange(
|
|
||||||
field: AdvancedSearchField,
|
|
||||||
kind: AdvancedSearchFieldKind,
|
|
||||||
body: string
|
|
||||||
): AdvancedSearchQueryAtom {
|
|
||||||
const bounds = RANGE_BOUNDS.exec(body)
|
|
||||||
if (!bounds) throw new UnreadableQuery()
|
|
||||||
const lo = bounds[1] ?? ''
|
|
||||||
const hi = bounds[2] ?? ''
|
|
||||||
|
|
||||||
if (kind === AdvancedSearchFieldKind.Date) {
|
|
||||||
const relative = RELATIVE_BOUND.exec(lo)
|
|
||||||
if (relative && hi === 'now') {
|
|
||||||
return atomFrom(field, AdvancedSearchOperator.WithinLast, relative[1], {
|
|
||||||
unit: relative[2] as AdvancedSearchDateUnit,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
} else if (kind !== AdvancedSearchFieldKind.Number) {
|
|
||||||
throw new UnreadableQuery()
|
|
||||||
}
|
|
||||||
|
|
||||||
const isValid =
|
|
||||||
kind === AdvancedSearchFieldKind.Date
|
|
||||||
? (v: string) => ISO_DATE.test(v)
|
|
||||||
: (v: string) => WHOLE_NUMBER.test(v)
|
|
||||||
|
|
||||||
if (lo && hi) {
|
|
||||||
if (!isValid(lo) || !isValid(hi)) throw new UnreadableQuery()
|
|
||||||
return atomFrom(field, AdvancedSearchOperator.Between, lo, { valueTo: hi })
|
|
||||||
}
|
|
||||||
if (lo && isValid(lo))
|
|
||||||
return atomFrom(field, AdvancedSearchOperator.AtLeast, lo)
|
|
||||||
if (hi && isValid(hi))
|
|
||||||
return atomFrom(field, AdvancedSearchOperator.AtMost, hi)
|
|
||||||
throw new UnreadableQuery()
|
|
||||||
}
|
|
||||||
|
|
||||||
function parseTerm(token: Token): Parsed {
|
|
||||||
const field = resolveField(token.field)
|
|
||||||
const kind = ADVANCED_SEARCH_FIELD_KINDS[field]
|
|
||||||
const value = token.value
|
|
||||||
const isKeyword = (
|
|
||||||
ADVANCED_SEARCH_DATE_KEYWORDS as readonly string[]
|
|
||||||
).includes(value)
|
|
||||||
|
|
||||||
if (token.range) {
|
|
||||||
return { element: parseRange(field, kind, value) }
|
|
||||||
}
|
|
||||||
|
|
||||||
if (kind === AdvancedSearchFieldKind.Date) {
|
|
||||||
if (!isKeyword) throw new UnreadableQuery()
|
|
||||||
return {
|
|
||||||
element: atomFrom(field, AdvancedSearchOperator.DateKeyword, value),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if (token.quoted) {
|
|
||||||
if (kind !== AdvancedSearchFieldKind.Text) throw new UnreadableQuery()
|
|
||||||
return { element: atomFrom(field, AdvancedSearchOperator.Phrase, value) }
|
|
||||||
}
|
|
||||||
|
|
||||||
const wildcard = TRAILING_WILDCARD.exec(value)
|
|
||||||
if (wildcard) {
|
|
||||||
if (kind === AdvancedSearchFieldKind.Number) throw new UnreadableQuery()
|
|
||||||
return {
|
|
||||||
element: atomFrom(field, AdvancedSearchOperator.StartsWith, wildcard[1]),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if (kind === AdvancedSearchFieldKind.Number) {
|
|
||||||
if (!WHOLE_NUMBER.test(value)) throw new UnreadableQuery()
|
|
||||||
return { element: atomFrom(field, AdvancedSearchOperator.Equals, value) }
|
|
||||||
}
|
|
||||||
// A checksum is only ever searched by its first characters
|
|
||||||
if (kind === AdvancedSearchFieldKind.Checksum) throw new UnreadableQuery()
|
|
||||||
|
|
||||||
return {
|
|
||||||
element: atomFrom(field, AdvancedSearchOperator.AllWords, value),
|
|
||||||
word: { field, text: value },
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// The serializer repeats the field for every word, because a field applies
|
|
||||||
// only to the word after it. Put those back together into one condition.
|
|
||||||
function mergeWords(
|
|
||||||
parts: Parsed[],
|
|
||||||
operator: AdvancedSearchLogicalOperator.And | AdvancedSearchLogicalOperator.Or
|
|
||||||
): AdvancedSearchQueryElement[] {
|
|
||||||
const merged: AdvancedSearchQueryElement[] = []
|
|
||||||
for (let i = 0; i < parts.length; i++) {
|
|
||||||
const run = [parts[i]]
|
|
||||||
while (
|
|
||||||
parts[i].word &&
|
|
||||||
parts[i + 1]?.word &&
|
|
||||||
parts[i + 1].word.field === parts[i].word.field
|
|
||||||
) {
|
|
||||||
run.push(parts[++i])
|
|
||||||
}
|
|
||||||
if (run.length === 1) {
|
|
||||||
merged.push(run[0].element)
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
merged.push(
|
|
||||||
atomFrom(
|
|
||||||
run[0].word.field,
|
|
||||||
operator === AdvancedSearchLogicalOperator.And
|
|
||||||
? AdvancedSearchOperator.AllWords
|
|
||||||
: AdvancedSearchOperator.AnyWord,
|
|
||||||
run.map((part) => part.word.text).join(' ')
|
|
||||||
)
|
|
||||||
)
|
|
||||||
}
|
|
||||||
return merged
|
|
||||||
}
|
|
||||||
|
|
||||||
interface Cursor {
|
|
||||||
tokens: Token[]
|
|
||||||
at: number
|
|
||||||
}
|
|
||||||
|
|
||||||
function parseExpression(cursor: Cursor): Parsed {
|
|
||||||
const parts: Parsed[] = [parseOperand(cursor)]
|
|
||||||
let operator:
|
|
||||||
AdvancedSearchLogicalOperator.And | AdvancedSearchLogicalOperator.Or
|
|
||||||
while (
|
|
||||||
cursor.tokens[cursor.at]?.type === 'AND' ||
|
|
||||||
cursor.tokens[cursor.at]?.type === 'OR'
|
|
||||||
) {
|
|
||||||
const next = cursor.tokens[cursor.at++].type as
|
|
||||||
AdvancedSearchLogicalOperator.And | AdvancedSearchLogicalOperator.Or
|
|
||||||
// One level mixing AND and OR is never something the editor wrote
|
|
||||||
if (operator && next !== operator) throw new UnreadableQuery()
|
|
||||||
operator = next
|
|
||||||
parts.push(parseOperand(cursor))
|
|
||||||
}
|
|
||||||
if (parts.length === 1) return parts[0]
|
|
||||||
|
|
||||||
const children = mergeWords(parts, operator)
|
|
||||||
if (children.length === 1) return { element: children[0] }
|
|
||||||
return {
|
|
||||||
element: {
|
|
||||||
type: AdvancedSearchQueryElementType.Group,
|
|
||||||
operator,
|
|
||||||
children,
|
|
||||||
},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
function parseOperand(cursor: Cursor): Parsed {
|
|
||||||
const token = cursor.tokens[cursor.at++]
|
|
||||||
if (!token) throw new UnreadableQuery()
|
|
||||||
|
|
||||||
if (token.type === 'NOT') {
|
|
||||||
const child = parseOperand(cursor)
|
|
||||||
return {
|
|
||||||
element: {
|
|
||||||
type: AdvancedSearchQueryElementType.Group,
|
|
||||||
operator: AdvancedSearchLogicalOperator.Not,
|
|
||||||
children: [child.element],
|
|
||||||
},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if (token.type === '(') {
|
|
||||||
const inner = parseExpression(cursor)
|
|
||||||
if (cursor.tokens[cursor.at++]?.type !== ')') throw new UnreadableQuery()
|
|
||||||
return { element: inner.element }
|
|
||||||
}
|
|
||||||
if (token.type !== 'term') throw new UnreadableQuery()
|
|
||||||
return parseTerm(token)
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Reads a query the editor could have written back into an editor tree, or
|
|
||||||
* returns null when the editor cannot show it, in which case the query stays
|
|
||||||
* text. Never returns a tree that would be written back differently.
|
|
||||||
*/
|
|
||||||
export function parseAdvancedSearchQuery(
|
|
||||||
query: string
|
|
||||||
): AdvancedSearchQueryGroup | null {
|
|
||||||
const trimmed = query?.trim() ?? ''
|
|
||||||
if (!trimmed) return null
|
|
||||||
|
|
||||||
let parsed: Parsed
|
|
||||||
try {
|
|
||||||
const cursor: Cursor = { tokens: tokenize(trimmed), at: 0 }
|
|
||||||
parsed = parseExpression(cursor)
|
|
||||||
if (cursor.at !== cursor.tokens.length) throw new UnreadableQuery()
|
|
||||||
} catch {
|
|
||||||
return null
|
|
||||||
}
|
|
||||||
|
|
||||||
const root =
|
|
||||||
parsed.element.type === AdvancedSearchQueryElementType.Group
|
|
||||||
? parsed.element
|
|
||||||
: {
|
|
||||||
type: AdvancedSearchQueryElementType.Group as const,
|
|
||||||
operator: AdvancedSearchLogicalOperator.And,
|
|
||||||
children: [parsed.element],
|
|
||||||
}
|
|
||||||
|
|
||||||
return serializeAdvancedSearchQuery(root) === trimmed ? root : null
|
|
||||||
}
|
|
||||||
@@ -8,7 +8,7 @@ export const environment = {
|
|||||||
apiVersion: '10', // match src/paperless/settings.py
|
apiVersion: '10', // match src/paperless/settings.py
|
||||||
appTitle: DEFAULT_APP_TITLE,
|
appTitle: DEFAULT_APP_TITLE,
|
||||||
tag: 'prod',
|
tag: 'prod',
|
||||||
version: '3.2.0',
|
version: '3.2.1',
|
||||||
webSocketHost: window.location.host,
|
webSocketHost: window.location.host,
|
||||||
webSocketProtocol: window.location.protocol == 'https:' ? 'wss:' : 'ws:',
|
webSocketProtocol: window.location.protocol == 'https:' ? 'wss:' : 'ws:',
|
||||||
webSocketBaseUrl: base_url.pathname + 'ws/',
|
webSocketBaseUrl: base_url.pathname + 'ws/',
|
||||||
|
|||||||
@@ -2855,7 +2855,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/admin/tasks/tasks.component.ts</context>
|
<context context-type="sourcefile">src/app/components/admin/tasks/tasks.component.ts</context>
|
||||||
<context context-type="linenumber">104</context>
|
<context context-type="linenumber">104</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Apply AI Suggestions</target>
|
<target state="translated">KI-Vorschläge anwenden</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="9172233176401579786" datatype="html" approved="yes">
|
<trans-unit id="9172233176401579786" datatype="html" approved="yes">
|
||||||
<source>Scheduled</source>
|
<source>Scheduled</source>
|
||||||
@@ -3907,7 +3907,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-links.component.html</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-links.component.html</context>
|
||||||
<context context-type="linenumber">2,3</context>
|
<context context-type="linenumber">2,3</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Share links</target>
|
<target state="translated">Share Links</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="7844706011418789951" datatype="html" approved="yes">
|
<trans-unit id="7844706011418789951" datatype="html" approved="yes">
|
||||||
<source>Administration</source>
|
<source>Administration</source>
|
||||||
@@ -5835,7 +5835,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts</context>
|
<context context-type="sourcefile">src/app/components/common/edit-dialog/mail-rule-edit-dialog/mail-rule-edit-dialog.component.ts</context>
|
||||||
<context context-type="linenumber">182</context>
|
<context context-type="linenumber">182</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Error retrieving correspondents</target>
|
<target state="translated">Fehler beim Abrufen der Korrespondenten</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="3407606224361082860" datatype="html">
|
<trans-unit id="3407606224361082860" datatype="html">
|
||||||
<source>Error retrieving document types</source>
|
<source>Error retrieving document types</source>
|
||||||
@@ -9623,7 +9623,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.ts</context>
|
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.ts</context>
|
||||||
<context context-type="linenumber">1051</context>
|
<context context-type="linenumber">1051</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">You have unsaved changes to the content of this version.</target>
|
<target state="translated">Sie haben ungespeicherte Änderungen am Inhalt dieser Version.</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="85184271222513014" datatype="html">
|
<trans-unit id="85184271222513014" datatype="html">
|
||||||
<source>Switching versions will discard them.</source>
|
<source>Switching versions will discard them.</source>
|
||||||
@@ -12574,7 +12574,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-links.component.html</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-links.component.html</context>
|
||||||
<context context-type="linenumber">4,5</context>
|
<context context-type="linenumber">4,5</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Manage public links to individual documents and document bundles.</target>
|
<target state="translated">Verwalten Sie öffentliche Links zu einzelnen Dokumenten und Dokumentenbündeln.</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="3740311348735113099" datatype="html">
|
<trans-unit id="3740311348735113099" datatype="html">
|
||||||
<source>Document links</source>
|
<source>Document links</source>
|
||||||
|
|||||||
@@ -3907,7 +3907,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-links.component.html</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-links.component.html</context>
|
||||||
<context context-type="linenumber">2,3</context>
|
<context context-type="linenumber">2,3</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Share links</target>
|
<target state="translated">Condividi link</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="7844706011418789951" datatype="html">
|
<trans-unit id="7844706011418789951" datatype="html">
|
||||||
<source>Administration</source>
|
<source>Administration</source>
|
||||||
@@ -12411,7 +12411,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.html</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.html</context>
|
||||||
<context context-type="linenumber">40,41</context>
|
<context context-type="linenumber">40,41</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Expired</target>
|
<target state="translated">Scaduto</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="2057574872309338088" datatype="html">
|
<trans-unit id="2057574872309338088" datatype="html">
|
||||||
<source>Copy share link</source>
|
<source>Copy share link</source>
|
||||||
@@ -12455,7 +12455,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-bundle-list/share-link-bundle-list.component.html</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-bundle-list/share-link-bundle-list.component.html</context>
|
||||||
<context context-type="linenumber">164,165</context>
|
<context context-type="linenumber">164,165</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Share link bundles pagination</target>
|
<target state="translated">Paginazione dei pacchetti di link di condivisione</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="1541995860059283227" datatype="html">
|
<trans-unit id="1541995860059283227" datatype="html">
|
||||||
<source>Failed to load share link bundles.</source>
|
<source>Failed to load share link bundles.</source>
|
||||||
@@ -12511,7 +12511,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.html</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.html</context>
|
||||||
<context context-type="linenumber">7,8</context>
|
<context context-type="linenumber">7,8</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation"> No document share links currently exist. </target>
|
<target state="translated"> Attualmente non sono presenti link per la condivisione dei documenti. </target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="894965666917873756" datatype="html">
|
<trans-unit id="894965666917873756" datatype="html">
|
||||||
<source>Document</source>
|
<source>Document</source>
|
||||||
@@ -12519,7 +12519,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.html</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.html</context>
|
||||||
<context context-type="linenumber">15,16</context>
|
<context context-type="linenumber">15,16</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Document</target>
|
<target state="translated">Documento</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="7420713064779772535" datatype="html">
|
<trans-unit id="7420713064779772535" datatype="html">
|
||||||
<source>Delete share link</source>
|
<source>Delete share link</source>
|
||||||
@@ -12527,7 +12527,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.html</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.html</context>
|
||||||
<context context-type="linenumber">75,76</context>
|
<context context-type="linenumber">75,76</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Delete share link</target>
|
<target state="translated">Elimina link di condivisione</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="5198271726831144068" datatype="html">
|
<trans-unit id="5198271726831144068" datatype="html">
|
||||||
<source>Share links pagination</source>
|
<source>Share links pagination</source>
|
||||||
@@ -12535,7 +12535,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.html</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.html</context>
|
||||||
<context context-type="linenumber">104,105</context>
|
<context context-type="linenumber">104,105</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Share links pagination</target>
|
<target state="translated">Paginazione link condivisi</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="2976350639944567244" datatype="html">
|
<trans-unit id="2976350639944567244" datatype="html">
|
||||||
<source>Failed to load share links.</source>
|
<source>Failed to load share links.</source>
|
||||||
@@ -12543,7 +12543,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.ts</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.ts</context>
|
||||||
<context context-type="linenumber">105</context>
|
<context context-type="linenumber">105</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Failed to load share links.</target>
|
<target state="translated">Impossibile caricare i link di condivisione.</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="4100863040928608880" datatype="html">
|
<trans-unit id="4100863040928608880" datatype="html">
|
||||||
<source>Error retrieving share links.</source>
|
<source>Error retrieving share links.</source>
|
||||||
@@ -12551,7 +12551,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.ts</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.ts</context>
|
||||||
<context context-type="linenumber">107</context>
|
<context context-type="linenumber">107</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Error retrieving share links.</target>
|
<target state="translated">Errore nel recuperare i link di condivisione.</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="326120283142363299" datatype="html">
|
<trans-unit id="326120283142363299" datatype="html">
|
||||||
<source>Share link deleted.</source>
|
<source>Share link deleted.</source>
|
||||||
@@ -12559,7 +12559,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.ts</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.ts</context>
|
||||||
<context context-type="linenumber">154</context>
|
<context context-type="linenumber">154</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Share link deleted.</target>
|
<target state="translated">Link di condivisione eliminato.</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="4964931417181298145" datatype="html">
|
<trans-unit id="4964931417181298145" datatype="html">
|
||||||
<source>Error deleting share link.</source>
|
<source>Error deleting share link.</source>
|
||||||
@@ -12567,7 +12567,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.ts</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.ts</context>
|
||||||
<context context-type="linenumber">159</context>
|
<context context-type="linenumber">159</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Error deleting share link.</target>
|
<target state="translated">Errore nell'eliminare il link condivisione.</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="3439104787814858626" datatype="html">
|
<trans-unit id="3439104787814858626" datatype="html">
|
||||||
<source>Manage public links to individual documents and document bundles.</source>
|
<source>Manage public links to individual documents and document bundles.</source>
|
||||||
@@ -12575,7 +12575,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-links.component.html</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-links.component.html</context>
|
||||||
<context context-type="linenumber">4,5</context>
|
<context context-type="linenumber">4,5</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Manage public links to individual documents and document bundles.</target>
|
<target state="translated">Gestisci i link pubblici ai singoli documenti e pacchetti di documenti.</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="3740311348735113099" datatype="html">
|
<trans-unit id="3740311348735113099" datatype="html">
|
||||||
<source>Document links</source>
|
<source>Document links</source>
|
||||||
@@ -12583,7 +12583,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-links.component.html</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-links.component.html</context>
|
||||||
<context context-type="linenumber">18,19</context>
|
<context context-type="linenumber">18,19</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Document links</target>
|
<target state="translated">Link al documento</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="8216780576869093031" datatype="html">
|
<trans-unit id="8216780576869093031" datatype="html">
|
||||||
<source>Bundles</source>
|
<source>Bundles</source>
|
||||||
@@ -12591,7 +12591,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-links.component.html</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-links.component.html</context>
|
||||||
<context context-type="linenumber">26,27</context>
|
<context context-type="linenumber">26,27</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Bundles</target>
|
<target state="translated">Pacchetti</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="1229748338333965418" datatype="html">
|
<trans-unit id="1229748338333965418" datatype="html">
|
||||||
<source>Use workflows to customize the behavior of Paperless-ngx when events 'trigger' a workflow.</source>
|
<source>Use workflows to customize the behavior of Paperless-ngx when events 'trigger' a workflow.</source>
|
||||||
|
|||||||
@@ -3907,7 +3907,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-links.component.html</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-links.component.html</context>
|
||||||
<context context-type="linenumber">2,3</context>
|
<context context-type="linenumber">2,3</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Share links</target>
|
<target state="translated">Ссылки для обмена</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="7844706011418789951" datatype="html">
|
<trans-unit id="7844706011418789951" datatype="html">
|
||||||
<source>Administration</source>
|
<source>Administration</source>
|
||||||
@@ -12410,7 +12410,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.html</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.html</context>
|
||||||
<context context-type="linenumber">40,41</context>
|
<context context-type="linenumber">40,41</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Expired</target>
|
<target state="translated">Истёкшие</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="2057574872309338088" datatype="html">
|
<trans-unit id="2057574872309338088" datatype="html">
|
||||||
<source>Copy share link</source>
|
<source>Copy share link</source>
|
||||||
@@ -12454,7 +12454,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-bundle-list/share-link-bundle-list.component.html</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-bundle-list/share-link-bundle-list.component.html</context>
|
||||||
<context context-type="linenumber">164,165</context>
|
<context context-type="linenumber">164,165</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Share link bundles pagination</target>
|
<target state="translated">Пагинация ссылок</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="1541995860059283227" datatype="html">
|
<trans-unit id="1541995860059283227" datatype="html">
|
||||||
<source>Failed to load share link bundles.</source>
|
<source>Failed to load share link bundles.</source>
|
||||||
@@ -12510,7 +12510,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.html</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.html</context>
|
||||||
<context context-type="linenumber">7,8</context>
|
<context context-type="linenumber">7,8</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation"> No document share links currently exist. </target>
|
<target state="translated"> В настоящее время нет общих ссылок. </target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="894965666917873756" datatype="html">
|
<trans-unit id="894965666917873756" datatype="html">
|
||||||
<source>Document</source>
|
<source>Document</source>
|
||||||
@@ -12518,7 +12518,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.html</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.html</context>
|
||||||
<context context-type="linenumber">15,16</context>
|
<context context-type="linenumber">15,16</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Document</target>
|
<target state="translated">Документ</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="7420713064779772535" datatype="html">
|
<trans-unit id="7420713064779772535" datatype="html">
|
||||||
<source>Delete share link</source>
|
<source>Delete share link</source>
|
||||||
@@ -12526,7 +12526,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.html</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.html</context>
|
||||||
<context context-type="linenumber">75,76</context>
|
<context context-type="linenumber">75,76</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Delete share link</target>
|
<target state="translated">Удалить ссылку для обмена</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="5198271726831144068" datatype="html">
|
<trans-unit id="5198271726831144068" datatype="html">
|
||||||
<source>Share links pagination</source>
|
<source>Share links pagination</source>
|
||||||
@@ -12534,7 +12534,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.html</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.html</context>
|
||||||
<context context-type="linenumber">104,105</context>
|
<context context-type="linenumber">104,105</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Share links pagination</target>
|
<target state="translated">Пагинация ссылок</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="2976350639944567244" datatype="html">
|
<trans-unit id="2976350639944567244" datatype="html">
|
||||||
<source>Failed to load share links.</source>
|
<source>Failed to load share links.</source>
|
||||||
@@ -12542,7 +12542,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.ts</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.ts</context>
|
||||||
<context context-type="linenumber">105</context>
|
<context context-type="linenumber">105</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Failed to load share links.</target>
|
<target state="translated">Не удалось загрузить ссылки.</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="4100863040928608880" datatype="html">
|
<trans-unit id="4100863040928608880" datatype="html">
|
||||||
<source>Error retrieving share links.</source>
|
<source>Error retrieving share links.</source>
|
||||||
@@ -12550,7 +12550,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.ts</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.ts</context>
|
||||||
<context context-type="linenumber">107</context>
|
<context context-type="linenumber">107</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Error retrieving share links.</target>
|
<target state="translated">Ошибка при получении ссылок.</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="326120283142363299" datatype="html">
|
<trans-unit id="326120283142363299" datatype="html">
|
||||||
<source>Share link deleted.</source>
|
<source>Share link deleted.</source>
|
||||||
@@ -12558,7 +12558,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.ts</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.ts</context>
|
||||||
<context context-type="linenumber">154</context>
|
<context context-type="linenumber">154</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Share link deleted.</target>
|
<target state="translated">Ссылка для обмена удалена.</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="4964931417181298145" datatype="html">
|
<trans-unit id="4964931417181298145" datatype="html">
|
||||||
<source>Error deleting share link.</source>
|
<source>Error deleting share link.</source>
|
||||||
@@ -12566,7 +12566,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.ts</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.ts</context>
|
||||||
<context context-type="linenumber">159</context>
|
<context context-type="linenumber">159</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Error deleting share link.</target>
|
<target state="translated">Ошибка при удалении ссылки.</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="3439104787814858626" datatype="html">
|
<trans-unit id="3439104787814858626" datatype="html">
|
||||||
<source>Manage public links to individual documents and document bundles.</source>
|
<source>Manage public links to individual documents and document bundles.</source>
|
||||||
@@ -12574,7 +12574,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-links.component.html</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-links.component.html</context>
|
||||||
<context context-type="linenumber">4,5</context>
|
<context context-type="linenumber">4,5</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Manage public links to individual documents and document bundles.</target>
|
<target state="translated">Управление публичными ссылками на отдельные документы и комплекты документов.</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="3740311348735113099" datatype="html">
|
<trans-unit id="3740311348735113099" datatype="html">
|
||||||
<source>Document links</source>
|
<source>Document links</source>
|
||||||
@@ -12582,7 +12582,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-links.component.html</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-links.component.html</context>
|
||||||
<context context-type="linenumber">18,19</context>
|
<context context-type="linenumber">18,19</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Document links</target>
|
<target state="translated">Ссылки на документы</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="8216780576869093031" datatype="html">
|
<trans-unit id="8216780576869093031" datatype="html">
|
||||||
<source>Bundles</source>
|
<source>Bundles</source>
|
||||||
@@ -12590,7 +12590,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-links.component.html</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-links.component.html</context>
|
||||||
<context context-type="linenumber">26,27</context>
|
<context context-type="linenumber">26,27</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Bundles</target>
|
<target state="translated">Комплекты</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="1229748338333965418" datatype="html">
|
<trans-unit id="1229748338333965418" datatype="html">
|
||||||
<source>Use workflows to customize the behavior of Paperless-ngx when events 'trigger' a workflow.</source>
|
<source>Use workflows to customize the behavior of Paperless-ngx when events 'trigger' a workflow.</source>
|
||||||
|
|||||||
@@ -2855,7 +2855,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/admin/tasks/tasks.component.ts</context>
|
<context context-type="sourcefile">src/app/components/admin/tasks/tasks.component.ts</context>
|
||||||
<context context-type="linenumber">104</context>
|
<context context-type="linenumber">104</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Apply AI Suggestions</target>
|
<target state="translated">Uporabi predloge umetne inteligence</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="9172233176401579786" datatype="html">
|
<trans-unit id="9172233176401579786" datatype="html">
|
||||||
<source>Scheduled</source>
|
<source>Scheduled</source>
|
||||||
@@ -3907,7 +3907,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-links.component.html</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-links.component.html</context>
|
||||||
<context context-type="linenumber">2,3</context>
|
<context context-type="linenumber">2,3</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Share links</target>
|
<target state="translated">Delite povezave</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="7844706011418789951" datatype="html">
|
<trans-unit id="7844706011418789951" datatype="html">
|
||||||
<source>Administration</source>
|
<source>Administration</source>
|
||||||
@@ -12411,7 +12411,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.html</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.html</context>
|
||||||
<context context-type="linenumber">40,41</context>
|
<context context-type="linenumber">40,41</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Expired</target>
|
<target state="translated">Poteklo</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="2057574872309338088" datatype="html">
|
<trans-unit id="2057574872309338088" datatype="html">
|
||||||
<source>Copy share link</source>
|
<source>Copy share link</source>
|
||||||
@@ -12455,7 +12455,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-bundle-list/share-link-bundle-list.component.html</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-bundle-list/share-link-bundle-list.component.html</context>
|
||||||
<context context-type="linenumber">164,165</context>
|
<context context-type="linenumber">164,165</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Share link bundles pagination</target>
|
<target state="translated">Deljenje povezav – strani v sklopih</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="1541995860059283227" datatype="html">
|
<trans-unit id="1541995860059283227" datatype="html">
|
||||||
<source>Failed to load share link bundles.</source>
|
<source>Failed to load share link bundles.</source>
|
||||||
@@ -12511,7 +12511,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.html</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.html</context>
|
||||||
<context context-type="linenumber">7,8</context>
|
<context context-type="linenumber">7,8</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation"> No document share links currently exist. </target>
|
<target state="translated"> Trenutno ni povezav za skupno rabo dokumentov. </target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="894965666917873756" datatype="html">
|
<trans-unit id="894965666917873756" datatype="html">
|
||||||
<source>Document</source>
|
<source>Document</source>
|
||||||
@@ -12519,7 +12519,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.html</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.html</context>
|
||||||
<context context-type="linenumber">15,16</context>
|
<context context-type="linenumber">15,16</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Document</target>
|
<target state="translated">Dokument</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="7420713064779772535" datatype="html">
|
<trans-unit id="7420713064779772535" datatype="html">
|
||||||
<source>Delete share link</source>
|
<source>Delete share link</source>
|
||||||
@@ -12527,7 +12527,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.html</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.html</context>
|
||||||
<context context-type="linenumber">75,76</context>
|
<context context-type="linenumber">75,76</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Delete share link</target>
|
<target state="translated">Izbriši povezavo za deljenje</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="5198271726831144068" datatype="html">
|
<trans-unit id="5198271726831144068" datatype="html">
|
||||||
<source>Share links pagination</source>
|
<source>Share links pagination</source>
|
||||||
@@ -12535,7 +12535,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.html</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.html</context>
|
||||||
<context context-type="linenumber">104,105</context>
|
<context context-type="linenumber">104,105</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Share links pagination</target>
|
<target state="translated">Deljenje povezav – strani v sklopih</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="2976350639944567244" datatype="html">
|
<trans-unit id="2976350639944567244" datatype="html">
|
||||||
<source>Failed to load share links.</source>
|
<source>Failed to load share links.</source>
|
||||||
@@ -12543,7 +12543,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.ts</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.ts</context>
|
||||||
<context context-type="linenumber">105</context>
|
<context context-type="linenumber">105</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Failed to load share links.</target>
|
<target state="translated">Povezav za deljenje ni bilo mogoče naložiti.</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="4100863040928608880" datatype="html">
|
<trans-unit id="4100863040928608880" datatype="html">
|
||||||
<source>Error retrieving share links.</source>
|
<source>Error retrieving share links.</source>
|
||||||
@@ -12551,7 +12551,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.ts</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.ts</context>
|
||||||
<context context-type="linenumber">107</context>
|
<context context-type="linenumber">107</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Error retrieving share links.</target>
|
<target state="translated">Napaka pri pridobivanju povezav za deljenje.</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="326120283142363299" datatype="html">
|
<trans-unit id="326120283142363299" datatype="html">
|
||||||
<source>Share link deleted.</source>
|
<source>Share link deleted.</source>
|
||||||
@@ -12559,7 +12559,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.ts</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.ts</context>
|
||||||
<context context-type="linenumber">154</context>
|
<context context-type="linenumber">154</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Share link deleted.</target>
|
<target state="translated">Povezava za deljenje je bila izbrisana.</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="4964931417181298145" datatype="html">
|
<trans-unit id="4964931417181298145" datatype="html">
|
||||||
<source>Error deleting share link.</source>
|
<source>Error deleting share link.</source>
|
||||||
@@ -12567,7 +12567,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.ts</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-link-list/share-link-list.component.ts</context>
|
||||||
<context context-type="linenumber">159</context>
|
<context context-type="linenumber">159</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Error deleting share link.</target>
|
<target state="translated">Napaka pri brisanju povezave za deljenje.</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="3439104787814858626" datatype="html">
|
<trans-unit id="3439104787814858626" datatype="html">
|
||||||
<source>Manage public links to individual documents and document bundles.</source>
|
<source>Manage public links to individual documents and document bundles.</source>
|
||||||
@@ -12575,7 +12575,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-links.component.html</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-links.component.html</context>
|
||||||
<context context-type="linenumber">4,5</context>
|
<context context-type="linenumber">4,5</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Manage public links to individual documents and document bundles.</target>
|
<target state="translated">Upravljajte javne povezave do posameznih dokumentov in paketov dokumentov.</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="3740311348735113099" datatype="html">
|
<trans-unit id="3740311348735113099" datatype="html">
|
||||||
<source>Document links</source>
|
<source>Document links</source>
|
||||||
@@ -12583,7 +12583,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-links.component.html</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-links.component.html</context>
|
||||||
<context context-type="linenumber">18,19</context>
|
<context context-type="linenumber">18,19</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Document links</target>
|
<target state="translated">Povezave do dokumentov</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="8216780576869093031" datatype="html">
|
<trans-unit id="8216780576869093031" datatype="html">
|
||||||
<source>Bundles</source>
|
<source>Bundles</source>
|
||||||
@@ -12591,7 +12591,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/share-links/share-links.component.html</context>
|
<context context-type="sourcefile">src/app/components/manage/share-links/share-links.component.html</context>
|
||||||
<context context-type="linenumber">26,27</context>
|
<context context-type="linenumber">26,27</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="needs-translation">Bundles</target>
|
<target state="translated">Paketi</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="1229748338333965418" datatype="html">
|
<trans-unit id="1229748338333965418" datatype="html">
|
||||||
<source>Use workflows to customize the behavior of Paperless-ngx when events 'trigger' a workflow.</source>
|
<source>Use workflows to customize the behavior of Paperless-ngx when events 'trigger' a workflow.</source>
|
||||||
|
|||||||
@@ -11518,7 +11518,7 @@
|
|||||||
<context context-type="sourcefile">src/app/components/manage/document-attributes/custom-fields/custom-fields.component.html</context>
|
<context context-type="sourcefile">src/app/components/manage/document-attributes/custom-fields/custom-fields.component.html</context>
|
||||||
<context context-type="linenumber">70,72</context>
|
<context context-type="linenumber">70,72</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<target state="translated"/>
|
<target state="translated">Inga fält har definierats.</target>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="3032792139967609806" datatype="html">
|
<trans-unit id="3032792139967609806" datatype="html">
|
||||||
<source>Confirm delete field</source>
|
<source>Confirm delete field</source>
|
||||||
|
|||||||
+4
-2
@@ -74,6 +74,7 @@ import {
|
|||||||
clipboardCheckFill,
|
clipboardCheckFill,
|
||||||
clipboardFill,
|
clipboardFill,
|
||||||
clockHistory,
|
clockHistory,
|
||||||
|
cpu,
|
||||||
creditCard,
|
creditCard,
|
||||||
dash,
|
dash,
|
||||||
dashCircle,
|
dashCircle,
|
||||||
@@ -118,6 +119,7 @@ import {
|
|||||||
infoCircle,
|
infoCircle,
|
||||||
journalBookmarkFill,
|
journalBookmarkFill,
|
||||||
journals,
|
journals,
|
||||||
|
lightbulb,
|
||||||
link,
|
link,
|
||||||
list,
|
list,
|
||||||
listNested,
|
listNested,
|
||||||
@@ -148,7 +150,6 @@ import {
|
|||||||
send,
|
send,
|
||||||
shop,
|
shop,
|
||||||
slashCircle,
|
slashCircle,
|
||||||
sliders,
|
|
||||||
sliders2Vertical,
|
sliders2Vertical,
|
||||||
sortAlphaDown,
|
sortAlphaDown,
|
||||||
sortAlphaUpAlt,
|
sortAlphaUpAlt,
|
||||||
@@ -323,6 +324,7 @@ const icons = {
|
|||||||
clipboardCheckFill,
|
clipboardCheckFill,
|
||||||
clipboardFill,
|
clipboardFill,
|
||||||
clockHistory,
|
clockHistory,
|
||||||
|
cpu,
|
||||||
cash,
|
cash,
|
||||||
creditCard,
|
creditCard,
|
||||||
dash,
|
dash,
|
||||||
@@ -368,6 +370,7 @@ const icons = {
|
|||||||
infoCircle,
|
infoCircle,
|
||||||
journalBookmarkFill,
|
journalBookmarkFill,
|
||||||
journals,
|
journals,
|
||||||
|
lightbulb,
|
||||||
link,
|
link,
|
||||||
list,
|
list,
|
||||||
listNested,
|
listNested,
|
||||||
@@ -398,7 +401,6 @@ const icons = {
|
|||||||
send,
|
send,
|
||||||
slashCircle,
|
slashCircle,
|
||||||
shop,
|
shop,
|
||||||
sliders,
|
|
||||||
sliders2Vertical,
|
sliders2Vertical,
|
||||||
sortAlphaDown,
|
sortAlphaDown,
|
||||||
sortAlphaUpAlt,
|
sortAlphaUpAlt,
|
||||||
|
|||||||
@@ -292,6 +292,7 @@ a.btn-link:active,
|
|||||||
a.btn-link:focus-visible,
|
a.btn-link:focus-visible,
|
||||||
.btn-link:hover,
|
.btn-link:hover,
|
||||||
.btn-link:active,
|
.btn-link:active,
|
||||||
|
.btn-link.show,
|
||||||
.btn-link:focus-visible {
|
.btn-link:focus-visible {
|
||||||
color: var(--pngx-primary-lighten-10) !important;
|
color: var(--pngx-primary-lighten-10) !important;
|
||||||
.primary-light & {
|
.primary-light & {
|
||||||
|
|||||||
@@ -25,10 +25,20 @@ export class PDFFindController {
|
|||||||
onIsPageVisible?: () => boolean
|
onIsPageVisible?: () => boolean
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export const LinkTarget = {
|
||||||
|
NONE: 0,
|
||||||
|
SELF: 1,
|
||||||
|
BLANK: 2,
|
||||||
|
PARENT: 3,
|
||||||
|
TOP: 4,
|
||||||
|
}
|
||||||
|
|
||||||
export class PDFLinkService {
|
export class PDFLinkService {
|
||||||
private document?: unknown
|
private document?: unknown
|
||||||
private viewer?: unknown
|
private viewer?: unknown
|
||||||
|
|
||||||
|
constructor(readonly options: Record<string, unknown> = {}) {}
|
||||||
|
|
||||||
setDocument(document: unknown): void {
|
setDocument(document: unknown): void {
|
||||||
this.document = document
|
this.document = document
|
||||||
}
|
}
|
||||||
|
|||||||
+151
@@ -0,0 +1,151 @@
|
|||||||
|
"""Fixtures available to every Paperless-ngx app.
|
||||||
|
|
||||||
|
Loaded automatically for every test path. Keep module-scope imports minimal:
|
||||||
|
this file is imported for every session, so anything heavy belongs inside
|
||||||
|
the fixture body that needs it.
|
||||||
|
"""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from typing import TYPE_CHECKING
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from collections.abc import Generator
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from django.contrib.auth.models import User
|
||||||
|
from pytest_django.fixtures import Settings
|
||||||
|
from rest_framework.test import APIClient
|
||||||
|
|
||||||
|
from paperless_testing.dirs import PaperlessDirs
|
||||||
|
from paperless_testing.fakes.progress import FakeProgressManager
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture(scope="session", autouse=True)
|
||||||
|
def faker_session_locale() -> str:
|
||||||
|
"""Pin Faker's locale so generated data does not follow the host locale.
|
||||||
|
|
||||||
|
The seed itself is left to pytest-randomly, which derives one per run.
|
||||||
|
"""
|
||||||
|
return "en_US"
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture(autouse=True)
|
||||||
|
def _fast_password_hasher(settings: Settings) -> None:
|
||||||
|
"""Hash test passwords with MD5 instead of Django's default PBKDF2.
|
||||||
|
|
||||||
|
PBKDF2 is deliberately slow, and every ``admin_user`` or
|
||||||
|
``create_superuser`` call pays for it: about 600 ms each. No test depends
|
||||||
|
on the hash format, only on ``check_password`` and on the stored value
|
||||||
|
changing when the password does.
|
||||||
|
"""
|
||||||
|
settings.PASSWORD_HASHERS = ["django.contrib.auth.hashers.MD5PasswordHasher"]
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture(autouse=True)
|
||||||
|
def _clear_content_type_caches() -> None:
|
||||||
|
"""Clear Django's ContentType cache and guardian's lru_cache before each test.
|
||||||
|
|
||||||
|
Tests that delete and reinsert ContentType/Permission rows (e.g. the
|
||||||
|
importer) corrupt both caches. Without this fixture a subsequent test on
|
||||||
|
the same xdist worker sees stale ContentType objects and guardian raises
|
||||||
|
MixedContentTypeError.
|
||||||
|
"""
|
||||||
|
from django.contrib.contenttypes.models import ContentType
|
||||||
|
from guardian.shortcuts import clear_ct_cache
|
||||||
|
|
||||||
|
ContentType.objects.clear_cache()
|
||||||
|
clear_ct_cache()
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture(autouse=True)
|
||||||
|
def _clear_django_caches() -> None:
|
||||||
|
"""Clear every configured cache before each test.
|
||||||
|
|
||||||
|
Cached values outlive the test that wrote them: the classifier keys its
|
||||||
|
vectorized content on a hash of the content itself, so a second test
|
||||||
|
generating the same fixture data takes the cache-hit path and never calls
|
||||||
|
the code it is asserting against.
|
||||||
|
"""
|
||||||
|
from django.core.cache import caches
|
||||||
|
|
||||||
|
for cache in caches.all(initialized_only=False):
|
||||||
|
cache.clear()
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def paperless_dirs(
|
||||||
|
tmp_path: Path,
|
||||||
|
settings: Settings,
|
||||||
|
) -> Generator[PaperlessDirs, None, None]:
|
||||||
|
"""The standard temp directory layout, applied to Django settings."""
|
||||||
|
from documents.search import reset_backend
|
||||||
|
from paperless_testing.dirs import build_paperless_dirs
|
||||||
|
from paperless_testing.dirs import dirs_settings
|
||||||
|
|
||||||
|
dirs = build_paperless_dirs(tmp_path)
|
||||||
|
for name, value in dirs_settings(dirs).items():
|
||||||
|
setattr(settings, name, value)
|
||||||
|
|
||||||
|
# Not directory settings, but they are needed alongside the layout by the
|
||||||
|
# sanity checker tests.
|
||||||
|
settings.IGNORABLE_FILES = {".DS_Store", "Thumbs.db", "desktop.ini"}
|
||||||
|
settings.APP_LOGO = ""
|
||||||
|
|
||||||
|
reset_backend()
|
||||||
|
yield dirs
|
||||||
|
reset_backend()
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def rest_api_client() -> APIClient:
|
||||||
|
"""The basic DRF APIClient, unauthenticated."""
|
||||||
|
from rest_framework.test import APIClient
|
||||||
|
|
||||||
|
return APIClient()
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def regular_user(db: None) -> User:
|
||||||
|
"""Unprivileged user for permission boundary tests."""
|
||||||
|
from paperless_testing.factories import UserFactory
|
||||||
|
|
||||||
|
return UserFactory(username="regular")
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def admin_client(rest_api_client: APIClient, admin_user: User) -> APIClient:
|
||||||
|
"""Admin client pre-authenticated and sending the v10 Accept header."""
|
||||||
|
rest_api_client.force_authenticate(user=admin_user)
|
||||||
|
rest_api_client.credentials(HTTP_ACCEPT="application/json; version=10")
|
||||||
|
return rest_api_client
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def v9_client(rest_api_client: APIClient, admin_user: User) -> APIClient:
|
||||||
|
"""Admin client pre-authenticated and sending the v9 Accept header."""
|
||||||
|
rest_api_client.force_authenticate(user=admin_user)
|
||||||
|
rest_api_client.credentials(HTTP_ACCEPT="application/json; version=9")
|
||||||
|
return rest_api_client
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def user_client(rest_api_client: APIClient, regular_user: User) -> APIClient:
|
||||||
|
"""Regular-user client pre-authenticated and sending the v10 Accept header."""
|
||||||
|
rest_api_client.force_authenticate(user=regular_user)
|
||||||
|
rest_api_client.credentials(HTTP_ACCEPT="application/json; version=10")
|
||||||
|
return rest_api_client
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def fake_progress_manager(
|
||||||
|
monkeypatch: pytest.MonkeyPatch,
|
||||||
|
) -> type[FakeProgressManager]:
|
||||||
|
"""Replace documents.tasks.ProgressManager with the fake, so consuming a file
|
||||||
|
in a test never tries to reach a broker."""
|
||||||
|
from paperless_testing.fakes.progress import FakeProgressManager
|
||||||
|
|
||||||
|
monkeypatch.setattr("documents.tasks.ProgressManager", FakeProgressManager)
|
||||||
|
return FakeProgressManager
|
||||||
@@ -26,7 +26,6 @@ class DocumentsConfig(AppConfig):
|
|||||||
document_consumption_finished.connect(set_document_type)
|
document_consumption_finished.connect(set_document_type)
|
||||||
document_consumption_finished.connect(set_tags)
|
document_consumption_finished.connect(set_tags)
|
||||||
document_consumption_finished.connect(set_storage_path)
|
document_consumption_finished.connect(set_storage_path)
|
||||||
document_consumption_finished.connect(add_to_index)
|
|
||||||
document_consumption_finished.connect(run_workflows_added)
|
document_consumption_finished.connect(run_workflows_added)
|
||||||
document_consumption_finished.connect(add_to_index)
|
document_consumption_finished.connect(add_to_index)
|
||||||
document_consumption_finished.connect(add_or_update_document_in_llm_index)
|
document_consumption_finished.connect(add_or_update_document_in_llm_index)
|
||||||
|
|||||||
@@ -857,8 +857,9 @@ class ConsumerPlugin(
|
|||||||
self.log.debug(f"Creation date from parse_date: {create_date}")
|
self.log.debug(f"Creation date from parse_date: {create_date}")
|
||||||
else:
|
else:
|
||||||
stats = Path(self.input_doc.original_file).stat()
|
stats = Path(self.input_doc.original_file).stat()
|
||||||
create_date = timezone.make_aware(
|
create_date = datetime.datetime.fromtimestamp(
|
||||||
datetime.datetime.fromtimestamp(stats.st_mtime),
|
stats.st_mtime,
|
||||||
|
tz=timezone.get_current_timezone(),
|
||||||
)
|
)
|
||||||
self.log.debug(f"Creation date from st_mtime: {create_date}")
|
self.log.debug(f"Creation date from st_mtime: {create_date}")
|
||||||
|
|
||||||
|
|||||||
@@ -196,7 +196,6 @@ class WriteBatch:
|
|||||||
return self._raw_writer
|
return self._raw_writer
|
||||||
|
|
||||||
def __enter__(self) -> Self:
|
def __enter__(self) -> Self:
|
||||||
if self._backend._path is not None:
|
|
||||||
lock_path = self._backend._path / ".tantivy.lock"
|
lock_path = self._backend._path / ".tantivy.lock"
|
||||||
self._lock = filelock.FileLock(str(lock_path))
|
self._lock = filelock.FileLock(str(lock_path))
|
||||||
for attempt in range(_LOCK_RETRY_ATTEMPTS):
|
for attempt in range(_LOCK_RETRY_ATTEMPTS):
|
||||||
@@ -240,8 +239,6 @@ class WriteBatch:
|
|||||||
)
|
)
|
||||||
register_tokenizers(write_index, settings.SEARCH_LANGUAGE)
|
register_tokenizers(write_index, settings.SEARCH_LANGUAGE)
|
||||||
self._raw_writer = write_index.writer()
|
self._raw_writer = write_index.writer()
|
||||||
else:
|
|
||||||
self._raw_writer = self._backend._index.writer()
|
|
||||||
return self
|
return self
|
||||||
|
|
||||||
def __exit__(self, exc_type, exc_val, exc_tb):
|
def __exit__(self, exc_type, exc_val, exc_tb):
|
||||||
@@ -372,9 +369,8 @@ class TantivyBackend:
|
|||||||
Tantivy search backend with explicit lifecycle management.
|
Tantivy search backend with explicit lifecycle management.
|
||||||
|
|
||||||
Provides full-text search capabilities using the Tantivy search engine.
|
Provides full-text search capabilities using the Tantivy search engine.
|
||||||
Supports in-memory indexes (for testing) and persistent on-disk indexes
|
Keeps a persistent on-disk index. Handles document indexing, search queries,
|
||||||
(for production use). Handles document indexing, search queries, autocompletion,
|
autocompletion, and "more like this" functionality.
|
||||||
and "more like this" functionality.
|
|
||||||
|
|
||||||
The backend manages its own connection lifecycle and can be reset when
|
The backend manages its own connection lifecycle and can be reset when
|
||||||
the underlying index directory changes (e.g., during test isolation).
|
the underlying index directory changes (e.g., during test isolation).
|
||||||
@@ -408,9 +404,7 @@ class TantivyBackend:
|
|||||||
},
|
},
|
||||||
)
|
)
|
||||||
|
|
||||||
def __init__(self, path: Path | None = None):
|
def __init__(self, path: Path):
|
||||||
# path=None → in-memory index (for tests)
|
|
||||||
# path=some_dir → on-disk index (for production)
|
|
||||||
self._path = path
|
self._path = path
|
||||||
self._raw_index: tantivy.Index | None = None
|
self._raw_index: tantivy.Index | None = None
|
||||||
self._raw_schema: tantivy.Schema | None = None
|
self._raw_schema: tantivy.Schema | None = None
|
||||||
@@ -429,16 +423,13 @@ class TantivyBackend:
|
|||||||
"""
|
"""
|
||||||
Open or rebuild the index as needed.
|
Open or rebuild the index as needed.
|
||||||
|
|
||||||
For disk-based indexes, checks if rebuilding is needed due to schema
|
Checks if rebuilding is needed due to schema version or language
|
||||||
version or language changes. Registers custom tokenizers after opening.
|
changes. Registers custom tokenizers after opening.
|
||||||
Safe to call multiple times - subsequent calls are no-ops.
|
Safe to call multiple times - subsequent calls are no-ops.
|
||||||
"""
|
"""
|
||||||
if self._raw_index is not None:
|
if self._raw_index is not None:
|
||||||
return # pragma: no cover
|
return # pragma: no cover
|
||||||
if self._path is not None:
|
|
||||||
self._raw_index = open_or_rebuild_index(self._path)
|
self._raw_index = open_or_rebuild_index(self._path)
|
||||||
else:
|
|
||||||
self._raw_index = tantivy.Index(build_schema())
|
|
||||||
register_tokenizers(self._raw_index, settings.SEARCH_LANGUAGE)
|
register_tokenizers(self._raw_index, settings.SEARCH_LANGUAGE)
|
||||||
self._raw_schema = self._raw_index.schema
|
self._raw_schema = self._raw_index.schema
|
||||||
|
|
||||||
@@ -1102,13 +1093,9 @@ class TantivyBackend:
|
|||||||
writer's threads). Larger values buffer more docs in RAM before
|
writer's threads). Larger values buffer more docs in RAM before
|
||||||
flushing a segment, deferring merge work; they do not avoid it.
|
flushing a segment, deferring merge work; they do not avoid it.
|
||||||
"""
|
"""
|
||||||
# Create new index (on-disk or in-memory)
|
|
||||||
if self._path is not None:
|
|
||||||
wipe_index(self._path)
|
wipe_index(self._path)
|
||||||
new_index = tantivy.Index(build_schema(), path=str(self._path))
|
new_index = tantivy.Index(build_schema(), path=str(self._path))
|
||||||
_write_sentinels(self._path)
|
_write_sentinels(self._path)
|
||||||
else:
|
|
||||||
new_index = tantivy.Index(build_schema())
|
|
||||||
register_tokenizers(new_index, settings.SEARCH_LANGUAGE)
|
register_tokenizers(new_index, settings.SEARCH_LANGUAGE)
|
||||||
|
|
||||||
# Point instance at the new index so _build_tantivy_doc uses it
|
# Point instance at the new index so _build_tantivy_doc uses it
|
||||||
|
|||||||
@@ -1079,6 +1079,16 @@ class DocumentSerializer(
|
|||||||
)
|
)
|
||||||
|
|
||||||
def get_page_count(self, obj) -> int | None:
|
def get_page_count(self, obj) -> int | None:
|
||||||
|
# Like content versions get their own page count from the newest version,
|
||||||
|
# use the prefetched versions cache to avoid an extra query
|
||||||
|
prefetched_cache = getattr(obj, "_prefetched_objects_cache", None)
|
||||||
|
prefetched_versions = (
|
||||||
|
prefetched_cache.get("versions")
|
||||||
|
if isinstance(prefetched_cache, dict)
|
||||||
|
else None
|
||||||
|
)
|
||||||
|
if obj.root_document_id is None and prefetched_versions:
|
||||||
|
return sort_versions_newest_first(prefetched_versions)[0].page_count
|
||||||
return obj.page_count
|
return obj.page_count
|
||||||
|
|
||||||
@extend_schema_field(DuplicateDocumentSummarySerializer(many=True))
|
@extend_schema_field(DuplicateDocumentSummarySerializer(many=True))
|
||||||
@@ -2098,6 +2108,8 @@ class BulkEditSerializer(
|
|||||||
if not isinstance(parameters["pages"], str):
|
if not isinstance(parameters["pages"], str):
|
||||||
raise serializers.ValidationError("invalid pages specified")
|
raise serializers.ValidationError("invalid pages specified")
|
||||||
page_count = Document.objects.get(id=document_id).page_count
|
page_count = Document.objects.get(id=document_id).page_count
|
||||||
|
if not page_count:
|
||||||
|
raise serializers.ValidationError("document page count is unknown")
|
||||||
pages = []
|
pages = []
|
||||||
for group in parameters["pages"].split(","):
|
for group in parameters["pages"].split(","):
|
||||||
start, is_range, end = group.partition("-")
|
start, is_range, end = group.partition("-")
|
||||||
@@ -2107,7 +2119,7 @@ class BulkEditSerializer(
|
|||||||
except ValueError as e:
|
except ValueError as e:
|
||||||
raise serializers.ValidationError("invalid pages specified") from e
|
raise serializers.ValidationError("invalid pages specified") from e
|
||||||
# Bound the range before building it, a huge one would exhaust memory
|
# Bound the range before building it, a huge one would exhaust memory
|
||||||
if not 1 <= first <= last or (page_count and last > page_count):
|
if not 1 <= first <= last <= page_count:
|
||||||
raise serializers.ValidationError("invalid pages specified")
|
raise serializers.ValidationError("invalid pages specified")
|
||||||
pages.append(list(range(first, last + 1)))
|
pages.append(list(range(first, last + 1)))
|
||||||
parameters["pages"] = pages
|
parameters["pages"] = pages
|
||||||
|
|||||||
@@ -56,6 +56,7 @@ from documents.permissions import get_objects_for_user_owner_aware
|
|||||||
from documents.plugins.helpers import DocumentsStatusManager
|
from documents.plugins.helpers import DocumentsStatusManager
|
||||||
from documents.templating.utils import convert_format_str_to_template_format
|
from documents.templating.utils import convert_format_str_to_template_format
|
||||||
from documents.utils import compute_checksum
|
from documents.utils import compute_checksum
|
||||||
|
from documents.utils import copy_file_with_basic_stats
|
||||||
from documents.workflows.actions import build_workflow_action_context
|
from documents.workflows.actions import build_workflow_action_context
|
||||||
from documents.workflows.actions import execute_email_action
|
from documents.workflows.actions import execute_email_action
|
||||||
from documents.workflows.actions import execute_move_to_trash_action
|
from documents.workflows.actions import execute_move_to_trash_action
|
||||||
@@ -363,7 +364,11 @@ def cleanup_document_deletion(sender, instance, **kwargs) -> None:
|
|||||||
|
|
||||||
logger.debug(f"Moving {instance.source_path} to trash at {new_file_path}")
|
logger.debug(f"Moving {instance.source_path} to trash at {new_file_path}")
|
||||||
try:
|
try:
|
||||||
shutil.move(instance.source_path, new_file_path)
|
shutil.move(
|
||||||
|
instance.source_path,
|
||||||
|
new_file_path,
|
||||||
|
copy_function=copy_file_with_basic_stats,
|
||||||
|
)
|
||||||
except OSError as e:
|
except OSError as e:
|
||||||
logger.error(
|
logger.error(
|
||||||
f"Failed to move {instance.source_path} to trash at "
|
f"Failed to move {instance.source_path} to trash at "
|
||||||
|
|||||||
@@ -12,7 +12,7 @@
|
|||||||
<meta name="robots" content="noindex,nofollow">
|
<meta name="robots" content="noindex,nofollow">
|
||||||
<meta name="author" content="The Paperless-ngx Team">
|
<meta name="author" content="The Paperless-ngx Team">
|
||||||
<link rel="icon" type="image/x-icon" href="favicon.ico">
|
<link rel="icon" type="image/x-icon" href="favicon.ico">
|
||||||
<link rel="manifest" href="{% static webmanifest %}">
|
<link rel="manifest" href="{% static webmanifest %}" crossorigin="use-credentials">
|
||||||
<link rel="stylesheet" href="{% static styles_css %}">
|
<link rel="stylesheet" href="{% static styles_css %}">
|
||||||
<link rel="apple-touch-icon" href="{% static apple_touch_icon %}">
|
<link rel="apple-touch-icon" href="{% static apple_touch_icon %}">
|
||||||
</head>
|
</head>
|
||||||
|
|||||||
+18
-143
@@ -1,88 +1,41 @@
|
|||||||
import shutil
|
import shutil
|
||||||
import zoneinfo
|
|
||||||
from collections.abc import Generator
|
|
||||||
from dataclasses import dataclass
|
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from typing import TYPE_CHECKING
|
from typing import TYPE_CHECKING
|
||||||
|
|
||||||
import filelock
|
import filelock
|
||||||
import pytest
|
import pytest
|
||||||
from django.contrib.auth import get_user_model
|
|
||||||
from django.contrib.contenttypes.models import ContentType
|
|
||||||
from guardian.shortcuts import clear_ct_cache
|
|
||||||
from pytest_django.fixtures import Settings
|
|
||||||
from rest_framework.test import APIClient
|
|
||||||
|
|
||||||
from documents.tests.factories import DocumentFactory
|
from paperless_testing.factories import DocumentFactory
|
||||||
|
|
||||||
UserModelT = get_user_model()
|
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from documents.models import Document
|
from documents.models import Document
|
||||||
|
from paperless_testing.dirs import PaperlessDirs
|
||||||
|
|
||||||
@dataclass(frozen=True, slots=True)
|
|
||||||
class PaperlessDirs:
|
|
||||||
"""Standard Paperless-ngx directory layout for tests."""
|
|
||||||
|
|
||||||
media: Path
|
|
||||||
originals: Path
|
|
||||||
archive: Path
|
|
||||||
thumbnails: Path
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(scope="session")
|
@pytest.fixture(scope="session")
|
||||||
def samples_dir() -> Path:
|
def document_samples_dir() -> Path:
|
||||||
"""Path to the shared test sample documents."""
|
"""Path to the shared test sample documents."""
|
||||||
return Path(__file__).parent / "samples" / "documents"
|
return Path(__file__).parent / "samples" / "documents"
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture()
|
|
||||||
def paperless_dirs(tmp_path: Path) -> PaperlessDirs:
|
|
||||||
"""Create and return the directory structure for testing."""
|
|
||||||
media = tmp_path / "media"
|
|
||||||
dirs = PaperlessDirs(
|
|
||||||
media=media,
|
|
||||||
originals=media / "documents" / "originals",
|
|
||||||
archive=media / "documents" / "archive",
|
|
||||||
thumbnails=media / "documents" / "thumbnails",
|
|
||||||
)
|
|
||||||
for d in (dirs.originals, dirs.archive, dirs.thumbnails):
|
|
||||||
d.mkdir(parents=True)
|
|
||||||
return dirs
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture()
|
|
||||||
def _media_settings(paperless_dirs: PaperlessDirs, settings) -> None:
|
|
||||||
"""Configure Django settings to point at temp directories."""
|
|
||||||
settings.MEDIA_ROOT = paperless_dirs.media
|
|
||||||
settings.ORIGINALS_DIR = paperless_dirs.originals
|
|
||||||
settings.ARCHIVE_DIR = paperless_dirs.archive
|
|
||||||
settings.THUMBNAIL_DIR = paperless_dirs.thumbnails
|
|
||||||
settings.MEDIA_LOCK = paperless_dirs.media / "media.lock"
|
|
||||||
settings.IGNORABLE_FILES = {".DS_Store", "Thumbs.db", "desktop.ini"}
|
|
||||||
settings.APP_LOGO = ""
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture()
|
@pytest.fixture()
|
||||||
def sample_doc(
|
def sample_doc(
|
||||||
paperless_dirs: PaperlessDirs,
|
paperless_dirs: "PaperlessDirs",
|
||||||
_media_settings: None,
|
document_samples_dir: Path,
|
||||||
samples_dir: Path,
|
|
||||||
) -> "Document":
|
) -> "Document":
|
||||||
"""Create a document with valid files and matching checksums."""
|
"""Create a document with valid files and matching checksums."""
|
||||||
with filelock.FileLock(paperless_dirs.media / "media.lock"):
|
with filelock.FileLock(paperless_dirs.media_lock):
|
||||||
shutil.copy(
|
shutil.copy(
|
||||||
samples_dir / "originals" / "0000001.pdf",
|
document_samples_dir / "originals" / "0000001.pdf",
|
||||||
paperless_dirs.originals / "0000001.pdf",
|
paperless_dirs.originals_dir / "0000001.pdf",
|
||||||
)
|
)
|
||||||
shutil.copy(
|
shutil.copy(
|
||||||
samples_dir / "archive" / "0000001.pdf",
|
document_samples_dir / "archive" / "0000001.pdf",
|
||||||
paperless_dirs.archive / "0000001.pdf",
|
paperless_dirs.archive_dir / "0000001.pdf",
|
||||||
)
|
)
|
||||||
shutil.copy(
|
shutil.copy(
|
||||||
samples_dir / "thumbnails" / "0000001.webp",
|
document_samples_dir / "thumbnails" / "0000001.webp",
|
||||||
paperless_dirs.thumbnails / "0000001.webp",
|
paperless_dirs.thumbnail_dir / "0000001.webp",
|
||||||
)
|
)
|
||||||
|
|
||||||
return DocumentFactory(
|
return DocumentFactory(
|
||||||
@@ -97,95 +50,17 @@ def sample_doc(
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture()
|
@pytest.fixture
|
||||||
def _search_index(
|
def _search_index(paperless_dirs: "PaperlessDirs") -> None:
|
||||||
tmp_path: Path,
|
"""Point the search backend at a fresh, empty index directory.
|
||||||
settings: Settings,
|
|
||||||
) -> Generator[None, None, None]:
|
|
||||||
"""Create a temp index directory and point INDEX_DIR at it.
|
|
||||||
|
|
||||||
Resets the backend singleton before and after so each test gets a clean
|
paperless_dirs owns INDEX_DIR and resets the backend singleton on both
|
||||||
index rather than reusing a stale singleton from another test.
|
sides of the test, so requesting it is all that is needed.
|
||||||
"""
|
"""
|
||||||
from documents.search import reset_backend
|
|
||||||
|
|
||||||
index_dir = tmp_path / "index"
|
|
||||||
index_dir.mkdir()
|
|
||||||
settings.INDEX_DIR = index_dir
|
|
||||||
reset_backend()
|
|
||||||
yield
|
|
||||||
reset_backend()
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture()
|
|
||||||
def settings_timezone(settings: Settings) -> zoneinfo.ZoneInfo:
|
|
||||||
return zoneinfo.ZoneInfo(settings.TIME_ZONE)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def rest_api_client():
|
def searchable_document(_search_index: None) -> "Document":
|
||||||
"""
|
|
||||||
The basic DRF ApiClient
|
|
||||||
"""
|
|
||||||
yield APIClient()
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture()
|
|
||||||
def regular_user(django_user_model: type[UserModelT]) -> UserModelT:
|
|
||||||
"""Unprivileged authenticated user for permission boundary tests."""
|
|
||||||
return django_user_model.objects.create_user(username="regular", password="regular")
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture()
|
|
||||||
def admin_client(rest_api_client: APIClient, admin_user: UserModelT) -> APIClient:
|
|
||||||
"""Admin client pre-authenticated and sending the v10 Accept header."""
|
|
||||||
rest_api_client.force_authenticate(user=admin_user)
|
|
||||||
rest_api_client.credentials(HTTP_ACCEPT="application/json; version=10")
|
|
||||||
return rest_api_client
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture()
|
|
||||||
def v9_client(rest_api_client: APIClient, admin_user: UserModelT) -> APIClient:
|
|
||||||
"""Admin client pre-authenticated and sending the v9 Accept header."""
|
|
||||||
rest_api_client.force_authenticate(user=admin_user)
|
|
||||||
rest_api_client.credentials(HTTP_ACCEPT="application/json; version=9")
|
|
||||||
return rest_api_client
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture()
|
|
||||||
def user_client(rest_api_client: APIClient, regular_user: UserModelT) -> APIClient:
|
|
||||||
"""Regular-user client pre-authenticated and sending the v10 Accept header."""
|
|
||||||
rest_api_client.force_authenticate(user=regular_user)
|
|
||||||
rest_api_client.credentials(HTTP_ACCEPT="application/json; version=10")
|
|
||||||
return rest_api_client
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(autouse=True)
|
|
||||||
def _clear_content_type_caches() -> None:
|
|
||||||
"""Clear Django's ContentType cache and guardian's lru_cache before each test.
|
|
||||||
|
|
||||||
Tests that delete and reinsert ContentType/Permission rows (e.g. the
|
|
||||||
importer) corrupt both caches. Without this fixture a subsequent test on
|
|
||||||
the same xdist worker sees stale ContentType objects and guardian raises
|
|
||||||
MixedContentTypeError.
|
|
||||||
"""
|
|
||||||
ContentType.objects.clear_cache()
|
|
||||||
clear_ct_cache()
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(scope="session", autouse=True)
|
|
||||||
def faker_session_locale():
|
|
||||||
"""Set Faker locale for reproducibility."""
|
|
||||||
return "en_US"
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(scope="session", autouse=True)
|
|
||||||
def faker_seed():
|
|
||||||
return 12345
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def indexed_document(_search_index: None) -> "Document":
|
|
||||||
"""One searchable document, for tests about what the search endpoint
|
"""One searchable document, for tests about what the search endpoint
|
||||||
returns rather than about what it finds.
|
returns rather than about what it finds.
|
||||||
"""
|
"""
|
||||||
|
|||||||
@@ -0,0 +1,10 @@
|
|||||||
|
import re
|
||||||
|
|
||||||
|
|
||||||
|
def dummy_preprocess(content: str) -> str:
|
||||||
|
"""
|
||||||
|
Simpler, faster pre-processing for testing purposes
|
||||||
|
"""
|
||||||
|
content = content.lower().strip()
|
||||||
|
content = re.sub(r"\s+", " ", content)
|
||||||
|
return content
|
||||||
@@ -15,11 +15,11 @@ from rich.console import Console
|
|||||||
|
|
||||||
from documents.management.commands.document_sanity_checker import Command
|
from documents.management.commands.document_sanity_checker import Command
|
||||||
from documents.sanity_checker import SanityCheckMessages
|
from documents.sanity_checker import SanityCheckMessages
|
||||||
from documents.tests.factories import DocumentFactory
|
from paperless_testing.factories import DocumentFactory
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from documents.models import Document
|
from documents.models import Document
|
||||||
from documents.tests.conftest import PaperlessDirs
|
from paperless_testing.dirs import PaperlessDirs
|
||||||
|
|
||||||
|
|
||||||
def _render_to_string(messages: SanityCheckMessages) -> str:
|
def _render_to_string(messages: SanityCheckMessages) -> str:
|
||||||
@@ -71,7 +71,7 @@ class TestRenderResultsWithIssues:
|
|||||||
assert "INFO" in output
|
assert "INFO" in output
|
||||||
assert "No OCR data" in output
|
assert "No OCR data" in output
|
||||||
|
|
||||||
@pytest.mark.usefixtures("_media_settings")
|
@pytest.mark.usefixtures("paperless_dirs")
|
||||||
def test_global_message(self) -> None:
|
def test_global_message(self) -> None:
|
||||||
msgs = SanityCheckMessages()
|
msgs = SanityCheckMessages()
|
||||||
msgs.warning(None, "Orphaned file: /tmp/stray.pdf")
|
msgs.warning(None, "Orphaned file: /tmp/stray.pdf")
|
||||||
@@ -87,7 +87,7 @@ class TestRenderResultsWithIssues:
|
|||||||
assert "Thumbnail missing" in output
|
assert "Thumbnail missing" in output
|
||||||
assert "Checksum mismatch" in output
|
assert "Checksum mismatch" in output
|
||||||
|
|
||||||
@pytest.mark.usefixtures("_media_settings")
|
@pytest.mark.usefixtures("paperless_dirs")
|
||||||
def test_unknown_doc_pk(self) -> None:
|
def test_unknown_doc_pk(self) -> None:
|
||||||
msgs = SanityCheckMessages()
|
msgs = SanityCheckMessages()
|
||||||
msgs.error(99999, "Ghost document")
|
msgs.error(99999, "Ghost document")
|
||||||
@@ -184,7 +184,6 @@ class TestDocumentSanityCheckerCommand:
|
|||||||
assert "ERROR" in output
|
assert "ERROR" in output
|
||||||
assert "Original of document does not exist" in output
|
assert "Original of document does not exist" in output
|
||||||
|
|
||||||
@pytest.mark.usefixtures("_media_settings")
|
|
||||||
def test_checksum_mismatch(self, paperless_dirs: PaperlessDirs) -> None:
|
def test_checksum_mismatch(self, paperless_dirs: PaperlessDirs) -> None:
|
||||||
"""Lightweight document with zero-byte files triggers checksum mismatch."""
|
"""Lightweight document with zero-byte files triggers checksum mismatch."""
|
||||||
doc = DocumentFactory(
|
doc = DocumentFactory(
|
||||||
|
|||||||
@@ -9,29 +9,21 @@ from documents.search._backend import TantivyBackend
|
|||||||
from documents.search._backend import reset_backend
|
from documents.search._backend import reset_backend
|
||||||
from documents.search._schema import build_schema
|
from documents.search._schema import build_schema
|
||||||
from documents.search._tokenizer import register_tokenizers
|
from documents.search._tokenizer import register_tokenizers
|
||||||
from documents.tests.factories import DocumentFactory
|
from paperless_testing.factories import DocumentFactory
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from collections.abc import Callable
|
from collections.abc import Callable
|
||||||
from collections.abc import Generator
|
from collections.abc import Generator
|
||||||
from pathlib import Path
|
|
||||||
|
|
||||||
from pytest_django.fixtures import Settings
|
from pytest_django.fixtures import Settings
|
||||||
|
|
||||||
from documents.models import Document
|
from documents.models import Document
|
||||||
|
from paperless_testing.dirs import PaperlessDirs
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def index_dir(tmp_path: Path, settings: Settings) -> Path:
|
def backend(paperless_dirs: PaperlessDirs) -> Generator[TantivyBackend, None, None]:
|
||||||
path = tmp_path / "index"
|
b = TantivyBackend(path=paperless_dirs.index_dir)
|
||||||
path.mkdir()
|
|
||||||
settings.INDEX_DIR = path
|
|
||||||
return path
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def backend() -> Generator[TantivyBackend, None, None]:
|
|
||||||
b = TantivyBackend() # path=None → in-memory index
|
|
||||||
b.open()
|
b.open()
|
||||||
try:
|
try:
|
||||||
yield b
|
yield b
|
||||||
|
|||||||
@@ -14,7 +14,6 @@ from typing import TYPE_CHECKING
|
|||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
import time_machine
|
import time_machine
|
||||||
from django.contrib.auth.models import User
|
|
||||||
|
|
||||||
from documents.models import CustomField
|
from documents.models import CustomField
|
||||||
from documents.models import CustomFieldInstance
|
from documents.models import CustomFieldInstance
|
||||||
@@ -22,7 +21,8 @@ from documents.models import DocumentType
|
|||||||
from documents.models import Note
|
from documents.models import Note
|
||||||
from documents.models import StoragePath
|
from documents.models import StoragePath
|
||||||
from documents.search._query import parse_user_query
|
from documents.search._query import parse_user_query
|
||||||
from documents.tests.factories import DocumentFactory
|
from paperless_testing.factories import DocumentFactory
|
||||||
|
from paperless_testing.factories import UserFactory
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from collections.abc import Callable
|
from collections.abc import Callable
|
||||||
@@ -148,7 +148,7 @@ class TestJsonSubpaths:
|
|||||||
THEN:
|
THEN:
|
||||||
- Only the document with alice's note matches
|
- Only the document with alice's note matches
|
||||||
"""
|
"""
|
||||||
alice = User.objects.create_user(username="alice")
|
alice = UserFactory(username="alice")
|
||||||
doc_with_note = DocumentFactory(
|
doc_with_note = DocumentFactory(
|
||||||
title="Has note",
|
title="Has note",
|
||||||
content="x",
|
content="x",
|
||||||
|
|||||||
@@ -3,10 +3,8 @@ from pathlib import Path
|
|||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
from django.contrib.auth.models import Group
|
from django.contrib.auth.models import Group
|
||||||
from django.contrib.auth.models import User
|
|
||||||
from django.db import connection
|
from django.db import connection
|
||||||
from django.test.utils import CaptureQueriesContext
|
from django.test.utils import CaptureQueriesContext
|
||||||
from guardian.shortcuts import assign_perm
|
|
||||||
from pytest_mock import MockerFixture
|
from pytest_mock import MockerFixture
|
||||||
|
|
||||||
from documents.models import CustomField
|
from documents.models import CustomField
|
||||||
@@ -19,11 +17,12 @@ from documents.search._backend import WriteBatch
|
|||||||
from documents.search._backend import get_backend
|
from documents.search._backend import get_backend
|
||||||
from documents.search._backend import reset_backend
|
from documents.search._backend import reset_backend
|
||||||
from documents.signals.handlers import add_to_index
|
from documents.signals.handlers import add_to_index
|
||||||
from documents.tests.factories import CorrespondentFactory
|
from paperless_testing.factories import CorrespondentFactory
|
||||||
from documents.tests.factories import DocumentFactory
|
from paperless_testing.factories import DocumentFactory
|
||||||
from documents.tests.factories import DocumentTypeFactory
|
from paperless_testing.factories import DocumentTypeFactory
|
||||||
from documents.tests.factories import TagFactory
|
from paperless_testing.factories import TagFactory
|
||||||
from documents.tests.factories import UserFactory
|
from paperless_testing.factories import UserFactory
|
||||||
|
from paperless_testing.permissions import grant_object
|
||||||
|
|
||||||
pytestmark = [pytest.mark.search, pytest.mark.django_db]
|
pytestmark = [pytest.mark.search, pytest.mark.django_db]
|
||||||
|
|
||||||
@@ -189,7 +188,7 @@ class TestAddOrUpdateIds:
|
|||||||
pk=1,
|
pk=1,
|
||||||
owner=owner,
|
owner=owner,
|
||||||
)
|
)
|
||||||
assign_perm("view_document", user, doc)
|
grant_object(user, doc, "view_document")
|
||||||
|
|
||||||
with backend.batch_update() as batch:
|
with backend.batch_update() as batch:
|
||||||
batch.add_or_update_ids([doc.pk])
|
batch.add_or_update_ids([doc.pk])
|
||||||
@@ -209,7 +208,7 @@ class TestAddOrUpdateIds:
|
|||||||
pk=1,
|
pk=1,
|
||||||
owner=owner,
|
owner=owner,
|
||||||
)
|
)
|
||||||
assign_perm("view_document", group, doc)
|
grant_object(group, doc, "view_document")
|
||||||
|
|
||||||
with backend.batch_update() as batch:
|
with backend.batch_update() as batch:
|
||||||
batch.add_or_update_ids([doc.pk])
|
batch.add_or_update_ids([doc.pk])
|
||||||
@@ -763,8 +762,8 @@ class TestSearchIds:
|
|||||||
|
|
||||||
def test_respects_permission_filter(self, backend: TantivyBackend) -> None:
|
def test_respects_permission_filter(self, backend: TantivyBackend) -> None:
|
||||||
"""search_ids must respect user permission filtering."""
|
"""search_ids must respect user permission filtering."""
|
||||||
owner = User.objects.create_user("ids_owner")
|
owner = UserFactory(username="ids_owner")
|
||||||
other = User.objects.create_user("ids_other")
|
other = UserFactory(username="ids_other")
|
||||||
doc = Document.objects.create(
|
doc = Document.objects.create(
|
||||||
title="private doc",
|
title="private doc",
|
||||||
content="secret keyword",
|
content="secret keyword",
|
||||||
@@ -843,7 +842,7 @@ class TestRebuild:
|
|||||||
content="group secret keyword",
|
content="group secret keyword",
|
||||||
owner=owner,
|
owner=owner,
|
||||||
)
|
)
|
||||||
assign_perm("view_document", group, doc)
|
grant_object(group, doc, "view_document")
|
||||||
|
|
||||||
backend.rebuild(Document.objects.all())
|
backend.rebuild(Document.objects.all())
|
||||||
|
|
||||||
@@ -948,7 +947,8 @@ class TestSingleton:
|
|||||||
yield
|
yield
|
||||||
reset_backend()
|
reset_backend()
|
||||||
|
|
||||||
def test_returns_same_instance_on_repeated_calls(self, index_dir) -> None:
|
@pytest.mark.usefixtures("paperless_dirs")
|
||||||
|
def test_returns_same_instance_on_repeated_calls(self) -> None:
|
||||||
"""Singleton pattern: repeated calls to get_backend() must return the same instance."""
|
"""Singleton pattern: repeated calls to get_backend() must return the same instance."""
|
||||||
assert get_backend() is get_backend()
|
assert get_backend() is get_backend()
|
||||||
|
|
||||||
@@ -965,7 +965,8 @@ class TestSingleton:
|
|||||||
assert b1 is not b2
|
assert b1 is not b2
|
||||||
assert b2._path == tmp_path / "b"
|
assert b2._path == tmp_path / "b"
|
||||||
|
|
||||||
def test_reset_forces_new_instance(self, index_dir) -> None:
|
@pytest.mark.usefixtures("paperless_dirs")
|
||||||
|
def test_reset_forces_new_instance(self) -> None:
|
||||||
"""reset_backend() must force creation of a new backend instance on next get_backend() call."""
|
"""reset_backend() must force creation of a new backend instance on next get_backend() call."""
|
||||||
b1 = get_backend()
|
b1 = get_backend()
|
||||||
reset_backend()
|
reset_backend()
|
||||||
@@ -1071,7 +1072,7 @@ class TestFieldHandling:
|
|||||||
|
|
||||||
def test_notes_include_user_information(self, backend: TantivyBackend) -> None:
|
def test_notes_include_user_information(self, backend: TantivyBackend) -> None:
|
||||||
"""Notes must be indexed with user information when available for structured queries."""
|
"""Notes must be indexed with user information when available for structured queries."""
|
||||||
user = User.objects.create_user("notewriter")
|
user = UserFactory(username="notewriter")
|
||||||
doc = Document.objects.create(
|
doc = Document.objects.create(
|
||||||
title="Doc with notes",
|
title="Doc with notes",
|
||||||
content="test",
|
content="test",
|
||||||
@@ -1173,7 +1174,7 @@ class TestHighlightHits:
|
|||||||
notes.note: prefix so the query targets notes content directly, but
|
notes.note: prefix so the query targets notes content directly, but
|
||||||
the snippet is generated from notes_text which stores the same text.
|
the snippet is generated from notes_text which stores the same text.
|
||||||
"""
|
"""
|
||||||
user = User.objects.create_user("hl_noteuser")
|
user = UserFactory(username="hl_noteuser")
|
||||||
doc = Document.objects.create(
|
doc = Document.objects.create(
|
||||||
title="Doc with matching note",
|
title="Doc with matching note",
|
||||||
content="unrelated content",
|
content="unrelated content",
|
||||||
|
|||||||
@@ -27,7 +27,7 @@ import time_machine
|
|||||||
from documents.models import Note
|
from documents.models import Note
|
||||||
from documents.models import Tag
|
from documents.models import Tag
|
||||||
from documents.search._errors import InvalidDateQuery
|
from documents.search._errors import InvalidDateQuery
|
||||||
from documents.tests.factories import DocumentFactory
|
from paperless_testing.factories import DocumentFactory
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from collections.abc import Callable
|
from collections.abc import Callable
|
||||||
@@ -269,7 +269,7 @@ class TestDocumentedDateForms:
|
|||||||
yield
|
yield
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def dated(self, index_document: Callable[..., Document]) -> dict[str, int]:
|
def dated(self, backend: TantivyBackend) -> dict[str, int]:
|
||||||
stamps = {
|
stamps = {
|
||||||
"today": datetime(2026, 6, 15, 9, 0, tzinfo=UTC),
|
"today": datetime(2026, 6, 15, 9, 0, tzinfo=UTC),
|
||||||
"yesterday": datetime(2026, 6, 14, 9, 0, tzinfo=UTC),
|
"yesterday": datetime(2026, 6, 14, 9, 0, tzinfo=UTC),
|
||||||
@@ -279,14 +279,14 @@ class TestDocumentedDateForms:
|
|||||||
"january": datetime(2026, 1, 10, 10, 0, tzinfo=UTC),
|
"january": datetime(2026, 1, 10, 10, 0, tzinfo=UTC),
|
||||||
"old": datetime(2005, 3, 4, 15, 30, tzinfo=UTC),
|
"old": datetime(2005, 3, 4, 15, 30, tzinfo=UTC),
|
||||||
}
|
}
|
||||||
return {
|
docs = {
|
||||||
label: index_document(
|
label: DocumentFactory(title=label, content="dated body", added=stamp)
|
||||||
title=label,
|
|
||||||
content="dated body",
|
|
||||||
added=stamp,
|
|
||||||
).pk
|
|
||||||
for label, stamp in stamps.items()
|
for label, stamp in stamps.items()
|
||||||
}
|
}
|
||||||
|
with backend.batch_update() as batch:
|
||||||
|
for doc in docs.values():
|
||||||
|
batch.add_or_update(doc)
|
||||||
|
return {label: doc.pk for label, doc in docs.items()}
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
@pytest.mark.parametrize(
|
||||||
("query", "label"),
|
("query", "label"),
|
||||||
|
|||||||
@@ -29,7 +29,7 @@ from rest_framework import status
|
|||||||
|
|
||||||
from documents.search._backend import SearchMode
|
from documents.search._backend import SearchMode
|
||||||
from documents.search._query import parse_simple_text_highlight_query
|
from documents.search._query import parse_simple_text_highlight_query
|
||||||
from documents.tests.factories import DocumentFactory
|
from paperless_testing.factories import DocumentFactory
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from rest_framework.test import APIClient
|
from rest_framework.test import APIClient
|
||||||
|
|||||||
@@ -17,12 +17,12 @@ from __future__ import annotations
|
|||||||
from typing import TYPE_CHECKING
|
from typing import TYPE_CHECKING
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
from django.contrib.auth.models import User
|
|
||||||
|
|
||||||
from documents.models import CustomField
|
from documents.models import CustomField
|
||||||
from documents.models import CustomFieldInstance
|
from documents.models import CustomFieldInstance
|
||||||
from documents.models import Note
|
from documents.models import Note
|
||||||
from documents.tests.factories import DocumentFactory
|
from paperless_testing.factories import DocumentFactory
|
||||||
|
from paperless_testing.factories import UserFactory
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from collections.abc import Callable
|
from collections.abc import Callable
|
||||||
@@ -53,7 +53,7 @@ class TestBareJsonFieldPrefixes:
|
|||||||
decoy's content match does not resurface through a demoted
|
decoy's content match does not resurface through a demoted
|
||||||
text search
|
text search
|
||||||
"""
|
"""
|
||||||
alice = User.objects.create_user(username="alice")
|
alice = UserFactory(username="alice")
|
||||||
with_note = DocumentFactory(title="Has note", content="x")
|
with_note = DocumentFactory(title="Has note", content="x")
|
||||||
Note.objects.create(document=with_note, user=alice, note="crocodile")
|
Note.objects.create(document=with_note, user=alice, note="crocodile")
|
||||||
backend.add_or_update(with_note)
|
backend.add_or_update(with_note)
|
||||||
@@ -116,7 +116,7 @@ class TestBareJsonFieldPrefixes:
|
|||||||
document; the default-subpath resolution for the bare
|
document; the default-subpath resolution for the bare
|
||||||
prefix does not interfere with explicit subpath addressing
|
prefix does not interfere with explicit subpath addressing
|
||||||
"""
|
"""
|
||||||
bob = User.objects.create_user(username="bob")
|
bob = UserFactory(username="bob")
|
||||||
doc = DocumentFactory(title="Bob note", content="x")
|
doc = DocumentFactory(title="Bob note", content="x")
|
||||||
Note.objects.create(document=doc, user=bob, note="remark")
|
Note.objects.create(document=doc, user=bob, note="remark")
|
||||||
backend.add_or_update(doc)
|
backend.add_or_update(doc)
|
||||||
|
|||||||
@@ -20,7 +20,6 @@ from typing import TYPE_CHECKING
|
|||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
import tantivy
|
import tantivy
|
||||||
from django.contrib.auth.models import User
|
|
||||||
from whoosh_compat import FieldKind
|
from whoosh_compat import FieldKind
|
||||||
|
|
||||||
from documents.models import CustomField
|
from documents.models import CustomField
|
||||||
@@ -28,6 +27,7 @@ from documents.models import CustomFieldInstance
|
|||||||
from documents.models import Document
|
from documents.models import Document
|
||||||
from documents.models import Note
|
from documents.models import Note
|
||||||
from documents.search._fields import PUBLIC_FIELDS
|
from documents.search._fields import PUBLIC_FIELDS
|
||||||
|
from paperless_testing.factories import UserFactory
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from documents.search._backend import TantivyBackend
|
from documents.search._backend import TantivyBackend
|
||||||
@@ -49,7 +49,7 @@ class TestJsonSubpathsAreWrittenAtIndexTime:
|
|||||||
- Every subpath PUBLIC_FIELDS declares for notes/custom_fields
|
- Every subpath PUBLIC_FIELDS declares for notes/custom_fields
|
||||||
is present as a key in the document's stored JSON payload
|
is present as a key in the document's stored JSON payload
|
||||||
"""
|
"""
|
||||||
user = User.objects.create_user(username="completeness-user")
|
user = UserFactory(username="completeness-user")
|
||||||
field = CustomField.objects.create(
|
field = CustomField.objects.create(
|
||||||
name="Completeness Field",
|
name="Completeness Field",
|
||||||
data_type=CustomField.FieldDataType.STRING,
|
data_type=CustomField.FieldDataType.STRING,
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ from documents.search._backend import SearchIndexLockError
|
|||||||
from documents.search._backend import TantivyBackend
|
from documents.search._backend import TantivyBackend
|
||||||
from documents.tasks import index_document
|
from documents.tasks import index_document
|
||||||
from documents.tasks import remove_document_from_index
|
from documents.tasks import remove_document_from_index
|
||||||
from documents.tests.factories import DocumentFactory
|
from paperless_testing.factories import DocumentFactory
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from collections.abc import Generator
|
from collections.abc import Generator
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
from documents.tests.utils import TestMigrations
|
from paperless_testing.migrations import TestMigrations
|
||||||
|
|
||||||
pytestmark = pytest.mark.search
|
pytestmark = pytest.mark.search
|
||||||
|
|
||||||
|
|||||||
@@ -18,13 +18,14 @@ from typing import TYPE_CHECKING
|
|||||||
import pytest
|
import pytest
|
||||||
from django.contrib.auth.models import Group
|
from django.contrib.auth.models import Group
|
||||||
from django.contrib.auth.models import User
|
from django.contrib.auth.models import User
|
||||||
from guardian.shortcuts import assign_perm
|
|
||||||
|
|
||||||
from documents.models import Correspondent
|
from documents.models import Correspondent
|
||||||
from documents.models import Document
|
from documents.models import Document
|
||||||
from documents.models import DocumentType
|
from documents.models import DocumentType
|
||||||
from documents.models import StoragePath
|
from documents.models import StoragePath
|
||||||
from documents.models import Tag
|
from documents.models import Tag
|
||||||
|
from paperless_testing.factories import UserFactory
|
||||||
|
from paperless_testing.permissions import grant_object
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from documents.search._backend import TantivyBackend
|
from documents.search._backend import TantivyBackend
|
||||||
@@ -34,22 +35,22 @@ pytestmark = [pytest.mark.search, pytest.mark.django_db]
|
|||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def owner() -> User:
|
def owner() -> User:
|
||||||
return User.objects.create_user(username="owner")
|
return UserFactory(username="owner")
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def stranger() -> User:
|
def stranger() -> User:
|
||||||
return User.objects.create_user(username="stranger")
|
return UserFactory(username="stranger")
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def viewer() -> User:
|
def viewer() -> User:
|
||||||
return User.objects.create_user(username="viewer")
|
return UserFactory(username="viewer")
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def group_member() -> User:
|
def group_member() -> User:
|
||||||
user = User.objects.create_user(username="group_member")
|
user = UserFactory(username="group_member")
|
||||||
user.groups.add(Group.objects.create(name="accounting"))
|
user.groups.add(Group.objects.create(name="accounting"))
|
||||||
return user
|
return user
|
||||||
|
|
||||||
@@ -127,7 +128,7 @@ class TestPermissionFilteringOnIndexedDocuments:
|
|||||||
checksum="perm-shared-user",
|
checksum="perm-shared-user",
|
||||||
owner=owner,
|
owner=owner,
|
||||||
)
|
)
|
||||||
assign_perm("view_document", viewer, doc)
|
grant_object(viewer, doc, "view_document")
|
||||||
backend.add_or_update(doc)
|
backend.add_or_update(doc)
|
||||||
|
|
||||||
assert backend.search_ids("invoice", user=viewer) == [doc.pk]
|
assert backend.search_ids("invoice", user=viewer) == [doc.pk]
|
||||||
@@ -157,7 +158,7 @@ class TestPermissionFilteringOnIndexedDocuments:
|
|||||||
checksum="perm-shared-group",
|
checksum="perm-shared-group",
|
||||||
owner=owner,
|
owner=owner,
|
||||||
)
|
)
|
||||||
assign_perm("view_document", group_member.groups.first(), doc)
|
grant_object(group_member.groups.first(), doc, "view_document")
|
||||||
backend.add_or_update(doc)
|
backend.add_or_update(doc)
|
||||||
|
|
||||||
assert backend.search_ids("invoice", user=group_member) == [doc.pk]
|
assert backend.search_ids("invoice", user=group_member) == [doc.pk]
|
||||||
|
|||||||
@@ -13,11 +13,11 @@ from documents.search._schema import needs_rebuild
|
|||||||
from documents.search._schema import schema_fingerprint
|
from documents.search._schema import schema_fingerprint
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from pathlib import Path
|
|
||||||
|
|
||||||
import tantivy
|
import tantivy
|
||||||
from pytest_django.fixtures import Settings
|
from pytest_django.fixtures import Settings
|
||||||
|
|
||||||
|
from paperless_testing.dirs import PaperlessDirs
|
||||||
|
|
||||||
|
|
||||||
pytestmark = pytest.mark.search
|
pytestmark = pytest.mark.search
|
||||||
|
|
||||||
@@ -25,16 +25,19 @@ pytestmark = pytest.mark.search
|
|||||||
class TestNeedsRebuild:
|
class TestNeedsRebuild:
|
||||||
"""needs_rebuild covers all sentinel-file states that require a full reindex."""
|
"""needs_rebuild covers all sentinel-file states that require a full reindex."""
|
||||||
|
|
||||||
def test_returns_true_when_settings_file_missing(self, index_dir: Path) -> None:
|
def test_returns_true_when_settings_file_missing(
|
||||||
assert needs_rebuild(index_dir) is True
|
self,
|
||||||
|
paperless_dirs: PaperlessDirs,
|
||||||
|
) -> None:
|
||||||
|
assert needs_rebuild(paperless_dirs.index_dir) is True
|
||||||
|
|
||||||
def test_returns_false_when_version_and_language_match(
|
def test_returns_false_when_version_and_language_match(
|
||||||
self,
|
self,
|
||||||
index_dir: Path,
|
paperless_dirs: PaperlessDirs,
|
||||||
settings: Settings,
|
settings: Settings,
|
||||||
) -> None:
|
) -> None:
|
||||||
settings.SEARCH_LANGUAGE = "en"
|
settings.SEARCH_LANGUAGE = "en"
|
||||||
(index_dir / ".index_settings.json").write_text(
|
(paperless_dirs.index_dir / ".index_settings.json").write_text(
|
||||||
json.dumps(
|
json.dumps(
|
||||||
{
|
{
|
||||||
"schema_version": SCHEMA_VERSION,
|
"schema_version": SCHEMA_VERSION,
|
||||||
@@ -43,51 +46,51 @@ class TestNeedsRebuild:
|
|||||||
},
|
},
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
assert needs_rebuild(index_dir) is False
|
assert needs_rebuild(paperless_dirs.index_dir) is False
|
||||||
|
|
||||||
def test_returns_true_on_schema_version_mismatch(
|
def test_returns_true_on_schema_version_mismatch(
|
||||||
self,
|
self,
|
||||||
index_dir: Path,
|
paperless_dirs: PaperlessDirs,
|
||||||
settings: Settings,
|
settings: Settings,
|
||||||
) -> None:
|
) -> None:
|
||||||
settings.SEARCH_LANGUAGE = None
|
settings.SEARCH_LANGUAGE = None
|
||||||
(index_dir / ".index_settings.json").write_text(
|
(paperless_dirs.index_dir / ".index_settings.json").write_text(
|
||||||
json.dumps({"schema_version": SCHEMA_VERSION - 1, "language": None}),
|
json.dumps({"schema_version": SCHEMA_VERSION - 1, "language": None}),
|
||||||
)
|
)
|
||||||
assert needs_rebuild(index_dir) is True
|
assert needs_rebuild(paperless_dirs.index_dir) is True
|
||||||
|
|
||||||
def test_returns_true_when_version_is_not_an_integer(
|
def test_returns_true_when_version_is_not_an_integer(
|
||||||
self,
|
self,
|
||||||
index_dir: Path,
|
paperless_dirs: PaperlessDirs,
|
||||||
settings: Settings,
|
settings: Settings,
|
||||||
) -> None:
|
) -> None:
|
||||||
settings.SEARCH_LANGUAGE = None
|
settings.SEARCH_LANGUAGE = None
|
||||||
(index_dir / ".index_settings.json").write_text(
|
(paperless_dirs.index_dir / ".index_settings.json").write_text(
|
||||||
json.dumps({"schema_version": "not-a-number", "language": None}),
|
json.dumps({"schema_version": "not-a-number", "language": None}),
|
||||||
)
|
)
|
||||||
assert needs_rebuild(index_dir) is True
|
assert needs_rebuild(paperless_dirs.index_dir) is True
|
||||||
|
|
||||||
def test_returns_true_when_language_key_missing(
|
def test_returns_true_when_language_key_missing(
|
||||||
self,
|
self,
|
||||||
index_dir: Path,
|
paperless_dirs: PaperlessDirs,
|
||||||
settings: Settings,
|
settings: Settings,
|
||||||
) -> None:
|
) -> None:
|
||||||
settings.SEARCH_LANGUAGE = "en"
|
settings.SEARCH_LANGUAGE = "en"
|
||||||
(index_dir / ".index_settings.json").write_text(
|
(paperless_dirs.index_dir / ".index_settings.json").write_text(
|
||||||
json.dumps({"schema_version": SCHEMA_VERSION}),
|
json.dumps({"schema_version": SCHEMA_VERSION}),
|
||||||
)
|
)
|
||||||
assert needs_rebuild(index_dir) is True
|
assert needs_rebuild(paperless_dirs.index_dir) is True
|
||||||
|
|
||||||
def test_returns_true_when_language_differs(
|
def test_returns_true_when_language_differs(
|
||||||
self,
|
self,
|
||||||
index_dir: Path,
|
paperless_dirs: PaperlessDirs,
|
||||||
settings: Settings,
|
settings: Settings,
|
||||||
) -> None:
|
) -> None:
|
||||||
settings.SEARCH_LANGUAGE = "de"
|
settings.SEARCH_LANGUAGE = "de"
|
||||||
(index_dir / ".index_settings.json").write_text(
|
(paperless_dirs.index_dir / ".index_settings.json").write_text(
|
||||||
json.dumps({"schema_version": SCHEMA_VERSION, "language": "en"}),
|
json.dumps({"schema_version": SCHEMA_VERSION, "language": "en"}),
|
||||||
)
|
)
|
||||||
assert needs_rebuild(index_dir) is True
|
assert needs_rebuild(paperless_dirs.index_dir) is True
|
||||||
|
|
||||||
|
|
||||||
def _schema_fields(schema: tantivy.Schema) -> dict[str, dict]:
|
def _schema_fields(schema: tantivy.Schema) -> dict[str, dict]:
|
||||||
|
|||||||
@@ -35,6 +35,8 @@ if TYPE_CHECKING:
|
|||||||
|
|
||||||
from pytest_django.fixtures import SettingsWrapper
|
from pytest_django.fixtures import SettingsWrapper
|
||||||
|
|
||||||
|
from paperless_testing.dirs import PaperlessDirs
|
||||||
|
|
||||||
pytestmark = pytest.mark.search
|
pytestmark = pytest.mark.search
|
||||||
|
|
||||||
# The on-disk field layout of a v2 index, pinned as data. Any edit here is an
|
# The on-disk field layout of a v2 index, pinned as data. Any edit here is an
|
||||||
@@ -469,7 +471,7 @@ def _fingerprint_of(descriptors: list[FieldDescriptor]) -> str:
|
|||||||
class TestNeedsRebuildOnFingerprint:
|
class TestNeedsRebuildOnFingerprint:
|
||||||
def test_matching_fingerprint_does_not_rebuild(
|
def test_matching_fingerprint_does_not_rebuild(
|
||||||
self,
|
self,
|
||||||
index_dir: Path,
|
paperless_dirs: PaperlessDirs,
|
||||||
settings: SettingsWrapper,
|
settings: SettingsWrapper,
|
||||||
) -> None:
|
) -> None:
|
||||||
"""
|
"""
|
||||||
@@ -482,13 +484,13 @@ class TestNeedsRebuildOnFingerprint:
|
|||||||
- It returns False
|
- It returns False
|
||||||
"""
|
"""
|
||||||
settings.SEARCH_LANGUAGE = None
|
settings.SEARCH_LANGUAGE = None
|
||||||
_sentinels(index_dir)
|
_sentinels(paperless_dirs.index_dir)
|
||||||
|
|
||||||
assert needs_rebuild(index_dir) is False
|
assert needs_rebuild(paperless_dirs.index_dir) is False
|
||||||
|
|
||||||
def test_stale_fingerprint_rebuilds_despite_a_matching_version(
|
def test_stale_fingerprint_rebuilds_despite_a_matching_version(
|
||||||
self,
|
self,
|
||||||
index_dir: Path,
|
paperless_dirs: PaperlessDirs,
|
||||||
settings: SettingsWrapper,
|
settings: SettingsWrapper,
|
||||||
monkeypatch: pytest.MonkeyPatch,
|
monkeypatch: pytest.MonkeyPatch,
|
||||||
) -> None:
|
) -> None:
|
||||||
@@ -505,7 +507,7 @@ class TestNeedsRebuildOnFingerprint:
|
|||||||
every subsequent write would raise
|
every subsequent write would raise
|
||||||
"""
|
"""
|
||||||
settings.SEARCH_LANGUAGE = None
|
settings.SEARCH_LANGUAGE = None
|
||||||
_sentinels(index_dir)
|
_sentinels(paperless_dirs.index_dir)
|
||||||
extended = [
|
extended = [
|
||||||
*field_descriptors(),
|
*field_descriptors(),
|
||||||
FieldDescriptor(
|
FieldDescriptor(
|
||||||
@@ -519,11 +521,11 @@ class TestNeedsRebuildOnFingerprint:
|
|||||||
]
|
]
|
||||||
monkeypatch.setattr(_schema, "field_descriptors", lambda: extended)
|
monkeypatch.setattr(_schema, "field_descriptors", lambda: extended)
|
||||||
|
|
||||||
assert needs_rebuild(index_dir) is True
|
assert needs_rebuild(paperless_dirs.index_dir) is True
|
||||||
|
|
||||||
def test_reordered_schema_rebuilds(
|
def test_reordered_schema_rebuilds(
|
||||||
self,
|
self,
|
||||||
index_dir: Path,
|
paperless_dirs: PaperlessDirs,
|
||||||
settings: SettingsWrapper,
|
settings: SettingsWrapper,
|
||||||
monkeypatch: pytest.MonkeyPatch,
|
monkeypatch: pytest.MonkeyPatch,
|
||||||
) -> None:
|
) -> None:
|
||||||
@@ -538,16 +540,16 @@ class TestNeedsRebuildOnFingerprint:
|
|||||||
- It returns True
|
- It returns True
|
||||||
"""
|
"""
|
||||||
settings.SEARCH_LANGUAGE = None
|
settings.SEARCH_LANGUAGE = None
|
||||||
_sentinels(index_dir)
|
_sentinels(paperless_dirs.index_dir)
|
||||||
reordered = field_descriptors()
|
reordered = field_descriptors()
|
||||||
reordered[1], reordered[2] = reordered[2], reordered[1]
|
reordered[1], reordered[2] = reordered[2], reordered[1]
|
||||||
monkeypatch.setattr(_schema, "field_descriptors", lambda: reordered)
|
monkeypatch.setattr(_schema, "field_descriptors", lambda: reordered)
|
||||||
|
|
||||||
assert needs_rebuild(index_dir) is True
|
assert needs_rebuild(paperless_dirs.index_dir) is True
|
||||||
|
|
||||||
def test_missing_fingerprint_rebuilds(
|
def test_missing_fingerprint_rebuilds(
|
||||||
self,
|
self,
|
||||||
index_dir: Path,
|
paperless_dirs: PaperlessDirs,
|
||||||
settings: SettingsWrapper,
|
settings: SettingsWrapper,
|
||||||
) -> None:
|
) -> None:
|
||||||
"""
|
"""
|
||||||
@@ -561,15 +563,15 @@ class TestNeedsRebuildOnFingerprint:
|
|||||||
is rebuilt rather than trusted
|
is rebuilt rather than trusted
|
||||||
"""
|
"""
|
||||||
settings.SEARCH_LANGUAGE = None
|
settings.SEARCH_LANGUAGE = None
|
||||||
(index_dir / ".index_settings.json").write_text(
|
(paperless_dirs.index_dir / ".index_settings.json").write_text(
|
||||||
json.dumps({"schema_version": SCHEMA_VERSION, "language": None}),
|
json.dumps({"schema_version": SCHEMA_VERSION, "language": None}),
|
||||||
)
|
)
|
||||||
|
|
||||||
assert needs_rebuild(index_dir) is True
|
assert needs_rebuild(paperless_dirs.index_dir) is True
|
||||||
|
|
||||||
def test_written_sentinels_satisfy_the_check(
|
def test_written_sentinels_satisfy_the_check(
|
||||||
self,
|
self,
|
||||||
index_dir: Path,
|
paperless_dirs: PaperlessDirs,
|
||||||
settings: SettingsWrapper,
|
settings: SettingsWrapper,
|
||||||
) -> None:
|
) -> None:
|
||||||
"""
|
"""
|
||||||
@@ -582,6 +584,6 @@ class TestNeedsRebuildOnFingerprint:
|
|||||||
- It returns False
|
- It returns False
|
||||||
"""
|
"""
|
||||||
settings.SEARCH_LANGUAGE = "en"
|
settings.SEARCH_LANGUAGE = "en"
|
||||||
_write_sentinels(index_dir)
|
_write_sentinels(paperless_dirs.index_dir)
|
||||||
|
|
||||||
assert needs_rebuild(index_dir) is False
|
assert needs_rebuild(paperless_dirs.index_dir) is False
|
||||||
|
|||||||
@@ -16,11 +16,11 @@ from documents.models import Document
|
|||||||
from documents.models import Tag
|
from documents.models import Tag
|
||||||
from documents.search import get_backend
|
from documents.search import get_backend
|
||||||
from documents.search import reset_backend
|
from documents.search import reset_backend
|
||||||
from documents.tests.factories import DocumentFactory
|
|
||||||
from documents.tests.factories import TagFactory
|
|
||||||
from documents.tests.factories import UserFactory
|
|
||||||
from documents.tests.utils import DirectoriesMixin
|
|
||||||
from paperless.admin import PaperlessUserAdmin
|
from paperless.admin import PaperlessUserAdmin
|
||||||
|
from paperless_testing.dirs import DirectoriesMixin
|
||||||
|
from paperless_testing.factories import DocumentFactory
|
||||||
|
from paperless_testing.factories import TagFactory
|
||||||
|
from paperless_testing.factories import UserFactory
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
|
|||||||
@@ -3,7 +3,6 @@ from io import BytesIO
|
|||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from unittest.mock import patch
|
from unittest.mock import patch
|
||||||
|
|
||||||
from django.contrib.auth.models import User
|
|
||||||
from django.core.files.uploadedfile import SimpleUploadedFile
|
from django.core.files.uploadedfile import SimpleUploadedFile
|
||||||
from django.test import override_settings
|
from django.test import override_settings
|
||||||
from PIL import Image
|
from PIL import Image
|
||||||
@@ -11,10 +10,11 @@ from PIL.PngImagePlugin import PngInfo
|
|||||||
from rest_framework import status
|
from rest_framework import status
|
||||||
from rest_framework.test import APITestCase
|
from rest_framework.test import APITestCase
|
||||||
|
|
||||||
from documents.tests.utils import DirectoriesMixin
|
|
||||||
from documents.tests.utils import read_streaming_response
|
|
||||||
from paperless.models import ApplicationConfiguration
|
from paperless.models import ApplicationConfiguration
|
||||||
from paperless.models import ColorConvertChoices
|
from paperless.models import ColorConvertChoices
|
||||||
|
from paperless_testing.dirs import DirectoriesMixin
|
||||||
|
from paperless_testing.factories import UserFactory
|
||||||
|
from paperless_testing.http import read_streaming_response
|
||||||
|
|
||||||
|
|
||||||
class TestApiAppConfig(DirectoriesMixin, APITestCase):
|
class TestApiAppConfig(DirectoriesMixin, APITestCase):
|
||||||
@@ -23,7 +23,7 @@ class TestApiAppConfig(DirectoriesMixin, APITestCase):
|
|||||||
def setUp(self) -> None:
|
def setUp(self) -> None:
|
||||||
super().setUp()
|
super().setUp()
|
||||||
|
|
||||||
user = User.objects.create_superuser(username="temp_admin")
|
user = UserFactory(username="temp_admin", superuser=True)
|
||||||
self.client.force_authenticate(user=user)
|
self.client.force_authenticate(user=user)
|
||||||
|
|
||||||
def test_api_get_config(self) -> None:
|
def test_api_get_config(self) -> None:
|
||||||
@@ -81,6 +81,7 @@ class TestApiAppConfig(DirectoriesMixin, APITestCase):
|
|||||||
"ai_enabled": None,
|
"ai_enabled": None,
|
||||||
"llm_embedding_backend": None,
|
"llm_embedding_backend": None,
|
||||||
"llm_embedding_model": None,
|
"llm_embedding_model": None,
|
||||||
|
"llm_embedding_api_key": None,
|
||||||
"llm_embedding_endpoint": None,
|
"llm_embedding_endpoint": None,
|
||||||
"llm_embedding_chunk_size": None,
|
"llm_embedding_chunk_size": None,
|
||||||
"llm_context_size": None,
|
"llm_context_size": None,
|
||||||
@@ -267,7 +268,7 @@ class TestApiAppConfig(DirectoriesMixin, APITestCase):
|
|||||||
THEN:
|
THEN:
|
||||||
- old app_logo file is deleted
|
- old app_logo file is deleted
|
||||||
"""
|
"""
|
||||||
admin = User.objects.create_superuser(username="admin")
|
admin = UserFactory(username="admin", superuser=True)
|
||||||
self.client.force_login(user=admin)
|
self.client.force_login(user=admin)
|
||||||
response = self.client.get("/logo/")
|
response = self.client.get("/logo/")
|
||||||
self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
|
self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
|
||||||
@@ -922,6 +923,49 @@ class TestApiAppConfig(DirectoriesMixin, APITestCase):
|
|||||||
self.assertEqual(response.status_code, status.HTTP_405_METHOD_NOT_ALLOWED)
|
self.assertEqual(response.status_code, status.HTTP_405_METHOD_NOT_ALLOWED)
|
||||||
self.assertEqual(ApplicationConfiguration.objects.count(), 1)
|
self.assertEqual(ApplicationConfiguration.objects.count(), 1)
|
||||||
|
|
||||||
|
def test_update_llm_embedding_api_key(self) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- Existing config with llm_embedding_api_key specified
|
||||||
|
WHEN:
|
||||||
|
- API to update llm_embedding_api_key is called with all *s
|
||||||
|
- API to update llm_embedding_api_key is called with empty string
|
||||||
|
THEN:
|
||||||
|
- llm_embedding_api_key is unchanged
|
||||||
|
- llm_embedding_api_key is set to None
|
||||||
|
"""
|
||||||
|
config = ApplicationConfiguration.objects.first()
|
||||||
|
assert config is not None
|
||||||
|
config.llm_embedding_api_key = "1234567890"
|
||||||
|
config.save()
|
||||||
|
|
||||||
|
# Test with all *
|
||||||
|
response = self.client.patch(
|
||||||
|
f"{self.ENDPOINT}1/",
|
||||||
|
json.dumps(
|
||||||
|
{
|
||||||
|
"llm_embedding_api_key": "*" * 32,
|
||||||
|
},
|
||||||
|
),
|
||||||
|
content_type="application/json",
|
||||||
|
)
|
||||||
|
self.assertEqual(response.status_code, status.HTTP_200_OK)
|
||||||
|
config.refresh_from_db()
|
||||||
|
self.assertEqual(config.llm_embedding_api_key, "1234567890")
|
||||||
|
# Test with empty string
|
||||||
|
response = self.client.patch(
|
||||||
|
f"{self.ENDPOINT}1/",
|
||||||
|
json.dumps(
|
||||||
|
{
|
||||||
|
"llm_embedding_api_key": "",
|
||||||
|
},
|
||||||
|
),
|
||||||
|
content_type="application/json",
|
||||||
|
)
|
||||||
|
self.assertEqual(response.status_code, status.HTTP_200_OK)
|
||||||
|
config.refresh_from_db()
|
||||||
|
self.assertEqual(config.llm_embedding_api_key, None)
|
||||||
|
|
||||||
def test_update_llm_api_key(self) -> None:
|
def test_update_llm_api_key(self) -> None:
|
||||||
"""
|
"""
|
||||||
GIVEN:
|
GIVEN:
|
||||||
|
|||||||
@@ -4,8 +4,6 @@ import json
|
|||||||
import shutil
|
import shutil
|
||||||
import zipfile
|
import zipfile
|
||||||
|
|
||||||
from django.contrib.auth.models import Permission
|
|
||||||
from django.contrib.auth.models import User
|
|
||||||
from django.test import override_settings
|
from django.test import override_settings
|
||||||
from django.utils import timezone
|
from django.utils import timezone
|
||||||
from rest_framework import status
|
from rest_framework import status
|
||||||
@@ -14,9 +12,11 @@ from rest_framework.test import APITestCase
|
|||||||
from documents.models import Correspondent
|
from documents.models import Correspondent
|
||||||
from documents.models import Document
|
from documents.models import Document
|
||||||
from documents.models import DocumentType
|
from documents.models import DocumentType
|
||||||
from documents.tests.utils import DirectoriesMixin
|
|
||||||
from documents.tests.utils import SampleDirMixin
|
from documents.tests.utils import SampleDirMixin
|
||||||
from documents.tests.utils import read_streaming_response
|
from paperless_testing.dirs import DirectoriesMixin
|
||||||
|
from paperless_testing.factories import UserFactory
|
||||||
|
from paperless_testing.http import read_streaming_response
|
||||||
|
from paperless_testing.permissions import grant_global
|
||||||
|
|
||||||
|
|
||||||
class TestBulkDownload(DirectoriesMixin, SampleDirMixin, APITestCase):
|
class TestBulkDownload(DirectoriesMixin, SampleDirMixin, APITestCase):
|
||||||
@@ -25,7 +25,7 @@ class TestBulkDownload(DirectoriesMixin, SampleDirMixin, APITestCase):
|
|||||||
def setUp(self) -> None:
|
def setUp(self) -> None:
|
||||||
super().setUp()
|
super().setUp()
|
||||||
|
|
||||||
self.user = User.objects.create_superuser(username="temp_admin")
|
self.user = UserFactory(username="temp_admin", superuser=True)
|
||||||
self.client.force_authenticate(user=self.user)
|
self.client.force_authenticate(user=self.user)
|
||||||
|
|
||||||
self.doc1 = Document.objects.create(title="unrelated", checksum="A")
|
self.doc1 = Document.objects.create(title="unrelated", checksum="A")
|
||||||
@@ -166,7 +166,15 @@ class TestBulkDownload(DirectoriesMixin, SampleDirMixin, APITestCase):
|
|||||||
),
|
),
|
||||||
content_type="application/json",
|
content_type="application/json",
|
||||||
)
|
)
|
||||||
response.close()
|
|
||||||
|
self.assertEqual(response.status_code, status.HTTP_200_OK)
|
||||||
|
self.assertEqual(response["Content-Type"], "application/zip")
|
||||||
|
|
||||||
|
with zipfile.ZipFile(io.BytesIO(read_streaming_response(response))) as zipf:
|
||||||
|
self.assertEqual(zipf.infolist()[0].compress_type, zipfile.ZIP_LZMA)
|
||||||
|
|
||||||
|
with self.doc2.source_file as f:
|
||||||
|
self.assertEqual(f.read(), zipf.read("2021-01-01 document A.pdf"))
|
||||||
|
|
||||||
@override_settings(FILENAME_FORMAT="{correspondent}/{title}")
|
@override_settings(FILENAME_FORMAT="{correspondent}/{title}")
|
||||||
def test_formatted_download_originals(self) -> None:
|
def test_formatted_download_originals(self) -> None:
|
||||||
@@ -326,10 +334,8 @@ class TestBulkDownload(DirectoriesMixin, SampleDirMixin, APITestCase):
|
|||||||
)
|
)
|
||||||
|
|
||||||
def test_download_insufficient_permissions(self) -> None:
|
def test_download_insufficient_permissions(self) -> None:
|
||||||
user = User.objects.create_user(username="temp_user")
|
user = UserFactory(username="temp_user")
|
||||||
user.user_permissions.add(
|
grant_global(user, "view_document")
|
||||||
Permission.objects.get(codename="view_document"),
|
|
||||||
)
|
|
||||||
self.client.force_authenticate(user=user)
|
self.client.force_authenticate(user=user)
|
||||||
|
|
||||||
self.doc2.owner = self.user
|
self.doc2.owner = self.user
|
||||||
|
|||||||
@@ -2,27 +2,30 @@ import json
|
|||||||
from unittest import mock
|
from unittest import mock
|
||||||
|
|
||||||
from auditlog.models import LogEntry
|
from auditlog.models import LogEntry
|
||||||
from django.contrib.auth.models import Permission
|
|
||||||
from django.contrib.auth.models import User
|
from django.contrib.auth.models import User
|
||||||
from django.test import override_settings
|
from django.test import override_settings
|
||||||
from guardian.shortcuts import assign_perm
|
|
||||||
from rest_framework import status
|
from rest_framework import status
|
||||||
from rest_framework.test import APITestCase
|
from rest_framework.test import APITestCase
|
||||||
|
|
||||||
from documents.models import Correspondent
|
from documents.models import Correspondent
|
||||||
from documents.models import CustomField
|
from documents.models import CustomField
|
||||||
|
from documents.models import CustomFieldInstance
|
||||||
from documents.models import Document
|
from documents.models import Document
|
||||||
from documents.models import DocumentType
|
from documents.models import DocumentType
|
||||||
from documents.models import StoragePath
|
from documents.models import StoragePath
|
||||||
from documents.models import Tag
|
from documents.models import Tag
|
||||||
from documents.tests.utils import DirectoriesMixin
|
from paperless_testing.dirs import DirectoriesMixin
|
||||||
|
from paperless_testing.factories import UserFactory
|
||||||
|
from paperless_testing.permissions import grant_all_global
|
||||||
|
from paperless_testing.permissions import grant_global
|
||||||
|
from paperless_testing.permissions import grant_object
|
||||||
|
|
||||||
|
|
||||||
class TestBulkEditAPI(DirectoriesMixin, APITestCase):
|
class TestBulkEditAPI(DirectoriesMixin, APITestCase):
|
||||||
def setUp(self) -> None:
|
def setUp(self) -> None:
|
||||||
super().setUp()
|
super().setUp()
|
||||||
|
|
||||||
user = User.objects.create_superuser(username="temp_admin")
|
user = UserFactory(username="temp_admin", superuser=True)
|
||||||
self.user = user
|
self.user = user
|
||||||
self.client.force_authenticate(user=user)
|
self.client.force_authenticate(user=user)
|
||||||
|
|
||||||
@@ -284,9 +287,9 @@ class TestBulkEditAPI(DirectoriesMixin, APITestCase):
|
|||||||
m,
|
m,
|
||||||
) -> None:
|
) -> None:
|
||||||
self.setup_mock(m, "modify_custom_fields")
|
self.setup_mock(m, "modify_custom_fields")
|
||||||
user = User.objects.create_user(username="doc-owner")
|
user = UserFactory(username="doc-owner")
|
||||||
user.user_permissions.add(Permission.objects.get(codename="change_document"))
|
grant_global(user, "change_document")
|
||||||
other_user = User.objects.create_user(username="other-user")
|
other_user = UserFactory(username="other-user")
|
||||||
source_doc = Document.objects.create(
|
source_doc = Document.objects.create(
|
||||||
checksum="source",
|
checksum="source",
|
||||||
title="Source",
|
title="Source",
|
||||||
@@ -787,10 +790,8 @@ class TestBulkEditAPI(DirectoriesMixin, APITestCase):
|
|||||||
@mock.patch("documents.serialisers.bulk_edit.set_storage_path")
|
@mock.patch("documents.serialisers.bulk_edit.set_storage_path")
|
||||||
def test_api_bulk_edit_with_all_true_resolves_owned_duplicates(self, m) -> None:
|
def test_api_bulk_edit_with_all_true_resolves_owned_duplicates(self, m) -> None:
|
||||||
self.setup_mock(m, "set_storage_path")
|
self.setup_mock(m, "set_storage_path")
|
||||||
user = User.objects.create_user(username="duplicate-owner")
|
user = UserFactory(username="duplicate-owner")
|
||||||
user.user_permissions.add(
|
grant_global(user, "change_document")
|
||||||
Permission.objects.get(codename="change_document"),
|
|
||||||
)
|
|
||||||
first_duplicate = Document.objects.create(
|
first_duplicate = Document.objects.create(
|
||||||
checksum="owned-duplicate",
|
checksum="owned-duplicate",
|
||||||
title="First duplicate",
|
title="First duplicate",
|
||||||
@@ -1178,7 +1179,7 @@ class TestBulkEditAPI(DirectoriesMixin, APITestCase):
|
|||||||
user1 = User.objects.create(username="user1")
|
user1 = User.objects.create(username="user1")
|
||||||
self.client.force_authenticate(user=user1)
|
self.client.force_authenticate(user=user1)
|
||||||
|
|
||||||
assign_perm("view_document", user1, self.doc2)
|
grant_object(user1, self.doc2, "view_document")
|
||||||
|
|
||||||
response = self.client.post(
|
response = self.client.post(
|
||||||
"/api/documents/selection_data/",
|
"/api/documents/selection_data/",
|
||||||
@@ -1188,9 +1189,7 @@ class TestBulkEditAPI(DirectoriesMixin, APITestCase):
|
|||||||
|
|
||||||
self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN)
|
self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN)
|
||||||
|
|
||||||
user1.user_permissions.add(
|
grant_global(user1, "view_document")
|
||||||
Permission.objects.get(codename="view_document"),
|
|
||||||
)
|
|
||||||
user1 = User.objects.get(pk=user1.pk)
|
user1 = User.objects.get(pk=user1.pk)
|
||||||
self.client.force_authenticate(user=user1)
|
self.client.force_authenticate(user=user1)
|
||||||
response = self.client.post(
|
response = self.client.post(
|
||||||
@@ -1533,7 +1532,7 @@ class TestBulkEditAPI(DirectoriesMixin, APITestCase):
|
|||||||
self.doc1.owner = User.objects.get(username="temp_admin")
|
self.doc1.owner = User.objects.get(username="temp_admin")
|
||||||
self.doc1.save()
|
self.doc1.save()
|
||||||
user1 = User.objects.create(username="user1")
|
user1 = User.objects.create(username="user1")
|
||||||
user1.user_permissions.add(*Permission.objects.all())
|
grant_all_global(user1)
|
||||||
user1.save()
|
user1.save()
|
||||||
self.client.force_authenticate(user=user1)
|
self.client.force_authenticate(user=user1)
|
||||||
|
|
||||||
@@ -1587,8 +1586,8 @@ class TestBulkEditAPI(DirectoriesMixin, APITestCase):
|
|||||||
self.doc1.owner = User.objects.get(username="temp_admin")
|
self.doc1.owner = User.objects.get(username="temp_admin")
|
||||||
self.doc1.save()
|
self.doc1.save()
|
||||||
user1 = User.objects.create(username="user1")
|
user1 = User.objects.create(username="user1")
|
||||||
assign_perm("view_document", user1, self.doc1)
|
grant_object(user1, self.doc1, "view_document")
|
||||||
user1.user_permissions.add(*Permission.objects.all())
|
grant_all_global(user1)
|
||||||
user1.save()
|
user1.save()
|
||||||
self.client.force_authenticate(user=user1)
|
self.client.force_authenticate(user=user1)
|
||||||
|
|
||||||
@@ -1609,7 +1608,7 @@ class TestBulkEditAPI(DirectoriesMixin, APITestCase):
|
|||||||
m.assert_not_called()
|
m.assert_not_called()
|
||||||
self.assertEqual(response.content, b"Insufficient permissions")
|
self.assertEqual(response.content, b"Insufficient permissions")
|
||||||
|
|
||||||
assign_perm("change_document", user1, self.doc1)
|
grant_object(user1, self.doc1, "change_document")
|
||||||
|
|
||||||
response = self.client.post(
|
response = self.client.post(
|
||||||
"/api/documents/bulk_edit/",
|
"/api/documents/bulk_edit/",
|
||||||
@@ -1786,6 +1785,36 @@ class TestBulkEditAPI(DirectoriesMixin, APITestCase):
|
|||||||
self.assertIn(b"invalid pages specified", response.content)
|
self.assertIn(b"invalid pages specified", response.content)
|
||||||
m.assert_not_called()
|
m.assert_not_called()
|
||||||
|
|
||||||
|
@mock.patch("documents.serialisers.bulk_edit.split")
|
||||||
|
def test_bulk_edit_split_rejects_unknown_page_count(self, m) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- A legacy split bulk edit of a document without a page count
|
||||||
|
WHEN:
|
||||||
|
- API to bulk edit is called
|
||||||
|
THEN:
|
||||||
|
- API returns HTTP 400
|
||||||
|
- split is not called
|
||||||
|
"""
|
||||||
|
self.setup_mock(m, "split")
|
||||||
|
|
||||||
|
for pages in ("1", "1-5000000"):
|
||||||
|
with self.subTest(pages=pages):
|
||||||
|
response = self.client.post(
|
||||||
|
"/api/documents/bulk_edit/",
|
||||||
|
json.dumps(
|
||||||
|
{
|
||||||
|
"documents": [self.doc1.id],
|
||||||
|
"method": "split",
|
||||||
|
"parameters": {"pages": pages},
|
||||||
|
},
|
||||||
|
),
|
||||||
|
content_type="application/json",
|
||||||
|
)
|
||||||
|
self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
|
||||||
|
self.assertIn(b"document page count is unknown", response.content)
|
||||||
|
m.assert_not_called()
|
||||||
|
|
||||||
@mock.patch("documents.serialisers.bulk_edit.split")
|
@mock.patch("documents.serialisers.bulk_edit.split")
|
||||||
def test_bulk_edit_split_parses_pages(self, m) -> None:
|
def test_bulk_edit_split_parses_pages(self, m) -> None:
|
||||||
"""
|
"""
|
||||||
@@ -1819,7 +1848,7 @@ class TestBulkEditAPI(DirectoriesMixin, APITestCase):
|
|||||||
self.doc1.owner = User.objects.get(username="temp_admin")
|
self.doc1.owner = User.objects.get(username="temp_admin")
|
||||||
self.doc1.save()
|
self.doc1.save()
|
||||||
user1 = User.objects.create(username="user1")
|
user1 = User.objects.create(username="user1")
|
||||||
user1.user_permissions.add(*Permission.objects.all())
|
grant_all_global(user1)
|
||||||
user1.save()
|
user1.save()
|
||||||
self.client.force_authenticate(user=user1)
|
self.client.force_authenticate(user=user1)
|
||||||
|
|
||||||
@@ -1880,7 +1909,7 @@ class TestBulkEditAPI(DirectoriesMixin, APITestCase):
|
|||||||
self.doc1.owner = User.objects.get(username="temp_admin")
|
self.doc1.owner = User.objects.get(username="temp_admin")
|
||||||
self.doc1.save()
|
self.doc1.save()
|
||||||
user1 = User.objects.create(username="user1")
|
user1 = User.objects.create(username="user1")
|
||||||
user1.user_permissions.add(*Permission.objects.all())
|
grant_all_global(user1)
|
||||||
user1.save()
|
user1.save()
|
||||||
self.client.force_authenticate(user=user1)
|
self.client.force_authenticate(user=user1)
|
||||||
|
|
||||||
@@ -1919,11 +1948,8 @@ class TestBulkEditAPI(DirectoriesMixin, APITestCase):
|
|||||||
@mock.patch("documents.views.bulk_edit.merge")
|
@mock.patch("documents.views.bulk_edit.merge")
|
||||||
def test_merge_and_delete_requires_change_permission(self, m) -> None:
|
def test_merge_and_delete_requires_change_permission(self, m) -> None:
|
||||||
self.setup_mock(m, "merge")
|
self.setup_mock(m, "merge")
|
||||||
user = User.objects.create_user(username="no-change")
|
user = UserFactory(username="no-change")
|
||||||
user.user_permissions.add(
|
grant_global(user, "add_document", "delete_document")
|
||||||
Permission.objects.get(codename="add_document"),
|
|
||||||
Permission.objects.get(codename="delete_document"),
|
|
||||||
)
|
|
||||||
self.client.force_authenticate(user=user)
|
self.client.force_authenticate(user=user)
|
||||||
|
|
||||||
response = self.client.post(
|
response = self.client.post(
|
||||||
@@ -2310,7 +2336,7 @@ class TestBulkEditAPI(DirectoriesMixin, APITestCase):
|
|||||||
self.doc1.owner = User.objects.get(username="temp_admin")
|
self.doc1.owner = User.objects.get(username="temp_admin")
|
||||||
self.doc1.save()
|
self.doc1.save()
|
||||||
user1 = User.objects.create(username="user1")
|
user1 = User.objects.create(username="user1")
|
||||||
user1.user_permissions.add(*Permission.objects.all())
|
grant_all_global(user1)
|
||||||
user1.save()
|
user1.save()
|
||||||
self.client.force_authenticate(user=user1)
|
self.client.force_authenticate(user=user1)
|
||||||
|
|
||||||
@@ -2345,7 +2371,7 @@ class TestBulkEditAPI(DirectoriesMixin, APITestCase):
|
|||||||
@mock.patch("documents.views.bulk_edit.edit_pdf")
|
@mock.patch("documents.views.bulk_edit.edit_pdf")
|
||||||
def test_edit_pdf_update_requires_change_permission(self, m) -> None:
|
def test_edit_pdf_update_requires_change_permission(self, m) -> None:
|
||||||
self.setup_mock(m, "edit_pdf")
|
self.setup_mock(m, "edit_pdf")
|
||||||
user = User.objects.create_user(username="no-change")
|
user = UserFactory(username="no-change")
|
||||||
self.client.force_authenticate(user=user)
|
self.client.force_authenticate(user=user)
|
||||||
|
|
||||||
response = self.client.post(
|
response = self.client.post(
|
||||||
@@ -2372,11 +2398,8 @@ class TestBulkEditAPI(DirectoriesMixin, APITestCase):
|
|||||||
) -> None:
|
) -> None:
|
||||||
self.setup_mock(edit_pdf_mock, "edit_pdf")
|
self.setup_mock(edit_pdf_mock, "edit_pdf")
|
||||||
self.setup_mock(remove_password_mock, "remove_password")
|
self.setup_mock(remove_password_mock, "remove_password")
|
||||||
user = User.objects.create_user(username="no-delete")
|
user = UserFactory(username="no-delete")
|
||||||
user.user_permissions.add(
|
grant_global(user, "add_document", "change_document")
|
||||||
Permission.objects.get(codename="add_document"),
|
|
||||||
Permission.objects.get(codename="change_document"),
|
|
||||||
)
|
|
||||||
self.client.force_authenticate(user=user)
|
self.client.force_authenticate(user=user)
|
||||||
|
|
||||||
cases = [
|
cases = [
|
||||||
@@ -2463,7 +2486,7 @@ class TestBulkEditAPI(DirectoriesMixin, APITestCase):
|
|||||||
self.doc1.owner = User.objects.get(username="temp_admin")
|
self.doc1.owner = User.objects.get(username="temp_admin")
|
||||||
self.doc1.save()
|
self.doc1.save()
|
||||||
user1 = User.objects.create(username="user1")
|
user1 = User.objects.create(username="user1")
|
||||||
user1.user_permissions.add(*Permission.objects.all())
|
grant_all_global(user1)
|
||||||
user1.save()
|
user1.save()
|
||||||
self.client.force_authenticate(user=user1)
|
self.client.force_authenticate(user=user1)
|
||||||
|
|
||||||
@@ -2503,7 +2526,7 @@ class TestBulkEditAPI(DirectoriesMixin, APITestCase):
|
|||||||
WHEN:
|
WHEN:
|
||||||
- API to bulk edit documents is called
|
- API to bulk edit documents is called
|
||||||
THEN:
|
THEN:
|
||||||
- Audit log is created
|
- Audit log is created with the old and new correspondent
|
||||||
"""
|
"""
|
||||||
LogEntry.objects.all().delete()
|
LogEntry.objects.all().delete()
|
||||||
response = self.client.post(
|
response = self.client.post(
|
||||||
@@ -2519,7 +2542,8 @@ class TestBulkEditAPI(DirectoriesMixin, APITestCase):
|
|||||||
)
|
)
|
||||||
|
|
||||||
self.assertEqual(response.status_code, status.HTTP_200_OK)
|
self.assertEqual(response.status_code, status.HTTP_200_OK)
|
||||||
self.assertEqual(LogEntry.objects.filter(object_pk=self.doc1.id).count(), 1)
|
entry = LogEntry.objects.get_for_object(self.doc1).get()
|
||||||
|
self.assertEqual(entry.changes, {"correspondent": [None, self.c2.id]})
|
||||||
|
|
||||||
@override_settings(AUDIT_LOG_ENABLED=True)
|
@override_settings(AUDIT_LOG_ENABLED=True)
|
||||||
def test_bulk_edit_audit_log_enabled_tags(self) -> None:
|
def test_bulk_edit_audit_log_enabled_tags(self) -> None:
|
||||||
@@ -2527,16 +2551,18 @@ class TestBulkEditAPI(DirectoriesMixin, APITestCase):
|
|||||||
GIVEN:
|
GIVEN:
|
||||||
- Audit log is enabled
|
- Audit log is enabled
|
||||||
WHEN:
|
WHEN:
|
||||||
- API to bulk edit tags is called
|
- API to bulk edit tags is called on an untagged document and a
|
||||||
|
document with several tags
|
||||||
THEN:
|
THEN:
|
||||||
- Audit log is created
|
- Audit log is created for each document with its full tag list
|
||||||
|
before and after the edit
|
||||||
"""
|
"""
|
||||||
LogEntry.objects.all().delete()
|
LogEntry.objects.all().delete()
|
||||||
response = self.client.post(
|
response = self.client.post(
|
||||||
"/api/documents/bulk_edit/",
|
"/api/documents/bulk_edit/",
|
||||||
json.dumps(
|
json.dumps(
|
||||||
{
|
{
|
||||||
"documents": [self.doc1.id],
|
"documents": [self.doc1.id, self.doc4.id],
|
||||||
"method": "modify_tags",
|
"method": "modify_tags",
|
||||||
"parameters": {
|
"parameters": {
|
||||||
"add_tags": [self.t1.id],
|
"add_tags": [self.t1.id],
|
||||||
@@ -2548,18 +2574,32 @@ class TestBulkEditAPI(DirectoriesMixin, APITestCase):
|
|||||||
)
|
)
|
||||||
|
|
||||||
self.assertEqual(response.status_code, status.HTTP_200_OK)
|
self.assertEqual(response.status_code, status.HTTP_200_OK)
|
||||||
self.assertEqual(LogEntry.objects.filter(object_pk=self.doc1.id).count(), 1)
|
entry = LogEntry.objects.get_for_object(self.doc1).get()
|
||||||
|
self.assertEqual(entry.changes, {"tags": [[], [self.t1.id]]})
|
||||||
|
entry = LogEntry.objects.get_for_object(self.doc4).get()
|
||||||
|
self.assertEqual(
|
||||||
|
entry.changes,
|
||||||
|
{"tags": [[self.t1.id, self.t2.id], [self.t1.id]]},
|
||||||
|
)
|
||||||
|
|
||||||
@override_settings(AUDIT_LOG_ENABLED=True)
|
@override_settings(AUDIT_LOG_ENABLED=True)
|
||||||
def test_bulk_edit_audit_log_enabled_custom_fields(self) -> None:
|
def test_bulk_edit_audit_log_enabled_custom_fields(self) -> None:
|
||||||
"""
|
"""
|
||||||
GIVEN:
|
GIVEN:
|
||||||
- Audit log is enabled
|
- Audit log is enabled
|
||||||
|
- A document with two custom fields
|
||||||
WHEN:
|
WHEN:
|
||||||
- API to bulk edit custom fields is called
|
- API to bulk edit custom fields is called to add a third
|
||||||
THEN:
|
THEN:
|
||||||
- Audit log is created
|
- Audit log is created with every custom field instance before and
|
||||||
|
after the edit
|
||||||
|
- Audit log is created for the new custom field instance
|
||||||
"""
|
"""
|
||||||
|
cf3 = CustomField.objects.create(name="cf3", data_type="string")
|
||||||
|
existing = [
|
||||||
|
CustomFieldInstance.objects.create(document=self.doc1, field=field)
|
||||||
|
for field in (self.cf2, cf3)
|
||||||
|
]
|
||||||
LogEntry.objects.all().delete()
|
LogEntry.objects.all().delete()
|
||||||
response = self.client.post(
|
response = self.client.post(
|
||||||
"/api/documents/bulk_edit/",
|
"/api/documents/bulk_edit/",
|
||||||
@@ -2577,7 +2617,14 @@ class TestBulkEditAPI(DirectoriesMixin, APITestCase):
|
|||||||
)
|
)
|
||||||
|
|
||||||
self.assertEqual(response.status_code, status.HTTP_200_OK)
|
self.assertEqual(response.status_code, status.HTTP_200_OK)
|
||||||
self.assertEqual(LogEntry.objects.filter(object_pk=self.doc1.id).count(), 2)
|
added = CustomFieldInstance.objects.get(document=self.doc1, field=self.cf1)
|
||||||
|
existing_ids = [instance.id for instance in existing]
|
||||||
|
entry = LogEntry.objects.get_for_object(self.doc1).get()
|
||||||
|
self.assertEqual(
|
||||||
|
entry.changes,
|
||||||
|
{"custom_fields": [existing_ids, [*existing_ids, added.id]]},
|
||||||
|
)
|
||||||
|
self.assertEqual(LogEntry.objects.get_for_object(added).count(), 1)
|
||||||
|
|
||||||
def test_api_bulk_edit_with_bad_search_query_returns_400(self) -> None:
|
def test_api_bulk_edit_with_bad_search_query_returns_400(self) -> None:
|
||||||
"""
|
"""
|
||||||
|
|||||||
@@ -4,20 +4,22 @@ from typing import TYPE_CHECKING
|
|||||||
from unittest import mock
|
from unittest import mock
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
from django.contrib.auth.models import Permission
|
|
||||||
from django.contrib.auth.models import User
|
|
||||||
from rest_framework import status
|
from rest_framework import status
|
||||||
from rest_framework.test import APIClient
|
from rest_framework.test import APIClient
|
||||||
from rest_framework.test import APITestCase
|
from rest_framework.test import APITestCase
|
||||||
|
|
||||||
|
from paperless_testing.factories import UserFactory
|
||||||
|
from paperless_testing.permissions import grant_global
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
|
from django.contrib.auth.models import User
|
||||||
from pytest_mock import MockerFixture
|
from pytest_mock import MockerFixture
|
||||||
|
|
||||||
|
|
||||||
class TestChatStreamingViewInputValidation(APITestCase):
|
class TestChatStreamingViewInputValidation(APITestCase):
|
||||||
def setUp(self) -> None:
|
def setUp(self) -> None:
|
||||||
super().setUp()
|
super().setUp()
|
||||||
self.user = User.objects.create_superuser(username="temp_admin")
|
self.user = UserFactory(username="temp_admin", superuser=True)
|
||||||
self.client.force_authenticate(user=self.user)
|
self.client.force_authenticate(user=self.user)
|
||||||
|
|
||||||
def _mock_ai_enabled(self) -> mock.MagicMock:
|
def _mock_ai_enabled(self) -> mock.MagicMock:
|
||||||
@@ -113,9 +115,7 @@ class TestChatStreamingViewUnrestrictedFlag:
|
|||||||
needs to reach the view at all. Model-level only: says nothing
|
needs to reach the view at all. Model-level only: says nothing
|
||||||
about which documents (if any) this user can actually see.
|
about which documents (if any) this user can actually see.
|
||||||
"""
|
"""
|
||||||
regular_user.user_permissions.add(
|
grant_global(regular_user, "view_document")
|
||||||
*Permission.objects.filter(codename="view_document"),
|
|
||||||
)
|
|
||||||
return user_client
|
return user_client
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
@pytest.mark.parametrize(
|
||||||
|
|||||||
@@ -4,23 +4,24 @@ from unittest import mock
|
|||||||
from unittest.mock import ANY
|
from unittest.mock import ANY
|
||||||
|
|
||||||
from django.contrib.auth.models import Permission
|
from django.contrib.auth.models import Permission
|
||||||
from django.contrib.auth.models import User
|
|
||||||
from django.test import override_settings
|
from django.test import override_settings
|
||||||
from guardian.shortcuts import assign_perm
|
|
||||||
from rest_framework import status
|
from rest_framework import status
|
||||||
from rest_framework.test import APITestCase
|
from rest_framework.test import APITestCase
|
||||||
|
|
||||||
from documents.models import CustomField
|
from documents.models import CustomField
|
||||||
from documents.models import CustomFieldInstance
|
from documents.models import CustomFieldInstance
|
||||||
from documents.models import Document
|
from documents.models import Document
|
||||||
from documents.tests.utils import DirectoriesMixin
|
from paperless_testing.dirs import DirectoriesMixin
|
||||||
|
from paperless_testing.factories import UserFactory
|
||||||
|
from paperless_testing.permissions import grant_global
|
||||||
|
from paperless_testing.permissions import grant_object
|
||||||
|
|
||||||
|
|
||||||
class TestCustomFieldsAPI(DirectoriesMixin, APITestCase):
|
class TestCustomFieldsAPI(DirectoriesMixin, APITestCase):
|
||||||
ENDPOINT = "/api/custom_fields/"
|
ENDPOINT = "/api/custom_fields/"
|
||||||
|
|
||||||
def setUp(self) -> None:
|
def setUp(self) -> None:
|
||||||
self.user = User.objects.create_superuser(username="temp_admin")
|
self.user = UserFactory(username="temp_admin", superuser=True)
|
||||||
self.client.force_authenticate(user=self.user)
|
self.client.force_authenticate(user=self.user)
|
||||||
return super().setUp()
|
return super().setUp()
|
||||||
|
|
||||||
@@ -1174,11 +1175,9 @@ class TestCustomFieldsAPI(DirectoriesMixin, APITestCase):
|
|||||||
def test_documentlink_patch_requires_change_permission_on_target_documents(
|
def test_documentlink_patch_requires_change_permission_on_target_documents(
|
||||||
self,
|
self,
|
||||||
) -> None:
|
) -> None:
|
||||||
source_owner = User.objects.create_user(username="source-owner")
|
source_owner = UserFactory(username="source-owner")
|
||||||
source_owner.user_permissions.add(
|
grant_global(source_owner, "change_document")
|
||||||
Permission.objects.get(codename="change_document"),
|
other_user = UserFactory(username="other-user")
|
||||||
)
|
|
||||||
other_user = User.objects.create_user(username="other-user")
|
|
||||||
|
|
||||||
source_doc = Document.objects.create(
|
source_doc = Document.objects.create(
|
||||||
title="Source",
|
title="Source",
|
||||||
@@ -1221,11 +1220,9 @@ class TestCustomFieldsAPI(DirectoriesMixin, APITestCase):
|
|||||||
def test_documentlink_patch_allowed_with_change_permission_on_target_documents(
|
def test_documentlink_patch_allowed_with_change_permission_on_target_documents(
|
||||||
self,
|
self,
|
||||||
) -> None:
|
) -> None:
|
||||||
source_owner = User.objects.create_user(username="source-owner")
|
source_owner = UserFactory(username="source-owner")
|
||||||
source_owner.user_permissions.add(
|
grant_global(source_owner, "change_document")
|
||||||
Permission.objects.get(codename="change_document"),
|
other_user = UserFactory(username="other-user")
|
||||||
)
|
|
||||||
other_user = User.objects.create_user(username="other-user")
|
|
||||||
|
|
||||||
source_doc = Document.objects.create(
|
source_doc = Document.objects.create(
|
||||||
title="Source",
|
title="Source",
|
||||||
@@ -1244,7 +1241,7 @@ class TestCustomFieldsAPI(DirectoriesMixin, APITestCase):
|
|||||||
data_type=CustomField.FieldDataType.DOCUMENTLINK,
|
data_type=CustomField.FieldDataType.DOCUMENTLINK,
|
||||||
)
|
)
|
||||||
|
|
||||||
assign_perm("change_document", source_owner, target_doc)
|
grant_object(source_owner, target_doc, "change_document")
|
||||||
self.client.force_authenticate(user=source_owner)
|
self.client.force_authenticate(user=source_owner)
|
||||||
|
|
||||||
resp = self.client.patch(
|
resp = self.client.patch(
|
||||||
@@ -1337,7 +1334,7 @@ class TestCustomFieldsAPI(DirectoriesMixin, APITestCase):
|
|||||||
self.assertEqual(results[0]["document_count"], 1)
|
self.assertEqual(results[0]["document_count"], 1)
|
||||||
|
|
||||||
# Test as user without access to the document
|
# Test as user without access to the document
|
||||||
non_superuser = User.objects.create_user(username="non_superuser")
|
non_superuser = UserFactory(username="non_superuser")
|
||||||
non_superuser.user_permissions.add(
|
non_superuser.user_permissions.add(
|
||||||
*Permission.objects.exclude(codename="view_global_statistics"),
|
*Permission.objects.exclude(codename="view_global_statistics"),
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -5,8 +5,6 @@ from typing import TYPE_CHECKING
|
|||||||
from unittest import mock
|
from unittest import mock
|
||||||
|
|
||||||
from auditlog.models import LogEntry # type: ignore[import-untyped]
|
from auditlog.models import LogEntry # type: ignore[import-untyped]
|
||||||
from django.contrib.auth.models import Permission
|
|
||||||
from django.contrib.auth.models import User
|
|
||||||
from django.contrib.contenttypes.models import ContentType
|
from django.contrib.contenttypes.models import ContentType
|
||||||
from django.core.files.uploadedfile import SimpleUploadedFile
|
from django.core.files.uploadedfile import SimpleUploadedFile
|
||||||
from django.test import TestCase as DjangoTestCase
|
from django.test import TestCase as DjangoTestCase
|
||||||
@@ -18,10 +16,13 @@ from documents.data_models import DocumentSource
|
|||||||
from documents.filters import EffectiveContentFilter
|
from documents.filters import EffectiveContentFilter
|
||||||
from documents.filters import TitleContentFilter
|
from documents.filters import TitleContentFilter
|
||||||
from documents.models import Document
|
from documents.models import Document
|
||||||
from documents.tests.utils import DirectoriesMixin
|
|
||||||
from documents.tests.utils import read_streaming_response
|
|
||||||
from documents.versioning import annotate_effective_content
|
from documents.versioning import annotate_effective_content
|
||||||
from documents.views import DocumentSelectionMixin
|
from documents.views import DocumentSelectionMixin
|
||||||
|
from paperless_testing.dirs import DirectoriesMixin
|
||||||
|
from paperless_testing.factories import DocumentFactory
|
||||||
|
from paperless_testing.factories import UserFactory
|
||||||
|
from paperless_testing.http import read_streaming_response
|
||||||
|
from paperless_testing.permissions import grant_global
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
@@ -31,7 +32,7 @@ class TestDocumentVersioningApi(DirectoriesMixin, APITestCase):
|
|||||||
def setUp(self) -> None:
|
def setUp(self) -> None:
|
||||||
super().setUp()
|
super().setUp()
|
||||||
|
|
||||||
self.user = User.objects.create_superuser(username="temp_admin")
|
self.user = UserFactory(username="temp_admin", superuser=True)
|
||||||
self.client.force_authenticate(user=self.user)
|
self.client.force_authenticate(user=self.user)
|
||||||
|
|
||||||
def _make_pdf_upload(self, name: str = "version.pdf") -> SimpleUploadedFile:
|
def _make_pdf_upload(self, name: str = "version.pdf") -> SimpleUploadedFile:
|
||||||
@@ -89,11 +90,9 @@ class TestDocumentVersioningApi(DirectoriesMixin, APITestCase):
|
|||||||
self.assertEqual(resp.status_code, status.HTTP_404_NOT_FOUND)
|
self.assertEqual(resp.status_code, status.HTTP_404_NOT_FOUND)
|
||||||
|
|
||||||
def test_root_endpoint_returns_403_when_user_lacks_permission(self) -> None:
|
def test_root_endpoint_returns_403_when_user_lacks_permission(self) -> None:
|
||||||
owner = User.objects.create_user(username="owner")
|
owner = UserFactory(username="owner")
|
||||||
viewer = User.objects.create_user(username="viewer")
|
viewer = UserFactory(username="viewer")
|
||||||
viewer.user_permissions.add(
|
grant_global(viewer, "view_document")
|
||||||
Permission.objects.get(codename="view_document"),
|
|
||||||
)
|
|
||||||
root = Document.objects.create(
|
root = Document.objects.create(
|
||||||
title="root",
|
title="root",
|
||||||
checksum="root",
|
checksum="root",
|
||||||
@@ -283,11 +282,9 @@ class TestDocumentVersioningApi(DirectoriesMixin, APITestCase):
|
|||||||
self.assertEqual(mock_backend.add_or_update.call_args[0][0].id, root.id)
|
self.assertEqual(mock_backend.add_or_update.call_args[0][0].id, root.id)
|
||||||
|
|
||||||
def test_delete_version_returns_403_without_permission(self) -> None:
|
def test_delete_version_returns_403_without_permission(self) -> None:
|
||||||
owner = User.objects.create_user(username="owner")
|
owner = UserFactory(username="owner")
|
||||||
other = User.objects.create_user(username="other")
|
other = UserFactory(username="other")
|
||||||
other.user_permissions.add(
|
grant_global(other, "delete_document")
|
||||||
Permission.objects.get(codename="delete_document"),
|
|
||||||
)
|
|
||||||
root = Document.objects.create(
|
root = Document.objects.create(
|
||||||
title="root",
|
title="root",
|
||||||
checksum="root",
|
checksum="root",
|
||||||
@@ -371,11 +368,9 @@ class TestDocumentVersioningApi(DirectoriesMixin, APITestCase):
|
|||||||
self.assertTrue(resp.data["is_root"])
|
self.assertTrue(resp.data["is_root"])
|
||||||
|
|
||||||
def test_update_version_label_returns_403_without_permission(self) -> None:
|
def test_update_version_label_returns_403_without_permission(self) -> None:
|
||||||
owner = User.objects.create_user(username="owner")
|
owner = UserFactory(username="owner")
|
||||||
other = User.objects.create_user(username="other")
|
other = UserFactory(username="other")
|
||||||
other.user_permissions.add(
|
grant_global(other, "change_document")
|
||||||
Permission.objects.get(codename="change_document"),
|
|
||||||
)
|
|
||||||
root = Document.objects.create(
|
root = Document.objects.create(
|
||||||
title="root",
|
title="root",
|
||||||
checksum="root",
|
checksum="root",
|
||||||
@@ -553,11 +548,9 @@ class TestDocumentVersioningApi(DirectoriesMixin, APITestCase):
|
|||||||
self.assertEqual(resp.status_code, status.HTTP_404_NOT_FOUND)
|
self.assertEqual(resp.status_code, status.HTTP_404_NOT_FOUND)
|
||||||
|
|
||||||
def test_metadata_returns_403_when_user_lacks_permission(self) -> None:
|
def test_metadata_returns_403_when_user_lacks_permission(self) -> None:
|
||||||
owner = User.objects.create_user(username="owner")
|
owner = UserFactory(username="owner")
|
||||||
other = User.objects.create_user(username="other")
|
other = UserFactory(username="other")
|
||||||
other.user_permissions.add(
|
grant_global(other, "view_document")
|
||||||
Permission.objects.get(codename="view_document"),
|
|
||||||
)
|
|
||||||
doc = Document.objects.create(
|
doc = Document.objects.create(
|
||||||
title="root",
|
title="root",
|
||||||
checksum="root",
|
checksum="root",
|
||||||
@@ -653,8 +646,8 @@ class TestDocumentVersioningApi(DirectoriesMixin, APITestCase):
|
|||||||
self.assertEqual(resp.status_code, status.HTTP_500_INTERNAL_SERVER_ERROR)
|
self.assertEqual(resp.status_code, status.HTTP_500_INTERNAL_SERVER_ERROR)
|
||||||
|
|
||||||
def test_update_version_returns_403_without_permission(self) -> None:
|
def test_update_version_returns_403_without_permission(self) -> None:
|
||||||
owner = User.objects.create_user(username="owner")
|
owner = UserFactory(username="owner")
|
||||||
other = User.objects.create_user(username="other")
|
other = UserFactory(username="other")
|
||||||
root = Document.objects.create(
|
root = Document.objects.create(
|
||||||
title="root",
|
title="root",
|
||||||
checksum="root",
|
checksum="root",
|
||||||
@@ -672,8 +665,8 @@ class TestDocumentVersioningApi(DirectoriesMixin, APITestCase):
|
|||||||
self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN)
|
self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN)
|
||||||
|
|
||||||
def test_update_version_requires_global_change_permission(self) -> None:
|
def test_update_version_requires_global_change_permission(self) -> None:
|
||||||
user = User.objects.create_user(username="add-only")
|
user = UserFactory(username="add-only")
|
||||||
user.user_permissions.add(Permission.objects.get(codename="add_document"))
|
grant_global(user, "add_document")
|
||||||
root = Document.objects.create(
|
root = Document.objects.create(
|
||||||
title="root",
|
title="root",
|
||||||
checksum="root",
|
checksum="root",
|
||||||
@@ -829,6 +822,26 @@ class TestDocumentVersioningApi(DirectoriesMixin, APITestCase):
|
|||||||
self.assertEqual(resp.status_code, status.HTTP_200_OK)
|
self.assertEqual(resp.status_code, status.HTTP_200_OK)
|
||||||
self.assertEqual(resp.data["content"], "v1-content")
|
self.assertEqual(resp.data["content"], "v1-content")
|
||||||
|
|
||||||
|
def test_page_count_resolves_to_latest_version(self) -> None:
|
||||||
|
root = DocumentFactory(page_count=2)
|
||||||
|
DocumentFactory(root_document=root, version_index=1, page_count=1)
|
||||||
|
unversioned = DocumentFactory(page_count=5)
|
||||||
|
|
||||||
|
resp = self.client.get("/api/documents/?fields=id,page_count")
|
||||||
|
self.assertEqual(resp.status_code, status.HTTP_200_OK)
|
||||||
|
self.assertEqual(
|
||||||
|
{doc["id"]: doc["page_count"] for doc in resp.data["results"]},
|
||||||
|
{root.id: 1, unversioned.id: 5},
|
||||||
|
)
|
||||||
|
|
||||||
|
resp = self.client.get(f"/api/documents/{root.id}/")
|
||||||
|
self.assertEqual(resp.status_code, status.HTTP_200_OK)
|
||||||
|
self.assertEqual(resp.data["page_count"], 1)
|
||||||
|
|
||||||
|
resp = self.client.get(f"/api/documents/{root.id}/?version={root.id}")
|
||||||
|
self.assertEqual(resp.status_code, status.HTTP_200_OK)
|
||||||
|
self.assertEqual(resp.data["page_count"], 2)
|
||||||
|
|
||||||
def _make_root_with_out_of_order_versions(self) -> tuple[Document, ...]:
|
def _make_root_with_out_of_order_versions(self) -> tuple[Document, ...]:
|
||||||
"""
|
"""
|
||||||
A root whose newest version has a *lower* id than an older one, which is
|
A root whose newest version has a *lower* id than an older one, which is
|
||||||
@@ -978,7 +991,7 @@ class TestVersionAwareFilters(DjangoTestCase):
|
|||||||
superseded content -- selecting documents the list view, filtered by
|
superseded content -- selecting documents the list view, filtered by
|
||||||
the same term, does not show.
|
the same term, does not show.
|
||||||
"""
|
"""
|
||||||
user = User.objects.create_superuser(username="bulk_selection")
|
user = UserFactory(username="bulk_selection", superuser=True)
|
||||||
|
|
||||||
selected = DocumentSelectionMixin()._resolve_document_ids(
|
selected = DocumentSelectionMixin()._resolve_document_ids(
|
||||||
user=user,
|
user=user,
|
||||||
@@ -1005,7 +1018,7 @@ class TestBulkSelectionExcludesVersions(DjangoTestCase):
|
|||||||
"Select all matching" reconstructs the document list, which never
|
"Select all matching" reconstructs the document list, which never
|
||||||
contains version documents as rows of their own.
|
contains version documents as rows of their own.
|
||||||
"""
|
"""
|
||||||
user = User.objects.create_superuser(username="bulk_versions")
|
user = UserFactory(username="bulk_versions", superuser=True)
|
||||||
root = Document.objects.create(
|
root = Document.objects.create(
|
||||||
title="shared-title root",
|
title="shared-title root",
|
||||||
checksum="bulk-root",
|
checksum="bulk-root",
|
||||||
|
|||||||
@@ -23,7 +23,6 @@ from django.core.files.uploadedfile import SimpleUploadedFile
|
|||||||
from django.db import DataError
|
from django.db import DataError
|
||||||
from django.test import override_settings
|
from django.test import override_settings
|
||||||
from django.utils import timezone
|
from django.utils import timezone
|
||||||
from guardian.shortcuts import assign_perm
|
|
||||||
from rest_framework import status
|
from rest_framework import status
|
||||||
from rest_framework.test import APITestCase
|
from rest_framework.test import APITestCase
|
||||||
|
|
||||||
@@ -48,18 +47,22 @@ from documents.models import Workflow
|
|||||||
from documents.models import WorkflowAction
|
from documents.models import WorkflowAction
|
||||||
from documents.models import WorkflowTrigger
|
from documents.models import WorkflowTrigger
|
||||||
from documents.signals.handlers import run_workflows
|
from documents.signals.handlers import run_workflows
|
||||||
from documents.tests.factories import DocumentFactory
|
|
||||||
from documents.tests.factories import TagFactory
|
|
||||||
from documents.tests.utils import ConsumeTaskMixin
|
from documents.tests.utils import ConsumeTaskMixin
|
||||||
from documents.tests.utils import DirectoriesMixin
|
from paperless_testing.dirs import DirectoriesMixin
|
||||||
from documents.tests.utils import read_streaming_response
|
from paperless_testing.factories import DocumentFactory
|
||||||
|
from paperless_testing.factories import TagFactory
|
||||||
|
from paperless_testing.factories import UserFactory
|
||||||
|
from paperless_testing.http import read_streaming_response
|
||||||
|
from paperless_testing.permissions import grant_all_global
|
||||||
|
from paperless_testing.permissions import grant_global
|
||||||
|
from paperless_testing.permissions import grant_object
|
||||||
|
|
||||||
|
|
||||||
class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
||||||
def setUp(self) -> None:
|
def setUp(self) -> None:
|
||||||
super().setUp()
|
super().setUp()
|
||||||
|
|
||||||
self.user = User.objects.create_superuser(username="temp_admin")
|
self.user = UserFactory(username="temp_admin", superuser=True)
|
||||||
self.client.force_authenticate(user=self.user)
|
self.client.force_authenticate(user=self.user)
|
||||||
cache.clear()
|
cache.clear()
|
||||||
|
|
||||||
@@ -357,10 +360,10 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
|||||||
with Path(filename).open("wb") as f:
|
with Path(filename).open("wb") as f:
|
||||||
f.write(content)
|
f.write(content)
|
||||||
|
|
||||||
user1 = User.objects.create_user(username="test1")
|
user1 = UserFactory(username="test1")
|
||||||
user2 = User.objects.create_user(username="test2")
|
user2 = UserFactory(username="test2")
|
||||||
user1.user_permissions.add(*Permission.objects.filter(codename="view_document"))
|
grant_global(user1, "view_document")
|
||||||
user2.user_permissions.add(*Permission.objects.filter(codename="view_document"))
|
grant_global(user2, "view_document")
|
||||||
|
|
||||||
self.client.force_authenticate(user2)
|
self.client.force_authenticate(user2)
|
||||||
|
|
||||||
@@ -383,7 +386,7 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
|||||||
response = self.client.get(f"/api/documents/{doc.pk}/thumb/")
|
response = self.client.get(f"/api/documents/{doc.pk}/thumb/")
|
||||||
self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN)
|
self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN)
|
||||||
|
|
||||||
assign_perm("view_document", user2, doc)
|
grant_object(user2, doc, "view_document")
|
||||||
|
|
||||||
response = self.client.get(f"/api/documents/{doc.pk}/download/")
|
response = self.client.get(f"/api/documents/{doc.pk}/download/")
|
||||||
self.assertEqual(response.status_code, status.HTTP_200_OK)
|
self.assertEqual(response.status_code, status.HTTP_200_OK)
|
||||||
@@ -760,8 +763,8 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
|||||||
- History is returned
|
- History is returned
|
||||||
"""
|
"""
|
||||||
# No auditlog permissions
|
# No auditlog permissions
|
||||||
user = User.objects.create_user(username="test")
|
user = UserFactory(username="test")
|
||||||
user.user_permissions.add(*Permission.objects.filter(codename="view_document"))
|
grant_global(user, "view_document")
|
||||||
self.client.force_authenticate(user=user)
|
self.client.force_authenticate(user=user)
|
||||||
doc = Document.objects.create(
|
doc = Document.objects.create(
|
||||||
title="First title",
|
title="First title",
|
||||||
@@ -776,7 +779,7 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
|||||||
# superuser
|
# superuser
|
||||||
user.is_superuser = True
|
user.is_superuser = True
|
||||||
user.save()
|
user.save()
|
||||||
user2 = User.objects.create_user(username="test2")
|
user2 = UserFactory(username="test2")
|
||||||
doc2 = Document.objects.create(
|
doc2 = Document.objects.create(
|
||||||
title="Second title",
|
title="Second title",
|
||||||
checksum="456",
|
checksum="456",
|
||||||
@@ -1073,11 +1076,9 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
|||||||
self.assertEqual(response.data["duplicate_documents"], [])
|
self.assertEqual(response.data["duplicate_documents"], [])
|
||||||
|
|
||||||
def test_has_duplicates_filter_respects_document_permissions(self) -> None:
|
def test_has_duplicates_filter_respects_document_permissions(self) -> None:
|
||||||
owner = User.objects.create_user(username="duplicate-owner")
|
owner = UserFactory(username="duplicate-owner")
|
||||||
requester = User.objects.create_user(username="duplicate-requester")
|
requester = UserFactory(username="duplicate-requester")
|
||||||
requester.user_permissions.add(
|
grant_global(requester, "view_document")
|
||||||
Permission.objects.get(codename="view_document"),
|
|
||||||
)
|
|
||||||
visible_document = Document.objects.create(
|
visible_document = Document.objects.create(
|
||||||
title="visible document",
|
title="visible document",
|
||||||
checksum="permission-match",
|
checksum="permission-match",
|
||||||
@@ -1096,7 +1097,7 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
|||||||
[document["id"] for document in response.data["results"]],
|
[document["id"] for document in response.data["results"]],
|
||||||
)
|
)
|
||||||
|
|
||||||
assign_perm("view_document", requester, hidden_duplicate)
|
grant_object(requester, hidden_duplicate, "view_document")
|
||||||
response = self.client.get("/api/documents/?has_duplicates=true")
|
response = self.client.get("/api/documents/?has_duplicates=true")
|
||||||
self.assertIn(
|
self.assertIn(
|
||||||
visible_document.id,
|
visible_document.id,
|
||||||
@@ -1317,10 +1318,10 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
|||||||
THEN:
|
THEN:
|
||||||
- Owner filters work correctly but still respect permissions
|
- Owner filters work correctly but still respect permissions
|
||||||
"""
|
"""
|
||||||
u1 = User.objects.create_user("user1")
|
u1 = UserFactory(username="user1")
|
||||||
u2 = User.objects.create_user("user2")
|
u2 = UserFactory(username="user2")
|
||||||
u1.user_permissions.add(*Permission.objects.filter(codename="view_document"))
|
grant_global(u1, "view_document")
|
||||||
u2.user_permissions.add(*Permission.objects.filter(codename="view_document"))
|
grant_global(u2, "view_document")
|
||||||
|
|
||||||
u1_doc1 = Document.objects.create(
|
u1_doc1 = Document.objects.create(
|
||||||
title="none1",
|
title="none1",
|
||||||
@@ -1353,7 +1354,7 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
|||||||
)
|
)
|
||||||
|
|
||||||
self.client.force_authenticate(user=u1)
|
self.client.force_authenticate(user=u1)
|
||||||
assign_perm("view_document", u1, u2_doc2)
|
grant_object(u1, u2_doc2, "view_document")
|
||||||
|
|
||||||
# Will not show any u1 docs or u2_doc1 which isn't shared
|
# Will not show any u1 docs or u2_doc1 which isn't shared
|
||||||
response = self.client.get(f"/api/documents/?owner__id__none={u1.id}")
|
response = self.client.get(f"/api/documents/?owner__id__none={u1.id}")
|
||||||
@@ -1400,7 +1401,7 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
|||||||
[u1_doc1.id, u1_doc2.id, u2_doc2.id],
|
[u1_doc1.id, u1_doc2.id, u2_doc2.id],
|
||||||
)
|
)
|
||||||
|
|
||||||
assign_perm("view_document", u2, u1_doc1)
|
grant_object(u2, u1_doc1, "view_document")
|
||||||
|
|
||||||
# Will show only documents shared by user
|
# Will show only documents shared by user
|
||||||
response = self.client.get(f"/api/documents/?shared_by__id={u1.id}")
|
response = self.client.get(f"/api/documents/?shared_by__id={u1.id}")
|
||||||
@@ -1424,8 +1425,8 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
|||||||
- The document is returned exactly once, not once per permission path
|
- The document is returned exactly once, not once per permission path
|
||||||
(regression test for https://github.com/paperless-ngx/paperless-ngx/issues/13331)
|
(regression test for https://github.com/paperless-ngx/paperless-ngx/issues/13331)
|
||||||
"""
|
"""
|
||||||
user = User.objects.create_user("user1")
|
user = UserFactory(username="user1")
|
||||||
user.user_permissions.add(*Permission.objects.filter(codename="view_document"))
|
grant_global(user, "view_document")
|
||||||
group = Group.objects.create(name="group1")
|
group = Group.objects.create(name="group1")
|
||||||
user.groups.add(group)
|
user.groups.add(group)
|
||||||
|
|
||||||
@@ -1433,7 +1434,7 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
|||||||
tag2 = TagFactory()
|
tag2 = TagFactory()
|
||||||
doc = DocumentFactory(title="shared", owner=user)
|
doc = DocumentFactory(title="shared", owner=user)
|
||||||
doc.tags.add(tag1, tag2)
|
doc.tags.add(tag1, tag2)
|
||||||
assign_perm("view_document", group, doc)
|
grant_object(group, doc, "view_document")
|
||||||
|
|
||||||
self.client.force_authenticate(user=user)
|
self.client.force_authenticate(user=user)
|
||||||
response = self.client.get(
|
response = self.client.get(
|
||||||
@@ -1452,11 +1453,9 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
|||||||
THEN:
|
THEN:
|
||||||
- The document does not appear in their results
|
- The document does not appear in their results
|
||||||
"""
|
"""
|
||||||
owner = User.objects.create_user("owner1")
|
owner = UserFactory(username="owner1")
|
||||||
stranger = User.objects.create_user("stranger1")
|
stranger = UserFactory(username="stranger1")
|
||||||
stranger.user_permissions.add(
|
grant_global(stranger, "view_document")
|
||||||
*Permission.objects.filter(codename="view_document"),
|
|
||||||
)
|
|
||||||
|
|
||||||
DocumentFactory(title="private", owner=owner)
|
DocumentFactory(title="private", owner=owner)
|
||||||
|
|
||||||
@@ -1474,17 +1473,17 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
|||||||
THEN:
|
THEN:
|
||||||
- Only the group member sees the document
|
- Only the group member sees the document
|
||||||
"""
|
"""
|
||||||
owner = User.objects.create_user("owner2")
|
owner = UserFactory(username="owner2")
|
||||||
member = User.objects.create_user("member1")
|
member = UserFactory(username="member1")
|
||||||
non_member = User.objects.create_user("nonmember1")
|
non_member = UserFactory(username="nonmember1")
|
||||||
for u in (member, non_member):
|
for u in (member, non_member):
|
||||||
u.user_permissions.add(*Permission.objects.filter(codename="view_document"))
|
grant_global(u, "view_document")
|
||||||
|
|
||||||
group = Group.objects.create(name="group2")
|
group = Group.objects.create(name="group2")
|
||||||
member.groups.add(group)
|
member.groups.add(group)
|
||||||
|
|
||||||
doc = DocumentFactory(title="shared2", owner=owner)
|
doc = DocumentFactory(title="shared2", owner=owner)
|
||||||
assign_perm("view_document", group, doc)
|
grant_object(group, doc, "view_document")
|
||||||
|
|
||||||
self.client.force_authenticate(user=member)
|
self.client.force_authenticate(user=member)
|
||||||
response = self.client.get("/api/documents/")
|
response = self.client.get("/api/documents/")
|
||||||
@@ -1785,8 +1784,8 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
|||||||
THEN:
|
THEN:
|
||||||
- Statistics only include inbox counts for tags accessible by the user
|
- Statistics only include inbox counts for tags accessible by the user
|
||||||
"""
|
"""
|
||||||
u1 = User.objects.create_user("user1")
|
u1 = UserFactory(username="user1")
|
||||||
u2 = User.objects.create_user("user2")
|
u2 = UserFactory(username="user2")
|
||||||
inbox_tag_u1 = Tag.objects.create(name="inbox_u1", is_inbox_tag=True, owner=u1)
|
inbox_tag_u1 = Tag.objects.create(name="inbox_u1", is_inbox_tag=True, owner=u1)
|
||||||
Tag.objects.create(name="inbox_u2", is_inbox_tag=True, owner=u2)
|
Tag.objects.create(name="inbox_u2", is_inbox_tag=True, owner=u2)
|
||||||
doc_u1 = Document.objects.create(
|
doc_u1 = Document.objects.create(
|
||||||
@@ -1816,11 +1815,9 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
|||||||
self.assertEqual(response.data["documents_inbox"], 0)
|
self.assertEqual(response.data["documents_inbox"], 0)
|
||||||
|
|
||||||
def test_statistics_with_statistics_permission(self) -> None:
|
def test_statistics_with_statistics_permission(self) -> None:
|
||||||
owner = User.objects.create_user("owner")
|
owner = UserFactory(username="owner")
|
||||||
stats_user = User.objects.create_user("stats-user")
|
stats_user = UserFactory(username="stats-user")
|
||||||
stats_user.user_permissions.add(
|
grant_global(stats_user, "view_global_statistics")
|
||||||
Permission.objects.get(codename="view_global_statistics"),
|
|
||||||
)
|
|
||||||
|
|
||||||
inbox_tag = Tag.objects.create(
|
inbox_tag = Tag.objects.create(
|
||||||
name="stats_inbox",
|
name="stats_inbox",
|
||||||
@@ -1986,7 +1983,7 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
|||||||
self.assertEqual(response.status_code, status.HTTP_405_METHOD_NOT_ALLOWED)
|
self.assertEqual(response.status_code, status.HTTP_405_METHOD_NOT_ALLOWED)
|
||||||
|
|
||||||
def test_upload_insufficient_permissions(self) -> None:
|
def test_upload_insufficient_permissions(self) -> None:
|
||||||
self.client.force_authenticate(user=User.objects.create_user("testuser2"))
|
self.client.force_authenticate(user=UserFactory(username="testuser2"))
|
||||||
|
|
||||||
with (Path(__file__).parent / "samples" / "simple.pdf").open("rb") as f:
|
with (Path(__file__).parent / "samples" / "simple.pdf").open("rb") as f:
|
||||||
response = self.client.post(
|
response = self.client.post(
|
||||||
@@ -2782,9 +2779,9 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
|||||||
mock_get_date_parser.assert_not_called()
|
mock_get_date_parser.assert_not_called()
|
||||||
|
|
||||||
def test_saved_views(self) -> None:
|
def test_saved_views(self) -> None:
|
||||||
u1 = User.objects.create_user("user1")
|
u1 = UserFactory(username="user1")
|
||||||
u2 = User.objects.create_user("user2")
|
u2 = UserFactory(username="user2")
|
||||||
u3 = User.objects.create_user("user3")
|
u3 = UserFactory(username="user3")
|
||||||
|
|
||||||
view_perm = Permission.objects.get(codename="view_savedview")
|
view_perm = Permission.objects.get(codename="view_savedview")
|
||||||
change_perm = Permission.objects.get(codename="change_savedview")
|
change_perm = Permission.objects.get(codename="change_savedview")
|
||||||
@@ -2807,9 +2804,9 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
|||||||
sort_field="",
|
sort_field="",
|
||||||
)
|
)
|
||||||
|
|
||||||
assign_perm("view_savedview", u1, v2)
|
grant_object(u1, v2, "view_savedview")
|
||||||
assign_perm("change_savedview", u1, v2)
|
grant_object(u1, v2, "change_savedview")
|
||||||
assign_perm("view_savedview", u1, v3)
|
grant_object(u1, v3, "view_savedview")
|
||||||
|
|
||||||
self.client.force_authenticate(user=u1)
|
self.client.force_authenticate(user=u1)
|
||||||
|
|
||||||
@@ -3064,7 +3061,7 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
|||||||
self.assertListEqual(saved_view_settings["sidebar_views_visible_ids"], [v2.id])
|
self.assertListEqual(saved_view_settings["sidebar_views_visible_ids"], [v2.id])
|
||||||
|
|
||||||
def test_saved_view_create_update_patch(self) -> None:
|
def test_saved_view_create_update_patch(self) -> None:
|
||||||
User.objects.create_user("user1")
|
UserFactory(username="user1")
|
||||||
|
|
||||||
view = {
|
view = {
|
||||||
"name": "test",
|
"name": "test",
|
||||||
@@ -3127,7 +3124,7 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
|||||||
- Display options are updated
|
- Display options are updated
|
||||||
- Display fields are validated
|
- Display fields are validated
|
||||||
"""
|
"""
|
||||||
User.objects.create_user("user1")
|
UserFactory(username="user1")
|
||||||
|
|
||||||
view = {
|
view = {
|
||||||
"name": "test",
|
"name": "test",
|
||||||
@@ -3568,11 +3565,11 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
|||||||
THEN:
|
THEN:
|
||||||
- Notes are neither created nor deleted
|
- Notes are neither created nor deleted
|
||||||
"""
|
"""
|
||||||
user1 = User.objects.create_user(username="test1")
|
user1 = UserFactory(username="test1")
|
||||||
user1.user_permissions.add(*Permission.objects.all())
|
grant_all_global(user1)
|
||||||
user1.save()
|
user1.save()
|
||||||
|
|
||||||
user2 = User.objects.create_user(username="test2")
|
user2 = UserFactory(username="test2")
|
||||||
user2.save()
|
user2.save()
|
||||||
|
|
||||||
doc = Document.objects.create(
|
doc = Document.objects.create(
|
||||||
@@ -3592,7 +3589,7 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
|||||||
self.assertEqual(resp.content, b"Insufficient permissions to view notes")
|
self.assertEqual(resp.content, b"Insufficient permissions to view notes")
|
||||||
self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN)
|
self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN)
|
||||||
|
|
||||||
assign_perm("view_document", user1, doc)
|
grant_object(user1, doc, "view_document")
|
||||||
|
|
||||||
resp = self.client.post(
|
resp = self.client.post(
|
||||||
f"/api/documents/{doc.pk}/notes/",
|
f"/api/documents/{doc.pk}/notes/",
|
||||||
@@ -3616,12 +3613,8 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
|||||||
self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN)
|
self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN)
|
||||||
|
|
||||||
def test_notes_require_global_document_permissions(self) -> None:
|
def test_notes_require_global_document_permissions(self) -> None:
|
||||||
user = User.objects.create_user(username="note_editor")
|
user = UserFactory(username="note_editor")
|
||||||
user.user_permissions.add(
|
grant_global(user, "view_note", "add_note", "delete_note")
|
||||||
*Permission.objects.filter(
|
|
||||||
codename__in=["view_note", "add_note", "delete_note"],
|
|
||||||
),
|
|
||||||
)
|
|
||||||
doc = Document.objects.create(
|
doc = Document.objects.create(
|
||||||
title="test",
|
title="test",
|
||||||
mime_type="application/pdf",
|
mime_type="application/pdf",
|
||||||
@@ -3634,9 +3627,7 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
|||||||
response = self.client.get(f"/api/documents/{doc.pk}/notes/")
|
response = self.client.get(f"/api/documents/{doc.pk}/notes/")
|
||||||
self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN)
|
self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN)
|
||||||
|
|
||||||
user.user_permissions.add(
|
grant_global(user, "view_document")
|
||||||
Permission.objects.get(codename="view_document"),
|
|
||||||
)
|
|
||||||
user = User.objects.get(pk=user.pk)
|
user = User.objects.get(pk=user.pk)
|
||||||
self.client.force_authenticate(user)
|
self.client.force_authenticate(user)
|
||||||
response = self.client.get(f"/api/documents/{doc.pk}/notes/")
|
response = self.client.get(f"/api/documents/{doc.pk}/notes/")
|
||||||
@@ -3648,9 +3639,7 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
|||||||
)
|
)
|
||||||
self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN)
|
self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN)
|
||||||
|
|
||||||
user.user_permissions.add(
|
grant_global(user, "change_document")
|
||||||
Permission.objects.get(codename="change_document"),
|
|
||||||
)
|
|
||||||
user = User.objects.get(pk=user.pk)
|
user = User.objects.get(pk=user.pk)
|
||||||
self.client.force_authenticate(user)
|
self.client.force_authenticate(user)
|
||||||
response = self.client.post(
|
response = self.client.post(
|
||||||
@@ -3797,12 +3786,12 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
|||||||
- Unique items are created
|
- Unique items are created
|
||||||
- Non-unique items are not allowed
|
- Non-unique items are not allowed
|
||||||
"""
|
"""
|
||||||
user1 = User.objects.create_user(username="test1")
|
user1 = UserFactory(username="test1")
|
||||||
user1.user_permissions.add(*Permission.objects.filter(codename="add_tag"))
|
grant_global(user1, "add_tag")
|
||||||
user1.save()
|
user1.save()
|
||||||
|
|
||||||
user2 = User.objects.create_user(username="test2")
|
user2 = UserFactory(username="test2")
|
||||||
user2.user_permissions.add(*Permission.objects.filter(codename="add_tag"))
|
grant_global(user2, "add_tag")
|
||||||
user2.save()
|
user2.save()
|
||||||
|
|
||||||
# User 1 creates tag 1 owned by user 1 by default
|
# User 1 creates tag 1 owned by user 1 by default
|
||||||
@@ -3857,12 +3846,12 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
|||||||
- Unique items are created
|
- Unique items are created
|
||||||
- Non-unique items are not allowed on update
|
- Non-unique items are not allowed on update
|
||||||
"""
|
"""
|
||||||
user1 = User.objects.create_user(username="test1")
|
user1 = UserFactory(username="test1")
|
||||||
user1.user_permissions.add(*Permission.objects.filter(codename="change_tag"))
|
grant_global(user1, "change_tag")
|
||||||
user1.save()
|
user1.save()
|
||||||
|
|
||||||
user2 = User.objects.create_user(username="test2")
|
user2 = UserFactory(username="test2")
|
||||||
user2.user_permissions.add(*Permission.objects.filter(codename="change_tag"))
|
grant_global(user2, "change_tag")
|
||||||
user2.save()
|
user2.save()
|
||||||
|
|
||||||
# Create name tag 1 owned by user 1
|
# Create name tag 1 owned by user 1
|
||||||
@@ -3993,11 +3982,11 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
|||||||
THEN:
|
THEN:
|
||||||
- Links only shown if user has permissions
|
- Links only shown if user has permissions
|
||||||
"""
|
"""
|
||||||
user1 = User.objects.create_user(username="test1")
|
user1 = UserFactory(username="test1")
|
||||||
user1.user_permissions.add(*Permission.objects.all())
|
grant_all_global(user1)
|
||||||
user1.save()
|
user1.save()
|
||||||
|
|
||||||
user2 = User.objects.create_user(username="test2")
|
user2 = UserFactory(username="test2")
|
||||||
user2.save()
|
user2.save()
|
||||||
|
|
||||||
doc = Document.objects.create(
|
doc = Document.objects.create(
|
||||||
@@ -4017,7 +4006,7 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
|||||||
self.assertEqual(resp.content, b"Insufficient permissions to add share link")
|
self.assertEqual(resp.content, b"Insufficient permissions to add share link")
|
||||||
self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN)
|
self.assertEqual(resp.status_code, status.HTTP_403_FORBIDDEN)
|
||||||
|
|
||||||
assign_perm("change_document", user1, doc)
|
grant_object(user1, doc, "change_document")
|
||||||
|
|
||||||
resp = self.client.get(
|
resp = self.client.get(
|
||||||
f"/api/documents/{doc.pk}/share_links/",
|
f"/api/documents/{doc.pk}/share_links/",
|
||||||
@@ -4034,11 +4023,11 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
|||||||
THEN:
|
THEN:
|
||||||
- Share link creation is denied until view permission is granted
|
- Share link creation is denied until view permission is granted
|
||||||
"""
|
"""
|
||||||
user1 = User.objects.create_user(username="test1")
|
user1 = UserFactory(username="test1")
|
||||||
user1.user_permissions.add(*Permission.objects.filter(codename="add_sharelink"))
|
grant_global(user1, "add_sharelink")
|
||||||
user1.save()
|
user1.save()
|
||||||
|
|
||||||
user2 = User.objects.create_user(username="test2")
|
user2 = UserFactory(username="test2")
|
||||||
user2.save()
|
user2.save()
|
||||||
|
|
||||||
doc = Document.objects.create(
|
doc = Document.objects.create(
|
||||||
@@ -4060,7 +4049,7 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
|||||||
)
|
)
|
||||||
self.assertEqual(create_resp.status_code, status.HTTP_403_FORBIDDEN)
|
self.assertEqual(create_resp.status_code, status.HTTP_403_FORBIDDEN)
|
||||||
|
|
||||||
assign_perm("view_document", user1, doc)
|
grant_object(user1, doc, "view_document")
|
||||||
|
|
||||||
create_resp = self.client.post(
|
create_resp = self.client.post(
|
||||||
"/api/share_links/",
|
"/api/share_links/",
|
||||||
@@ -4072,9 +4061,7 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
|||||||
)
|
)
|
||||||
self.assertEqual(create_resp.status_code, status.HTTP_403_FORBIDDEN)
|
self.assertEqual(create_resp.status_code, status.HTTP_403_FORBIDDEN)
|
||||||
|
|
||||||
user1.user_permissions.add(
|
grant_global(user1, "view_document")
|
||||||
Permission.objects.get(codename="view_document"),
|
|
||||||
)
|
|
||||||
user1 = User.objects.get(pk=user1.pk)
|
user1 = User.objects.get(pk=user1.pk)
|
||||||
self.client.force_authenticate(user1)
|
self.client.force_authenticate(user1)
|
||||||
create_resp = self.client.post(
|
create_resp = self.client.post(
|
||||||
@@ -4097,11 +4084,11 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
|||||||
THEN:
|
THEN:
|
||||||
- ASN +1 from user2's doc is returned for user1
|
- ASN +1 from user2's doc is returned for user1
|
||||||
"""
|
"""
|
||||||
user1 = User.objects.create_user(username="test1")
|
user1 = UserFactory(username="test1")
|
||||||
user1.user_permissions.add(*Permission.objects.all())
|
grant_all_global(user1)
|
||||||
user1.save()
|
user1.save()
|
||||||
|
|
||||||
user2 = User.objects.create_user(username="test2")
|
user2 = UserFactory(username="test2")
|
||||||
user2.save()
|
user2.save()
|
||||||
|
|
||||||
doc1 = Document.objects.create(
|
doc1 = Document.objects.create(
|
||||||
@@ -4141,8 +4128,8 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
|||||||
THEN:
|
THEN:
|
||||||
- ASN 1 is returned
|
- ASN 1 is returned
|
||||||
"""
|
"""
|
||||||
user1 = User.objects.create_user(username="test1")
|
user1 = UserFactory(username="test1")
|
||||||
user1.user_permissions.add(*Permission.objects.all())
|
grant_all_global(user1)
|
||||||
user1.save()
|
user1.save()
|
||||||
|
|
||||||
doc1 = Document.objects.create(
|
doc1 = Document.objects.create(
|
||||||
@@ -4170,7 +4157,7 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
|||||||
THEN:
|
THEN:
|
||||||
- Explicit error is returned
|
- Explicit error is returned
|
||||||
"""
|
"""
|
||||||
user1 = User.objects.create_superuser(username="test1")
|
user1 = UserFactory(username="test1", superuser=True)
|
||||||
|
|
||||||
self.client.force_authenticate(user1)
|
self.client.force_authenticate(user1)
|
||||||
|
|
||||||
@@ -4348,8 +4335,8 @@ class TestDocumentApi(DirectoriesMixin, ConsumeTaskMixin, APITestCase):
|
|||||||
THEN:
|
THEN:
|
||||||
- Error response is returned
|
- Error response is returned
|
||||||
"""
|
"""
|
||||||
user1 = User.objects.create_user(username="test1")
|
user1 = UserFactory(username="test1")
|
||||||
user1.user_permissions.add(*Permission.objects.all())
|
grant_all_global(user1)
|
||||||
user1.save()
|
user1.save()
|
||||||
|
|
||||||
doc = Document.objects.create(
|
doc = Document.objects.create(
|
||||||
@@ -4454,7 +4441,7 @@ class TestDocumentApiTagColors(DirectoriesMixin, APITestCase):
|
|||||||
def setUp(self) -> None:
|
def setUp(self) -> None:
|
||||||
super().setUp()
|
super().setUp()
|
||||||
|
|
||||||
self.user = User.objects.create_superuser(username="temp_admin")
|
self.user = UserFactory(username="temp_admin", superuser=True)
|
||||||
|
|
||||||
self.client.force_authenticate(user=self.user)
|
self.client.force_authenticate(user=self.user)
|
||||||
|
|
||||||
@@ -4534,7 +4521,7 @@ class TestDocumentApiCustomFieldsSorting(DirectoriesMixin, APITestCase):
|
|||||||
def setUp(self) -> None:
|
def setUp(self) -> None:
|
||||||
super().setUp()
|
super().setUp()
|
||||||
|
|
||||||
self.user = User.objects.create_superuser(username="temp_admin")
|
self.user = UserFactory(username="temp_admin", superuser=True)
|
||||||
self.client.force_authenticate(user=self.user)
|
self.client.force_authenticate(user=self.user)
|
||||||
|
|
||||||
self.doc1 = Document.objects.create(
|
self.doc1 = Document.objects.create(
|
||||||
|
|||||||
@@ -2,16 +2,16 @@ import json
|
|||||||
import shutil
|
import shutil
|
||||||
from unittest import mock
|
from unittest import mock
|
||||||
|
|
||||||
from django.contrib.auth.models import Permission
|
|
||||||
from django.contrib.auth.models import User
|
|
||||||
from django.core import mail
|
from django.core import mail
|
||||||
from django.test import override_settings
|
from django.test import override_settings
|
||||||
from rest_framework import status
|
from rest_framework import status
|
||||||
from rest_framework.test import APITestCase
|
from rest_framework.test import APITestCase
|
||||||
|
|
||||||
from documents.models import Document
|
from documents.models import Document
|
||||||
from documents.tests.utils import DirectoriesMixin
|
|
||||||
from documents.tests.utils import SampleDirMixin
|
from documents.tests.utils import SampleDirMixin
|
||||||
|
from paperless_testing.dirs import DirectoriesMixin
|
||||||
|
from paperless_testing.factories import UserFactory
|
||||||
|
from paperless_testing.permissions import grant_global
|
||||||
|
|
||||||
|
|
||||||
class TestEmail(DirectoriesMixin, SampleDirMixin, APITestCase):
|
class TestEmail(DirectoriesMixin, SampleDirMixin, APITestCase):
|
||||||
@@ -20,7 +20,7 @@ class TestEmail(DirectoriesMixin, SampleDirMixin, APITestCase):
|
|||||||
def setUp(self) -> None:
|
def setUp(self) -> None:
|
||||||
super().setUp()
|
super().setUp()
|
||||||
|
|
||||||
self.user = User.objects.create_superuser(username="temp_admin")
|
self.user = UserFactory(username="temp_admin", superuser=True)
|
||||||
self.client.force_authenticate(user=self.user)
|
self.client.force_authenticate(user=self.user)
|
||||||
|
|
||||||
self.doc1 = Document.objects.create(
|
self.doc1 = Document.objects.create(
|
||||||
@@ -303,8 +303,8 @@ class TestEmail(DirectoriesMixin, SampleDirMixin, APITestCase):
|
|||||||
THEN:
|
THEN:
|
||||||
- Forbidden response is returned
|
- Forbidden response is returned
|
||||||
"""
|
"""
|
||||||
user1 = User.objects.create_user(username="test1")
|
user1 = UserFactory(username="test1")
|
||||||
user1.user_permissions.add(*Permission.objects.filter(codename="view_document"))
|
grant_global(user1, "view_document")
|
||||||
|
|
||||||
doc_owned = Document.objects.create(
|
doc_owned = Document.objects.create(
|
||||||
title="owned_doc",
|
title="owned_doc",
|
||||||
@@ -338,8 +338,8 @@ class TestEmail(DirectoriesMixin, SampleDirMixin, APITestCase):
|
|||||||
THEN:
|
THEN:
|
||||||
- Request succeeds
|
- Request succeeds
|
||||||
"""
|
"""
|
||||||
user1 = User.objects.create_user(username="test1")
|
user1 = UserFactory(username="test1")
|
||||||
user1.user_permissions.add(*Permission.objects.filter(codename="view_document"))
|
grant_global(user1, "view_document")
|
||||||
|
|
||||||
self.client.force_authenticate(user1)
|
self.client.force_authenticate(user1)
|
||||||
|
|
||||||
|
|||||||
@@ -4,7 +4,6 @@ from collections.abc import Callable
|
|||||||
from datetime import date
|
from datetime import date
|
||||||
from urllib.parse import quote
|
from urllib.parse import quote
|
||||||
|
|
||||||
from django.contrib.auth.models import User
|
|
||||||
from rest_framework.test import APITestCase
|
from rest_framework.test import APITestCase
|
||||||
|
|
||||||
from documents.models import CustomField
|
from documents.models import CustomField
|
||||||
@@ -13,7 +12,8 @@ from documents.models import Document
|
|||||||
from documents.models import SavedView
|
from documents.models import SavedView
|
||||||
from documents.models import SavedViewFilterRule
|
from documents.models import SavedViewFilterRule
|
||||||
from documents.serialisers import DocumentSerializer
|
from documents.serialisers import DocumentSerializer
|
||||||
from documents.tests.utils import DirectoriesMixin
|
from paperless_testing.dirs import DirectoriesMixin
|
||||||
|
from paperless_testing.factories import UserFactory
|
||||||
|
|
||||||
|
|
||||||
class DocumentWrapper:
|
class DocumentWrapper:
|
||||||
@@ -35,7 +35,7 @@ class TestCustomFieldsSearch(DirectoriesMixin, APITestCase):
|
|||||||
def setUp(self) -> None:
|
def setUp(self) -> None:
|
||||||
super().setUp()
|
super().setUp()
|
||||||
|
|
||||||
self.user = User.objects.create_superuser(username="temp_admin")
|
self.user = UserFactory(username="temp_admin", superuser=True)
|
||||||
self.client.force_authenticate(user=self.user)
|
self.client.force_authenticate(user=self.user)
|
||||||
|
|
||||||
# Create one custom field per type. The fields are called f"{type}_field".
|
# Create one custom field per type. The fields are called f"{type}_field".
|
||||||
|
|||||||
@@ -3,12 +3,10 @@ import json
|
|||||||
from unittest import mock
|
from unittest import mock
|
||||||
|
|
||||||
from django.contrib.auth.models import Group
|
from django.contrib.auth.models import Group
|
||||||
from django.contrib.auth.models import Permission
|
|
||||||
from django.contrib.auth.models import User
|
from django.contrib.auth.models import User
|
||||||
from django.db import connection
|
from django.db import connection
|
||||||
from django.test import override_settings
|
from django.test import override_settings
|
||||||
from django.test.utils import CaptureQueriesContext
|
from django.test.utils import CaptureQueriesContext
|
||||||
from guardian.shortcuts import assign_perm
|
|
||||||
from guardian.shortcuts import get_groups_with_perms
|
from guardian.shortcuts import get_groups_with_perms
|
||||||
from guardian.shortcuts import get_users_with_perms
|
from guardian.shortcuts import get_users_with_perms
|
||||||
from rest_framework import status
|
from rest_framework import status
|
||||||
@@ -21,14 +19,17 @@ from documents.models import Document
|
|||||||
from documents.models import DocumentType
|
from documents.models import DocumentType
|
||||||
from documents.models import StoragePath
|
from documents.models import StoragePath
|
||||||
from documents.models import Tag
|
from documents.models import Tag
|
||||||
from documents.tests.utils import DirectoriesMixin
|
from paperless_testing.dirs import DirectoriesMixin
|
||||||
|
from paperless_testing.factories import UserFactory
|
||||||
|
from paperless_testing.permissions import grant_global
|
||||||
|
from paperless_testing.permissions import grant_object
|
||||||
|
|
||||||
|
|
||||||
class TestApiObjects(DirectoriesMixin, APITestCase):
|
class TestApiObjects(DirectoriesMixin, APITestCase):
|
||||||
def setUp(self) -> None:
|
def setUp(self) -> None:
|
||||||
super().setUp()
|
super().setUp()
|
||||||
|
|
||||||
user = User.objects.create_superuser(username="temp_admin")
|
user = UserFactory(username="temp_admin", superuser=True)
|
||||||
self.client.force_authenticate(user=user)
|
self.client.force_authenticate(user=user)
|
||||||
|
|
||||||
self.tag1 = Tag.objects.create(name="t1", is_inbox_tag=True)
|
self.tag1 = Tag.objects.create(name="t1", is_inbox_tag=True)
|
||||||
@@ -153,7 +154,7 @@ class TestApiObjects(DirectoriesMixin, APITestCase):
|
|||||||
|
|
||||||
# A newer document owned by another user must not leak through the
|
# A newer document owned by another user must not leak through the
|
||||||
# aggregate for a non-superuser who cannot view it
|
# aggregate for a non-superuser who cannot view it
|
||||||
other = User.objects.create_user(username="other")
|
other = UserFactory(username="other")
|
||||||
Document.objects.create(
|
Document.objects.create(
|
||||||
mime_type="application/pdf",
|
mime_type="application/pdf",
|
||||||
correspondent=self.c1,
|
correspondent=self.c1,
|
||||||
@@ -162,10 +163,8 @@ class TestApiObjects(DirectoriesMixin, APITestCase):
|
|||||||
owner=other,
|
owner=other,
|
||||||
)
|
)
|
||||||
|
|
||||||
user = User.objects.create_user(username="regular")
|
user = UserFactory(username="regular")
|
||||||
user.user_permissions.add(
|
grant_global(user, "view_correspondent")
|
||||||
Permission.objects.get(codename="view_correspondent"),
|
|
||||||
)
|
|
||||||
self.client.force_authenticate(user=user)
|
self.client.force_authenticate(user=user)
|
||||||
|
|
||||||
response = self.client.get("/api/correspondents/?last_correspondence=true")
|
response = self.client.get("/api/correspondents/?last_correspondence=true")
|
||||||
@@ -200,7 +199,7 @@ class TestApiStoragePaths(DirectoriesMixin, APITestCase):
|
|||||||
def setUp(self) -> None:
|
def setUp(self) -> None:
|
||||||
super().setUp()
|
super().setUp()
|
||||||
|
|
||||||
user = User.objects.create_superuser(username="temp_admin")
|
user = UserFactory(username="temp_admin", superuser=True)
|
||||||
self.client.force_authenticate(user=user)
|
self.client.force_authenticate(user=user)
|
||||||
|
|
||||||
self.sp1 = StoragePath.objects.create(name="sp1", path="Something/{checksum}")
|
self.sp1 = StoragePath.objects.create(name="sp1", path="Something/{checksum}")
|
||||||
@@ -455,11 +454,9 @@ class TestApiStoragePaths(DirectoriesMixin, APITestCase):
|
|||||||
self.assertEqual(response.data, "folder/Something.pdf")
|
self.assertEqual(response.data, "folder/Something.pdf")
|
||||||
|
|
||||||
def test_test_storage_path_requires_document_view_permission(self) -> None:
|
def test_test_storage_path_requires_document_view_permission(self) -> None:
|
||||||
owner = User.objects.create_user(username="owner")
|
owner = UserFactory(username="owner")
|
||||||
unprivileged = User.objects.create_user(username="unprivileged")
|
unprivileged = UserFactory(username="unprivileged")
|
||||||
unprivileged.user_permissions.add(
|
grant_global(unprivileged, "view_document")
|
||||||
Permission.objects.get(codename="view_document"),
|
|
||||||
)
|
|
||||||
document = Document.objects.create(
|
document = Document.objects.create(
|
||||||
mime_type="application/pdf",
|
mime_type="application/pdf",
|
||||||
owner=owner,
|
owner=owner,
|
||||||
@@ -481,15 +478,15 @@ class TestApiStoragePaths(DirectoriesMixin, APITestCase):
|
|||||||
self.assertIn("document", response.data)
|
self.assertIn("document", response.data)
|
||||||
|
|
||||||
def test_test_storage_path_allows_shared_document_view_permission(self) -> None:
|
def test_test_storage_path_allows_shared_document_view_permission(self) -> None:
|
||||||
owner = User.objects.create_user(username="owner")
|
owner = UserFactory(username="owner")
|
||||||
viewer = User.objects.create_user(username="viewer")
|
viewer = UserFactory(username="viewer")
|
||||||
document = Document.objects.create(
|
document = Document.objects.create(
|
||||||
mime_type="application/pdf",
|
mime_type="application/pdf",
|
||||||
owner=owner,
|
owner=owner,
|
||||||
title="Shared",
|
title="Shared",
|
||||||
checksum="123",
|
checksum="123",
|
||||||
)
|
)
|
||||||
assign_perm("view_document", viewer, document)
|
grant_object(viewer, document, "view_document")
|
||||||
|
|
||||||
self.client.force_authenticate(user=viewer)
|
self.client.force_authenticate(user=viewer)
|
||||||
response = self.client.post(
|
response = self.client.post(
|
||||||
@@ -504,9 +501,7 @@ class TestApiStoragePaths(DirectoriesMixin, APITestCase):
|
|||||||
)
|
)
|
||||||
self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN)
|
self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN)
|
||||||
|
|
||||||
viewer.user_permissions.add(
|
grant_global(viewer, "view_document")
|
||||||
Permission.objects.get(codename="view_document"),
|
|
||||||
)
|
|
||||||
viewer = User.objects.get(pk=viewer.pk)
|
viewer = User.objects.get(pk=viewer.pk)
|
||||||
self.client.force_authenticate(user=viewer)
|
self.client.force_authenticate(user=viewer)
|
||||||
response = self.client.post(
|
response = self.client.post(
|
||||||
@@ -545,14 +540,12 @@ class TestApiStoragePaths(DirectoriesMixin, APITestCase):
|
|||||||
def test_test_storage_path_exposes_basic_document_context_but_not_sensitive_owner_data(
|
def test_test_storage_path_exposes_basic_document_context_but_not_sensitive_owner_data(
|
||||||
self,
|
self,
|
||||||
) -> None:
|
) -> None:
|
||||||
owner = User.objects.create_user(
|
owner = UserFactory(
|
||||||
username="owner",
|
username="owner",
|
||||||
password="password",
|
password="password",
|
||||||
email="owner@example.com",
|
email="owner@example.com",
|
||||||
)
|
)
|
||||||
owner.user_permissions.add(
|
grant_global(owner, "view_document")
|
||||||
Permission.objects.get(codename="view_document"),
|
|
||||||
)
|
|
||||||
document = Document.objects.create(
|
document = Document.objects.create(
|
||||||
mime_type="application/pdf",
|
mime_type="application/pdf",
|
||||||
owner=owner,
|
owner=owner,
|
||||||
@@ -614,8 +607,8 @@ class TestApiStoragePaths(DirectoriesMixin, APITestCase):
|
|||||||
def test_test_storage_path_includes_related_objects_for_visible_document(
|
def test_test_storage_path_includes_related_objects_for_visible_document(
|
||||||
self,
|
self,
|
||||||
) -> None:
|
) -> None:
|
||||||
owner = User.objects.create_user(username="owner")
|
owner = UserFactory(username="owner")
|
||||||
viewer = User.objects.create_user(username="viewer")
|
viewer = UserFactory(username="viewer")
|
||||||
private_correspondent = Correspondent.objects.create(
|
private_correspondent = Correspondent.objects.create(
|
||||||
name="Private Correspondent",
|
name="Private Correspondent",
|
||||||
owner=owner,
|
owner=owner,
|
||||||
@@ -627,10 +620,8 @@ class TestApiStoragePaths(DirectoriesMixin, APITestCase):
|
|||||||
title="Document",
|
title="Document",
|
||||||
checksum="123",
|
checksum="123",
|
||||||
)
|
)
|
||||||
assign_perm("view_document", viewer, document)
|
grant_object(viewer, document, "view_document")
|
||||||
viewer.user_permissions.add(
|
grant_global(viewer, "view_document")
|
||||||
Permission.objects.get(codename="view_document"),
|
|
||||||
)
|
|
||||||
|
|
||||||
self.client.force_authenticate(user=viewer)
|
self.client.force_authenticate(user=viewer)
|
||||||
response = self.client.post(
|
response = self.client.post(
|
||||||
@@ -662,7 +653,7 @@ class TestApiStoragePaths(DirectoriesMixin, APITestCase):
|
|||||||
self.assertEqual(response.data, "Private Correspondent.pdf")
|
self.assertEqual(response.data, "Private Correspondent.pdf")
|
||||||
|
|
||||||
def test_test_storage_path_superuser_can_view_private_related_objects(self) -> None:
|
def test_test_storage_path_superuser_can_view_private_related_objects(self) -> None:
|
||||||
owner = User.objects.create_user(username="owner")
|
owner = UserFactory(username="owner")
|
||||||
private_correspondent = Correspondent.objects.create(
|
private_correspondent = Correspondent.objects.create(
|
||||||
name="Private Correspondent",
|
name="Private Correspondent",
|
||||||
owner=owner,
|
owner=owner,
|
||||||
@@ -693,8 +684,8 @@ class TestApiStoragePaths(DirectoriesMixin, APITestCase):
|
|||||||
def test_test_storage_path_includes_doc_type_storage_path_and_tags(
|
def test_test_storage_path_includes_doc_type_storage_path_and_tags(
|
||||||
self,
|
self,
|
||||||
) -> None:
|
) -> None:
|
||||||
owner = User.objects.create_user(username="owner")
|
owner = UserFactory(username="owner")
|
||||||
viewer = User.objects.create_user(username="viewer")
|
viewer = UserFactory(username="viewer")
|
||||||
private_document_type = DocumentType.objects.create(
|
private_document_type = DocumentType.objects.create(
|
||||||
name="Private Type",
|
name="Private Type",
|
||||||
owner=owner,
|
owner=owner,
|
||||||
@@ -717,10 +708,8 @@ class TestApiStoragePaths(DirectoriesMixin, APITestCase):
|
|||||||
checksum="123",
|
checksum="123",
|
||||||
)
|
)
|
||||||
document.tags.add(private_tag)
|
document.tags.add(private_tag)
|
||||||
assign_perm("view_document", viewer, document)
|
grant_object(viewer, document, "view_document")
|
||||||
viewer.user_permissions.add(
|
grant_global(viewer, "view_document")
|
||||||
Permission.objects.get(codename="view_document"),
|
|
||||||
)
|
|
||||||
|
|
||||||
self.client.force_authenticate(user=viewer)
|
self.client.force_authenticate(user=viewer)
|
||||||
response = self.client.post(
|
response = self.client.post(
|
||||||
@@ -756,8 +745,8 @@ class TestApiStoragePaths(DirectoriesMixin, APITestCase):
|
|||||||
def test_test_storage_path_includes_custom_fields_for_visible_document(
|
def test_test_storage_path_includes_custom_fields_for_visible_document(
|
||||||
self,
|
self,
|
||||||
) -> None:
|
) -> None:
|
||||||
owner = User.objects.create_user(username="owner")
|
owner = UserFactory(username="owner")
|
||||||
viewer = User.objects.create_user(username="viewer")
|
viewer = UserFactory(username="viewer")
|
||||||
document = Document.objects.create(
|
document = Document.objects.create(
|
||||||
mime_type="application/pdf",
|
mime_type="application/pdf",
|
||||||
owner=owner,
|
owner=owner,
|
||||||
@@ -773,10 +762,8 @@ class TestApiStoragePaths(DirectoriesMixin, APITestCase):
|
|||||||
field=custom_field,
|
field=custom_field,
|
||||||
value_int=42,
|
value_int=42,
|
||||||
)
|
)
|
||||||
assign_perm("view_document", viewer, document)
|
grant_object(viewer, document, "view_document")
|
||||||
viewer.user_permissions.add(
|
grant_global(viewer, "view_document")
|
||||||
Permission.objects.get(codename="view_document"),
|
|
||||||
)
|
|
||||||
|
|
||||||
self.client.force_authenticate(user=viewer)
|
self.client.force_authenticate(user=viewer)
|
||||||
response = self.client.post(
|
response = self.client.post(
|
||||||
@@ -798,7 +785,7 @@ class TestBulkEditObjects(APITestCase):
|
|||||||
def setUp(self) -> None:
|
def setUp(self) -> None:
|
||||||
super().setUp()
|
super().setUp()
|
||||||
|
|
||||||
self.temp_admin = User.objects.create_superuser(username="temp_admin")
|
self.temp_admin = UserFactory(username="temp_admin", superuser=True)
|
||||||
self.client.force_authenticate(user=self.temp_admin)
|
self.client.force_authenticate(user=self.temp_admin)
|
||||||
|
|
||||||
self.t1 = Tag.objects.create(name="t1")
|
self.t1 = Tag.objects.create(name="t1")
|
||||||
@@ -1030,9 +1017,7 @@ class TestBulkEditObjects(APITestCase):
|
|||||||
THEN:
|
THEN:
|
||||||
- User is able to delete objects
|
- User is able to delete objects
|
||||||
"""
|
"""
|
||||||
self.user1.user_permissions.add(
|
grant_global(self.user1, "delete_tag")
|
||||||
*Permission.objects.filter(codename="delete_tag"),
|
|
||||||
)
|
|
||||||
self.user1.save()
|
self.user1.save()
|
||||||
self.client.force_authenticate(user=self.user1)
|
self.client.force_authenticate(user=self.user1)
|
||||||
|
|
||||||
@@ -1062,9 +1047,7 @@ class TestBulkEditObjects(APITestCase):
|
|||||||
self.t2.owner = User.objects.get(username="temp_admin")
|
self.t2.owner = User.objects.get(username="temp_admin")
|
||||||
self.t2.save()
|
self.t2.save()
|
||||||
|
|
||||||
self.user1.user_permissions.add(
|
grant_global(self.user1, "delete_tag")
|
||||||
*Permission.objects.filter(codename="delete_tag"),
|
|
||||||
)
|
|
||||||
self.user1.save()
|
self.user1.save()
|
||||||
self.client.force_authenticate(user=self.user1)
|
self.client.force_authenticate(user=self.user1)
|
||||||
|
|
||||||
@@ -1097,9 +1080,7 @@ class TestBulkEditObjects(APITestCase):
|
|||||||
self.t2.owner = User.objects.get(username="temp_admin")
|
self.t2.owner = User.objects.get(username="temp_admin")
|
||||||
self.t2.save()
|
self.t2.save()
|
||||||
|
|
||||||
self.user1.user_permissions.add(
|
grant_global(self.user1, "delete_tag")
|
||||||
*Permission.objects.filter(codename="delete_tag"),
|
|
||||||
)
|
|
||||||
self.user1.save()
|
self.user1.save()
|
||||||
self.client.force_authenticate(user=self.user1)
|
self.client.force_authenticate(user=self.user1)
|
||||||
|
|
||||||
|
|||||||
@@ -5,9 +5,7 @@ from unittest import mock
|
|||||||
from allauth.mfa.models import Authenticator
|
from allauth.mfa.models import Authenticator
|
||||||
from allauth.mfa.totp.internal import auth as totp_auth
|
from allauth.mfa.totp.internal import auth as totp_auth
|
||||||
from django.contrib.auth.models import Group
|
from django.contrib.auth.models import Group
|
||||||
from django.contrib.auth.models import Permission
|
|
||||||
from django.contrib.auth.models import User
|
from django.contrib.auth.models import User
|
||||||
from guardian.shortcuts import assign_perm
|
|
||||||
from guardian.shortcuts import get_perms
|
from guardian.shortcuts import get_perms
|
||||||
from guardian.shortcuts import get_users_with_perms
|
from guardian.shortcuts import get_users_with_perms
|
||||||
from rest_framework import status
|
from rest_framework import status
|
||||||
@@ -19,7 +17,11 @@ from documents.models import DocumentType
|
|||||||
from documents.models import MatchingModel
|
from documents.models import MatchingModel
|
||||||
from documents.models import StoragePath
|
from documents.models import StoragePath
|
||||||
from documents.models import Tag
|
from documents.models import Tag
|
||||||
from documents.tests.utils import DirectoriesMixin
|
from paperless_testing.dirs import DirectoriesMixin
|
||||||
|
from paperless_testing.factories import UserFactory
|
||||||
|
from paperless_testing.permissions import grant_all_global
|
||||||
|
from paperless_testing.permissions import grant_global
|
||||||
|
from paperless_testing.permissions import grant_object
|
||||||
|
|
||||||
|
|
||||||
class TestApiAuth(DirectoriesMixin, APITestCase):
|
class TestApiAuth(DirectoriesMixin, APITestCase):
|
||||||
@@ -93,14 +95,14 @@ class TestApiAuth(DirectoriesMixin, APITestCase):
|
|||||||
self.assertNotIn("X-Version", response)
|
self.assertNotIn("X-Version", response)
|
||||||
|
|
||||||
def test_api_version_with_auth(self) -> None:
|
def test_api_version_with_auth(self) -> None:
|
||||||
user = User.objects.create_superuser(username="test")
|
user = UserFactory(username="test", superuser=True)
|
||||||
self.client.force_authenticate(user)
|
self.client.force_authenticate(user)
|
||||||
response = self.client.get("/api/documents/")
|
response = self.client.get("/api/documents/")
|
||||||
self.assertIn("X-Api-Version", response)
|
self.assertIn("X-Api-Version", response)
|
||||||
self.assertIn("X-Version", response)
|
self.assertIn("X-Version", response)
|
||||||
|
|
||||||
def test_api_insufficient_permissions(self) -> None:
|
def test_api_insufficient_permissions(self) -> None:
|
||||||
user = User.objects.create_user(username="test")
|
user = UserFactory(username="test")
|
||||||
self.client.force_authenticate(user)
|
self.client.force_authenticate(user)
|
||||||
|
|
||||||
Document.objects.create(title="Test")
|
Document.objects.create(title="Test")
|
||||||
@@ -137,8 +139,8 @@ class TestApiAuth(DirectoriesMixin, APITestCase):
|
|||||||
)
|
)
|
||||||
|
|
||||||
def test_api_sufficient_permissions(self) -> None:
|
def test_api_sufficient_permissions(self) -> None:
|
||||||
user = User.objects.create_user(username="test")
|
user = UserFactory(username="test")
|
||||||
user.user_permissions.add(*Permission.objects.all())
|
grant_all_global(user)
|
||||||
user.is_staff = True
|
user.is_staff = True
|
||||||
self.client.force_authenticate(user)
|
self.client.force_authenticate(user)
|
||||||
|
|
||||||
@@ -166,9 +168,9 @@ class TestApiAuth(DirectoriesMixin, APITestCase):
|
|||||||
)
|
)
|
||||||
|
|
||||||
def test_api_get_object_permissions(self) -> None:
|
def test_api_get_object_permissions(self) -> None:
|
||||||
user1 = User.objects.create_user(username="test1")
|
user1 = UserFactory(username="test1")
|
||||||
user2 = User.objects.create_user(username="test2")
|
user2 = UserFactory(username="test2")
|
||||||
user1.user_permissions.add(*Permission.objects.filter(codename="view_document"))
|
grant_global(user1, "view_document")
|
||||||
self.client.force_authenticate(user1)
|
self.client.force_authenticate(user1)
|
||||||
|
|
||||||
self.assertEqual(
|
self.assertEqual(
|
||||||
@@ -205,7 +207,7 @@ class TestApiAuth(DirectoriesMixin, APITestCase):
|
|||||||
THEN:
|
THEN:
|
||||||
- Object created with current user as owner
|
- Object created with current user as owner
|
||||||
"""
|
"""
|
||||||
user1 = User.objects.create_superuser(username="user1")
|
user1 = UserFactory(username="user1", superuser=True)
|
||||||
|
|
||||||
self.client.force_authenticate(user1)
|
self.client.force_authenticate(user1)
|
||||||
|
|
||||||
@@ -234,7 +236,7 @@ class TestApiAuth(DirectoriesMixin, APITestCase):
|
|||||||
THEN:
|
THEN:
|
||||||
- Object created with no owner
|
- Object created with no owner
|
||||||
"""
|
"""
|
||||||
user1 = User.objects.create_superuser(username="user1")
|
user1 = UserFactory(username="user1", superuser=True)
|
||||||
|
|
||||||
self.client.force_authenticate(user1)
|
self.client.force_authenticate(user1)
|
||||||
|
|
||||||
@@ -265,7 +267,7 @@ class TestApiAuth(DirectoriesMixin, APITestCase):
|
|||||||
THEN:
|
THEN:
|
||||||
- Object permissions are set appropriately
|
- Object permissions are set appropriately
|
||||||
"""
|
"""
|
||||||
user1 = User.objects.create_superuser(username="user1")
|
user1 = UserFactory(username="user1", superuser=True)
|
||||||
user2 = User.objects.create(username="user2")
|
user2 = User.objects.create(username="user2")
|
||||||
group1 = Group.objects.create(name="group1")
|
group1 = Group.objects.create(name="group1")
|
||||||
|
|
||||||
@@ -313,7 +315,7 @@ class TestApiAuth(DirectoriesMixin, APITestCase):
|
|||||||
THEN:
|
THEN:
|
||||||
- Object permissions are set appropriately
|
- Object permissions are set appropriately
|
||||||
"""
|
"""
|
||||||
user1 = User.objects.create_superuser(username="user1")
|
user1 = UserFactory(username="user1", superuser=True)
|
||||||
user2 = User.objects.create(username="user2")
|
user2 = User.objects.create(username="user2")
|
||||||
group1 = Group.objects.create(name="group1")
|
group1 = Group.objects.create(name="group1")
|
||||||
|
|
||||||
@@ -363,7 +365,7 @@ class TestApiAuth(DirectoriesMixin, APITestCase):
|
|||||||
mime_type="application/pdf",
|
mime_type="application/pdf",
|
||||||
content="this is a document",
|
content="this is a document",
|
||||||
)
|
)
|
||||||
user1 = User.objects.create_superuser(username="user1")
|
user1 = UserFactory(username="user1", superuser=True)
|
||||||
user2 = User.objects.create(username="user2")
|
user2 = User.objects.create(username="user2")
|
||||||
group1 = Group.objects.create(name="group1")
|
group1 = Group.objects.create(name="group1")
|
||||||
|
|
||||||
@@ -413,16 +415,16 @@ class TestApiAuth(DirectoriesMixin, APITestCase):
|
|||||||
mime_type="application/pdf",
|
mime_type="application/pdf",
|
||||||
content="this is a document",
|
content="this is a document",
|
||||||
)
|
)
|
||||||
user1 = User.objects.create_superuser(username="user1")
|
user1 = UserFactory(username="user1", superuser=True)
|
||||||
user2 = User.objects.create(username="user2")
|
user2 = User.objects.create(username="user2")
|
||||||
group1 = Group.objects.create(name="group1")
|
group1 = Group.objects.create(name="group1")
|
||||||
doc.owner = user1
|
doc.owner = user1
|
||||||
doc.save()
|
doc.save()
|
||||||
|
|
||||||
assign_perm("view_document", user2, doc)
|
grant_object(user2, doc, "view_document")
|
||||||
assign_perm("change_document", user2, doc)
|
grant_object(user2, doc, "change_document")
|
||||||
assign_perm("view_document", group1, doc)
|
grant_object(group1, doc, "view_document")
|
||||||
assign_perm("change_document", group1, doc)
|
grant_object(group1, doc, "change_document")
|
||||||
|
|
||||||
self.client.force_authenticate(user1)
|
self.client.force_authenticate(user1)
|
||||||
|
|
||||||
@@ -446,11 +448,9 @@ class TestApiAuth(DirectoriesMixin, APITestCase):
|
|||||||
self.assertIn("change_document", get_perms(group1, doc))
|
self.assertIn("change_document", get_perms(group1, doc))
|
||||||
|
|
||||||
def test_document_permissions_change_requires_owner(self) -> None:
|
def test_document_permissions_change_requires_owner(self) -> None:
|
||||||
owner = User.objects.create_user(username="owner")
|
owner = UserFactory(username="owner")
|
||||||
editor = User.objects.create_user(username="editor")
|
editor = UserFactory(username="editor")
|
||||||
editor.user_permissions.add(
|
grant_all_global(editor)
|
||||||
*Permission.objects.all(),
|
|
||||||
)
|
|
||||||
|
|
||||||
doc = Document.objects.create(
|
doc = Document.objects.create(
|
||||||
title="Ownered doc",
|
title="Ownered doc",
|
||||||
@@ -460,8 +460,8 @@ class TestApiAuth(DirectoriesMixin, APITestCase):
|
|||||||
owner=owner,
|
owner=owner,
|
||||||
)
|
)
|
||||||
|
|
||||||
assign_perm("view_document", editor, doc)
|
grant_object(editor, doc, "view_document")
|
||||||
assign_perm("change_document", editor, doc)
|
grant_object(editor, doc, "change_document")
|
||||||
|
|
||||||
self.client.force_authenticate(editor)
|
self.client.force_authenticate(editor)
|
||||||
response = self.client.patch(
|
response = self.client.patch(
|
||||||
@@ -499,9 +499,9 @@ class TestApiAuth(DirectoriesMixin, APITestCase):
|
|||||||
self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN)
|
self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN)
|
||||||
|
|
||||||
def test_dynamic_permissions_fields(self) -> None:
|
def test_dynamic_permissions_fields(self) -> None:
|
||||||
user1 = User.objects.create_user(username="user1")
|
user1 = UserFactory(username="user1")
|
||||||
user1.user_permissions.add(*Permission.objects.filter(codename="view_document"))
|
grant_global(user1, "view_document")
|
||||||
user2 = User.objects.create_user(username="user2")
|
user2 = UserFactory(username="user2")
|
||||||
|
|
||||||
Document.objects.create(title="Test", content="content 1", checksum="1")
|
Document.objects.create(title="Test", content="content 1", checksum="1")
|
||||||
doc2 = Document.objects.create(
|
doc2 = Document.objects.create(
|
||||||
@@ -523,10 +523,10 @@ class TestApiAuth(DirectoriesMixin, APITestCase):
|
|||||||
owner=user1,
|
owner=user1,
|
||||||
)
|
)
|
||||||
|
|
||||||
assign_perm("view_document", user1, doc2)
|
grant_object(user1, doc2, "view_document")
|
||||||
assign_perm("view_document", user1, doc3)
|
grant_object(user1, doc3, "view_document")
|
||||||
assign_perm("change_document", user1, doc3)
|
grant_object(user1, doc3, "change_document")
|
||||||
assign_perm("view_document", user2, doc4)
|
grant_object(user2, doc4, "view_document")
|
||||||
|
|
||||||
self.client.force_authenticate(user1)
|
self.client.force_authenticate(user1)
|
||||||
|
|
||||||
@@ -574,8 +574,8 @@ class TestApiAuth(DirectoriesMixin, APITestCase):
|
|||||||
owned by someone else with no explicit guardian grant -- mirrors
|
owned by someone else with no explicit guardian grant -- mirrors
|
||||||
guardian's own ObjectPermissionChecker.has_perm() superuser shortcut.
|
guardian's own ObjectPermissionChecker.has_perm() superuser shortcut.
|
||||||
"""
|
"""
|
||||||
superuser = User.objects.create_superuser(username="admin")
|
superuser = UserFactory(username="admin", superuser=True)
|
||||||
other_user = User.objects.create_user(username="user2")
|
other_user = UserFactory(username="user2")
|
||||||
Document.objects.create(
|
Document.objects.create(
|
||||||
title="Test",
|
title="Test",
|
||||||
content="content",
|
content="content",
|
||||||
@@ -602,7 +602,7 @@ class TestApiAuth(DirectoriesMixin, APITestCase):
|
|||||||
THEN:
|
THEN:
|
||||||
- MFA required error is returned
|
- MFA required error is returned
|
||||||
"""
|
"""
|
||||||
user1 = User.objects.create_user(username="user1")
|
user1 = UserFactory(username="user1")
|
||||||
user1.set_password("password")
|
user1.set_password("password")
|
||||||
user1.save()
|
user1.save()
|
||||||
|
|
||||||
@@ -626,7 +626,7 @@ class TestApiAuth(DirectoriesMixin, APITestCase):
|
|||||||
THEN:
|
THEN:
|
||||||
- MFA code is required
|
- MFA code is required
|
||||||
"""
|
"""
|
||||||
user1 = User.objects.create_user(username="user1")
|
user1 = UserFactory(username="user1")
|
||||||
user1.set_password("password")
|
user1.set_password("password")
|
||||||
user1.save()
|
user1.save()
|
||||||
|
|
||||||
@@ -688,7 +688,7 @@ class TestApiUser(DirectoriesMixin, APITestCase):
|
|||||||
def setUp(self) -> None:
|
def setUp(self) -> None:
|
||||||
super().setUp()
|
super().setUp()
|
||||||
|
|
||||||
self.user = User.objects.create_superuser(username="temp_admin")
|
self.user = UserFactory(username="temp_admin", superuser=True)
|
||||||
self.client.force_authenticate(user=self.user)
|
self.client.force_authenticate(user=self.user)
|
||||||
|
|
||||||
def test_get_users(self) -> None:
|
def test_get_users(self) -> None:
|
||||||
@@ -858,10 +858,8 @@ class TestApiUser(DirectoriesMixin, APITestCase):
|
|||||||
)
|
)
|
||||||
self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
|
self.assertEqual(response.status_code, status.HTTP_404_NOT_FOUND)
|
||||||
|
|
||||||
regular_user = User.objects.create_user(username="regular_user")
|
regular_user = UserFactory(username="regular_user")
|
||||||
regular_user.user_permissions.add(
|
grant_all_global(regular_user)
|
||||||
*Permission.objects.all(),
|
|
||||||
)
|
|
||||||
self.client.force_authenticate(regular_user)
|
self.client.force_authenticate(regular_user)
|
||||||
Authenticator.objects.create(
|
Authenticator.objects.create(
|
||||||
user=user1,
|
user=user1,
|
||||||
@@ -885,9 +883,9 @@ class TestApiUser(DirectoriesMixin, APITestCase):
|
|||||||
- Only superusers can change superuser status
|
- Only superusers can change superuser status
|
||||||
"""
|
"""
|
||||||
|
|
||||||
user1 = User.objects.create_user(username="user1")
|
user1 = UserFactory(username="user1")
|
||||||
user1.user_permissions.add(*Permission.objects.all())
|
grant_all_global(user1)
|
||||||
user2 = User.objects.create_superuser(username="user2")
|
user2 = UserFactory(username="user2", superuser=True)
|
||||||
|
|
||||||
self.client.force_authenticate(user1)
|
self.client.force_authenticate(user1)
|
||||||
|
|
||||||
@@ -972,9 +970,9 @@ class TestApiUser(DirectoriesMixin, APITestCase):
|
|||||||
- Only superusers can change staff status
|
- Only superusers can change staff status
|
||||||
"""
|
"""
|
||||||
|
|
||||||
user1 = User.objects.create_user(username="user1")
|
user1 = UserFactory(username="user1")
|
||||||
user1.user_permissions.add(*Permission.objects.all())
|
grant_all_global(user1)
|
||||||
user2 = User.objects.create_superuser(username="user2")
|
user2 = UserFactory(username="user2", superuser=True)
|
||||||
|
|
||||||
self.client.force_authenticate(user1)
|
self.client.force_authenticate(user1)
|
||||||
|
|
||||||
@@ -1027,7 +1025,7 @@ class TestApiGroup(DirectoriesMixin, APITestCase):
|
|||||||
def setUp(self) -> None:
|
def setUp(self) -> None:
|
||||||
super().setUp()
|
super().setUp()
|
||||||
|
|
||||||
self.user = User.objects.create_superuser(username="temp_admin")
|
self.user = UserFactory(username="temp_admin", superuser=True)
|
||||||
self.client.force_authenticate(user=self.user)
|
self.client.force_authenticate(user=self.user)
|
||||||
|
|
||||||
def test_get_groups(self) -> None:
|
def test_get_groups(self) -> None:
|
||||||
@@ -1128,7 +1126,7 @@ class TestBulkEditObjectPermissions(APITestCase):
|
|||||||
def setUp(self) -> None:
|
def setUp(self) -> None:
|
||||||
super().setUp()
|
super().setUp()
|
||||||
|
|
||||||
self.temp_admin = User.objects.create_superuser(username="temp_admin")
|
self.temp_admin = UserFactory(username="temp_admin", superuser=True)
|
||||||
self.client.force_authenticate(user=self.temp_admin)
|
self.client.force_authenticate(user=self.temp_admin)
|
||||||
|
|
||||||
self.t1 = Tag.objects.create(name="t1")
|
self.t1 = Tag.objects.create(name="t1")
|
||||||
@@ -1276,7 +1274,7 @@ class TestBulkEditObjectPermissions(APITestCase):
|
|||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
assign_perm("view_tag", self.user3, self.t1)
|
grant_object(self.user3, self.t1, "view_tag")
|
||||||
self.t1.owner = self.user3
|
self.t1.owner = self.user3
|
||||||
self.t1.save()
|
self.t1.save()
|
||||||
|
|
||||||
@@ -1373,13 +1371,9 @@ class TestBulkEditObjectPermissions(APITestCase):
|
|||||||
"""
|
"""
|
||||||
self.t1.owner = self.user2
|
self.t1.owner = self.user2
|
||||||
self.t1.save()
|
self.t1.save()
|
||||||
assign_perm("view_tag", self.user1, self.t1)
|
grant_object(self.user1, self.t1, "view_tag")
|
||||||
assign_perm("change_tag", self.user1, self.t1)
|
grant_object(self.user1, self.t1, "change_tag")
|
||||||
self.user1.user_permissions.add(
|
grant_global(self.user1, "view_tag", "change_tag")
|
||||||
*Permission.objects.filter(
|
|
||||||
codename__in=["view_tag", "change_tag"],
|
|
||||||
),
|
|
||||||
)
|
|
||||||
user1 = User.objects.get(pk=self.user1.pk)
|
user1 = User.objects.get(pk=self.user1.pk)
|
||||||
self.client.force_authenticate(user=user1)
|
self.client.force_authenticate(user=user1)
|
||||||
|
|
||||||
@@ -1426,13 +1420,9 @@ class TestBulkEditObjectPermissions(APITestCase):
|
|||||||
"""
|
"""
|
||||||
owned = Tag.objects.create(name="owned", owner=self.user1)
|
owned = Tag.objects.create(name="owned", owner=self.user1)
|
||||||
shared = Tag.objects.create(name="shared", owner=self.user2)
|
shared = Tag.objects.create(name="shared", owner=self.user2)
|
||||||
assign_perm("view_tag", self.user1, shared)
|
grant_object(self.user1, shared, "view_tag")
|
||||||
assign_perm("change_tag", self.user1, shared)
|
grant_object(self.user1, shared, "change_tag")
|
||||||
self.user1.user_permissions.add(
|
grant_global(self.user1, "view_tag", "change_tag")
|
||||||
*Permission.objects.filter(
|
|
||||||
codename__in=["view_tag", "change_tag"],
|
|
||||||
),
|
|
||||||
)
|
|
||||||
user1 = User.objects.get(pk=self.user1.pk)
|
user1 = User.objects.get(pk=self.user1.pk)
|
||||||
self.client.force_authenticate(user=user1)
|
self.client.force_authenticate(user=user1)
|
||||||
|
|
||||||
@@ -1473,14 +1463,10 @@ class TestBulkEditObjectPermissions(APITestCase):
|
|||||||
"""
|
"""
|
||||||
self.t1.owner = self.user2
|
self.t1.owner = self.user2
|
||||||
self.t1.save()
|
self.t1.save()
|
||||||
assign_perm("view_tag", self.user1, self.t1)
|
grant_object(self.user1, self.t1, "view_tag")
|
||||||
assign_perm("change_tag", self.user1, self.t1)
|
grant_object(self.user1, self.t1, "change_tag")
|
||||||
assign_perm("delete_tag", self.user1, self.t1)
|
grant_object(self.user1, self.t1, "delete_tag")
|
||||||
self.user1.user_permissions.add(
|
grant_global(self.user1, "view_tag", "change_tag", "delete_tag")
|
||||||
*Permission.objects.filter(
|
|
||||||
codename__in=["view_tag", "change_tag", "delete_tag"],
|
|
||||||
),
|
|
||||||
)
|
|
||||||
user1 = User.objects.get(pk=self.user1.pk)
|
user1 = User.objects.get(pk=self.user1.pk)
|
||||||
self.client.force_authenticate(user=user1)
|
self.client.force_authenticate(user=user1)
|
||||||
|
|
||||||
@@ -1585,7 +1571,7 @@ class TestBulkEditObjectPermissions(APITestCase):
|
|||||||
- Request succeeds and null is treated as an empty user list,
|
- Request succeeds and null is treated as an empty user list,
|
||||||
so the existing view permission is removed
|
so the existing view permission is removed
|
||||||
"""
|
"""
|
||||||
assign_perm("view_tag", self.user1, self.t1)
|
grant_object(self.user1, self.t1, "view_tag")
|
||||||
|
|
||||||
response = self.client.post(
|
response = self.client.post(
|
||||||
"/api/bulk_edit_objects/",
|
"/api/bulk_edit_objects/",
|
||||||
@@ -1680,7 +1666,7 @@ class TestFullPermissionsFlag(APITestCase):
|
|||||||
def setUp(self) -> None:
|
def setUp(self) -> None:
|
||||||
super().setUp()
|
super().setUp()
|
||||||
|
|
||||||
self.admin = User.objects.create_superuser(username="admin")
|
self.admin = UserFactory(username="admin", superuser=True)
|
||||||
|
|
||||||
def test_full_perms_flag(self) -> None:
|
def test_full_perms_flag(self) -> None:
|
||||||
"""
|
"""
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user