feat: Indent page titles according to tree structure (#246)

fsbraun · sourcery-ai[bot] · web-flow · commit a850f2acc3e4 · 2025-07-15T14:30:56.000+02:00
* feat: Add indentation for the Page model to reflect tree structure in link target dropdown

* Fix tests

* Fix type annotations

* Update readme

* Update trove classifiers

* Show page titles in current language

* Add tests

* Bump verision

* Update tests/test_endpoint.py

Co-authored-by: sourcery-ai[bot] &lt;58596630+sourcery-ai[bot]@users.noreply.github.com&gt;

* Fix tests

* Fix 3.11 compat

* Update tests/test_endpoint.py

Co-authored-by: sourcery-ai[bot] &lt;58596630+sourcery-ai[bot]@users.noreply.github.com&gt;

* Fix tests

* Fix condition in tests

* Depth calculation for djagnio CMS &lt; 5

* Fix for 3.11

* Fix 4.1

* Minor simplification

* Fix for 3.11

* fix: Consistent internal link

* Fix site treatment

* Fix linting

* Fix merge conflict

* fix coverage

* fix: permission tests

---------

Co-authored-by: sourcery-ai[bot] &lt;58596630+sourcery-ai[bot]@users.noreply.github.com&gt;
diff --git a/README.rst b/README.rst
@@ -305,4 +305,3 @@ the database. If you encounter any issues, please report them on
 .. |djangocms| image:: https://img.shields.io/pypi/frameworkversions/django-cms/djangocms-link
     :alt: PyPI - django CMS Versions from Framework Classifiers
     :target: https://www.django-cms.org/
-
diff --git a/conftest.py b/conftest.py
@@ -69,7 +69,23 @@
 ] + CMS_MIDDLEWARE
 SITE_ID = 1
 LANGUAGE_CODE = "en"
-LANGUAGES = (("en", "English"),)
+LANGUAGES = (("en", "English"), ("fr", "French"))
+CMS_LANGUAGES = {
+    1: [
+        {
+            "code": "en",
+            "name": "English",
+            "public": True,
+        },
+        {
+            "code": "fr",
+            "name": "French",
+            "public": True,
+            "fallbacks": ["en"],
+            "hide_untranslated": False,
+        },
+    ]
+}
 STATIC_URL = "/static/"
 MEDIA_URL = "/media/"
 MIGRATION_MODULES = {}
diff --git a/djangocms_link/__init__.py b/djangocms_link/__init__.py
@@ -1 +1 @@
-__version__ = "5.0.1"
+__version__ = "5.1.0"
diff --git a/djangocms_link/admin.py b/djangocms_link/admin.py
@@ -1,9 +1,11 @@
+from __future__ import annotations
+
 from django.apps import apps
 from django.conf import settings
 from django.contrib import admin
-from django.core.exceptions import FieldError, PermissionDenied
-from django.db.models import OuterRef, Q, Subquery
-from django.http import Http404, JsonResponse
+from django.core.exceptions import PermissionDenied
+from django.db.models import F, Model, Prefetch, Q, QuerySet
+from django.http import Http404, HttpRequest, JsonResponse
 from django.urls import path
 from django.utils.translation import gettext as _
 from django.views.generic.list import BaseListView
@@ -17,6 +19,9 @@
 from .helpers import get_manager
 
 
+UNICODE_SPACE = "\u3000"  # This is a full-width space character (U+3000)
+
+
 _version = int(__version__.split(".")[0])
 if _version >= 4:
     from cms.admin.utils import GrouperModelAdmin
@@ -37,7 +42,7 @@ class AdminUrlsView(BaseListView):
     paginate_by = getattr(settings, "DJANGOCMS_LINK_PAGINATE_BY", 50)
     admin_site = None
 
