mirror of
https://github.com/paperless-ngx/paperless-ngx.git
synced 2026-10-15 12:37:13 +00:00
Compare commits
6
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c6d7c9c0c8 | ||
|
|
24ff8df992 | ||
|
|
cf3077def0 | ||
|
|
09a48138e4 | ||
|
|
c45c7c7a99 | ||
|
|
e3b4cf55f0 |
No files matched your search
+1
-1
@@ -43,7 +43,7 @@ dependencies = [
|
|||||||
"drf-spectacular~=0.30",
|
"drf-spectacular~=0.30",
|
||||||
"drf-spectacular-sidecar>=2026.7.1,<2026.10",
|
"drf-spectacular-sidecar>=2026.7.1,<2026.10",
|
||||||
"drf-writable-nested~=0.7.1",
|
"drf-writable-nested~=0.7.1",
|
||||||
"filelock>=3.32,<4.1",
|
"filelock~=3.32.0",
|
||||||
"flower>=2.0.1,<2.3",
|
"flower>=2.0.1,<2.3",
|
||||||
"gotenberg-client[httpx]~=1.0",
|
"gotenberg-client[httpx]~=1.0",
|
||||||
"httpx-oauth~=0.17",
|
"httpx-oauth~=0.17",
|
||||||
|
|||||||
@@ -34,6 +34,7 @@ from documents.models import DocumentType
|
|||||||
from documents.models import PaperlessTask
|
from documents.models import PaperlessTask
|
||||||
from documents.models import StoragePath
|
from documents.models import StoragePath
|
||||||
from documents.models import Tag
|
from documents.models import Tag
|
||||||
|
from documents.permissions import PermissionsSpec
|
||||||
from documents.permissions import set_permissions_for_objects
|
from documents.permissions import set_permissions_for_objects
|
||||||
from documents.plugins.helpers import DocumentsStatusManager
|
from documents.plugins.helpers import DocumentsStatusManager
|
||||||
from documents.tasks import bulk_update_documents
|
from documents.tasks import bulk_update_documents
|
||||||
@@ -445,7 +446,7 @@ def reprocess(doc_ids: list[int], *, remote_ocr: bool = False) -> Literal["OK"]:
|
|||||||
|
|
||||||
def set_permissions(
|
def set_permissions(
|
||||||
doc_ids: list[int],
|
doc_ids: list[int],
|
||||||
set_permissions: dict,
|
set_permissions: PermissionsSpec,
|
||||||
*,
|
*,
|
||||||
owner: User | None = None,
|
owner: User | None = None,
|
||||||
merge: bool = False,
|
merge: bool = False,
|
||||||
|
|||||||
@@ -38,7 +38,8 @@ from documents.models import StoragePath
|
|||||||
from documents.models import Tag
|
from documents.models import Tag
|
||||||
from documents.models import WorkflowTrigger
|
from documents.models import WorkflowTrigger
|
||||||
from documents.parsers import ParseError
|
from documents.parsers import ParseError
|
||||||
from documents.permissions import set_permissions_for_object
|
from documents.permissions import PermissionsSpec
|
||||||
|
from documents.permissions import set_permissions_for_objects
|
||||||
from documents.plugins.base import AlwaysRunPluginMixin
|
from documents.plugins.base import AlwaysRunPluginMixin
|
||||||
from documents.plugins.base import ConsumeTaskPlugin
|
from documents.plugins.base import ConsumeTaskPlugin
|
||||||
from documents.plugins.base import NoCleanupPluginMixin
|
from documents.plugins.base import NoCleanupPluginMixin
|
||||||
@@ -948,7 +949,7 @@ class ConsumerPlugin(
|
|||||||
or self.metadata.change_users is not None
|
or self.metadata.change_users is not None
|
||||||
or self.metadata.change_groups is not None
|
or self.metadata.change_groups is not None
|
||||||
):
|
):
|
||||||
permissions = {
|
permissions: PermissionsSpec = {
|
||||||
"view": {
|
"view": {
|
||||||
"users": self.metadata.view_users or [],
|
"users": self.metadata.view_users or [],
|
||||||
"groups": self.metadata.view_groups or [],
|
"groups": self.metadata.view_groups or [],
|
||||||
@@ -958,7 +959,7 @@ class ConsumerPlugin(
|
|||||||
"groups": self.metadata.change_groups or [],
|
"groups": self.metadata.change_groups or [],
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
set_permissions_for_object(permissions=permissions, object=document)
|
set_permissions_for_objects(permissions, Document, [document.pk])
|
||||||
|
|
||||||
if self.metadata.custom_fields:
|
if self.metadata.custom_fields:
|
||||||
for field in CustomField.objects.filter(
|
for field in CustomField.objects.filter(
|
||||||
|
|||||||
@@ -5,8 +5,6 @@ from pathlib import Path
|
|||||||
from typing import TypedDict
|
from typing import TypedDict
|
||||||
|
|
||||||
import magic
|
import magic
|
||||||
from guardian.shortcuts import get_groups_with_perms
|
|
||||||
from guardian.shortcuts import get_users_with_perms
|
|
||||||
|
|
||||||
|
|
||||||
class StoredBarcode(TypedDict):
|
class StoredBarcode(TypedDict):
|
||||||
@@ -117,6 +115,9 @@ class DocumentMetadataOverrides:
|
|||||||
"""
|
"""
|
||||||
Fills in the overrides from a document object
|
Fills in the overrides from a document object
|
||||||
"""
|
"""
|
||||||
|
# documents.models imports this module, so this can't be a top-level import
|
||||||
|
from documents.permissions import get_permission_grantees
|
||||||
|
|
||||||
overrides = DocumentMetadataOverrides()
|
overrides = DocumentMetadataOverrides()
|
||||||
overrides.title = doc.title
|
overrides.title = doc.title
|
||||||
overrides.correspondent_id = doc.correspondent.id if doc.correspondent else None
|
overrides.correspondent_id = doc.correspondent.id if doc.correspondent else None
|
||||||
@@ -126,38 +127,16 @@ class DocumentMetadataOverrides:
|
|||||||
overrides.tag_ids = list(doc.tags.values_list("id", flat=True))
|
overrides.tag_ids = list(doc.tags.values_list("id", flat=True))
|
||||||
overrides.created = doc.created
|
overrides.created = doc.created
|
||||||
|
|
||||||
overrides.view_users = list(
|
grantees = get_permission_grantees(type(doc), [doc.pk])[doc.pk]
|
||||||
get_users_with_perms(
|
overrides.view_users = grantees["view"]["users"]
|
||||||
doc,
|
overrides.view_groups = grantees["view"]["groups"]
|
||||||
only_with_perms_in=["view_document"],
|
overrides.change_users = grantees["change"]["users"]
|
||||||
).values_list("id", flat=True),
|
overrides.change_groups = grantees["change"]["groups"]
|
||||||
)
|
|
||||||
overrides.change_users = list(
|
|
||||||
get_users_with_perms(
|
|
||||||
doc,
|
|
||||||
only_with_perms_in=["change_document"],
|
|
||||||
).values_list("id", flat=True),
|
|
||||||
)
|
|
||||||
overrides.custom_fields = {
|
overrides.custom_fields = {
|
||||||
custom_field.field.id: custom_field.value
|
custom_field.field.id: custom_field.value
|
||||||
for custom_field in doc.custom_fields.all()
|
for custom_field in doc.custom_fields.all()
|
||||||
}
|
}
|
||||||
|
|
||||||
groups_with_perms = get_groups_with_perms(
|
|
||||||
doc,
|
|
||||||
attach_perms=True,
|
|
||||||
)
|
|
||||||
overrides.view_groups = [
|
|
||||||
group.id
|
|
||||||
for group in groups_with_perms
|
|
||||||
if "view_document" in groups_with_perms[group]
|
|
||||||
]
|
|
||||||
overrides.change_groups = [
|
|
||||||
group.id
|
|
||||||
for group in groups_with_perms
|
|
||||||
if "change_document" in groups_with_perms[group]
|
|
||||||
]
|
|
||||||
|
|
||||||
return overrides
|
return overrides
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
+97
-134
@@ -1,4 +1,10 @@
|
|||||||
|
from collections.abc import Iterable
|
||||||
|
from collections.abc import Mapping
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
from typing import Final
|
||||||
|
from typing import Literal
|
||||||
|
from typing import TypeAlias
|
||||||
|
from typing import TypedDict
|
||||||
from typing import TypeVar
|
from typing import TypeVar
|
||||||
|
|
||||||
from django.contrib.auth.models import Group
|
from django.contrib.auth.models import Group
|
||||||
@@ -20,16 +26,39 @@ from django.db.models.functions import Coalesce
|
|||||||
from guardian.core import ObjectPermissionChecker
|
from guardian.core import ObjectPermissionChecker
|
||||||
from guardian.models import GroupObjectPermission
|
from guardian.models import GroupObjectPermission
|
||||||
from guardian.models import UserObjectPermission
|
from guardian.models import UserObjectPermission
|
||||||
from guardian.shortcuts import assign_perm
|
|
||||||
from guardian.shortcuts import get_objects_for_user
|
from guardian.shortcuts import get_objects_for_user
|
||||||
from guardian.shortcuts import get_users_with_perms
|
|
||||||
from guardian.shortcuts import remove_perm
|
|
||||||
from rest_framework.permissions import BasePermission
|
from rest_framework.permissions import BasePermission
|
||||||
from rest_framework.permissions import DjangoObjectPermissions
|
from rest_framework.permissions import DjangoObjectPermissions
|
||||||
|
|
||||||
from documents.models import Document
|
from documents.models import Document
|
||||||
from documents.versioning import get_root_document
|
from documents.versioning import get_root_document
|
||||||
|
|
||||||
|
PermissionAction = Literal["view", "change"]
|
||||||
|
PERMISSION_ACTIONS: Final[tuple[PermissionAction, ...]] = ("view", "change")
|
||||||
|
|
||||||
|
|
||||||
|
class PermissionGrantees(TypedDict):
|
||||||
|
"""
|
||||||
|
The user and group ids holding one permission action directly on an
|
||||||
|
object. Users who only hold it through a group are not listed.
|
||||||
|
"""
|
||||||
|
|
||||||
|
users: list[int]
|
||||||
|
groups: list[int]
|
||||||
|
|
||||||
|
|
||||||
|
class PermissionGranteesUpdate(TypedDict, total=False):
|
||||||
|
"""
|
||||||
|
The user and group ids to grant one permission action to. A missing key
|
||||||
|
leaves that kind of grant untouched.
|
||||||
|
"""
|
||||||
|
|
||||||
|
users: Iterable[int]
|
||||||
|
groups: Iterable[int]
|
||||||
|
|
||||||
|
|
||||||
|
PermissionsSpec: TypeAlias = Mapping[PermissionAction, PermissionGranteesUpdate]
|
||||||
|
|
||||||
|
|
||||||
class PaperlessObjectPermissions(DjangoObjectPermissions):
|
class PaperlessObjectPermissions(DjangoObjectPermissions):
|
||||||
"""
|
"""
|
||||||
@@ -90,101 +119,10 @@ def has_system_status_permission(user: User | None) -> bool:
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def get_groups_with_only_permission(obj, codename):
|
|
||||||
ctype = ContentType.objects.get_for_model(obj)
|
|
||||||
permission = Permission.objects.get(content_type=ctype, codename=codename)
|
|
||||||
group_object_perm_group_ids = (
|
|
||||||
GroupObjectPermission.objects.filter(
|
|
||||||
object_pk=obj.pk,
|
|
||||||
content_type=ctype,
|
|
||||||
)
|
|
||||||
.filter(permission=permission)
|
|
||||||
.values_list("group_id")
|
|
||||||
)
|
|
||||||
return Group.objects.filter(id__in=group_object_perm_group_ids).distinct()
|
|
||||||
|
|
||||||
|
|
||||||
def set_permissions_for_object(
|
|
||||||
permissions: dict,
|
|
||||||
object,
|
|
||||||
*,
|
|
||||||
merge: bool = False,
|
|
||||||
) -> None:
|
|
||||||
"""
|
|
||||||
Set permissions for an object. The permissions are given as a mapping of actions
|
|
||||||
to a dict of user / group id lists, e.g.
|
|
||||||
{"view": {"users": [1], "groups": [2]}, "change": {"users": [], "groups": []}}.
|
|
||||||
|
|
||||||
If merge is True, the permissions are merged with the existing permissions and
|
|
||||||
no users or groups are removed. If False, the permissions are set to exactly
|
|
||||||
the given list of users and groups.
|
|
||||||
"""
|
|
||||||
|
|
||||||
for action, entry in permissions.items():
|
|
||||||
permission = f"{action}_{object.__class__.__name__.lower()}"
|
|
||||||
if "users" in entry:
|
|
||||||
# users
|
|
||||||
users_to_add = User.objects.filter(id__in=entry["users"])
|
|
||||||
users_to_remove = (
|
|
||||||
get_users_with_perms(
|
|
||||||
object,
|
|
||||||
only_with_perms_in=[permission],
|
|
||||||
with_group_users=False,
|
|
||||||
)
|
|
||||||
if not merge
|
|
||||||
else User.objects.none()
|
|
||||||
)
|
|
||||||
if users_to_add.exists() and users_to_remove.exists():
|
|
||||||
users_to_remove = users_to_remove.exclude(id__in=users_to_add)
|
|
||||||
if users_to_remove.exists():
|
|
||||||
for user in users_to_remove:
|
|
||||||
remove_perm(permission, user, object)
|
|
||||||
if users_to_add.exists():
|
|
||||||
for user in users_to_add:
|
|
||||||
assign_perm(permission, user, object)
|
|
||||||
if action == "change":
|
|
||||||
# change gives view too
|
|
||||||
assign_perm(
|
|
||||||
f"view_{object.__class__.__name__.lower()}",
|
|
||||||
user,
|
|
||||||
object,
|
|
||||||
)
|
|
||||||
if "groups" in entry:
|
|
||||||
# groups
|
|
||||||
groups_to_add = Group.objects.filter(id__in=entry["groups"])
|
|
||||||
groups_to_remove = (
|
|
||||||
get_groups_with_only_permission(
|
|
||||||
object,
|
|
||||||
permission,
|
|
||||||
)
|
|
||||||
if not merge
|
|
||||||
else Group.objects.none()
|
|
||||||
)
|
|
||||||
if groups_to_add.exists() and groups_to_remove.exists():
|
|
||||||
groups_to_remove = groups_to_remove.exclude(id__in=groups_to_add)
|
|
||||||
if groups_to_remove.exists():
|
|
||||||
for group in groups_to_remove:
|
|
||||||
remove_perm(permission, group, object)
|
|
||||||
if groups_to_add.exists():
|
|
||||||
for group in groups_to_add:
|
|
||||||
assign_perm(permission, group, object)
|
|
||||||
if action == "change":
|
|
||||||
# change gives view too
|
|
||||||
assign_perm(
|
|
||||||
f"view_{object.__class__.__name__.lower()}",
|
|
||||||
group,
|
|
||||||
object,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def _resolve_permissions(codenames: set[str], ctype: ContentType) -> list[Permission]:
|
def _resolve_permissions(codenames: set[str], ctype: ContentType) -> list[Permission]:
|
||||||
"""
|
"""
|
||||||
Resolves `codenames` to Permission rows, raising like the single-object
|
Resolve ``codenames`` to Permission rows, raising for any that don't exist
|
||||||
assign_perm() this bulk path replaces does (via a `.get()` internally)
|
so a bad action name fails loudly instead of granting nothing.
|
||||||
if any codename doesn't exist. SetPermissionsSerializer rejects unknown
|
|
||||||
action names at the API, but a caller passing one directly would
|
|
||||||
otherwise get a plain `.filter()` that silently builds zero rows and
|
|
||||||
no-ops instead of reporting the bad input.
|
|
||||||
"""
|
"""
|
||||||
permission_objs = list(
|
permission_objs = list(
|
||||||
Permission.objects.filter(content_type=ctype, codename__in=codenames),
|
Permission.objects.filter(content_type=ctype, codename__in=codenames),
|
||||||
@@ -203,16 +141,13 @@ def _apply_bulk_permission_entry(
|
|||||||
perm_model: type[UserObjectPermission] | type[GroupObjectPermission],
|
perm_model: type[UserObjectPermission] | type[GroupObjectPermission],
|
||||||
identity_model: type[User] | type[Group],
|
identity_model: type[User] | type[Group],
|
||||||
identity_field: str,
|
identity_field: str,
|
||||||
ids: list[int],
|
ids: Iterable[int],
|
||||||
codename: str,
|
codename: str,
|
||||||
permission_objs: list[Permission],
|
permission_objs: list[Permission],
|
||||||
ctype: ContentType,
|
ctype: ContentType,
|
||||||
object_pks: list[str],
|
object_pks: list[str],
|
||||||
merge: bool,
|
merge: bool,
|
||||||
) -> None:
|
) -> None:
|
||||||
# Only the ids are needed to build permission rows (via `<field>_id=`),
|
|
||||||
# so avoid fetching full User/Group rows for identities that may not
|
|
||||||
# even end up being granted anything new.
|
|
||||||
add_ids = set(
|
add_ids = set(
|
||||||
identity_model.objects.filter(id__in=ids).values_list("id", flat=True),
|
identity_model.objects.filter(id__in=ids).values_list("id", flat=True),
|
||||||
)
|
)
|
||||||
@@ -250,45 +185,26 @@ def _apply_bulk_permission_entry(
|
|||||||
for pk in object_pks
|
for pk in object_pks
|
||||||
for identity_id in add_ids
|
for identity_id in add_ids
|
||||||
]
|
]
|
||||||
# ignore_conflicts skips only rows that already exist as an exact
|
# ignore_conflicts skips grants that already exist (unique constraint).
|
||||||
# (identity, permission, object) match -- the same de-dup the
|
|
||||||
# underlying (user|group, permission, object_pk) unique constraint
|
|
||||||
# already enforces for the single-object assign_perm() this replaces,
|
|
||||||
# so it doesn't change what counts as "already granted". batch_size
|
|
||||||
# caps how many rows go into a single INSERT statement.
|
|
||||||
perm_model.objects.bulk_create(rows, ignore_conflicts=True, batch_size=1000)
|
perm_model.objects.bulk_create(rows, ignore_conflicts=True, batch_size=1000)
|
||||||
|
|
||||||
|
|
||||||
def set_permissions_for_objects(
|
def set_permissions_for_objects(
|
||||||
permissions: dict,
|
permissions: PermissionsSpec,
|
||||||
model: type[Model],
|
model: type[Model],
|
||||||
pks: QuerySet | list,
|
pks: QuerySet | list,
|
||||||
*,
|
*,
|
||||||
merge: bool = False,
|
merge: bool = False,
|
||||||
) -> None:
|
) -> None:
|
||||||
"""
|
"""
|
||||||
Bulk equivalent of set_permissions_for_object: applies the same
|
Set the view/change grants for every object in ``pks``. With ``merge``,
|
||||||
permission changes to every object identified by `pks` at once.
|
the given users and groups are added; without it, each given action's
|
||||||
|
direct grants are replaced. Granting change also grants view, and an
|
||||||
|
action entry with neither key is left untouched.
|
||||||
|
|
||||||
Takes a model + pks (rather than model instances) deliberately -- the
|
guardian's bulk assign_perm is avoided because it skips the direct row
|
||||||
permission rows built below only ever need `pk`, `content_type`, and
|
for anyone who already has access through a group, so revoking the group
|
||||||
identity ids, so callers shouldn't have to fetch full rows (with every
|
later would silently remove access that was granted explicitly.
|
||||||
other field) just to hand them to this function.
|
|
||||||
|
|
||||||
Deliberately does not use guardian's queryset/list-aware assign_perm:
|
|
||||||
passing a list as the object routes to bulk_assign_perm, which skips
|
|
||||||
creating a direct permission row for anyone who already has the
|
|
||||||
permission via ANY group membership (it checks
|
|
||||||
ObjectPermissionChecker.has_perm, which is group-inheritance-aware) --
|
|
||||||
unlike the single-object assign_perm this replaces, which always
|
|
||||||
ensures a direct row via get_or_create regardless of group-derived
|
|
||||||
access. Losing that guarantee would mean a later revocation of the
|
|
||||||
group's grant silently strips access an admin explicitly asked to be
|
|
||||||
direct. Bulk-creating rows straight against the permission models
|
|
||||||
instead (see _apply_bulk_permission_entry) preserves the original
|
|
||||||
always-create-a-direct-row semantics while still batching every object
|
|
||||||
and every identity into one query per action, rather than one query per
|
|
||||||
(object, user) pair.
|
|
||||||
"""
|
"""
|
||||||
object_pks = [str(pk) for pk in pks]
|
object_pks = [str(pk) for pk in pks]
|
||||||
if not object_pks: # pragma: no cover
|
if not object_pks: # pragma: no cover
|
||||||
@@ -297,12 +213,9 @@ def set_permissions_for_objects(
|
|||||||
model_name = model.__name__.lower()
|
model_name = model.__name__.lower()
|
||||||
ctype = ContentType.objects.get_for_model(model)
|
ctype = ContentType.objects.get_for_model(model)
|
||||||
|
|
||||||
# Every action is resolved up front, before anything is written, so an
|
# Resolve every action before writing, so a bad one can't leave the
|
||||||
# unrecognized action name (see _resolve_permissions) aborts the whole
|
# actions ahead of it applied.
|
||||||
# call instead of leaving the actions ahead of it already applied.
|
permissions_by_action: dict[PermissionAction, list[Permission]] = {}
|
||||||
# SetPermissionsSerializer rejects unknown actions at the API, so this
|
|
||||||
# guards any other caller.
|
|
||||||
permissions_by_action: dict[str, list[Permission]] = {}
|
|
||||||
for action, entry in permissions.items():
|
for action, entry in permissions.items():
|
||||||
if "users" not in entry and "groups" not in entry:
|
if "users" not in entry and "groups" not in entry:
|
||||||
continue
|
continue
|
||||||
@@ -346,6 +259,56 @@ def set_permissions_for_objects(
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def get_permission_grantees(
|
||||||
|
model: type[Model],
|
||||||
|
pks: Iterable[int],
|
||||||
|
actions: Iterable[PermissionAction] = PERMISSION_ACTIONS,
|
||||||
|
) -> dict[int, dict[PermissionAction, PermissionGrantees]]:
|
||||||
|
"""
|
||||||
|
Return the users and groups holding each of ``actions`` directly on each
|
||||||
|
object of ``model`` identified by ``pks``, in two queries however many
|
||||||
|
objects are asked about.
|
||||||
|
|
||||||
|
Every requested pk and action has an entry, with empty lists where nothing
|
||||||
|
is granted. Ids are sorted. Group grants stay group ids rather than being
|
||||||
|
expanded to their members, so a caller that copies them keeps access tied
|
||||||
|
to current group membership.
|
||||||
|
"""
|
||||||
|
pks = list(pks)
|
||||||
|
actions = list(actions)
|
||||||
|
model_name = model.__name__.lower()
|
||||||
|
action_by_codename: dict[str, PermissionAction] = {
|
||||||
|
f"{action}_{model_name}": action for action in actions
|
||||||
|
}
|
||||||
|
result: dict[int, dict[PermissionAction, PermissionGrantees]] = {
|
||||||
|
pk: {action: {"users": [], "groups": []} for action in actions} for pk in pks
|
||||||
|
}
|
||||||
|
if not pks or not actions:
|
||||||
|
return result
|
||||||
|
|
||||||
|
ctype = ContentType.objects.get_for_model(model)
|
||||||
|
grant_filter = {
|
||||||
|
"content_type": ctype,
|
||||||
|
"permission__content_type": ctype,
|
||||||
|
"permission__codename__in": list(action_by_codename),
|
||||||
|
"object_pk__in": [str(pk) for pk in pks],
|
||||||
|
}
|
||||||
|
for perm_model, identity_field, key in (
|
||||||
|
(UserObjectPermission, "user_id", "users"),
|
||||||
|
(GroupObjectPermission, "group_id", "groups"),
|
||||||
|
):
|
||||||
|
rows = (
|
||||||
|
perm_model.objects.filter(**grant_filter)
|
||||||
|
.values_list("object_pk", "permission__codename", identity_field)
|
||||||
|
.order_by(identity_field)
|
||||||
|
)
|
||||||
|
for object_pk, codename, identity_id in rows:
|
||||||
|
result[int(object_pk)][action_by_codename[codename]][key].append(
|
||||||
|
identity_id,
|
||||||
|
)
|
||||||
|
return result
|
||||||
|
|
||||||
|
|
||||||
def permitted_object_ids(
|
def permitted_object_ids(
|
||||||
user: User | None,
|
user: User | None,
|
||||||
model: type[Model],
|
model: type[Model],
|
||||||
|
|||||||
@@ -48,8 +48,6 @@ if TYPE_CHECKING:
|
|||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
from django.contrib.auth.models import AbstractUser
|
from django.contrib.auth.models import AbstractUser
|
||||||
from django.contrib.auth.models import Group
|
|
||||||
from django.contrib.auth.models import User
|
|
||||||
from django.db.models import QuerySet
|
from django.db.models import QuerySet
|
||||||
|
|
||||||
from documents.models import Document
|
from documents.models import Document
|
||||||
@@ -528,8 +526,8 @@ class TantivyBackend:
|
|||||||
Annotate the queryset with ``annotate_effective_content`` when indexing
|
Annotate the queryset with ``annotate_effective_content`` when indexing
|
||||||
more than a couple of documents, to resolve that without a query each.
|
more than a couple of documents, to resolve that without a query each.
|
||||||
"""
|
"""
|
||||||
from guardian.shortcuts import get_groups_with_perms
|
from documents.models import Document
|
||||||
from guardian.shortcuts import get_users_with_perms
|
from documents.permissions import get_permission_grantees
|
||||||
|
|
||||||
# Every searchable string is normalized on the way in, and every
|
# Every searchable string is normalized on the way in, and every
|
||||||
# query string on the way out (_parse_query), so the two agree on
|
# query string on the way out (_parse_query), so the two agree on
|
||||||
@@ -674,28 +672,18 @@ class TantivyBackend:
|
|||||||
doc.add_unsigned("owner_id", document.owner_id)
|
doc.add_unsigned("owner_id", document.owner_id)
|
||||||
|
|
||||||
# Viewers with permission
|
# Viewers with permission
|
||||||
if viewer_ids is None:
|
if viewer_ids is None or viewer_group_ids is None:
|
||||||
users_with_perms = get_users_with_perms(
|
view = get_permission_grantees(
|
||||||
document,
|
Document,
|
||||||
only_with_perms_in=["view_document"],
|
[document.pk],
|
||||||
with_group_users=False,
|
actions=("view",),
|
||||||
)
|
)[document.pk]["view"]
|
||||||
viewer_ids = list(
|
if viewer_ids is None:
|
||||||
cast("QuerySet[User]", users_with_perms).values_list("id", flat=True),
|
viewer_ids = view["users"]
|
||||||
)
|
if viewer_group_ids is None:
|
||||||
|
viewer_group_ids = view["groups"]
|
||||||
for viewer_id in viewer_ids:
|
for viewer_id in viewer_ids:
|
||||||
doc.add_unsigned("viewer_id", viewer_id)
|
doc.add_unsigned("viewer_id", viewer_id)
|
||||||
if viewer_group_ids is None:
|
|
||||||
groups_with_perms = get_groups_with_perms(
|
|
||||||
document,
|
|
||||||
only_with_perms_in=["view_document"],
|
|
||||||
)
|
|
||||||
viewer_group_ids = list(
|
|
||||||
cast("QuerySet[Group]", groups_with_perms).values_list(
|
|
||||||
"id",
|
|
||||||
flat=True,
|
|
||||||
),
|
|
||||||
)
|
|
||||||
for viewer_group_id in viewer_group_ids:
|
for viewer_group_id in viewer_group_ids:
|
||||||
doc.add_unsigned("viewer_group_id", viewer_group_id)
|
doc.add_unsigned("viewer_group_id", viewer_group_id)
|
||||||
|
|
||||||
@@ -1200,12 +1188,6 @@ def chunked(iterable, size):
|
|||||||
yield chunk
|
yield chunk
|
||||||
|
|
||||||
|
|
||||||
_EMPTY_VIEWER_GRANT: Final[ViewerGrant] = ViewerGrant(
|
|
||||||
viewer_ids=[],
|
|
||||||
viewer_group_ids=[],
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class _DocumentViewerStream(QuerySetStream["Document"]):
|
class _DocumentViewerStream(QuerySetStream["Document"]):
|
||||||
"""Yield document permission data while batch-loading grants.
|
"""Yield document permission data while batch-loading grants.
|
||||||
|
|
||||||
@@ -1231,7 +1213,7 @@ class _DocumentViewerStream(QuerySetStream["Document"]):
|
|||||||
for chunk in chunked(documents, self._chunk_size):
|
for chunk in chunked(documents, self._chunk_size):
|
||||||
grants_by_pk = _bulk_get_viewer_permissions([doc.pk for doc in chunk])
|
grants_by_pk = _bulk_get_viewer_permissions([doc.pk for doc in chunk])
|
||||||
for doc in chunk:
|
for doc in chunk:
|
||||||
yield doc, grants_by_pk.get(doc.pk, _EMPTY_VIEWER_GRANT)
|
yield doc, grants_by_pk[doc.pk]
|
||||||
|
|
||||||
|
|
||||||
def _bulk_get_viewer_permissions(
|
def _bulk_get_viewer_permissions(
|
||||||
@@ -1243,48 +1225,19 @@ def _bulk_get_viewer_permissions(
|
|||||||
requesting user's current memberships. Expanding groups to user IDs here
|
requesting user's current memberships. Expanding groups to user IDs here
|
||||||
would leave stale access behind after a user is removed from a group.
|
would leave stale access behind after a user is removed from a group.
|
||||||
"""
|
"""
|
||||||
from collections import defaultdict
|
|
||||||
|
|
||||||
from django.contrib.contenttypes.models import ContentType
|
|
||||||
from guardian.models import GroupObjectPermission
|
|
||||||
from guardian.models import UserObjectPermission
|
|
||||||
|
|
||||||
from documents.models import Document
|
from documents.models import Document
|
||||||
|
from documents.permissions import get_permission_grantees
|
||||||
# get_for_model is cached by Django, so this costs at most one query total.
|
|
||||||
ct = ContentType.objects.get_for_model(Document)
|
|
||||||
str_pks = [str(pk) for pk in doc_pks]
|
|
||||||
|
|
||||||
viewer_map: dict[int, set[int]] = defaultdict(set)
|
|
||||||
viewer_group_map: dict[int, set[int]] = defaultdict(set)
|
|
||||||
|
|
||||||
# Fold the permission lookup into the query via a join on codename instead
|
|
||||||
# of a separate Permission.objects.get(), which would otherwise run once per
|
|
||||||
# chunk during a full reindex.
|
|
||||||
user_qs = UserObjectPermission.objects.filter(
|
|
||||||
content_type=ct,
|
|
||||||
permission__content_type=ct,
|
|
||||||
permission__codename="view_document",
|
|
||||||
object_pk__in=str_pks,
|
|
||||||
).values_list("object_pk", "user_id")
|
|
||||||
for object_pk, user_id in user_qs:
|
|
||||||
viewer_map[int(object_pk)].add(user_id)
|
|
||||||
|
|
||||||
group_qs = GroupObjectPermission.objects.filter(
|
|
||||||
content_type=ct,
|
|
||||||
permission__content_type=ct,
|
|
||||||
permission__codename="view_document",
|
|
||||||
object_pk__in=str_pks,
|
|
||||||
).values_list("object_pk", "group_id")
|
|
||||||
for object_pk, group_id in group_qs:
|
|
||||||
viewer_group_map[int(object_pk)].add(group_id)
|
|
||||||
|
|
||||||
return {
|
return {
|
||||||
object_pk: ViewerGrant(
|
pk: ViewerGrant(
|
||||||
viewer_ids=list(viewer_map.get(object_pk, ())),
|
viewer_ids=grantees["view"]["users"],
|
||||||
viewer_group_ids=list(viewer_group_map.get(object_pk, ())),
|
viewer_group_ids=grantees["view"]["groups"],
|
||||||
)
|
)
|
||||||
for object_pk in viewer_map.keys() | viewer_group_map.keys()
|
for pk, grantees in get_permission_grantees(
|
||||||
|
Document,
|
||||||
|
doc_pks,
|
||||||
|
actions=("view",),
|
||||||
|
).items()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -8,7 +8,6 @@ from datetime import timedelta
|
|||||||
from decimal import Decimal
|
from decimal import Decimal
|
||||||
from typing import TYPE_CHECKING
|
from typing import TYPE_CHECKING
|
||||||
from typing import Any
|
from typing import Any
|
||||||
from typing import Literal
|
|
||||||
from typing import TypedDict
|
from typing import TypedDict
|
||||||
|
|
||||||
import magic
|
import magic
|
||||||
@@ -39,7 +38,6 @@ from drf_spectacular.utils import extend_schema_field
|
|||||||
from drf_spectacular.utils import extend_schema_serializer
|
from drf_spectacular.utils import extend_schema_serializer
|
||||||
from drf_writable_nested.serializers import NestedUpdateMixin
|
from drf_writable_nested.serializers import NestedUpdateMixin
|
||||||
from guardian.core import ObjectPermissionChecker
|
from guardian.core import ObjectPermissionChecker
|
||||||
from guardian.shortcuts import get_users_with_perms
|
|
||||||
from guardian.utils import get_group_obj_perms_model
|
from guardian.utils import get_group_obj_perms_model
|
||||||
from guardian.utils import get_user_obj_perms_model
|
from guardian.utils import get_user_obj_perms_model
|
||||||
from rest_framework import fields
|
from rest_framework import fields
|
||||||
@@ -78,12 +76,17 @@ from documents.models import WorkflowActionEmail
|
|||||||
from documents.models import WorkflowActionWebhook
|
from documents.models import WorkflowActionWebhook
|
||||||
from documents.models import WorkflowTrigger
|
from documents.models import WorkflowTrigger
|
||||||
from documents.parsers import is_mime_type_supported
|
from documents.parsers import is_mime_type_supported
|
||||||
|
from documents.permissions import PERMISSION_ACTIONS
|
||||||
|
from documents.permissions import PermissionAction
|
||||||
|
from documents.permissions import PermissionGrantees
|
||||||
|
from documents.permissions import PermissionGranteesUpdate
|
||||||
|
from documents.permissions import PermissionsSpec
|
||||||
from documents.permissions import get_document_count_filter_for_user
|
from documents.permissions import get_document_count_filter_for_user
|
||||||
from documents.permissions import get_groups_with_only_permission
|
from documents.permissions import get_permission_grantees
|
||||||
from documents.permissions import has_perms_owner_aware
|
from documents.permissions import has_perms_owner_aware
|
||||||
from documents.permissions import permitted_document_ids
|
from documents.permissions import permitted_document_ids
|
||||||
from documents.permissions import restrict_queryset_to_visible
|
from documents.permissions import restrict_queryset_to_visible
|
||||||
from documents.permissions import set_permissions_for_object
|
from documents.permissions import set_permissions_for_objects
|
||||||
from documents.regex import validate_regex_pattern
|
from documents.regex import validate_regex_pattern
|
||||||
from documents.templating.filepath import validate_filepath_template_and_render
|
from documents.templating.filepath import validate_filepath_template_and_render
|
||||||
from documents.templating.utils import convert_format_str_to_template_format
|
from documents.templating.utils import convert_format_str_to_template_format
|
||||||
@@ -211,9 +214,6 @@ class MatchingModelSerializer(serializers.ModelSerializer[Any]):
|
|||||||
return match
|
return match
|
||||||
|
|
||||||
|
|
||||||
PERMISSION_ACTIONS = ("view", "change")
|
|
||||||
|
|
||||||
|
|
||||||
class SetPermissionsMixin:
|
class SetPermissionsMixin:
|
||||||
def _validate_user_ids(self, user_ids):
|
def _validate_user_ids(self, user_ids):
|
||||||
users = User.objects.none()
|
users = User.objects.none()
|
||||||
@@ -235,8 +235,10 @@ class SetPermissionsMixin:
|
|||||||
)
|
)
|
||||||
return groups
|
return groups
|
||||||
|
|
||||||
def validate_set_permissions(self, set_permissions=None):
|
def validate_set_permissions(self, set_permissions=None) -> PermissionsSpec:
|
||||||
permissions_dict = {action: {} for action in PERMISSION_ACTIONS}
|
permissions_dict: dict[PermissionAction, PermissionGranteesUpdate] = {
|
||||||
|
action: {} for action in PERMISSION_ACTIONS
|
||||||
|
}
|
||||||
if set_permissions is not None:
|
if set_permissions is not None:
|
||||||
for action in PERMISSION_ACTIONS:
|
for action in PERMISSION_ACTIONS:
|
||||||
if action in set_permissions:
|
if action in set_permissions:
|
||||||
@@ -244,18 +246,18 @@ class SetPermissionsMixin:
|
|||||||
users = set_permissions[action]["users"]
|
users = set_permissions[action]["users"]
|
||||||
permissions_dict[action]["users"] = self._validate_user_ids(
|
permissions_dict[action]["users"] = self._validate_user_ids(
|
||||||
users,
|
users,
|
||||||
)
|
).values_list("id", flat=True)
|
||||||
if "groups" in set_permissions[action]:
|
if "groups" in set_permissions[action]:
|
||||||
groups = set_permissions[action]["groups"]
|
groups = set_permissions[action]["groups"]
|
||||||
permissions_dict[action]["groups"] = self._validate_group_ids(
|
permissions_dict[action]["groups"] = self._validate_group_ids(
|
||||||
groups,
|
groups,
|
||||||
)
|
).values_list("id", flat=True)
|
||||||
else:
|
else:
|
||||||
del permissions_dict[action]
|
del permissions_dict[action]
|
||||||
return permissions_dict
|
return permissions_dict
|
||||||
|
|
||||||
def _set_permissions(self, permissions, object) -> None:
|
def _set_permissions(self, permissions: PermissionsSpec, object) -> None:
|
||||||
set_permissions_for_object(permissions, object)
|
set_permissions_for_objects(permissions, type(object), [object.pk])
|
||||||
|
|
||||||
|
|
||||||
class SerializerWithPerms(serializers.Serializer[dict[str, Any]]):
|
class SerializerWithPerms(serializers.Serializer[dict[str, Any]]):
|
||||||
@@ -311,35 +313,6 @@ class OwnedObjectSerializer(
|
|||||||
except KeyError:
|
except KeyError:
|
||||||
pass
|
pass
|
||||||
|
|
||||||
def _get_perms(self, obj, codename: str, target: Literal["users", "groups"]):
|
|
||||||
"""
|
|
||||||
Get the given permissions from context or from django-guardian.
|
|
||||||
|
|
||||||
:param codename: The permission codename, e.g. 'view' or 'change'
|
|
||||||
:param target: 'users' or 'groups'
|
|
||||||
"""
|
|
||||||
key = f"{target}_{codename}_perms"
|
|
||||||
cached = self.context.get(key, {}).get(obj.pk)
|
|
||||||
if cached is not None:
|
|
||||||
return list(cached)
|
|
||||||
|
|
||||||
# Permission not found in the context, get it from guardian
|
|
||||||
if target == "users":
|
|
||||||
return list(
|
|
||||||
get_users_with_perms(
|
|
||||||
obj,
|
|
||||||
only_with_perms_in=[f"{codename}_{obj.__class__.__name__.lower()}"],
|
|
||||||
with_group_users=False,
|
|
||||||
).values_list("id", flat=True),
|
|
||||||
)
|
|
||||||
else: # groups
|
|
||||||
return list(
|
|
||||||
get_groups_with_only_permission(
|
|
||||||
obj,
|
|
||||||
codename=f"{codename}_{obj.__class__.__name__.lower()}",
|
|
||||||
).values_list("id", flat=True),
|
|
||||||
)
|
|
||||||
|
|
||||||
@extend_schema_field(
|
@extend_schema_field(
|
||||||
field={
|
field={
|
||||||
"type": "object",
|
"type": "object",
|
||||||
@@ -373,17 +346,12 @@ class OwnedObjectSerializer(
|
|||||||
},
|
},
|
||||||
},
|
},
|
||||||
)
|
)
|
||||||
def get_permissions(self, obj) -> dict:
|
def get_permissions(self, obj) -> dict[PermissionAction, PermissionGrantees]:
|
||||||
return {
|
# Prefer the page-level batch computed by BulkPermissionMixin.
|
||||||
"view": {
|
grantees = self.context.get("permission_grantees", {}).get(obj.pk)
|
||||||
"users": self._get_perms(obj, "view", "users"),
|
if grantees is not None:
|
||||||
"groups": self._get_perms(obj, "view", "groups"),
|
return grantees
|
||||||
},
|
return get_permission_grantees(type(obj), [obj.pk])[obj.pk]
|
||||||
"change": {
|
|
||||||
"users": self._get_perms(obj, "change", "users"),
|
|
||||||
"groups": self._get_perms(obj, "change", "groups"),
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
def get_user_can_change(self, obj) -> bool:
|
def get_user_can_change(self, obj) -> bool:
|
||||||
if obj.owner is None or obj.owner == self.user:
|
if obj.owner is None or obj.owner == self.user:
|
||||||
@@ -399,18 +367,18 @@ class OwnedObjectSerializer(
|
|||||||
# Prefer the page-level batch computed by BulkPermissionMixin
|
# Prefer the page-level batch computed by BulkPermissionMixin
|
||||||
# (get_serializer_context) over a fresh per-object guardian check,
|
# (get_serializer_context) over a fresh per-object guardian check,
|
||||||
# which would otherwise query the permission tables once per row.
|
# which would otherwise query the permission tables once per row.
|
||||||
users_change_perms = self.context.get("users_change_perms")
|
grantees_by_pk = self.context.get("permission_grantees")
|
||||||
groups_change_perms = self.context.get("groups_change_perms")
|
if grantees_by_pk is not None:
|
||||||
if users_change_perms is not None and groups_change_perms is not None:
|
change = grantees_by_pk.get(obj.pk, {}).get("change")
|
||||||
if self.user.pk in users_change_perms.get(obj.pk, []):
|
if change is None:
|
||||||
|
return False
|
||||||
|
if self.user.pk in change["users"]:
|
||||||
return True
|
return True
|
||||||
user_group_ids = getattr(self, "_user_group_ids", None)
|
user_group_ids = getattr(self, "_user_group_ids", None)
|
||||||
if user_group_ids is None:
|
if user_group_ids is None:
|
||||||
user_group_ids = set(self.user.groups.values_list("id", flat=True))
|
user_group_ids = set(self.user.groups.values_list("id", flat=True))
|
||||||
self._user_group_ids = user_group_ids
|
self._user_group_ids = user_group_ids
|
||||||
return bool(
|
return bool(user_group_ids.intersection(change["groups"]))
|
||||||
user_group_ids.intersection(groups_change_perms.get(obj.pk, [])),
|
|
||||||
)
|
|
||||||
|
|
||||||
checker = ObjectPermissionChecker(self.user)
|
checker = ObjectPermissionChecker(self.user)
|
||||||
return checker.has_perm(f"change_{obj.__class__.__name__.lower()}", obj)
|
return checker.has_perm(f"change_{obj.__class__.__name__.lower()}", obj)
|
||||||
@@ -3086,7 +3054,7 @@ class BulkEditObjectsSerializer(SerializerWithPerms, SetPermissionsMixin):
|
|||||||
)
|
)
|
||||||
return objects
|
return objects
|
||||||
|
|
||||||
def _validate_permissions(self, permissions) -> dict:
|
def _validate_permissions(self, permissions) -> PermissionsSpec:
|
||||||
return self.validate_set_permissions(
|
return self.validate_set_permissions(
|
||||||
permissions,
|
permissions,
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -23,6 +23,7 @@ from documents.models import Document
|
|||||||
from documents.models import DocumentType
|
from documents.models import DocumentType
|
||||||
from documents.models import StoragePath
|
from documents.models import StoragePath
|
||||||
from documents.models import Tag
|
from documents.models import Tag
|
||||||
|
from documents.permissions import PermissionsSpec
|
||||||
from documents.permissions import set_permissions_for_objects
|
from documents.permissions import set_permissions_for_objects
|
||||||
from paperless_testing.dirs import DirectoriesMixin
|
from paperless_testing.dirs import DirectoriesMixin
|
||||||
from paperless_testing.factories import DocumentFactory
|
from paperless_testing.factories import DocumentFactory
|
||||||
@@ -445,7 +446,7 @@ class TestBulkEdit(DirectoriesMixin, TestCase):
|
|||||||
|
|
||||||
grant_object(self.group1, self.doc1, "view_document")
|
grant_object(self.group1, self.doc1, "view_document")
|
||||||
|
|
||||||
permissions = {
|
permissions: PermissionsSpec = {
|
||||||
"view": {
|
"view": {
|
||||||
"users": [self.user1.id, self.user2.id],
|
"users": [self.user1.id, self.user2.id],
|
||||||
"groups": [self.group2.id],
|
"groups": [self.group2.id],
|
||||||
@@ -488,7 +489,7 @@ class TestBulkEdit(DirectoriesMixin, TestCase):
|
|||||||
grant_object(self.user1, self.doc1, "view_document")
|
grant_object(self.user1, self.doc1, "view_document")
|
||||||
grant_object(self.group1, self.doc1, "view_document")
|
grant_object(self.group1, self.doc1, "view_document")
|
||||||
|
|
||||||
permissions = {
|
permissions: PermissionsSpec = {
|
||||||
"view": {
|
"view": {
|
||||||
"users": [self.user2.id],
|
"users": [self.user2.id],
|
||||||
"groups": [self.group2.id],
|
"groups": [self.group2.id],
|
||||||
@@ -539,7 +540,7 @@ class TestBulkEdit(DirectoriesMixin, TestCase):
|
|||||||
batched call rather than one call per (document, identity)
|
batched call rather than one call per (document, identity)
|
||||||
pair
|
pair
|
||||||
"""
|
"""
|
||||||
permissions = {
|
permissions: PermissionsSpec = {
|
||||||
"view": {
|
"view": {
|
||||||
"users": [self.user1.id, self.user2.id],
|
"users": [self.user1.id, self.user2.id],
|
||||||
"groups": [self.group2.id],
|
"groups": [self.group2.id],
|
||||||
@@ -646,7 +647,7 @@ class TestBulkEdit(DirectoriesMixin, TestCase):
|
|||||||
"""
|
"""
|
||||||
with self.assertRaises(Permission.DoesNotExist):
|
with self.assertRaises(Permission.DoesNotExist):
|
||||||
set_permissions_for_objects(
|
set_permissions_for_objects(
|
||||||
{"not_a_real_action": {"users": [self.user1.id], "groups": []}},
|
{"not_a_real_action": {"users": [self.user1.id], "groups": []}}, # type: ignore[bad-assignment]
|
||||||
Document,
|
Document,
|
||||||
[self.doc1.pk],
|
[self.doc1.pk],
|
||||||
)
|
)
|
||||||
@@ -674,7 +675,7 @@ class TestBulkEdit(DirectoriesMixin, TestCase):
|
|||||||
set_permissions_for_objects(
|
set_permissions_for_objects(
|
||||||
{
|
{
|
||||||
"view": {"users": [self.user1.id], "groups": []},
|
"view": {"users": [self.user1.id], "groups": []},
|
||||||
"not_a_real_action": {"users": [self.user1.id], "groups": []},
|
"not_a_real_action": {"users": [self.user1.id], "groups": []}, # type: ignore[bad-assignment]
|
||||||
},
|
},
|
||||||
Document,
|
Document,
|
||||||
[self.doc1.pk],
|
[self.doc1.pk],
|
||||||
|
|||||||
@@ -34,8 +34,10 @@ from documents.tests.utils import GetConsumerMixin
|
|||||||
from paperless_mail.models import MailRule
|
from paperless_mail.models import MailRule
|
||||||
from paperless_testing.assertions import FileSystemAssertsMixin
|
from paperless_testing.assertions import FileSystemAssertsMixin
|
||||||
from paperless_testing.dirs import DirectoriesMixin
|
from paperless_testing.dirs import DirectoriesMixin
|
||||||
|
from paperless_testing.factories import DocumentFactory
|
||||||
from paperless_testing.factories import UserFactory
|
from paperless_testing.factories import UserFactory
|
||||||
from paperless_testing.fakes.progress import FakeProgressManager
|
from paperless_testing.fakes.progress import FakeProgressManager
|
||||||
|
from paperless_testing.permissions import grant_object
|
||||||
|
|
||||||
|
|
||||||
class _BaseNewStyleParser:
|
class _BaseNewStyleParser:
|
||||||
@@ -1683,6 +1685,32 @@ class TestMetadataOverrides(TestCase):
|
|||||||
self.assertEqual(base.actor_id, 2)
|
self.assertEqual(base.actor_id, 2)
|
||||||
self.assertEqual(base.version_label, "v2")
|
self.assertEqual(base.version_label, "v2")
|
||||||
|
|
||||||
|
def test_from_document_copies_user_and_group_grants_separately(self) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- A document with view and change granted directly to one user and
|
||||||
|
to a group with another user as a member
|
||||||
|
WHEN:
|
||||||
|
- Overrides are built from the document
|
||||||
|
THEN:
|
||||||
|
- The user lists hold only the directly granted user
|
||||||
|
- The group lists hold the group
|
||||||
|
"""
|
||||||
|
direct_user = UserFactory()
|
||||||
|
group_member = UserFactory()
|
||||||
|
group = Group.objects.create(name="group")
|
||||||
|
group_member.groups.add(group)
|
||||||
|
document = DocumentFactory()
|
||||||
|
grant_object(direct_user, document, "view_document", "change_document")
|
||||||
|
grant_object(group, document, "view_document", "change_document")
|
||||||
|
|
||||||
|
overrides = DocumentMetadataOverrides.from_document(document)
|
||||||
|
|
||||||
|
self.assertEqual(overrides.view_users, [direct_user.pk])
|
||||||
|
self.assertEqual(overrides.change_users, [direct_user.pk])
|
||||||
|
self.assertEqual(overrides.view_groups, [group.pk])
|
||||||
|
self.assertEqual(overrides.change_groups, [group.pk])
|
||||||
|
|
||||||
|
|
||||||
class TestBarcodeApplyDetectedASN(TestCase):
|
class TestBarcodeApplyDetectedASN(TestCase):
|
||||||
"""
|
"""
|
||||||
|
|||||||
@@ -15,9 +15,11 @@ from documents.matching import match_document_types
|
|||||||
from documents.matching import match_storage_paths
|
from documents.matching import match_storage_paths
|
||||||
from documents.matching import match_tags
|
from documents.matching import match_tags
|
||||||
from documents.models import Correspondent
|
from documents.models import Correspondent
|
||||||
|
from documents.models import Document
|
||||||
from documents.models import DocumentType
|
from documents.models import DocumentType
|
||||||
from documents.models import StoragePath
|
from documents.models import StoragePath
|
||||||
from documents.models import Tag
|
from documents.models import Tag
|
||||||
|
from documents.permissions import get_permission_grantees
|
||||||
from documents.permissions import has_perms_owner_aware
|
from documents.permissions import has_perms_owner_aware
|
||||||
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 permitted_object_ids
|
||||||
@@ -1372,3 +1374,101 @@ class TestRestrictQuerysetToVisible:
|
|||||||
|
|
||||||
assert own.pk in visible_ids
|
assert own.pk in visible_ids
|
||||||
assert hidden.pk not in visible_ids
|
assert hidden.pk not in visible_ids
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.django_db
|
||||||
|
class TestGetPermissionGrantees:
|
||||||
|
def test_lists_direct_grants_per_object_and_action(self) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- Two documents, the first with view and change granted to a user
|
||||||
|
and a group, the second with only view granted to another user
|
||||||
|
- A user who is a member of the granted group
|
||||||
|
WHEN:
|
||||||
|
- get_permission_grantees() is called for both documents
|
||||||
|
THEN:
|
||||||
|
- Each document and action lists exactly its direct grants
|
||||||
|
- The group member is not listed as a user
|
||||||
|
"""
|
||||||
|
direct = UserFactory()
|
||||||
|
other = UserFactory()
|
||||||
|
member = UserFactory()
|
||||||
|
group = Group.objects.create(name="grantees")
|
||||||
|
member.groups.add(group)
|
||||||
|
first = DocumentFactory()
|
||||||
|
second = DocumentFactory()
|
||||||
|
grant_object(direct, first, "view_document", "change_document")
|
||||||
|
grant_object(group, first, "view_document", "change_document")
|
||||||
|
grant_object(other, second, "view_document")
|
||||||
|
|
||||||
|
grantees = get_permission_grantees(Document, [first.pk, second.pk])
|
||||||
|
|
||||||
|
assert grantees == {
|
||||||
|
first.pk: {
|
||||||
|
"view": {"users": [direct.pk], "groups": [group.pk]},
|
||||||
|
"change": {"users": [direct.pk], "groups": [group.pk]},
|
||||||
|
},
|
||||||
|
second.pk: {
|
||||||
|
"view": {"users": [other.pk], "groups": []},
|
||||||
|
"change": {"users": [], "groups": []},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
def test_ids_are_sorted(self) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- A tag with view granted to three users in reverse creation order
|
||||||
|
WHEN:
|
||||||
|
- get_permission_grantees() is called for the tag
|
||||||
|
THEN:
|
||||||
|
- The user ids come back in ascending order
|
||||||
|
"""
|
||||||
|
users = [UserFactory() for _ in range(3)]
|
||||||
|
tag = TagFactory()
|
||||||
|
for user in reversed(users):
|
||||||
|
grant_object(user, tag, "view_tag")
|
||||||
|
|
||||||
|
grantees = get_permission_grantees(Tag, [tag.pk], actions=("view",))
|
||||||
|
|
||||||
|
assert grantees[tag.pk]["view"]["users"] == sorted(user.pk for user in users)
|
||||||
|
|
||||||
|
def test_only_requested_actions_are_returned(self) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- A tag with view and change granted to a user
|
||||||
|
WHEN:
|
||||||
|
- get_permission_grantees() is called for the view action only
|
||||||
|
THEN:
|
||||||
|
- Only the view action is returned
|
||||||
|
"""
|
||||||
|
user = UserFactory()
|
||||||
|
tag = TagFactory()
|
||||||
|
grant_object(user, tag, "view_tag", "change_tag")
|
||||||
|
|
||||||
|
grantees = get_permission_grantees(Tag, [tag.pk], actions=("view",))
|
||||||
|
|
||||||
|
assert grantees == {tag.pk: {"view": {"users": [user.pk], "groups": []}}}
|
||||||
|
|
||||||
|
def test_grants_on_another_model_with_the_same_pk_are_ignored(self) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- A tag and a correspondent sharing a primary key, with view
|
||||||
|
granted to a user on the tag only
|
||||||
|
WHEN:
|
||||||
|
- get_permission_grantees() is called for the correspondent
|
||||||
|
THEN:
|
||||||
|
- No grants are returned
|
||||||
|
"""
|
||||||
|
user = UserFactory()
|
||||||
|
tag = TagFactory()
|
||||||
|
correspondent = CorrespondentFactory(pk=tag.pk)
|
||||||
|
grant_object(user, tag, "view_tag")
|
||||||
|
|
||||||
|
grantees = get_permission_grantees(Correspondent, [correspondent.pk])
|
||||||
|
|
||||||
|
assert grantees == {
|
||||||
|
correspondent.pk: {
|
||||||
|
"view": {"users": [], "groups": []},
|
||||||
|
"change": {"users": [], "groups": []},
|
||||||
|
},
|
||||||
|
}
|
||||||
@@ -292,6 +292,33 @@ class TestViews(DirectoriesMixin, TestCase):
|
|||||||
else:
|
else:
|
||||||
assert False, f"Unexpected tag found: {tag['name']}"
|
assert False, f"Unexpected tag found: {tag['name']}"
|
||||||
|
|
||||||
|
def test_retrieve_with_full_permissions(self) -> None:
|
||||||
|
"""
|
||||||
|
GIVEN:
|
||||||
|
- A tag with view granted to two groups and change granted to only
|
||||||
|
one of them
|
||||||
|
WHEN:
|
||||||
|
- The single tag is requested with full permissions
|
||||||
|
THEN:
|
||||||
|
- Each action lists only the groups granted that action
|
||||||
|
"""
|
||||||
|
view_only = Group.objects.create(name="view_only")
|
||||||
|
view_and_change = Group.objects.create(name="view_and_change")
|
||||||
|
tag = Tag.objects.create(name="invoice")
|
||||||
|
grant_object(view_only, tag, "view_tag")
|
||||||
|
grant_object(view_and_change, tag, "view_tag", "change_tag")
|
||||||
|
grant_global(self.user, "view_tag")
|
||||||
|
|
||||||
|
self.client.force_login(self.user)
|
||||||
|
response = self.client.get(f"/api/tags/{tag.pk}/?full_perms=true")
|
||||||
|
|
||||||
|
assert response.status_code == 200
|
||||||
|
permissions = response.json()["permissions"]
|
||||||
|
assert sorted(permissions["view"]["groups"]) == sorted(
|
||||||
|
[view_only.pk, view_and_change.pk],
|
||||||
|
)
|
||||||
|
assert permissions["change"]["groups"] == [view_and_change.pk]
|
||||||
|
|
||||||
def test_list_no_n_plus_1_queries(self) -> None:
|
def test_list_no_n_plus_1_queries(self) -> None:
|
||||||
"""
|
"""
|
||||||
GIVEN:
|
GIVEN:
|
||||||
|
|||||||
+5
-68
@@ -5,7 +5,6 @@ import platform
|
|||||||
import re
|
import re
|
||||||
import tempfile
|
import tempfile
|
||||||
import zipfile
|
import zipfile
|
||||||
from collections import defaultdict
|
|
||||||
from collections import deque
|
from collections import deque
|
||||||
from collections.abc import Callable
|
from collections.abc import Callable
|
||||||
from datetime import datetime
|
from datetime import datetime
|
||||||
@@ -17,7 +16,6 @@ from time import sleep
|
|||||||
from typing import TYPE_CHECKING
|
from typing import TYPE_CHECKING
|
||||||
from typing import Any
|
from typing import Any
|
||||||
from typing import Final
|
from typing import Final
|
||||||
from typing import Literal
|
|
||||||
from typing import NamedTuple
|
from typing import NamedTuple
|
||||||
from unicodedata import normalize
|
from unicodedata import normalize
|
||||||
from urllib.parse import quote
|
from urllib.parse import quote
|
||||||
@@ -29,7 +27,6 @@ import pathvalidate
|
|||||||
from django.conf import settings
|
from django.conf import settings
|
||||||
from django.contrib.auth.models import Group
|
from django.contrib.auth.models import Group
|
||||||
from django.contrib.auth.models import User
|
from django.contrib.auth.models import User
|
||||||
from django.contrib.contenttypes.models import ContentType
|
|
||||||
from django.core.cache import cache
|
from django.core.cache import cache
|
||||||
from django.db import connections
|
from django.db import connections
|
||||||
from django.db.migrations.loader import MigrationLoader
|
from django.db.migrations.loader import MigrationLoader
|
||||||
@@ -77,8 +74,6 @@ from drf_spectacular.utils import extend_schema
|
|||||||
from drf_spectacular.utils import extend_schema_serializer
|
from drf_spectacular.utils import extend_schema_serializer
|
||||||
from drf_spectacular.utils import extend_schema_view
|
from drf_spectacular.utils import extend_schema_view
|
||||||
from drf_spectacular.utils import inline_serializer
|
from drf_spectacular.utils import inline_serializer
|
||||||
from guardian.utils import get_group_obj_perms_model
|
|
||||||
from guardian.utils import get_user_obj_perms_model
|
|
||||||
from langdetect import detect
|
from langdetect import detect
|
||||||
from packaging import version as packaging_version
|
from packaging import version as packaging_version
|
||||||
from redis import Redis
|
from redis import Redis
|
||||||
@@ -176,6 +171,7 @@ from documents.permissions import annotate_document_count_by_ids
|
|||||||
from documents.permissions import annotate_document_count_for_related_queryset
|
from documents.permissions import annotate_document_count_for_related_queryset
|
||||||
from documents.permissions import get_document_count_filter_for_user
|
from documents.permissions import get_document_count_filter_for_user
|
||||||
from documents.permissions import get_objects_for_user_owner_aware
|
from documents.permissions import get_objects_for_user_owner_aware
|
||||||
|
from documents.permissions import get_permission_grantees
|
||||||
from documents.permissions import has_global_statistics_permission
|
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
|
||||||
@@ -455,42 +451,6 @@ class BulkPermissionMixin:
|
|||||||
Prefetch Django-Guardian permissions for a list before serialization, to avoid N+1 queries.
|
Prefetch Django-Guardian permissions for a list before serialization, to avoid N+1 queries.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def _get_object_perms(
|
|
||||||
self,
|
|
||||||
objects: list,
|
|
||||||
perm_codenames: list[str],
|
|
||||||
actor: Literal["users", "groups"],
|
|
||||||
) -> dict[int, dict[str, list[int]]]:
|
|
||||||
"""
|
|
||||||
Collect object-level permissions for either users or groups.
|
|
||||||
"""
|
|
||||||
model = self.queryset.model
|
|
||||||
obj_perm_model = (
|
|
||||||
get_user_obj_perms_model(model)
|
|
||||||
if actor == "users"
|
|
||||||
else get_group_obj_perms_model(model)
|
|
||||||
)
|
|
||||||
id_field = "user_id" if actor == "users" else "group_id"
|
|
||||||
ctype = ContentType.objects.get_for_model(model)
|
|
||||||
object_pks = [obj.pk for obj in objects]
|
|
||||||
|
|
||||||
perms_qs = obj_perm_model.objects.filter(
|
|
||||||
content_type=ctype,
|
|
||||||
object_pk__in=object_pks,
|
|
||||||
permission__codename__in=perm_codenames,
|
|
||||||
).values_list("object_pk", id_field, "permission__codename")
|
|
||||||
|
|
||||||
perms: dict[int, dict[str, list[int]]] = defaultdict(lambda: defaultdict(list))
|
|
||||||
for object_pk, actor_id, codename in perms_qs:
|
|
||||||
perms[int(object_pk)][codename].append(actor_id)
|
|
||||||
|
|
||||||
# Ensure that all objects have all codenames, even if empty
|
|
||||||
for pk in object_pks:
|
|
||||||
for codename in perm_codenames:
|
|
||||||
perms[pk][codename]
|
|
||||||
|
|
||||||
return perms
|
|
||||||
|
|
||||||
def get_serializer_context(self):
|
def get_serializer_context(self):
|
||||||
"""
|
"""
|
||||||
Get all permissions of the current list of objects at once and pass them to the serializer.
|
Get all permissions of the current list of objects at once and pass them to the serializer.
|
||||||
@@ -501,7 +461,7 @@ class BulkPermissionMixin:
|
|||||||
if getattr(self, "action", None) != "list":
|
if getattr(self, "action", None) != "list":
|
||||||
# Batching only pays off across a page of objects; for single-object
|
# Batching only pays off across a page of objects; for single-object
|
||||||
# actions (retrieve, update, ...) the per-object fallback in
|
# actions (retrieve, update, ...) the per-object fallback in
|
||||||
# get_user_can_change()/_get_perms() is cheap and avoids scanning
|
# get_user_can_change()/get_permissions() is cheap and avoids scanning
|
||||||
# the whole queryset here.
|
# the whole queryset here.
|
||||||
return context
|
return context
|
||||||
|
|
||||||
@@ -514,33 +474,10 @@ class BulkPermissionMixin:
|
|||||||
else:
|
else:
|
||||||
queryset = self.filter_queryset(self.get_queryset())
|
queryset = self.filter_queryset(self.get_queryset())
|
||||||
|
|
||||||
model_name = self.queryset.model.__name__.lower()
|
context["permission_grantees"] = get_permission_grantees(
|
||||||
permission_name_view = f"view_{model_name}"
|
self.queryset.model,
|
||||||
permission_name_change = f"change_{model_name}"
|
[obj.pk for obj in queryset],
|
||||||
|
|
||||||
user_perms = self._get_object_perms(
|
|
||||||
objects=queryset,
|
|
||||||
perm_codenames=[permission_name_view, permission_name_change],
|
|
||||||
actor="users",
|
|
||||||
)
|
)
|
||||||
group_perms = self._get_object_perms(
|
|
||||||
objects=queryset,
|
|
||||||
perm_codenames=[permission_name_view, permission_name_change],
|
|
||||||
actor="groups",
|
|
||||||
)
|
|
||||||
|
|
||||||
context["users_view_perms"] = {
|
|
||||||
pk: user_perms[pk][permission_name_view] for pk in user_perms
|
|
||||||
}
|
|
||||||
context["users_change_perms"] = {
|
|
||||||
pk: user_perms[pk][permission_name_change] for pk in user_perms
|
|
||||||
}
|
|
||||||
context["groups_view_perms"] = {
|
|
||||||
pk: group_perms[pk][permission_name_view] for pk in group_perms
|
|
||||||
}
|
|
||||||
context["groups_change_perms"] = {
|
|
||||||
pk: group_perms[pk][permission_name_change] for pk in group_perms
|
|
||||||
}
|
|
||||||
|
|
||||||
return context
|
return context
|
||||||
|
|
||||||
|
|||||||
@@ -7,7 +7,8 @@ from documents.data_models import DocumentMetadataOverrides
|
|||||||
from documents.models import CustomFieldInstance
|
from documents.models import CustomFieldInstance
|
||||||
from documents.models import Document
|
from documents.models import Document
|
||||||
from documents.models import WorkflowAction
|
from documents.models import WorkflowAction
|
||||||
from documents.permissions import set_permissions_for_object
|
from documents.permissions import PermissionsSpec
|
||||||
|
from documents.permissions import set_permissions_for_objects
|
||||||
from documents.templating.workflows import parse_w_workflow_placeholders
|
from documents.templating.workflows import parse_w_workflow_placeholders
|
||||||
|
|
||||||
logger = logging.getLogger("paperless.workflows.mutations")
|
logger = logging.getLogger("paperless.workflows.mutations")
|
||||||
@@ -73,7 +74,7 @@ def apply_assignment_to_document(
|
|||||||
action.has_assign_change_groups,
|
action.has_assign_change_groups,
|
||||||
],
|
],
|
||||||
):
|
):
|
||||||
permissions = {
|
permissions: PermissionsSpec = {
|
||||||
"view": {
|
"view": {
|
||||||
"users": action.assign_view_users.values_list("id", flat=True),
|
"users": action.assign_view_users.values_list("id", flat=True),
|
||||||
"groups": action.assign_view_groups.values_list("id", flat=True),
|
"groups": action.assign_view_groups.values_list("id", flat=True),
|
||||||
@@ -83,9 +84,10 @@ def apply_assignment_to_document(
|
|||||||
"groups": action.assign_change_groups.values_list("id", flat=True),
|
"groups": action.assign_change_groups.values_list("id", flat=True),
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
set_permissions_for_object(
|
set_permissions_for_objects(
|
||||||
permissions=permissions,
|
permissions,
|
||||||
object=document,
|
Document,
|
||||||
|
[document.pk],
|
||||||
merge=True,
|
merge=True,
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -243,13 +245,14 @@ def apply_removal_to_document(
|
|||||||
document.owner = None
|
document.owner = None
|
||||||
|
|
||||||
if action.remove_all_permissions:
|
if action.remove_all_permissions:
|
||||||
permissions = {
|
permissions: PermissionsSpec = {
|
||||||
"view": {"users": [], "groups": []},
|
"view": {"users": [], "groups": []},
|
||||||
"change": {"users": [], "groups": []},
|
"change": {"users": [], "groups": []},
|
||||||
}
|
}
|
||||||
set_permissions_for_object(
|
set_permissions_for_objects(
|
||||||
permissions=permissions,
|
permissions,
|
||||||
object=document,
|
Document,
|
||||||
|
[document.pk],
|
||||||
merge=False,
|
merge=False,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|||||||
@@ -1272,11 +1272,11 @@ wheels = [
|
|||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "filelock"
|
name = "filelock"
|
||||||
version = "4.0.12"
|
version = "3.32.6"
|
||||||
source = { registry = "https://pypi.org/simple" }
|
source = { registry = "https://pypi.org/simple" }
|
||||||
sdist = { url = "https://files.pythonhosted.org/packages/53/e4/34efcb869715cf299e47d1ac7b2624d2bcb6f2d3dffc2f0abe8417f65ab2/filelock-4.0.12.tar.gz", hash = "sha256:cf42711a7ac791818b299fab0332a088c65aeeefa36290de98db92c434303b0c", size = 253880, upload-time = "2026-10-05T13:17:43.677Z" }
|
sdist = { url = "https://files.pythonhosted.org/packages/38/46/126b1831dca12060d4a8296bf9c4fe5c93c4f22197fa239cb0cc82042bba/filelock-3.32.6.tar.gz", hash = "sha256:a3f55a18af3652a94d8f47d6055df434f254ca1d02ef2524850c6d249ca2512c", size = 225172, upload-time = "2026-09-08T22:57:11.528Z" }
|
||||||
wheels = [
|
wheels = [
|
||||||
{ url = "https://files.pythonhosted.org/packages/da/a1/b047e1c486a2c66283633b7dbb73872ca16ca1ce6a426f70d4d037fc8e1c/filelock-4.0.12-py3-none-any.whl", hash = "sha256:5f17ee83ecee8a6f3e389c75822fb70a1c2f0506b99438a6dffa1d56793588c8", size = 111732, upload-time = "2026-10-05T13:17:42.361Z" },
|
{ url = "https://files.pythonhosted.org/packages/cc/06/4f138f618dbea66803291274f228f01daf29f306fe8b96bc30dab765df75/filelock-3.32.6-py3-none-any.whl", hash = "sha256:3f16ecd0117feae0dfc147e8c62eb5daeccd8bd800378c3ddf416de9b4feb6b1", size = 100189, upload-time = "2026-09-08T22:57:10.182Z" },
|
||||||
]
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
@@ -3184,7 +3184,7 @@ requires-dist = [
|
|||||||
{ name = "drf-spectacular", specifier = "~=0.30" },
|
{ name = "drf-spectacular", specifier = "~=0.30" },
|
||||||
{ name = "drf-spectacular-sidecar", specifier = ">=2026.7.1,<2026.10" },
|
{ name = "drf-spectacular-sidecar", specifier = ">=2026.7.1,<2026.10" },
|
||||||
{ name = "drf-writable-nested", specifier = "~=0.7.1" },
|
{ name = "drf-writable-nested", specifier = "~=0.7.1" },
|
||||||
{ name = "filelock", specifier = ">=3.32,<4.1" },
|
{ name = "filelock", specifier = "~=3.32.0" },
|
||||||
{ name = "flower", specifier = ">=2.0.1,<2.3" },
|
{ name = "flower", specifier = ">=2.0.1,<2.3" },
|
||||||
{ name = "gotenberg-client", extras = ["httpx"], specifier = "~=1.0" },
|
{ name = "gotenberg-client", extras = ["httpx"], specifier = "~=1.0" },
|
||||||
{ name = "granian", extras = ["uvloop"], marker = "extra == 'webserver'", specifier = ">=2.7,<2.9" },
|
{ name = "granian", extras = ["uvloop"], marker = "extra == 'webserver'", specifier = ">=2.7,<2.9" },
|
||||||
|
|||||||
Reference in new issue
Block a user