wagtail 6.3.3__py3-none-any.whl → 6.4__py3-none-any.whl

wagtail/admin/tests/test_userbar.py

@@ -11,6 +11,7 @@ from wagtail.coreutils import get_dummy_request
 from wagtail.models import PAGE_TEMPLATE_VAR, Page, Site
 from wagtail.test.testapp.models import BusinessChild, BusinessIndex, SimplePage
 from wagtail.test.utils import WagtailTestUtils
+from wagtail.utils.deprecation import RemovedInWagtail70Warning
 
 
 class TestUserbarTag(WagtailTestUtils, TestCase):
@@ -184,7 +185,7 @@ class TestAccessibilityCheckerConfig(WagtailTestUtils, TestCase):
         return json.loads(self.get_script().string)
 
     def get_hook(self, item_class):
-        def customise_accessibility_checker(request, items):
+        def customise_accessibility_checker(request, items, page):
             items[:] = [
                 item_class() if isinstance(item, AccessibilityItem) else item
                 for item in items
@@ -455,6 +456,86 @@ class TestUserbarInPageServe(WagtailTestUtils, TestCase):
         self.assertEqual(response.status_code, 200)
         self.assertNotContains(response, '<template id="wagtail-userbar-template">')
 
+    def test_construct_wagtail_userbar_hook_passes_page(self):
+        kwargs = {}
+
+        def construct_wagtail_userbar(request, items, page):
+            kwargs["page"] = page
+            return items
+
+        with hooks.register_temporarily(
+            "construct_wagtail_userbar",
+            construct_wagtail_userbar,
+        ):
+            response = self.page.serve(self.request)
+            response.render()
+
+            self.assertEqual(kwargs.get("page"), self.page)
+
+    def test_deprecated_construct_wagtail_userbar_hook_without_page(self):
+        kwargs = {}
+
+        def construct_wagtail_userbar(request, items):
+            kwargs["called"] = True
+            return items
+
+        with self.assertWarnsMessage(
+            RemovedInWagtail70Warning,
+            "`construct_wagtail_userbar` hook functions should accept a `page` argument in third position",
+        ), hooks.register_temporarily(
+            "construct_wagtail_userbar",
+            construct_wagtail_userbar,
+        ):
+            response = self.page.serve(self.request)
+            response.render()
+
+            self.assertTrue(kwargs.get("called"))
+
+
+class TestUserbarHooksForChecksPanel(WagtailTestUtils, TestCase):
+    def setUp(self):
+        self.user = self.login()
+        self.homepage = Page.objects.get(id=2).specific
+
+    def test_construct_wagtail_userbar_hook_passes_page(self):
+        kwargs = {}
+
+        def construct_wagtail_userbar(request, items, page):
+            kwargs["called"] = True
+            return items
+
+        with hooks.register_temporarily(
+            "construct_wagtail_userbar",
+            construct_wagtail_userbar,
+        ):
+            response = self.client.get(
+                reverse("wagtailadmin_pages:edit", args=(self.homepage.id,))
+            )
+
+        self.assertEqual(response.status_code, 200)
+        self.assertTrue(kwargs.get("called"))
+
+    def test_deprecated_construct_wagtail_userbar_hook_without_page(self):
+        kwargs = {}
+
+        def construct_wagtail_userbar(request, items):
+            kwargs["called"] = True
+            return items
+
+        with self.assertWarnsMessage(
+            RemovedInWagtail70Warning,
+            "`construct_wagtail_userbar` hook functions should accept a `page` argument in third position",
+        ), hooks.register_temporarily(
+            "construct_wagtail_userbar",
+            construct_wagtail_userbar,
+        ):
+            response = self.client.get(
+                reverse("wagtailadmin_pages:edit", args=(self.homepage.id,))
+            )
+
+        self.assertEqual(response.status_code, 200)
+        self.assertTrue(kwargs.get("called"))
+
 
 class TestUserbarAddLink(WagtailTestUtils, TestCase):
     fixtures = ["test.json"]

wagtail/admin/tests/test_views_generic.py

@@ -15,7 +15,7 @@ class TestGenericIndexView(WagtailTestUtils, TestCase):
         response = self.get()
         self.assertEqual(response.status_code, 200)
         response_object_count = response.context_data["object_list"].count()
-        self.assertEqual(response_object_count, 3)
+        self.assertEqual(response_object_count, 4)
         self.assertContains(response, "first modelwithstringtypeprimarykey model")
         self.assertContains(response, "second modelwithstringtypeprimarykey model")
         soup = self.get_soup(response.content)
@@ -34,7 +34,7 @@ class TestGenericIndexViewWithoutModel(WagtailTestUtils, TestCase):
         response = self.get()
         self.assertEqual(response.status_code, 200)
         response_object_count = response.context_data["object_list"].count()
-        self.assertEqual(response_object_count, 3)
+        self.assertEqual(response_object_count, 4)
 
 
 class TestGenericEditView(WagtailTestUtils, TestCase):
@@ -58,19 +58,29 @@ class TestGenericEditView(WagtailTestUtils, TestCase):
             response, "non-url-safe pk modelwithstringtypeprimarykey model"
         )
 
