wagtail 6.2.3__py3-none-any.whl → 6.3__py3-none-any.whl

wagtail/admin/views/pages/listing.py

@@ -19,7 +19,6 @@ from wagtail.admin.filters import (
     MultipleUserFilter,
     WagtailFilterSet,
 )
-from wagtail.admin.forms.search import SearchForm
 from wagtail.admin.ui.components import MediaContainer
 from wagtail.admin.ui.side_panels import (
     PageStatusSidePanel,
@@ -32,6 +31,7 @@ from wagtail.admin.ui.tables.pages import (
     PageStatusColumn,
     PageTable,
     PageTitleColumn,
+    ParentPageColumn,
 )
 from wagtail.admin.views import generic
 from wagtail.models import Page, PageLogEntry, Site, get_page_content_types
@@ -115,7 +115,7 @@ class PageFilterSet(WagtailFilterSet):
         fields = []  # only needed for filters being generated automatically
 
 
-class ExplorablePageFilterSet(PageFilterSet):
+class GenericPageFilterSet(PageFilterSet):
     content_type = MultipleContentTypeFilter(
         label=_("Page type"),
         queryset=lambda request: get_page_content_types(include_base_page_type=False),
@@ -123,29 +123,14 @@ class ExplorablePageFilterSet(PageFilterSet):
     )
 
 
-class IndexView(generic.IndexView):
-    template_name = "wagtailadmin/pages/index.html"
-    results_template_name = "wagtailadmin/pages/index_results.html"
-    permission_policy = page_permission_policy
-    any_permission_required = {
-        "add",
-        "change",
-        "publish",
-        "bulk_delete",
-        "lock",
-        "unlock",
-    }
+class PageListingMixin:
+    template_name = "wagtailadmin/pages/listing.html"
     context_object_name = "pages"
-    page_kwarg = "p"
-    paginate_by = 50
     table_class = PageTable
-    table_classname = "listing full-width"
-    filterset_class = PageFilterSet
-    index_url_name = None
-    index_results_url_name = None
+    filterset_class = GenericPageFilterSet
     default_ordering = "-latest_revision_created_at"
     model = Page
-    _show_breadcrumbs = True
+    is_searchable = True
 
     columns = [
         BulkActionsColumn("bulk_actions"),
@@ -155,12 +140,20 @@ class IndexView(generic.IndexView):
             sort_key="title",
             classname="title",
         ),
+        ParentPageColumn("parent", label=_("Parent")),
         DateColumn(
             "latest_revision_created_at",
             label=_("Updated"),
             sort_key="latest_revision_created_at",
             width="12%",
         ),
+        Column(
+            "type",
+            label=_("Type"),
+            accessor="page_type_display_name",
+            sort_key="content_type",
+            width="12%",
+        ),
         PageStatusColumn(
             "status",
             label=_("Status"),
@@ -169,21 +162,13 @@ class IndexView(generic.IndexView):
         ),
     ]
 
-    def get(self, request):
-        # Search
-        self.query_string = None
-        self.is_searching = False
-        if "q" in self.request.GET:
-            self.search_form = SearchForm(self.request.GET)
-            if self.search_form.is_valid():
-                self.query_string = self.search_form.cleaned_data["q"]
-        else:
-            self.search_form = SearchForm()
-
-        if self.query_string:
-            self.is_searching = True
+    @cached_property
+    def i18n_enabled(self):
+        return getattr(settings, "WAGTAIL_I18N_ENABLED", False)
 
-        return super().get(request)
+    @cached_property
+    def show_locale_labels(self):
+        return self.i18n_enabled
 
     def get_valid_orderings(self):
         valid_orderings = super().get_valid_orderings()
@@ -212,17 +197,8 @@ class IndexView(generic.IndexView):
 
         return ordering
 
-    def get_base_queryset(self):
-        pages = self.model.objects.filter(depth__gt=1)
-        pages = self._annotate_queryset(pages)
-        return pages
-
-    def _annotate_queryset(self, pages):
-        pages = pages.prefetch_related("content_type", "sites_rooted_here").filter(
-            pk__in=self.permission_policy.explorable_instances(
-                self.request.user
-            ).values_list("pk", flat=True)
-        )
+    def annotate_queryset(self, pages):
+        pages = pages.prefetch_related("content_type", "sites_rooted_here")
 
         # We want specific page instances, but do not need streamfield values here
         pages = pages.defer_streamfields().specific()
@@ -230,6 +206,8 @@ class IndexView(generic.IndexView):
         # Annotate queryset with various states to be used later for performance optimisations
         if getattr(settings, "WAGTAIL_WORKFLOW_ENABLED", True):
             pages = pages.prefetch_workflow_states()
+        if self.i18n_enabled:
+            pages = pages.prefetch_related("locale").annotate_has_untranslated_locale()
 
         pages = pages.annotate_site_root_state().annotate_approved_schedule()
 
@@ -268,38 +246,56 @@ class IndexView(generic.IndexView):
     def search_queryset(self, queryset):
         if self.is_searching:
             queryset = queryset.autocomplete(
-                self.query_string, order_by_relevance=(not self.is_explicitly_ordered)
+                self.search_query, order_by_relevance=(not self.is_explicitly_ordered)
             )
 
         return queryset
 
-    def get_index_url(self):
-        return reverse(self.index_url_name)
-
-    def get_index_results_url(self):
-        return reverse(self.index_results_url_name)
-
-    def get_breadcrumbs_items(self):
-        return self.breadcrumbs_items + [{"url": "", "label": self.get_page_title()}]
-
     def get_table_kwargs(self):
         kwargs = super().get_table_kwargs()
         kwargs["actions_next_url"] = self.index_url
+        kwargs["show_locale_labels"] = self.show_locale_labels
         return kwargs
 
     def get_context_data(self, **kwargs):
         context = super().get_context_data(**kwargs)
 
-        context.update(
-            {
-                "ordering": self.ordering,
-                "search_form": self.search_form,
-                "is_searching": self.is_searching,
-            }
-        )
+        if any(isinstance(column, ParentPageColumn) for column in self.columns):
+            Page.objects.annotate_parent_page(context["object_list"])
+
         return context
 
 
+class IndexView(PageListingMixin, generic.IndexView):
+    permission_policy = page_permission_policy
+    any_permission_required = {
+        "add",
+        "change",
+        "publish",
+        "bulk_delete",
+        "lock",
+        "unlock",
+    }
+    template_name = "wagtailadmin/pages/index.html"
+    results_template_name = "wagtailadmin/pages/index_results.html"
+    paginate_by = 50
+    table_classname = "listing full-width"
+    filterset_class = PageFilterSet
+
+    @classproperty
+    def columns(cls):
+        return [col for col in PageListingMixin.columns if col.name != "type"]
+
+    def get_base_queryset(self):
+        pages = self.model.objects.filter(depth__gt=1).filter(
+            pk__in=page_permission_policy.explorable_instances(
+                self.request.user
+            ).values_list("pk", flat=True)
+        )
+        pages = self.annotate_queryset(pages)
+        return pages
+
+
 class ExplorableIndexView(IndexView):
     """
     A version of the page listing where the user is presented with a view of a specified parent page;
@@ -308,24 +304,15 @@ class ExplorableIndexView(IndexView):
     """
 
     template_name = "wagtailadmin/pages/explorable_index.html"
+    results_template_name = "wagtailadmin/pages/explorable_index_results.html"
     index_url_name = "wagtailadmin_explore"
     index_results_url_name = "wagtailadmin_explore_results"
     page_title = _("Exploring")
-    filterset_class = ExplorablePageFilterSet
+    filterset_class = GenericPageFilterSet
 
     @classproperty
     def columns(cls):
-        columns = super().columns.copy()
-        columns.insert(
-            3,
-            Column(
-                "type",
-                label=_("Type"),
-                accessor="page_type_display_name",
-                sort_key="content_type",
-                width="12%",
-            ),
-        )
+        columns = [col for col in PageListingMixin.columns if col.name != "parent"]
         columns.append(NavigateToChildrenColumn("navigate", width="10%"))
         return columns
 
@@ -351,7 +338,6 @@ class ExplorableIndexView(IndexView):
         self.parent_page = self.parent_page.specific
         self.scheduled_page = self.parent_page.get_scheduled_revision_as_object()
 
-        self.i18n_enabled = getattr(settings, "WAGTAIL_I18N_ENABLED", False)
         if self.i18n_enabled and not self.parent_page.is_root():
             self.locale = self.parent_page.locale
             self.translations = self.get_translations()
@@ -367,6 +353,10 @@ class ExplorableIndexView(IndexView):
             self.is_searching or self.is_filtering
         )
 
+    @cached_property
+    def show_locale_labels(self):
+        return self.i18n_enabled and self.parent_page.is_root()
+
     def get_base_queryset(self):
         if self.is_searching or self.is_filtering:
             if self.is_searching_whole_tree:
@@ -376,7 +366,12 @@ class ExplorableIndexView(IndexView):
         else:
             pages = self.parent_page.get_children()
 
-        pages = self._annotate_queryset(pages)
+        pages = pages.filter(
+            pk__in=page_permission_policy.explorable_instances(
+                self.request.user
+            ).values_list("pk", flat=True)
+        )
+        pages = self.annotate_queryset(pages)
         return pages
 
     def search_queryset(self, queryset):
@@ -402,7 +397,6 @@ class ExplorableIndexView(IndexView):
         kwargs = super().get_table_kwargs()
         kwargs["use_row_ordering_attributes"] = self.show_ordering_column
         kwargs["parent_page"] = self.parent_page
-        kwargs["show_locale_labels"] = self.i18n_enabled and self.parent_page.is_root()
 
         if self.show_ordering_column:
             kwargs["caption"] = _(
@@ -464,19 +458,12 @@ class ExplorableIndexView(IndexView):
         context = super().get_context_data(**kwargs)
 
         if self.is_searching:
-            # postprocess this page of results to annotate each result with its parent page
-            parent_page_paths = {
-                page.path[: -page.steplen] for page in context["object_list"]
-            }
-            parent_pages_by_path = {
-                page.path: page
-                for page in Page.objects.filter(path__in=parent_page_paths).specific()
-            }
+            Page.objects.annotate_parent_page(context["object_list"])
             for page in context["object_list"]:
-                parent_page = parent_pages_by_path.get(page.path[: -page.steplen])
                 # add annotation if parent page is found and is not the currently viewed parent
-                if parent_page and parent_page != self.parent_page:
-                    page.annotated_parent_page = parent_page
+                # to be used by PageTitleColumn instead of a dedicated ParentPageColumn
+                if page._parent_page and page._parent_page != self.parent_page:
+                    page.annotated_parent_page = page._parent_page
 
         context.update(
             {

wagtail/admin/views/pages/preview.py

@@ -14,7 +14,7 @@ def view_draft(request, page_id):
         raise PermissionDenied
 
     try:
-        preview_mode = page.default_preview_mode
+        preview_mode = request.GET.get("mode", page.default_preview_mode)
     except IndexError:
         raise PermissionDenied
 

wagtail/admin/views/pages/search.py

@@ -1,23 +1,17 @@
-from typing import Any, Dict
+from typing import Any
 
-from django.conf import settings
 from django.contrib.contenttypes.models import ContentType
 from django.db.models.query import QuerySet
 from django.http import Http404
+from django.utils.functional import classproperty
 from django.utils.translation import gettext_lazy as _
 
-from wagtail.admin.forms.search import SearchForm
-from wagtail.admin.ui.tables import Column, DateColumn
 from wagtail.admin.ui.tables.pages import (
-    BulkActionsColumn,
     NavigateToChildrenColumn,
-    PageStatusColumn,
-    PageTable,
-    PageTitleColumn,
-    ParentPageColumn,
 )
 from wagtail.admin.views.generic.base import BaseListingView
 from wagtail.admin.views.generic.permissions import PermissionCheckedMixin
+from wagtail.admin.views.pages.listing import PageListingMixin
 from wagtail.models import Page
 from wagtail.permissions import page_permission_policy
 from wagtail.search.query import MATCH_ALL
@@ -49,7 +43,7 @@ def page_filter_search(q, pages, all_pages=None, ordering=None):
     return pages, all_pages
 
 
-class BaseSearchView(PermissionCheckedMixin, BaseListingView):
+class SearchView(PageListingMixin, PermissionCheckedMixin, BaseListingView):
     permission_policy = page_permission_policy
     any_permission_required = {
         "add",
@@ -60,43 +54,24 @@ class BaseSearchView(PermissionCheckedMixin, BaseListingView):
         "unlock",
     }
     paginate_by = 20
-    page_kwarg = "p"
-    context_object_name = "pages"
-    table_class = PageTable
+    page_title = _("Search")
+    header_icon = "search"
     index_url_name = "wagtailadmin_pages:search"
+    index_results_url_name = "wagtailadmin_pages:search_results"
+    # We override get_queryset here that has a custom search implementation
+    is_searchable = True
+    # This view has its own filtering mechanism that doesn't use django-filter
+    filterset_class = None
+    template_name = "wagtailadmin/pages/search.html"
+    results_template_name = "wagtailadmin/pages/search_results.html"
 
-    columns = [
-        BulkActionsColumn("bulk_actions"),
-        PageTitleColumn(
-            "title",
-            classname="title",
-            label=_("Title"),
-            sort_key="title",
-        ),
-        ParentPageColumn("parent", label=_("Parent")),
-        DateColumn(
-            "latest_revision_created_at",
-            label=_("Updated"),
-            sort_key="latest_revision_created_at",
-            width="12%",
-        ),
-        Column(
-            "type",
-            label=_("Type"),
-            accessor="page_type_display_name",
-            width="12%",
-        ),
-        PageStatusColumn(
-            "status",
-            label=_("Status"),
-            sort_key="live",
-            width="12%",
-        ),
-        NavigateToChildrenColumn("navigate", width="10%"),
-    ]
+    @classproperty
+    def columns(cls):
+        columns = PageListingMixin.columns.copy()
+        columns.append(NavigateToChildrenColumn("navigate", width="10%"))
+        return columns
 
     def get(self, request):
-        self.show_locale_labels = getattr(settings, "WAGTAIL_I18N_ENABLED", False)
         self.content_types = []
         self.ordering = None
 
@@ -126,13 +101,13 @@ class BaseSearchView(PermissionCheckedMixin, BaseListingView):
         else:
             self.selected_content_type = None
 
-        self.q = self.request.GET.get("q", "")
-
         return super().get(request)
 
     def get_queryset(self) -> QuerySet[Any]:
-        pages = self.all_pages = (
-            Page.objects.all().prefetch_related("content_type").specific()
+        pages = self.all_pages = Page.objects.all().filter(
+            pk__in=page_permission_policy.explorable_instances(
+                self.request.user
+            ).values_list("pk", flat=True)
         )
         if self.show_locale_labels:
             pages = pages.select_related("locale")
@@ -143,15 +118,17 @@ class BaseSearchView(PermissionCheckedMixin, BaseListingView):
         if self.selected_content_type:
             pages = pages.filter(content_type=self.selected_content_type)
 
+        pages = self.annotate_queryset(pages)
+
         # Parse query and filter
         pages, self.all_pages = page_filter_search(
-            self.q, pages, self.all_pages, self.ordering
+            self.search_query, pages, self.all_pages, self.ordering
         )
 
         # Facets
         if pages.supports_facet:
             self.content_types = [
-                (ContentType.objects.get(id=content_type_id), count)
+                (ContentType.objects.get_for_id(content_type_id), count)
                 for content_type_id, count in self.all_pages.facet(
                     "content_type_id"
                 ).items()
@@ -159,34 +136,13 @@ class BaseSearchView(PermissionCheckedMixin, BaseListingView):
 
         return pages
 
-    def get_table_kwargs(self):
-        kwargs = super().get_table_kwargs()
-        kwargs["show_locale_labels"] = self.show_locale_labels
-        kwargs["actions_next_url"] = self.get_index_url()
-        return kwargs
-
-    def get_context_data(self, **kwargs: Any) -> Dict[str, Any]:
+    def get_context_data(self, **kwargs: Any) -> dict[str, Any]:
         context = super().get_context_data(**kwargs)
         context.update(
             {
                 "all_pages": self.all_pages,
-                "query_string": self.q,
                 "content_types": self.content_types,
                 "selected_content_type": self.selected_content_type,
-                "ordering": self.ordering,
             }
         )
         return context
-
-
-class SearchView(BaseSearchView):
-    template_name = "wagtailadmin/pages/search.html"
-
-    def get_context_data(self, **kwargs: Any) -> Dict[str, Any]:
-        context = super().get_context_data(**kwargs)
-        context["search_form"] = SearchForm(self.request.GET)
-        return context
-
-
-class SearchResultsView(BaseSearchView):
-    template_name = "wagtailadmin/pages/search_results.html"

wagtail/admin/views/pages/usage.py

@@ -1,41 +1,45 @@
-from typing import Any, Dict
+from typing import Any
 
 from django.contrib.contenttypes.models import ContentType
 from django.core.exceptions import PermissionDenied
 from django.http import Http404
 from django.urls import reverse
+from django.utils.functional import cached_property, classproperty
+from django.utils.text import capfirst
+from django.utils.translation import gettext
 from django.utils.translation import gettext_lazy as _
 
-from wagtail.admin.ui.tables import Column, DateColumn
-from wagtail.admin.ui.tables.pages import (
-    PageStatusColumn,
-    PageTable,
-    PageTitleColumn,
-    ParentPageColumn,
-)
 from wagtail.admin.views import generic
 from wagtail.admin.views.generic.base import BaseListingView
+from wagtail.admin.views.generic.permissions import PermissionCheckedMixin
+from wagtail.admin.views.pages.listing import PageFilterSet, PageListingMixin
 from wagtail.admin.views.pages.utils import (
     GenericPageBreadcrumbsMixin,
 )
 from wagtail.models import Page
+from wagtail.permissions import page_permission_policy
 
 
-class ContentTypeUseView(BaseListingView):
-    results_template_name = "wagtailadmin/pages/usage_results.html"
+class ContentTypeUseView(PageListingMixin, PermissionCheckedMixin, BaseListingView):
+    permission_policy = page_permission_policy
+    any_permission_required = {
+        "add",
+        "change",
+        "publish",
+        "bulk_delete",
+        "lock",
+        "unlock",
+    }
+    index_url_name = "wagtailadmin_pages:type_use"
+    index_results_url_name = "wagtailadmin_pages:type_use_results"
     page_title = _("Pages using")
     header_icon = "doc-empty-inverse"
-    page_kwarg = "p"
     paginate_by = 50
-    columns = [
-        PageTitleColumn("title", classname="title", label=_("Title")),
-        ParentPageColumn("parent", label=_("Parent")),
-        DateColumn("latest_revision_created_at", label=_("Updated"), width="12%"),
-        Column("type", label=_("Type"), accessor="page_type_display_name", width="12%"),
-        PageStatusColumn("status", label=_("Status"), width="12%"),
-    ]
-    table_class = PageTable
-    table_classname = "listing"
+    filterset_class = PageFilterSet
+
+    @classproperty
+    def columns(cls):
+        return [col for col in PageListingMixin.columns if col.name != "type"]
 
     def get(self, request, *, content_type_app_name, content_type_model_name):
         try:
@@ -56,19 +60,54 @@ class ContentTypeUseView(BaseListingView):
     def get_page_subtitle(self):
         return self.page_class.get_verbose_name()
 
-    def get_queryset(self):
-        return self.page_class.objects.all().specific(defer=True)
+    @cached_property
+    def verbose_name_plural(self):
+        return self.page_class._meta.verbose_name_plural
+
+    def get_base_queryset(self):
+        queryset = self.page_class._default_manager.all().filter(
+            pk__in=self.permission_policy.explorable_instances(
+                self.request.user
+            ).values_list("pk", flat=True)
+        )
+        return self.annotate_queryset(queryset)
 
     def get_index_url(self):
         return reverse(
-            "wagtailadmin_pages:type_use",
+            self.index_url_name,
+            args=[
+                self.kwargs["content_type_app_name"],
+                self.kwargs["content_type_model_name"],
+            ],
+        )
+
+    def get_index_results_url(self):
+        return reverse(
+            self.index_results_url_name,
             args=[
                 self.kwargs["content_type_app_name"],
                 self.kwargs["content_type_model_name"],
             ],
         )
 
-    def get_context_data(self, **kwargs: Any) -> Dict[str, Any]:
+    def get_breadcrumbs_items(self):
+        return self.breadcrumbs_items + [
+            # Initially, this page was only accessible via the "choose page type"
+            # step of the page creation flow. However, that view might be skipped
+            # if there's only one valid page type. Since then, we've introduced
+            # the "page types usage" report, which always provides a link to this
+            # view for all page types. Use that as the parent link.
+            {
+                "url": reverse("wagtailadmin_reports:page_types_usage"),
+                "label": gettext("Page types usage"),
+            },
+            {
+                "url": self.get_index_url(),
+                "label": capfirst(self.page_class._meta.verbose_name_plural),
+            },
+        ]
+
+    def get_context_data(self, **kwargs: Any) -> dict[str, Any]:
         context = super().get_context_data(**kwargs)
         context["page_class"] = self.page_class
         return context

wagtail/admin/views/pages/utils.py

@@ -66,6 +66,7 @@ class GenericPageBreadcrumbsMixin:
         # which in most cases is the final item that links to the current view.
         # However, this can be customised in the case of generic views that are
         # nested inside another generic view.
-        return self.breadcrumbs_items + [
-            super().get_breadcrumbs_items()[-self.breadcrumbs_items_to_take]
-        ]
+        return (
+            self.breadcrumbs_items
+            + super().get_breadcrumbs_items()[-self.breadcrumbs_items_to_take :]
+        )

wagtail/admin/views/reports/base.py

@@ -13,12 +13,6 @@ class ReportView(SpreadsheetExportMixin, PermissionCheckedMixin, BaseListingView
     results_template_name = "wagtailadmin/reports/base_report_results.html"
     title = ""
     paginate_by = 50
-    _show_breadcrumbs = True
-
-    def get_breadcrumbs_items(self):
-        return super().get_breadcrumbs_items() + [
-            {"url": "", "label": self.get_page_title()}
-        ]
 
     def get_page_title(self):
         if self.page_title: