mirror of
https://github.com/paperless-ngx/paperless-ngx.git
synced 2026-08-09 04:13:18 +00:00
Compare commits
8
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
17dc482872 | ||
|
|
b0e0e8a353 | ||
|
|
fc242bb570 | ||
|
|
b192a419fd | ||
|
|
3986150f95 | ||
|
|
ee5588ade3 | ||
|
|
2635a12281 | ||
|
|
1f396e51f3 |
@@ -38,7 +38,6 @@ dependencies = [
|
|||||||
"django-soft-delete~=1.0.18",
|
"django-soft-delete~=1.0.18",
|
||||||
"django-treenode>=0.24",
|
"django-treenode>=0.24",
|
||||||
"djangorestframework~=3.16",
|
"djangorestframework~=3.16",
|
||||||
"djangorestframework-guardian~=0.4.0",
|
|
||||||
"drf-spectacular~=0.30",
|
"drf-spectacular~=0.30",
|
||||||
"drf-spectacular-sidecar~=2026.7.1",
|
"drf-spectacular-sidecar~=2026.7.1",
|
||||||
"drf-writable-nested~=0.7.1",
|
"drf-writable-nested~=0.7.1",
|
||||||
|
|||||||
@@ -151,6 +151,13 @@
|
|||||||
inset: 0;
|
inset: 0;
|
||||||
pointer-events: none;
|
pointer-events: none;
|
||||||
|
|
||||||
|
& section {
|
||||||
|
position: absolute;
|
||||||
|
text-align: initial;
|
||||||
|
box-sizing: border-box;
|
||||||
|
transform-origin: 0 0;
|
||||||
|
}
|
||||||
|
|
||||||
& .annotationTextContent {
|
& .annotationTextContent {
|
||||||
opacity: 0;
|
opacity: 0;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -13,6 +13,7 @@ import {
|
|||||||
ViewChild,
|
ViewChild,
|
||||||
} from '@angular/core'
|
} from '@angular/core'
|
||||||
import {
|
import {
|
||||||
|
AnnotationMode,
|
||||||
getDocument,
|
getDocument,
|
||||||
GlobalWorkerOptions,
|
GlobalWorkerOptions,
|
||||||
PDFDocumentLoadingTask,
|
PDFDocumentLoadingTask,
|
||||||
@@ -221,6 +222,7 @@ export class PngxPdfViewerComponent
|
|||||||
linkService: this.linkService,
|
linkService: this.linkService,
|
||||||
findController: this.findController,
|
findController: this.findController,
|
||||||
textLayerMode,
|
textLayerMode,
|
||||||
|
annotationMode: AnnotationMode.ENABLE,
|
||||||
enableSelectionRendering: false,
|
enableSelectionRendering: false,
|
||||||
removePageBorders: true,
|
removePageBorders: true,
|
||||||
}
|
}
|
||||||
|
|||||||
+1
-1
@@ -88,7 +88,7 @@
|
|||||||
@if (depth > 0) {
|
@if (depth > 0) {
|
||||||
<div class="indicator"></div>
|
<div class="indicator"></div>
|
||||||
}
|
}
|
||||||
<button class="btn btn-link ms-0 ps-0 text-start" style="user-select: text;" (click)="userCanEdit(object) ? openEditDialog(object) : null; $event.stopPropagation()">{{ object.name }}</button>
|
<button class="btn btn-link ms-0 ps-0 text-start" style="user-select: text;" [disabled]="!userCanEdit(object)" (click)="userCanEdit(object) ? openEditDialog(object) : null; $event.stopPropagation()">{{ object.name }}</button>
|
||||||
</td>
|
</td>
|
||||||
<td class="d-none d-sm-table-cell">{{ getMatching(object) }}</td>
|
<td class="d-none d-sm-table-cell">{{ getMatching(object) }}</td>
|
||||||
<td>{{ getDocumentCount(object) }}</td>
|
<td>{{ getDocumentCount(object) }}</td>
|
||||||
|
|||||||
@@ -19,6 +19,13 @@ export const GlobalWorkerOptions = {
|
|||||||
workerSrc: '',
|
workerSrc: '',
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export const AnnotationMode = {
|
||||||
|
DISABLE: 0,
|
||||||
|
ENABLE: 1,
|
||||||
|
ENABLE_FORMS: 2,
|
||||||
|
ENABLE_STORAGE: 3,
|
||||||
|
}
|
||||||
|
|
||||||
export const getDocument = (_src: unknown): PDFDocumentLoadingTask => {
|
export const getDocument = (_src: unknown): PDFDocumentLoadingTask => {
|
||||||
return new PDFDocumentLoadingTask(Promise.resolve(new PDFDocumentProxy()))
|
return new PDFDocumentLoadingTask(Promise.resolve(new PDFDocumentProxy()))
|
||||||
}
|
}
|
||||||
|
|||||||
+24
-49
@@ -39,7 +39,6 @@ from guardian.utils import get_user_obj_perms_model
|
|||||||
from rest_framework import serializers
|
from rest_framework import serializers
|
||||||
from rest_framework.filters import BaseFilterBackend
|
from rest_framework.filters import BaseFilterBackend
|
||||||
from rest_framework.filters import OrderingFilter
|
from rest_framework.filters import OrderingFilter
|
||||||
from rest_framework_guardian.filters import ObjectPermissionsFilter
|
|
||||||
|
|
||||||
from documents.models import Correspondent
|
from documents.models import Correspondent
|
||||||
from documents.models import CustomField
|
from documents.models import CustomField
|
||||||
@@ -51,7 +50,7 @@ from documents.models import ShareLink
|
|||||||
from documents.models import ShareLinkBundle
|
from documents.models import ShareLinkBundle
|
||||||
from documents.models import StoragePath
|
from documents.models import StoragePath
|
||||||
from documents.models import Tag
|
from documents.models import Tag
|
||||||
from documents.permissions import permitted_document_ids
|
from documents.permissions import permitted_object_ids
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
from collections.abc import Callable
|
from collections.abc import Callable
|
||||||
@@ -1028,59 +1027,35 @@ class PaperlessTaskFilterSet(FilterSet):
|
|||||||
return queryset.exclude(status__in=PaperlessTask.COMPLETE_STATUSES)
|
return queryset.exclude(status__in=PaperlessTask.COMPLETE_STATUSES)
|
||||||
|
|
||||||
|
|
||||||
class ObjectOwnedOrGrantedPermissionsFilter(ObjectPermissionsFilter):
|
class PermittedObjectsFilter(BaseFilterBackend):
|
||||||
"""
|
"""
|
||||||
A filter backend that limits results to those where the requesting user
|
Filters a queryset down to objects the requesting user owns, are
|
||||||
has read object level permissions, owns the objects, or objects without
|
unowned, or (when ``include_granted`` is True) has an explicit
|
||||||
an owner (for backwards compat)
|
user/group guardian permission on. Backed by ``permitted_object_ids``
|
||||||
|
-- a single ``id__in`` subquery, not a join -- so it can't produce
|
||||||
|
duplicate rows even when the base queryset already carries independent
|
||||||
|
joins (e.g. multi-value ``tags__id__all`` filtering), and stays
|
||||||
|
index-friendly at scale instead of falling back to guardian's
|
||||||
|
varchar-cast join.
|
||||||
|
|
||||||
|
Set ``include_granted = False`` on a subclass for endpoints that
|
||||||
|
intentionally only show owned/unowned objects regardless of explicit
|
||||||
|
shares (e.g. ``TrashView``).
|
||||||
"""
|
"""
|
||||||
|
|
||||||
|
include_granted: bool = True
|
||||||
|
perm_codename: str | None = None
|
||||||
|
|
||||||
def filter_queryset(self, request, queryset, view):
|
def filter_queryset(self, request, queryset, view):
|
||||||
if request.user.is_superuser:
|
if request.user.is_superuser:
|
||||||
return queryset
|
return queryset
|
||||||
objects_with_perms = super().filter_queryset(request, queryset, view)
|
if not self.include_granted:
|
||||||
objects_owned = queryset.filter(owner=request.user)
|
return queryset.filter(Q(owner=request.user) | Q(owner__isnull=True))
|
||||||
objects_unowned = queryset.filter(owner__isnull=True)
|
model = queryset.model
|
||||||
return objects_with_perms | objects_owned | objects_unowned
|
perm = self.perm_codename or f"view_{model._meta.model_name}"
|
||||||
|
return queryset.filter(
|
||||||
|
id__in=permitted_object_ids(request.user, model, perm),
|
||||||
class DocumentPermissionsFilter(BaseFilterBackend):
|
)
|
||||||
"""
|
|
||||||
A filter backend limiting Document results to those the requesting user
|
|
||||||
owns, are unowned, or has explicit (user- or group-level) view
|
|
||||||
permission on.
|
|
||||||
|
|
||||||
Unlike ``ObjectOwnedOrGrantedPermissionsFilter``, this does not build an
|
|
||||||
``objects_with_perms | objects_owned | objects_unowned`` union of
|
|
||||||
querysets derived from the same base queryset. When that base queryset
|
|
||||||
already carries independent joins on a multi-valued relation (e.g. two
|
|
||||||
separate joins from ``tags__id__all`` filtering on two tags), each
|
|
||||||
OR-ed branch can end up pairing those joins' aliases differently,
|
|
||||||
letting more than one row out of the join's cross product satisfy the
|
|
||||||
combined WHERE -- returning the same document more than once. Filtering
|
|
||||||
via a single ``id__in`` against ``permitted_document_ids`` (a plain
|
|
||||||
subquery, not a join) sidesteps that entirely and is also cheaper than
|
|
||||||
guardian's join-based permission check.
|
|
||||||
"""
|
|
||||||
|
|
||||||
def filter_queryset(self, request, queryset, view):
|
|
||||||
if request.user.is_superuser:
|
|
||||||
return queryset
|
|
||||||
return queryset.filter(id__in=permitted_document_ids(request.user))
|
|
||||||
|
|
||||||
|
|
||||||
class ObjectOwnedPermissionsFilter(ObjectPermissionsFilter):
|
|
||||||
"""
|
|
||||||
A filter backend that limits results to those where the requesting user
|
|
||||||
owns the objects or objects without an owner (for backwards compat)
|
|
||||||
"""
|
|
||||||
|
|
||||||
def filter_queryset(self, request, queryset, view):
|
|
||||||
if request.user.is_superuser:
|
|
||||||
return queryset
|
|
||||||
objects_owned = queryset.filter(owner=request.user)
|
|
||||||
objects_unowned = queryset.filter(owner__isnull=True)
|
|
||||||
return objects_owned | objects_unowned
|
|
||||||
|
|
||||||
|
|
||||||
class DocumentsOrderingFilter(OrderingFilter):
|
class DocumentsOrderingFilter(OrderingFilter):
|
||||||
|
|||||||
+10
-14
@@ -19,7 +19,7 @@ from documents.models import StoragePath
|
|||||||
from documents.models import Tag
|
from documents.models import Tag
|
||||||
from documents.models import Workflow
|
from documents.models import Workflow
|
||||||
from documents.models import WorkflowTrigger
|
from documents.models import WorkflowTrigger
|
||||||
from documents.permissions import get_objects_for_user_owner_aware
|
from documents.permissions import permitted_object_ids
|
||||||
from documents.regex import safe_regex_search
|
from documents.regex import safe_regex_search
|
||||||
|
|
||||||
if TYPE_CHECKING:
|
if TYPE_CHECKING:
|
||||||
@@ -55,10 +55,8 @@ def match_correspondents(document: Document, classifier: DocumentClassifier, use
|
|||||||
user = document.owner
|
user = document.owner
|
||||||
|
|
||||||
if user is not None:
|
if user is not None:
|
||||||
correspondents = get_objects_for_user_owner_aware(
|
correspondents = Correspondent.objects.filter(
|
||||||
user,
|
id__in=permitted_object_ids(user, Correspondent, "view_correspondent"),
|
||||||
"documents.view_correspondent",
|
|
||||||
Correspondent,
|
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
correspondents = Correspondent.objects.all()
|
correspondents = Correspondent.objects.all()
|
||||||
@@ -86,10 +84,8 @@ def match_document_types(document: Document, classifier: DocumentClassifier, use
|
|||||||
user = document.owner
|
user = document.owner
|
||||||
|
|
||||||
if user is not None:
|
if user is not None:
|
||||||
document_types = get_objects_for_user_owner_aware(
|
document_types = DocumentType.objects.filter(
|
||||||
user,
|
id__in=permitted_object_ids(user, DocumentType, "view_documenttype"),
|
||||||
"documents.view_documenttype",
|
|
||||||
DocumentType,
|
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
document_types = DocumentType.objects.all()
|
document_types = DocumentType.objects.all()
|
||||||
@@ -116,7 +112,9 @@ def match_tags(document: Document, classifier: DocumentClassifier, user=None):
|
|||||||
user = document.owner
|
user = document.owner
|
||||||
|
|
||||||
if user is not None:
|
if user is not None:
|
||||||
tags = get_objects_for_user_owner_aware(user, "documents.view_tag", Tag)
|
tags = Tag.objects.filter(
|
||||||
|
id__in=permitted_object_ids(user, Tag, "view_tag"),
|
||||||
|
)
|
||||||
else:
|
else:
|
||||||
tags = Tag.objects.all()
|
tags = Tag.objects.all()
|
||||||
|
|
||||||
@@ -145,10 +143,8 @@ def match_storage_paths(document: Document, classifier: DocumentClassifier, user
|
|||||||
user = document.owner
|
user = document.owner
|
||||||
|
|
||||||
if user is not None:
|
if user is not None:
|
||||||
storage_paths = get_objects_for_user_owner_aware(
|
storage_paths = StoragePath.objects.filter(
|
||||||
user,
|
id__in=permitted_object_ids(user, StoragePath, "view_storagepath"),
|
||||||
"documents.view_storagepath",
|
|
||||||
StoragePath,
|
|
||||||
)
|
)
|
||||||
else:
|
else:
|
||||||
storage_paths = StoragePath.objects.all()
|
storage_paths = StoragePath.objects.all()
|
||||||
|
|||||||
@@ -7,6 +7,7 @@ from django.contrib.contenttypes.models import ContentType
|
|||||||
from django.db.models import Case
|
from django.db.models import Case
|
||||||
from django.db.models import Count
|
from django.db.models import Count
|
||||||
from django.db.models import IntegerField
|
from django.db.models import IntegerField
|
||||||
|
from django.db.models import Model
|
||||||
from django.db.models import Q
|
from django.db.models import Q
|
||||||
from django.db.models import QuerySet
|
from django.db.models import QuerySet
|
||||||
from django.db.models import Value
|
from django.db.models import Value
|
||||||
@@ -163,30 +164,32 @@ def set_permissions_for_object(
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def permitted_document_ids(
|
def permitted_object_ids(
|
||||||
user,
|
user: User | None,
|
||||||
|
model: type[Model],
|
||||||
|
perm: str,
|
||||||
*,
|
*,
|
||||||
perm: str = "view_document",
|
|
||||||
include_deleted: bool = False,
|
include_deleted: bool = False,
|
||||||
):
|
) -> QuerySet[int]:
|
||||||
"""
|
"""
|
||||||
Return a queryset of document IDs the user has ``perm`` on (default
|
Generic version of ``permitted_document_ids`` for any model with an
|
||||||
``"view_document"``). By default limited to non-deleted documents; pass
|
``owner`` field and guardian object-level permissions. ``include_deleted``
|
||||||
``include_deleted=True`` for callers that need to check permission on
|
only has an effect for models exposing a ``global_objects``/``deleted_at``
|
||||||
soft-deleted documents (e.g. trash restore). This intentionally avoids
|
soft-delete pattern (currently only ``Document``); for every other model
|
||||||
``get_objects_for_user`` to keep the subquery small and index-friendly.
|
it is accepted but has no effect, since those models have no soft-delete
|
||||||
|
concept.
|
||||||
"""
|
"""
|
||||||
|
has_soft_delete = hasattr(model, "global_objects")
|
||||||
manager = Document.global_objects if include_deleted else Document.objects
|
manager = (
|
||||||
base_docs = manager.all()
|
model.global_objects if include_deleted and has_soft_delete else model.objects
|
||||||
base_docs = base_docs.only("id", "owner")
|
)
|
||||||
|
base_qs = manager.all().only("id", "owner")
|
||||||
|
|
||||||
if user is None or not getattr(user, "is_authenticated", False):
|
if user is None or not getattr(user, "is_authenticated", False):
|
||||||
# Just Anonymous user e.g. for drf-spectacular
|
return base_qs.filter(owner__isnull=True).values_list("id", flat=True)
|
||||||
return base_docs.filter(owner__isnull=True).values_list("id", flat=True)
|
|
||||||
|
|
||||||
if getattr(user, "is_superuser", False):
|
if getattr(user, "is_superuser", False):
|
||||||
return base_docs.values_list("id", flat=True)
|
return base_qs.values_list("id", flat=True)
|
||||||
|
|
||||||
# Guardian's UserObjectPermission/GroupObjectPermission always store a bare
|
# Guardian's UserObjectPermission/GroupObjectPermission always store a bare
|
||||||
# codename, but has_perm()-style callers commonly pass the qualified
|
# codename, but has_perm()-style callers commonly pass the qualified
|
||||||
@@ -194,31 +197,46 @@ def permitted_document_ids(
|
|||||||
# codename, so just drop any prefix rather than silently under-permitting.
|
# codename, so just drop any prefix rather than silently under-permitting.
|
||||||
perm = perm.rsplit(".", 1)[-1]
|
perm = perm.rsplit(".", 1)[-1]
|
||||||
|
|
||||||
document_ct = ContentType.objects.get_for_model(Document)
|
content_type = ContentType.objects.get_for_model(model)
|
||||||
perm_filter = {
|
perm_filter = {
|
||||||
"permission__codename": perm,
|
"permission__codename": perm,
|
||||||
"permission__content_type": document_ct,
|
"permission__content_type": content_type,
|
||||||
}
|
}
|
||||||
|
|
||||||
user_perm_docs = (
|
user_perm_ids = (
|
||||||
UserObjectPermission.objects.filter(user=user, **perm_filter)
|
UserObjectPermission.objects.filter(user=user, **perm_filter)
|
||||||
.annotate(object_pk_int=Cast("object_pk", IntegerField()))
|
.annotate(object_pk_int=Cast("object_pk", IntegerField()))
|
||||||
.values_list("object_pk_int", flat=True)
|
.values_list("object_pk_int", flat=True)
|
||||||
)
|
)
|
||||||
|
group_perm_ids = (
|
||||||
group_perm_docs = (
|
|
||||||
GroupObjectPermission.objects.filter(group__user=user, **perm_filter)
|
GroupObjectPermission.objects.filter(group__user=user, **perm_filter)
|
||||||
.annotate(object_pk_int=Cast("object_pk", IntegerField()))
|
.annotate(object_pk_int=Cast("object_pk", IntegerField()))
|
||||||
.values_list("object_pk_int", flat=True)
|
.values_list("object_pk_int", flat=True)
|
||||||
)
|
)
|
||||||
|
permitted_ids = user_perm_ids.union(group_perm_ids)
|
||||||
|
|
||||||
permitted_documents = user_perm_docs.union(group_perm_docs)
|
return base_qs.filter(
|
||||||
|
Q(owner=user) | Q(owner__isnull=True) | Q(id__in=permitted_ids),
|
||||||
return base_docs.filter(
|
|
||||||
Q(owner=user) | Q(owner__isnull=True) | Q(id__in=permitted_documents),
|
|
||||||
).values_list("id", flat=True)
|
).values_list("id", flat=True)
|
||||||
|
|
||||||
|
|
||||||
|
def permitted_document_ids(
|
||||||
|
user: User | None,
|
||||||
|
*,
|
||||||
|
perm: str = "view_document",
|
||||||
|
include_deleted: bool = False,
|
||||||
|
) -> QuerySet[int]:
|
||||||
|
"""
|
||||||
|
Document-specific convenience wrapper around ``permitted_object_ids``.
|
||||||
|
Return a queryset of document IDs the user has ``perm`` on (default
|
||||||
|
``"view_document"``). By default limited to non-deleted documents; pass
|
||||||
|
``include_deleted=True`` for callers that need to check permission on
|
||||||
|
soft-deleted documents (e.g. trash restore). This intentionally avoids
|
||||||
|
``get_objects_for_user`` to keep the subquery small and index-friendly.
|
||||||
|
"""
|
||||||
|
return permitted_object_ids(user, Document, perm, include_deleted=include_deleted)
|
||||||
|
|
||||||
|
|
||||||
def get_document_count_filter_for_user(user, related_name: str = "documents"):
|
def get_document_count_filter_for_user(user, related_name: str = "documents"):
|
||||||
"""
|
"""
|
||||||
Return the Q object used to filter document counts for the given user.
|
Return the Q object used to filter document counts for the given user.
|
||||||
@@ -341,6 +359,13 @@ def get_objects_for_user_owner_aware(
|
|||||||
"""
|
"""
|
||||||
Returns objects the user owns, are unowned, or has explicit perms.
|
Returns objects the user owns, are unowned, or has explicit perms.
|
||||||
When include_deleted is True, soft-deleted items are also included.
|
When include_deleted is True, soft-deleted items are also included.
|
||||||
|
|
||||||
|
Legacy slow path (guardian-backed, O(n) style permission resolution).
|
||||||
|
Most queryset-filtering call sites have migrated onto
|
||||||
|
``PermittedObjectsFilter``/``permitted_object_ids()``, but this function
|
||||||
|
is kept because production callers still remain. Several callers remain
|
||||||
|
across ``documents/``, ``paperless_mail/``, and ``paperless_ai/`` --
|
||||||
|
grep for this function name before removing it.
|
||||||
"""
|
"""
|
||||||
manager = (
|
manager = (
|
||||||
Model.global_objects
|
Model.global_objects
|
||||||
@@ -360,6 +385,15 @@ def get_objects_for_user_owner_aware(
|
|||||||
|
|
||||||
|
|
||||||
def has_perms_owner_aware(user, perms, obj):
|
def has_perms_owner_aware(user, perms, obj):
|
||||||
|
"""
|
||||||
|
Legacy slow path (guardian-backed) single-object permission check.
|
||||||
|
|
||||||
|
The queryset-filtering side of this migrated onto
|
||||||
|
``PermittedObjectsFilter``/``permitted_object_ids()``, but this
|
||||||
|
single-object check still has many production callers. Several callers
|
||||||
|
remain across ``documents/``, ``paperless_mail/``, and ``paperless_ai/``
|
||||||
|
-- grep for this function name before removing it.
|
||||||
|
"""
|
||||||
checker = ObjectPermissionChecker(user)
|
checker = ObjectPermissionChecker(user)
|
||||||
return obj.owner is None or obj.owner == user or checker.has_perm(perms, obj)
|
return obj.owner is None or obj.owner == user or checker.has_perm(perms, obj)
|
||||||
|
|
||||||
|
|||||||
@@ -12,9 +12,22 @@ from django.test import override_settings
|
|||||||
from guardian.shortcuts import assign_perm
|
from guardian.shortcuts import assign_perm
|
||||||
from rest_framework.test import APIClient
|
from rest_framework.test import APIClient
|
||||||
|
|
||||||
|
from documents.matching import match_correspondents
|
||||||
|
from documents.matching import match_document_types
|
||||||
|
from documents.matching import match_storage_paths
|
||||||
|
from documents.matching import match_tags
|
||||||
|
from documents.models import Correspondent
|
||||||
|
from documents.models import DocumentType
|
||||||
|
from documents.models import StoragePath
|
||||||
|
from documents.models import Tag
|
||||||
from documents.permissions import permitted_document_ids
|
from documents.permissions import permitted_document_ids
|
||||||
|
from documents.permissions import permitted_object_ids
|
||||||
from documents.serialisers import _get_viewable_duplicates
|
from documents.serialisers import _get_viewable_duplicates
|
||||||
|
from documents.tests.factories import CorrespondentFactory
|
||||||
from documents.tests.factories import DocumentFactory
|
from documents.tests.factories import DocumentFactory
|
||||||
|
from documents.tests.factories import DocumentTypeFactory
|
||||||
|
from documents.tests.factories import StoragePathFactory
|
||||||
|
from documents.tests.factories import TagFactory
|
||||||
|
|
||||||
|
|
||||||
def assert_visible_document_ids(actual_ids, *, expected_visible, expected_hidden):
|
def assert_visible_document_ids(actual_ids, *, expected_visible, expected_hidden):
|
||||||
@@ -431,3 +444,320 @@ class TestTrashRestorePermissionBoundary:
|
|||||||
format="json",
|
format="json",
|
||||||
)
|
)
|
||||||
assert response.status_code == HTTPStatus.OK
|
assert response.status_code == HTTPStatus.OK
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.django_db
|
||||||
|
class TestTrashViewExcludesExplicitlyGrantedDocuments:
|
||||||
|
"""
|
||||||
|
Regression test pinning TrashView's use of
|
||||||
|
``_TrashPermittedObjectsFilter`` (``include_granted = False``). If that
|
||||||
|
flag were ever flipped to the default ``True``, or the subclass removed
|
||||||
|
in favor of the base ``PermittedObjectsFilter``, a trashed document
|
||||||
|
would leak into ``/api/trash/`` results for any user holding an
|
||||||
|
explicit guardian grant on it, even though they are neither the owner
|
||||||
|
nor a superuser.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def test_explicit_grant_does_not_leak_trashed_document(self, rest_api_client):
|
||||||
|
owner = User.objects.create_user(username="trash_owner")
|
||||||
|
grantee = User.objects.create_user(username="trash_grantee")
|
||||||
|
doc = DocumentFactory(owner=owner)
|
||||||
|
doc.delete() # soft delete
|
||||||
|
assign_perm("view_document", grantee, doc)
|
||||||
|
|
||||||
|
rest_api_client.force_authenticate(user=grantee)
|
||||||
|
response = rest_api_client.get("/api/trash/")
|
||||||
|
|
||||||
|
assert response.status_code == HTTPStatus.OK
|
||||||
|
result_ids = {result["id"] for result in response.data["results"]}
|
||||||
|
assert doc.pk not in result_ids
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.django_db
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
("model", "factory", "perm"),
|
||||||
|
[
|
||||||
|
(Tag, TagFactory, "view_tag"),
|
||||||
|
(Correspondent, CorrespondentFactory, "view_correspondent"),
|
||||||
|
(DocumentType, DocumentTypeFactory, "view_documenttype"),
|
||||||
|
(StoragePath, StoragePathFactory, "view_storagepath"),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
class TestPermittedObjectIdsGenericModels:
|
||||||
|
def test_owner_sees_own_object(self, model, factory, perm):
|
||||||
|
owner = User.objects.create_user(username=f"owner_{model.__name__}")
|
||||||
|
stranger = User.objects.create_user(username=f"stranger_{model.__name__}")
|
||||||
|
owned = factory(owner=owner)
|
||||||
|
strangers = factory(owner=stranger)
|
||||||
|
|
||||||
|
assert_visible_document_ids(
|
||||||
|
permitted_object_ids(owner, model, perm),
|
||||||
|
expected_visible=[owned.pk],
|
||||||
|
expected_hidden=[strangers.pk],
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_unowned_object_visible_to_everyone(self, model, factory, perm):
|
||||||
|
user = User.objects.create_user(username=f"user_{model.__name__}")
|
||||||
|
unowned = factory(owner=None)
|
||||||
|
|
||||||
|
assert_visible_document_ids(
|
||||||
|
permitted_object_ids(user, model, perm),
|
||||||
|
expected_visible=[unowned.pk],
|
||||||
|
expected_hidden=[],
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_explicit_permission_grants_visibility(self, model, factory, perm):
|
||||||
|
owner = User.objects.create_user(username=f"owner2_{model.__name__}")
|
||||||
|
grantee = User.objects.create_user(username=f"grantee_{model.__name__}")
|
||||||
|
stranger = User.objects.create_user(username=f"stranger2_{model.__name__}")
|
||||||
|
shared = factory(owner=owner)
|
||||||
|
not_shared = factory(owner=owner)
|
||||||
|
assign_perm(perm, grantee, shared)
|
||||||
|
|
||||||
|
assert_visible_document_ids(
|
||||||
|
permitted_object_ids(grantee, model, perm),
|
||||||
|
expected_visible=[shared.pk],
|
||||||
|
expected_hidden=[not_shared.pk],
|
||||||
|
)
|
||||||
|
assert_visible_document_ids(
|
||||||
|
permitted_object_ids(stranger, model, perm),
|
||||||
|
expected_visible=[],
|
||||||
|
expected_hidden=[shared.pk, not_shared.pk],
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_group_permission_grants_visibility_to_members_only(
|
||||||
|
self,
|
||||||
|
model,
|
||||||
|
factory,
|
||||||
|
perm,
|
||||||
|
):
|
||||||
|
owner = User.objects.create_user(username=f"owner3_{model.__name__}")
|
||||||
|
member = User.objects.create_user(username=f"member_{model.__name__}")
|
||||||
|
non_member = User.objects.create_user(username=f"nonmember_{model.__name__}")
|
||||||
|
group = Group.objects.create(name=f"group_{model.__name__}")
|
||||||
|
member.groups.add(group)
|
||||||
|
shared = factory(owner=owner)
|
||||||
|
assign_perm(perm, group, shared)
|
||||||
|
|
||||||
|
assert_visible_document_ids(
|
||||||
|
permitted_object_ids(member, model, perm),
|
||||||
|
expected_visible=[shared.pk],
|
||||||
|
expected_hidden=[],
|
||||||
|
)
|
||||||
|
assert_visible_document_ids(
|
||||||
|
permitted_object_ids(non_member, model, perm),
|
||||||
|
expected_visible=[],
|
||||||
|
expected_hidden=[shared.pk],
|
||||||
|
)
|
||||||
|
|
||||||
|
def test_superuser_sees_everything(self, model, factory, perm):
|
||||||
|
superuser = User.objects.create_superuser(username=f"root_{model.__name__}")
|
||||||
|
owner = User.objects.create_user(username=f"owner4_{model.__name__}")
|
||||||
|
obj = factory(owner=owner)
|
||||||
|
|
||||||
|
assert_visible_document_ids(
|
||||||
|
permitted_object_ids(superuser, model, perm),
|
||||||
|
expected_visible=[obj.pk],
|
||||||
|
expected_hidden=[],
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.django_db
|
||||||
|
class TestMatchingRespectsObjectPermissions:
|
||||||
|
def test_match_tags_only_considers_tags_visible_to_user(self):
|
||||||
|
owner = User.objects.create_user(username="tag_owner")
|
||||||
|
classifying_user = User.objects.create_user(username="classifier_user")
|
||||||
|
visible_tag = TagFactory(
|
||||||
|
owner=owner,
|
||||||
|
match="invoice",
|
||||||
|
matching_algorithm=Tag.MATCH_LITERAL,
|
||||||
|
)
|
||||||
|
hidden_tag = TagFactory(
|
||||||
|
owner=owner,
|
||||||
|
match="invoice",
|
||||||
|
matching_algorithm=Tag.MATCH_LITERAL,
|
||||||
|
)
|
||||||
|
assign_perm("view_tag", classifying_user, visible_tag)
|
||||||
|
doc = DocumentFactory(owner=classifying_user, content="an invoice document")
|
||||||
|
|
||||||
|
matched = match_tags(doc, classifier=None, user=classifying_user)
|
||||||
|
matched_ids = {t.pk for t in matched}
|
||||||
|
assert visible_tag.pk in matched_ids
|
||||||
|
assert hidden_tag.pk not in matched_ids
|
||||||
|
|
||||||
|
def test_match_correspondents_only_considers_correspondents_visible_to_user(self):
|
||||||
|
owner = User.objects.create_user(username="correspondent_owner")
|
||||||
|
classifying_user = User.objects.create_user(username="classifier_user2")
|
||||||
|
visible_correspondent = CorrespondentFactory(
|
||||||
|
owner=owner,
|
||||||
|
match="invoice",
|
||||||
|
matching_algorithm=Correspondent.MATCH_LITERAL,
|
||||||
|
)
|
||||||
|
hidden_correspondent = CorrespondentFactory(
|
||||||
|
owner=owner,
|
||||||
|
match="invoice",
|
||||||
|
matching_algorithm=Correspondent.MATCH_LITERAL,
|
||||||
|
)
|
||||||
|
assign_perm("view_correspondent", classifying_user, visible_correspondent)
|
||||||
|
doc = DocumentFactory(owner=classifying_user, content="an invoice document")
|
||||||
|
|
||||||
|
matched = match_correspondents(doc, classifier=None, user=classifying_user)
|
||||||
|
matched_ids = {c.pk for c in matched}
|
||||||
|
assert visible_correspondent.pk in matched_ids
|
||||||
|
assert hidden_correspondent.pk not in matched_ids
|
||||||
|
|
||||||
|
def test_match_document_types_only_considers_document_types_visible_to_user(self):
|
||||||
|
owner = User.objects.create_user(username="document_type_owner")
|
||||||
|
classifying_user = User.objects.create_user(username="classifier_user3")
|
||||||
|
visible_document_type = DocumentTypeFactory(
|
||||||
|
owner=owner,
|
||||||
|
match="invoice",
|
||||||
|
matching_algorithm=DocumentType.MATCH_LITERAL,
|
||||||
|
)
|
||||||
|
hidden_document_type = DocumentTypeFactory(
|
||||||
|
owner=owner,
|
||||||
|
match="invoice",
|
||||||
|
matching_algorithm=DocumentType.MATCH_LITERAL,
|
||||||
|
)
|
||||||
|
assign_perm("view_documenttype", classifying_user, visible_document_type)
|
||||||
|
doc = DocumentFactory(owner=classifying_user, content="an invoice document")
|
||||||
|
|
||||||
|
matched = match_document_types(doc, classifier=None, user=classifying_user)
|
||||||
|
matched_ids = {dt.pk for dt in matched}
|
||||||
|
assert visible_document_type.pk in matched_ids
|
||||||
|
assert hidden_document_type.pk not in matched_ids
|
||||||
|
|
||||||
|
def test_match_storage_paths_only_considers_storage_paths_visible_to_user(self):
|
||||||
|
owner = User.objects.create_user(username="storage_path_owner")
|
||||||
|
classifying_user = User.objects.create_user(username="classifier_user4")
|
||||||
|
visible_storage_path = StoragePathFactory(
|
||||||
|
owner=owner,
|
||||||
|
match="invoice",
|
||||||
|
matching_algorithm=StoragePath.MATCH_LITERAL,
|
||||||
|
)
|
||||||
|
hidden_storage_path = StoragePathFactory(
|
||||||
|
owner=owner,
|
||||||
|
match="invoice",
|
||||||
|
matching_algorithm=StoragePath.MATCH_LITERAL,
|
||||||
|
)
|
||||||
|
assign_perm("view_storagepath", classifying_user, visible_storage_path)
|
||||||
|
doc = DocumentFactory(owner=classifying_user, content="an invoice document")
|
||||||
|
|
||||||
|
matched = match_storage_paths(doc, classifier=None, user=classifying_user)
|
||||||
|
matched_ids = {sp.pk for sp in matched}
|
||||||
|
assert visible_storage_path.pk in matched_ids
|
||||||
|
assert hidden_storage_path.pk not in matched_ids
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.django_db
|
||||||
|
class TestBulkEditObjectsApplyToAllPermissionBoundary:
|
||||||
|
def test_apply_to_all_tags_excludes_unpermitted_tag(self, rest_api_client):
|
||||||
|
owner = User.objects.create_user(username="tags_owner")
|
||||||
|
requester = User.objects.create_user(username="tags_requester")
|
||||||
|
# grant the global change_tag permission so the object-level
|
||||||
|
# filtering (not the global has_perm check) is what's under test
|
||||||
|
requester.user_permissions.add(
|
||||||
|
Permission.objects.get(codename="change_tag"),
|
||||||
|
)
|
||||||
|
rest_api_client.force_authenticate(user=requester)
|
||||||
|
visible = TagFactory(owner=owner)
|
||||||
|
hidden = TagFactory(owner=owner)
|
||||||
|
assign_perm("view_tag", requester, visible)
|
||||||
|
assign_perm("change_tag", requester, visible)
|
||||||
|
|
||||||
|
response = rest_api_client.post(
|
||||||
|
"/api/bulk_edit_objects/",
|
||||||
|
{
|
||||||
|
"object_type": "tags",
|
||||||
|
"operation": "set_permissions",
|
||||||
|
"all": True,
|
||||||
|
"filters": {},
|
||||||
|
"owner": requester.pk,
|
||||||
|
},
|
||||||
|
format="json",
|
||||||
|
)
|
||||||
|
assert response.status_code == HTTPStatus.OK
|
||||||
|
|
||||||
|
# The apply_to_all dispatch must resolve permitted objects up front:
|
||||||
|
# the visible tag (object-level change_tag granted) gets its owner
|
||||||
|
# reassigned, while the hidden tag (no object-level grant) is
|
||||||
|
# excluded entirely and keeps its original owner.
|
||||||
|
visible.refresh_from_db()
|
||||||
|
hidden.refresh_from_db()
|
||||||
|
assert visible.owner == requester
|
||||||
|
assert hidden.owner == owner
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.django_db
|
||||||
|
class TestBulkEditObjectsTagDescendantPartialPermission:
|
||||||
|
def test_apply_to_all_descendant_expansion_respects_per_object_permissions(
|
||||||
|
self,
|
||||||
|
rest_api_client,
|
||||||
|
):
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- A tag hierarchy (parent -> permitted_child, unpermitted_child)
|
||||||
|
- A non-superuser requester with object-level change_tag granted
|
||||||
|
on the parent and on only ONE of the two children
|
||||||
|
WHEN:
|
||||||
|
- bulk_edit_objects is called with all=True and a filter that
|
||||||
|
matches only the root (parent) tag, engaging the
|
||||||
|
tag-descendant-expansion logic in BulkEditObjectsView.post
|
||||||
|
THEN:
|
||||||
|
- The descendant expansion only pulls in descendants the
|
||||||
|
requester actually has permission on: the permitted child's
|
||||||
|
owner is reassigned alongside the parent's, while the
|
||||||
|
unpermitted child keeps its original owner. This pins that the
|
||||||
|
expansion checks per-object permissions (editable_ids), not
|
||||||
|
merely "is a descendant of a filter match".
|
||||||
|
|
||||||
|
NOTE: this uses ``set_permissions`` (owner reassignment) rather than
|
||||||
|
``delete`` as the operation, because Tag.tn_parent (django-treenode)
|
||||||
|
cascades deletes to descendants at the database/ORM level regardless
|
||||||
|
of which tags the view resolved into ``objs`` -- a delete-based test
|
||||||
|
would pass/fail based on FK cascade behavior, not on whether the
|
||||||
|
descendant-expansion logic itself respected per-object permissions.
|
||||||
|
"""
|
||||||
|
owner = User.objects.create_user(username="tag_hierarchy_owner")
|
||||||
|
requester = User.objects.create_user(username="tag_hierarchy_requester")
|
||||||
|
# global change_tag permission so the has_perm() gate passes and the
|
||||||
|
# object-level permitted_object_ids filtering is what's under test
|
||||||
|
requester.user_permissions.add(
|
||||||
|
Permission.objects.get(codename="change_tag"),
|
||||||
|
)
|
||||||
|
rest_api_client.force_authenticate(user=requester)
|
||||||
|
|
||||||
|
parent = TagFactory(owner=owner, name="parent-tag")
|
||||||
|
permitted_child = TagFactory(
|
||||||
|
owner=owner,
|
||||||
|
name="permitted-child-tag",
|
||||||
|
tn_parent=parent,
|
||||||
|
)
|
||||||
|
unpermitted_child = TagFactory(
|
||||||
|
owner=owner,
|
||||||
|
name="unpermitted-child-tag",
|
||||||
|
tn_parent=parent,
|
||||||
|
)
|
||||||
|
assign_perm("change_tag", requester, parent)
|
||||||
|
assign_perm("change_tag", requester, permitted_child)
|
||||||
|
# unpermitted_child is intentionally NOT granted change_tag
|
||||||
|
|
||||||
|
response = rest_api_client.post(
|
||||||
|
"/api/bulk_edit_objects/",
|
||||||
|
{
|
||||||
|
"object_type": "tags",
|
||||||
|
"operation": "set_permissions",
|
||||||
|
"all": True,
|
||||||
|
"filters": {"is_root": True},
|
||||||
|
"owner": requester.pk,
|
||||||
|
},
|
||||||
|
format="json",
|
||||||
|
)
|
||||||
|
assert response.status_code == HTTPStatus.OK
|
||||||
|
|
||||||
|
parent.refresh_from_db()
|
||||||
|
permitted_child.refresh_from_db()
|
||||||
|
unpermitted_child.refresh_from_db()
|
||||||
|
assert parent.owner == requester
|
||||||
|
assert permitted_child.owner == requester
|
||||||
|
assert unpermitted_child.owner == owner
|
||||||
|
|||||||
@@ -0,0 +1,70 @@
|
|||||||
|
import pytest
|
||||||
|
from django.contrib.auth.models import User
|
||||||
|
from guardian.shortcuts import assign_perm
|
||||||
|
from rest_framework.test import APIRequestFactory
|
||||||
|
|
||||||
|
from documents.filters import PermittedObjectsFilter
|
||||||
|
from documents.models import Tag
|
||||||
|
from documents.tests.factories import TagFactory
|
||||||
|
|
||||||
|
|
||||||
|
class _DummyView:
|
||||||
|
queryset = Tag.objects.all()
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.django_db
|
||||||
|
class TestPermittedObjectsFilter:
|
||||||
|
def test_superuser_bypasses_filtering_entirely(self):
|
||||||
|
superuser = User.objects.create_superuser(username="root")
|
||||||
|
owner = User.objects.create_user(username="owner")
|
||||||
|
TagFactory(owner=owner)
|
||||||
|
request = APIRequestFactory().get("/")
|
||||||
|
request.user = superuser
|
||||||
|
|
||||||
|
result = PermittedObjectsFilter().filter_queryset(
|
||||||
|
request,
|
||||||
|
Tag.objects.all(),
|
||||||
|
_DummyView(),
|
||||||
|
)
|
||||||
|
assert result.count() == Tag.objects.count()
|
||||||
|
|
||||||
|
def test_non_superuser_sees_only_owned_unowned_and_granted(self):
|
||||||
|
owner = User.objects.create_user(username="owner")
|
||||||
|
grantee = User.objects.create_user(username="grantee")
|
||||||
|
owned = TagFactory(owner=grantee)
|
||||||
|
unowned = TagFactory(owner=None)
|
||||||
|
granted = TagFactory(owner=owner)
|
||||||
|
hidden = TagFactory(owner=owner)
|
||||||
|
assign_perm("view_tag", grantee, granted)
|
||||||
|
request = APIRequestFactory().get("/")
|
||||||
|
request.user = grantee
|
||||||
|
|
||||||
|
result = PermittedObjectsFilter().filter_queryset(
|
||||||
|
request,
|
||||||
|
Tag.objects.all(),
|
||||||
|
_DummyView(),
|
||||||
|
)
|
||||||
|
visible_ids = set(result.values_list("id", flat=True))
|
||||||
|
assert visible_ids == {owned.pk, unowned.pk, granted.pk}
|
||||||
|
assert hidden.pk not in visible_ids
|
||||||
|
|
||||||
|
def test_include_granted_false_excludes_explicitly_shared_objects(self):
|
||||||
|
owner = User.objects.create_user(username="owner2")
|
||||||
|
grantee = User.objects.create_user(username="grantee2")
|
||||||
|
owned = TagFactory(owner=grantee)
|
||||||
|
granted = TagFactory(owner=owner)
|
||||||
|
assign_perm("view_tag", grantee, granted)
|
||||||
|
request = APIRequestFactory().get("/")
|
||||||
|
request.user = grantee
|
||||||
|
|
||||||
|
class _OwnerOnlyFilter(PermittedObjectsFilter):
|
||||||
|
include_granted = False
|
||||||
|
|
||||||
|
result = _OwnerOnlyFilter().filter_queryset(
|
||||||
|
request,
|
||||||
|
Tag.objects.all(),
|
||||||
|
_DummyView(),
|
||||||
|
)
|
||||||
|
visible_ids = set(result.values_list("id", flat=True))
|
||||||
|
assert visible_ids == {owned.pk}
|
||||||
|
assert granted.pk not in visible_ids
|
||||||
+22
-18
@@ -133,12 +133,10 @@ from documents.file_handling import format_filename
|
|||||||
from documents.filters import CorrespondentFilterSet
|
from documents.filters import CorrespondentFilterSet
|
||||||
from documents.filters import CustomFieldFilterSet
|
from documents.filters import CustomFieldFilterSet
|
||||||
from documents.filters import DocumentFilterSet
|
from documents.filters import DocumentFilterSet
|
||||||
from documents.filters import DocumentPermissionsFilter
|
|
||||||
from documents.filters import DocumentsOrderingFilter
|
from documents.filters import DocumentsOrderingFilter
|
||||||
from documents.filters import DocumentTypeFilterSet
|
from documents.filters import DocumentTypeFilterSet
|
||||||
from documents.filters import ObjectOwnedOrGrantedPermissionsFilter
|
|
||||||
from documents.filters import ObjectOwnedPermissionsFilter
|
|
||||||
from documents.filters import PaperlessTaskFilterSet
|
from documents.filters import PaperlessTaskFilterSet
|
||||||
|
from documents.filters import PermittedObjectsFilter
|
||||||
from documents.filters import ShareLinkBundleFilterSet
|
from documents.filters import ShareLinkBundleFilterSet
|
||||||
from documents.filters import ShareLinkFilterSet
|
from documents.filters import ShareLinkFilterSet
|
||||||
from documents.filters import StoragePathFilterSet
|
from documents.filters import StoragePathFilterSet
|
||||||
@@ -178,6 +176,7 @@ from documents.permissions import has_global_statistics_permission
|
|||||||
from documents.permissions import has_perms_owner_aware
|
from documents.permissions import has_perms_owner_aware
|
||||||
from documents.permissions import has_system_status_permission
|
from documents.permissions import has_system_status_permission
|
||||||
from documents.permissions import permitted_document_ids
|
from documents.permissions import permitted_document_ids
|
||||||
|
from documents.permissions import permitted_object_ids
|
||||||
from documents.permissions import set_permissions_for_object
|
from documents.permissions import set_permissions_for_object
|
||||||
from documents.plugins.date_parsing import get_date_parser
|
from documents.plugins.date_parsing import get_date_parser
|
||||||
from documents.schema import generate_object_with_permissions_schema
|
from documents.schema import generate_object_with_permissions_schema
|
||||||
@@ -550,7 +549,7 @@ class CorrespondentViewSet(
|
|||||||
filter_backends = (
|
filter_backends = (
|
||||||
DjangoFilterBackend,
|
DjangoFilterBackend,
|
||||||
OrderingFilter,
|
OrderingFilter,
|
||||||
ObjectOwnedOrGrantedPermissionsFilter,
|
PermittedObjectsFilter,
|
||||||
)
|
)
|
||||||
filterset_class = CorrespondentFilterSet
|
filterset_class = CorrespondentFilterSet
|
||||||
ordering_fields = (
|
ordering_fields = (
|
||||||
@@ -591,7 +590,7 @@ class TagViewSet(PermissionsAwareDocumentCountMixin, ModelViewSet[Tag]):
|
|||||||
filter_backends = (
|
filter_backends = (
|
||||||
DjangoFilterBackend,
|
DjangoFilterBackend,
|
||||||
OrderingFilter,
|
OrderingFilter,
|
||||||
ObjectOwnedOrGrantedPermissionsFilter,
|
PermittedObjectsFilter,
|
||||||
)
|
)
|
||||||
filterset_class = TagFilterSet
|
filterset_class = TagFilterSet
|
||||||
ordering_fields = ("color", "name", "matching_algorithm", "match", "document_count")
|
ordering_fields = ("color", "name", "matching_algorithm", "match", "document_count")
|
||||||
@@ -683,7 +682,7 @@ class DocumentTypeViewSet(
|
|||||||
filter_backends = (
|
filter_backends = (
|
||||||
DjangoFilterBackend,
|
DjangoFilterBackend,
|
||||||
OrderingFilter,
|
OrderingFilter,
|
||||||
ObjectOwnedOrGrantedPermissionsFilter,
|
PermittedObjectsFilter,
|
||||||
)
|
)
|
||||||
filterset_class = DocumentTypeFilterSet
|
filterset_class = DocumentTypeFilterSet
|
||||||
ordering_fields = ("name", "matching_algorithm", "match", "document_count")
|
ordering_fields = ("name", "matching_algorithm", "match", "document_count")
|
||||||
@@ -987,7 +986,7 @@ class DocumentViewSet(
|
|||||||
DjangoFilterBackend,
|
DjangoFilterBackend,
|
||||||
SearchFilter,
|
SearchFilter,
|
||||||
DocumentsOrderingFilter,
|
DocumentsOrderingFilter,
|
||||||
DocumentPermissionsFilter,
|
PermittedObjectsFilter,
|
||||||
)
|
)
|
||||||
filterset_class = DocumentFilterSet
|
filterset_class = DocumentFilterSet
|
||||||
search_fields = ("title", "correspondent__name", "effective_content")
|
search_fields = ("title", "correspondent__name", "effective_content")
|
||||||
@@ -2673,7 +2672,7 @@ class SavedViewViewSet(BulkPermissionMixin, PassUserMixin, ModelViewSet[SavedVie
|
|||||||
permission_classes = (IsAuthenticated, PaperlessObjectPermissions)
|
permission_classes = (IsAuthenticated, PaperlessObjectPermissions)
|
||||||
filter_backends = (
|
filter_backends = (
|
||||||
OrderingFilter,
|
OrderingFilter,
|
||||||
ObjectOwnedOrGrantedPermissionsFilter,
|
PermittedObjectsFilter,
|
||||||
)
|
)
|
||||||
ordering_fields = ("name",)
|
ordering_fields = ("name",)
|
||||||
|
|
||||||
@@ -3920,7 +3919,7 @@ class StoragePathViewSet(PermissionsAwareDocumentCountMixin, ModelViewSet[Storag
|
|||||||
filter_backends = (
|
filter_backends = (
|
||||||
DjangoFilterBackend,
|
DjangoFilterBackend,
|
||||||
OrderingFilter,
|
OrderingFilter,
|
||||||
ObjectOwnedOrGrantedPermissionsFilter,
|
PermittedObjectsFilter,
|
||||||
)
|
)
|
||||||
filterset_class = StoragePathFilterSet
|
filterset_class = StoragePathFilterSet
|
||||||
ordering_fields = ("name", "path", "matching_algorithm", "match", "document_count")
|
ordering_fields = ("name", "path", "matching_algorithm", "match", "document_count")
|
||||||
@@ -4451,7 +4450,7 @@ class ShareLinkViewSet(
|
|||||||
filter_backends = (
|
filter_backends = (
|
||||||
DjangoFilterBackend,
|
DjangoFilterBackend,
|
||||||
OrderingFilter,
|
OrderingFilter,
|
||||||
ObjectOwnedOrGrantedPermissionsFilter,
|
PermittedObjectsFilter,
|
||||||
)
|
)
|
||||||
filterset_class = ShareLinkFilterSet
|
filterset_class = ShareLinkFilterSet
|
||||||
ordering_fields = ("created", "expiration", "document")
|
ordering_fields = ("created", "expiration", "document")
|
||||||
@@ -4481,7 +4480,7 @@ class ShareLinkBundleViewSet(PassUserMixin, ModelViewSet[ShareLinkBundle]):
|
|||||||
filter_backends = (
|
filter_backends = (
|
||||||
DjangoFilterBackend,
|
DjangoFilterBackend,
|
||||||
OrderingFilter,
|
OrderingFilter,
|
||||||
ObjectOwnedOrGrantedPermissionsFilter,
|
PermittedObjectsFilter,
|
||||||
)
|
)
|
||||||
filterset_class = ShareLinkBundleFilterSet
|
filterset_class = ShareLinkBundleFilterSet
|
||||||
ordering_fields = ("created", "expiration", "status")
|
ordering_fields = ("created", "expiration", "status")
|
||||||
@@ -4764,10 +4763,8 @@ class BulkEditObjectsView(PassUserMixin):
|
|||||||
"document_types": DocumentTypeFilterSet,
|
"document_types": DocumentTypeFilterSet,
|
||||||
"storage_paths": StoragePathFilterSet,
|
"storage_paths": StoragePathFilterSet,
|
||||||
}[object_type]
|
}[object_type]
|
||||||
user_permitted_objects = get_objects_for_user_owner_aware(
|
user_permitted_objects = object_class.objects.filter(
|
||||||
user,
|
id__in=permitted_object_ids(user, object_class, perm_codename),
|
||||||
perm_codename,
|
|
||||||
object_class,
|
|
||||||
)
|
)
|
||||||
objs = filterset_class(
|
objs = filterset_class(
|
||||||
data=filters,
|
data=filters,
|
||||||
@@ -4792,8 +4789,11 @@ class BulkEditObjectsView(PassUserMixin):
|
|||||||
|
|
||||||
if not user.is_superuser:
|
if not user.is_superuser:
|
||||||
perm = f"documents.{perm_codename}"
|
perm = f"documents.{perm_codename}"
|
||||||
has_perms = user.has_perm(perm) and all(
|
has_perms = (
|
||||||
has_perms_owner_aware(user, perm_codename, obj) for obj in objs
|
user.has_perm(perm)
|
||||||
|
and not objs.exclude(
|
||||||
|
pk__in=permitted_object_ids(user, object_class, perm_codename),
|
||||||
|
).exists()
|
||||||
)
|
)
|
||||||
|
|
||||||
if not has_perms:
|
if not has_perms:
|
||||||
@@ -5294,7 +5294,11 @@ class SystemStatusView(PassUserMixin):
|
|||||||
class TrashView(ListModelMixin, PassUserMixin):
|
class TrashView(ListModelMixin, PassUserMixin):
|
||||||
permission_classes = (IsAuthenticated,)
|
permission_classes = (IsAuthenticated,)
|
||||||
serializer_class = TrashSerializer
|
serializer_class = TrashSerializer
|
||||||
filter_backends = (ObjectOwnedPermissionsFilter,)
|
|
||||||
|
class _TrashPermittedObjectsFilter(PermittedObjectsFilter):
|
||||||
|
include_granted = False
|
||||||
|
|
||||||
|
filter_backends = (_TrashPermittedObjectsFilter,)
|
||||||
pagination_class = StandardPagination
|
pagination_class = StandardPagination
|
||||||
|
|
||||||
model = Document
|
model = Document
|
||||||
|
|||||||
@@ -2,7 +2,7 @@ msgid ""
|
|||||||
msgstr ""
|
msgstr ""
|
||||||
"Project-Id-Version: paperless-ngx\n"
|
"Project-Id-Version: paperless-ngx\n"
|
||||||
"Report-Msgid-Bugs-To: \n"
|
"Report-Msgid-Bugs-To: \n"
|
||||||
"POT-Creation-Date: 2026-08-07 20:00+0000\n"
|
"POT-Creation-Date: 2026-08-08 14:28+0000\n"
|
||||||
"PO-Revision-Date: 2022-02-17 04:17\n"
|
"PO-Revision-Date: 2022-02-17 04:17\n"
|
||||||
"Last-Translator: \n"
|
"Last-Translator: \n"
|
||||||
"Language-Team: English\n"
|
"Language-Team: English\n"
|
||||||
@@ -21,39 +21,39 @@ msgstr ""
|
|||||||
msgid "Documents"
|
msgid "Documents"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: documents/filters.py:472
|
#: documents/filters.py:471
|
||||||
msgid "Value must be valid JSON."
|
msgid "Value must be valid JSON."
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: documents/filters.py:491
|
#: documents/filters.py:490
|
||||||
msgid "Invalid custom field query expression"
|
msgid "Invalid custom field query expression"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: documents/filters.py:501
|
#: documents/filters.py:500
|
||||||
msgid "Invalid expression list. Must be nonempty."
|
msgid "Invalid expression list. Must be nonempty."
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: documents/filters.py:522
|
#: documents/filters.py:521
|
||||||
msgid "Invalid logical operator {op!r}"
|
msgid "Invalid logical operator {op!r}"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: documents/filters.py:536
|
#: documents/filters.py:535
|
||||||
msgid "Maximum number of query conditions exceeded."
|
msgid "Maximum number of query conditions exceeded."
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: documents/filters.py:600
|
#: documents/filters.py:599
|
||||||
msgid "{name!r} is not a valid custom field."
|
msgid "{name!r} is not a valid custom field."
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: documents/filters.py:637
|
#: documents/filters.py:636
|
||||||
msgid "{data_type} does not support query expr {expr!r}."
|
msgid "{data_type} does not support query expr {expr!r}."
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: documents/filters.py:756 documents/models.py:136
|
#: documents/filters.py:755 documents/models.py:136
|
||||||
msgid "Maximum nesting depth exceeded."
|
msgid "Maximum nesting depth exceeded."
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: documents/filters.py:1098
|
#: documents/filters.py:1073
|
||||||
msgid "Custom field not found"
|
msgid "Custom field not found"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
@@ -1352,7 +1352,7 @@ msgid "workflow runs"
|
|||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: documents/serialisers.py:521 documents/serialisers.py:873
|
#: documents/serialisers.py:521 documents/serialisers.py:873
|
||||||
#: documents/serialisers.py:2767 documents/views.py:300 documents/views.py:2556
|
#: documents/serialisers.py:2767 documents/views.py:299 documents/views.py:2555
|
||||||
#: paperless_mail/serialisers.py:155
|
#: paperless_mail/serialisers.py:155
|
||||||
msgid "Insufficient permissions."
|
msgid "Insufficient permissions."
|
||||||
msgstr ""
|
msgstr ""
|
||||||
@@ -1393,7 +1393,7 @@ msgstr ""
|
|||||||
msgid "Duplicate document identifiers are not allowed."
|
msgid "Duplicate document identifiers are not allowed."
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: documents/serialisers.py:2853 documents/views.py:4510
|
#: documents/serialisers.py:2853 documents/views.py:4509
|
||||||
#, python-format
|
#, python-format
|
||||||
msgid "Documents not found: %(ids)s"
|
msgid "Documents not found: %(ids)s"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
@@ -1661,36 +1661,36 @@ msgstr ""
|
|||||||
msgid "Unable to parse URI {value}"
|
msgid "Unable to parse URI {value}"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: documents/views.py:293 documents/views.py:2553
|
#: documents/views.py:292 documents/views.py:2552
|
||||||
msgid "Invalid more_like_id"
|
msgid "Invalid more_like_id"
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: documents/views.py:1567
|
#: documents/views.py:1566
|
||||||
msgid "Invalid AI configuration."
|
msgid "Invalid AI configuration."
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: documents/views.py:1576
|
#: documents/views.py:1575
|
||||||
msgid "AI backend request timed out."
|
msgid "AI backend request timed out."
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: documents/views.py:2378 documents/views.py:2699
|
#: documents/views.py:2377 documents/views.py:2698
|
||||||
msgid "Specify only one of text, title_search, query, or more_like_id."
|
msgid "Specify only one of text, title_search, query, or more_like_id."
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: documents/views.py:4523
|
#: documents/views.py:4522
|
||||||
#, python-format
|
#, python-format
|
||||||
msgid "Insufficient permissions to share document %(id)s."
|
msgid "Insufficient permissions to share document %(id)s."
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: documents/views.py:4569
|
#: documents/views.py:4568
|
||||||
msgid "Bundle is already being processed."
|
msgid "Bundle is already being processed."
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: documents/views.py:4630
|
#: documents/views.py:4629
|
||||||
msgid "The share link bundle is still being prepared. Please try again later."
|
msgid "The share link bundle is still being prepared. Please try again later."
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
#: documents/views.py:4640
|
#: documents/views.py:4639
|
||||||
msgid "The share link bundle is unavailable."
|
msgid "The share link bundle is unavailable."
|
||||||
msgstr ""
|
msgstr ""
|
||||||
|
|
||||||
|
|||||||
@@ -217,6 +217,7 @@ class ApplicationConfigurationSerializer(
|
|||||||
llm_api_key = ObfuscatedPasswordField(
|
llm_api_key = ObfuscatedPasswordField(
|
||||||
required=False,
|
required=False,
|
||||||
allow_null=True,
|
allow_null=True,
|
||||||
|
max_length=1024,
|
||||||
)
|
)
|
||||||
|
|
||||||
def run_validation(self, data):
|
def run_validation(self, data):
|
||||||
|
|||||||
@@ -23,7 +23,7 @@ from rest_framework.response import Response
|
|||||||
from rest_framework.viewsets import ModelViewSet
|
from rest_framework.viewsets import ModelViewSet
|
||||||
from rest_framework.viewsets import ReadOnlyModelViewSet
|
from rest_framework.viewsets import ReadOnlyModelViewSet
|
||||||
|
|
||||||
from documents.filters import ObjectOwnedOrGrantedPermissionsFilter
|
from documents.filters import PermittedObjectsFilter
|
||||||
from documents.models import PaperlessTask
|
from documents.models import PaperlessTask
|
||||||
from documents.permissions import PaperlessObjectPermissions
|
from documents.permissions import PaperlessObjectPermissions
|
||||||
from documents.permissions import has_perms_owner_aware
|
from documents.permissions import has_perms_owner_aware
|
||||||
@@ -75,7 +75,7 @@ class MailAccountViewSet(PassUserMixin, ModelViewSet[MailAccount]):
|
|||||||
serializer_class = MailAccountSerializer
|
serializer_class = MailAccountSerializer
|
||||||
pagination_class = StandardPagination
|
pagination_class = StandardPagination
|
||||||
permission_classes = (IsAuthenticated, PaperlessObjectPermissions)
|
permission_classes = (IsAuthenticated, PaperlessObjectPermissions)
|
||||||
filter_backends = (ObjectOwnedOrGrantedPermissionsFilter,)
|
filter_backends = (PermittedObjectsFilter,)
|
||||||
|
|
||||||
def get_permissions(self):
|
def get_permissions(self):
|
||||||
if self.action == "test":
|
if self.action == "test":
|
||||||
@@ -197,7 +197,7 @@ class ProcessedMailViewSet(PassUserMixin, ReadOnlyModelViewSet[ProcessedMail]):
|
|||||||
filter_backends = (
|
filter_backends = (
|
||||||
DjangoFilterBackend,
|
DjangoFilterBackend,
|
||||||
OrderingFilter,
|
OrderingFilter,
|
||||||
ObjectOwnedOrGrantedPermissionsFilter,
|
PermittedObjectsFilter,
|
||||||
)
|
)
|
||||||
filterset_class = ProcessedMailFilterSet
|
filterset_class = ProcessedMailFilterSet
|
||||||
|
|
||||||
@@ -225,7 +225,7 @@ class MailRuleViewSet(PassUserMixin, ModelViewSet[MailRule]):
|
|||||||
serializer_class = MailRuleSerializer
|
serializer_class = MailRuleSerializer
|
||||||
pagination_class = StandardPagination
|
pagination_class = StandardPagination
|
||||||
permission_classes = (IsAuthenticated, PaperlessObjectPermissions)
|
permission_classes = (IsAuthenticated, PaperlessObjectPermissions)
|
||||||
filter_backends = (ObjectOwnedOrGrantedPermissionsFilter,)
|
filter_backends = (PermittedObjectsFilter,)
|
||||||
|
|
||||||
|
|
||||||
@extend_schema_view(
|
@extend_schema_view(
|
||||||
|
|||||||
Reference in New Issue
Block a user