-    def test_using_quote_in_edit_url(self):
-        object_pk = 'string-pk-:#?;@&=+$,"[]<>%'
+    def test_unquote_sensitive_primary_key(self):
+        object_pk = "web_407269_1"
         response = self.get(quote(object_pk))
-        edit_url = response.context_data["action_url"]
-        edit_url_pk = edit_url.split("/")[-2]
-        self.assertEqual(edit_url_pk, quote(object_pk))
+        self.assertEqual(response.status_code, 200)
+        self.assertContains(
+            response, "unquote-sensitive modelwithstringtypeprimarykey model"
+        )
+
+    def test_using_quote_in_edit_url(self):
+        for object_pk in ('string-pk-:#?;@&=+$,"[]<>%', "web_407269_1"):
+            with self.subTest(object_pk=object_pk):
+                response = self.get(quote(object_pk))
+                edit_url = response.context_data["action_url"]
+                edit_url_pk = edit_url.split("/")[-2]
+                self.assertEqual(edit_url_pk, quote(object_pk))
 
     def test_using_quote_in_delete_url(self):
-        object_pk = 'string-pk-:#?;@&=+$,"[]<>%'
-        response = self.get(quote(object_pk))
-        delete_url = response.context_data["delete_url"]
-        delete_url_pk = delete_url.split("/")[-2]
-        self.assertEqual(delete_url_pk, quote(object_pk))
+        for object_pk in ('string-pk-:#?;@&=+$,"[]<>%', "web_407269_1"):
+            with self.subTest(object_pk=object_pk):
+                response = self.get(quote(object_pk))
+                delete_url = response.context_data["delete_url"]
+                delete_url_pk = delete_url.split("/")[-2]
+                self.assertEqual(delete_url_pk, quote(object_pk))
 
 
 class TestGenericDeleteView(WagtailTestUtils, TestCase):
@@ -89,3 +99,8 @@ class TestGenericDeleteView(WagtailTestUtils, TestCase):
         object_pk = 'string-pk-:#?;@&=+$,"[]<>%'
         response = self.get(quote(object_pk))
         self.assertEqual(response.status_code, 200)
+
+    def test_with_unquote_sensitive_primary_key(self):
+        object_pk = "web_407269_1"
+        response = self.get(quote(object_pk))
+        self.assertEqual(response.status_code, 200)

wagtail/admin/tests/test_workflows.py

@@ -431,6 +431,40 @@ class TestWorkflowsCreateView(AdminTemplateTestUtils, WagtailTestUtils, TestCase
             response.content,
         )
 
+        # Check the correct data attributes have been set on the form
+        soup = self.get_soup(response.content)
+        workflow_pages_panel = soup.find(id="workflow-pages-section")
+        self.assertIn(
+            "w-formset",
+            workflow_pages_panel.attrs["data-controller"],
+        )
+        self.assertEqual(
+            "totalFormsInput",
+            workflow_pages_panel.find(id="id_pages-TOTAL_FORMS").attrs[
+                "data-w-formset-target"
+            ],
+        )
+        self.assertEqual(
+            "template",
+            workflow_pages_panel.find("template").attrs["data-w-formset-target"],
+        )
+
+        tbody = workflow_pages_panel.find("table").find("tbody")
+        self.assertEqual(
+            "forms",
+            tbody.attrs["data-w-formset-target"],
+        )
+
+        row = tbody.find("tr")
+        self.assertEqual(
+            "child",
+            row.attrs["data-w-formset-target"],
+        )
+        self.assertEqual(
+            "deleteInput",
+            row.find(id="id_pages-0-DELETE").attrs["data-w-formset-target"],
+        )
+
     def test_post(self):
         response = self.post(
             {
@@ -663,6 +697,41 @@ class TestWorkflowsEditView(AdminTemplateTestUtils, WagtailTestUtils, TestCase):
         # Check that the list of pages has the page to which this workflow is assigned
         self.assertContains(response, self.page.title)
 
+        # Check the correct data attributes have been set on the form
+        soup = self.get_soup(response.content)
+
+        workflow_pages_panel = soup.find(id="workflow-pages-section")
+        self.assertIn(
+            "w-formset",
+            workflow_pages_panel.attrs["data-controller"],
+        )
+        self.assertEqual(
+            "totalFormsInput",
+            workflow_pages_panel.find(id="id_pages-TOTAL_FORMS").attrs[
+                "data-w-formset-target"
+            ],
+        )
+        self.assertEqual(
+            "template",
+            workflow_pages_panel.find("template").attrs["data-w-formset-target"],
+        )
+
+        tbody = workflow_pages_panel.find("table").find("tbody")
+        self.assertEqual(
+            "forms",
+            tbody.attrs["data-w-formset-target"],
+        )
+
+        row = tbody.find("tr")
+        self.assertEqual(
+            "child",
+            row.attrs["data-w-formset-target"],
+        )
+        self.assertEqual(
+            "deleteInput",
+            row.find(id="id_pages-0-DELETE").attrs["data-w-formset-target"],
+        )
+
     def test_post(self):
         response = self.post(
             {

wagtail/admin/tests/tests.py

@@ -374,6 +374,26 @@ class TestTagsAutocomplete(WagtailTestUtils, TestCase):
 
         self.assertEqual(data, [])
 
+    def test_tags_autocomplete_limit(self):
+        tags = [Tag(name=f"Tag {i}", slug=f"tag-{i}") for i in range(15)]
+        Tag.objects.bulk_create(tags)
+
+        # Send a request to the autocomplete endpoint with a broad search term
+        response = self.client.get(
+            reverse("wagtailadmin_tag_autocomplete"), {"term": "Tag"}
+        )
+
+        # Confirm the response is successful
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response["Content-Type"], "application/json")
+
+        data = json.loads(response.content.decode("utf-8"))
+
+        # The results should be limited to avoid performance issues (#12415)
+        self.assertEqual(len(data), 10)
+        sorted_tags = sorted(tags, key=lambda t: t.name)
+        self.assertEqual(data, [tag.name for tag in sorted_tags[:10]])
+
 
 class TestMenuItem(WagtailTestUtils, TestCase):
     def setUp(self):
@@ -381,10 +401,6 @@ class TestMenuItem(WagtailTestUtils, TestCase):
         response = self.client.get(reverse("wagtailadmin_home"))
         self.request = response.wsgi_request
 
-    def test_menuitem_reverse_lazy_url_pass(self):
-        menuitem = MenuItem(_("Test"), reverse_lazy("wagtailadmin_home"))
-        self.assertIs(menuitem.is_active(self.request), True)
-
     def test_menuitem_with_classname(self):
         menuitem = MenuItem(
             _("Test"),
@@ -492,6 +508,9 @@ class Test404(WagtailTestUtils, TestCase):
             # Check 404 error after CommonMiddleware redirect
             self.assertEqual(response.status_code, 404)
             self.assertTemplateUsed(response, "wagtailadmin/404.html")
+            soup = self.get_soup(response.content)
+            self.assertFalse(soup.select("script"))
+            self.assertFalse(soup.select("[data-sprite]"))
 
     def test_not_logged_in_redirect(self):
         response = self.client.get("/admin/sdfgdsfgdsfgsdf/")

wagtail/admin/tests/ui/test_sidebar.py

@@ -283,7 +283,7 @@ class TestAdaptMainMenuModule(WagtailTestUtils, DjangoTestCase):
                     ],
                     {
                         "name": user.first_name or user.get_username(),
-                        "avatarUrl": "//www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=100&d=mm",
+                        "avatarUrl": "//www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?d=mp&s=100",
                     },
                 ],
             },

wagtail/admin/tests/viewsets/test_model_viewset.py

@@ -910,10 +910,11 @@ class TestBreadcrumbs(AdminTemplateTestUtils, WagtailTestUtils, TestCase):
         self.assertBreadcrumbsItemsRendered(items, response.content)
 
     def test_usage_view_pagination(self):
-        for i in range(25):
-            VariousOnDeleteModel.objects.create(
-                text=f"Toybox {i}", cascading_toy=self.object
-            )
+        with self.captureOnCommitCallbacks(execute=True):
+            for i in range(25):
+                VariousOnDeleteModel.objects.create(
+                    text=f"Toybox {i}", cascading_toy=self.object
+                )
 
         usage_url = reverse(
             "feature_complete_toy:usage",
@@ -1208,15 +1209,16 @@ class TestHistoryView(WagtailTestUtils, TestCase):
 class TestUsageView(WagtailTestUtils, TestCase):
     @classmethod
     def setUpTestData(cls):
-        cls.user = cls.create_test_user()
-        cls.object = FeatureCompleteToy.objects.create(name="Buzz")
-        cls.url = reverse(
-            "feature_complete_toy:usage",
-            args=(quote(cls.object.pk),),
-        )
-        cls.tbx = VariousOnDeleteModel.objects.create(
-            text="Toybox", cascading_toy=cls.object
-        )
+        with cls.captureOnCommitCallbacks(execute=True):
+            cls.user = cls.create_test_user()
+            cls.object = FeatureCompleteToy.objects.create(name="Buzz")
+            cls.url = reverse(
+                "feature_complete_toy:usage",
+                args=(quote(cls.object.pk),),
+            )
+            cls.tbx = VariousOnDeleteModel.objects.create(
+                text="Toybox", cascading_toy=cls.object
+            )
 
     def setUp(self):
         self.user = self.login(self.user)

wagtail/admin/ui/side_panels.py

@@ -5,9 +5,8 @@ from django.urls import reverse
 from django.utils.text import capfirst
 from django.utils.translation import gettext_lazy, ngettext
 
-from wagtail import hooks
 from wagtail.admin.ui.components import Component
-from wagtail.admin.userbar import AccessibilityItem
+from wagtail.admin.userbar import AccessibilityItem, apply_userbar_hooks
 from wagtail.models import DraftStateMixin, LockableMixin, Page, ReferenceIndex
 from wagtail.utils.deprecation import RemovedInWagtail70Warning
 
@@ -241,6 +240,7 @@ class StatusSidePanel(BaseSidePanel):
 
 class PageStatusSidePanel(StatusSidePanel):
     def __init__(self, *args, **kwargs):
+        self.parent_page = kwargs.pop("parent_page", None)
         super().__init__(*args, **kwargs)
         if self.object.pk:
             self.usage_url = reverse("wagtailadmin_pages:usage", args=(self.object.pk,))
@@ -272,6 +272,9 @@ class PageStatusSidePanel(StatusSidePanel):
         context = super().get_context_data(parent_context)
         page = self.object
 
+        if self.parent_page:
+            context["parent_page"] = self.parent_page
+
         if page.id:
             context.update(
                 {
@@ -325,8 +328,8 @@ class ChecksSidePanel(BaseSidePanel):
     def get_axe_configuration(self):
         # Retrieve the Axe configuration from the userbar.
         userbar_items = [AccessibilityItem()]
-        for fn in hooks.get_hooks("construct_wagtail_userbar"):
-            fn(self.request, userbar_items)
+        page = self.object if issubclass(self.model, Page) else None
+        apply_userbar_hooks(self.request, userbar_items, page)
 
         for item in userbar_items:
             if isinstance(item, AccessibilityItem):

wagtail/admin/urls/__init__.py

@@ -19,6 +19,7 @@ from wagtail.admin.urls import reports as wagtailadmin_reports_urls
 from wagtail.admin.urls import workflows as wagtailadmin_workflows_urls
 from wagtail.admin.views import account, chooser, dismissibles, home, tags
 from wagtail.admin.views.bulk_action import index as bulk_actions
+from wagtail.admin.views.generic.preview import StreamFieldBlockPreview
 from wagtail.admin.views.pages import listing
 from wagtail.utils.urlpatterns import decorate_urlpatterns
 
@@ -118,6 +119,11 @@ urlpatterns = [
             namespace="wagtailadmin_editing_sessions",
         ),
     ),
+    path(
+        "block-preview/",
+        StreamFieldBlockPreview.as_view(),
+        name="wagtailadmin_block_preview",
+    ),
 ]
 
 

wagtail/admin/urls/pages.py

@@ -106,7 +106,7 @@ urlpatterns = [
     ),
     path(
         "<int:page_id>/revisions/<int:revision_id>/revert/",
-        revisions.revisions_revert,
+        revisions.RevisionsRevertView.as_view(),
         name="revisions_revert",
     ),
     path(

wagtail/admin/userbar.py

@@ -1,6 +1,12 @@
+from warnings import warn
+
 from django.template.loader import render_to_string
 from django.utils.translation import gettext_lazy as _
 
+from wagtail import hooks
+from wagtail.coreutils import accepts_kwarg
+from wagtail.utils.deprecation import RemovedInWagtail70Warning
+
 
 class BaseItem:
     template = "wagtailadmin/userbar/item_base.html"
@@ -258,7 +264,7 @@ class ExplorePageItem(BaseItem):
         if not request.user.has_perm("wagtailadmin.access_admin"):
             return ""
 
-        # Don't render if user doesn't have ability to edit or publish sub-pages on the parent page
+        # Don't render if user doesn't have ability to edit or publish subpages on the parent page
         permission_checker = self.parent_page.permissions_for_user(request.user)
         if (
             not permission_checker.can_edit()
@@ -298,3 +304,16 @@ class EditPageItem(BaseItem):
             return ""
 
         return super().render(request)
+
+
+def apply_userbar_hooks(request, items, page):
+    for fn in hooks.get_hooks("construct_wagtail_userbar"):
+        if accepts_kwarg(fn, "page"):
+            fn(request, items, page)
+        else:
+            warn(
+                "`construct_wagtail_userbar` hook functions should accept a `page` argument in third position -"
+                f" {fn.__module__}.{fn.__name__} needs to be updated",
+                category=RemovedInWagtail70Warning,
+            )
+            fn(request, items)

wagtail/admin/views/account.py

@@ -232,6 +232,11 @@ class AccountView(WagtailAdminTemplateMixin, TemplateView):
     page_title = gettext_lazy("Account")
     header_icon = "user"
 
+    def get_breadcrumbs_items(self):
+        return super().get_breadcrumbs_items() + [
+            {"url": "", "label": self.get_page_title()}
+        ]
+
     def get_context_data(self, **kwargs):
         context = super().get_context_data(**kwargs)
         panels = self.get_panels()

wagtail/admin/views/chooser.py

@@ -408,7 +408,11 @@ class SearchView(View):
     @property
     def columns(self):
         cols = [
-            PageTitleColumn("title", label=_("Title")),
+            PageTitleColumn(
+                "title",
+                label=_("Title"),
+                is_multiple_choice=self.is_multiple_choice,
+            ),
             ParentPageColumn("parent", label=_("Parent")),
             DateColumn(
                 "updated",

wagtail/admin/views/collections.py

@@ -50,7 +50,6 @@ class Create(CreateView):
     edit_url_name = "wagtailadmin_collections:edit"
     index_url_name = "wagtailadmin_collections:index"
     header_icon = "folder-open-1"
-    _show_breadcrumbs = True
 
     def get_form(self, form_class=None):
         form = super().get_form(form_class)
@@ -80,7 +79,6 @@ class Edit(EditView):
     delete_url_name = "wagtailadmin_collections:delete"
     context_object_name = "collection"
     header_icon = "folder-open-1"
-    _show_breadcrumbs = True
 
     def _user_may_move_collection(self, user, instance):
         """

wagtail/admin/views/generic/base.py

@@ -41,9 +41,17 @@ class WagtailAdminTemplateMixin(TemplateResponseMixin, ContextMixin):
     page_title = ""
     page_subtitle = ""
     header_icon = ""
-    # Breadcrumbs are opt-in until we have a design that can be consistently applied
-    _show_breadcrumbs = False
+
     breadcrumbs_items = [{"url": reverse_lazy("wagtailadmin_home"), "label": _("Home")}]
+    """
+    The base set of breadcrumbs items to be displayed on the page.
+    The property can be overridden by subclasses and viewsets to provide
+    custom base items, e.g. page tree breadcrumbs or add the "Snippets" item.
+
+    Views should copy and append to this list in :meth:`get_breadcrumbs_items()`
+    to define the path to the current view.
+    """
+
     template_name = "wagtailadmin/generic/base.html"
     header_buttons = []
     header_more_buttons = []
@@ -65,6 +73,12 @@ class WagtailAdminTemplateMixin(TemplateResponseMixin, ContextMixin):
         return self.header_icon
 
     def get_breadcrumbs_items(self):
+        """
+        Define the current path to the view by copying the base
+        :attr:`breadcrumbs_items` and appending the list.
+
+        If breadcrumbs are not required, return an empty list.
+        """
         return self.breadcrumbs_items
 
     def get_header_buttons(self):
@@ -92,14 +106,11 @@ class WagtailAdminTemplateMixin(TemplateResponseMixin, ContextMixin):
         context["page_title"] = self.get_page_title()
         context["page_subtitle"] = self.get_page_subtitle()
         context["header_icon"] = self.get_header_icon()
-
-        # Once all appropriate views use "wagtailadmin/generic/base.html" and
-        # the slim_header.html, _show_breadcrumbs can be removed
         context["header_title"] = self.get_header_title()
-        context["breadcrumbs_items"] = None
-        if self._show_breadcrumbs:
-            context["breadcrumbs_items"] = self.get_breadcrumbs_items()
-            context["header_buttons"] = self.get_header_buttons()
+
+        # Breadcrumbs are enabled by default.
+        context["breadcrumbs_items"] = self.get_breadcrumbs_items()
+        context["header_buttons"] = self.get_header_buttons()
         return context
 
     def get_template_names(self):
@@ -203,7 +214,6 @@ class BaseListingView(WagtailAdminTemplateMixin, BaseListView):
     default_ordering = None
     filterset_class = None
     verbose_name_plural = None
-    _show_breadcrumbs = True
 
     def get_template_names(self):
         if self.results_only:

wagtail/admin/views/generic/history.py

@@ -415,7 +415,6 @@ class WorkflowHistoryDetailView(
     page_title = gettext_lazy("Workflow progress")
     header_icon = "list-ul"
     object_icon = "doc-empty-inverse"
-    _show_breadcrumbs = True
 
     @cached_property
     def index_url(self):