A community-supported supercharged document management system: scan, index and archive all your documents
Python aiangulararchivingdjangodmsdocument-managementdocument-management-systemllmmachine-learningocroptical-character-recognitionpdf
Fix: retrieve document_count for tag children (#11125)
shamoon13161ebb01f0
diff --git a/src/documents/permissions.py b/src/documents/permissions.pyindex 797d92ed9..a2b165fd8 100644--- a/src/documents/permissions.py+++ b/src/documents/permissions.py@@ -2,6 +2,7 @@ from django.contrib.auth.models import Groupfrom django.contrib.auth.models import Permissionfrom django.contrib.auth.models import Userfrom django.contrib.contenttypes.models import ContentType+from django.db.models import Qfrom django.db.models import QuerySetfrom guardian.core import ObjectPermissionCheckerfrom guardian.models import GroupObjectPermission@@ -12,6 +13,8 @@ from guardian.shortcuts import remove_permfrom rest_framework.permissions import BasePermissionfrom rest_framework.permissions import DjangoObjectPermissions+from documents.models import Document+class PaperlessObjectPermissions(DjangoObjectPermissions):"""@@ -125,6 +128,25 @@ def set_permissions_for_object(permissions: list[str], object, *, merge: bool =)+def get_document_count_filter_for_user(user):+ """+ Return the Q object used to filter document counts for the given user.+ """++ if user is None or not getattr(user, "is_authenticated", False):+ return Q(documents__deleted_at__isnull=True, documents__owner__isnull=True)+ if getattr(user, "is_superuser", False):+ return Q(documents__deleted_at__isnull=True)+ return Q(+ documents__deleted_at__isnull=True,+ documents__id__in=get_objects_for_user_owner_aware(+ user,+ "documents.view_document",+ Document,+ ).values_list("id", flat=True),+ )++def get_objects_for_user_owner_aware(user, perms, Model) -> QuerySet:objects_owned = Model.objects.filter(owner=user)objects_unowned = Model.objects.filter(owner__isnull=True)diff --git a/src/documents/serialisers.py b/src/documents/serialisers.pyindex 18d570010..25207bdfa 100644--- a/src/documents/serialisers.py+++ b/src/documents/serialisers.py@@ -20,6 +20,7 @@ from django.core.validators import EmailValidatorfrom django.core.validators import MaxLengthValidatorfrom django.core.validators import RegexValidatorfrom django.core.validators import integer_validator+from django.db.models import Countfrom django.utils.crypto import get_random_stringfrom django.utils.dateparse import parse_datetimefrom django.utils.text import slugify@@ -65,6 +66,7 @@ from documents.models import WorkflowActionEmailfrom documents.models import WorkflowActionWebhookfrom documents.models import WorkflowTriggerfrom documents.parsers import is_mime_type_supported+from documents.permissions import get_document_count_filter_for_userfrom documents.permissions import get_groups_with_only_permissionfrom documents.permissions import set_permissions_for_objectfrom documents.templating.filepath import validate_filepath_template_and_render@@ -572,8 +574,16 @@ class TagSerializer(MatchingModelSerializer, OwnedObjectSerializer):),)def get_children(self, obj):+ filter_q = self.context.get("document_count_filter")+ if filter_q is None:+ request = self.context.get("request")+ user = getattr(request, "user", None) if request else None+ filter_q = get_document_count_filter_for_user(user)+ self.context["document_count_filter"] = filter_qserializer = TagSerializer(- obj.get_children(),+ obj.get_children_queryset()+ .select_related("owner")+ .annotate(document_count=Count("documents", filter=filter_q)),many=True,context=self.context,)diff --git a/src/documents/tests/test_tag_hierarchy.py b/src/documents/tests/test_tag_hierarchy.pyindex 73fe81786..708e3e534 100644--- a/src/documents/tests/test_tag_hierarchy.py+++ b/src/documents/tests/test_tag_hierarchy.py@@ -9,6 +9,7 @@ from documents.models import Tagfrom documents.models import Workflowfrom documents.models import WorkflowActionfrom documents.models import WorkflowTrigger+from documents.serialisers import TagSerializerfrom documents.signals.handlers import run_workflows@@ -121,6 +122,31 @@ class TestTagHierarchy(APITestCase):tags = set(self.document.tags.values_list("pk", flat=True))assert tags == {self.parent.pk, orphan.pk}+ def test_child_document_count_included_when_parent_paginated(self):+ self.document.tags.add(self.child)++ response = self.client.get(+ "/api/tags/",+ {"page_size": 1, "ordering": "-name"},+ )++ assert response.status_code == 200+ assert response.data["results"][0]["id"] == self.parent.pk++ children = response.data["results"][0]["children"]+ assert len(children) == 1++ child_entry = children[0]+ assert child_entry["id"] == self.child.pk+ assert child_entry["document_count"] == 1++ def test_tag_serializer_populates_document_filter_context(self):+ context = {}++ serializer = TagSerializer(self.parent, context=context)+ assert serializer.data # triggers serialization+ assert "document_count_filter" in context+def test_cannot_set_parent_to_self(self):tag = Tag.objects.create(name="Selfie")resp = self.client.patch(diff --git a/src/documents/views.py b/src/documents/views.pyindex 4168eba38..696311a7a 100644--- a/src/documents/views.py+++ b/src/documents/views.py@@ -141,6 +141,7 @@ from documents.permissions import AcknowledgeTasksPermissionsfrom documents.permissions import PaperlessAdminPermissionsfrom documents.permissions import PaperlessNotePermissionsfrom documents.permissions import PaperlessObjectPermissions+from documents.permissions import get_document_count_filter_for_userfrom documents.permissions import get_objects_for_user_owner_awarefrom documents.permissions import has_perms_owner_awarefrom documents.permissions import set_permissions_for_object@@ -364,21 +365,13 @@ class PermissionsAwareDocumentCountMixin(BulkPermissionMixin, PassUserMixin):Mixin to add document count to queryset, permissions-aware if needed"""+ def get_document_count_filter(self):+ request = getattr(self, "request", None)+ user = getattr(request, "user", None) if request else None+ return get_document_count_filter_for_user(user)+def get_queryset(self):- filter = (- Q(documents__deleted_at__isnull=True)- if self.request.user is None or self.request.user.is_superuser- else (- Q(- documents__deleted_at__isnull=True,- documents__id__in=get_objects_for_user_owner_aware(- self.request.user,- "documents.view_document",- Document,- ).values_list("id", flat=True),- )- )- )+ filter = self.get_document_count_filter()return (super().get_queryset()@@ -447,6 +440,11 @@ class TagViewSet(ModelViewSet, PermissionsAwareDocumentCountMixin):filterset_class = TagFilterSetordering_fields = ("color", "name", "matching_algorithm", "match", "document_count")+ def get_serializer_context(self):+ context = super().get_serializer_context()+ context["document_count_filter"] = self.get_document_count_filter()+ return context+def perform_update(self, serializer):old_parent = self.get_object().get_parent()tag = serializer.save()