-    def get(self, request, *args, **kwargs):
+    def get(self, request: HttpRequest, *args, **kwargs) -> JsonResponse:
         """
         Return a JsonResponse with search results (query parameter "q") usable by
         Django admin's autocomplete view. Each item is returned as defined in
@@ -90,7 +95,7 @@ def get(self, request, *args, **kwargs):
             }
         )
 
-    def get_page(self):
+    def get_page(self) -> int:
         page_kwarg = self.page_kwarg
         page = self.kwargs.get(page_kwarg) or self.request.GET.get(page_kwarg) or 1
         try:
@@ -101,7 +106,7 @@ def get_page(self):
             )
         return page_number
 
-    def get_paginated_multi_qs(self, qs_list):
+    def get_paginated_multi_qs(self, qs_list: list[QuerySet]) -> list[Model] | QuerySet:
         """
         Paginate multiple querysets and return a result list.
         """
@@ -110,19 +115,34 @@ def get_paginated_multi_qs(self, qs_list):
             return qs_list[0]
         # Slize all querysets, evaluate and join them into a list
         max_items = self.get_page() * self.paginate_by
-        return sum((list(qs[:max_items]) for qs in qs_list), start=[])
-
-    def get_reference(self, request):
+        objects = []
+        for qs in qs_list:
+            for item in qs:
+                if self.has_perm(self.request, item):
+                    objects.append(item)
+
+            if len(objects) >= max_items:
+                # No need to touch the rest of the querysets
+                # as we have enough items already
+                break
+        return objects
+
+    def get_reference(self, request: HttpRequest) -> JsonResponse:
         try:
             model_str, pk = request.GET.get("g").split(":")
             app, model = model_str.split(".")
             model = apps.get_model(app, model)
             model_admin = self.admin_site._registry.get(model)
+            language = get_language_from_request(request)
+
             if model_str == "cms.page" and _version >= 4 or model_admin is None:
                 obj = get_manager(model).get(pk=pk)
                 if model_str == "cms.page":
-                    language = get_language_from_request(request)
-                    obj.__link_text__ = obj.get_admin_content(language).title
+                    obj.__link_text__ = obj.get_admin_content(language, fallback=True).title
+                return JsonResponse(self.serialize_result(obj))
+            elif model_str == "cms.page":
+                obj = get_manager(model).get(pk=pk)
+                obj.__link_text__ = obj.get_title(language, fallback=True)
                 return JsonResponse(self.serialize_result(obj))
 
             if hasattr(model_admin, "get_link_queryset"):
@@ -151,43 +171,54 @@ def get_optgroups(self, context):
             results.append(model)
         return results
 
-    def serialize_result(self, obj):
+    def serialize_result(self, obj: Model) -> dict:
         """
         Convert the provided model object to a dictionary that is added to the
         results list.
         """
+        if isinstance(obj, Page) and hasattr(obj, "prefetched_content") and hasattr(obj, "get_admin_content"):
+            obj.admin_content_cache = {trans.language: trans for trans in obj.prefetched_content}
+            obj.__link_text__ = obj.get_admin_content(self.language).title
+
+        indentation = UNICODE_SPACE * (max(getattr(obj, "__depth__", 1), 1) - 1)
         return {
             "id": f"{obj._meta.app_label}.{obj._meta.model_name}:{obj.pk}",
-            "text": getattr(obj, "__link_text__", str(obj)) or str(obj),
+            "text": indentation + (getattr(obj, "__link_text__", str(obj)) or str(obj)),
             "url": obj.get_absolute_url(),
             "verbose_name": str(obj._meta.verbose_name).capitalize(),
         }
 
-    def get_queryset(self):
+    def get_queryset(self) -> QuerySet:
         """Return queryset based on ModelAdmin.get_search_results()."""
         languages = get_language_list()
         try:
-            # django CMS 5.0+
-            qs = (
+            # django CMS 4.1/5.0+
+            content_qs = (
                 PageContent.admin_manager.filter(language__in=languages)
                 .filter(
                     Q(title__icontains=self.term) | Q(menu_title__icontains=self.term)
                 )
                 .current_content()
             )
             qs = (
-                Page.objects.filter(pk__in=qs.values_list("page_id", flat=True))
-                .order_by("path")
-                .annotate(
-                    __link_text__=Subquery(
-                        qs.filter(page_id=OuterRef("pk")).values("title")[:1]
-                    )
+                Page.objects.filter(pk__in=content_qs.values_list("page_id", flat=True))
+                .order_by("path" if _version >= 5 else "node__path")
+                .prefetch_related(
+                    Prefetch(
+                        "pagecontent_set",
+                        to_attr="prefetched_content",
+                        queryset=PageContent.admin_manager.current_content(),
+                    ),
                 )
             )
+            if not self.term:
+                qs = qs.annotate(
+                    __depth__=F("depth" if _version >= 5 else "node__depth")
+                )
             if self.site:
-                qs = qs.filter(site_id=self.site)
-        except (AttributeError, FieldError):
-            # django CMS 3.11 - 4.1
+                qs = qs.filter(site_id=self.site) if _version >= 5 else qs.filter(node__site_id=self.site)
+        except (AttributeError,):
+            # django CMS 3.11
             qs = (
                 get_manager(PageContent, current_content=True)
                 .filter(language__in=languages)
@@ -198,20 +229,27 @@ def get_queryset(self):
             qs = (
                 Page.objects.filter(pk__in=qs.values_list("page_id", flat=True))
                 .order_by("node__path")
-                .annotate(
-                    __link_text__=Subquery(
-                        qs.filter(page_id=OuterRef("pk")).values("title")[:1]
-                    )
+                .prefetch_related(
+                    Prefetch(
+                        "title_set",
+                        to_attr="prefetched_content",
+                        queryset=get_manager(PageContent, current_content=True).all(),
+                    ),
                 )
             )
             if "publisher_draft" in Page._meta.fields_map:
                 # django CMS 3.11
                 qs = qs.filter(publisher_is_draft=True)
+            if not self.term:
+                qs = qs.annotate(
+                    __depth__=F("node__depth")
+                )
+
             if self.site:
                 qs = qs.filter(node__site_id=self.site)
         return qs
 
-    def add_admin_querysets(self, qs):
+    def add_admin_querysets(self, qs: list[QuerySet]) -> None:
         for model_admin in REGISTERED_ADMIN:
             try:
                 # hack: GrouperModelAdmin expects a language to be temporarily set
@@ -229,20 +267,17 @@ def add_admin_querysets(self, qs):
                         )
                     elif hasattr(model_admin.model, "sites") and self.site:
                         new_qs = new_qs.filter(sites__id=self.site)
-                new_qs, search_use_distinct = model_admin.get_search_results(
-                    self.request, new_qs, self.term
-                )
+                new_qs, search_use_distinct = model_admin.get_search_results(self.request, new_qs, self.term)
                 if search_use_distinct:  # pragma: no cover
                     new_qs = new_qs.distinct()
-
                 qs.append(new_qs)
             except Exception:  # pragma: no cover
                 # Still report back remaining urls even if one model fails
                 pass
 
         return qs
 
-    def process_request(self, request):
+    def process_request(self, request: HttpRequest) -> tuple[str, str, int | None]:
         """
         Validate request integrity, extract and return request parameters.
         """
@@ -257,7 +292,7 @@ def process_request(self, request):
         language = get_language_from_request(request)
         return term, language, site
 
-    def has_perm(self, request, obj=None):
+    def has_perm(self, request: HttpRequest, obj=None) -> bool:
         """Check if user has permission to access the related model."""
         if obj is None:
             return True
@@ -279,11 +314,11 @@ def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self.global_link_url_name = f"{self.opts.app_label}_{self.opts.model_name}_urls"
 
-    def has_module_permission(self, request):  # pragma: no cover
+    def has_module_permission(self, request: HttpRequest) -> bool:  # pragma: no cover
         # Remove from admin
         return False
 
-    def get_urls(self):
+    def get_urls(self) -> list:
         # Only url endpoint public, do not call super().get_urls()
         return [
             path(
@@ -293,7 +328,7 @@ def get_urls(self):
             ),
         ]
 
-    def url_view(self, request):
+    def url_view(self, request: HttpRequest) -> JsonResponse:
         return AdminUrlsView.as_view(admin_site=self.admin_site)(request)
 
 
diff --git a/djangocms_link/helpers.py b/djangocms_link/helpers.py
@@ -89,17 +89,17 @@ def __init__(self, initial=None, **kwargs):
                 self["internal_link"] = (
                     f"{initial._meta.app_label}.{initial._meta.model_name}:{initial.pk}"
                 )
+                # Prepopulate cache since we have to object to get the URL
                 self["__cache__"] = initial.get_absolute_url()
-                if anchor:
-                    self["anchor"] = anchor
+                if self["__cache__"] and anchor:
                     self["__cache__"] += anchor
 
     @property
-    def url(self):
+    def url(self) -> str:
         return get_link(self) or ""
 
     @property
-    def type(self):
+    def type(self) -> str:
         for key in ("internal_link", "file_link"):
             if key in self:
                 return key
diff --git a/pyproject.toml b/pyproject.toml
@@ -23,10 +23,12 @@ classifiers = [
   "Framework :: Django :: 4.2",
   "Framework :: Django :: 5.0",
   "Framework :: Django :: 5.1",
+  "Framework :: Django :: 5.2",
   "Framework :: Django CMS",
   "Framework :: Django CMS :: 3.11",
   "Framework :: Django CMS :: 4.0",
   "Framework :: Django CMS :: 4.1",
+  "Framework :: Django CMS :: 5.0",
   "Intended Audience :: Developers",
   "License :: OSI Approved :: BSD License",
   "Operating System :: OS Independent",
@@ -58,6 +60,11 @@ version = { attr = "djangocms_link.__version__" }
 [tool.setuptools.package-data]
 djangocms_link = [ "static/**/*", "templates/**/*", "locale/**/*", "LICENSE", "README.rst" ]
 
+[tool.ruff]
+exclude = [
+  "djangocms_link/migrations/*",
+]
+
 [tool.isort]
 line_length = 119
 skip = [
diff --git a/tests/settings.py b/tests/settings.py
@@ -7,15 +7,6 @@
         "filer",
         "tests.utils",
     ],
-    "CMS_LANGUAGES": {
-        1: [
-            {
-                "code": "en",
-                "name": "English",
-            }
-        ]
-    },
-    "LANGUAGE_CODE": "en",
     "THUMBNAIL_PROCESSORS": (
         "easy_thumbnails.processors.colorspace",
         "easy_thumbnails.processors.autocrop",
diff --git a/tests/test_endpoint.py b/tests/test_endpoint.py
diff --git a/tests/test_link_dict.py b/tests/test_link_dict.py

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-__version__ = "5.0.1"`
	`1`	`+__version__ = "5.1.0"`