Skip to content

A community-supported supercharged document management system: scan, index and archive all your documents

perf: migrate bulk-edit-objects dispatch to permitted_object_ids (#13576)

Trenton Hb192a419fd3a
diff --git a/src/documents/tests/test_permission_filtering_security.py b/src/documents/tests/test_permission_filtering_security.py
index 528885d44..3704b3e29 100644
--- a/src/documents/tests/test_permission_filtering_security.py
+++ b/src/documents/tests/test_permission_filtering_security.py
@@ -620,3 +620,117 @@ class TestMatchingRespectsObjectPermissions:
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
+
+
+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
+
+
+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
diff --git a/src/documents/views.py b/src/documents/views.py
index 1db286445..8d3ef8b2b 100644
--- a/src/documents/views.py
+++ b/src/documents/views.py
@@ -178,6 +178,7 @@ from documents.permissions import has_global_statistics_permission
from documents.permissions import has_perms_owner_aware
from documents.permissions import has_system_status_permission
from documents.permissions import permitted_document_ids
+from documents.permissions import permitted_object_ids
from documents.permissions import set_permissions_for_object
from documents.plugins.date_parsing import get_date_parser
from documents.schema import generate_object_with_permissions_schema
@@ -4764,10 +4765,8 @@ class BulkEditObjectsView(PassUserMixin):
"document_types": DocumentTypeFilterSet,
"storage_paths": StoragePathFilterSet,
}[object_type]
- user_permitted_objects = get_objects_for_user_owner_aware(
- user,
- perm_codename,
- object_class,
+ user_permitted_objects = object_class.objects.filter(
+ id__in=permitted_object_ids(user, object_class, perm_codename),
)
objs = filterset_class(
data=filters,
@@ -4792,8 +4791,9 @@ class BulkEditObjectsView(PassUserMixin):
if not user.is_superuser:
perm = f"documents.{perm_codename}"
+ permitted_ids = set(permitted_object_ids(user, object_class, perm_codename))
has_perms = user.has_perm(perm) and all(
- has_perms_owner_aware(user, perm_codename, obj) for obj in objs
+ obj.pk in permitted_ids for obj in objs
)
if not has_perms: