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

wagtail/admin/views/generic/models.py

@@ -8,7 +8,6 @@ from django.core.exceptions import (
     PermissionDenied,
 )
 from django.db import models, transaction
-from django.db.models import Q
 from django.db.models.constants import LOOKUP_SEP
 from django.db.models.functions import Cast
 from django.http import Http404, HttpResponseRedirect
@@ -29,7 +28,6 @@ from wagtail.actions.unpublish import UnpublishAction
 from wagtail.admin import messages
 from wagtail.admin.filters import WagtailFilterSet
 from wagtail.admin.forms.models import WagtailAdminModelForm
-from wagtail.admin.forms.search import SearchForm
 from wagtail.admin.panels import get_edit_handler
 from wagtail.admin.ui.components import Component, MediaContainer
 from wagtail.admin.ui.fields import display_class_registry
@@ -43,6 +41,7 @@ from wagtail.admin.ui.tables import (
 from wagtail.admin.utils import get_latest_str, get_valid_next_url_from_request
 from wagtail.admin.views.mixins import SpreadsheetExportMixin
 from wagtail.admin.widgets.button import (
+    Button,
     ButtonWithDropdown,
     HeaderButton,
     ListingButton,
@@ -51,8 +50,8 @@ from wagtail.log_actions import log
 from wagtail.log_actions import registry as log_registry
 from wagtail.models import DraftStateMixin, Locale, ReferenceIndex
 from wagtail.models.audit_log import ModelLogEntry
-from wagtail.search.backends import get_search_backend
 from wagtail.search.index import class_is_indexed
+from wagtail.utils.deprecation import RemovedInWagtail70Warning
 
 from .base import BaseListingView, WagtailAdminTemplateMixin
 from .mixins import BeforeAfterHookMixin, HookResponseMixin, LocaleMixin, PanelMixin
@@ -74,57 +73,40 @@ class IndexView(
     inspect_url_name = None
     delete_url_name = None
     any_permission_required = ["add", "change", "delete", "view"]
-    search_fields = None
-    search_backend_name = "default"
-    is_searchable = None
-    search_kwarg = "q"
     columns = None  # If not explicitly specified, will be derived from list_display
     list_display = ["__str__", UpdatedAtColumn()]
     list_filter = None
     show_other_searches = False
 
-    def setup(self, request, *args, **kwargs):
-        super().setup(request, *args, **kwargs)
-
-        if not self.filterset_class:
-            # Allow filterset_class to be dynamically constructed from list_filter
-            self.filterset_class = self.get_filterset_class()
-
-        self.setup_search()
-
-    def setup_search(self):
-        self.is_searchable = self.get_is_searchable()
-        self.search_url = self.get_search_url()
-        self.search_form = self.get_search_form()
-        self.is_searching = False
-        self.search_query = None
-
-        if self.search_form and self.search_form.is_valid():
-            self.search_query = self.search_form.cleaned_data[self.search_kwarg]
-            self.is_searching = bool(self.search_query)
-
-    def get_is_searchable(self):
-        if self.model is None:
-            return False
-        if self.is_searchable is None:
-            return class_is_indexed(self.model) or self.search_fields
-        return self.is_searchable
-
     def get_search_url(self):
-        if not self.is_searchable:
-            return None
+        # This is only used by views that do not use breadcrumbs, thus uses the
+        # legacy header.html. The search in that header template accepts both
+        # the search_url (which really should be search_url_name) and the
+        # index_results_url. This means we can advise using the latter instead,
+        # without having to instruct how to set up breadcrumbs.
+        warnings.warn(
+            "`IndexView.get_search_url` is deprecated. "
+            "Use `IndexView.get_index_results_url` instead.",
+            RemovedInWagtail70Warning,
+        )
         return self.index_url_name
 
-    def get_search_form(self):
-        if self.model is None or not self.is_searchable:
-            return None
+    @cached_property
+    def search_url(self):
+        return self.get_search_url()
 
-        if self.is_searchable and self.search_kwarg in self.request.GET:
-            return SearchForm(self.request.GET)
+    @cached_property
+    def is_searchable(self):
+        # Do not automatically enable search if the model is not indexed and
+        # search_fields is not defined.
+        if not (self.model and class_is_indexed(self.model)) and not self.search_fields:
+            return False
 
-        return SearchForm()
+        # Require the results-only view to be set up before enabling search
+        return bool(self.index_results_url or self.search_url)
 
-    def get_filterset_class(self):
+    @cached_property
+    def filterset_class(self):
         # Allow filterset_class to be dynamically constructed from list_filter.
 
         # If the model is translatable, ensure a ``WagtailFilterSet`` subclass
@@ -197,43 +179,6 @@ class IndexView(
 
             return queryset
 
-    def get_queryset(self):
-        queryset = super().get_queryset()
-        queryset = self.search_queryset(queryset)
-        return queryset
-
-    def search_queryset(self, queryset):
-        if not self.is_searching:
-            return queryset
-
-        if class_is_indexed(queryset.model) and self.search_backend_name:
-            search_backend = get_search_backend(self.search_backend_name)
-            if queryset.model.get_autocomplete_search_fields():
-                return search_backend.autocomplete(
-                    self.search_query,
-                    queryset,
-                    fields=self.search_fields,
-                    order_by_relevance=(not self.is_explicitly_ordered),
-                )
-            else:
-                # fall back on non-autocompleting search
-                warnings.warn(
-                    f"{queryset.model} is defined as Indexable but does not specify "
-                    "any AutocompleteFields. Searches within the admin will only "
-                    "respond to complete words.",
-                    category=RuntimeWarning,
-                )
-                return search_backend.search(
-                    self.search_query,
-                    queryset,
-                    fields=self.search_fields,
-                    order_by_relevance=(not self.is_explicitly_ordered),
-                )
-        query = Q()
-        for field in self.search_fields or []:
-            query |= Q(**{field + "__icontains": self.search_query})
-        return queryset.filter(query)
-
     def _get_title_column_class(self, column_class):
         if not issubclass(column_class, ButtonsColumnMixin):
 
@@ -356,13 +301,6 @@ class IndexView(
             return capfirst(self.model._meta.verbose_name_plural)
         return self.page_title
 
-    def get_breadcrumbs_items(self):
-        if not self.model:
-            return self.breadcrumbs_items
-        return self.breadcrumbs_items + [
-            {"url": "", "label": capfirst(self.model._meta.verbose_name_plural)},
-        ]
-
     @cached_property
     def header_buttons(self):
         buttons = []
@@ -453,6 +391,12 @@ class IndexView(
             )
         return _("Add")
 
+    @cached_property
+    def verbose_name_plural(self):
+        if self.model:
+            return self.model._meta.verbose_name_plural
+        return None
+
     def get_context_data(self, *args, **kwargs):
         context = super().get_context_data(*args, **kwargs)
 
@@ -461,11 +405,12 @@ class IndexView(
             context["add_url"] = context["header_action_url"] = self.add_url
             context["header_action_label"] = self.add_item_label
 
-        context["is_searchable"] = self.is_searchable
-        context["search_url"] = self.get_search_url()
-        context["search_form"] = self.search_form
-        context["is_searching"] = self.is_searching
-        context["query_string"] = self.search_query
+        # RemovedInWagtail70Warning:
+        # Remove these in favor of using search_form and index_results_url
+        if self.is_searchable and not self.index_results_url:
+            context["is_searchable"] = self.is_searchable
+            context["search_url"] = self.search_url
+
         context["model_opts"] = self.model and self.model._meta
         return context
 
@@ -498,6 +443,7 @@ class CreateView(
         "The %(model_name)s could not be created due to errors."
     )
     submit_button_label = gettext_lazy("Create")
+    submit_button_active_label = gettext_lazy("Creating…")
     actions = ["create"]
 
     def setup(self, request, *args, **kwargs):
@@ -588,14 +534,20 @@ class CreateView(
             % {"model_name": self.model and self.model._meta.verbose_name}
         )
 
+    @cached_property
+    def has_unsaved_changes(self):
+        return self.form.is_bound
+
     def get_context_data(self, **kwargs):
         context = super().get_context_data(**kwargs)
         self.form = context.get("form")
         side_panels = self.get_side_panels()
         context["action_url"] = self.add_url
         context["submit_button_label"] = self.submit_button_label
+        context["submit_button_active_label"] = self.submit_button_active_label
         context["side_panels"] = side_panels
         context["media"] += side_panels.media
+        context["has_unsaved_changes"] = self.has_unsaved_changes
         return context
 
     def get_side_panels(self):
@@ -705,8 +657,10 @@ class EditView(
     form_class = None
     index_url_name = None
     edit_url_name = None
+    copy_url_name = None
     delete_url_name = None
     history_url_name = None
+    inspect_url_name = None
     usage_url_name = None
     page_title = gettext_lazy("Editing")
     context_object_name = None
@@ -716,6 +670,7 @@ class EditView(
     success_message = gettext_lazy("%(model_name)s '%(object)s' updated.")
     error_message = gettext_lazy("The %(model_name)s could not be saved due to errors.")
     submit_button_label = gettext_lazy("Save")
+    submit_button_active_label = gettext_lazy("Saving…")
     actions = ["edit"]
 
     def setup(self, request, *args, **kwargs):
@@ -779,6 +734,42 @@ class EditView(
             .first()
         )
 
+    @cached_property
+    def can_delete(self):
+        return self.user_has_permission_for_instance("delete", self.object)
+
+    @cached_property
+    def header_more_buttons(self):
+        buttons = []
+        if copy_url := self.get_copy_url():
+            buttons.append(
+                Button(
+                    _("Copy"),
+                    url=copy_url,
+                    icon_name="copy",
+                    priority=10,
+                )
+            )
+        if self.can_delete and (delete_url := self.get_delete_url()):
+            buttons.append(
+                Button(
+                    self.delete_item_label,
+                    url=delete_url,
+                    icon_name="bin",
+                    priority=20,
+                )
+            )
+        if inspect_url := self.get_inspect_url():
+            buttons.append(
+                Button(
+                    _("Inspect"),
+                    url=inspect_url,
+                    icon_name="info-circle",
+                    priority=30,
+                )
+            )
+        return buttons
+
     def get_edit_url(self):
         if not self.edit_url_name:
             raise ImproperlyConfigured(
@@ -787,6 +778,10 @@ class EditView(
             )
         return reverse(self.edit_url_name, args=(quote(self.object.pk),))
 
+    def get_copy_url(self):
+        if self.copy_url_name and self.user_has_permission("add"):
+            return reverse(self.copy_url_name, args=(quote(self.object.pk),))
+
     def get_delete_url(self):
         if self.delete_url_name:
             return reverse(self.delete_url_name, args=(quote(self.object.pk),))
@@ -795,6 +790,10 @@ class EditView(
         if self.history_url_name:
             return reverse(self.history_url_name, args=(quote(self.object.pk),))
 
+    def get_inspect_url(self):
+        if self.inspect_url_name:
+            return reverse(self.inspect_url_name, args=(quote(self.object.pk),))
+
     def get_usage_url(self):
         if self.usage_url_name:
             return reverse(self.usage_url_name, args=[quote(self.object.pk)])
@@ -895,6 +894,10 @@ class EditView(
             messages.validation_error(self.request, error_message, form)
         return super().form_invalid(form)
 
+    @cached_property
+    def has_unsaved_changes(self):
+        return self.form.is_bound
+
     def get_context_data(self, **kwargs):
         context = super().get_context_data(**kwargs)
         self.form = context.get("form")
@@ -904,9 +907,9 @@ class EditView(
         context["side_panels"] = side_panels
         context["media"] += side_panels.media
         context["submit_button_label"] = self.submit_button_label
-        context["can_delete"] = self.user_has_permission_for_instance(
-            "delete", self.object
-        )
+        context["submit_button_active_label"] = self.submit_button_active_label
+        context["has_unsaved_changes"] = self.has_unsaved_changes
+        context["can_delete"] = self.can_delete
         if context["can_delete"]:
             context["delete_url"] = self.get_delete_url()
             context["delete_item_label"] = self.delete_item_label
@@ -1034,7 +1037,7 @@ class DeleteView(
 class InspectView(PermissionCheckedMixin, WagtailAdminTemplateMixin, TemplateView):
     any_permission_required = ["add", "change", "delete", "view"]
     template_name = "wagtailadmin/generic/inspect.html"
-    page_title = gettext_lazy("Inspecting")
+    page_title = gettext_lazy("Inspect")
     model = None
     index_url_name = None
     edit_url_name = None
@@ -1071,12 +1074,25 @@ class InspectView(PermissionCheckedMixin, WagtailAdminTemplateMixin, TemplateVie
         items.append(
             {
                 "url": "",
-                "label": _("Inspect"),
+                "label": self.get_page_title(),
                 "sublabel": object_str,
             }
         )
         return self.breadcrumbs_items + items
 
+    @cached_property
+    def header_more_buttons(self):
+        buttons = []
+        if edit_url := self.get_edit_url():
+            buttons.append(
+                Button(_("Edit"), url=edit_url, icon_name="edit", priority=10)
+            )
+        if delete_url := self.get_delete_url():
+            buttons.append(
+                Button(_("Delete"), url=delete_url, icon_name="bin", priority=20)
+            )
+        return buttons
+
     def get_fields(self):
         fields = self.fields or [
             f.name
@@ -1146,8 +1162,6 @@ class InspectView(PermissionCheckedMixin, WagtailAdminTemplateMixin, TemplateVie
         context = super().get_context_data(**kwargs)
         context["object"] = self.object
         context["fields"] = self.get_fields_context()
-        context["edit_url"] = self.get_edit_url()
-        context["delete_url"] = self.get_delete_url()
         return context
 
 

wagtail/admin/views/home.py

@@ -1,4 +1,5 @@
-from typing import Any, Mapping, Union
+from collections.abc import Mapping
+from typing import Any, Union
 
 from django.conf import settings
 from django.contrib.auth import get_user_model
@@ -7,10 +8,11 @@ from django.db.models import Exists, IntegerField, Max, OuterRef, Q
 from django.db.models.functions import Cast
 from django.forms import Media
 from django.http import Http404, HttpResponse
-from django.utils.translation import gettext_lazy
+from django.utils.translation import gettext_lazy as _
 from django.views.generic.base import TemplateView
 
 from wagtail import hooks
+from wagtail.admin.forms.search import SearchForm
 from wagtail.admin.icons import get_icons
 from wagtail.admin.navigation import get_site_for_user
 from wagtail.admin.site_summary import SiteSummaryPanel
@@ -33,9 +35,8 @@ User = get_user_model()
 
 
 class UpgradeNotificationPanel(Component):
-    name = "upgrade_notification"
     template_name = "wagtailadmin/home/upgrade_notification.html"
-    order = 100
+    dismissible_id = "last_upgrade_check"
 
     def get_upgrade_check_setting(self) -> Union[bool, str]:
         return getattr(settings, "WAGTAIL_ENABLE_UPDATE_CHECK", True)
@@ -46,8 +47,19 @@ class UpgradeNotificationPanel(Component):
             return True
         return False
 
+    def get_dismissible_value(self, user) -> str:
+        if profile := getattr(user, "wagtail_userprofile", None):
+            return profile.dismissibles.get(self.dismissible_id)
+        return None
+
     def get_context_data(self, parent_context: Mapping[str, Any]) -> Mapping[str, Any]:
-        return {"lts_only": self.upgrade_check_lts_only()}
+        return {
+            "lts_only": self.upgrade_check_lts_only(),
+            "dismissible_id": self.dismissible_id,
+            "dismissible_value": self.get_dismissible_value(
+                parent_context["request"].user
+            ),
+        }
 
     def render_html(self, parent_context: Mapping[str, Any] = None) -> str:
         if (
@@ -282,15 +294,20 @@ class RecentEditsPanel(Component):
 
 class HomeView(WagtailAdminTemplateMixin, TemplateView):
     template_name = "wagtailadmin/home.html"
-    page_title = gettext_lazy("Dashboard")
+    page_title = _("Dashboard")
+    permission_policy = page_permission_policy
 
     def get_context_data(self, **kwargs):
         context = super().get_context_data(**kwargs)
         panels = self.get_panels()
+        site_summary = SiteSummaryPanel(self.request)
         site_details = self.get_site_details()
 
-        context["media"] = self.get_media(panels)
+        context["media"] = self.get_media([*panels, site_summary])
         context["panels"] = sorted(panels, key=lambda p: p.order)
+        context["site_summary"] = site_summary
+        context["upgrade_notification"] = UpgradeNotificationPanel()
+        context["search_form"] = SearchForm(placeholder=_("Search all pages…"))
         context["user"] = self.request.user
 
         return {**context, **site_details}
@@ -306,10 +323,8 @@ class HomeView(WagtailAdminTemplateMixin, TemplateView):
     def get_panels(self):
         request = self.request
         panels = [
-            SiteSummaryPanel(request),
             # Disabled until a release warrants the banner.
             # WhatsNewInWagtailVersionPanel(),
-            UpgradeNotificationPanel(),
             WorkflowObjectsToModeratePanel(),
             UserObjectsInWorkflowModerationPanel(),
             RecentEditsPanel(),

wagtail/admin/views/page_privacy.py

@@ -1,9 +1,14 @@
 from django.core.exceptions import PermissionDenied
 from django.shortcuts import get_object_or_404
+from django.urls import reverse
+from django.utils.html import format_html
+from django.utils.safestring import mark_safe
+from django.utils.translation import gettext_lazy as _
 
 from wagtail.admin.forms.pages import PageViewRestrictionForm
 from wagtail.admin.modal_workflow import render_modal_workflow
 from wagtail.models import Page, PageViewRestriction
+from wagtail.models.view_restrictions import BaseViewRestriction
 
 
 def set_privacy(request, page_id):
@@ -12,14 +17,20 @@ def set_privacy(request, page_id):
     if not page_perms.can_set_view_restrictions():
         raise PermissionDenied
 
-    # fetch restriction records in depth order so that ancestors appear first
-    restrictions = page.get_view_restrictions().order_by("page__depth")
+    restrictions = page.get_view_restrictions().order_by("-page__depth")
     if restrictions:
-        restriction = restrictions[0]
-        restriction_exists_on_ancestor = restriction.page.id != page.id
+        if restrictions[0].page.id == page.id:
+            restriction = restrictions[0]
+            if len(restrictions) > 1:
+                restriction_on_ancestor = restrictions[1]
+            else:
+                restriction_on_ancestor = None
+        else:
+            restriction = None
+            restriction_on_ancestor = restrictions[0]
     else:
         restriction = None
-        restriction_exists_on_ancestor = False
+        restriction_on_ancestor = None
 
     if request.method == "POST":
         form = PageViewRestrictionForm(
@@ -27,7 +38,7 @@ def set_privacy(request, page_id):
             instance=restriction,
             private_page_options=page.private_page_options,
         )
-        if form.is_valid() and not restriction_exists_on_ancestor:
+        if form.is_valid():
             if form.cleaned_data["restriction_type"] == PageViewRestriction.NONE:
                 # remove any existing restriction
                 if restriction:
@@ -51,37 +62,50 @@ def set_privacy(request, page_id):
             )
 
     else:  # request is a GET
-        if not restriction_exists_on_ancestor:
-            if restriction:
-                form = PageViewRestrictionForm(
-                    instance=restriction, private_page_options=page.private_page_options
-                )
-            else:
-                # no current view restrictions on this page
-                form = PageViewRestrictionForm(
-                    initial={"restriction_type": "none"},
-                    private_page_options=page.private_page_options,
-                )
+        if restriction:
+            form = PageViewRestrictionForm(
+                instance=restriction,
+                private_page_options=page.private_page_options,
+            )
 
-    if restriction_exists_on_ancestor:
-        # display a message indicating that there is a restriction at ancestor level -
-        # do not provide the form for setting up new restrictions
-        return render_modal_workflow(
-            request,
-            "wagtailadmin/page_privacy/ancestor_privacy.html",
-            None,
-            {
-                "page_with_restriction": restriction.page,
-            },
-        )
-    elif len(page.private_page_options) == 0:
+        else:
+            # no current view restrictions on this page
+            form = PageViewRestrictionForm(
+                initial={"restriction_type": "none"},
+                private_page_options=page.private_page_options,
+            )
+
+        if restriction_on_ancestor:
+            ancestor_page_link = format_html(
+                '<a href="{url}">{title}</a>',
+                url=reverse(
+                    "wagtailadmin_pages:edit", args=[restriction_on_ancestor.page_id]
+                ),
+                title=restriction_on_ancestor.page.specific_deferred.get_admin_display_title(),
+            )
+            inherit_from_parent_choice = (
+                BaseViewRestriction.NONE,
+                format_html(
+                    "<span>{}</span>",
+                    mark_safe(
+                        _(
+                            "Privacy is inherited from the ancestor page - %(ancestor_page)s"
+                        )
+                        % {"ancestor_page": ancestor_page_link}
+                    ),
+                ),
+            )
+            form.fields["restriction_type"].choices = [
+                inherit_from_parent_choice
+            ] + list(form.fields["restriction_type"].choices[1:])
+
+    if len(page.private_page_options) == 0:
         return render_modal_workflow(
             request,
             "wagtailadmin/page_privacy/no_privacy.html",
             None,
         )
     else:
-        # no restriction set at ancestor level - can set restrictions here
         return render_modal_workflow(
             request,
             "wagtailadmin/page_privacy/set_privacy.html",

wagtail/admin/views/pages/history.py

@@ -34,6 +34,7 @@ class PageHistoryFilterSet(history.HistoryFilterSet):
 class PageWorkflowHistoryViewMixin:
     model = Page
     pk_url_kwarg = "page_id"
+    edit_url_name = "wagtailadmin_pages:edit"
 
     def dispatch(self, request, *args, **kwargs):
         if not self.object.permissions_for_user(request.user).can_edit():
@@ -44,17 +45,23 @@ class PageWorkflowHistoryViewMixin:
         return super().get_context_data(**kwargs, page=self.object)
 
 
-class WorkflowHistoryView(PageWorkflowHistoryViewMixin, history.WorkflowHistoryView):
+class WorkflowHistoryView(
+    PageWorkflowHistoryViewMixin,
+    GenericPageBreadcrumbsMixin,
+    history.WorkflowHistoryView,
+):
     header_icon = "doc-empty-inverse"
-    workflow_history_url_name = "wagtailadmin_pages:workflow_history"
     workflow_history_detail_url_name = "wagtailadmin_pages:workflow_history_detail"
 
 
 class WorkflowHistoryDetailView(
-    PageWorkflowHistoryViewMixin, history.WorkflowHistoryDetailView
+    PageWorkflowHistoryViewMixin,
+    GenericPageBreadcrumbsMixin,
+    history.WorkflowHistoryDetailView,
 ):
-    object_icon = "doc-empty-inverse"
+    header_icon = "doc-empty-inverse"
     workflow_history_url_name = "wagtailadmin_pages:workflow_history"
+    breadcrumbs_items_to_take = 2
 
 
 class PageHistoryView(GenericPageBreadcrumbsMixin, history.HistoryView):