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

wagtail/admin/views/pages/revisions.py

@@ -1,30 +1,21 @@
-from django.conf import settings
-from django.contrib.contenttypes.models import ContentType
 from django.core.exceptions import PermissionDenied
 from django.shortcuts import get_object_or_404, redirect
 from django.template.loader import render_to_string
-from django.template.response import TemplateResponse
 from django.urls import reverse
 from django.utils.decorators import method_decorator
 from django.utils.safestring import mark_safe
 from django.utils.translation import gettext as _
-from django.utils.translation import gettext_lazy
 
 from wagtail.admin import messages
 from wagtail.admin.action_menu import PageActionMenu
 from wagtail.admin.auth import user_has_any_page_permission, user_passes_test
-from wagtail.admin.ui.components import MediaContainer
-from wagtail.admin.ui.side_panels import (
-    ChecksSidePanel,
-    CommentsSidePanel,
-    PageStatusSidePanel,
-    PreviewSidePanel,
-)
 from wagtail.admin.views.generic.models import (
     RevisionsCompareView,
     RevisionsUnscheduleView,
 )
 from wagtail.admin.views.generic.preview import PreviewRevision
+from wagtail.admin.views.pages.edit import EditView
+from wagtail.admin.views.pages.utils import GenericPageBreadcrumbsMixin
 from wagtail.models import Page
 from wagtail.utils.timestamps import render_timestamp
 
@@ -33,116 +24,55 @@ def revisions_index(request, page_id):
     return redirect("wagtailadmin_pages:history", page_id)
 
 
-def revisions_revert(request, page_id, revision_id):
-    # TODO: refactor this into a class-based view that extends the EditView
-    page = get_object_or_404(Page, id=page_id).specific
-    page_perms = page.permissions_for_user(request.user)
-    if not page_perms.can_edit():
-        raise PermissionDenied
+class RevisionsRevertView(EditView):
+    revisions_revert_url_name = "wagtailadmin_pages:revisions_revert"
 
-    revision = get_object_or_404(page.revisions, id=revision_id)
-    revision_page = revision.as_object()
+    def get_action_menu(self):
+        return PageActionMenu(
+            self.request,
+            view="revisions_revert",
+            is_revision=True,
+            page=self.page,
+            lock=self.lock,
+            locked_for_user=self.locked_for_user,
+        )
 
-    scheduled_page = page.get_scheduled_revision_as_object()
+    def get(self, request, *args, **kwargs):
+        self._add_warning_message()
+        return super().get(request, *args, **kwargs)
 
-    content_type = ContentType.objects.get_for_model(page)
-    page_class = content_type.model_class()
+    def _add_warning_message(self):
+        messages.warning(self.request, self.get_warning_message())
 
