Merge pull request 'Bugfixes Paperless Connector' (#11) from develop into main
Deploy Production / deploy (push) Successful in 48s
Deploy Production / deploy (push) Successful in 48s
Reviewed-on: #11
This commit was merged in pull request #11.
This commit is contained in:
commit
64f22360c1
11 files changed
+391
-197
No files matched your search
@@ -1,8 +1,8 @@
|
||||
name: Test Suite
|
||||
|
||||
# Runs once per push, after "Deploy Development" has updated the checkout it tests.
|
||||
# A push trigger here would start a second run that races the deploy.
|
||||
on:
|
||||
push:
|
||||
branches: [develop]
|
||||
workflow_run:
|
||||
workflows: ["Deploy Development"]
|
||||
types: [completed]
|
||||
|
||||
+25
-69
@@ -4,7 +4,7 @@ from __future__ import annotations
|
||||
|
||||
from uuid import UUID
|
||||
|
||||
from fastapi import APIRouter, Depends
|
||||
from fastapi import APIRouter, Depends, Request
|
||||
from fastapi.responses import JSONResponse, Response
|
||||
from psycopg import Connection
|
||||
|
||||
@@ -28,7 +28,6 @@ from app.sources import (
|
||||
list_connectors,
|
||||
owned_connector,
|
||||
paperless_content,
|
||||
paperless_thumbnail,
|
||||
parse_connector,
|
||||
probe,
|
||||
save_connector,
|
||||
@@ -265,55 +264,23 @@ def _mail_bytes(data: bytes, media_type: str, filename: str, inline: bool = Fals
|
||||
)
|
||||
|
||||
|
||||
class SearchFilters:
|
||||
"""The query parameters every search route shares. A source answers only those it declares."""
|
||||
# These belong to the route. Every other query parameter is a filter the registered module must declare.
|
||||
_ROUTE_PARAMS = frozenset({"q", "connector_id", "mailbox", "before", "uidvalidity"})
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
mode: str = "",
|
||||
title: str = "",
|
||||
correspondent: str = "",
|
||||
document_type: str = "",
|
||||
storage_path: str = "",
|
||||
tag: str = "",
|
||||
tag_mode: str = "",
|
||||
document_from: str = "",
|
||||
document_to: str = "",
|
||||
added_from: str = "",
|
||||
added_to: str = "",
|
||||
asn: str = "",
|
||||
custom: str = "",
|
||||
sort: str = "",
|
||||
cursor: str = "",
|
||||
):
|
||||
self.values = {
|
||||
"mode": mode,
|
||||
"title": title,
|
||||
"correspondent": correspondent,
|
||||
"document_type": document_type,
|
||||
"storage_path": storage_path,
|
||||
"tag": tag,
|
||||
"tag_mode": tag_mode,
|
||||
"document_from": document_from,
|
||||
"document_to": document_to,
|
||||
"added_from": added_from,
|
||||
"added_to": added_to,
|
||||
"asn": asn,
|
||||
"custom": custom,
|
||||
"sort": sort,
|
||||
"cursor": cursor,
|
||||
}
|
||||
|
||||
def _filters(request: Request) -> dict:
|
||||
return {name: value for name, value in request.query_params.items() if name not in _ROUTE_PARAMS}
|
||||
|
||||
|
||||
@router.get("/api/v1/sources/paperless/documents")
|
||||
def search_paperless(
|
||||
request: Request,
|
||||
q: str = "",
|
||||
connector_id: UUID | None = None,
|
||||
filters: SearchFilters = Depends(),
|
||||
principal: Principal = Depends(get_principal),
|
||||
conn: Connection = Depends(get_conn),
|
||||
):
|
||||
return _run_search("paperless", conn, principal.account_id, q.strip(), connector_id, "", None, filters.values)
|
||||
return _run_search("paperless", conn, principal.account_id, q.strip(), connector_id, "", None, _filters(request))
|
||||
|
||||
|
||||
@router.get("/api/v1/sources/{kind}/facets")
|
||||
@@ -344,14 +311,18 @@ def preview_paperless_document(
|
||||
)
|
||||
|
||||
|
||||
@router.get("/api/v1/sources/paperless/documents/{document_id}/thumb")
|
||||
def thumbnail_paperless_document(
|
||||
document_id: str,
|
||||
@router.get("/api/v1/sources/{kind}/thumbnail")
|
||||
def thumbnail_source(
|
||||
kind: str,
|
||||
connector_id: UUID,
|
||||
item: str,
|
||||
principal: Principal = Depends(get_principal),
|
||||
conn: Connection = Depends(get_conn),
|
||||
):
|
||||
data, media = paperless_thumbnail(conn, principal.account_id, document_id, connector_id)
|
||||
module = require_source(kind)
|
||||
if not module.capabilities["search"].get("result_preview") or module.thumbnail is None:
|
||||
raise unsupported("Diese Quelle hat keine Vorschaubilder.")
|
||||
data, media = module.thumbnail(conn, principal.account_id, connector_id, item)
|
||||
return Response(content=data, media_type=media, headers=_PRIVATE)
|
||||
|
||||
|
||||
@@ -366,19 +337,19 @@ def list_mailboxes(
|
||||
|
||||
@router.get("/api/v1/sources/imap/messages")
|
||||
def search_mail(
|
||||
request: Request,
|
||||
connector_id: UUID,
|
||||
q: str = "",
|
||||
mailbox: str = "",
|
||||
before: int | None = None,
|
||||
uidvalidity: int | None = None,
|
||||
filters: SearchFilters = Depends(),
|
||||
principal: Principal = Depends(get_principal),
|
||||
conn: Connection = Depends(get_conn),
|
||||
):
|
||||
if before is not None and before < 1:
|
||||
raise unprocessable("Die Seitenangabe ist ungültig.")
|
||||
return _run_search(
|
||||
"imap", conn, principal.account_id, q.strip(), connector_id, mailbox.strip(), before, filters.values, uidvalidity
|
||||
"imap", conn, principal.account_id, q.strip(), connector_id, mailbox.strip(), before, _filters(request), uidvalidity
|
||||
)
|
||||
|
||||
|
||||
@@ -434,29 +405,14 @@ def _connector_parts(body: ConnectorIn, current: dict | None) -> tuple[str, dict
|
||||
return parse_connector(body.kind, body.name, flat, body.config, current)
|
||||
|
||||
|
||||
_SEARCH_FLAGS = {
|
||||
"mode": "mode",
|
||||
"title": "title",
|
||||
"correspondent": "correspondent",
|
||||
"document_type": "document_type",
|
||||
"storage_path": "storage_path",
|
||||
"tag": "tags",
|
||||
"tag_mode": "tag_mode",
|
||||
"document_from": "document_range",
|
||||
"document_to": "document_range",
|
||||
"added_from": "added_range",
|
||||
"added_to": "added_range",
|
||||
"asn": "asn",
|
||||
"custom": "custom_fields",
|
||||
"sort": "sort",
|
||||
"cursor": "continuation",
|
||||
}
|
||||
|
||||
|
||||
def _run_search(kind: str, conn, owner, query: str, connector_id: UUID | None, mailbox: str, before: int | None, filters: dict, uidvalidity: int | None = None) -> dict:
|
||||
module = require_source(kind)
|
||||
search = module.capabilities["search"]
|
||||
refused = [name for name, value in filters.items() if str(value or "").strip() and not search.get(_SEARCH_FLAGS.get(name, name))]
|
||||
refused = [
|
||||
name
|
||||
for name, value in filters.items()
|
||||
if str(value or "").strip() and not search.get(module.search_params.get(name, ""))
|
||||
]
|
||||
if before is not None and not search.get("continuation"):
|
||||
refused.append("before")
|
||||
if refused:
|
||||
@@ -479,18 +435,18 @@ def _run_navigate(kind: str, conn, owner, connector_id: UUID) -> dict:
|
||||
|
||||
@router.get("/api/v1/sources/{kind}/search")
|
||||
def search_source(
|
||||
request: Request,
|
||||
kind: str,
|
||||
q: str = "",
|
||||
connector_id: UUID | None = None,
|
||||
mailbox: str = "",
|
||||
before: int | None = None,
|
||||
filters: SearchFilters = Depends(),
|
||||
principal: Principal = Depends(get_principal),
|
||||
conn: Connection = Depends(get_conn),
|
||||
):
|
||||
if before is not None and before < 1:
|
||||
raise unprocessable("Die Seitenangabe ist ungültig.")
|
||||
return _run_search(kind, conn, principal.account_id, q.strip(), connector_id, mailbox.strip(), before, filters.values)
|
||||
return _run_search(kind, conn, principal.account_id, q.strip(), connector_id, mailbox.strip(), before, _filters(request))
|
||||
|
||||
|
||||
@router.get("/api/v1/sources/{kind}/navigate")
|
||||
|
||||
@@ -1,93 +1,15 @@
|
||||
"""Declared source and editor capabilities.
|
||||
"""Declared editor capabilities and the payloads that carry them.
|
||||
|
||||
A common contract does not invent abilities the adapter does not have.
|
||||
A filter is offered only when that module implements it.
|
||||
The capabilities of a source belong to its module. A filter is offered only when that module implements it.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
PAPERLESS_CAPABILITIES = {
|
||||
"kind": "paperless",
|
||||
"navigate": False,
|
||||
"read_original": True,
|
||||
"read_preview": True,
|
||||
"read_attachment": False,
|
||||
"edit_content": False,
|
||||
"edit_metadata": False,
|
||||
"search": {
|
||||
"query": True,
|
||||
"mode": True,
|
||||
"title": True,
|
||||
"correspondent": True,
|
||||
"document_type": True,
|
||||
"storage_path": True,
|
||||
"tags": True,
|
||||
"tag_mode": True,
|
||||
"document_range": True,
|
||||
"added_range": True,
|
||||
"asn": True,
|
||||
"custom_fields": True,
|
||||
"sort": True,
|
||||
"continuation": True,
|
||||
"result_preview": True,
|
||||
},
|
||||
}
|
||||
|
||||
IMAP_CAPABILITIES = {
|
||||
"kind": "imap",
|
||||
"navigate": True,
|
||||
"read_original": True,
|
||||
"read_preview": True,
|
||||
"read_attachment": True,
|
||||
"edit_content": False,
|
||||
"edit_metadata": False,
|
||||
"search": {
|
||||
"query": True,
|
||||
"mode": False,
|
||||
"title": False,
|
||||
"correspondent": False,
|
||||
"document_type": False,
|
||||
"storage_path": False,
|
||||
"tags": False,
|
||||
"tag_mode": False,
|
||||
"document_range": False,
|
||||
"added_range": False,
|
||||
"asn": False,
|
||||
"custom_fields": False,
|
||||
"sort": False,
|
||||
"continuation": True,
|
||||
"result_preview": False,
|
||||
},
|
||||
}
|
||||
|
||||
CAPABILITIES = {
|
||||
"paperless": PAPERLESS_CAPABILITIES,
|
||||
"imap": IMAP_CAPABILITIES,
|
||||
}
|
||||
|
||||
EDITORS = {
|
||||
"note": True,
|
||||
"markdown_file": False,
|
||||
}
|
||||
|
||||
UNSUPPORTED_SEARCH = (
|
||||
"mode",
|
||||
"title",
|
||||
"correspondent",
|
||||
"document_type",
|
||||
"storage_path",
|
||||
"tag",
|
||||
"tag_mode",
|
||||
"document_from",
|
||||
"document_to",
|
||||
"added_from",
|
||||
"added_to",
|
||||
"asn",
|
||||
"custom",
|
||||
"sort",
|
||||
"cursor",
|
||||
)
|
||||
|
||||
|
||||
def capability_payload() -> dict:
|
||||
from app.sourceregistry import registered_sources
|
||||
@@ -112,10 +34,6 @@ def capability_payload() -> dict:
|
||||
}
|
||||
|
||||
|
||||
def unsupported_filters(values: dict[str, str]) -> list[str]:
|
||||
return [name for name in UNSUPPORTED_SEARCH if str(values.get(name) or "").strip()]
|
||||
|
||||
|
||||
def with_capabilities(kind: str, connector_id: str, payload: dict) -> dict:
|
||||
from app.sourceregistry import require_source
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from dataclasses import dataclass
|
||||
from dataclasses import dataclass, field
|
||||
from typing import Callable
|
||||
|
||||
from app.core.errors import unprocessable
|
||||
@@ -65,6 +65,11 @@ class SourceModule:
|
||||
navigate: Callable | None = None
|
||||
preview: Callable | None = None
|
||||
facets: Callable | None = None
|
||||
# Query parameter of a search, mapped to the capability flag that must be true for it.
|
||||
# The module owns its filter names. Anything not declared here is refused.
|
||||
search_params: dict[str, str] = field(default_factory=dict)
|
||||
# thumbnail(conn, owner_id, connector_id, item) -> (bytes, media type), when the module declares it.
|
||||
thumbnail: Callable | None = None
|
||||
|
||||
|
||||
_MODULES: dict[str, SourceModule] = {}
|
||||
|
||||
+143
-11
@@ -48,7 +48,6 @@ from app.sourceaccess import (
|
||||
connector_owner as _connector_owner,
|
||||
release_for_external,
|
||||
)
|
||||
from app.sourceport import CAPABILITIES
|
||||
from app.sourceregistry import ConfigField, SourceModule, get_source, parse_fields, register_source, require_source
|
||||
|
||||
|
||||
@@ -418,7 +417,14 @@ def paperless_documents(conn, owner_id: UUID, query: str, connector_id: UUID | N
|
||||
release_for_external(conn)
|
||||
names = _paperless_lookup(row["id"], base, row["secret"])
|
||||
params = _paperless_params(query, options, names["custom_fields"])
|
||||
payload = _paperless_get(base, row["secret"], "/api/documents/", params)
|
||||
# Observed on a real instance: all-tags together with a custom field makes Paperless answer 500.
|
||||
try:
|
||||
payload = _paperless_get(base, row["secret"], "/api/documents/", params)
|
||||
except Problem as problem:
|
||||
clash = "," in params.get("tags__id__all", "") and "custom_field_query" in params
|
||||
if clash and "HTTP 5" in problem.detail:
|
||||
raise unprocessable(f"{problem.detail} Das tritt auf, wenn „Alle gewählten Tags“ mit einem Zusatzfeld zusammentrifft. Wähle „Mindestens eines“ oder lass das Zusatzfeld weg.") from problem
|
||||
raise
|
||||
assert_still_owned(conn, row["id"], owner_id)
|
||||
terms = _search_terms(query, (options or {}).get("title"))
|
||||
items = []
|
||||
@@ -438,6 +444,7 @@ def paperless_documents(conn, owner_id: UUID, query: str, connector_id: UUID | N
|
||||
"document_type": _named(doc.get("document_type"), names["document_types"]),
|
||||
"storage_path": _named(doc.get("storage_path"), names["storage_paths"]),
|
||||
"tags": [name for name in (_named(tag, names["tags"]) for tag in doc.get("tags") or []) if name][:12],
|
||||
"custom_fields": _custom_display(doc.get("custom_fields"), names["custom_fields"]),
|
||||
"pages": pages if isinstance(pages, int) and pages > 0 else None,
|
||||
"asn": asn if isinstance(asn, int) else None,
|
||||
"snippet": _snippet(doc, terms),
|
||||
@@ -478,6 +485,27 @@ def paperless_facets(conn, owner_id: UUID, connector_id: UUID) -> dict:
|
||||
}
|
||||
|
||||
|
||||
_THUMBNAIL_MEDIA = frozenset({"image/png", "image/jpeg", "image/webp", "image/gif"})
|
||||
|
||||
PAPERLESS_SEARCH_PARAMS = {
|
||||
"mode": "mode",
|
||||
"title": "title",
|
||||
"correspondent": "correspondent",
|
||||
"document_type": "document_type",
|
||||
"storage_path": "storage_path",
|
||||
"tag": "tags",
|
||||
"tag_mode": "tag_mode",
|
||||
"document_from": "document_range",
|
||||
"document_to": "document_range",
|
||||
"added_from": "added_range",
|
||||
"added_to": "added_range",
|
||||
"asn": "asn",
|
||||
"custom": "custom_fields",
|
||||
"sort": "sort",
|
||||
"cursor": "continuation",
|
||||
}
|
||||
|
||||
|
||||
def paperless_thumbnail(conn, owner_id: UUID, document_id: str, connector_id: UUID) -> tuple[bytes, str]:
|
||||
if not document_id.isdigit() or len(document_id) > 12:
|
||||
raise unprocessable("Die Paperless-Nummer ist ungültig.")
|
||||
@@ -488,10 +516,19 @@ def paperless_thumbnail(conn, owner_id: UUID, document_id: str, connector_id: UU
|
||||
assert_still_owned(conn, row["id"], owner_id)
|
||||
if fetched is None:
|
||||
raise not_found()
|
||||
data, media, _name = fetched
|
||||
if not media.startswith("image/"):
|
||||
raise unprocessable("Paperless hat kein Vorschaubild geliefert.")
|
||||
return data, media
|
||||
data, header, _name = fetched
|
||||
return data, _thumbnail_media(data, header)
|
||||
|
||||
|
||||
def _thumbnail_media(data: bytes, header: str) -> str:
|
||||
"""Raster pictures only, told by their bytes. A vector file could carry markup, a header can be wrong."""
|
||||
try:
|
||||
media = sniff(data)
|
||||
except Problem:
|
||||
media = "image/gif" if data[:4] == b"GIF8" else ""
|
||||
if media not in _THUMBNAIL_MEDIA:
|
||||
raise unprocessable(f"Paperless hat kein Vorschaubild geliefert (Antworttyp {header or 'unbekannt'}).")
|
||||
return media
|
||||
|
||||
|
||||
_LOOKUP_TTL = 60.0
|
||||
@@ -555,6 +592,33 @@ def _paperless_names_or_none(base: str, token: str, path: str) -> list[dict]:
|
||||
return []
|
||||
|
||||
|
||||
_CUSTOM_SHOWN = 8
|
||||
|
||||
|
||||
def _custom_display(values, fields: list[dict]) -> list[dict]:
|
||||
"""The custom fields of a hit as name, type and readable value. Empty values and unknown fields are left out."""
|
||||
if not isinstance(values, list):
|
||||
return []
|
||||
known = {field["id"]: field for field in fields}
|
||||
shown = []
|
||||
for entry in values:
|
||||
if not isinstance(entry, dict):
|
||||
continue
|
||||
field = known.get(str(entry.get("field")))
|
||||
value = entry.get("value")
|
||||
if field is None or value is None or value == "" or isinstance(value, list):
|
||||
continue
|
||||
if field["type"] == "boolean":
|
||||
text = "Ja" if value else "Nein"
|
||||
elif field["type"] == "select":
|
||||
text = next((option["name"] for option in field["options"] if option["id"] == str(value)), "")
|
||||
else:
|
||||
text = str(value)
|
||||
if text:
|
||||
shown.append({"name": field["name"], "type": field["type"], "value": text[:200]})
|
||||
return shown[:_CUSTOM_SHOWN]
|
||||
|
||||
|
||||
def _named(value, entries: list[dict]) -> str | None:
|
||||
if value is None or isinstance(value, bool):
|
||||
return None
|
||||
@@ -957,11 +1021,22 @@ def _paperless_get(base: str, token: str, path: str, params: dict) -> dict:
|
||||
except HTTPError as exc:
|
||||
if exc.code in {401, 403}:
|
||||
raise unprocessable("Paperless hat den Schlüssel abgelehnt.") from exc
|
||||
raise unprocessable("Paperless hat die Anfrage nicht beantwortet.") from exc
|
||||
raise unprocessable(f"Paperless hat die Anfrage nicht beantwortet ({_refusal(exc, path)}).") from exc
|
||||
except (URLError, TimeoutError, json.JSONDecodeError) as exc:
|
||||
raise unprocessable("Paperless ist nicht erreichbar.") from exc
|
||||
|
||||
|
||||
def _refusal(exc: HTTPError, path: str) -> str:
|
||||
"""Status and, when Paperless names one, its reason. The body is the owner's own instance, cut short."""
|
||||
reason = ""
|
||||
try:
|
||||
body = json.loads(exc.read(2000).decode("utf-8", "replace"))
|
||||
reason = json.dumps(body, ensure_ascii=False)[:240] if isinstance(body, (dict, list)) else ""
|
||||
except (ValueError, OSError):
|
||||
reason = ""
|
||||
return f"HTTP {exc.code} auf {path}" + (f": {reason}" if reason else "")
|
||||
|
||||
|
||||
def _correspondent(doc: dict, names: dict | None = None) -> str | None:
|
||||
value = doc.get("correspondent_name") or doc.get("correspondent")
|
||||
if isinstance(value, str) and value.strip():
|
||||
@@ -2028,11 +2103,66 @@ def _imap_bytes(conn, actor_id: UUID, element: dict, context: Ctx | None, ref) -
|
||||
return raw, "message/rfc822", "nachricht.eml"
|
||||
|
||||
|
||||
PAPERLESS_CAPABILITIES = {
|
||||
"kind": "paperless",
|
||||
"navigate": False,
|
||||
"read_original": True,
|
||||
"read_preview": True,
|
||||
"read_attachment": False,
|
||||
"edit_content": False,
|
||||
"edit_metadata": False,
|
||||
"search": {
|
||||
"query": True,
|
||||
"mode": True,
|
||||
"title": True,
|
||||
"correspondent": True,
|
||||
"document_type": True,
|
||||
"storage_path": True,
|
||||
"tags": True,
|
||||
"tag_mode": True,
|
||||
"document_range": True,
|
||||
"added_range": True,
|
||||
"asn": True,
|
||||
"custom_fields": True,
|
||||
"sort": True,
|
||||
"continuation": True,
|
||||
"result_preview": True,
|
||||
},
|
||||
}
|
||||
|
||||
IMAP_CAPABILITIES = {
|
||||
"kind": "imap",
|
||||
"navigate": True,
|
||||
"read_original": True,
|
||||
"read_preview": True,
|
||||
"read_attachment": True,
|
||||
"edit_content": False,
|
||||
"edit_metadata": False,
|
||||
"search": {
|
||||
"query": True,
|
||||
"mode": False,
|
||||
"title": False,
|
||||
"correspondent": False,
|
||||
"document_type": False,
|
||||
"storage_path": False,
|
||||
"tags": False,
|
||||
"tag_mode": False,
|
||||
"document_range": False,
|
||||
"added_range": False,
|
||||
"asn": False,
|
||||
"custom_fields": False,
|
||||
"sort": False,
|
||||
"continuation": True,
|
||||
"result_preview": False,
|
||||
},
|
||||
}
|
||||
|
||||
|
||||
class _PaperlessAdapter:
|
||||
kind = "paperless"
|
||||
|
||||
def capabilities(self) -> dict:
|
||||
return CAPABILITIES[self.kind]
|
||||
return PAPERLESS_CAPABILITIES
|
||||
|
||||
def probe(self, row) -> dict:
|
||||
count = _paperless_count(row["settings"]["base_url"], row["secret"])
|
||||
@@ -2053,7 +2183,7 @@ class _ImapAdapter:
|
||||
kind = "imap"
|
||||
|
||||
def capabilities(self) -> dict:
|
||||
return CAPABILITIES[self.kind]
|
||||
return IMAP_CAPABILITIES
|
||||
|
||||
def probe(self, row) -> dict:
|
||||
_imap_login(row["settings"], row["secret"])
|
||||
@@ -2076,7 +2206,7 @@ def _install_sources() -> None:
|
||||
kind="paperless",
|
||||
label="Paperless",
|
||||
representation="pdf",
|
||||
capabilities=CAPABILITIES["paperless"],
|
||||
capabilities=PAPERLESS_CAPABILITIES,
|
||||
config_fields=PAPERLESS_FIELDS,
|
||||
normalize_config=_paperless_normalize,
|
||||
probe=paperless.probe,
|
||||
@@ -2086,12 +2216,14 @@ def _install_sources() -> None:
|
||||
navigate=None,
|
||||
preview=None,
|
||||
facets=paperless.facets,
|
||||
search_params=PAPERLESS_SEARCH_PARAMS,
|
||||
thumbnail=lambda conn, owner, connector_id, item: paperless_thumbnail(conn, owner, str(item), connector_id),
|
||||
))
|
||||
register_source(SourceModule(
|
||||
kind="imap",
|
||||
label="E-Mail",
|
||||
representation="email",
|
||||
capabilities=CAPABILITIES["imap"],
|
||||
capabilities=IMAP_CAPABILITIES,
|
||||
config_fields=IMAP_FIELDS,
|
||||
normalize_config=_imap_normalize,
|
||||
probe=imap.probe,
|
||||
|
||||
@@ -10,6 +10,9 @@ import io
|
||||
import zipfile
|
||||
from email.parser import BytesParser
|
||||
|
||||
import pytest
|
||||
|
||||
from app.core.errors import unprocessable
|
||||
from app.media.port import MemoryAdapter
|
||||
from app.sourceaccess import borrow_original, complete_borrow
|
||||
from app.sourceregistry import SourceModule, unregister_source, register_source
|
||||
@@ -472,6 +475,14 @@ def test_paperless_default_search_reads_title_and_content_and_shows_a_preview(cl
|
||||
"tags": [2, 5, 99],
|
||||
"archive_serial_number": 1042,
|
||||
"page_count": 3,
|
||||
"custom_fields": [
|
||||
{"field": 1, "value": "EUR100.50"},
|
||||
{"field": 2, "value": "2024-03-09"},
|
||||
{"field": 3, "value": "b"},
|
||||
{"field": 4, "value": True},
|
||||
{"field": 5, "value": None},
|
||||
{"field": 99, "value": "fremd"},
|
||||
],
|
||||
"content": body,
|
||||
}
|
||||
],
|
||||
@@ -482,6 +493,16 @@ def test_paperless_default_search_reads_title_and_content_and_shows_a_preview(cl
|
||||
return {"results": [{"id": 2, "name": "Miete"}, {"id": 5, "name": "Wohnung"}]}
|
||||
if path == "/api/correspondents/":
|
||||
return {"results": [{"id": 4, "name": "Hausverwaltung"}]}
|
||||
if path == "/api/custom_fields/":
|
||||
return {
|
||||
"results": [
|
||||
{"id": 1, "name": "Rechnungsbetrag", "data_type": "monetary"},
|
||||
{"id": 2, "name": "bezahlt_am", "data_type": "date"},
|
||||
{"id": 3, "name": "Status", "data_type": "select", "extra_data": {"select_options": [{"id": "b", "label": "bezahlt"}]}},
|
||||
{"id": 4, "name": "Geprüft", "data_type": "boolean"},
|
||||
{"id": 5, "name": "Notiz", "data_type": "string"},
|
||||
]
|
||||
}
|
||||
return {"results": [{"id": 8, "name": "Brief"}]}
|
||||
|
||||
monkeypatch.setattr(sources, "_paperless_get", fake_get)
|
||||
@@ -515,17 +536,31 @@ def test_paperless_default_search_reads_title_and_content_and_shows_a_preview(cl
|
||||
assert "Kündigung des Mietvertrags" in item["snippet"]
|
||||
assert len(item["snippet"]) <= 262
|
||||
assert item["snippet"].startswith("…")
|
||||
assert item["custom_fields"] == [
|
||||
{"name": "Rechnungsbetrag", "type": "monetary", "value": "EUR100.50"},
|
||||
{"name": "bezahlt_am", "type": "date", "value": "2024-03-09"},
|
||||
{"name": "Status", "type": "select", "value": "bezahlt"},
|
||||
{"name": "Geprüft", "type": "boolean", "value": "Ja"},
|
||||
]
|
||||
assert found["total"] == 1
|
||||
assert found["previous_page"] is None
|
||||
facets = ada.request("GET", "/api/v1/sources/paperless/facets", params={"connector_id": first["id"]})
|
||||
assert facets["storage_paths"] == []
|
||||
assert facets["tag_modes"] == ["all", "any", "none"]
|
||||
# A filter of another source is refused, not ignored.
|
||||
ada.request(
|
||||
"GET",
|
||||
"/api/v1/sources/imap/messages",
|
||||
params={"connector_id": first["id"], "mailbox": "INBOX", "mode": "title"},
|
||||
status=422,
|
||||
)
|
||||
for params in (
|
||||
{"mode": "regex"},
|
||||
{"tag_mode": "x"},
|
||||
{"asn": "x1"},
|
||||
{"storage_path": "a"},
|
||||
{"q": "miete", "mode": "title", "title": "vertrag"},
|
||||
{"bogus": "1"},
|
||||
):
|
||||
ada.request(
|
||||
"GET",
|
||||
@@ -559,9 +594,12 @@ def test_paperless_custom_field_filters_use_the_instance_fields(client, db, monk
|
||||
]
|
||||
}
|
||||
if path == "/api/documents/":
|
||||
if failing:
|
||||
raise unprocessable(failing[0])
|
||||
return {"count": 0, "results": []}
|
||||
return {"results": []}
|
||||
|
||||
failing = []
|
||||
monkeypatch.setattr(sources, "_paperless_get", fake_get)
|
||||
ada = Actor(client, "ada-custom@example.test", "Ada Custom")
|
||||
register(db, ada.email, ada.name)
|
||||
@@ -618,6 +656,50 @@ def test_paperless_custom_field_filters_use_the_instance_fields(client, db, monk
|
||||
params={"connector_id": first["id"], "custom": "kein json"},
|
||||
status=422,
|
||||
)
|
||||
# Paperless answers 500 for all-tags together with a custom field: the message names that pairing.
|
||||
failing.append("Paperless hat die Anfrage nicht beantwortet (HTTP 500 auf /api/documents/).")
|
||||
row = json.dumps([{"field": "2", "op": "exists", "value": True}])
|
||||
|
||||
def refused(extra):
|
||||
return ada.request(
|
||||
"GET",
|
||||
"/api/v1/sources/paperless/documents",
|
||||
params={"connector_id": first["id"], "custom": row, **extra},
|
||||
status=422,
|
||||
)
|
||||
|
||||
assert "Alle gewählten Tags" in str(refused({"tag": "1,2"}))
|
||||
assert "Alle gewählten Tags" not in str(refused({"tag": "1,2", "tag_mode": "any"}))
|
||||
assert "Alle gewählten Tags" not in str(refused({"tag": "1"}))
|
||||
|
||||
|
||||
def test_paperless_refusal_names_the_status_and_reason(monkeypatch):
|
||||
import io
|
||||
from urllib.error import HTTPError
|
||||
|
||||
import app.sources as sources
|
||||
from app.core.errors import Problem
|
||||
|
||||
def refuse(code, body):
|
||||
def fake(request, timeout=0):
|
||||
raise HTTPError(request.full_url, code, "x", {}, io.BytesIO(body))
|
||||
|
||||
return fake
|
||||
|
||||
monkeypatch.setattr(sources, "urlopen", refuse(400, '{"custom_field_query": ["Ungültig"]}'.encode()))
|
||||
with pytest.raises(Problem) as caught:
|
||||
sources._paperless_get("https://paper.example.test", "token-alpha", "/api/documents/", {"page_size": "20"})
|
||||
assert "HTTP 400 auf /api/documents/" in caught.value.detail
|
||||
assert "custom_field_query" in caught.value.detail
|
||||
assert "token-alpha" not in caught.value.detail
|
||||
monkeypatch.setattr(sources, "urlopen", refuse(500, b"<html>Fehler</html>"))
|
||||
with pytest.raises(Problem) as caught:
|
||||
sources._paperless_get("https://paper.example.test", "token-alpha", "/api/documents/", {})
|
||||
assert caught.value.detail.endswith("(HTTP 500 auf /api/documents/).")
|
||||
monkeypatch.setattr(sources, "urlopen", refuse(403, b"{}"))
|
||||
with pytest.raises(Problem) as caught:
|
||||
sources._paperless_get("https://paper.example.test", "token-alpha", "/api/documents/", {})
|
||||
assert "Schlüssel abgelehnt" in caught.value.detail
|
||||
|
||||
|
||||
def test_paperless_thumbnail_is_bound_to_the_owners_instance(client, db, monkeypatch):
|
||||
@@ -631,6 +713,10 @@ def test_paperless_thumbnail_is_bound_to_the_owners_instance(client, db, monkeyp
|
||||
return b"RIFFxxxxWEBP", "image/webp", ""
|
||||
if path.endswith("/8/thumb/"):
|
||||
return b"<p>", "text/html", ""
|
||||
if path.endswith("/6/thumb/"):
|
||||
return b"\x89PNG\r\n\x1a\nxxxx", "application/octet-stream", ""
|
||||
if path.endswith("/7/thumb/"):
|
||||
return b"<svg xmlns='http://www.w3.org/2000/svg'/>", "image/svg+xml", ""
|
||||
return None
|
||||
|
||||
monkeypatch.setattr(sources, "_paperless_file", fake_file)
|
||||
@@ -643,21 +729,29 @@ def test_paperless_thumbnail_is_bound_to_the_owners_instance(client, db, monkeyp
|
||||
json={"kind": "paperless", "name": "Archiv", "base_url": "https://paper.example.test", "token": "token-alpha"},
|
||||
status=201,
|
||||
)
|
||||
url = "/api/v1/sources/paperless/documents/{}/thumb"
|
||||
ok = ada.client.get(url.format(9), params={"connector_id": first["id"]}, headers=_headers(ada))
|
||||
url = "/api/v1/sources/paperless/thumbnail"
|
||||
|
||||
def get(actor, item, kind_url=url):
|
||||
return actor.client.get(kind_url, params={"connector_id": first["id"], "item": item}, headers=_headers(actor))
|
||||
|
||||
ok = get(ada, 9)
|
||||
assert ok.status_code == 200
|
||||
assert ok.headers["content-type"] == "image/webp"
|
||||
assert ok.headers["cache-control"] == "private, no-store"
|
||||
assert seen[-1] == ("token-alpha", "/api/documents/9/thumb/")
|
||||
assert ada.client.get(url.format(8), params={"connector_id": first["id"]}, headers=_headers(ada)).status_code == 422
|
||||
assert ada.client.get(url.format(5), params={"connector_id": first["id"]}, headers=_headers(ada)).status_code == 404
|
||||
assert ada.client.get(url.format("x1"), params={"connector_id": first["id"]}, headers=_headers(ada)).status_code == 422
|
||||
typed = get(ada, 6)
|
||||
assert typed.status_code == 200 and typed.headers["content-type"] == "image/png"
|
||||
assert get(ada, 8).status_code == 422
|
||||
assert get(ada, 7).status_code == 422
|
||||
assert get(ada, 5).status_code == 404
|
||||
assert get(ada, "x1").status_code == 422
|
||||
# IMAP declares no thumbnails, and the module must declare the capability.
|
||||
assert get(ada, 9, "/api/v1/sources/imap/thumbnail").status_code == 422
|
||||
ben = Actor(client, "ben-thumb@example.test", "Ben Thumb")
|
||||
register(db, ben.email, ben.name)
|
||||
ben.login()
|
||||
stranger = ben.client.get(url.format(9), params={"connector_id": first["id"]}, headers=_headers(ben))
|
||||
assert stranger.status_code == 404
|
||||
assert len(seen) == 3
|
||||
assert get(ben, 9).status_code == 404
|
||||
assert len(seen) == 5
|
||||
|
||||
|
||||
def test_revoked_grant_hides_bytes_fetched_during_the_call(client, db, monkeypatch):
|
||||
|
||||
+2
-2
@@ -30,7 +30,7 @@ Unter `/home/lars/docker/` legt der Lauf nur diese zwei Verzeichnisse an:
|
||||
|----------|---------|--------|
|
||||
| `deploy-dev.yml` | Push `develop` | Deploy nach `/home/lars/docker/tsumugu-dev`, Health `localhost:8094` und `localhost:3094` |
|
||||
| `deploy-prod.yml` | Push `main` | Deploy nach `/home/lars/docker/tsumugu`, Health `localhost:8007` und `localhost:3007` |
|
||||
| `test.yml` | Push `develop`, nach erfolgreichem Dev-Deploy, manuell | Pytest gegen `tsumugu_test` auf der Dev-Postgres, Smoke der laufenden Dev-App, Frontend-Build |
|
||||
| `test.yml` | Nach erfolgreichem Dev-Deploy (`workflow_run`), manuell | Pytest gegen `tsumugu_test` auf der Dev-Postgres, Smoke der laufenden Dev-App, Frontend-Build |
|
||||
|
||||
Gearbeitet wird auf `develop`. Production entsteht nur durch einen Merge-Commit `develop` → `main` (`git merge --no-ff develop` auf `main`) und den anschließenden Push von `main`. Kein Fast-Forward, kein direkter Commit auf `main`, kein manuelles `git pull` auf dem Prod-Checkout. Gitea (`deploy-prod.yml`) ist der einzige Prod-Schreibpfad für Code.
|
||||
|
||||
@@ -54,7 +54,7 @@ Diese Punkte sind im [Code-Review](review/06_BEFUNDE.md) beschrieben. Sie stehen
|
||||
| Datenbankzugang | Das Backend migriert beim Start mit dem Owner-Zugang. Die Runtime-Rolle `tsumugu_runtime` erhält dasselbe Passwort wie `DB_USER` | Ein Wechsel von `DB_PASSWORD` ändert beim nächsten Start beide Rollen | R-09 |
|
||||
| Quellen-Geheimnisse | Paperless-Token und IMAP-Passwörter stehen unverschlüsselt in der Tabelle `connectors` | Datenbank-Dumps wie Zugangsdaten schützen | R-05 |
|
||||
| Sessions | 14 Tage gültig, keine Leerlaufabmeldung, kein Passwortwechsel in der Anwendung | Passwort nur über die Datenbank oder ein neues Konto änderbar | R-08 |
|
||||
| Testläufe | `test.yml` startet je Push zweimal auf derselben Datenbank `tsumugu_test` | Ein roter Lauf kann vom parallelen Lauf verursacht sein; Ergebnis des Einzellaufs prüfen | R-27 |
|
||||
| Testläufe | `test.yml` startet je Push einmal, nach dem Dev-Deploy; alle Läufe teilen die Datenbank `tsumugu_test`, und das Image bleibt das Laufzeitimage | Zwei manuelle Läufe gleichzeitig vermeiden; sie würden sich die Datenbank wegnehmen | R-27 |
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -193,13 +193,13 @@ Legende Spalte „Auth“: **–** öffentlich, **S** gültige Session, **S+R**
|
||||
| DELETE | `/api/v1/connectors/{id}` | Zugang löschen; bestehende Referenzen bleiben und werden nicht umgehängt |
|
||||
| POST | `/api/v1/connectors/{id}/probe` | gespeicherten Zugang prüfen; Ergebnis (auch ein Fehler) wird als Prüfstand festgehalten. Es gibt keine Prüfung mit ungespeicherten Entwürfen |
|
||||
| GET | `/api/v1/sources/capabilities` | erklärte Such-, Lese- und Editorfähigkeiten; nicht Vorhandenes bleibt falsch |
|
||||
| GET | `/api/v1/sources/{kind}/search` | Suche der registrierten Quelle im erklärten Umfang; unbekannte Art und nicht erklärte Filter antworten `422` |
|
||||
| GET | `/api/v1/sources/{kind}/search` | Suche der registrierten Quelle im erklärten Umfang. Außer `q`, `connector_id`, `mailbox`, `before` und `uidvalidity` ist jeder Abfrageparameter ein Filter, den das Modul in `search_params` deklariert; unbekannte Art, nicht deklarierte oder nicht erklärte Filter und unbekannte Parameter antworten `422` |
|
||||
| GET | `/api/v1/sources/{kind}/navigate?connector_id=` | Fachnavigation, wenn die Quelle sie erklärt |
|
||||
| GET | `/api/v1/sources/{kind}/preview` | Vorschau vor dem Übernehmen, wenn die Quelle sie erklärt |
|
||||
| GET | `/api/v1/sources/paperless/documents?q=&connector_id=` | Paperless-Suche, 20 Treffer je Seite, `cursor` ist die Seitennummer. `mode`: `title_content` (Standard, Titel und Inhalt ohne Index), `title`, `content`, `index` (Volltextindex von Paperless). Filter: `title`, `correspondent`, `document_type`, `storage_path` (jeweils Nummer oder `none` für „ohne“), `tag` (Nummern, durch Komma) mit `tag_mode` `all` (Standard), `any` oder `none`, `document_from`/`document_to` (Dokumentdatum), `added_from`/`added_to` (Hinzugefügt), `asn`, `custom` (JSON-Liste `[{field, op, value}]`, höchstens 5, alle zugleich; `field` ist die Nummer aus `facets.custom_fields`, `op` je Feldtyp `exact`, `icontains`, `istartswith`, `iendswith`, `gt`, `gte`, `lt`, `lte`, `range` oder `exists`; Dokumentverweis-Felder sind nicht filterbar; wird als `custom_field_query` an Paperless gegeben), `sort` (`created`, `added`, `title`, jeweils mit `-`; `-score` nur bei `mode=index` mit Suchtext). Ein ungültiger Wert antwortet `422`. Je Treffer: `title`, `document_on`, `added_on`, `correspondent`, `document_type`, `storage_path`, `tags` (Namen), `pages`, `asn`, `snippet` (Textauszug, reiner Text) und `open_url`; dazu `total`, `next_page`, `previous_page` |
|
||||
| GET | `/api/v1/sources/{kind}/facets?connector_id=` | Auswahllisten der Instanz (Paperless: Korrespondenten, Dokumenttypen, Speicherpfade, Tags, Zusatzfelder mit Typ und Auswahlwerten). Namen und Listen werden je Instanz und Schlüssel eine Minute lang vorgehalten |
|
||||
| GET | `/api/v1/sources/paperless/documents/{id}/preview?connector_id=` | Datei zum Ansehen vor dem Übernehmen |
|
||||
| GET | `/api/v1/sources/paperless/documents/{id}/thumb?connector_id=` | Vorschaubild der Trefferliste. Läuft über den Server der eigenen Instanz, `private, no-store`; fremde Instanz `404`, Antwort ohne Bild `422` |
|
||||
| GET | `/api/v1/sources/{kind}/thumbnail?connector_id=&item=` | Vorschaubild eines Treffers, nur wenn das Modul `search.result_preview` erklärt und ein `thumbnail` bereitstellt, sonst `422`. Läuft über den Server der eigenen Instanz, `private, no-store`, nur Rastergrafiken (PNG, JPEG, WebP, GIF); fremde Instanz `404`, eine Antwort ohne Bild `422` |
|
||||
| GET | `/api/v1/sources/imap/mailboxes?connector_id=` | IMAP-Fächer |
|
||||
| GET | `/api/v1/sources/imap/messages?connector_id=&mailbox=&q=&before=` | Nachrichtenliste, 30 je Seite, Fortsetzung über `before` |
|
||||
| GET | `/api/v1/sources/imap/message?connector_id=&mailbox=&uid=` | Vorschau vor dem Übernehmen |
|
||||
|
||||
@@ -99,3 +99,20 @@ Die Konfiguration einer Instanz gehört dem Modul. Ein Modul deklariert `config_
|
||||
Neuer Connector: Modul mit `config_fields` in `register_source` eintragen, UI-Modul mit `registerSourceModule` registrieren. Kein Eingriff in `ConnectorIn`, `Sources.jsx` oder die Fachseiten.
|
||||
|
||||
Nachweis und Grenzen: `backend/tests/test_connector_config.py` (Manifest, Geheimnis, Instanzerhalt, Fremdzugriff, Prüfstand) und `frontend/src/sources/config-core.test.mjs` (6 Node-Tests bestanden), Frontend-Build erfolgreich. Die Backend-Tests wurden in dieser Umgebung **nicht ausgeführt** (kein Python, keine PostgreSQL-Instanz). Keine Bedienprüfung im Browser. Zugangsdaten bleiben im Klartext (R-05); Archivmodus und DataPolicy sind nicht Teil dieses Schnitts.
|
||||
|
||||
## Paperless-Suche, Erweiterung am 24.10.2026
|
||||
|
||||
Auf Wunsch des Nutzers erweitert über den Umfang von Abschnitt C des Nacharbeitsauftrags hinaus: Suchart (Titel und Inhalt als Standard ohne Index, nur Titel, nur Inhalt, Volltextindex), Speicherpfad, Tag-Verknüpfung (alle, mindestens eines, keines), „ohne“ bei Korrespondent, Typ und Pfad, Hinzugefügt-Datum, Archivnummer und Zusatzfelder. Dazu eine Trefferkarte mit Vorschaubild, Textauszug, Tags, Typ und Seitenzahl sowie ein großer Dialog mit Filtern links und Treffern rechts. Zusatzfeld-Abfragen waren im Auftrag ausdrücklich kein Pflichtumfang und sind hier auf Nutzerwunsch dazugekommen.
|
||||
|
||||
**Verantwortung im Modul:** Die Filternamen eines Moduls deklariert `SourceModule.search_params` (Parametername auf Fähigkeitsflag). Die gemeinsame Suchroute kennt keinen Filternamen mehr. Sie reicht alle übrigen Abfrageparameter weiter und weist jeden ab, den das Modul nicht deklariert oder dessen Fähigkeit nicht wahr ist. Das gilt auch für unbekannte Parameter. Das Vorschaubild ist eine optionale Modulfähigkeit (`SourceModule.thumbnail`, Route `/api/v1/sources/{kind}/thumbnail`, Flag `search.result_preview`). Ein Modul ohne Deklaration lehnt es mit `422` ab.
|
||||
|
||||
**Verbleibende Quellkenntnis im allgemeinen Code (zulässig):** Die Kompatibilitätsrouten `/api/v1/sources/paperless/documents` und `.../preview` in `backend/app/api/sources.py` delegieren nur und tragen keine eigene Protokoll- oder Rechtelogik. Die Fähigkeiten von Paperless und IMAP stehen jetzt in `backend/app/sources.py` beim jeweiligen Modul; `backend/app/sourceport.py` enthält nur noch die Editorfähigkeiten und die Nutzlasten. Die unbenutzte Liste `UNSUPPORTED_SEARCH` und `unsupported_filters` sind entfernt. In der Oberfläche liegt der Paperless-Auswahldialog in `frontend/src/pages/Sources.jsx` und wird über `registerSourceModule` (`large: true`) eingehängt; Fachseiten und Modal kennen nur das allgemeine Flag.
|
||||
|
||||
| Nachweis | Ergebnis |
|
||||
|---|---|
|
||||
| Backend-Suite gegen `tsumugu_local_test` (eingebettete PostgreSQL, Wegwerf-Umgebung) | **164 Tests bestanden** |
|
||||
| `test_connector_followup.py`: Parameterübertragung je Filter, Standardsuche, Textauszug, Namensauflösung, Zusatzfelder samt Ablehnung ungültiger Eingaben, fremder Filter und unbekannter Parameter `422`, Vorschaubild nur für Raster, fremde Instanz `404` | bestanden, gegen Attrappe |
|
||||
| Bedienung im Browser (Chrome headless, Desktop 1440×900 und 390×844) gegen die echte Oberfläche, die echte API und einen nachgebildeten Paperless-HTTP-Server: Dialoggröße, Suche, Vorschaubilder, Textauszug, Ansicht in der Karte, unvollständige Zusatzfeld-Zeile meldet statt zu senden, Zusatzfelder gehen als `custom_field_query` hinaus, Blättern erhält die Auswahl, Einfügen, keine Konsolenfehler | 38 von 38 Prüfungen bestanden. Dabei ist ein Überlappen von Filtern und Treffern auf 390 px gefunden und behoben worden. |
|
||||
|
||||
**Grenze:** Keine der Prüfungen lief gegen die echte Paperless-Instanz. Die Parameternamen (`title_content`, `tags__id__none`, `storage_path__id`, `added__date__gte`, `archive_serial_number`, `custom_field_query`) stammen aus der Kenntnis der Paperless-ngx-API und stehen am Stellvertreter, nicht an der Nutzerinstanz belegt. Die Flags `custom_fields` und `result_preview` sind damit nur durch Code und Attrappe ausführbar belegt. Offen sind insbesondere der Wert eines Betragsfelds (reine Zahl ohne Währung), der Textauszug im Volltextindex und die Mindestversion für Zusatzfeld-Abfragen. Eine Prüfung an der echten Instanz braucht eine ausdrückliche Freigabe.
|
||||
|
||||
@@ -155,7 +155,20 @@ function customKind(field) {
|
||||
return CUSTOM_KINDS[field?.type] || "text";
|
||||
}
|
||||
|
||||
// Only rows that are complete go to the server. An empty row is a row not filled in yet.
|
||||
// A row that is not complete is reported, not left out of the search.
|
||||
function customProblem(rows) {
|
||||
for (const row of rows) {
|
||||
const name = row.field ? "Eine Zusatzfeld-Bedingung" : "Eine Zusatzfeld-Bedingung ohne Feld";
|
||||
if (!row.field) return `${name} ist unvollständig. Wähle ein Feld oder entferne die Zeile.`;
|
||||
const presence = row.op === "set" || row.op === "unset";
|
||||
if (presence || row.kind === "boolean") continue;
|
||||
if (row.op === "range" ? !(row.value && row.value2) : !String(row.value).trim()) {
|
||||
return `${name} ist unvollständig. Gib den Wert an oder entferne die Zeile.`;
|
||||
}
|
||||
}
|
||||
return "";
|
||||
}
|
||||
|
||||
function customPayload(rows) {
|
||||
const payload = [];
|
||||
for (const row of rows) {
|
||||
@@ -252,21 +265,21 @@ function CustomFieldFilters({ fields, rows, onChange }) {
|
||||
// The thumbnail comes through the server like every other Paperless call, so the key stays there.
|
||||
function PaperlessThumb({ connectorId, id }) {
|
||||
const [url, setUrl] = useState("");
|
||||
const [failed, setFailed] = useState(false);
|
||||
const [failed, setFailed] = useState("");
|
||||
|
||||
useEffect(() => {
|
||||
let alive = true;
|
||||
let made = "";
|
||||
setUrl("");
|
||||
setFailed(false);
|
||||
fetchBlob(`/api/v1/sources/paperless/documents/${id}/thumb?connector_id=${connectorId}`)
|
||||
setFailed("");
|
||||
fetchBlob(`/api/v1/sources/paperless/thumbnail?connector_id=${connectorId}&item=${id}`)
|
||||
.then((blob) => {
|
||||
if (!alive) return;
|
||||
made = URL.createObjectURL(blob);
|
||||
setUrl(made);
|
||||
})
|
||||
.catch(() => {
|
||||
if (alive) setFailed(true);
|
||||
.catch((err) => {
|
||||
if (alive) setFailed(err.message || "Das Vorschaubild ist nicht verfügbar.");
|
||||
});
|
||||
return () => {
|
||||
alive = false;
|
||||
@@ -275,7 +288,7 @@ function PaperlessThumb({ connectorId, id }) {
|
||||
}, [connectorId, id]);
|
||||
|
||||
if (url) return <img src={url} alt="" className="paperless-thumb__image" />;
|
||||
return <span className="paperless-thumb__empty" aria-hidden="true">{failed ? "Kein Bild" : ""}</span>;
|
||||
return <span className="paperless-thumb__empty" title={failed || undefined}>{failed ? "Kein Bild" : ""}</span>;
|
||||
}
|
||||
|
||||
export function PaperlessPicker({ context, placement, chapterId = "", chapterTitle = "", targetLabel = "", onDone, onInserted }) {
|
||||
@@ -294,6 +307,9 @@ export function PaperlessPicker({ context, placement, chapterId = "", chapterTit
|
||||
const [previewUrl, setPreviewUrl] = useState("");
|
||||
const [pending, setPending] = useState(false);
|
||||
const [error, setError] = useState("");
|
||||
// The filters sit beside the hits on a wide screen. On a phone they start folded away.
|
||||
const [tagSearch, setTagSearch] = useState("");
|
||||
const [moreOpen, setMoreOpen] = useState(() => typeof window === "undefined" || !window.matchMedia || window.matchMedia("(min-width: 900px)").matches);
|
||||
const searchRef = useRef(0);
|
||||
const previewRef = useRef(0);
|
||||
const facetRef = useRef(0);
|
||||
@@ -338,8 +354,7 @@ export function PaperlessPicker({ context, placement, chapterId = "", chapterTit
|
||||
if (connectorId) params.set("connector_id", connectorId);
|
||||
if (text) params.set("q", text);
|
||||
if (text && filters.mode !== "title_content") params.set("mode", filters.mode);
|
||||
// The search text already is the title in this mode.
|
||||
if (filters.title.trim() && !(text && filters.mode === "title")) params.set("title", filters.title.trim());
|
||||
if (filters.title.trim()) params.set("title", filters.title.trim());
|
||||
if (filters.correspondent) params.set("correspondent", filters.correspondent);
|
||||
if (filters.documentType) params.set("document_type", filters.documentType);
|
||||
if (filters.storagePath) params.set("storage_path", filters.storagePath);
|
||||
@@ -383,6 +398,11 @@ export function PaperlessPicker({ context, placement, chapterId = "", chapterTit
|
||||
setError("Wähle zuerst den Paperless-Zugang.");
|
||||
return;
|
||||
}
|
||||
const problem = customProblem(filters.custom);
|
||||
if (problem) {
|
||||
setError(problem);
|
||||
return;
|
||||
}
|
||||
const token = searchRef.current + 1;
|
||||
searchRef.current = token;
|
||||
const asked = connectorId;
|
||||
@@ -505,6 +525,16 @@ export function PaperlessPicker({ context, placement, chapterId = "", chapterTit
|
||||
setFilters((current) => ({ ...current, mode, sort: current.sort === "-score" && mode !== "index" ? "-created" : current.sort }));
|
||||
}
|
||||
|
||||
const visibleTags = facets.tags.filter((item) => item.name.toLocaleLowerCase().includes(tagSearch.trim().toLocaleLowerCase()));
|
||||
|
||||
function tagName(id) {
|
||||
return facets.tags.find((item) => item.id === id)?.name || id;
|
||||
}
|
||||
|
||||
function selectTags(ids) {
|
||||
setFilters((current) => ({ ...current, tags: [...new Set([...current.tags, ...ids])] }));
|
||||
}
|
||||
|
||||
function toggleTag(id) {
|
||||
setFilters((current) => {
|
||||
const tags = current.tags.includes(id) ? current.tags.filter((item) => item !== id) : [...current.tags, id];
|
||||
@@ -568,15 +598,12 @@ export function PaperlessPicker({ context, placement, chapterId = "", chapterTit
|
||||
<button type="submit">Suchen</button>
|
||||
</div>
|
||||
<p className="muted">{PAPERLESS_MODE_HINTS[filters.mode]}</p>
|
||||
<details className="paperless-more" open>
|
||||
<details className="paperless-more" open={moreOpen} onToggle={(event) => setMoreOpen(event.currentTarget.open)}>
|
||||
<summary>{active ? `Weitere Filter (${active} aktiv)` : "Weitere Filter"}</summary>
|
||||
<div className="source-filters">
|
||||
<label>
|
||||
Titel enthält
|
||||
<input value={filters.title} onChange={(event) => setFilter("title", event.target.value)} />
|
||||
{filters.mode === "title" && filters.query.trim() && filters.title.trim() ? (
|
||||
<span className="muted">Bei „Nur Titel“ gilt der Suchtext als Titel. Dieses Feld bleibt unberücksichtigt.</span>
|
||||
) : null}
|
||||
</label>
|
||||
<label>
|
||||
Korrespondent
|
||||
@@ -600,13 +627,39 @@ export function PaperlessPicker({ context, placement, chapterId = "", chapterTit
|
||||
<option value="none">Keines der gewählten Tags</option>
|
||||
</select>
|
||||
</label>
|
||||
{filters.tags.length ? (
|
||||
<ul className="paperless-chips" aria-label="Gewählte Tags">
|
||||
{filters.tags.map((id) => (
|
||||
<li key={id}>
|
||||
<button type="button" className="paperless-chip" onClick={() => toggleTag(id)} aria-label={`Tag ${tagName(id)} entfernen`}>
|
||||
{tagName(id)} <span aria-hidden="true">×</span>
|
||||
</button>
|
||||
</li>
|
||||
))}
|
||||
</ul>
|
||||
) : null}
|
||||
{facets.tags.length ? (
|
||||
<>
|
||||
<input type="search" value={tagSearch} onChange={(event) => setTagSearch(event.target.value)} placeholder="Tags suchen" aria-label="Tags suchen" />
|
||||
<div className="paperless-tags__actions">
|
||||
<button type="button" className="quiet" onClick={() => selectTags(visibleTags.map((item) => item.id))} disabled={!visibleTags.length}>
|
||||
{tagSearch.trim() ? "Treffer wählen" : "Alle wählen"}
|
||||
</button>
|
||||
<button type="button" className="quiet" onClick={() => setFilter("tags", [])} disabled={!filters.tags.length}>
|
||||
Alle abwählen
|
||||
</button>
|
||||
</div>
|
||||
</>
|
||||
) : null}
|
||||
<div className="paperless-tags">
|
||||
{facets.tags.length ? facets.tags.map((item) => (
|
||||
{visibleTags.map((item) => (
|
||||
<label key={item.id} className="paperless-pick">
|
||||
<input type="checkbox" checked={filters.tags.includes(item.id)} onChange={() => toggleTag(item.id)} />
|
||||
<span>{item.name}</span>
|
||||
</label>
|
||||
)) : <p className="muted">Keine Tags an diesem Zugang.</p>}
|
||||
))}
|
||||
{!facets.tags.length ? <p className="muted">Keine Tags an diesem Zugang.</p> : null}
|
||||
{facets.tags.length && !visibleTags.length ? <p className="muted">Kein Tag passt zur Suche.</p> : null}
|
||||
</div>
|
||||
</fieldset>
|
||||
<label>
|
||||
@@ -698,6 +751,16 @@ export function PaperlessPicker({ context, placement, chapterId = "", chapterTit
|
||||
{item.tags.map((tag) => <li key={tag}>{tag}</li>)}
|
||||
</ul>
|
||||
) : null}
|
||||
{item.custom_fields?.length ? (
|
||||
<dl className="paperless-card__fields" aria-label="Zusatzfelder">
|
||||
{item.custom_fields.map((field) => (
|
||||
<div key={field.name}>
|
||||
<dt>{field.name}</dt>
|
||||
<dd>{field.type === "date" && formatDate(field.value) !== "Ohne Datum" ? formatDate(field.value) : field.value}</dd>
|
||||
</div>
|
||||
))}
|
||||
</dl>
|
||||
) : null}
|
||||
{item.snippet ? <p className="paperless-card__snippet">{item.snippet}</p> : null}
|
||||
<div className="row">
|
||||
<button type="button" className="quiet" onClick={() => preview(item)} aria-expanded={open}>
|
||||
|
||||
+12
-3
@@ -1740,6 +1740,9 @@ button.pick-tree__twist {
|
||||
.paperless-search { display: grid; grid-template-columns: minmax(9rem, 12rem) minmax(0, 1fr) auto; gap: 8px; align-items: end; }
|
||||
.paperless-more > summary { cursor: pointer; font-weight: 600; min-height: 32px; }
|
||||
.paperless-tags { display: grid; gap: 2px; max-height: 12rem; overflow: auto; }
|
||||
.paperless-tags__actions { display: flex; flex-wrap: wrap; gap: 6px; }
|
||||
.paperless-chips { display: flex; flex-wrap: wrap; gap: 4px; margin: 0; padding: 0; list-style: none; }
|
||||
.paperless-chip { padding: 2px 10px; border: 1px solid var(--border); border-radius: 999px; background: var(--surface2); color: var(--text); font-size: 13px; cursor: pointer; }
|
||||
.paperless-card {
|
||||
display: grid;
|
||||
grid-template-columns: auto 5rem minmax(0, 1fr);
|
||||
@@ -1766,6 +1769,11 @@ button.pick-tree__twist {
|
||||
}
|
||||
.paperless-card__tags { display: flex; flex-wrap: wrap; gap: 4px; margin: 0; padding: 0; list-style: none; }
|
||||
.paperless-card__tags li { padding: 0 8px; border-radius: 999px; background: var(--surface2); color: var(--text2); font-size: 12px; }
|
||||
.paperless-card__fields { display: flex; flex-wrap: wrap; gap: 2px 14px; margin: 0; font-size: 13px; }
|
||||
.paperless-card__fields div { display: flex; gap: 4px; min-width: 0; }
|
||||
.paperless-card__fields dt { color: var(--text3); }
|
||||
.paperless-card__fields dt::after { content: ":"; }
|
||||
.paperless-card__fields dd { margin: 0; color: var(--text1); font-weight: 600; overflow-wrap: anywhere; }
|
||||
.paperless-card__view { grid-column: 1 / -1; }
|
||||
.paperless-thumb {
|
||||
display: grid;
|
||||
@@ -1782,9 +1790,10 @@ button.pick-tree__twist {
|
||||
.paperless-thumb__image { display: block; width: 100%; height: 100%; object-fit: cover; object-position: top; }
|
||||
.paperless-thumb__empty { color: var(--text3); font-size: 11px; }
|
||||
@media (max-width: 899px) {
|
||||
.modal--large .paperless-layout { grid-template-columns: minmax(0, 1fr); overflow: auto; }
|
||||
.modal--large .paperless-layout__filters, .modal--large .paperless-layout__results { overflow: visible; border-right: 0; padding-right: 0; }
|
||||
.modal.modal--large { overflow: auto; }
|
||||
.modal.modal--large { overflow: auto; display: block; height: min(96vh, 1400px); }
|
||||
.modal.modal--large > .stack { display: grid; flex: none; overflow: visible; }
|
||||
.modal--large .paperless-layout { flex: none; grid-template-columns: minmax(0, 1fr); grid-auto-rows: max-content; overflow: visible; }
|
||||
.modal--large .paperless-layout__filters, .modal--large .paperless-layout__results { min-height: auto; overflow: visible; border-right: 0; padding-right: 0; }
|
||||
}
|
||||
@media (max-width: 600px) {
|
||||
.paperless-search { grid-template-columns: minmax(0, 1fr); }
|
||||
|
||||
Reference in new issue
Block a user