mirror of
https://github.com/paperless-ngx/paperless-ngx.git
synced 2026-07-30 23:55:59 +00:00
Compare commits
19
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
424a148482 | ||
|
|
e79f0d4106 | ||
|
|
c29c9178f0 | ||
|
|
baae99eb49 | ||
|
|
f50a021ef6 | ||
|
|
c8e00dca04 | ||
|
|
0a56018d6b | ||
|
|
350684cd6b | ||
|
|
668fa77428 | ||
|
|
5bd72014a6 | ||
|
|
bbb9c86ba4 | ||
|
|
09c9fa03cf | ||
|
|
04779d72bb | ||
|
|
1b32b9d678 | ||
|
|
12d318deff | ||
|
|
9c98f30d3f | ||
|
|
6a1d7b1bca | ||
|
|
de9f520143 | ||
|
|
a68c487d60 |
@@ -0,0 +1,12 @@
|
|||||||
|
#!/command/with-contenv /usr/bin/bash
|
||||||
|
# shellcheck shell=bash
|
||||||
|
|
||||||
|
declare -r log_prefix="[init-llmindex-migrate]"
|
||||||
|
|
||||||
|
echo "${log_prefix} Checking for pending LLM index migrations..."
|
||||||
|
cd "${PAPERLESS_SRC_DIR}"
|
||||||
|
if [[ -n "${USER_IS_NON_ROOT}" ]]; then
|
||||||
|
python3 manage.py document_llmindex migrate
|
||||||
|
else
|
||||||
|
s6-setuidgid paperless python3 manage.py document_llmindex migrate
|
||||||
|
fi
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
oneshot
|
||||||
@@ -0,0 +1 @@
|
|||||||
|
/etc/s6-overlay/s6-rc.d/init-llmindex-migrate/run
|
||||||
+11
-1
@@ -212,6 +212,16 @@ following:
|
|||||||
This is a no-op if the index is already up to date, so it is safe to
|
This is a no-op if the index is already up to date, so it is safe to
|
||||||
run on every upgrade.
|
run on every upgrade.
|
||||||
|
|
||||||
|
5. Migrate the LLM index if needed.
|
||||||
|
|
||||||
|
```shell-session
|
||||||
|
cd src
|
||||||
|
python3 manage.py document_llmindex migrate
|
||||||
|
```
|
||||||
|
|
||||||
|
This is a no-op if the index schema is already current, so it is safe
|
||||||
|
to run on every upgrade.
|
||||||
|
|
||||||
### Database Upgrades
|
### Database Upgrades
|
||||||
|
|
||||||
Paperless-ngx is compatible with Django-supported versions of PostgreSQL and MariaDB and it is generally
|
Paperless-ngx is compatible with Django-supported versions of PostgreSQL and MariaDB and it is generally
|
||||||
@@ -532,7 +542,7 @@ index is updated automatically on the schedule set by
|
|||||||
can manage it manually:
|
can manage it manually:
|
||||||
|
|
||||||
```
|
```
|
||||||
document_llmindex {rebuild,update,compact}
|
document_llmindex {rebuild,update,compact,migrate}
|
||||||
```
|
```
|
||||||
|
|
||||||
Specify `rebuild` to build the index from scratch from all documents in the database. Use
|
Specify `rebuild` to build the index from scratch from all documents in the database. Use
|
||||||
|
|||||||
@@ -620,6 +620,34 @@ no other workflow will be executed on the document.
|
|||||||
If a "Move to Trash" action is executed in a consume pipeline, the consumption
|
If a "Move to Trash" action is executed in a consume pipeline, the consumption
|
||||||
will be aborted and the file will be deleted.
|
will be aborted and the file will be deleted.
|
||||||
|
|
||||||
|
##### Password Removal {#workflow-action-password-removal}
|
||||||
|
|
||||||
|
"Password Removal" actions attempt to remove password protection from encrypted PDF documents. You can specify:
|
||||||
|
|
||||||
|
- One or more passwords to try, separated by commas or new lines
|
||||||
|
- Each password is tried in order until one successfully unlocks the document
|
||||||
|
|
||||||
|
Password removal never modifies a file in place. Instead, once a working password is found, the
|
||||||
|
decrypted content is consumed as a new [document version](#document-file-versions), leaving the
|
||||||
|
original (still encrypted) version in the document's version history.
|
||||||
|
|
||||||
|
**Consumption Started**: because this trigger fires before the document exists yet, the password
|
||||||
|
removal itself is deferred until after the initial consumption of the encrypted file has completed.
|
||||||
|
OCR engines cannot process an encrypted PDF, so this first version is typically stored with no
|
||||||
|
extracted text (unless the file already contained extractable text outside of OCR). Immediately
|
||||||
|
afterwards, the password is removed and the decrypted file is automatically re-consumed as a second,
|
||||||
|
new version of the same document, this time with normal OCR/text extraction applied. In other words,
|
||||||
|
a password-protected file added with this trigger will briefly exist as an un-OCR'd version before
|
||||||
|
the properly processed version is created.
|
||||||
|
|
||||||
|
**Document Added**, **Document Updated**, **Scheduled**: these triggers run against a document that
|
||||||
|
already exists, so password removal happens immediately: the decrypted content is queued for
|
||||||
|
consumption as a new version right away. Note that if the document's initial consumption also
|
||||||
|
happened while it was still encrypted, that original version will likewise be missing OCR text.
|
||||||
|
|
||||||
|
**Current limitation**: Passwords are stored as a simple list without descriptions. To handle
|
||||||
|
multiple PDF types with different passwords, create separate workflows for each use case.
|
||||||
|
|
||||||
#### Workflow placeholders
|
#### Workflow placeholders
|
||||||
|
|
||||||
Titles and webhook payloads can be generated by workflows using [Jinja templates](https://jinja.palletsprojects.com/en/3.1.x/templates/).
|
Titles and webhook payloads can be generated by workflows using [Jinja templates](https://jinja.palletsprojects.com/en/3.1.x/templates/).
|
||||||
|
|||||||
+45
-45
@@ -659,7 +659,7 @@
|
|||||||
</context-group>
|
</context-group>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
||||||
<context context-type="linenumber">445</context>
|
<context context-type="linenumber">449</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-list/bulk-editor/custom-fields-bulk-edit-dialog/custom-fields-bulk-edit-dialog.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-list/bulk-editor/custom-fields-bulk-edit-dialog/custom-fields-bulk-edit-dialog.component.html</context>
|
||||||
@@ -831,7 +831,7 @@
|
|||||||
</context-group>
|
</context-group>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
||||||
<context context-type="linenumber">464</context>
|
<context context-type="linenumber">468</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-list/document-list.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-list/document-list.component.html</context>
|
||||||
@@ -1355,7 +1355,7 @@
|
|||||||
</context-group>
|
</context-group>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
||||||
<context context-type="linenumber">390</context>
|
<context context-type="linenumber">394</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-list/bulk-editor/bulk-editor.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-list/bulk-editor/bulk-editor.component.html</context>
|
||||||
@@ -1596,7 +1596,7 @@
|
|||||||
</context-group>
|
</context-group>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
||||||
<context context-type="linenumber">165</context>
|
<context context-type="linenumber">169</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="2691296884221415710" datatype="html">
|
<trans-unit id="2691296884221415710" datatype="html">
|
||||||
@@ -1607,7 +1607,7 @@
|
|||||||
</context-group>
|
</context-group>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
||||||
<context context-type="linenumber">170</context>
|
<context context-type="linenumber">174</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-list/bulk-editor/bulk-editor.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-list/bulk-editor/bulk-editor.component.html</context>
|
||||||
@@ -1638,7 +1638,7 @@
|
|||||||
</context-group>
|
</context-group>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
||||||
<context context-type="linenumber">174</context>
|
<context context-type="linenumber">178</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-list/bulk-editor/bulk-editor.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-list/bulk-editor/bulk-editor.component.html</context>
|
||||||
@@ -1669,7 +1669,7 @@
|
|||||||
</context-group>
|
</context-group>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
||||||
<context context-type="linenumber">178</context>
|
<context context-type="linenumber">182</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-list/bulk-editor/bulk-editor.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-list/bulk-editor/bulk-editor.component.html</context>
|
||||||
@@ -1849,7 +1849,7 @@
|
|||||||
</context-group>
|
</context-group>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
||||||
<context context-type="linenumber">154</context>
|
<context context-type="linenumber">159</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/common/filterable-dropdown/filterable-dropdown.component.html</context>
|
<context context-type="sourcefile">src/app/components/common/filterable-dropdown/filterable-dropdown.component.html</context>
|
||||||
@@ -3972,11 +3972,11 @@
|
|||||||
</context-group>
|
</context-group>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
||||||
<context context-type="linenumber">96</context>
|
<context context-type="linenumber">101</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
||||||
<context context-type="linenumber">102</context>
|
<context context-type="linenumber">107</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="3800326155195149498" datatype="html">
|
<trans-unit id="3800326155195149498" datatype="html">
|
||||||
@@ -3987,11 +3987,11 @@
|
|||||||
</context-group>
|
</context-group>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
||||||
<context context-type="linenumber">97</context>
|
<context context-type="linenumber">102</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
||||||
<context context-type="linenumber">103</context>
|
<context context-type="linenumber">108</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="7551700625201096185" datatype="html">
|
<trans-unit id="7551700625201096185" datatype="html">
|
||||||
@@ -4002,14 +4002,14 @@
|
|||||||
</context-group>
|
</context-group>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
||||||
<context context-type="linenumber">119</context>
|
<context context-type="linenumber">124</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="3184700926171002527" datatype="html">
|
<trans-unit id="3184700926171002527" datatype="html">
|
||||||
<source>Any</source>
|
<source>Any</source>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
||||||
<context context-type="linenumber">152</context>
|
<context context-type="linenumber">157</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/common/filterable-dropdown/filterable-dropdown.component.html</context>
|
<context context-type="sourcefile">src/app/components/common/filterable-dropdown/filterable-dropdown.component.html</context>
|
||||||
@@ -4020,21 +4020,21 @@
|
|||||||
<source>Not</source>
|
<source>Not</source>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
||||||
<context context-type="linenumber">157</context>
|
<context context-type="linenumber">162</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="6548676277933116532" datatype="html">
|
<trans-unit id="6548676277933116532" datatype="html">
|
||||||
<source>Add query</source>
|
<source>Add query</source>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
||||||
<context context-type="linenumber">176</context>
|
<context context-type="linenumber">181</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="5599577087865387184" datatype="html">
|
<trans-unit id="5599577087865387184" datatype="html">
|
||||||
<source>Add expression</source>
|
<source>Add expression</source>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
<context context-type="sourcefile">src/app/components/common/custom-fields-query-dropdown/custom-fields-query-dropdown.component.html</context>
|
||||||
<context context-type="linenumber">179</context>
|
<context context-type="linenumber">184</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="6312759212949884929" datatype="html">
|
<trans-unit id="6312759212949884929" datatype="html">
|
||||||
@@ -4914,7 +4914,7 @@
|
|||||||
</context-group>
|
</context-group>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
||||||
<context context-type="linenumber">356</context>
|
<context context-type="linenumber">360</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="8057014866157903311" datatype="html">
|
<trans-unit id="8057014866157903311" datatype="html">
|
||||||
@@ -7760,14 +7760,14 @@
|
|||||||
<source>Details</source>
|
<source>Details</source>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
||||||
<context context-type="linenumber">160</context>
|
<context context-type="linenumber">164</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="5701618810648052610" datatype="html">
|
<trans-unit id="5701618810648052610" datatype="html">
|
||||||
<source>Title</source>
|
<source>Title</source>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
||||||
<context context-type="linenumber">163</context>
|
<context context-type="linenumber">167</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-list/document-list.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-list/document-list.component.html</context>
|
||||||
@@ -7790,14 +7790,14 @@
|
|||||||
<source>Date created</source>
|
<source>Date created</source>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
||||||
<context context-type="linenumber">167</context>
|
<context context-type="linenumber">171</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="5607669932062416162" datatype="html">
|
<trans-unit id="5607669932062416162" datatype="html">
|
||||||
<source>Default</source>
|
<source>Default</source>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
||||||
<context context-type="linenumber">179</context>
|
<context context-type="linenumber">183</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/manage/saved-views/saved-views.component.html</context>
|
<context context-type="sourcefile">src/app/components/manage/saved-views/saved-views.component.html</context>
|
||||||
@@ -7808,14 +7808,14 @@
|
|||||||
<source>Content</source>
|
<source>Content</source>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
||||||
<context context-type="linenumber">286</context>
|
<context context-type="linenumber">290</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="218403386307979629" datatype="html">
|
<trans-unit id="218403386307979629" datatype="html">
|
||||||
<source>Metadata</source>
|
<source>Metadata</source>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
||||||
<context context-type="linenumber">295</context>
|
<context context-type="linenumber">299</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-detail/metadata-collapse/metadata-collapse.component.ts</context>
|
<context context-type="sourcefile">src/app/components/document-detail/metadata-collapse/metadata-collapse.component.ts</context>
|
||||||
@@ -7826,147 +7826,147 @@
|
|||||||
<source>Date modified</source>
|
<source>Date modified</source>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
||||||
<context context-type="linenumber">302</context>
|
<context context-type="linenumber">306</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="6392918669949841614" datatype="html">
|
<trans-unit id="6392918669949841614" datatype="html">
|
||||||
<source>Date added</source>
|
<source>Date added</source>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
||||||
<context context-type="linenumber">306</context>
|
<context context-type="linenumber">310</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="146828917013192897" datatype="html">
|
<trans-unit id="146828917013192897" datatype="html">
|
||||||
<source>Media filename</source>
|
<source>Media filename</source>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
||||||
<context context-type="linenumber">310</context>
|
<context context-type="linenumber">314</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="4500855521601039868" datatype="html">
|
<trans-unit id="4500855521601039868" datatype="html">
|
||||||
<source>Original filename</source>
|
<source>Original filename</source>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
||||||
<context context-type="linenumber">314</context>
|
<context context-type="linenumber">318</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="2659735245739197634" datatype="html">
|
<trans-unit id="2659735245739197634" datatype="html">
|
||||||
<source>Original SHA256 checksum</source>
|
<source>Original SHA256 checksum</source>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
||||||
<context context-type="linenumber">318</context>
|
<context context-type="linenumber">322</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="5888243105821763422" datatype="html">
|
<trans-unit id="5888243105821763422" datatype="html">
|
||||||
<source>Original file size</source>
|
<source>Original file size</source>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
||||||
<context context-type="linenumber">322</context>
|
<context context-type="linenumber">326</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="2696647325713149563" datatype="html">
|
<trans-unit id="2696647325713149563" datatype="html">
|
||||||
<source>Original mime type</source>
|
<source>Original mime type</source>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
||||||
<context context-type="linenumber">326</context>
|
<context context-type="linenumber">330</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="6714358112223607756" datatype="html">
|
<trans-unit id="6714358112223607756" datatype="html">
|
||||||
<source>Archive SHA256 checksum</source>
|
<source>Archive SHA256 checksum</source>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
||||||
<context context-type="linenumber">331</context>
|
<context context-type="linenumber">335</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="6033581412811562084" datatype="html">
|
<trans-unit id="6033581412811562084" datatype="html">
|
||||||
<source>Archive file size</source>
|
<source>Archive file size</source>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
||||||
<context context-type="linenumber">337</context>
|
<context context-type="linenumber">341</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="6992781481378431874" datatype="html">
|
<trans-unit id="6992781481378431874" datatype="html">
|
||||||
<source>Original document metadata</source>
|
<source>Original document metadata</source>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
||||||
<context context-type="linenumber">346</context>
|
<context context-type="linenumber">350</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="2846565152091361585" datatype="html">
|
<trans-unit id="2846565152091361585" datatype="html">
|
||||||
<source>Archived document metadata</source>
|
<source>Archived document metadata</source>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
||||||
<context context-type="linenumber">349</context>
|
<context context-type="linenumber">353</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="7206723502037428235" datatype="html">
|
<trans-unit id="7206723502037428235" datatype="html">
|
||||||
<source>Notes <x id="START_BLOCK_IF" equiv-text="@if (document()?.notes.length) {"/><x id="START_TAG_SPAN" ctype="x-span" equiv-text="<span class="badge text-bg-secondary ms-1">"/><x id="INTERPOLATION" equiv-text="length}}"/><x id="CLOSE_TAG_SPAN" ctype="x-span"/><x id="CLOSE_BLOCK_IF" equiv-text="}"/></source>
|
<source>Notes <x id="START_BLOCK_IF" equiv-text="@if (document()?.notes.length) {"/><x id="START_TAG_SPAN" ctype="x-span" equiv-text="<span class="badge text-bg-secondary ms-1">"/><x id="INTERPOLATION" equiv-text="length}}"/><x id="CLOSE_TAG_SPAN" ctype="x-span"/><x id="CLOSE_BLOCK_IF" equiv-text="}"/></source>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
||||||
<context context-type="linenumber">368,371</context>
|
<context context-type="linenumber">372,375</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="186236568870281953" datatype="html">
|
<trans-unit id="186236568870281953" datatype="html">
|
||||||
<source>History</source>
|
<source>History</source>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
||||||
<context context-type="linenumber">379</context>
|
<context context-type="linenumber">383</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="8236092845697214347" datatype="html">
|
<trans-unit id="8236092845697214347" datatype="html">
|
||||||
<source> Duplicates <x id="START_TAG_SPAN" ctype="x-span" equiv-text="<span class="badge text-bg-secondary ms-1">"/><x id="INTERPOLATION" equiv-text="cate_documents.length }}"/><x id="CLOSE_TAG_SPAN" ctype="x-span"/></source>
|
<source> Duplicates <x id="START_TAG_SPAN" ctype="x-span" equiv-text="<span class="badge text-bg-secondary ms-1">"/><x id="INTERPOLATION" equiv-text="cate_documents.length }}"/><x id="CLOSE_TAG_SPAN" ctype="x-span"/></source>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
||||||
<context context-type="linenumber">401,405</context>
|
<context context-type="linenumber">405,409</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="6449374629822973702" datatype="html">
|
<trans-unit id="6449374629822973702" datatype="html">
|
||||||
<source>Duplicate documents detected:</source>
|
<source>Duplicate documents detected:</source>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
||||||
<context context-type="linenumber">407</context>
|
<context context-type="linenumber">411</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="14058600336670816" datatype="html">
|
<trans-unit id="14058600336670816" datatype="html">
|
||||||
<source>In trash</source>
|
<source>In trash</source>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
||||||
<context context-type="linenumber">418</context>
|
<context context-type="linenumber">422</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="5129524307369213584" datatype="html">
|
<trans-unit id="5129524307369213584" datatype="html">
|
||||||
<source>Save & next</source>
|
<source>Save & next</source>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
||||||
<context context-type="linenumber">447</context>
|
<context context-type="linenumber">451</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="4910102545766233758" datatype="html">
|
<trans-unit id="4910102545766233758" datatype="html">
|
||||||
<source>Save & close</source>
|
<source>Save & close</source>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
||||||
<context context-type="linenumber">449</context>
|
<context context-type="linenumber">453</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="3823219296477075982" datatype="html">
|
<trans-unit id="3823219296477075982" datatype="html">
|
||||||
<source>Discard</source>
|
<source>Discard</source>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
||||||
<context context-type="linenumber">451</context>
|
<context context-type="linenumber">455</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="1309556917227148591" datatype="html">
|
<trans-unit id="1309556917227148591" datatype="html">
|
||||||
<source>Document loading...</source>
|
<source>Document loading...</source>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
||||||
<context context-type="linenumber">459</context>
|
<context context-type="linenumber">463</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="8191371354890763172" datatype="html">
|
<trans-unit id="8191371354890763172" datatype="html">
|
||||||
<source>Enter Password</source>
|
<source>Enter Password</source>
|
||||||
<context-group purpose="location">
|
<context-group purpose="location">
|
||||||
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
<context context-type="sourcefile">src/app/components/document-detail/document-detail.component.html</context>
|
||||||
<context context-type="linenumber">513</context>
|
<context context-type="linenumber">517</context>
|
||||||
</context-group>
|
</context-group>
|
||||||
</trans-unit>
|
</trans-unit>
|
||||||
<trans-unit id="5758784066858623886" datatype="html">
|
<trans-unit id="5758784066858623886" datatype="html">
|
||||||
|
|||||||
@@ -21,7 +21,7 @@
|
|||||||
</div>
|
</div>
|
||||||
</pngx-page-header>
|
</pngx-page-header>
|
||||||
|
|
||||||
@if (!tasksService.completedFileTasks && tasksService.loading) {
|
@if (loading() && pagedTasks().length === 0) {
|
||||||
<div class="spinner-border spinner-border-sm fw-normal ms-2 me-auto" role="status"></div>
|
<div class="spinner-border spinner-border-sm fw-normal ms-2 me-auto" role="status"></div>
|
||||||
<div class="visually-hidden" i18n>Loading...</div>
|
<div class="visually-hidden" i18n>Loading...</div>
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -182,7 +182,7 @@
|
|||||||
container="body" triggers="mouseenter:mouseleave" popoverClass="popover-slim">
|
container="body" triggers="mouseenter:mouseleave" popoverClass="popover-slim">
|
||||||
<i-bs class="me-2" name="stack"></i-bs><span><ng-container i18n>Attributes</ng-container></span>
|
<i-bs class="me-2" name="stack"></i-bs><span><ng-container i18n>Attributes</ng-container></span>
|
||||||
</a>
|
</a>
|
||||||
@if (!slimSidebarEnabled) {
|
@if (!slimSidebarEnabled && canSaveSettings) {
|
||||||
<button
|
<button
|
||||||
type="button"
|
type="button"
|
||||||
class="btn btn-link btn-sm text-muted p-0 me-3 attributes-expand-btn"
|
class="btn btn-link btn-sm text-muted p-0 me-3 attributes-expand-btn"
|
||||||
|
|||||||
+5
@@ -68,6 +68,11 @@
|
|||||||
></ng-select>
|
></ng-select>
|
||||||
} @else if (getCustomFieldByID(atom.field)?.data_type === CustomFieldDataType.DocumentLink) {
|
} @else if (getCustomFieldByID(atom.field)?.data_type === CustomFieldDataType.DocumentLink) {
|
||||||
<pngx-input-document-link [(ngModel)]="atom.value" class="w-25 form-select doc-link-select p-0" placeholder="Search docs..." i18n-placeholder [minimal]="true"></pngx-input-document-link>
|
<pngx-input-document-link [(ngModel)]="atom.value" class="w-25 form-select doc-link-select p-0" placeholder="Search docs..." i18n-placeholder [minimal]="true"></pngx-input-document-link>
|
||||||
|
} @else if (getCustomFieldByID(atom.field)?.data_type === CustomFieldDataType.Monetary) {
|
||||||
|
<input class="w-25 form-control rounded-end" type="text" inputmode="decimal"
|
||||||
|
[ngModel]="atom.value"
|
||||||
|
(ngModelChange)="setMonetaryValue(atom, $event)"
|
||||||
|
[disabled]="disabled">
|
||||||
} @else {
|
} @else {
|
||||||
<input class="w-25 form-control rounded-end" type="text" [(ngModel)]="atom.value" [disabled]="disabled">
|
<input class="w-25 form-control rounded-end" type="text" [(ngModel)]="atom.value" [disabled]="disabled">
|
||||||
}
|
}
|
||||||
|
|||||||
+24
@@ -1,5 +1,6 @@
|
|||||||
import { provideHttpClient, withInterceptorsFromDi } from '@angular/common/http'
|
import { provideHttpClient, withInterceptorsFromDi } from '@angular/common/http'
|
||||||
import { provideHttpClientTesting } from '@angular/common/http/testing'
|
import { provideHttpClientTesting } from '@angular/common/http/testing'
|
||||||
|
import { LOCALE_ID } from '@angular/core'
|
||||||
import { ComponentFixture, TestBed } from '@angular/core/testing'
|
import { ComponentFixture, TestBed } from '@angular/core/testing'
|
||||||
import { FormsModule, ReactiveFormsModule } from '@angular/forms'
|
import { FormsModule, ReactiveFormsModule } from '@angular/forms'
|
||||||
import { NgbDropdownModule } from '@ng-bootstrap/ng-bootstrap'
|
import { NgbDropdownModule } from '@ng-bootstrap/ng-bootstrap'
|
||||||
@@ -41,6 +42,12 @@ const customFields = [
|
|||||||
],
|
],
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
id: 3,
|
||||||
|
name: 'Test Monetary Field',
|
||||||
|
data_type: CustomFieldDataType.Monetary,
|
||||||
|
extra_data: { default_currency: 'EUR' },
|
||||||
|
},
|
||||||
]
|
]
|
||||||
|
|
||||||
describe('CustomFieldsQueryDropdownComponent', () => {
|
describe('CustomFieldsQueryDropdownComponent', () => {
|
||||||
@@ -61,6 +68,7 @@ describe('CustomFieldsQueryDropdownComponent', () => {
|
|||||||
providers: [
|
providers: [
|
||||||
provideHttpClient(withInterceptorsFromDi()),
|
provideHttpClient(withInterceptorsFromDi()),
|
||||||
provideHttpClientTesting(),
|
provideHttpClientTesting(),
|
||||||
|
{ provide: LOCALE_ID, useValue: 'de' },
|
||||||
],
|
],
|
||||||
}).compileComponents()
|
}).compileComponents()
|
||||||
|
|
||||||
@@ -150,6 +158,22 @@ describe('CustomFieldsQueryDropdownComponent', () => {
|
|||||||
expect(options2).toEqual([])
|
expect(options2).toEqual([])
|
||||||
})
|
})
|
||||||
|
|
||||||
|
it('should normalize localized monetary comparison values', () => {
|
||||||
|
const atom = new CustomFieldQueryAtom([3, 'exact', null])
|
||||||
|
|
||||||
|
component.setMonetaryValue(atom, '1.234,56')
|
||||||
|
|
||||||
|
expect(atom.value).toEqual('1234.56')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should preserve API-formatted monetary comparison values', () => {
|
||||||
|
const atom = new CustomFieldQueryAtom([3, 'exact', null])
|
||||||
|
|
||||||
|
component.setMonetaryValue(atom, '1234.56')
|
||||||
|
|
||||||
|
expect(atom.value).toEqual('1234.56')
|
||||||
|
})
|
||||||
|
|
||||||
it('should remove an element from the selection model', () => {
|
it('should remove an element from the selection model', () => {
|
||||||
const expression = new CustomFieldQueryExpression()
|
const expression = new CustomFieldQueryExpression()
|
||||||
const atom = new CustomFieldQueryAtom()
|
const atom = new CustomFieldQueryAtom()
|
||||||
|
|||||||
+21
-1
@@ -1,9 +1,14 @@
|
|||||||
import { NgTemplateOutlet } from '@angular/common'
|
import {
|
||||||
|
getLocaleNumberSymbol,
|
||||||
|
NgTemplateOutlet,
|
||||||
|
NumberSymbol,
|
||||||
|
} from '@angular/common'
|
||||||
import {
|
import {
|
||||||
Component,
|
Component,
|
||||||
EventEmitter,
|
EventEmitter,
|
||||||
inject,
|
inject,
|
||||||
Input,
|
Input,
|
||||||
|
LOCALE_ID,
|
||||||
Output,
|
Output,
|
||||||
QueryList,
|
QueryList,
|
||||||
signal,
|
signal,
|
||||||
@@ -212,6 +217,7 @@ export class CustomFieldQueriesModel {
|
|||||||
})
|
})
|
||||||
export class CustomFieldsQueryDropdownComponent extends LoadingComponentWithPermissions {
|
export class CustomFieldsQueryDropdownComponent extends LoadingComponentWithPermissions {
|
||||||
protected customFieldsService = inject(CustomFieldsService)
|
protected customFieldsService = inject(CustomFieldsService)
|
||||||
|
private readonly locale = inject(LOCALE_ID)
|
||||||
|
|
||||||
public CustomFieldQueryComponentType = CustomFieldQueryElementType
|
public CustomFieldQueryComponentType = CustomFieldQueryElementType
|
||||||
public CustomFieldQueryOperator = CustomFieldQueryOperator
|
public CustomFieldQueryOperator = CustomFieldQueryOperator
|
||||||
@@ -376,4 +382,18 @@ export class CustomFieldsQueryDropdownComponent extends LoadingComponentWithPerm
|
|||||||
}
|
}
|
||||||
return []
|
return []
|
||||||
}
|
}
|
||||||
|
|
||||||
|
setMonetaryValue(atom: CustomFieldQueryAtom, value: string) {
|
||||||
|
// Normalize the decimal symbol e.g. . vs , by locale
|
||||||
|
const decimalSymbol = getLocaleNumberSymbol(
|
||||||
|
this.locale,
|
||||||
|
NumberSymbol.Decimal
|
||||||
|
)
|
||||||
|
if (decimalSymbol !== '.' && value.includes(decimalSymbol)) {
|
||||||
|
const groupSymbol = getLocaleNumberSymbol(this.locale, NumberSymbol.Group)
|
||||||
|
value = value.split(groupSymbol).join('').split(decimalSymbol).join('.')
|
||||||
|
}
|
||||||
|
|
||||||
|
atom.value = value
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -129,13 +129,25 @@ describe('PngxPdfViewerComponent', () => {
|
|||||||
;(component as any).applyScale()
|
;(component as any).applyScale()
|
||||||
expect(viewer.currentScaleValue).toBe(PdfZoomScale.PageFit)
|
expect(viewer.currentScaleValue).toBe(PdfZoomScale.PageFit)
|
||||||
expect(viewer.currentScale).toBe(2)
|
expect(viewer.currentScale).toBe(2)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('does not reapply scale for page-only changes', async () => {
|
||||||
|
await initComponent()
|
||||||
|
|
||||||
|
const pdf = (component as any).pdf as { numPages: number }
|
||||||
|
pdf.numPages = 3
|
||||||
|
const viewer = (component as any).pdfViewer as PDFViewer
|
||||||
|
viewer.setDocument(pdf)
|
||||||
const applyScaleSpy = jest.spyOn(component as any, 'applyScale')
|
const applyScaleSpy = jest.spyOn(component as any, 'applyScale')
|
||||||
component.page = 2
|
component.page = 2
|
||||||
;(component as any).lastViewerPage = 2
|
|
||||||
;(component as any).applyViewerState()
|
component.ngOnChanges({
|
||||||
|
page: new SimpleChange(1, 2, false),
|
||||||
|
})
|
||||||
|
|
||||||
|
expect(viewer.currentPageNumber).toBe(2)
|
||||||
expect((component as any).lastViewerPage).toBeUndefined()
|
expect((component as any).lastViewerPage).toBeUndefined()
|
||||||
expect(applyScaleSpy).toHaveBeenCalled()
|
expect(applyScaleSpy).not.toHaveBeenCalled()
|
||||||
})
|
})
|
||||||
|
|
||||||
it('does not reset the viewer when it is already on the requested page', async () => {
|
it('does not reset the viewer when it is already on the requested page', async () => {
|
||||||
|
|||||||
@@ -116,7 +116,10 @@ export class PngxPdfViewerComponent
|
|||||||
changes['zoomScale'] ||
|
changes['zoomScale'] ||
|
||||||
changes['rotation']
|
changes['rotation']
|
||||||
) {
|
) {
|
||||||
this.applyViewerState()
|
// Prevent loop with page / scale application see https://github.com/paperless-ngx/paperless-ngx/issues/13404
|
||||||
|
this.applyViewerState(
|
||||||
|
!!(changes['zoom'] || changes['zoomScale'] || changes['rotation'])
|
||||||
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
if (changes['searchQuery']) {
|
if (changes['searchQuery']) {
|
||||||
@@ -240,7 +243,7 @@ export class PngxPdfViewerComponent
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
private applyViewerState(): void {
|
private applyViewerState(applyScale = true): void {
|
||||||
if (!this.pdfViewer) {
|
if (!this.pdfViewer) {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
@@ -264,7 +267,7 @@ export class PngxPdfViewerComponent
|
|||||||
if (this.page === this.lastViewerPage) {
|
if (this.page === this.lastViewerPage) {
|
||||||
this.lastViewerPage = undefined
|
this.lastViewerPage = undefined
|
||||||
}
|
}
|
||||||
if (hasPages) {
|
if (hasPages && applyScale) {
|
||||||
this.applyScale()
|
this.applyScale()
|
||||||
}
|
}
|
||||||
this.dispatchFindIfReady()
|
this.dispatchFindIfReady()
|
||||||
|
|||||||
@@ -113,8 +113,8 @@
|
|||||||
|
|
||||||
<form [formGroup]='documentForm' (ngSubmit)="save()">
|
<form [formGroup]='documentForm' (ngSubmit)="save()">
|
||||||
|
|
||||||
<div class="btn-toolbar mb-1 border-bottom">
|
<div class="btn-toolbar justify-content-end mb-1 pb-3 gap-2 row-gap-2 border-bottom">
|
||||||
<div class="btn-group pb-3">
|
<div class="btn-group me-auto">
|
||||||
<button type="button" class="btn btn-sm btn-outline-secondary" i18n-title title="Close" (click)="close()">
|
<button type="button" class="btn btn-sm btn-outline-secondary" i18n-title title="Close" (click)="close()">
|
||||||
<i-bs width="1.2em" height="1.2em" name="x"></i-bs>
|
<i-bs width="1.2em" height="1.2em" name="x"></i-bs>
|
||||||
</button>
|
</button>
|
||||||
@@ -127,32 +127,36 @@
|
|||||||
</div>
|
</div>
|
||||||
|
|
||||||
<ng-container *pngxIfPermissions="{ action: PermissionAction.Change, type: PermissionType.Document }">
|
<ng-container *pngxIfPermissions="{ action: PermissionAction.Change, type: PermissionType.Document }">
|
||||||
<div class="btn-group pb-3 ms-auto">
|
<div class="d-flex gap-2">
|
||||||
<pngx-suggestions-dropdown *pngxIfPermissions="{ action: PermissionAction.Change, type: PermissionType.Document }"
|
<div class="btn-group">
|
||||||
[disabled]="!userCanEdit || suggestionsLoading()"
|
<pngx-suggestions-dropdown *pngxIfPermissions="{ action: PermissionAction.Change, type: PermissionType.Document }"
|
||||||
[loading]="suggestionsLoading()"
|
[disabled]="!userCanEdit || suggestionsLoading()"
|
||||||
[suggestions]="suggestions()"
|
[loading]="suggestionsLoading()"
|
||||||
[aiEnabled]="aiEnabled"
|
[suggestions]="suggestions()"
|
||||||
(getSuggestions)="getSuggestions()"
|
[aiEnabled]="aiEnabled"
|
||||||
(addTag)="createTag($event)"
|
(getSuggestions)="getSuggestions()"
|
||||||
(addDocumentType)="createDocumentType($event)"
|
(addTag)="createTag($event)"
|
||||||
(addCorrespondent)="createCorrespondent($event)">
|
(addDocumentType)="createDocumentType($event)"
|
||||||
</pngx-suggestions-dropdown>
|
(addCorrespondent)="createCorrespondent($event)">
|
||||||
|
</pngx-suggestions-dropdown>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div class="btn-group">
|
||||||
|
<pngx-custom-fields-dropdown
|
||||||
|
*pngxIfPermissions="{ action: PermissionAction.View, type: PermissionType.CustomField }"
|
||||||
|
[documentId]="documentId()"
|
||||||
|
[disabled]="!userCanEdit"
|
||||||
|
[existingFields]="document()?.custom_fields"
|
||||||
|
(created)="refreshCustomFields()"
|
||||||
|
(added)="addField($event)">
|
||||||
|
</pngx-custom-fields-dropdown>
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="btn-group pb-3 ms-2">
|
<div class="ps-3">
|
||||||
<pngx-custom-fields-dropdown
|
<ng-container *ngTemplateOutlet="saveButtons"></ng-container>
|
||||||
*pngxIfPermissions="{ action: PermissionAction.View, type: PermissionType.CustomField }"
|
|
||||||
[documentId]="documentId()"
|
|
||||||
[disabled]="!userCanEdit"
|
|
||||||
[existingFields]="document()?.custom_fields"
|
|
||||||
(created)="refreshCustomFields()"
|
|
||||||
(added)="addField($event)">
|
|
||||||
</pngx-custom-fields-dropdown>
|
|
||||||
</div>
|
</div>
|
||||||
</ng-container>
|
</ng-container>
|
||||||
|
|
||||||
<ng-container *ngTemplateOutlet="saveButtons"></ng-container>
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<ul ngbNav #nav="ngbNav" class="nav-underline flex-nowrap flex-md-wrap overflow-auto" (navChange)="onNavChange($event)" [activeId]="activeNavID()" (activeIdChange)="activeNavID.set($event)">
|
<ul ngbNav #nav="ngbNav" class="nav-underline flex-nowrap flex-md-wrap overflow-auto" (navChange)="onNavChange($event)" [activeId]="activeNavID()" (activeIdChange)="activeNavID.set($event)">
|
||||||
@@ -276,7 +280,7 @@
|
|||||||
}
|
}
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div class="d-flex border-top pt-3">
|
<div class="d-flex justify-content-end border-top pt-3">
|
||||||
<ng-container *ngTemplateOutlet="saveButtons"></ng-container>
|
<ng-container *ngTemplateOutlet="saveButtons"></ng-container>
|
||||||
</div>
|
</div>
|
||||||
</ng-template>
|
</ng-template>
|
||||||
@@ -440,7 +444,7 @@
|
|||||||
</div>
|
</div>
|
||||||
|
|
||||||
<ng-template #saveButtons>
|
<ng-template #saveButtons>
|
||||||
<div class="btn-group pb-3 ms-4">
|
<div class="btn-group">
|
||||||
<ng-container *pngxIfPermissions="{ action: PermissionAction.Change, type: PermissionType.Document }">
|
<ng-container *pngxIfPermissions="{ action: PermissionAction.Change, type: PermissionType.Document }">
|
||||||
<button type="submit" class="order-3 btn btn-sm btn-primary" i18n [disabled]="!userCanEdit || networkActive() || (isDirty$ | async) !== true">Save</button>
|
<button type="submit" class="order-3 btn btn-sm btn-primary" i18n [disabled]="!userCanEdit || networkActive() || (isDirty$ | async) !== true">Save</button>
|
||||||
@if (hasNext()) {
|
@if (hasNext()) {
|
||||||
|
|||||||
@@ -2269,4 +2269,34 @@ describe('FilterEditorComponent', () => {
|
|||||||
component.itemSelected({ item: 'world', preventDefault: () => true })
|
component.itemSelected({ item: 'world', preventDefault: () => true })
|
||||||
expect(component.textFilter).toEqual('hello world ')
|
expect(component.textFilter).toEqual('hello world ')
|
||||||
})
|
})
|
||||||
|
|
||||||
|
it('should choose the active autocomplete item with Enter', () => {
|
||||||
|
component.textFilterTarget = 'fulltext-query'
|
||||||
|
jest
|
||||||
|
.spyOn(searchService, 'autocomplete')
|
||||||
|
.mockReturnValue(of(['hello', 'help']))
|
||||||
|
|
||||||
|
const input = component.textFilterInput.nativeElement as HTMLInputElement
|
||||||
|
input.value = 'he'
|
||||||
|
input.dispatchEvent(new Event('input'))
|
||||||
|
tick(250)
|
||||||
|
|
||||||
|
input.dispatchEvent(
|
||||||
|
new KeyboardEvent('keydown', {
|
||||||
|
key: 'ArrowDown',
|
||||||
|
bubbles: true,
|
||||||
|
cancelable: true,
|
||||||
|
})
|
||||||
|
)
|
||||||
|
input.dispatchEvent(
|
||||||
|
new KeyboardEvent('keydown', {
|
||||||
|
key: 'Enter',
|
||||||
|
bubbles: true,
|
||||||
|
cancelable: true,
|
||||||
|
})
|
||||||
|
)
|
||||||
|
fixture.detectChanges()
|
||||||
|
|
||||||
|
expect(component.textFilter).toEqual('help ')
|
||||||
|
})
|
||||||
})
|
})
|
||||||
|
|||||||
@@ -1314,6 +1314,10 @@ export class FilterEditorComponent
|
|||||||
|
|
||||||
textFilterKeydown(event: KeyboardEvent) {
|
textFilterKeydown(event: KeyboardEvent) {
|
||||||
if (event.key == 'Enter') {
|
if (event.key == 'Enter') {
|
||||||
|
if (event.defaultPrevented) {
|
||||||
|
// NgbTypeahead calls preventDefault, so use that to detect if the Enter key was for the dropdown
|
||||||
|
return
|
||||||
|
}
|
||||||
const filterString = (
|
const filterString = (
|
||||||
this.textFilterInput.nativeElement as HTMLInputElement
|
this.textFilterInput.nativeElement as HTMLInputElement
|
||||||
).value
|
).value
|
||||||
|
|||||||
+2
-2
@@ -51,8 +51,8 @@
|
|||||||
*pngxIfPermissions="{ action: PermissionAction.Add, type: activeManagementList.permissionType }">
|
*pngxIfPermissions="{ action: PermissionAction.Add, type: activeManagementList.permissionType }">
|
||||||
<i-bs name="plus-circle" class="me-1"></i-bs><ng-container i18n>Create</ng-container>
|
<i-bs name="plus-circle" class="me-1"></i-bs><ng-container i18n>Create</ng-container>
|
||||||
</button>
|
</button>
|
||||||
} @else if (activeCustomFields) {
|
} @else if (customFieldsActive) {
|
||||||
<button type="button" class="btn btn-sm btn-outline-primary" (click)="activeCustomFields.editField()"
|
<button type="button" class="btn btn-sm btn-outline-primary" (click)="addCustomField()"
|
||||||
*pngxIfPermissions="{ action: PermissionAction.Add, type: PermissionType.CustomField }">
|
*pngxIfPermissions="{ action: PermissionAction.Add, type: PermissionType.CustomField }">
|
||||||
<i-bs name="plus-circle" class="me-1"></i-bs><ng-container i18n>Add Field</ng-container>
|
<i-bs name="plus-circle" class="me-1"></i-bs><ng-container i18n>Add Field</ng-container>
|
||||||
</button>
|
</button>
|
||||||
|
|||||||
+25
-1
@@ -18,6 +18,7 @@ import {
|
|||||||
DocumentAttributesComponent,
|
DocumentAttributesComponent,
|
||||||
DocumentAttributesSectionKind,
|
DocumentAttributesSectionKind,
|
||||||
} from './document-attributes.component'
|
} from './document-attributes.component'
|
||||||
|
import { CustomFieldsComponent } from './custom-fields/custom-fields.component'
|
||||||
import { ManagementListComponent } from './management-list/management-list.component'
|
import { ManagementListComponent } from './management-list/management-list.component'
|
||||||
|
|
||||||
@Component({
|
@Component({
|
||||||
@@ -207,6 +208,29 @@ describe('DocumentAttributesComponent', () => {
|
|||||||
expect(component.activeSection.kind).toBe(
|
expect(component.activeSection.kind).toBe(
|
||||||
DocumentAttributesSectionKind.CustomFields
|
DocumentAttributesSectionKind.CustomFields
|
||||||
)
|
)
|
||||||
expect(component.activeCustomFields).toBeDefined()
|
const customFields = Object.create(CustomFieldsComponent.prototype)
|
||||||
|
customFields.editField = jest.fn()
|
||||||
|
component.activeOutlet = {
|
||||||
|
componentInstance: customFields,
|
||||||
|
} as any
|
||||||
|
expect(component.activeCustomFields).toBe(customFields)
|
||||||
|
|
||||||
|
component.addCustomField()
|
||||||
|
expect(customFields.editField).toHaveBeenCalled()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('should show the add field button before the custom fields instance is available', async () => {
|
||||||
|
jest.spyOn(permissionsService, 'currentUserCan').mockReturnValue(true)
|
||||||
|
|
||||||
|
fixture.detectChanges()
|
||||||
|
component.activeNavID.set(2)
|
||||||
|
await fixture.whenStable()
|
||||||
|
|
||||||
|
expect(component.activeCustomFields).toBeNull()
|
||||||
|
expect(
|
||||||
|
fixture.nativeElement.querySelector(
|
||||||
|
'pngx-page-header .btn-outline-primary'
|
||||||
|
)?.textContent
|
||||||
|
).toContain('Add Field')
|
||||||
})
|
})
|
||||||
})
|
})
|
||||||
|
|||||||
+11
-2
@@ -163,12 +163,17 @@ export class DocumentAttributesComponent implements OnInit, OnDestroy {
|
|||||||
}
|
}
|
||||||
|
|
||||||
get activeCustomFields(): CustomFieldsComponent | null {
|
get activeCustomFields(): CustomFieldsComponent | null {
|
||||||
if (this.activeSection?.kind !== DocumentAttributesSectionKind.CustomFields)
|
if (!this.customFieldsActive) return null
|
||||||
return null
|
|
||||||
const instance = this.activeOutlet?.componentInstance
|
const instance = this.activeOutlet?.componentInstance
|
||||||
return instance instanceof CustomFieldsComponent ? instance : null
|
return instance instanceof CustomFieldsComponent ? instance : null
|
||||||
}
|
}
|
||||||
|
|
||||||
|
get customFieldsActive(): boolean {
|
||||||
|
return (
|
||||||
|
this.activeSection?.kind === DocumentAttributesSectionKind.CustomFields
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
get activeTabLabel(): string {
|
get activeTabLabel(): string {
|
||||||
return this.activeSection?.label ?? ''
|
return this.activeSection?.label ?? ''
|
||||||
}
|
}
|
||||||
@@ -224,6 +229,10 @@ export class DocumentAttributesComponent implements OnInit, OnDestroy {
|
|||||||
this.router.navigate(['attributes', nextSection])
|
this.router.navigate(['attributes', nextSection])
|
||||||
}
|
}
|
||||||
|
|
||||||
|
addCustomField(): void {
|
||||||
|
this.activeCustomFields?.editField(null)
|
||||||
|
}
|
||||||
|
|
||||||
private getDefaultNavID(): DocumentAttributesNavIDs | null {
|
private getDefaultNavID(): DocumentAttributesNavIDs | null {
|
||||||
return this.visibleSections[0]?.id ?? null
|
return this.visibleSections[0]?.id ?? null
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -50,13 +50,66 @@ describe('TasksService', () => {
|
|||||||
req.flush({ count: 0, results: [] })
|
req.flush({ count: 0, results: [] })
|
||||||
})
|
})
|
||||||
|
|
||||||
it('does not call tasks api endpoint on reload if already loading', () => {
|
it('cancels an in-progress reload when reloading again', () => {
|
||||||
tasksService.loading = true
|
|
||||||
tasksService.reload()
|
tasksService.reload()
|
||||||
httpTestingController.expectNone(
|
const staleReload = httpTestingController.expectOne(
|
||||||
(req: HttpRequest<unknown>) =>
|
(req: HttpRequest<unknown>) =>
|
||||||
req.url === `${environment.apiBaseUrl}tasks/`
|
req.url === `${environment.apiBaseUrl}tasks/`
|
||||||
)
|
)
|
||||||
|
tasksService.reload()
|
||||||
|
|
||||||
|
expect(staleReload.cancelled).toBe(true)
|
||||||
|
httpTestingController
|
||||||
|
.expectOne(
|
||||||
|
(req: HttpRequest<unknown>) =>
|
||||||
|
req.url === `${environment.apiBaseUrl}tasks/`
|
||||||
|
)
|
||||||
|
.flush({ count: 0, results: [] })
|
||||||
|
})
|
||||||
|
|
||||||
|
it('continues reloading after a reload request fails', () => {
|
||||||
|
tasksService.reload()
|
||||||
|
httpTestingController
|
||||||
|
.expectOne(
|
||||||
|
(req: HttpRequest<unknown>) =>
|
||||||
|
req.url === `${environment.apiBaseUrl}tasks/`
|
||||||
|
)
|
||||||
|
.flush('error', { status: 500, statusText: 'error' })
|
||||||
|
|
||||||
|
expect(tasksService.loading).toBe(false)
|
||||||
|
|
||||||
|
tasksService.reload()
|
||||||
|
httpTestingController
|
||||||
|
.expectOne(
|
||||||
|
(req: HttpRequest<unknown>) =>
|
||||||
|
req.url === `${environment.apiBaseUrl}tasks/`
|
||||||
|
)
|
||||||
|
.flush({ count: 0, results: [] })
|
||||||
|
})
|
||||||
|
|
||||||
|
it('reloads after dismissing a task while a reload is already in progress', () => {
|
||||||
|
tasksService.reload()
|
||||||
|
const staleReload = httpTestingController.expectOne(
|
||||||
|
(req: HttpRequest<unknown>) =>
|
||||||
|
req.url === `${environment.apiBaseUrl}tasks/` &&
|
||||||
|
req.params.get('acknowledged') === 'false'
|
||||||
|
)
|
||||||
|
|
||||||
|
tasksService.dismissTasks(new Set([1])).subscribe()
|
||||||
|
httpTestingController
|
||||||
|
.expectOne(`${environment.apiBaseUrl}tasks/acknowledge/`)
|
||||||
|
.flush([])
|
||||||
|
|
||||||
|
expect(staleReload.cancelled).toBe(true)
|
||||||
|
httpTestingController
|
||||||
|
.expectOne(
|
||||||
|
(req: HttpRequest<unknown>) =>
|
||||||
|
req.url === `${environment.apiBaseUrl}tasks/` &&
|
||||||
|
req.params.get('acknowledged') === 'false'
|
||||||
|
)
|
||||||
|
.flush({ count: 0, results: [] })
|
||||||
|
|
||||||
|
expect(tasksService.needsAttentionTasks).toHaveLength(0)
|
||||||
})
|
})
|
||||||
|
|
||||||
it('calls acknowledge_tasks api endpoint on dismiss and reloads', () => {
|
it('calls acknowledge_tasks api endpoint on dismiss and reloads', () => {
|
||||||
@@ -101,79 +154,6 @@ describe('TasksService', () => {
|
|||||||
.flush({ count: 0, results: [] })
|
.flush({ count: 0, results: [] })
|
||||||
})
|
})
|
||||||
|
|
||||||
it('groups mixed task types by status when reloading', () => {
|
|
||||||
expect(tasksService.total).toEqual(0)
|
|
||||||
const mockTasks = [
|
|
||||||
{
|
|
||||||
task_type: PaperlessTaskType.ConsumeFile,
|
|
||||||
trigger_source: PaperlessTaskTriggerSource.FolderConsume,
|
|
||||||
status: PaperlessTaskStatus.Success,
|
|
||||||
acknowledged: false,
|
|
||||||
task_id: '1234',
|
|
||||||
input_data: { filename: 'file1.pdf' },
|
|
||||||
date_created: new Date(),
|
|
||||||
related_document_ids: [],
|
|
||||||
},
|
|
||||||
{
|
|
||||||
task_type: PaperlessTaskType.SanityCheck,
|
|
||||||
trigger_source: PaperlessTaskTriggerSource.System,
|
|
||||||
status: PaperlessTaskStatus.Failure,
|
|
||||||
acknowledged: false,
|
|
||||||
task_id: '1235',
|
|
||||||
input_data: {},
|
|
||||||
date_created: new Date(),
|
|
||||||
related_document_ids: [],
|
|
||||||
},
|
|
||||||
{
|
|
||||||
task_type: PaperlessTaskType.MailFetch,
|
|
||||||
trigger_source: PaperlessTaskTriggerSource.Scheduled,
|
|
||||||
status: PaperlessTaskStatus.Pending,
|
|
||||||
acknowledged: false,
|
|
||||||
task_id: '1236',
|
|
||||||
input_data: {},
|
|
||||||
date_created: new Date(),
|
|
||||||
related_document_ids: [],
|
|
||||||
},
|
|
||||||
{
|
|
||||||
task_type: PaperlessTaskType.LlmIndex,
|
|
||||||
trigger_source: PaperlessTaskTriggerSource.WebUI,
|
|
||||||
status: PaperlessTaskStatus.Started,
|
|
||||||
acknowledged: false,
|
|
||||||
task_id: '1237',
|
|
||||||
input_data: {},
|
|
||||||
date_created: new Date(),
|
|
||||||
related_document_ids: [],
|
|
||||||
},
|
|
||||||
{
|
|
||||||
task_type: PaperlessTaskType.EmptyTrash,
|
|
||||||
trigger_source: PaperlessTaskTriggerSource.Manual,
|
|
||||||
status: PaperlessTaskStatus.Success,
|
|
||||||
acknowledged: false,
|
|
||||||
task_id: '1238',
|
|
||||||
input_data: {},
|
|
||||||
date_created: new Date(),
|
|
||||||
related_document_ids: [],
|
|
||||||
},
|
|
||||||
]
|
|
||||||
|
|
||||||
tasksService.reload()
|
|
||||||
|
|
||||||
const req = httpTestingController.expectOne(
|
|
||||||
(req: HttpRequest<unknown>) =>
|
|
||||||
req.url === `${environment.apiBaseUrl}tasks/` &&
|
|
||||||
req.params.get('acknowledged') === 'false' &&
|
|
||||||
req.params.get('page_size') === '1000'
|
|
||||||
)
|
|
||||||
|
|
||||||
req.flush({ count: mockTasks.length, results: mockTasks })
|
|
||||||
|
|
||||||
expect(tasksService.allFileTasks).toHaveLength(5)
|
|
||||||
expect(tasksService.completedFileTasks).toHaveLength(2)
|
|
||||||
expect(tasksService.failedFileTasks).toHaveLength(1)
|
|
||||||
expect(tasksService.queuedFileTasks).toHaveLength(1)
|
|
||||||
expect(tasksService.startedFileTasks).toHaveLength(1)
|
|
||||||
})
|
|
||||||
|
|
||||||
it('includes revoked tasks in needs attention', () => {
|
it('includes revoked tasks in needs attention', () => {
|
||||||
const mockTasks = [
|
const mockTasks = [
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -1,7 +1,15 @@
|
|||||||
import { HttpClient } from '@angular/common/http'
|
import { HttpClient } from '@angular/common/http'
|
||||||
import { Injectable, inject, signal } from '@angular/core'
|
import { Injectable, inject, signal } from '@angular/core'
|
||||||
import { Observable, Subject } from 'rxjs'
|
import { EMPTY, Observable, Subject } from 'rxjs'
|
||||||
import { first, map, takeUntil, tap } from 'rxjs/operators'
|
import {
|
||||||
|
catchError,
|
||||||
|
finalize,
|
||||||
|
first,
|
||||||
|
map,
|
||||||
|
switchMap,
|
||||||
|
takeUntil,
|
||||||
|
tap,
|
||||||
|
} from 'rxjs/operators'
|
||||||
import {
|
import {
|
||||||
PaperlessTask,
|
PaperlessTask,
|
||||||
PaperlessTaskStatus,
|
PaperlessTaskStatus,
|
||||||
@@ -23,44 +31,40 @@ export class TasksService {
|
|||||||
|
|
||||||
public loading: boolean = false
|
public loading: boolean = false
|
||||||
|
|
||||||
private readonly fileTasks = signal<PaperlessTask[]>([])
|
private readonly tasks = signal<PaperlessTask[]>([])
|
||||||
|
private readonly reloadNotifier = new Subject<void>()
|
||||||
|
|
||||||
private unsubscribeNotifer: Subject<any> = new Subject()
|
private unsubscribeNotifer: Subject<any> = new Subject()
|
||||||
|
|
||||||
public get total(): number {
|
constructor() {
|
||||||
return this.fileTasks().length
|
this.reloadNotifier
|
||||||
}
|
.pipe(
|
||||||
|
switchMap(() => {
|
||||||
public get allFileTasks(): PaperlessTask[] {
|
this.loading = true
|
||||||
return this.fileTasks().slice(0)
|
return this.http
|
||||||
}
|
.get<Results<PaperlessTask>>(`${this.baseUrl}${this.endpoint}/`, {
|
||||||
|
params: {
|
||||||
public get queuedFileTasks(): PaperlessTask[] {
|
acknowledged: 'false',
|
||||||
return this.fileTasks().filter(
|
page_size: this.defaultReloadPageSize,
|
||||||
(t) => t.status === PaperlessTaskStatus.Pending
|
},
|
||||||
)
|
})
|
||||||
}
|
.pipe(
|
||||||
|
map((response) => response.results),
|
||||||
public get startedFileTasks(): PaperlessTask[] {
|
takeUntil(this.unsubscribeNotifer),
|
||||||
return this.fileTasks().filter(
|
catchError(() => EMPTY),
|
||||||
(t) => t.status === PaperlessTaskStatus.Started
|
finalize(() => {
|
||||||
)
|
this.loading = false
|
||||||
}
|
})
|
||||||
|
)
|
||||||
public get completedFileTasks(): PaperlessTask[] {
|
})
|
||||||
return this.fileTasks().filter(
|
)
|
||||||
(t) => t.status === PaperlessTaskStatus.Success
|
.subscribe((tasks) => {
|
||||||
)
|
this.tasks.set(tasks)
|
||||||
}
|
})
|
||||||
|
|
||||||
public get failedFileTasks(): PaperlessTask[] {
|
|
||||||
return this.fileTasks().filter(
|
|
||||||
(t) => t.status === PaperlessTaskStatus.Failure
|
|
||||||
)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
public get needsAttentionTasks(): PaperlessTask[] {
|
public get needsAttentionTasks(): PaperlessTask[] {
|
||||||
return this.fileTasks().filter((t) =>
|
return this.tasks().filter((t) =>
|
||||||
[PaperlessTaskStatus.Failure, PaperlessTaskStatus.Revoked].includes(
|
[PaperlessTaskStatus.Failure, PaperlessTaskStatus.Revoked].includes(
|
||||||
t.status
|
t.status
|
||||||
)
|
)
|
||||||
@@ -68,22 +72,7 @@ export class TasksService {
|
|||||||
}
|
}
|
||||||
|
|
||||||
public reload() {
|
public reload() {
|
||||||
if (this.loading) return
|
this.reloadNotifier.next()
|
||||||
this.loading = true
|
|
||||||
|
|
||||||
this.http
|
|
||||||
.get<Results<PaperlessTask>>(`${this.baseUrl}${this.endpoint}/`, {
|
|
||||||
params: {
|
|
||||||
acknowledged: 'false',
|
|
||||||
page_size: this.defaultReloadPageSize,
|
|
||||||
},
|
|
||||||
})
|
|
||||||
.pipe(map((r) => r.results))
|
|
||||||
.pipe(takeUntil(this.unsubscribeNotifer), first())
|
|
||||||
.subscribe((r) => {
|
|
||||||
this.fileTasks.set(r)
|
|
||||||
this.loading = false
|
|
||||||
})
|
|
||||||
}
|
}
|
||||||
|
|
||||||
public list(
|
public list(
|
||||||
|
|||||||
+15
-25
@@ -57,9 +57,7 @@ from paperless.models import ArchiveFileGenerationChoices
|
|||||||
from paperless.parsers import ParserContext
|
from paperless.parsers import ParserContext
|
||||||
from paperless.parsers import ParserProtocol
|
from paperless.parsers import ParserProtocol
|
||||||
from paperless.parsers.registry import get_parser_registry
|
from paperless.parsers.registry import get_parser_registry
|
||||||
from paperless.parsers.utils import PDF_TEXT_MIN_LENGTH
|
from paperless.parsers.utils import pdf_born_digital_text
|
||||||
from paperless.parsers.utils import extract_pdf_text
|
|
||||||
from paperless.parsers.utils import is_tagged_pdf
|
|
||||||
|
|
||||||
LOGGING_NAME: Final[str] = "paperless.consumer"
|
LOGGING_NAME: Final[str] = "paperless.consumer"
|
||||||
|
|
||||||
@@ -138,53 +136,45 @@ def should_produce_archive(
|
|||||||
|
|
||||||
# Must produce a PDF so the frontend can display the original format at all.
|
# Must produce a PDF so the frontend can display the original format at all.
|
||||||
if parser.requires_pdf_rendition:
|
if parser.requires_pdf_rendition:
|
||||||
_log.debug("Archive: yes — parser requires PDF rendition for frontend display")
|
_log.debug("Archive: yes - parser requires PDF rendition for frontend display")
|
||||||
return True
|
return True
|
||||||
|
|
||||||
# Parser cannot produce an archive (e.g. TextDocumentParser).
|
# Parser cannot produce an archive (e.g. TextDocumentParser).
|
||||||
if not parser.can_produce_archive:
|
if not parser.can_produce_archive:
|
||||||
_log.debug("Archive: no — parser cannot produce archives")
|
_log.debug("Archive: no - parser cannot produce archives")
|
||||||
return False
|
return False
|
||||||
|
|
||||||
generation = OcrConfig().archive_file_generation
|
generation = OcrConfig().archive_file_generation
|
||||||
|
|
||||||
if generation == ArchiveFileGenerationChoices.ALWAYS:
|
if generation == ArchiveFileGenerationChoices.ALWAYS:
|
||||||
_log.debug("Archive: yes — ARCHIVE_FILE_GENERATION=always")
|
_log.debug("Archive: yes - ARCHIVE_FILE_GENERATION=always")
|
||||||
return True
|
return True
|
||||||
if generation == ArchiveFileGenerationChoices.NEVER:
|
if generation == ArchiveFileGenerationChoices.NEVER:
|
||||||
_log.debug("Archive: no — ARCHIVE_FILE_GENERATION=never")
|
_log.debug("Archive: no - ARCHIVE_FILE_GENERATION=never")
|
||||||
return False
|
return False
|
||||||
|
|
||||||
# auto: produce archives for scanned/image documents; skip for born-digital PDFs.
|
# auto: produce archives for scanned/image documents; skip for born-digital PDFs.
|
||||||
if mime_type.startswith("image/"):
|
if mime_type.startswith("image/"):
|
||||||
_log.debug("Archive: yes — image document, ARCHIVE_FILE_GENERATION=auto")
|
_log.debug("Archive: yes - image document, ARCHIVE_FILE_GENERATION=auto")
|
||||||
return True
|
return True
|
||||||
if mime_type == "application/pdf":
|
if mime_type == "application/pdf":
|
||||||
text = extract_pdf_text(document_path)
|
text, born_digital = pdf_born_digital_text(document_path, log=_log)
|
||||||
has_text = text is not None and len(text) > 0
|
text_length = len(text) if text else 0
|
||||||
if has_text and is_tagged_pdf(document_path):
|
if born_digital:
|
||||||
_log.debug(
|
_log.debug(
|
||||||
"Archive: no — born-digital PDF (structure tags detected),"
|
"Archive: no - born-digital PDF (text_length=%d),"
|
||||||
" ARCHIVE_FILE_GENERATION=auto",
|
" ARCHIVE_FILE_GENERATION=auto",
|
||||||
|
text_length,
|
||||||
)
|
)
|
||||||
return False
|
return False
|
||||||
if text is None or len(text) <= PDF_TEXT_MIN_LENGTH:
|
|
||||||
_log.debug(
|
|
||||||
"Archive: yes — scanned PDF (text_length=%d ≤ %d),"
|
|
||||||
" ARCHIVE_FILE_GENERATION=auto",
|
|
||||||
len(text) if text else 0,
|
|
||||||
PDF_TEXT_MIN_LENGTH,
|
|
||||||
)
|
|
||||||
return True
|
|
||||||
_log.debug(
|
_log.debug(
|
||||||
"Archive: no — born-digital PDF (text_length=%d > %d),"
|
"Archive: yes - scanned/textless PDF (text_length=%d),"
|
||||||
" ARCHIVE_FILE_GENERATION=auto",
|
" ARCHIVE_FILE_GENERATION=auto",
|
||||||
len(text),
|
text_length,
|
||||||
PDF_TEXT_MIN_LENGTH,
|
|
||||||
)
|
)
|
||||||
return False
|
return True
|
||||||
_log.debug(
|
_log.debug(
|
||||||
"Archive: no — MIME type %r not eligible for auto archive generation",
|
"Archive: no - MIME type %r not eligible for auto archive generation",
|
||||||
mime_type,
|
mime_type,
|
||||||
)
|
)
|
||||||
return False
|
return False
|
||||||
|
|||||||
@@ -36,6 +36,9 @@ def send_email(
|
|||||||
|
|
||||||
TODO: re-evaluate this pending https://code.djangoproject.com/ticket/35581 / https://github.com/django/django/pull/18966
|
TODO: re-evaluate this pending https://code.djangoproject.com/ticket/35581 / https://github.com/django/django/pull/18966
|
||||||
"""
|
"""
|
||||||
|
if "\r" in subject or "\n" in subject:
|
||||||
|
subject = " ".join(line.strip(" \t") for line in subject.splitlines())
|
||||||
|
|
||||||
email = EmailMessage(
|
email = EmailMessage(
|
||||||
subject=subject,
|
subject=subject,
|
||||||
body=body,
|
body=body,
|
||||||
|
|||||||
@@ -386,10 +386,19 @@ class Command(CryptMixin, PaperlessCommand):
|
|||||||
raise DeserializationError(
|
raise DeserializationError(
|
||||||
f"{model.__name__} has no updatable fields; PK-only models are not supported by the importer",
|
f"{model.__name__} has no updatable fields; PK-only models are not supported by the importer",
|
||||||
)
|
)
|
||||||
|
# MySQL/MariaDB support upserts via ON DUPLICATE KEY UPDATE but,
|
||||||
|
# unlike PostgreSQL/SQLite, cannot target a specific unique field
|
||||||
|
# for the conflict -- passing unique_fields there raises
|
||||||
|
# NotSupportedError.
|
||||||
|
unique_fields = (
|
||||||
|
[model._meta.pk.attname]
|
||||||
|
if connection.features.supports_update_conflicts_with_target
|
||||||
|
else None
|
||||||
|
)
|
||||||
model.objects.bulk_create( # type: ignore[attr-defined]
|
model.objects.bulk_create( # type: ignore[attr-defined]
|
||||||
instances,
|
instances,
|
||||||
update_conflicts=True,
|
update_conflicts=True,
|
||||||
unique_fields=[model._meta.pk.attname],
|
unique_fields=unique_fields,
|
||||||
update_fields=update_fields,
|
update_fields=update_fields,
|
||||||
)
|
)
|
||||||
loaded_models.add(model)
|
loaded_models.add(model)
|
||||||
|
|||||||
@@ -3,6 +3,7 @@ from typing import Any
|
|||||||
from documents.management.commands.base import PaperlessCommand
|
from documents.management.commands.base import PaperlessCommand
|
||||||
from documents.tasks import llmindex_index
|
from documents.tasks import llmindex_index
|
||||||
from paperless_ai.indexing import llm_index_compact
|
from paperless_ai.indexing import llm_index_compact
|
||||||
|
from paperless_ai.indexing import llm_index_migrate
|
||||||
|
|
||||||
|
|
||||||
class Command(PaperlessCommand):
|
class Command(PaperlessCommand):
|
||||||
@@ -13,12 +14,18 @@ class Command(PaperlessCommand):
|
|||||||
|
|
||||||
def add_arguments(self, parser: Any) -> None:
|
def add_arguments(self, parser: Any) -> None:
|
||||||
super().add_arguments(parser)
|
super().add_arguments(parser)
|
||||||
parser.add_argument("command", choices=["rebuild", "update", "compact"])
|
parser.add_argument(
|
||||||
|
"command",
|
||||||
|
choices=["rebuild", "update", "compact", "migrate"],
|
||||||
|
)
|
||||||
|
|
||||||
def handle(self, *args: Any, **options: Any) -> None:
|
def handle(self, *args: Any, **options: Any) -> None:
|
||||||
if options["command"] == "compact":
|
if options["command"] == "compact":
|
||||||
llm_index_compact()
|
llm_index_compact()
|
||||||
return
|
return
|
||||||
|
if options["command"] == "migrate":
|
||||||
|
llm_index_migrate()
|
||||||
|
return
|
||||||
llmindex_index(
|
llmindex_index(
|
||||||
rebuild=options["command"] == "rebuild",
|
rebuild=options["command"] == "rebuild",
|
||||||
iter_wrapper=lambda docs: self.track(
|
iter_wrapper=lambda docs: self.track(
|
||||||
|
|||||||
@@ -61,7 +61,7 @@ class Command(PaperlessCommand):
|
|||||||
)
|
)
|
||||||
table.add_column("Level", width=7, no_wrap=True)
|
table.add_column("Level", width=7, no_wrap=True)
|
||||||
table.add_column("Document", min_width=20)
|
table.add_column("Document", min_width=20)
|
||||||
table.add_column("Issue", ratio=1)
|
table.add_column("Issue", ratio=1, overflow="fold")
|
||||||
|
|
||||||
for doc_pk, doc_messages in messages.iter_messages():
|
for doc_pk, doc_messages in messages.iter_messages():
|
||||||
if doc_pk is not None:
|
if doc_pk is not None:
|
||||||
|
|||||||
@@ -43,8 +43,16 @@ def _fmt(dt: datetime) -> str:
|
|||||||
|
|
||||||
|
|
||||||
def _iso_range(lo: datetime, hi: datetime) -> str:
|
def _iso_range(lo: datetime, hi: datetime) -> str:
|
||||||
"""Format a [lo TO hi] range string in ISO 8601 for Tantivy query syntax."""
|
"""
|
||||||
return f"[{_fmt(lo)} TO {_fmt(hi)}]"
|
Format a half-open ``[lo TO hi)`` range in ISO 8601 for Tantivy query syntax.
|
||||||
|
|
||||||
|
``hi`` is always the exclusive ceiling of a computed period (the start of
|
||||||
|
the *next* day/week/month/quarter/year), so the closing bracket must be
|
||||||
|
the Tantivy exclusive-range brace ``}`` rather than ``]`` — otherwise the
|
||||||
|
first instant of the following period (e.g. the 1st of next month) is
|
||||||
|
incorrectly included in the match.
|
||||||
|
"""
|
||||||
|
return f"[{_fmt(lo)} TO {_fmt(hi)}}}"
|
||||||
|
|
||||||
|
|
||||||
def _quarter_start(d: date) -> date:
|
def _quarter_start(d: date) -> date:
|
||||||
|
|||||||
@@ -566,6 +566,17 @@ def translate_range(field: str, lo: str, hi: str, tz: tzinfo) -> str:
|
|||||||
lo_pair, hi_pair = hi_pair, lo_pair
|
lo_pair, hi_pair = hi_pair, lo_pair
|
||||||
|
|
||||||
lo_iso = _fmt(lo_pair[0]) if lo_pair is not None else OPEN_LO
|
lo_iso = _fmt(lo_pair[0]) if lo_pair is not None else OPEN_LO
|
||||||
hi_iso = _fmt(hi_pair[1]) if hi_pair is not None else OPEN_HI
|
|
||||||
|
|
||||||
return f"{field}:[{lo_iso} TO {hi_iso}]"
|
# A bound resolves to (floor, ceil) where floor == ceil for an exact instant
|
||||||
|
# (a full ISO datetime, "now", or a "+/-N unit" offset) and floor != ceil for
|
||||||
|
# a coarser period token (year/month/day precision). Only the latter needs a
|
||||||
|
# half-open close: its ceil is the start of the *next* period and must be
|
||||||
|
# excluded, or that instant (e.g. the 1st of next month) wrongly matches.
|
||||||
|
if hi_pair is not None:
|
||||||
|
hi_iso = _fmt(hi_pair[1])
|
||||||
|
hi_close = "]" if hi_pair[0] == hi_pair[1] else "}"
|
||||||
|
else:
|
||||||
|
hi_iso = OPEN_HI
|
||||||
|
hi_close = "]"
|
||||||
|
|
||||||
|
return f"{field}:[{lo_iso} TO {hi_iso}{hi_close}"
|
||||||
|
|||||||
@@ -1134,6 +1134,11 @@ def before_task_publish_handler(
|
|||||||
return
|
return
|
||||||
|
|
||||||
try:
|
try:
|
||||||
|
# Close stale connections without disrupting a transaction publishing a task
|
||||||
|
for connection in connections.all(initialized_only=True):
|
||||||
|
if not connection.in_atomic_block:
|
||||||
|
connection.close_if_unusable_or_obsolete()
|
||||||
|
|
||||||
_, task_kwargs, _ = body
|
_, task_kwargs, _ = body
|
||||||
task_id = headers["id"]
|
task_id = headers["id"]
|
||||||
|
|
||||||
|
|||||||
@@ -9,6 +9,7 @@ if TYPE_CHECKING:
|
|||||||
|
|
||||||
_COMPACT = "documents.management.commands.document_llmindex.llm_index_compact"
|
_COMPACT = "documents.management.commands.document_llmindex.llm_index_compact"
|
||||||
_INDEX = "documents.management.commands.document_llmindex.llmindex_index"
|
_INDEX = "documents.management.commands.document_llmindex.llmindex_index"
|
||||||
|
_MIGRATE = "documents.management.commands.document_llmindex.llm_index_migrate"
|
||||||
|
|
||||||
|
|
||||||
class TestDocumentLlmindexCommand:
|
class TestDocumentLlmindexCommand:
|
||||||
@@ -17,6 +18,11 @@ class TestDocumentLlmindexCommand:
|
|||||||
call_command("document_llmindex", "compact")
|
call_command("document_llmindex", "compact")
|
||||||
mock_compact.assert_called_once_with()
|
mock_compact.assert_called_once_with()
|
||||||
|
|
||||||
|
def test_migrate_calls_llm_index_migrate(self, mocker: MockerFixture) -> None:
|
||||||
|
mock_migrate = mocker.patch(_MIGRATE)
|
||||||
|
call_command("document_llmindex", "migrate")
|
||||||
|
mock_migrate.assert_called_once_with()
|
||||||
|
|
||||||
def test_rebuild_calls_llmindex_index_with_rebuild_true(
|
def test_rebuild_calls_llmindex_index_with_rebuild_true(
|
||||||
self,
|
self,
|
||||||
mocker: MockerFixture,
|
mocker: MockerFixture,
|
||||||
|
|||||||
@@ -32,7 +32,9 @@ AUCKLAND = ZoneInfo("Pacific/Auckland") # UTC+13 in southern-hemisphere summer
|
|||||||
|
|
||||||
|
|
||||||
def _range(result: str, field: str) -> tuple[str, str]:
|
def _range(result: str, field: str) -> tuple[str, str]:
|
||||||
m = re.search(rf"{field}:\[(.+?) TO (.+?)\]", result)
|
# Half-open period ranges close with "}" (exclusive); exact-instant ranges
|
||||||
|
# (full ISO datetimes, "now", relative offsets) close with "]" (inclusive).
|
||||||
|
m = re.search(rf"{field}:\[(.+?) TO (.+?)[\]}}]", result)
|
||||||
assert m, f"No range for {field!r} in: {result!r}"
|
assert m, f"No range for {field!r} in: {result!r}"
|
||||||
return m.group(1), m.group(2)
|
return m.group(1), m.group(2)
|
||||||
|
|
||||||
|
|||||||
@@ -214,27 +214,27 @@ class TestTranslateScalar:
|
|||||||
(
|
(
|
||||||
"created",
|
"created",
|
||||||
"2020",
|
"2020",
|
||||||
"created:[2020-01-01T00:00:00Z TO 2021-01-01T00:00:00Z]",
|
"created:[2020-01-01T00:00:00Z TO 2021-01-01T00:00:00Z}",
|
||||||
),
|
),
|
||||||
(
|
(
|
||||||
"created",
|
"created",
|
||||||
"202003",
|
"202003",
|
||||||
"created:[2020-03-01T00:00:00Z TO 2020-04-01T00:00:00Z]",
|
"created:[2020-03-01T00:00:00Z TO 2020-04-01T00:00:00Z}",
|
||||||
),
|
),
|
||||||
(
|
(
|
||||||
"created",
|
"created",
|
||||||
"20200115",
|
"20200115",
|
||||||
"created:[2020-01-15T00:00:00Z TO 2020-01-16T00:00:00Z]",
|
"created:[2020-01-15T00:00:00Z TO 2020-01-16T00:00:00Z}",
|
||||||
),
|
),
|
||||||
(
|
(
|
||||||
"created",
|
"created",
|
||||||
"2020-01-15",
|
"2020-01-15",
|
||||||
"created:[2020-01-15T00:00:00Z TO 2020-01-16T00:00:00Z]",
|
"created:[2020-01-15T00:00:00Z TO 2020-01-16T00:00:00Z}",
|
||||||
),
|
),
|
||||||
(
|
(
|
||||||
"created",
|
"created",
|
||||||
"2020-03",
|
"2020-03",
|
||||||
"created:[2020-03-01T00:00:00Z TO 2020-04-01T00:00:00Z]",
|
"created:[2020-03-01T00:00:00Z TO 2020-04-01T00:00:00Z}",
|
||||||
),
|
),
|
||||||
],
|
],
|
||||||
)
|
)
|
||||||
@@ -248,9 +248,9 @@ class TestTranslateScalar:
|
|||||||
assert exc_info.value.value == "202023"
|
assert exc_info.value.value == "202023"
|
||||||
|
|
||||||
def test_keyword_delegates(self) -> None:
|
def test_keyword_delegates(self) -> None:
|
||||||
# keyword path produces a range; just assert it is a created range
|
# keyword path produces a half-open range; just assert it is a created range
|
||||||
out = translate_scalar("created", "today", UTC)
|
out = translate_scalar("created", "today", UTC)
|
||||||
assert out.startswith("created:[") and out.endswith("]")
|
assert out.startswith("created:[") and out.endswith("}")
|
||||||
|
|
||||||
def test_14digit_compact_datetime(self) -> None:
|
def test_14digit_compact_datetime(self) -> None:
|
||||||
out = translate_scalar("created", "20240115120000", UTC)
|
out = translate_scalar("created", "20240115120000", UTC)
|
||||||
@@ -279,21 +279,21 @@ class TestTranslateRange:
|
|||||||
@pytest.mark.parametrize(
|
@pytest.mark.parametrize(
|
||||||
("lo", "hi", "expected"),
|
("lo", "hi", "expected"),
|
||||||
[
|
[
|
||||||
("2005", "2009", "created:[2005-01-01T00:00:00Z TO 2010-01-01T00:00:00Z]"),
|
("2005", "2009", "created:[2005-01-01T00:00:00Z TO 2010-01-01T00:00:00Z}"),
|
||||||
(
|
(
|
||||||
"202001",
|
"202001",
|
||||||
"202006",
|
"202006",
|
||||||
"created:[2020-01-01T00:00:00Z TO 2020-07-01T00:00:00Z]",
|
"created:[2020-01-01T00:00:00Z TO 2020-07-01T00:00:00Z}",
|
||||||
),
|
),
|
||||||
(
|
(
|
||||||
"20200101",
|
"20200101",
|
||||||
"20201231",
|
"20201231",
|
||||||
"created:[2020-01-01T00:00:00Z TO 2021-01-01T00:00:00Z]",
|
"created:[2020-01-01T00:00:00Z TO 2021-01-01T00:00:00Z}",
|
||||||
),
|
),
|
||||||
(
|
(
|
||||||
"2020-01-01",
|
"2020-01-01",
|
||||||
"2020-12-31",
|
"2020-12-31",
|
||||||
"created:[2020-01-01T00:00:00Z TO 2021-01-01T00:00:00Z]",
|
"created:[2020-01-01T00:00:00Z TO 2021-01-01T00:00:00Z}",
|
||||||
),
|
),
|
||||||
],
|
],
|
||||||
)
|
)
|
||||||
@@ -302,7 +302,7 @@ class TestTranslateRange:
|
|||||||
|
|
||||||
def test_reversed_swaps(self):
|
def test_reversed_swaps(self):
|
||||||
assert translate_range("created", "2009", "2005", UTC) == (
|
assert translate_range("created", "2009", "2005", UTC) == (
|
||||||
"created:[2005-01-01T00:00:00Z TO 2010-01-01T00:00:00Z]"
|
"created:[2005-01-01T00:00:00Z TO 2010-01-01T00:00:00Z}"
|
||||||
)
|
)
|
||||||
|
|
||||||
def test_open_upper(self):
|
def test_open_upper(self):
|
||||||
@@ -311,7 +311,7 @@ class TestTranslateRange:
|
|||||||
|
|
||||||
def test_open_lower(self):
|
def test_open_lower(self):
|
||||||
out = translate_range("created", "", "2020", UTC)
|
out = translate_range("created", "", "2020", UTC)
|
||||||
assert out == f"created:[{OPEN_LO} TO 2021-01-01T00:00:00Z]"
|
assert out == f"created:[{OPEN_LO} TO 2021-01-01T00:00:00Z}}"
|
||||||
|
|
||||||
def test_invalid_bound_raises(self):
|
def test_invalid_bound_raises(self):
|
||||||
with pytest.raises(InvalidDateQuery) as exc_info:
|
with pytest.raises(InvalidDateQuery) as exc_info:
|
||||||
@@ -334,16 +334,16 @@ class TestTranslateQuery:
|
|||||||
[
|
[
|
||||||
(
|
(
|
||||||
"created:2020",
|
"created:2020",
|
||||||
"created:[2020-01-01T00:00:00Z TO 2021-01-01T00:00:00Z]",
|
"created:[2020-01-01T00:00:00Z TO 2021-01-01T00:00:00Z}",
|
||||||
),
|
),
|
||||||
("tag:foo,bar", "tag:foo AND tag:bar"),
|
("tag:foo,bar", "tag:foo AND tag:bar"),
|
||||||
# 'type' is a user-facing alias rewritten to 'document_type' (the real schema field)
|
# 'type' is a user-facing alias rewritten to 'document_type' (the real schema field)
|
||||||
("tag:foo,type:bar", "tag:foo AND document_type:bar"),
|
("tag:foo,type:bar", "tag:foo AND document_type:bar"),
|
||||||
(
|
(
|
||||||
"created:[2020 TO 2021],added:[2022 TO 2023]",
|
"created:[2020 TO 2021],added:[2022 TO 2023]",
|
||||||
"created:[2020-01-01T00:00:00Z TO 2022-01-01T00:00:00Z]"
|
"created:[2020-01-01T00:00:00Z TO 2022-01-01T00:00:00Z}"
|
||||||
" AND "
|
" AND "
|
||||||
"added:[2022-01-01T00:00:00Z TO 2024-01-01T00:00:00Z]",
|
"added:[2022-01-01T00:00:00Z TO 2024-01-01T00:00:00Z}",
|
||||||
),
|
),
|
||||||
# correspondent is not multi-value: comma stays literal inside the value
|
# correspondent is not multi-value: comma stays literal inside the value
|
||||||
("correspondent:foo,bar", "correspondent:foo,bar"),
|
("correspondent:foo,bar", "correspondent:foo,bar"),
|
||||||
@@ -506,7 +506,7 @@ class TestOperatorNormalization:
|
|||||||
def test_date_range_preserved(self) -> None:
|
def test_date_range_preserved(self) -> None:
|
||||||
out = translate_query("created:[2020 TO 2021]", UTC)
|
out = translate_query("created:[2020 TO 2021]", UTC)
|
||||||
# Must not corrupt the ISO range
|
# Must not corrupt the ISO range
|
||||||
assert out == "created:[2020-01-01T00:00:00Z TO 2022-01-01T00:00:00Z]"
|
assert out == "created:[2020-01-01T00:00:00Z TO 2022-01-01T00:00:00Z}"
|
||||||
|
|
||||||
def test_date_scalar_with_or(self) -> None:
|
def test_date_scalar_with_or(self) -> None:
|
||||||
out = translate_query("created:2020 OR foo", UTC)
|
out = translate_query("created:2020 OR foo", UTC)
|
||||||
@@ -581,42 +581,42 @@ class TestKeywordDateResolution:
|
|||||||
[
|
[
|
||||||
pytest.param(
|
pytest.param(
|
||||||
"today",
|
"today",
|
||||||
"created:[2026-03-28T00:00:00Z TO 2026-03-29T00:00:00Z]",
|
"created:[2026-03-28T00:00:00Z TO 2026-03-29T00:00:00Z}",
|
||||||
id="today",
|
id="today",
|
||||||
),
|
),
|
||||||
pytest.param(
|
pytest.param(
|
||||||
"yesterday",
|
"yesterday",
|
||||||
"created:[2026-03-27T00:00:00Z TO 2026-03-28T00:00:00Z]",
|
"created:[2026-03-27T00:00:00Z TO 2026-03-28T00:00:00Z}",
|
||||||
id="yesterday",
|
id="yesterday",
|
||||||
),
|
),
|
||||||
pytest.param(
|
pytest.param(
|
||||||
"previous week",
|
"previous week",
|
||||||
"created:[2026-03-16T00:00:00Z TO 2026-03-23T00:00:00Z]",
|
"created:[2026-03-16T00:00:00Z TO 2026-03-23T00:00:00Z}",
|
||||||
id="previous-week",
|
id="previous-week",
|
||||||
),
|
),
|
||||||
pytest.param(
|
pytest.param(
|
||||||
"this month",
|
"this month",
|
||||||
"created:[2026-03-01T00:00:00Z TO 2026-04-01T00:00:00Z]",
|
"created:[2026-03-01T00:00:00Z TO 2026-04-01T00:00:00Z}",
|
||||||
id="this-month",
|
id="this-month",
|
||||||
),
|
),
|
||||||
pytest.param(
|
pytest.param(
|
||||||
"previous month",
|
"previous month",
|
||||||
"created:[2026-02-01T00:00:00Z TO 2026-03-01T00:00:00Z]",
|
"created:[2026-02-01T00:00:00Z TO 2026-03-01T00:00:00Z}",
|
||||||
id="previous-month",
|
id="previous-month",
|
||||||
),
|
),
|
||||||
pytest.param(
|
pytest.param(
|
||||||
"this year",
|
"this year",
|
||||||
"created:[2026-01-01T00:00:00Z TO 2027-01-01T00:00:00Z]",
|
"created:[2026-01-01T00:00:00Z TO 2027-01-01T00:00:00Z}",
|
||||||
id="this-year",
|
id="this-year",
|
||||||
),
|
),
|
||||||
pytest.param(
|
pytest.param(
|
||||||
"previous year",
|
"previous year",
|
||||||
"created:[2025-01-01T00:00:00Z TO 2026-01-01T00:00:00Z]",
|
"created:[2025-01-01T00:00:00Z TO 2026-01-01T00:00:00Z}",
|
||||||
id="previous-year",
|
id="previous-year",
|
||||||
),
|
),
|
||||||
pytest.param(
|
pytest.param(
|
||||||
"previous quarter",
|
"previous quarter",
|
||||||
"created:[2025-10-01T00:00:00Z TO 2026-01-01T00:00:00Z]",
|
"created:[2025-10-01T00:00:00Z TO 2026-01-01T00:00:00Z}",
|
||||||
id="previous-quarter",
|
id="previous-quarter",
|
||||||
),
|
),
|
||||||
],
|
],
|
||||||
@@ -637,42 +637,42 @@ class TestKeywordDateResolution:
|
|||||||
[
|
[
|
||||||
pytest.param(
|
pytest.param(
|
||||||
"today",
|
"today",
|
||||||
"added:[2026-03-27T15:00:00Z TO 2026-03-28T15:00:00Z]",
|
"added:[2026-03-27T15:00:00Z TO 2026-03-28T15:00:00Z}",
|
||||||
id="today",
|
id="today",
|
||||||
),
|
),
|
||||||
pytest.param(
|
pytest.param(
|
||||||
"yesterday",
|
"yesterday",
|
||||||
"added:[2026-03-26T15:00:00Z TO 2026-03-27T15:00:00Z]",
|
"added:[2026-03-26T15:00:00Z TO 2026-03-27T15:00:00Z}",
|
||||||
id="yesterday",
|
id="yesterday",
|
||||||
),
|
),
|
||||||
pytest.param(
|
pytest.param(
|
||||||
"previous week",
|
"previous week",
|
||||||
"added:[2026-03-15T15:00:00Z TO 2026-03-22T15:00:00Z]",
|
"added:[2026-03-15T15:00:00Z TO 2026-03-22T15:00:00Z}",
|
||||||
id="previous-week",
|
id="previous-week",
|
||||||
),
|
),
|
||||||
pytest.param(
|
pytest.param(
|
||||||
"this month",
|
"this month",
|
||||||
"added:[2026-02-28T15:00:00Z TO 2026-03-31T15:00:00Z]",
|
"added:[2026-02-28T15:00:00Z TO 2026-03-31T15:00:00Z}",
|
||||||
id="this-month",
|
id="this-month",
|
||||||
),
|
),
|
||||||
pytest.param(
|
pytest.param(
|
||||||
"previous month",
|
"previous month",
|
||||||
"added:[2026-01-31T15:00:00Z TO 2026-02-28T15:00:00Z]",
|
"added:[2026-01-31T15:00:00Z TO 2026-02-28T15:00:00Z}",
|
||||||
id="previous-month",
|
id="previous-month",
|
||||||
),
|
),
|
||||||
pytest.param(
|
pytest.param(
|
||||||
"this year",
|
"this year",
|
||||||
"added:[2025-12-31T15:00:00Z TO 2026-12-31T15:00:00Z]",
|
"added:[2025-12-31T15:00:00Z TO 2026-12-31T15:00:00Z}",
|
||||||
id="this-year",
|
id="this-year",
|
||||||
),
|
),
|
||||||
pytest.param(
|
pytest.param(
|
||||||
"previous year",
|
"previous year",
|
||||||
"added:[2024-12-31T15:00:00Z TO 2025-12-31T15:00:00Z]",
|
"added:[2024-12-31T15:00:00Z TO 2025-12-31T15:00:00Z}",
|
||||||
id="previous-year",
|
id="previous-year",
|
||||||
),
|
),
|
||||||
pytest.param(
|
pytest.param(
|
||||||
"previous quarter",
|
"previous quarter",
|
||||||
"added:[2025-09-30T15:00:00Z TO 2025-12-31T15:00:00Z]",
|
"added:[2025-09-30T15:00:00Z TO 2025-12-31T15:00:00Z}",
|
||||||
id="previous-quarter",
|
id="previous-quarter",
|
||||||
),
|
),
|
||||||
],
|
],
|
||||||
@@ -719,7 +719,7 @@ class TestISODatetimeBounds:
|
|||||||
def test_translate_query_text_before_comma_separated_date_clause(self) -> None:
|
def test_translate_query_text_before_comma_separated_date_clause(self) -> None:
|
||||||
result = translate_query("schäfersee,created:previous year", UTC)
|
result = translate_query("schäfersee,created:previous year", UTC)
|
||||||
assert result == (
|
assert result == (
|
||||||
"schäfersee AND created:[2025-01-01T00:00:00Z TO 2026-01-01T00:00:00Z]"
|
"schäfersee AND created:[2025-01-01T00:00:00Z TO 2026-01-01T00:00:00Z}"
|
||||||
)
|
)
|
||||||
|
|
||||||
def test_invalid_iso_datetime_raises(self) -> None:
|
def test_invalid_iso_datetime_raises(self) -> None:
|
||||||
|
|||||||
@@ -75,7 +75,7 @@ class TestEmail(DirectoriesMixin, SampleDirMixin, APITestCase):
|
|||||||
{
|
{
|
||||||
"documents": [self.doc1.pk, self.doc2.pk],
|
"documents": [self.doc1.pk, self.doc2.pk],
|
||||||
"addresses": "hello@paperless-ngx.com,test@example.com",
|
"addresses": "hello@paperless-ngx.com,test@example.com",
|
||||||
"subject": "Bulk email test",
|
"subject": "Bulk email\n test",
|
||||||
"message": "Here are your documents",
|
"message": "Here are your documents",
|
||||||
},
|
},
|
||||||
),
|
),
|
||||||
|
|||||||
@@ -720,6 +720,48 @@ class TestDocumentSearchApi(DirectoriesMixin, APITestCase):
|
|||||||
self.assertEqual(results[0]["id"], 3)
|
self.assertEqual(results[0]["id"], 3)
|
||||||
self.assertEqual(results[0]["title"], "bank statement 3")
|
self.assertEqual(results[0]["title"], "bank statement 3")
|
||||||
|
|
||||||
|
def test_search_added_previous_month_excludes_next_period_start(self) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- One document added at the last instant of last month
|
||||||
|
- One document added exactly at the first instant of this month
|
||||||
|
WHEN:
|
||||||
|
- Query for documents added in the previous month
|
||||||
|
THEN:
|
||||||
|
- Only the document from last month is returned; the document dated
|
||||||
|
exactly at the start of this month (the exclusive upper bound of
|
||||||
|
the range) is not
|
||||||
|
"""
|
||||||
|
d1 = DocumentFactory.create(
|
||||||
|
title="end of last month",
|
||||||
|
content="last instant of last month",
|
||||||
|
checksum="A",
|
||||||
|
pk=1,
|
||||||
|
added=timezone.make_aware(datetime.datetime(2024, 1, 31, 23, 59, 59)),
|
||||||
|
)
|
||||||
|
d2 = DocumentFactory.create(
|
||||||
|
title="start of this month",
|
||||||
|
content="first instant of this month",
|
||||||
|
checksum="B",
|
||||||
|
pk=2,
|
||||||
|
added=timezone.make_aware(datetime.datetime(2024, 2, 1, 0, 0, 0)),
|
||||||
|
)
|
||||||
|
|
||||||
|
backend = get_backend()
|
||||||
|
backend.add_or_update(d1)
|
||||||
|
backend.add_or_update(d2)
|
||||||
|
|
||||||
|
with time_machine.travel(
|
||||||
|
timezone.make_aware(datetime.datetime(2024, 2, 15, 12, 0, 0)),
|
||||||
|
tick=False,
|
||||||
|
):
|
||||||
|
response = self.client.get("/api/documents/?query=added:previous month")
|
||||||
|
results = response.data["results"]
|
||||||
|
|
||||||
|
self.assertEqual(len(results), 1)
|
||||||
|
self.assertEqual(results[0]["id"], 1)
|
||||||
|
self.assertEqual(results[0]["title"], "end of last month")
|
||||||
|
|
||||||
def test_search_added_invalid_date(self) -> None:
|
def test_search_added_invalid_date(self) -> None:
|
||||||
"""
|
"""
|
||||||
GIVEN:
|
GIVEN:
|
||||||
|
|||||||
@@ -1329,7 +1329,7 @@ class PreConsumeTestCase(DirectoriesMixin, GetConsumerMixin, TestCase):
|
|||||||
with self.get_consumer(self.test_file) as c:
|
with self.get_consumer(self.test_file) as c:
|
||||||
c.run()
|
c.run()
|
||||||
# Verify no pre-consume script subprocess was invoked
|
# Verify no pre-consume script subprocess was invoked
|
||||||
# (run_subprocess may still be called by _extract_text_for_archive_check)
|
# (run_subprocess may still be called by pdf_born_digital_text via pdftotext)
|
||||||
script_calls = [
|
script_calls = [
|
||||||
call
|
call
|
||||||
for call in m.call_args_list
|
for call in m.call_args_list
|
||||||
@@ -1354,7 +1354,7 @@ class PreConsumeTestCase(DirectoriesMixin, GetConsumerMixin, TestCase):
|
|||||||
self.assertTrue(m.called)
|
self.assertTrue(m.called)
|
||||||
|
|
||||||
# Find the call that invoked the pre-consume script
|
# Find the call that invoked the pre-consume script
|
||||||
# (run_subprocess may also be called by _extract_text_for_archive_check)
|
# (run_subprocess may also be called by pdf_born_digital_text via pdftotext)
|
||||||
script_call = next(
|
script_call = next(
|
||||||
call
|
call
|
||||||
for call in m.call_args_list
|
for call in m.call_args_list
|
||||||
|
|||||||
@@ -134,60 +134,32 @@ class TestShouldProduceArchive:
|
|||||||
assert should_produce_archive(parser, mime, Path("/tmp/doc")) is expected
|
assert should_produce_archive(parser, mime, Path("/tmp/doc")) is expected
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
@pytest.mark.parametrize(
|
||||||
("extracted_text", "expected"),
|
("born_digital", "expected"),
|
||||||
[
|
[
|
||||||
pytest.param(
|
pytest.param(True, False, id="born-digital-skips-archive"),
|
||||||
"This is a born-digital PDF with lots of text content. " * 10,
|
pytest.param(False, True, id="not-born-digital-produces-archive"),
|
||||||
False,
|
|
||||||
id="born-digital-long-text-skips-archive",
|
|
||||||
),
|
|
||||||
pytest.param(None, True, id="no-text-scanned-produces-archive"),
|
|
||||||
pytest.param("tiny", True, id="short-text-treated-as-scanned"),
|
|
||||||
],
|
],
|
||||||
)
|
)
|
||||||
def test_auto_pdf_archive_decision(
|
def test_auto_pdf_archive_decision(
|
||||||
self,
|
self,
|
||||||
mocker: MockerFixture,
|
mocker: MockerFixture,
|
||||||
settings,
|
settings,
|
||||||
extracted_text: str | None,
|
born_digital: bool, # noqa: FBT001
|
||||||
expected: bool, # noqa: FBT001
|
expected: bool, # noqa: FBT001
|
||||||
) -> None:
|
) -> None:
|
||||||
|
"""Archive decision tracks pdf_born_digital_text()'s verdict exactly.
|
||||||
|
|
||||||
|
should_produce_archive() defers entirely to pdf_born_digital_text()
|
||||||
|
for the has-real-text decision, so both callers of that predicate
|
||||||
|
(this function and RasterisedDocumentParser.parse()) always agree.
|
||||||
|
"""
|
||||||
settings.ARCHIVE_FILE_GENERATION = "auto"
|
settings.ARCHIVE_FILE_GENERATION = "auto"
|
||||||
mocker.patch("documents.consumer.is_tagged_pdf", return_value=False)
|
mocker.patch(
|
||||||
mocker.patch("documents.consumer.extract_pdf_text", return_value=extracted_text)
|
"documents.consumer.pdf_born_digital_text",
|
||||||
|
return_value=("some text", born_digital),
|
||||||
|
)
|
||||||
parser = _parser_instance(can_produce=True, requires_rendition=False)
|
parser = _parser_instance(can_produce=True, requires_rendition=False)
|
||||||
assert (
|
assert (
|
||||||
should_produce_archive(parser, "application/pdf", Path("/tmp/doc.pdf"))
|
should_produce_archive(parser, "application/pdf", Path("/tmp/doc.pdf"))
|
||||||
is expected
|
is expected
|
||||||
)
|
)
|
||||||
|
|
||||||
def test_tagged_pdf_skips_archive_in_auto_mode(
|
|
||||||
self,
|
|
||||||
mocker: MockerFixture,
|
|
||||||
settings,
|
|
||||||
) -> None:
|
|
||||||
"""Tagged PDFs (e.g. Word exports) with real text are treated as born-digital, even below PDF_TEXT_MIN_LENGTH."""
|
|
||||||
settings.ARCHIVE_FILE_GENERATION = "auto"
|
|
||||||
mocker.patch("documents.consumer.is_tagged_pdf", return_value=True)
|
|
||||||
mocker.patch("documents.consumer.extract_pdf_text", return_value="tiny")
|
|
||||||
parser = _parser_instance(can_produce=True, requires_rendition=False)
|
|
||||||
assert (
|
|
||||||
should_produce_archive(parser, "application/pdf", Path("/tmp/doc.pdf"))
|
|
||||||
is False
|
|
||||||
)
|
|
||||||
|
|
||||||
def test_tagged_pdf_without_text_produces_archive(
|
|
||||||
self,
|
|
||||||
mocker: MockerFixture,
|
|
||||||
settings,
|
|
||||||
) -> None:
|
|
||||||
"""A tagged PDF with no actual extractable text (e.g. some scanner firmware) is not
|
|
||||||
trusted as born-digital — the tag alone must not bypass OCR."""
|
|
||||||
settings.ARCHIVE_FILE_GENERATION = "auto"
|
|
||||||
mocker.patch("documents.consumer.is_tagged_pdf", return_value=True)
|
|
||||||
mocker.patch("documents.consumer.extract_pdf_text", return_value=None)
|
|
||||||
parser = _parser_instance(can_produce=True, requires_rendition=False)
|
|
||||||
assert (
|
|
||||||
should_produce_archive(parser, "application/pdf", Path("/tmp/doc.pdf"))
|
|
||||||
is True
|
|
||||||
)
|
|
||||||
|
|||||||
@@ -56,6 +56,32 @@ def send_publish(
|
|||||||
|
|
||||||
@pytest.mark.django_db
|
@pytest.mark.django_db
|
||||||
class TestBeforeTaskPublishHandler:
|
class TestBeforeTaskPublishHandler:
|
||||||
|
@mock.patch("documents.signals.handlers.connections.all")
|
||||||
|
def test_closes_old_connections_outside_atomic_blocks(
|
||||||
|
self,
|
||||||
|
connections_all,
|
||||||
|
) -> None:
|
||||||
|
connection = mock.Mock(in_atomic_block=False)
|
||||||
|
connections_all.return_value = [connection]
|
||||||
|
|
||||||
|
task_id = send_publish("documents.tasks.train_classifier", (), {})
|
||||||
|
|
||||||
|
connection.close_if_unusable_or_obsolete.assert_called_once_with()
|
||||||
|
assert PaperlessTask.objects.filter(task_id=task_id).exists()
|
||||||
|
|
||||||
|
@mock.patch("documents.signals.handlers.connections.all")
|
||||||
|
def test_keeps_connections_open_inside_atomic_blocks(
|
||||||
|
self,
|
||||||
|
connections_all,
|
||||||
|
) -> None:
|
||||||
|
connection = mock.Mock(in_atomic_block=True)
|
||||||
|
connections_all.return_value = [connection]
|
||||||
|
|
||||||
|
task_id = send_publish("documents.tasks.train_classifier", (), {})
|
||||||
|
|
||||||
|
connection.close_if_unusable_or_obsolete.assert_not_called()
|
||||||
|
assert PaperlessTask.objects.filter(task_id=task_id).exists()
|
||||||
|
|
||||||
def test_creates_task_for_consume_file(
|
def test_creates_task_for_consume_file(
|
||||||
self,
|
self,
|
||||||
consume_input_doc,
|
consume_input_doc,
|
||||||
|
|||||||
@@ -3,7 +3,6 @@ from __future__ import annotations
|
|||||||
import importlib.resources
|
import importlib.resources
|
||||||
import logging
|
import logging
|
||||||
import os
|
import os
|
||||||
import re
|
|
||||||
import shutil
|
import shutil
|
||||||
import tempfile
|
import tempfile
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
@@ -25,9 +24,9 @@ from paperless.config import OcrConfig
|
|||||||
from paperless.models import CleanChoices
|
from paperless.models import CleanChoices
|
||||||
from paperless.models import ModeChoices
|
from paperless.models import ModeChoices
|
||||||
from paperless.models import OutputTypeChoices
|
from paperless.models import OutputTypeChoices
|
||||||
from paperless.parsers.utils import PDF_TEXT_MIN_LENGTH
|
|
||||||
from paperless.parsers.utils import extract_pdf_text
|
from paperless.parsers.utils import extract_pdf_text
|
||||||
from paperless.parsers.utils import is_tagged_pdf
|
from paperless.parsers.utils import is_born_digital_text
|
||||||
|
from paperless.parsers.utils import post_process_text
|
||||||
from paperless.parsers.utils import read_file_handle_unicode_errors
|
from paperless.parsers.utils import read_file_handle_unicode_errors
|
||||||
from paperless.version import __full_version_str__
|
from paperless.version import __full_version_str__
|
||||||
|
|
||||||
@@ -510,10 +509,10 @@ class RasterisedDocumentParser:
|
|||||||
|
|
||||||
if mime_type == "application/pdf":
|
if mime_type == "application/pdf":
|
||||||
text_original = self.extract_text(None, document_path)
|
text_original = self.extract_text(None, document_path)
|
||||||
has_text = text_original is not None and len(text_original) > 0
|
original_has_text = is_born_digital_text(
|
||||||
original_has_text = has_text and (
|
text_original,
|
||||||
is_tagged_pdf(document_path, log=self.log)
|
document_path,
|
||||||
or len(text_original) > PDF_TEXT_MIN_LENGTH
|
log=self.log,
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
text_original = None
|
text_original = None
|
||||||
@@ -658,17 +657,3 @@ class RasterisedDocumentParser:
|
|||||||
f"No text was found in {document_path}, the content will be empty.",
|
f"No text was found in {document_path}, the content will be empty.",
|
||||||
)
|
)
|
||||||
self.text = ""
|
self.text = ""
|
||||||
|
|
||||||
|
|
||||||
def post_process_text(text: str | None) -> str | None:
|
|
||||||
if not text:
|
|
||||||
return None
|
|
||||||
|
|
||||||
collapsed_spaces = re.sub(r"([^\S\r\n]+)", " ", text)
|
|
||||||
no_leading_whitespace = re.sub(r"([\n\r]+)([^\S\n\r]+)", "\\1", collapsed_spaces)
|
|
||||||
no_trailing_whitespace = re.sub(r"([^\S\n\r]+)$", "", no_leading_whitespace)
|
|
||||||
|
|
||||||
# TODO: this needs a rework
|
|
||||||
# replace \0 prevents issues with saving to postgres.
|
|
||||||
# text may contain \0 when this character is present in PDF files.
|
|
||||||
return no_trailing_whitespace.strip().replace("\0", " ")
|
|
||||||
|
|||||||
@@ -111,6 +111,88 @@ def extract_pdf_text(
|
|||||||
return None
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def post_process_text(text: str | None) -> str | None:
|
||||||
|
"""Normalize extracted PDF/OCR text: collapse whitespace, strip padding.
|
||||||
|
|
||||||
|
Returns ``None`` for ``None`` or whitespace-only input, so callers can
|
||||||
|
treat "no text" and "only layout padding" the same way.
|
||||||
|
"""
|
||||||
|
if not text:
|
||||||
|
return None
|
||||||
|
|
||||||
|
collapsed_spaces = re.sub(r"([^\S\r\n]+)", " ", text)
|
||||||
|
no_leading_whitespace = re.sub(r"([\n\r]+)([^\S\n\r]+)", "\\1", collapsed_spaces)
|
||||||
|
no_trailing_whitespace = re.sub(r"([^\S\n\r]+)$", "", no_leading_whitespace)
|
||||||
|
|
||||||
|
# replace \0 prevents issues with saving to postgres.
|
||||||
|
# text may contain \0 when this character is present in PDF files.
|
||||||
|
result = no_trailing_whitespace.strip().replace("\0", " ")
|
||||||
|
return result or None
|
||||||
|
|
||||||
|
|
||||||
|
def is_born_digital_text(
|
||||||
|
text: str | None,
|
||||||
|
path: Path,
|
||||||
|
log: logging.Logger | None = None,
|
||||||
|
) -> bool:
|
||||||
|
"""Decide whether already-extracted, normalized PDF text counts as born-digital.
|
||||||
|
|
||||||
|
This is the single source of truth for "does this PDF already have real
|
||||||
|
text", used both to decide whether to produce an archive file and to
|
||||||
|
decide whether OCR can be skipped. Both decisions must agree, or a
|
||||||
|
tagged-but-textless PDF can end up with no archive AND a forced OCR pass
|
||||||
|
(see GH #13387): raw ``pdftotext -layout`` output can be non-empty
|
||||||
|
(whitespace/form-feed padding) even when there is no real content, so
|
||||||
|
*text* must already be normalized via :func:`post_process_text`, not the
|
||||||
|
raw extraction.
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
text:
|
||||||
|
The normalized extracted text (or ``None``) to evaluate.
|
||||||
|
path:
|
||||||
|
Absolute path to the PDF file, used for the tagged-PDF check.
|
||||||
|
log:
|
||||||
|
Logger for warnings. Falls back to the module-level logger when omitted.
|
||||||
|
|
||||||
|
Returns
|
||||||
|
-------
|
||||||
|
bool
|
||||||
|
Whether the PDF counts as born-digital (has real text, and is either
|
||||||
|
tagged or exceeds ``PDF_TEXT_MIN_LENGTH``).
|
||||||
|
"""
|
||||||
|
if not text:
|
||||||
|
return False
|
||||||
|
return is_tagged_pdf(path, log=log) or len(text) > PDF_TEXT_MIN_LENGTH
|
||||||
|
|
||||||
|
|
||||||
|
def pdf_born_digital_text(
|
||||||
|
path: Path,
|
||||||
|
log: logging.Logger | None = None,
|
||||||
|
) -> tuple[str | None, bool]:
|
||||||
|
"""Extract a PDF's text and decide whether it should be treated as born-digital.
|
||||||
|
|
||||||
|
Convenience wrapper around :func:`is_born_digital_text` for callers that
|
||||||
|
don't already have the PDF's text extracted (e.g. the archive-generation
|
||||||
|
decision, which runs before any parser has touched the file).
|
||||||
|
|
||||||
|
Parameters
|
||||||
|
----------
|
||||||
|
path:
|
||||||
|
Absolute path to the PDF file.
|
||||||
|
log:
|
||||||
|
Logger for warnings. Falls back to the module-level logger when omitted.
|
||||||
|
|
||||||
|
Returns
|
||||||
|
-------
|
||||||
|
tuple[str | None, bool]
|
||||||
|
The normalized extracted text (or ``None``), and whether the PDF
|
||||||
|
counts as born-digital.
|
||||||
|
"""
|
||||||
|
text = post_process_text(extract_pdf_text(path, log=log))
|
||||||
|
return text, is_born_digital_text(text, path, log=log)
|
||||||
|
|
||||||
|
|
||||||
def read_file_handle_unicode_errors(
|
def read_file_handle_unicode_errors(
|
||||||
filepath: Path,
|
filepath: Path,
|
||||||
log: logging.Logger | None = None,
|
log: logging.Logger | None = None,
|
||||||
|
|||||||
@@ -36,6 +36,23 @@ def samples_dir() -> Path:
|
|||||||
return (Path(__file__).parent / "samples").resolve()
|
return (Path(__file__).parent / "samples").resolve()
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture(scope="session")
|
||||||
|
def tagged_no_text_pdf_file(samples_dir: Path) -> Path:
|
||||||
|
"""Path to a tagged PDF whose only "text" is pdftotext layout padding.
|
||||||
|
|
||||||
|
Reproduces GH #13387: ``/MarkInfo /Marked true`` is set, but the only
|
||||||
|
extractable content is a form-feed byte, not real text. Lives here
|
||||||
|
rather than in parsers/conftest.py so both parser tests and
|
||||||
|
paperless/tests/test_parser_utils.py can use it.
|
||||||
|
|
||||||
|
Returns
|
||||||
|
-------
|
||||||
|
Path
|
||||||
|
Absolute path to ``tesseract/tagged-but-no-text.pdf``.
|
||||||
|
"""
|
||||||
|
return samples_dir / "tesseract" / "tagged-but-no-text.pdf"
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture(autouse=True)
|
@pytest.fixture(autouse=True)
|
||||||
def clean_registry() -> Generator[None, None, None]:
|
def clean_registry() -> Generator[None, None, None]:
|
||||||
"""Reset the parser registry before and after every test.
|
"""Reset the parser registry before and after every test.
|
||||||
|
|||||||
@@ -21,7 +21,7 @@ from documents.parsers import run_convert
|
|||||||
from paperless.models import ModeChoices
|
from paperless.models import ModeChoices
|
||||||
from paperless.parsers import ParserProtocol
|
from paperless.parsers import ParserProtocol
|
||||||
from paperless.parsers.tesseract import RasterisedDocumentParser
|
from paperless.parsers.tesseract import RasterisedDocumentParser
|
||||||
from paperless.parsers.tesseract import post_process_text
|
from paperless.parsers.utils import is_tagged_pdf
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
@@ -151,36 +151,6 @@ class TestRasterisedDocumentParserLifecycle:
|
|||||||
assert tempdir is not None and not tempdir.exists()
|
assert tempdir is not None and not tempdir.exists()
|
||||||
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
# post_process_text
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
|
|
||||||
|
|
||||||
class TestPostProcessText:
|
|
||||||
@pytest.mark.parametrize(
|
|
||||||
("source", "expected"),
|
|
||||||
[
|
|
||||||
pytest.param(
|
|
||||||
"simple string",
|
|
||||||
"simple string",
|
|
||||||
id="collapse-spaces",
|
|
||||||
),
|
|
||||||
pytest.param(
|
|
||||||
"simple newline\n testing string",
|
|
||||||
"simple newline\ntesting string",
|
|
||||||
id="preserve-newline",
|
|
||||||
),
|
|
||||||
pytest.param(
|
|
||||||
"utf-8 строка с пробелами в конце ", # noqa: RUF001
|
|
||||||
"utf-8 строка с пробелами в конце", # noqa: RUF001
|
|
||||||
id="utf8-trailing-spaces",
|
|
||||||
),
|
|
||||||
],
|
|
||||||
)
|
|
||||||
def test_post_process_text(self, source: str, expected: str) -> None:
|
|
||||||
assert post_process_text(source) == expected
|
|
||||||
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
# ---------------------------------------------------------------------------
|
||||||
# Page count
|
# Page count
|
||||||
# ---------------------------------------------------------------------------
|
# ---------------------------------------------------------------------------
|
||||||
@@ -910,25 +880,25 @@ class TestSkipArchive:
|
|||||||
self,
|
self,
|
||||||
mocker: MockerFixture,
|
mocker: MockerFixture,
|
||||||
tesseract_parser: RasterisedDocumentParser,
|
tesseract_parser: RasterisedDocumentParser,
|
||||||
tesseract_samples_dir: Path,
|
tagged_no_text_pdf_file: Path,
|
||||||
) -> None:
|
) -> None:
|
||||||
"""
|
"""
|
||||||
GIVEN:
|
GIVEN:
|
||||||
- A PDF that reports itself as tagged (/MarkInfo /Marked true) but
|
- A real PDF that reports itself as tagged (/MarkInfo /Marked
|
||||||
has no actual extractable text (some scanner firmware produces
|
true) but whose only pdftotext output is layout padding (a
|
||||||
this — see GitHub issue #13349)
|
lone form-feed byte), not real text (see GitHub issue #13387,
|
||||||
|
originally reported against #13349's tagged-PDF handling)
|
||||||
- Mode: auto, produce_archive=False
|
- Mode: auto, produce_archive=False
|
||||||
WHEN:
|
WHEN:
|
||||||
- Document is parsed
|
- Document is parsed
|
||||||
THEN:
|
THEN:
|
||||||
- The tag alone is not trusted as "has text"; OCRmyPDF still runs
|
- The tag alone is not trusted as "has text"; OCRmyPDF still runs
|
||||||
"""
|
"""
|
||||||
|
assert is_tagged_pdf(tagged_no_text_pdf_file) is True
|
||||||
tesseract_parser.settings.mode = ModeChoices.AUTO
|
tesseract_parser.settings.mode = ModeChoices.AUTO
|
||||||
mocker.patch("paperless.parsers.tesseract.is_tagged_pdf", return_value=True)
|
|
||||||
mocker.patch.object(tesseract_parser, "extract_text", return_value=None)
|
|
||||||
mock_ocr = mocker.patch("ocrmypdf.ocr")
|
mock_ocr = mocker.patch("ocrmypdf.ocr")
|
||||||
tesseract_parser.parse(
|
tesseract_parser.parse(
|
||||||
tesseract_samples_dir / "multi-page-images.pdf",
|
tagged_no_text_pdf_file,
|
||||||
"application/pdf",
|
"application/pdf",
|
||||||
produce_archive=False,
|
produce_archive=False,
|
||||||
)
|
)
|
||||||
|
|||||||
Binary file not shown.
@@ -4,10 +4,18 @@ from __future__ import annotations
|
|||||||
|
|
||||||
import codecs
|
import codecs
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
from typing import TYPE_CHECKING
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
from paperless.parsers.utils import is_tagged_pdf
|
from paperless.parsers.utils import is_tagged_pdf
|
||||||
|
from paperless.parsers.utils import pdf_born_digital_text
|
||||||
|
from paperless.parsers.utils import post_process_text
|
||||||
from paperless.parsers.utils import read_file_handle_unicode_errors
|
from paperless.parsers.utils import read_file_handle_unicode_errors
|
||||||
|
|
||||||
|
if TYPE_CHECKING:
|
||||||
|
from pytest_mock import MockerFixture
|
||||||
|
|
||||||
SAMPLES = Path(__file__).parent / "samples" / "tesseract"
|
SAMPLES = Path(__file__).parent / "samples" / "tesseract"
|
||||||
|
|
||||||
|
|
||||||
@@ -60,3 +68,105 @@ class TestIsTaggedPdf:
|
|||||||
bad = tmp_path / "bad.pdf"
|
bad = tmp_path / "bad.pdf"
|
||||||
bad.write_bytes(b"not a pdf")
|
bad.write_bytes(b"not a pdf")
|
||||||
assert is_tagged_pdf(bad) is False
|
assert is_tagged_pdf(bad) is False
|
||||||
|
|
||||||
|
|
||||||
|
class TestPostProcessText:
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
("source", "expected"),
|
||||||
|
[
|
||||||
|
pytest.param(
|
||||||
|
"simple string",
|
||||||
|
"simple string",
|
||||||
|
id="collapse-spaces",
|
||||||
|
),
|
||||||
|
pytest.param(
|
||||||
|
"simple newline\n testing string",
|
||||||
|
"simple newline\ntesting string",
|
||||||
|
id="preserve-newline",
|
||||||
|
),
|
||||||
|
pytest.param(
|
||||||
|
"utf-8 строка с пробелами в конце ", # noqa: RUF001
|
||||||
|
"utf-8 строка с пробелами в конце", # noqa: RUF001
|
||||||
|
id="utf8-trailing-spaces",
|
||||||
|
),
|
||||||
|
pytest.param(None, None, id="none-input"),
|
||||||
|
pytest.param("", None, id="empty-string"),
|
||||||
|
pytest.param(" \n\x0c \n ", None, id="whitespace-and-formfeed-only"),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_post_process_text(
|
||||||
|
self,
|
||||||
|
source: str | None,
|
||||||
|
expected: str | None,
|
||||||
|
) -> None:
|
||||||
|
assert post_process_text(source) == expected
|
||||||
|
|
||||||
|
|
||||||
|
class TestPdfBornDigitalText:
|
||||||
|
"""Regression coverage for GH #13387.
|
||||||
|
|
||||||
|
should_produce_archive() and RasterisedDocumentParser.parse() must agree
|
||||||
|
on whether a PDF has real text, so both go through this one function.
|
||||||
|
"""
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
("extracted", "tagged", "expected_text", "expected_born_digital"),
|
||||||
|
[
|
||||||
|
pytest.param("tiny", True, "tiny", True, id="tagged-with-real-text"),
|
||||||
|
pytest.param("tiny", False, "tiny", False, id="untagged-below-min-length"),
|
||||||
|
pytest.param(
|
||||||
|
"x" * 51,
|
||||||
|
False,
|
||||||
|
"x" * 51,
|
||||||
|
True,
|
||||||
|
id="untagged-above-min-length",
|
||||||
|
),
|
||||||
|
pytest.param(None, True, None, False, id="tagged-but-no-text"),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_born_digital_decision(
|
||||||
|
self,
|
||||||
|
mocker: MockerFixture,
|
||||||
|
tmp_path: Path,
|
||||||
|
extracted: str | None,
|
||||||
|
tagged: bool, # noqa: FBT001
|
||||||
|
expected_text: str | None,
|
||||||
|
expected_born_digital: bool, # noqa: FBT001
|
||||||
|
) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- A PDF whose pdftotext output and /MarkInfo tag status vary
|
||||||
|
WHEN:
|
||||||
|
- pdf_born_digital_text() is called
|
||||||
|
THEN:
|
||||||
|
- The normalized text and born-digital verdict match; the tag
|
||||||
|
alone never counts as "has text"
|
||||||
|
"""
|
||||||
|
mocker.patch(
|
||||||
|
"paperless.parsers.utils.extract_pdf_text",
|
||||||
|
return_value=extracted,
|
||||||
|
)
|
||||||
|
mocker.patch("paperless.parsers.utils.is_tagged_pdf", return_value=tagged)
|
||||||
|
text, born_digital = pdf_born_digital_text(tmp_path / "doc.pdf")
|
||||||
|
assert text == expected_text
|
||||||
|
assert born_digital is expected_born_digital
|
||||||
|
|
||||||
|
def test_tagged_but_textless_pdf_is_not_born_digital(
|
||||||
|
self,
|
||||||
|
tagged_no_text_pdf_file: Path,
|
||||||
|
) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- A real PDF that is tagged (/MarkInfo /Marked true) but whose
|
||||||
|
only "text" is layout padding (a stray form-feed byte)
|
||||||
|
WHEN:
|
||||||
|
- pdf_born_digital_text() is called with no mocking
|
||||||
|
THEN:
|
||||||
|
- The normalized text is None and the PDF is not treated as
|
||||||
|
born-digital. The raw, unnormalized pdftotext output is
|
||||||
|
non-empty for this file, which is exactly what caused the
|
||||||
|
archive decision to disagree with the OCR decision in #13387.
|
||||||
|
"""
|
||||||
|
text, born_digital = pdf_born_digital_text(tagged_no_text_pdf_file)
|
||||||
|
assert text is None
|
||||||
|
assert born_digital is False
|
||||||
|
|||||||
+111
-27
@@ -1,5 +1,6 @@
|
|||||||
import logging
|
import logging
|
||||||
from collections.abc import Iterable
|
from collections.abc import Iterable
|
||||||
|
from collections.abc import Iterator
|
||||||
from contextlib import contextmanager
|
from contextlib import contextmanager
|
||||||
from datetime import timedelta
|
from datetime import timedelta
|
||||||
from typing import TYPE_CHECKING
|
from typing import TYPE_CHECKING
|
||||||
@@ -22,6 +23,7 @@ from paperless_ai.embedding import get_configured_model_name
|
|||||||
from paperless_ai.embedding import get_embedding_model
|
from paperless_ai.embedding import get_embedding_model
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
|
from django.db.models import QuerySet
|
||||||
from llama_index.core.schema import BaseNode
|
from llama_index.core.schema import BaseNode
|
||||||
|
|
||||||
from paperless_ai.vector_store import PaperlessSqliteVecVectorStore
|
from paperless_ai.vector_store import PaperlessSqliteVecVectorStore
|
||||||
@@ -32,6 +34,35 @@ logger = logging.getLogger("paperless_ai.indexing")
|
|||||||
RAG_NUM_OUTPUT = 512
|
RAG_NUM_OUTPUT = 512
|
||||||
RAG_CHUNK_OVERLAP = 200
|
RAG_CHUNK_OVERLAP = 200
|
||||||
|
|
||||||
|
# update_llm_index(): row count per .iterator() batch when streaming
|
||||||
|
# documents for a rebuild/update, matching _DocumentViewerStream's chunk
|
||||||
|
# size in documents/search/_backend.py.
|
||||||
|
_INDEX_STREAM_CHUNK_SIZE = 1000
|
||||||
|
|
||||||
|
|
||||||
|
class _StreamedDocuments:
|
||||||
|
"""A thin QuerySet wrapper that streams via ``.iterator()`` instead of
|
||||||
|
materializing every row (plus its ``content`` and prefetch caches) into
|
||||||
|
memory at once, while still supporting ``len()`` so ``iter_wrapper``'s
|
||||||
|
progress bar shows a real total instead of falling back to indeterminate.
|
||||||
|
Same shape as ``documents/search/_backend.py``'s ``_DocumentViewerStream``,
|
||||||
|
just without that class's extra per-batch permission lookup -- nothing
|
||||||
|
here needs one.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(self, documents: "QuerySet[Document]") -> None:
|
||||||
|
self._documents = documents
|
||||||
|
|
||||||
|
def __len__(self) -> int:
|
||||||
|
return self._documents.count()
|
||||||
|
|
||||||
|
def __iter__(self) -> Iterator[Document]:
|
||||||
|
# iterator(chunk_size=...) streams from a server-side cursor instead
|
||||||
|
# of materializing the whole queryset in memory; since Django 4.1 it
|
||||||
|
# still honours prefetch_related, running the prefetches one batch
|
||||||
|
# at a time.
|
||||||
|
return iter(self._documents.iterator(chunk_size=_INDEX_STREAM_CHUNK_SIZE))
|
||||||
|
|
||||||
|
|
||||||
def queue_llm_index_update_if_needed(*, rebuild: bool, reason: str) -> bool:
|
def queue_llm_index_update_if_needed(*, rebuild: bool, reason: str) -> bool:
|
||||||
# NOTE: The check-then-enqueue sequence below is non-atomic (TOCTOU): two
|
# NOTE: The check-then-enqueue sequence below is non-atomic (TOCTOU): two
|
||||||
@@ -144,6 +175,24 @@ def _exclude_readers():
|
|||||||
lock.close()
|
lock.close()
|
||||||
|
|
||||||
|
|
||||||
|
def _with_exclusive_access(operation: str, fn):
|
||||||
|
"""Run ``fn()`` with exclusive index access (see ``_exclude_readers()``),
|
||||||
|
for compaction/migration file swaps that must not run while readers are
|
||||||
|
active. Returns ``fn()``'s result, or None (after logging) if active
|
||||||
|
readers do not drain within ``LLM_INDEX_COMPACTION_LOCK_TIMEOUT`` --
|
||||||
|
callers skip the operation this run; it retries next time.
|
||||||
|
"""
|
||||||
|
try:
|
||||||
|
with _exclude_readers():
|
||||||
|
return fn()
|
||||||
|
except Timeout:
|
||||||
|
logger.info(
|
||||||
|
"Skipping LLM index %s: index readers are active; will retry next run.",
|
||||||
|
operation,
|
||||||
|
)
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
@contextmanager
|
@contextmanager
|
||||||
def write_store(embed_model_name: str | None = None):
|
def write_store(embed_model_name: str | None = None):
|
||||||
"""Acquire the write lock and yield the vector store.
|
"""Acquire the write lock and yield the vector store.
|
||||||
@@ -168,6 +217,21 @@ def write_store(embed_model_name: str | None = None):
|
|||||||
yield store
|
yield store
|
||||||
|
|
||||||
|
|
||||||
|
def _check_and_run_migrations(store: "PaperlessSqliteVecVectorStore") -> bool:
|
||||||
|
"""Run any pending structural migrations, returning True if a pending
|
||||||
|
re-embed migration needs the caller to force a rebuild -- never
|
||||||
|
triggered automatically here. Safe to call before any write, including
|
||||||
|
delete()/upsert_document(): has_pending_migration() (see its docstring)
|
||||||
|
keeps this a no-op, with no exclusive access taken, once the store is
|
||||||
|
current.
|
||||||
|
"""
|
||||||
|
if not store.has_pending_migration():
|
||||||
|
return False
|
||||||
|
return bool(
|
||||||
|
_with_exclusive_access("migration check", store.check_and_run_migrations),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def _safe_related_name(document: Document, field: str) -> str | None:
|
def _safe_related_name(document: Document, field: str) -> str | None:
|
||||||
"""
|
"""
|
||||||
Returns the ``name`` of a related object (correspondent, document_type,
|
Returns the ``name`` of a related object (correspondent, document_type,
|
||||||
@@ -339,15 +403,7 @@ def update_llm_index(
|
|||||||
happens, since a rebuild always covers the whole library regardless.
|
happens, since a rebuild always covers the whole library regardless.
|
||||||
"""
|
"""
|
||||||
with write_store() as store:
|
with write_store() as store:
|
||||||
try:
|
needs_reembed = _check_and_run_migrations(store)
|
||||||
with _exclude_readers():
|
|
||||||
needs_reembed = store.check_and_run_migrations()
|
|
||||||
except Timeout:
|
|
||||||
logger.info(
|
|
||||||
"Skipping LLM index migration check: index readers are active; "
|
|
||||||
"will retry next run.",
|
|
||||||
)
|
|
||||||
needs_reembed = False
|
|
||||||
if needs_reembed:
|
if needs_reembed:
|
||||||
logger.warning(
|
logger.warning(
|
||||||
"LLM index migration requires re-embedding; forcing rebuild.",
|
"LLM index migration requires re-embedding; forcing rebuild.",
|
||||||
@@ -385,7 +441,7 @@ def update_llm_index(
|
|||||||
if rebuild or not store.table_exists():
|
if rebuild or not store.table_exists():
|
||||||
logger.info("Rebuilding LLM index.")
|
logger.info("Rebuilding LLM index.")
|
||||||
store.drop_table()
|
store.drop_table()
|
||||||
for document in iter_wrapper(documents):
|
for document in iter_wrapper(_StreamedDocuments(documents)):
|
||||||
nodes = build_document_node(document, chunk_size=chunk_size)
|
nodes = build_document_node(document, chunk_size=chunk_size)
|
||||||
_embed_nodes(nodes, embed_model)
|
_embed_nodes(nodes, embed_model)
|
||||||
store.add(nodes)
|
store.add(nodes)
|
||||||
@@ -398,7 +454,7 @@ def update_llm_index(
|
|||||||
)
|
)
|
||||||
existing = store.get_modified_times()
|
existing = store.get_modified_times()
|
||||||
changed = 0
|
changed = 0
|
||||||
for document in iter_wrapper(scoped_documents):
|
for document in iter_wrapper(_StreamedDocuments(scoped_documents)):
|
||||||
doc_id = str(document.id)
|
doc_id = str(document.id)
|
||||||
if existing.get(doc_id) == document.modified.isoformat():
|
if existing.get(doc_id) == document.modified.isoformat():
|
||||||
continue
|
continue
|
||||||
@@ -412,14 +468,7 @@ def update_llm_index(
|
|||||||
else "No changes detected in LLM index."
|
else "No changes detected in LLM index."
|
||||||
)
|
)
|
||||||
|
|
||||||
try:
|
_with_exclusive_access("compaction", store.compact)
|
||||||
with _exclude_readers():
|
|
||||||
store.compact()
|
|
||||||
except Timeout:
|
|
||||||
logger.info(
|
|
||||||
"Skipping LLM index compaction: index readers are active; "
|
|
||||||
"will retry next run.",
|
|
||||||
)
|
|
||||||
return msg
|
return msg
|
||||||
|
|
||||||
|
|
||||||
@@ -434,25 +483,60 @@ def llm_index_add_or_update_document(document: Document):
|
|||||||
_embed_nodes(new_nodes, get_embedding_model(config))
|
_embed_nodes(new_nodes, get_embedding_model(config))
|
||||||
|
|
||||||
with write_store(embed_model_name=get_configured_model_name(config)) as store:
|
with write_store(embed_model_name=get_configured_model_name(config)) as store:
|
||||||
|
needs_reembed = _check_and_run_migrations(store)
|
||||||
|
if needs_reembed:
|
||||||
|
logger.warning(
|
||||||
|
"Skipping incremental LLM index update for document %s: the "
|
||||||
|
"index requires re-embedding first. Run 'document_llmindex "
|
||||||
|
"rebuild' to resolve.",
|
||||||
|
document.id,
|
||||||
|
)
|
||||||
|
return
|
||||||
store.upsert_document(str(document.id), new_nodes)
|
store.upsert_document(str(document.id), new_nodes)
|
||||||
|
|
||||||
|
|
||||||
|
def llm_index_migrate() -> None:
|
||||||
|
"""Apply any pending LLM index schema migrations, with no reindex.
|
||||||
|
|
||||||
|
Intended to run unconditionally on every startup (see the
|
||||||
|
init-llmindex-migrate container step and the bare-metal upgrade docs):
|
||||||
|
has_pending_migration() short-circuits to a metadata-only read once the
|
||||||
|
store is current, so a healthy install pays almost nothing here. Only
|
||||||
|
ever applies structural migrations -- a pending re-embed migration is
|
||||||
|
left for the explicit, deliberate rebuild path (``document_llmindex
|
||||||
|
update``/``rebuild``) to resolve, since re-embedding can be slow and,
|
||||||
|
for a metered embedding backend, cost money.
|
||||||
|
"""
|
||||||
|
if not AIConfig().llm_index_enabled:
|
||||||
|
return
|
||||||
|
with write_store() as store:
|
||||||
|
needs_reembed = _check_and_run_migrations(store)
|
||||||
|
if needs_reembed:
|
||||||
|
logger.warning(
|
||||||
|
"LLM index requires re-embedding, which this automatic migration "
|
||||||
|
"check will not do on its own -- it can be slow and, for a "
|
||||||
|
"metered embedding backend, cost money. Run "
|
||||||
|
"'document_llmindex rebuild' manually when ready.",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def llm_index_compact() -> None:
|
def llm_index_compact() -> None:
|
||||||
"""Compact the index immediately, rebuilding the table to reclaim space."""
|
"""Compact the index immediately, rebuilding the table to reclaim space."""
|
||||||
with write_store() as store:
|
with write_store() as store:
|
||||||
try:
|
_with_exclusive_access("compaction", lambda: store.compact(force=True))
|
||||||
with _exclude_readers():
|
|
||||||
store.compact(force=True)
|
|
||||||
except Timeout:
|
|
||||||
logger.info(
|
|
||||||
"Skipping LLM index compaction: index readers are active; "
|
|
||||||
"will retry next run.",
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def llm_index_remove_document(document: Document):
|
def llm_index_remove_document(document: Document):
|
||||||
"""Remove a document's chunks from the LLM index."""
|
"""Remove a document's chunks from the LLM index."""
|
||||||
with write_store() as store:
|
with write_store() as store:
|
||||||
|
if _check_and_run_migrations(store):
|
||||||
|
logger.warning(
|
||||||
|
"Skipping removal of document %s from the LLM index: the "
|
||||||
|
"index requires re-embedding first. Run 'document_llmindex "
|
||||||
|
"rebuild' to resolve.",
|
||||||
|
document.id,
|
||||||
|
)
|
||||||
|
return
|
||||||
store.delete(str(document.id))
|
store.delete(str(document.id))
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,60 @@
|
|||||||
|
"""Schema migrations for the sqlite-vec vector store.
|
||||||
|
|
||||||
|
Each migration lives in its own module here, named ``mNNNN_description.py``
|
||||||
|
(e.g. ``m0001_v1_to_v2.py`` -- a leading digit isn't a valid Python
|
||||||
|
identifier, hence the ``m`` prefix, unlike Django's own numbered migrations,
|
||||||
|
which load via a dynamic ``importlib.import_module()`` call rather than a
|
||||||
|
static import statement), and registers itself into ``MIGRATIONS`` at import
|
||||||
|
time. ``vector_store.py`` imports those modules at the bottom of the file,
|
||||||
|
purely for that registration side effect, after ``PaperlessSqliteVecVectorStore``
|
||||||
|
is fully defined -- migrations need it to implement ``apply()`` (see
|
||||||
|
``Migration`` below).
|
||||||
|
|
||||||
|
To add a new migration: add a new ``mNNNN_description.py`` module here that
|
||||||
|
imports ``PaperlessSqliteVecVectorStore`` from ``paperless_ai.vector_store``,
|
||||||
|
defines its ``apply()``, and appends a ``Migration`` to ``MIGRATIONS``; then
|
||||||
|
import that module at the bottom of ``vector_store.py`` and bump
|
||||||
|
``SCHEMA_VERSION`` there. A migration must freeze its own historical DDL for
|
||||||
|
any side table its target version depends on (``DROP TABLE IF EXISTS`` +
|
||||||
|
its own literal ``CREATE TABLE``/``CREATE INDEX`` statements) rather than
|
||||||
|
delegating to any "current schema" helper -- see ``m0001_v1_to_v2.py`` for
|
||||||
|
why and the worked example.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import sqlite3
|
||||||
|
from collections.abc import Callable
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from dataclasses import field
|
||||||
|
from typing import Literal
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class Migration:
|
||||||
|
"""A schema migration for the sqlite-vec vector store.
|
||||||
|
|
||||||
|
kind="structural": rows are copied into a new-schema file with no
|
||||||
|
re-embedding needed. Supply ``apply(src_conn, dst_conn, dim)``, which
|
||||||
|
must create every table its target schema needs in ``dst_conn`` and copy
|
||||||
|
``src_conn``'s rows and relevant ``index_meta`` keys into it.
|
||||||
|
``schema_version`` is written by the migration runner after ``apply``
|
||||||
|
returns, not by ``apply`` itself.
|
||||||
|
|
||||||
|
kind="re-embed": the new schema requires fresh embeddings.
|
||||||
|
``check_and_run_migrations()`` returns True when it encounters one of
|
||||||
|
these so the caller can force a full rebuild (which recreates the table
|
||||||
|
at the current SCHEMA_VERSION).
|
||||||
|
"""
|
||||||
|
|
||||||
|
from_version: int
|
||||||
|
to_version: int
|
||||||
|
kind: Literal["structural", "re-embed"]
|
||||||
|
description: str
|
||||||
|
apply: Callable[[sqlite3.Connection, sqlite3.Connection, int], None] | None = field(
|
||||||
|
default=None,
|
||||||
|
repr=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
# Registry of all schema migrations in order, populated by each migration
|
||||||
|
# module's import-time registration (see the module docstring above).
|
||||||
|
MIGRATIONS: list[Migration] = []
|
||||||
@@ -1,3 +1,4 @@
|
|||||||
|
import logging
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from unittest.mock import MagicMock
|
from unittest.mock import MagicMock
|
||||||
from unittest.mock import patch
|
from unittest.mock import patch
|
||||||
@@ -186,6 +187,45 @@ def test_truncate_embedding_query_returns_single_chunk() -> None:
|
|||||||
assert "word199" not in result
|
assert "word199" not in result
|
||||||
|
|
||||||
|
|
||||||
|
class TestStreamedDocuments:
|
||||||
|
"""_StreamedDocuments streams via .iterator() instead of materializing
|
||||||
|
the whole queryset (plus its content and prefetch caches) in memory at
|
||||||
|
once, while still supporting len() so a progress bar wrapped around it
|
||||||
|
shows a real total.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def test_len_and_iter_delegate_to_streaming_queryset_methods(
|
||||||
|
self,
|
||||||
|
mocker: pytest_mock.MockerFixture,
|
||||||
|
) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- A mock queryset
|
||||||
|
WHEN:
|
||||||
|
- A _StreamedDocuments wrapping it is measured and iterated
|
||||||
|
THEN:
|
||||||
|
- len() uses count() (not a materializing len()), and iteration
|
||||||
|
uses .iterator(chunk_size=...) (not plain iteration, which
|
||||||
|
would materialize prefetches for the whole queryset at once)
|
||||||
|
"""
|
||||||
|
mock_queryset = mocker.MagicMock()
|
||||||
|
mock_queryset.count.return_value = 42
|
||||||
|
mock_queryset.iterator.return_value = iter(["doc-1", "doc-2"])
|
||||||
|
streamed = indexing._StreamedDocuments(mock_queryset)
|
||||||
|
|
||||||
|
assert len(streamed) == 42
|
||||||
|
assert list(streamed) == ["doc-1", "doc-2"]
|
||||||
|
# count.call_count isn't asserted exactly: list()'s own size-hint
|
||||||
|
# optimization calls len(streamed) again internally, on top of the
|
||||||
|
# explicit len() call above -- both legitimately delegate to
|
||||||
|
# count(), so only the delegation itself (not the call count) is
|
||||||
|
# the thing being verified here.
|
||||||
|
mock_queryset.count.assert_called_with()
|
||||||
|
mock_queryset.iterator.assert_called_once_with(
|
||||||
|
chunk_size=indexing._INDEX_STREAM_CHUNK_SIZE,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.django_db
|
@pytest.mark.django_db
|
||||||
def test_update_llm_index(
|
def test_update_llm_index(
|
||||||
temp_llm_index_dir: Path,
|
temp_llm_index_dir: Path,
|
||||||
@@ -737,6 +777,7 @@ class TestLlmIndexLocking:
|
|||||||
mocker: pytest_mock.MockerFixture,
|
mocker: pytest_mock.MockerFixture,
|
||||||
) -> None:
|
) -> None:
|
||||||
mock_store = MagicMock()
|
mock_store = MagicMock()
|
||||||
|
mock_store.has_pending_migration.return_value = False
|
||||||
mocker.patch(
|
mocker.patch(
|
||||||
"paperless_ai.indexing.write_store",
|
"paperless_ai.indexing.write_store",
|
||||||
return_value=mocker.MagicMock(
|
return_value=mocker.MagicMock(
|
||||||
@@ -757,12 +798,45 @@ class TestLlmIndexLocking:
|
|||||||
|
|
||||||
mock_store.upsert_document.assert_called_once()
|
mock_store.upsert_document.assert_called_once()
|
||||||
|
|
||||||
|
def test_add_or_update_document_skips_write_when_reembed_pending(
|
||||||
|
self,
|
||||||
|
temp_llm_index_dir: Path,
|
||||||
|
mock_embed_model: FakeEmbedding,
|
||||||
|
mocker: pytest_mock.MockerFixture,
|
||||||
|
) -> None:
|
||||||
|
"""A pending re-embed migration must block the incremental write,
|
||||||
|
not let it proceed against a schema that just changed underneath it.
|
||||||
|
"""
|
||||||
|
mock_store = MagicMock()
|
||||||
|
mock_store.has_pending_migration.return_value = True
|
||||||
|
mock_store.check_and_run_migrations.return_value = True
|
||||||
|
mocker.patch(
|
||||||
|
"paperless_ai.indexing.write_store",
|
||||||
|
return_value=mocker.MagicMock(
|
||||||
|
__enter__=mocker.MagicMock(return_value=mock_store),
|
||||||
|
__exit__=mocker.MagicMock(return_value=False),
|
||||||
|
),
|
||||||
|
)
|
||||||
|
mock_node = MagicMock()
|
||||||
|
mock_node.get_content.return_value = "fake node text"
|
||||||
|
mocker.patch(
|
||||||
|
"paperless_ai.indexing.build_document_node",
|
||||||
|
return_value=[mock_node],
|
||||||
|
)
|
||||||
|
|
||||||
|
doc = MagicMock(spec=Document)
|
||||||
|
doc.id = 1
|
||||||
|
indexing.llm_index_add_or_update_document(doc)
|
||||||
|
|
||||||
|
mock_store.upsert_document.assert_not_called()
|
||||||
|
|
||||||
def test_remove_document_uses_write_store(
|
def test_remove_document_uses_write_store(
|
||||||
self,
|
self,
|
||||||
temp_llm_index_dir: Path,
|
temp_llm_index_dir: Path,
|
||||||
mocker: pytest_mock.MockerFixture,
|
mocker: pytest_mock.MockerFixture,
|
||||||
) -> None:
|
) -> None:
|
||||||
mock_store = MagicMock()
|
mock_store = MagicMock()
|
||||||
|
mock_store.has_pending_migration.return_value = False
|
||||||
mocker.patch(
|
mocker.patch(
|
||||||
"paperless_ai.indexing.write_store",
|
"paperless_ai.indexing.write_store",
|
||||||
return_value=mocker.MagicMock(
|
return_value=mocker.MagicMock(
|
||||||
@@ -777,6 +851,31 @@ class TestLlmIndexLocking:
|
|||||||
|
|
||||||
mock_store.delete.assert_called_once_with("1")
|
mock_store.delete.assert_called_once_with("1")
|
||||||
|
|
||||||
|
def test_remove_document_skips_write_when_reembed_pending(
|
||||||
|
self,
|
||||||
|
temp_llm_index_dir: Path,
|
||||||
|
mocker: pytest_mock.MockerFixture,
|
||||||
|
) -> None:
|
||||||
|
"""A pending re-embed migration must block the delete too, for the
|
||||||
|
same consistency reason as the incremental-update path.
|
||||||
|
"""
|
||||||
|
mock_store = MagicMock()
|
||||||
|
mock_store.has_pending_migration.return_value = True
|
||||||
|
mock_store.check_and_run_migrations.return_value = True
|
||||||
|
mocker.patch(
|
||||||
|
"paperless_ai.indexing.write_store",
|
||||||
|
return_value=mocker.MagicMock(
|
||||||
|
__enter__=mocker.MagicMock(return_value=mock_store),
|
||||||
|
__exit__=mocker.MagicMock(return_value=False),
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
doc = MagicMock(spec=Document)
|
||||||
|
doc.id = 1
|
||||||
|
indexing.llm_index_remove_document(doc)
|
||||||
|
|
||||||
|
mock_store.delete.assert_not_called()
|
||||||
|
|
||||||
def test_update_llm_index_rebuild_uses_write_store(
|
def test_update_llm_index_rebuild_uses_write_store(
|
||||||
self,
|
self,
|
||||||
temp_llm_index_dir: Path,
|
temp_llm_index_dir: Path,
|
||||||
@@ -849,6 +948,76 @@ class TestVectorStoreIndexing:
|
|||||||
assert rows >= 1
|
assert rows >= 1
|
||||||
|
|
||||||
|
|
||||||
|
class TestLlmIndexMigrate:
|
||||||
|
def test_noop_when_ai_disabled(self, mocker: pytest_mock.MockerFixture) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- AI/LLM index support is disabled in configuration
|
||||||
|
WHEN:
|
||||||
|
- llm_index_migrate() is called
|
||||||
|
THEN:
|
||||||
|
- No store is opened and no migration check runs
|
||||||
|
"""
|
||||||
|
mocker.patch(
|
||||||
|
"paperless_ai.indexing.AIConfig",
|
||||||
|
return_value=mocker.Mock(llm_index_enabled=False),
|
||||||
|
)
|
||||||
|
write_store_mock = mocker.patch("paperless_ai.indexing.write_store")
|
||||||
|
indexing.llm_index_migrate()
|
||||||
|
write_store_mock.assert_not_called()
|
||||||
|
|
||||||
|
def test_runs_pending_migration_when_enabled(
|
||||||
|
self,
|
||||||
|
mocker: pytest_mock.MockerFixture,
|
||||||
|
) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- AI/LLM index support is enabled
|
||||||
|
WHEN:
|
||||||
|
- llm_index_migrate() is called
|
||||||
|
THEN:
|
||||||
|
- The store is opened for write and a migration check runs
|
||||||
|
"""
|
||||||
|
mocker.patch(
|
||||||
|
"paperless_ai.indexing.AIConfig",
|
||||||
|
return_value=mocker.Mock(llm_index_enabled=True),
|
||||||
|
)
|
||||||
|
store_mock = mocker.MagicMock()
|
||||||
|
store_mock.has_pending_migration.return_value = False
|
||||||
|
write_store_cm = mocker.patch("paperless_ai.indexing.write_store")
|
||||||
|
write_store_cm.return_value.__enter__.return_value = store_mock
|
||||||
|
indexing.llm_index_migrate()
|
||||||
|
store_mock.has_pending_migration.assert_called_once()
|
||||||
|
|
||||||
|
def test_logs_warning_when_reembed_needed(
|
||||||
|
self,
|
||||||
|
mocker: pytest_mock.MockerFixture,
|
||||||
|
caplog: pytest.LogCaptureFixture,
|
||||||
|
) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- AI/LLM index support is enabled
|
||||||
|
- A pending migration requires re-embedding
|
||||||
|
WHEN:
|
||||||
|
- llm_index_migrate() is called
|
||||||
|
THEN:
|
||||||
|
- A warning directs the operator to run a manual rebuild, since
|
||||||
|
this automatic check must never re-embed on its own
|
||||||
|
"""
|
||||||
|
mocker.patch(
|
||||||
|
"paperless_ai.indexing.AIConfig",
|
||||||
|
return_value=mocker.Mock(llm_index_enabled=True),
|
||||||
|
)
|
||||||
|
store_mock = mocker.MagicMock()
|
||||||
|
store_mock.has_pending_migration.return_value = True
|
||||||
|
store_mock.check_and_run_migrations.return_value = True
|
||||||
|
write_store_cm = mocker.patch("paperless_ai.indexing.write_store")
|
||||||
|
write_store_cm.return_value.__enter__.return_value = store_mock
|
||||||
|
with caplog.at_level(logging.WARNING, logger="paperless_ai.indexing"):
|
||||||
|
indexing.llm_index_migrate()
|
||||||
|
assert "requires re-embedding" in caplog.text
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.django_db
|
@pytest.mark.django_db
|
||||||
class TestQuerySimilarDocuments:
|
class TestQuerySimilarDocuments:
|
||||||
def test_query_similar_documents_respects_allowed_ids(
|
def test_query_similar_documents_respects_allowed_ids(
|
||||||
|
|||||||
@@ -9,11 +9,11 @@ from llama_index.core.vector_stores.types import MetadataFilter
|
|||||||
from llama_index.core.vector_stores.types import MetadataFilters
|
from llama_index.core.vector_stores.types import MetadataFilters
|
||||||
from llama_index.core.vector_stores.types import VectorStoreQuery
|
from llama_index.core.vector_stores.types import VectorStoreQuery
|
||||||
|
|
||||||
|
from paperless_ai.migrations import MIGRATIONS
|
||||||
|
from paperless_ai.migrations import Migration
|
||||||
from paperless_ai.vector_store import DB_FILENAME
|
from paperless_ai.vector_store import DB_FILENAME
|
||||||
from paperless_ai.vector_store import DEFAULT_TABLE_NAME
|
from paperless_ai.vector_store import DEFAULT_TABLE_NAME
|
||||||
from paperless_ai.vector_store import MIGRATIONS
|
|
||||||
from paperless_ai.vector_store import SCHEMA_VERSION
|
from paperless_ai.vector_store import SCHEMA_VERSION
|
||||||
from paperless_ai.vector_store import Migration
|
|
||||||
from paperless_ai.vector_store import PaperlessSqliteVecVectorStore
|
from paperless_ai.vector_store import PaperlessSqliteVecVectorStore
|
||||||
from paperless_ai.vector_store import _build_where
|
from paperless_ai.vector_store import _build_where
|
||||||
|
|
||||||
@@ -646,3 +646,50 @@ class TestMigrations:
|
|||||||
|
|
||||||
assert result is True
|
assert result is True
|
||||||
assert self._schema_version(store) == 2
|
assert self._schema_version(store) == 2
|
||||||
|
|
||||||
|
def test_has_pending_migration_false_when_no_table(
|
||||||
|
self,
|
||||||
|
store: PaperlessSqliteVecVectorStore,
|
||||||
|
) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- A vector store with no table created yet
|
||||||
|
WHEN:
|
||||||
|
- has_pending_migration() is checked
|
||||||
|
THEN:
|
||||||
|
- False is returned (nothing to migrate before anything exists)
|
||||||
|
"""
|
||||||
|
assert store.has_pending_migration() is False
|
||||||
|
|
||||||
|
def test_has_pending_migration_false_at_current_version(
|
||||||
|
self,
|
||||||
|
store: PaperlessSqliteVecVectorStore,
|
||||||
|
) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- A store at the current SCHEMA_VERSION
|
||||||
|
WHEN:
|
||||||
|
- has_pending_migration() is checked
|
||||||
|
THEN:
|
||||||
|
- False is returned
|
||||||
|
"""
|
||||||
|
store.add([make_node("a1", "1")])
|
||||||
|
assert store.has_pending_migration() is False
|
||||||
|
|
||||||
|
def test_has_pending_migration_true_when_behind(
|
||||||
|
self,
|
||||||
|
store: PaperlessSqliteVecVectorStore,
|
||||||
|
) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- A store whose schema_version has been forced behind SCHEMA_VERSION
|
||||||
|
WHEN:
|
||||||
|
- has_pending_migration() is checked
|
||||||
|
THEN:
|
||||||
|
- True is returned
|
||||||
|
"""
|
||||||
|
store.add([make_node("a1", "1")])
|
||||||
|
store.client.execute(
|
||||||
|
"UPDATE index_meta SET value = '0' WHERE key = 'schema_version'",
|
||||||
|
)
|
||||||
|
assert store.has_pending_migration() is True
|
||||||
|
|||||||
@@ -2,16 +2,12 @@ import json
|
|||||||
import logging
|
import logging
|
||||||
import sqlite3
|
import sqlite3
|
||||||
import struct
|
import struct
|
||||||
from collections.abc import Callable
|
|
||||||
from collections.abc import Iterator
|
from collections.abc import Iterator
|
||||||
from collections.abc import Sequence
|
from collections.abc import Sequence
|
||||||
from contextlib import contextmanager
|
from contextlib import contextmanager
|
||||||
from dataclasses import dataclass
|
|
||||||
from dataclasses import field
|
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
from types import TracebackType
|
from types import TracebackType
|
||||||
from typing import Any
|
from typing import Any
|
||||||
from typing import Literal
|
|
||||||
|
|
||||||
import sqlite_vec
|
import sqlite_vec
|
||||||
from llama_index.core.bridge.pydantic import PrivateAttr
|
from llama_index.core.bridge.pydantic import PrivateAttr
|
||||||
@@ -26,6 +22,9 @@ from llama_index.core.vector_stores.types import VectorStoreQueryResult
|
|||||||
from llama_index.core.vector_stores.utils import metadata_dict_to_node
|
from llama_index.core.vector_stores.utils import metadata_dict_to_node
|
||||||
from llama_index.core.vector_stores.utils import node_to_metadata_dict
|
from llama_index.core.vector_stores.utils import node_to_metadata_dict
|
||||||
|
|
||||||
|
from paperless_ai.migrations import MIGRATIONS
|
||||||
|
from paperless_ai.migrations import Migration
|
||||||
|
|
||||||
logger = logging.getLogger("paperless_ai.vector_store")
|
logger = logging.getLogger("paperless_ai.vector_store")
|
||||||
|
|
||||||
DB_FILENAME = "llmindex.db"
|
DB_FILENAME = "llmindex.db"
|
||||||
@@ -53,38 +52,6 @@ COMPACT_BATCH_SIZE = 500
|
|||||||
_FILTER_COLUMNS = frozenset({"document_id", "modified"})
|
_FILTER_COLUMNS = frozenset({"document_id", "modified"})
|
||||||
|
|
||||||
|
|
||||||
@dataclass
|
|
||||||
class Migration:
|
|
||||||
"""A schema migration for the sqlite-vec vector store.
|
|
||||||
|
|
||||||
kind="structural": rows are copied into a new-schema file with no
|
|
||||||
re-embedding needed. Supply ``apply(src_conn, dst_conn, dim)`` which
|
|
||||||
must create the vec0 table in ``dst_conn``, copy all rows from
|
|
||||||
``src_conn``, and write ``dim`` / ``embed_model`` / ``total_inserts`` to
|
|
||||||
``dst_conn``'s ``index_meta``. ``schema_version`` is written by the
|
|
||||||
migration runner after ``apply`` returns.
|
|
||||||
|
|
||||||
kind="re-embed": the new schema requires fresh embeddings.
|
|
||||||
``check_and_run_migrations()`` returns True when it encounters one of
|
|
||||||
these so the caller can force a full rebuild (which recreates the table
|
|
||||||
at the current SCHEMA_VERSION).
|
|
||||||
"""
|
|
||||||
|
|
||||||
from_version: int
|
|
||||||
to_version: int
|
|
||||||
kind: Literal["structural", "re-embed"]
|
|
||||||
description: str
|
|
||||||
apply: Callable[[sqlite3.Connection, sqlite3.Connection, int], None] | None = field(
|
|
||||||
default=None,
|
|
||||||
repr=False,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
# Registry of all schema migrations in order. Empty at v1 -- this is the
|
|
||||||
# baseline. Add entries here (and bump SCHEMA_VERSION) when the schema changes.
|
|
||||||
MIGRATIONS: list[Migration] = []
|
|
||||||
|
|
||||||
|
|
||||||
def _pack(embedding: Sequence[float]) -> bytes:
|
def _pack(embedding: Sequence[float]) -> bytes:
|
||||||
return struct.pack(f"{len(embedding)}f", *embedding)
|
return struct.pack(f"{len(embedding)}f", *embedding)
|
||||||
|
|
||||||
@@ -551,6 +518,31 @@ class PaperlessSqliteVecVectorStore(BasePydanticVectorStore):
|
|||||||
Path(compact_path).replace(db_path)
|
Path(compact_path).replace(db_path)
|
||||||
self._conn = self._open_connection(db_path)
|
self._conn = self._open_connection(db_path)
|
||||||
|
|
||||||
|
def _stored_schema_version(self) -> int | None:
|
||||||
|
"""The schema_version recorded in index_meta, or None if no table
|
||||||
|
exists. A missing key (a store predating version tracking) is
|
||||||
|
treated as SCHEMA_VERSION -- i.e. already current -- since no
|
||||||
|
migration in MIGRATIONS targets a version before tracking began.
|
||||||
|
"""
|
||||||
|
if not self.table_exists():
|
||||||
|
return None
|
||||||
|
raw = self._meta_get("schema_version")
|
||||||
|
return int(raw) if raw is not None else SCHEMA_VERSION
|
||||||
|
|
||||||
|
def has_pending_migration(self) -> bool:
|
||||||
|
"""Cheaply check whether a migration is pending, with no exclusive
|
||||||
|
access needed -- just a metadata read under the connection callers
|
||||||
|
already hold via the write FileLock.
|
||||||
|
|
||||||
|
Callers should only pay for check_and_run_migrations()'s exclusive
|
||||||
|
access (a structural migration's file swap must not run while
|
||||||
|
readers are active) when this returns True, so that the common
|
||||||
|
case -- already at SCHEMA_VERSION -- never contends with readers
|
||||||
|
or a concurrent compaction.
|
||||||
|
"""
|
||||||
|
current = self._stored_schema_version()
|
||||||
|
return current is not None and current < SCHEMA_VERSION
|
||||||
|
|
||||||
def check_and_run_migrations(self) -> bool:
|
def check_and_run_migrations(self) -> bool:
|
||||||
"""Apply any pending schema migrations to the store.
|
"""Apply any pending schema migrations to the store.
|
||||||
|
|
||||||
@@ -559,15 +551,13 @@ class PaperlessSqliteVecVectorStore(BasePydanticVectorStore):
|
|||||||
this method returns True when one is encountered so the caller can
|
this method returns True when one is encountered so the caller can
|
||||||
force a full rebuild (which recreates the table at SCHEMA_VERSION).
|
force a full rebuild (which recreates the table at SCHEMA_VERSION).
|
||||||
|
|
||||||
Must be called under the write FileLock. No-op when the table does
|
Must be called under the write FileLock, with readers excluded (see
|
||||||
not exist or is already at SCHEMA_VERSION.
|
has_pending_migration() for a cheap pre-check that avoids paying for
|
||||||
|
that exclusion in the common case). No-op when the table does not
|
||||||
|
exist or is already at SCHEMA_VERSION.
|
||||||
"""
|
"""
|
||||||
if not self.table_exists():
|
current = self._stored_schema_version()
|
||||||
return False
|
if current is None or current >= SCHEMA_VERSION:
|
||||||
|
|
||||||
raw = self._meta_get("schema_version")
|
|
||||||
current = int(raw) if raw is not None else SCHEMA_VERSION
|
|
||||||
if current >= SCHEMA_VERSION:
|
|
||||||
return False
|
return False
|
||||||
|
|
||||||
pending = sorted(
|
pending = sorted(
|
||||||
@@ -579,7 +569,7 @@ class PaperlessSqliteVecVectorStore(BasePydanticVectorStore):
|
|||||||
if migration.kind == "re-embed":
|
if migration.kind == "re-embed":
|
||||||
logger.warning(
|
logger.warning(
|
||||||
"LLM index schema v%d -> v%d requires re-embedding (%s); "
|
"LLM index schema v%d -> v%d requires re-embedding (%s); "
|
||||||
"forcing full rebuild.",
|
"the caller must force a rebuild.",
|
||||||
migration.from_version,
|
migration.from_version,
|
||||||
migration.to_version,
|
migration.to_version,
|
||||||
migration.description,
|
migration.description,
|
||||||
|
|||||||
@@ -3735,15 +3735,15 @@ crypto = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "pymdown-extensions"
|
name = "pymdown-extensions"
|
||||||
version = "10.21.3"
|
version = "11.0"
|
||||||
source = { registry = "https://pypi.org/simple" }
|
source = { registry = "https://pypi.org/simple" }
|
||||||
dependencies = [
|
dependencies = [
|
||||||
{ name = "markdown", marker = "sys_platform == 'darwin' or sys_platform == 'linux'" },
|
{ name = "markdown", marker = "sys_platform == 'darwin' or sys_platform == 'linux'" },
|
||||||
{ name = "pyyaml", marker = "sys_platform == 'darwin' or sys_platform == 'linux'" },
|
{ name = "pyyaml", marker = "sys_platform == 'darwin' or sys_platform == 'linux'" },
|
||||||
]
|
]
|
||||||
sdist = { url = "https://files.pythonhosted.org/packages/9e/26/d1015444da4d952a1ca487a236b522eb979766f0295a0bd0c5fc089989a9/pymdown_extensions-10.21.3.tar.gz", hash = "sha256:72cfcf55f07aea0d4af2c4f11dd4e52466ddfb1bb819673146398e0bd3a77354", size = 854140, upload-time = "2026-05-13T12:57:32.267Z" }
|
sdist = { url = "https://files.pythonhosted.org/packages/47/67/f1e79672a5f91985577c7984c9709ca110e4fd37fe7fd167b60422e6ccc2/pymdown_extensions-11.0.tar.gz", hash = "sha256:8269cef0247f9e2d0a62fcea10860aba05c1cbab5470fd4b63230b96434dc589", size = 857049, upload-time = "2026-06-23T02:27:45.146Z" }
|
||||||
wheels = [
|
wheels = [
|
||||||
{ url = "https://files.pythonhosted.org/packages/7e/85/545a951eecc270fcd688288c600017e2050a1aacb56c711d208586d3e470/pymdown_extensions-10.21.3-py3-none-any.whl", hash = "sha256:d7a5d08014fc571e80ca21dd6f854e31f94c489800350564d55d15b3c41e76b6", size = 269002, upload-time = "2026-05-13T12:57:30.296Z" },
|
{ url = "https://files.pythonhosted.org/packages/af/b6/1ae53367e28b9cffa3be7574e13fbe4589694272fd47710fbdbafd3d63c6/pymdown_extensions-11.0-py3-none-any.whl", hash = "sha256:fbc4acb641814fa9d17521bbd21a5240ef739a662f11c06330c4b78c93e954d6", size = 269415, upload-time = "2026-06-23T02:27:43.826Z" },
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
|
|||||||
Reference in New Issue
Block a user