-    if getattr(settings, "WAGTAIL_I18N_ENABLED", False):
-        locale = page.locale
-        translations = [
-            {
-                "locale": translation.locale,
-                "url": reverse("wagtailadmin_pages:edit", args=[translation.id]),
-            }
-            for translation in page.get_translations()
-            .only("id", "locale", "depth")
-            .select_related("locale")
-            if translation.permissions_for_user(request.user).can_edit()
-        ]
-    else:
-        locale = None
-        translations = []
-
-    edit_handler = page_class.get_edit_handler()
-    form_class = edit_handler.get_form_class()
-
-    form = form_class(instance=revision_page, for_user=request.user)
-    edit_handler = edit_handler.get_bound_panel(
-        instance=revision_page, request=request, form=form
-    )
-
-    preview_url = reverse("wagtailadmin_pages:preview_on_edit", args=[page.id])
-    lock = page.get_lock()
-
-    action_menu = PageActionMenu(
-        request,
-        view="revisions_revert",
-        is_revision=True,
-        page=page,
-        lock=lock,
-        locked_for_user=lock is not None and lock.for_user(request.user),
-    )
-    side_panels = [
-        PageStatusSidePanel(
-            revision_page,
-            request,
-            show_schedule_publishing_toggle=form.show_schedule_publishing_toggle,
-            live_object=page,
-            scheduled_object=scheduled_page,
-            locale=locale,
-            translations=translations,
-        ),
-    ]
-    if page.is_previewable():
-        side_panels.append(PreviewSidePanel(page, request, preview_url=preview_url))
-        side_panels.append(ChecksSidePanel(page, request))
-    if form.show_comments_toggle:
-        side_panels.append(CommentsSidePanel(page, request))
-    side_panels = MediaContainer(side_panels)
-
-    media = MediaContainer([edit_handler, form, action_menu, side_panels]).media
-
-    user_avatar = render_to_string(
-        "wagtailadmin/shared/user_avatar.html", {"user": revision.user}
-    )
-
-    messages.warning(
-        request,
-        mark_safe(
+    def get_object(self):
+        return self.previous_revision.as_object()
+
+    def get_revisions_revert_url(self):
+        return reverse(
+            self.revisions_revert_url_name,
+            args=[self.page.pk, self.revision_id],
+        )
+
+    def get_warning_message(self):
+        user_avatar = render_to_string(
+            "wagtailadmin/shared/user_avatar.html",
+            {"user": self.previous_revision.user},
+        )
+
+        return mark_safe(
             _(
                 "You are viewing a previous version of this page from <b>%(created_at)s</b> by %(user)s"
             )
             % {
-                "created_at": render_timestamp(revision.created_at),
+                "created_at": render_timestamp(self.previous_revision.created_at),
                 "user": user_avatar,
             }
-        ),
-    )
-
-    page_title = _("Editing %(page_type)s") % {
-        "page_type": page_class.get_verbose_name()
-    }
-    page_subtitle = page.get_admin_display_title()
-    header_title = f"{page_title}: {page_subtitle}"
-
-    return TemplateResponse(
-        request,
-        "wagtailadmin/pages/edit.html",
-        {
-            "page": page,
-            "revision": revision,
-            "is_revision": True,
-            "content_type": content_type,
-            "edit_handler": edit_handler,
-            "errors_debug": None,
-            "action_menu": action_menu,
-            "side_panels": side_panels,
-            "header_title": header_title,
-            "form": form,  # Used in unit tests
-            "media": media,
-        },
-    )
+        )
+
+    def get_context_data(self, **kwargs):
+        context = super().get_context_data(**kwargs)
+        context["action_url"] = self.get_revisions_revert_url()
+        return context
 
 
 @method_decorator(user_passes_test(user_has_any_page_permission), name="dispatch")
@@ -163,12 +93,11 @@ class RevisionsView(PreviewRevision):
         return page
 
 
-class RevisionsCompare(RevisionsCompareView):
-    history_label = gettext_lazy("Page history")
-    edit_label = gettext_lazy("Edit this page")
+class RevisionsCompare(GenericPageBreadcrumbsMixin, RevisionsCompareView):
     history_url_name = "wagtailadmin_pages:history"
     edit_url_name = "wagtailadmin_pages:edit"
     header_icon = "doc-empty-inverse"
+    breadcrumbs_items_to_take = 2
 
     @method_decorator(user_passes_test(user_has_any_page_permission))
     def dispatch(self, request, *args, **kwargs):

wagtail/admin/views/pages/utils.py

@@ -50,7 +50,6 @@ class GenericPageBreadcrumbsMixin:
     item of the generic view's generated breadcrumbs items.
     """
 
-    _show_breadcrumbs = True
     breadcrumbs_items_to_take = 1
 
     @cached_property

wagtail/admin/views/tags.py

@@ -19,8 +19,12 @@ def autocomplete(request, app_name=None, model_name=None):
 
     term = request.GET.get("term", None)
     if term:
-        tags = tag_model.objects.filter(name__istartswith=term).order_by("name")
+        tags = (
+            tag_model.objects.filter(name__istartswith=term)
+            .order_by("name")
+            .values_list("name", flat=True)[:10]
+        )
     else:
         tags = tag_model.objects.none()
 
-    return JsonResponse([tag.name for tag in tags], safe=False)
+    return JsonResponse(list(tags), safe=False)

wagtail/admin/views/workflows.py

@@ -175,7 +175,6 @@ class Create(CreateView):
     index_url_name = "wagtailadmin_workflows:index"
     header_icon = "tasks"
     edit_handler = None
-    _show_breadcrumbs = True
 
     def get_edit_handler(self):
         if not self.edit_handler:
@@ -263,7 +262,6 @@ class Edit(EditView):
     header_more_buttons = []
     edit_handler = None
     MAX_PAGES = 5
-    _show_breadcrumbs = True
 
     def get_edit_handler(self):
         if not self.edit_handler:
@@ -304,7 +302,6 @@ class Edit(EditView):
         pages_formset = self.get_pages_formset()
         context["edit_handler"] = bound_panel
         context["pages"] = self.get_paginated_pages()
-        context["pages_formset"] = pages_formset
         context["has_workflow_enabled_models"] = bool(get_workflow_enabled_models())
         context["content_type_form"] = self.get_content_type_form()
         context["can_disable"] = (
@@ -315,7 +312,14 @@ class Edit(EditView):
             self.permission_policy is None
             or self.permission_policy.user_has_permission(self.request.user, "add")
         ) and not self.object.active
-        context["media"] = bound_panel.media + form.media + pages_formset.media
+        context["media"] = bound_panel.media + form.media
+
+        # Only add the pages_formset if the workflow is active
+        if self.object.active:
+            pages_formset = self.get_pages_formset()
+            context["pages_formset"] = pages_formset
+            context["media"] += pages_formset.media
+
         return context
 
     @property
@@ -641,7 +645,6 @@ class CreateTask(CreateView):
     edit_url_name = "wagtailadmin_workflows:edit_task"
     index_url_name = "wagtailadmin_workflows:task_index"
     header_icon = "thumbtack"
-    _show_breadcrumbs = True
 
     @cached_property
     def model(self):
@@ -704,7 +707,6 @@ class EditTask(EditView):
     enable_url_name = "wagtailadmin_workflows:enable_task"
     header_icon = "thumbtack"
     header_more_buttons = []
-    _show_breadcrumbs = True
 
     @cached_property
     def model(self):

wagtail/admin/viewsets/model.py

@@ -63,9 +63,6 @@ class ModelViewSet(ViewSet):
     #: The view class to use for the inspect view; must be a subclass of ``wagtail.admin.views.generic.InspectView``.
     inspect_view_class = generic.InspectView
 
-    # Breadcrumbs can be turned off until we have a design that can be consistently applied
-    _show_breadcrumbs = True
-
     #: The prefix of template names to look for when rendering the admin views.
     template_prefix = ""
 
@@ -136,7 +133,6 @@ class ModelViewSet(ViewSet):
                 "edit_url_name": self.get_url_name("edit"),
                 "delete_url_name": self.get_url_name("delete"),
                 "header_icon": self.icon,
-                "_show_breadcrumbs": self._show_breadcrumbs,
                 **kwargs,
             }
         )

wagtail/admin/viewsets/pages.py

@@ -31,7 +31,6 @@ class PageListingViewSet(ViewSet):
     def get_common_view_kwargs(self, **kwargs):
         return super().get_common_view_kwargs(
             **{
-                "_show_breadcrumbs": True,
                 "header_icon": self.icon,
                 "model": self.model,
                 "index_url_name": self.get_url_name("index"),

wagtail/admin/widgets/tags.py

@@ -48,6 +48,7 @@ class AdminTagWidget(TagWidget):
             help_text = _("Tags can only consist of a single word, no spaces allowed.")
 
         context["widget"]["help_text"] = help_text
+        context["widget"]["attrs"]["data-w-tag-delay-value"] = 200
         context["widget"]["attrs"]["data-w-tag-url-value"] = autocomplete_url
         context["widget"]["attrs"]["data-w-tag-options-value"] = json.dumps(
             {

wagtail/api/v2/tests/test_documents.py

@@ -605,11 +605,13 @@ class TestDocumentCacheInvalidation(TestCase):
         signal_handlers.unregister_signal_handlers()
 
     def test_resave_document_purges(self, purge):
-        get_document_model().objects.get(id=5).save()
+        with self.captureOnCommitCallbacks(execute=True):
+            get_document_model().objects.get(id=5).save()
 
         purge.assert_any_call("http://api.example.com/api/main/documents/5/")
 
     def test_delete_document_purges(self, purge):
-        get_document_model().objects.get(id=5).delete()
+        with self.captureOnCommitCallbacks(execute=True):
+            get_document_model().objects.get(id=5).delete()
 
         purge.assert_any_call("http://api.example.com/api/main/documents/5/")

wagtail/api/v2/tests/test_images.py

@@ -597,11 +597,13 @@ class TestImageCacheInvalidation(TestCase):
         signal_handlers.unregister_signal_handlers()
 
     def test_resave_image_purges(self, purge):
-        get_image_model().objects.get(id=5).save()
+        with self.captureOnCommitCallbacks(execute=True):
+            get_image_model().objects.get(id=5).save()
 
         purge.assert_any_call("http://api.example.com/api/main/images/5/")
 
     def test_delete_image_purges(self, purge):
-        get_image_model().objects.get(id=5).delete()
+        with self.captureOnCommitCallbacks(execute=True):
+            get_image_model().objects.get(id=5).delete()
 
         purge.assert_any_call("http://api.example.com/api/main/images/5/")

wagtail/api/v2/tests/test_pages.py

@@ -1886,22 +1886,26 @@ class TestPageCacheInvalidation(TestCase):
         signal_handlers.unregister_signal_handlers()
 
     def test_republish_page_purges(self, purge):
-        Page.objects.get(id=2).specific.save_revision().publish()
+        with self.captureOnCommitCallbacks(execute=True):
+            Page.objects.get(id=2).specific.save_revision().publish()
 
         purge.assert_any_call("http://api.example.com/api/main/pages/2/")
 
     def test_unpublish_page_purges(self, purge):
-        Page.objects.get(id=2).unpublish()
+        with self.captureOnCommitCallbacks(execute=True):
+            Page.objects.get(id=2).unpublish()
 
         purge.assert_any_call("http://api.example.com/api/main/pages/2/")
 
     def test_delete_page_purges(self, purge):
-        Page.objects.get(id=16).delete()
+        with self.captureOnCommitCallbacks(execute=True):
+            Page.objects.get(id=16).delete()
 
         purge.assert_any_call("http://api.example.com/api/main/pages/16/")
 
     def test_save_draft_doesnt_purge(self, purge):
-        Page.objects.get(id=2).specific.save_revision()
+        with self.captureOnCommitCallbacks(execute=True):
+            Page.objects.get(id=2).specific.save_revision()
 
         purge.assert_not_called()
 

wagtail/blocks/base.py

@@ -20,6 +20,7 @@ from wagtail.admin.staticfiles import versioned_static
 from wagtail.coreutils import accepts_kwarg
 from wagtail.telepath import JSContext
 from wagtail.utils.deprecation import RemovedInWagtail70Warning
+from wagtail.utils.templates import template_is_overridden
 
 __all__ = [
     "BaseBlock",
@@ -55,8 +56,10 @@ class BaseBlock(type):
 class Block(metaclass=BaseBlock):
     name = ""
     creation_counter = 0
+    definition_registry = {}
 
     TEMPLATE_VAR = "value"
+    DEFAULT_PREVIEW_TEMPLATE = "wagtailcore/shared/block_preview.html"
 
     class Meta:
         label = None
@@ -94,6 +97,7 @@ class Block(metaclass=BaseBlock):
         self.creation_counter = Block.creation_counter
         Block.creation_counter += 1
         self.definition_prefix = "blockdef-%d" % self.creation_counter
+        Block.definition_registry[self.definition_prefix] = self
 
         self.label = self.meta.label or ""
 
@@ -157,7 +161,7 @@ class Block(metaclass=BaseBlock):
         model definition time (e.g. something like StructValue which incorporates a
         pointer back to the block definition object).
         """
-        return self.normalize(self.meta.default)
+        return self.normalize(getattr(self.meta, "default", None))
 
     def clean(self, value):
         """
@@ -220,8 +224,9 @@ class Block(metaclass=BaseBlock):
 
     def get_context(self, value, parent_context=None):
         """
-        Return a dict of context variables (derived from the block value and combined with the parent_context)
-        to be used as the template context when rendering this value through a template.
+        Return a dict of context variables (derived from the block ``value`` and combined with the
+        ``parent_context``) to be used as the template context when rendering this value through a
+        template. See :ref:`the usage example <streamfield_get_context>` for more details.
         """
 
         context = parent_context or {}
@@ -235,11 +240,9 @@ class Block(metaclass=BaseBlock):
 
     def get_template(self, value=None, context=None):
         """
-        Return the template to use for rendering the block if specified on meta class.
-        This extraction was added to make dynamic templates possible if you override this method
-
-        value contains the current value of the block, allowing overridden methods to
-        select the proper template based on the actual block value.
+        Return the template to use for rendering the block if specified.
+        This method allows for dynamic templates based on the block instance and a given ``value``.
+        See :ref:`the usage example <streamfield_get_template>` for more details.
         """
         return getattr(self.meta, "template", None)
 
@@ -269,6 +272,102 @@ class Block(metaclass=BaseBlock):
 
         return mark_safe(render_to_string(template, new_context))
 
+    def get_preview_context(self, value, parent_context=None):
+        """
+        Return a dict of context variables to be used as the template context
+        when rendering the block's preview. The ``value`` argument is the value
+        returned by :meth:`get_preview_value`. The ``parent_context`` argument
+        contains the following variables:
+
+        - ``request``: The current request object.
+        - ``block_def``: The block instance.
+        - ``block_class``: The block class.
+        - ``bound_block``: A ``BoundBlock`` instance representing the block and its value.
+
+        If :ref:`the global preview template <streamfield_global_preview_template>`
+        is used, the block will be rendered as the main content using
+        ``{% include_block %}``, which in turn uses :meth:`get_context`. As a
+        result, the context returned by this method will be available as the
+        ``parent_context`` for ``get_context()`` when the preview is rendered.
+        """
+        # NOTE: see StreamFieldBlockPreview.base_context for the context variables
+        # that can be documented.
+        return parent_context or {}
+
+    def get_preview_template(self, value, context=None):
+        """
+        Return the template to use for rendering the block's preview. The ``value``
+        argument is the value returned by :meth:`get_preview_value`. The ``context``
+        argument contains the variables listed for the ``parent_context`` argument
+        of :meth:`get_preview_context` above (and not the context returned by that
+        method itself).
+
+        Note that the preview template is used to render a complete HTML page of
+        the preview, not just an HTML fragment for the block. The method returns
+        the ``preview_template`` attribute from the block's options if provided,
+        and falls back to
+        :ref:`the global preview template <streamfield_global_preview_template>`
+        otherwise.
+
+        If the global preview template is used, the block will be rendered as the
+        main content using ``{% include_block %}``, which in turn uses
+        :meth:`get_template`.
+        """
+        return (
+            getattr(self.meta, "preview_template", None)
+            or self.DEFAULT_PREVIEW_TEMPLATE
+        )
+
+    def get_preview_value(self):
+        """
+        Return the placeholder value that will be used for rendering the block's
+        preview. By default, the value is the ``preview_value`` from the block's
+        options if provided, otherwise the ``default`` is used as fallback. This
+        method can be overridden to provide a dynamic preview value, such as
+        from the database.
+        """
+        if hasattr(self.meta, "preview_value"):
+            return self.normalize(self.meta.preview_value)
+        return self.get_default()
+
+    @cached_property
+    def _has_default(self):
+        return getattr(self.meta, "default", None) is not None
+
+    @cached_property
+    def is_previewable(self):
+        # To prevent showing a broken preview if the block preview has not been
+        # configured, consider the block to be previewable if either:
+        # - a specific preview template is configured for the block
+        # - a preview value is provided and the global template has been overridden
+        # which are the intended ways to configure block previews.
+        #
+        # If a block is made previewable by other means, the `is_previewable`
+        # property should be overridden to return `True`.
+        has_specific_template = (
+            hasattr(self.meta, "preview_template")
+            or self.__class__.get_preview_template is not Block.get_preview_template
+        )
+        has_preview_value = (
+            hasattr(self.meta, "preview_value")
+            or self._has_default
+            or self.__class__.get_preview_context is not Block.get_preview_context
+            or self.__class__.get_preview_value is not Block.get_preview_value
+        )
+        has_global_template = template_is_overridden(
+            self.DEFAULT_PREVIEW_TEMPLATE,
+            "templates",
+        )
+        return has_specific_template or (has_preview_value and has_global_template)
+
+    def get_description(self):
+        """
+        Return the description of the block to be shown to editors as part of the preview.
+        For :ref:`field block types <field_block_types>`, it will fall back to
+        ``help_text`` if not provided.
+        """
+        return getattr(self.meta, "description", "")
+
     def get_api_representation(self, value, context=None):
         """
         Can be used to customise the API response and defaults to the value returned by get_prep_value.

wagtail/blocks/field_block.py

@@ -81,6 +81,9 @@ class FieldBlock(Block):
             self.field.prepare_value(self.value_for_form(value))
         )
 
+    def get_description(self):
+        return super().get_description() or self.field.help_text or ""
+
     class Meta:
         # No icon specified here, because that depends on the purpose that the
         # block is being used for. Feel encouraged to specify an icon in your
@@ -110,8 +113,11 @@ class FieldBlockAdapter(Adapter):
 
         meta = {
             "label": block.label,
+            "description": block.get_description(),
             "required": block.required,
             "icon": block.meta.icon,
+            "blockDefId": block.definition_prefix,
+            "isPreviewable": block.is_previewable,
             "classname": " ".join(classname),
             "showAddCommentButton": getattr(
                 block.field.widget, "show_add_comment_button", True

wagtail/blocks/list_block.py

@@ -147,7 +147,8 @@ class ListBlock(Block):
         else:
             self.child_block = child_block
 
-        if not hasattr(self.meta, "default"):
+        self._has_default = hasattr(self.meta, "default")
+        if not self._has_default:
             # Default to a list consisting of one empty (i.e. default-valued) child item
             self.meta.default = [self.child_block.get_default()]
 
@@ -449,12 +450,16 @@ class ListBlockAdapter(Adapter):
     def js_args(self, block):
         meta = {
             "label": block.label,
+            "description": block.get_description(),
             "icon": block.meta.icon,
+            "blockDefId": block.definition_prefix,
+            "isPreviewable": block.is_previewable,
             "classname": block.meta.form_classname,
             "collapsed": block.meta.collapsed,
             "strings": {
                 "MOVE_UP": _("Move up"),
                 "MOVE_DOWN": _("Move down"),
+                "DRAG": _("Drag"),
                 "DUPLICATE": _("Duplicate"),
                 "DELETE": _("Delete"),
                 "ADD": _("Add"),

wagtail/blocks/static_block.py

@@ -58,6 +58,9 @@ class StaticBlockAdapter(Adapter):
                 text_or_html: admin_text,
                 "icon": block.meta.icon,
                 "label": block.label,
+                "description": block.get_description(),
+                "blockDefId": block.definition_prefix,
+                "isPreviewable": block.is_previewable,
             },
         ]
 

wagtail/blocks/stream_block.py

@@ -460,6 +460,10 @@ class BaseStreamBlock(Block):
 
         return errors
 
+    @cached_property
+    def _has_default(self):
+        return self.meta.default is not BaseStreamBlock._meta_class.default
+
     class Meta:
         # No icon specified here, because that depends on the purpose that the
         # block is being used for. Feel encouraged to specify an icon in your
@@ -826,8 +830,11 @@ class StreamBlockAdapter(Adapter):
     def js_args(self, block):
         meta = {
             "label": block.label,
+            "description": block.get_description(),
             "required": block.required,
             "icon": block.meta.icon,
+            "blockDefId": block.definition_prefix,
+            "isPreviewable": block.is_previewable,
             "classname": block.meta.form_classname,
             "maxNum": block.meta.max_num,
             "minNum": block.meta.min_num,
@@ -836,6 +843,7 @@ class StreamBlockAdapter(Adapter):
             "strings": {
                 "MOVE_UP": _("Move up"),
                 "MOVE_DOWN": _("Move down"),
+                "DRAG": _("Drag"),
                 "DUPLICATE": _("Duplicate"),
                 "DELETE": _("Delete"),
                 "ADD": _("Add"),