wagtail 7.1.2__py3-none-any.whl → 7.2__py3-none-any.whl

wagtail/admin/views/generic/mixins.py

@@ -1,5 +1,4 @@
 import json
-from typing import Optional
 
 from django.conf import settings
 from django.contrib.admin.utils import quote
@@ -38,6 +37,7 @@ from wagtail.models import (
     WorkflowMixin,
     WorkflowState,
 )
+from wagtail.models.orderable import set_max_order
 from wagtail.utils.timestamps import render_timestamp
 
 
@@ -123,7 +123,7 @@ class LocaleMixin:
     def translations(self):
         return self.get_translations() if self.locale else []
 
-    def get_locale(self) -> Optional[Locale]:
+    def get_locale(self) -> Locale | None:
         if not getattr(self, "model", None):
             return None
 
@@ -240,6 +240,15 @@ class IndexViewOptionalFeaturesMixin:
             list_display.append(LiveStatusTagColumn())
         return list_display
 
+    def get_reorder_url(self):
+        if (
+            self.model
+            and issubclass(self.model, DraftStateMixin)
+            and not self.user_has_permission("publish")
+        ):
+            return None
+        return super().get_reorder_url()
+
 
 class CreateEditViewOptionalFeaturesMixin:
     """
@@ -524,6 +533,15 @@ class CreateEditViewOptionalFeaturesMixin:
         else:
             instance = self.form.save()
 
+        # Apply max order number if the model uses custom ordering and the
+        # sort_order_field is not set.
+        if (
+            self.view_name == "create"
+            and self.sort_order_field
+            and getattr(instance, self.sort_order_field) is None
+        ):
+            set_max_order(instance, self.sort_order_field)
+
         self.has_content_changes = self.view_name == "create" or self.form.has_changed()
 
         # Save revision if the model inherits from RevisionMixin

wagtail/admin/views/generic/models.py

@@ -38,6 +38,7 @@ from wagtail.admin.ui.tables import (
     TitleColumn,
     UpdatedAtColumn,
 )
+from wagtail.admin.ui.tables.orderable import OrderableTableMixin
 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 (
@@ -50,6 +51,7 @@ 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.models.orderable import set_max_order
 from wagtail.search.index import class_is_indexed
 
 from .base import BaseListingView, WagtailAdminTemplateMixin
@@ -71,9 +73,11 @@ class IndexView(
     copy_url_name = None
     inspect_url_name = None
     delete_url_name = None
+    reorder_url_name = None
     any_permission_required = ["add", "change", "delete", "view"]
     list_filter = None
     show_other_searches = False
+    sort_order_field = None
 
     @cached_property
     def is_searchable(self):
@@ -105,6 +109,24 @@ class IndexView(
             {"Meta": Meta},
         )
 
+    @cached_property
+    def table_class(self):
+        table_class = super().table_class
+        if self.show_ordering_column:
+            return type(
+                f"{self.model.__name__}Table",
+                (OrderableTableMixin, table_class),
+                {},
+            )
+        return table_class
+
+    def get_table_kwargs(self):
+        kwargs = super().get_table_kwargs()
+        if self.show_ordering_column:
+            kwargs["sort_order_field"] = self.sort_order_field
+            kwargs["reorder_url"] = self.get_reorder_url()
+        return kwargs
+
     def _annotate_queryset_updated_at(self, queryset):
         # Annotate the objects' updated_at, use _ prefix to avoid name collision
         # with an existing database field.
@@ -138,9 +160,11 @@ class IndexView(
         if has_updated_at_column:
             queryset = self._annotate_queryset_updated_at(queryset)
 
+        if self.show_ordering_column:
+            return queryset.order_by(self.sort_order_field)
         # Explicitly handle null values for the updated at column to ensure consistency
         # across database backends and match the behaviour in page explorer
-        if self.ordering == "_updated_at":
+        elif self.ordering == "_updated_at":
             return queryset.order_by(models.F("_updated_at").asc(nulls_first=True))
         elif self.ordering == "-_updated_at":
             return queryset.order_by(models.F("_updated_at").desc(nulls_last=True))
@@ -276,6 +300,10 @@ class IndexView(
         if self.delete_url_name and self.user_has_permission("delete"):
             return reverse(self.delete_url_name, args=(quote(instance.pk),))
 
+    def get_reorder_url(self):
+        if self.reorder_url_name and self.user_has_permission("change"):
+            return reverse(self.reorder_url_name, args=(999999,))
+
     def get_add_url(self):
         if self.add_url_name and self.user_has_permission("add"):
             return self._set_locale_query_param(reverse(self.add_url_name))
@@ -302,6 +330,19 @@ class IndexView(
             )
         return buttons
 
+    @cached_property
+    def header_more_buttons(self):
+        buttons = super().header_more_buttons
+        if self.get_reorder_url():
+            buttons.append(
+                Button(
+                    _("Sort item order"),
+                    url=self.index_url + f"?ordering={self.sort_order_field}",
+                    icon_name="list-ul",
+                )
+            )
+        return buttons
+
     def get_list_more_buttons(self, instance):
         buttons = []
         if edit_url := self.get_edit_url(instance):
@@ -382,6 +423,26 @@ class IndexView(
             return self.model._meta.verbose_name_plural
         return None
 
+    @cached_property
+    def show_ordering_column(self):
+        return self.sort_order_field and (self.ordering == self.sort_order_field)
+
+    def get_paginate_by(self, queryset):
+        if self.show_ordering_column:
+            # Don't paginate if sorting by custom order - all items must be shown
+            # to allow drag-and-drop reordering
+            return None
+        return super().get_paginate_by(queryset)
+
+    def get_valid_orderings(self):
+        valid_orderings = super().get_valid_orderings()
+
+        if self.sort_order_field and not (self.is_searching or self.is_filtering):
+            # ordering by custom order is only available when not searching/filtering
+            valid_orderings.append(self.sort_order_field)
+
+        return valid_orderings
+
     def get_context_data(self, *args, **kwargs):
         context = super().get_context_data(*args, **kwargs)
 
@@ -424,6 +485,7 @@ class CreateView(
     submit_button_label = gettext_lazy("Create")
     submit_button_active_label = gettext_lazy("Creating…")
     actions = ["create"]
+    sort_order_field = None
 
     def setup(self, request, *args, **kwargs):
         super().setup(request, *args, **kwargs)
@@ -575,6 +637,10 @@ class CreateView(
         and returns the new object. Override this to implement custom save logic.
         """
         instance = self.form.save()
+        # Apply max order number if the model uses custom ordering and the
+        # sort_order_field is not set.
+        if self.sort_order_field and getattr(instance, self.sort_order_field) is None:
+            set_max_order(instance, self.sort_order_field)
         log(instance=instance, action="wagtail.create", content_changed=True)
         return instance
 

wagtail/admin/views/generic/ordering.py

@@ -0,0 +1,79 @@
+from django.contrib.admin.utils import unquote
+from django.db import transaction
+from django.db.models import F
+from django.http import JsonResponse
+from django.shortcuts import get_object_or_404
+from django.views.generic import View
+
+from .permissions import PermissionCheckedMixin
+
+
+class ReorderView(PermissionCheckedMixin, View):
+    """View for handling the reordering of model instances that have an order field."""
+
+    model = None
+    sort_order_field = None
+    permission_required = "change"
+
+    def get_queryset(self):
+        return self.model._default_manager.all().order_by(self.sort_order_field)
+
+    def post(self, request, *args, **kwargs):
+        item_to_move = get_object_or_404(self.model, pk=unquote(kwargs.get("pk")))
+
+        try:
+            # Position is an index in the list of items,
+            # not a value of the sort_order_field.
+            new_position = int(request.GET.get("position", ""))
+        except ValueError:
+            new_position = -1
+
+        queryset = self.get_queryset()
+        items = list(queryset.values("pk", self.sort_order_field))
+
+        # If position is missing or not a valid integer, move to the end
+        if new_position < 0 or new_position >= len(items):
+            new_position = len(items) - 1
+
+        # Get the current sort_order_field value of the item being moved,
+        # to be used as the relative anchor for updating the other items.
+        current_sort_order = getattr(item_to_move, self.sort_order_field)
+
+        # The current position index of the item being moved (may not be the
+        # same as the sort_order_field value), to be used to determine
+        # whether to move items up or down.
+        current_position = next(
+            (i for i, obj in enumerate(items) if obj["pk"] == item_to_move.pk),
+            current_sort_order,
+        )
+
+        # The sort_order_field value of the item at the new position, which
+        # will be set as the new sort_order_field value for the item being moved.
+        sort_order_at_position = items[new_position][self.sort_order_field]
+
+        with transaction.atomic():
+            if new_position < current_position:
+                # We are moving the item up in the list, so we need to push down
+                # the items from the new position and below.
+                queryset.filter(
+                    **{
+                        f"{self.sort_order_field}__gte": sort_order_at_position,
+                        f"{self.sort_order_field}__lt": current_sort_order,
+                    }
+                ).update(**{self.sort_order_field: F(self.sort_order_field) + 1})
+            elif new_position > current_position:
+                # We are moving the item down in the list, so we need to pull up
+                # the items from the new position and above.
+                queryset.filter(
+                    **{
+                        f"{self.sort_order_field}__gt": current_sort_order,
+                        f"{self.sort_order_field}__lte": sort_order_at_position,
+                    }
+                ).update(**{self.sort_order_field: F(self.sort_order_field) - 1})
+
+            if new_position != current_position:
+                # Once the other items have been moved, update the actual item.
+                setattr(item_to_move, self.sort_order_field, sort_order_at_position)
+                item_to_move.save(update_fields=[self.sort_order_field])
+
+        return JsonResponse({"success": True})

wagtail/admin/views/home.py

@@ -1,5 +1,5 @@
 from collections.abc import Mapping
-from typing import Any, Union
+from typing import Any
 
 from django.conf import settings
 from django.contrib.auth import get_user_model
@@ -38,7 +38,7 @@ class UpgradeNotificationPanel(Component):
     template_name = "wagtailadmin/home/upgrade_notification.html"
     dismissible_id = "last_upgrade_check"
 
-    def get_upgrade_check_setting(self) -> Union[bool, str]:
+    def get_upgrade_check_setting(self) -> bool | str:
         return getattr(settings, "WAGTAIL_ENABLE_UPDATE_CHECK", True)
 
     def upgrade_check_lts_only(self) -> bool:
@@ -77,7 +77,7 @@ class WhatsNewInWagtailVersionPanel(Component):
     order = 110
     _version = "4"
 
-    def get_whats_new_banner_setting(self) -> Union[bool, str]:
+    def get_whats_new_banner_setting(self) -> bool | str:
         return getattr(settings, "WAGTAIL_ENABLE_WHATS_NEW_BANNER", True)
 
     def get_dismissible_id(self) -> str:

wagtail/admin/views/page_privacy.py

@@ -108,10 +108,13 @@ def set_privacy(request, page_id):
     else:
         return render_modal_workflow(
             request,
-            "wagtailadmin/page_privacy/set_privacy.html",
+            "wagtailadmin/shared/set_privacy.html",
             None,
             {
-                "page": page,
+                "action_url": reverse(
+                    "wagtailadmin_pages:set_privacy", args=(page.pk,)
+                ),
+                "object": page,
                 "form": form,
             },
             json_data={"step": "set_privacy"},

wagtail/admin/views/pages/create.py

@@ -383,7 +383,7 @@ class CreateView(WagtailAdminTemplateMixin, HookResponseMixin, View):
     def form_invalid(self, form):
         messages.validation_error(
             self.request,
-            _("The page could not be created due to validation errors"),
+            _("The page could not be created due to validation errors."),
             self.form,
         )
         self.has_unsaved_changes = True

wagtail/admin/views/pages/edit.py

@@ -852,12 +852,12 @@ class EditView(WagtailAdminTemplateMixin, HookResponseMixin, View):
             )
         elif self.locked_for_user:
             messages.error(
-                self.request, _("The page could not be saved as it is locked")
+                self.request, _("The page could not be saved as it is locked.")
             )
         else:
             messages.validation_error(
                 self.request,
-                _("The page could not be saved due to validation errors"),
+                _("The page could not be saved due to validation errors."),
                 self.form,
             )
         self.errors_debug = repr(self.form.errors) + repr(

wagtail/admin/views/pages/listing.py

@@ -27,7 +27,6 @@ from wagtail.admin.ui.tables import DateColumn
 from wagtail.admin.ui.tables.pages import (
     BulkActionsColumn,
     NavigateToChildrenColumn,
-    OrderingColumn,
     PageStatusColumn,
     PageTable,
     PageTitleColumn,
@@ -152,7 +151,7 @@ class PageListingMixin:
             "type",
             label=_("Type"),
             accessor="page_type_display_name",
-            sort_key="content_type",
+            sort_key="content_type__model",
             width="12%",
         ),
         PageStatusColumn(
@@ -310,6 +309,9 @@ class ExplorableIndexView(IndexView):
     index_results_url_name = "wagtailadmin_explore_results"
     page_title = _("Exploring")
     filterset_class = GenericPageFilterSet
+    # This is not a real field on the model, but it allows reuse of ordering
+    # logic from generic IndexView
+    sort_order_field = "ord"
 
     @classproperty
     def columns(cls):
@@ -394,39 +396,14 @@ class ExplorableIndexView(IndexView):
         if permissions.can_view_revisions():
             return reverse("wagtailadmin_pages:history", args=[self.parent_page.id])
 
+    def get_reorder_url(self):
+        return reverse("wagtailadmin_pages:set_page_position", args=[999999])
+
     def get_table_kwargs(self):
         kwargs = super().get_table_kwargs()
-        kwargs["use_row_ordering_attributes"] = self.show_ordering_column
         kwargs["parent_page"] = self.parent_page
-
-        if self.show_ordering_column:
-            kwargs["caption"] = _(
-                "Focus on the drag button and press up or down arrows to move the item, then press enter to submit the change."
-            )
-            kwargs["attrs"] = {
-                "data-controller": "w-orderable",
-                "data-w-orderable-active-class": "w-orderable--active",
-                "data-w-orderable-chosen-class": "w-orderable__item--active",
-                "data-w-orderable-container-value": "tbody",
-                "data-w-orderable-message-value": _(
-                    "'%(page_title)s' has been moved successfully."
-                )
-                % {"page_title": "__LABEL__"},
-                "data-w-orderable-url-value": reverse(
-                    "wagtailadmin_pages:set_page_position", args=[999999]
-                ),
-            }
         return kwargs
 
-    def get_valid_orderings(self):
-        valid_orderings = super().get_valid_orderings()
-
-        if not self.is_searching:
-            # ordering by page order is only available when not searching
-            valid_orderings.append("ord")
-
-        return valid_orderings
-
     def get_ordering(self):
         if self.is_searching and not self.is_explicitly_ordered:
             # default to ordering by relevance
@@ -440,22 +417,10 @@ class ExplorableIndexView(IndexView):
 
         return ordering
 
-    def get_paginate_by(self, queryset):
-        if self.ordering == "ord":
-            # Don't paginate if sorting by page order - all pages must be shown to
-            # allow drag-and-drop reordering
-            return None
-        else:
-            return self.paginate_by
-
     def get_page_subtitle(self):
         return self.parent_page.get_admin_display_title()
 
     def get_context_data(self, **kwargs):
-        self.show_ordering_column = self.ordering == "ord"
-        if self.show_ordering_column:
-            self.columns = self.columns.copy()
-            self.columns[0] = OrderingColumn("ordering", width="80px", sort_key="ord")
         context = super().get_context_data(**kwargs)
 
         if self.is_searching:

wagtail/admin/views/pages/move.py

@@ -70,7 +70,7 @@ def move_confirm(request, page_to_move_id, destination_id):
         messages.error(
             request,
             _(
-                "The slug '%(page_slug)s' is already in use at the selected parent page. Make sure the slug is unique and try again"
+                "The slug '%(page_slug)s' is already in use at the selected parent page. Make sure the slug is unique and try again."
             )
             % {"page_slug": page_to_move.slug},
         )

wagtail/admin/views/pages/ordering.py

@@ -21,7 +21,7 @@ def set_page_position(request, page_to_move_id):
         if position is not None:
             try:
                 position_page = parent_page.get_children()[int(position)]
-            except IndexError:
+            except (IndexError, ValueError):
                 pass  # No page in this position
 
         # Move page

wagtail/admin/viewsets/base.py

@@ -18,7 +18,7 @@ class ViewSet(WagtailMenuRegisterable):
     """
 
     #: A special value that, when passed in a kwargs dict to construct a view, indicates that
-    #: the attribute should not be written and should instead be left as the view's initial value
+    #: the attribute should not be written and should instead be left as the view's initial value.
     UNDEFINED = object()
 
     #: A name for this viewset, used as the default URL prefix and namespace.

wagtail/admin/viewsets/model.py

@@ -59,6 +59,9 @@ 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
 
+    #: The view class to use for the reorder view; must be a subclass of ``wagtail.admin.views.generic.ReorderView``.
+    reorder_view_class = generic.ReorderView
+
     #: The prefix of template names to look for when rendering the admin views.
     template_prefix = ""
 
@@ -92,6 +95,18 @@ class ModelViewSet(ViewSet):
     #: Whether to enable the copy view. Defaults to ``True``.
     copy_view_enabled = True
 
+    sort_order_field = ViewSet.UNDEFINED
+    """
+    The name of an integer field on the model to use for ordering items
+    in the index view. If not set and the model has a ``sort_order_field``
+    attribute (e.g.
+    :attr:`Orderable.sort_order_field <wagtail.models.Orderable.sort_order_field>`),
+    that will be used instead. To disable reordering, set this to ``None``.
+
+    .. versionadded:: 7.2
+       The ``sort_order_field`` attribute was added in Wagtail 7.2.
+    """
+
     def __init__(self, name=None, **kwargs):
         super().__init__(name=name, **kwargs)
         if not self.model:
@@ -104,6 +119,12 @@ class ModelViewSet(ViewSet):
         self.app_label = self.model_opts.app_label
         self.model_name = self.model_opts.model_name
 
+        # Auto-detect sort_order_field from the model, e.g. from Orderable mixin
+        if self.sort_order_field is self.UNDEFINED and hasattr(
+            self.model, "sort_order_field"
+        ):
+            self.sort_order_field = self.model.sort_order_field
+
     @property
     def permission_policy(self):
         return ModelPermissionPolicy(self.model)
@@ -116,6 +137,10 @@ class ModelViewSet(ViewSet):
         """
         return self.model_name
 
+    @cached_property
+    def reorder_view_enabled(self):
+        return self.sort_order_field not in {self.UNDEFINED, None}
+
     def get_common_view_kwargs(self, **kwargs):
         view_kwargs = super().get_common_view_kwargs(
             **{
@@ -155,15 +180,21 @@ class ModelViewSet(ViewSet):
         }
         if self.ordering:
             view_kwargs["default_ordering"] = self.ordering
+        if self.reorder_view_enabled:
+            view_kwargs["sort_order_field"] = self.sort_order_field
+            view_kwargs["reorder_url_name"] = self.get_url_name("reorder")
         return view_kwargs
 
     def get_add_view_kwargs(self, **kwargs):
-        return {
+        view_kwargs = {
             "panel": self._edit_handler,
             "form_class": self.get_form_class(),
             "template_name": self.create_template_name,
             **kwargs,
         }
+        if self.reorder_view_enabled:
+            view_kwargs["sort_order_field"] = self.sort_order_field
+        return view_kwargs
 
     def get_edit_view_kwargs(self, **kwargs):
         return {
@@ -206,6 +237,12 @@ class ModelViewSet(ViewSet):
     def get_copy_view_kwargs(self, **kwargs):
         return self.get_add_view_kwargs(**kwargs)
 
+    def get_reorder_view_kwargs(self, **kwargs):
+        return {
+            "sort_order_field": self.sort_order_field,
+            **kwargs,
+        }
+
     @property
     def index_view(self):
         return self.construct_view(
@@ -260,6 +297,12 @@ class ModelViewSet(ViewSet):
     def copy_view(self):
         return self.construct_view(self.copy_view_class, **self.get_copy_view_kwargs())
 
+    @property
+    def reorder_view(self):
+        return self.construct_view(
+            self.reorder_view_class, **self.get_reorder_view_kwargs()
+        )
+
     def get_templates(self, name="index", fallback=""):
         """
         Utility function that provides a list of templates to try for a given
@@ -621,6 +664,11 @@ class ModelViewSet(ViewSet):
             path("usage/<str:pk>/", self.usage_view, name="usage"),
         ]
 
+        if self.reorder_view_enabled:
+            urlpatterns.append(
+                path("reorder/<str:pk>/", self.reorder_view, name="reorder")
+            )
+
         if self.inspect_view_enabled:
             urlpatterns.append(
                 path("inspect/<str:pk>/", self.inspect_view, name="inspect")

wagtail/admin/wagtail_hooks.py

@@ -986,7 +986,8 @@ def register_keyboard_shortcuts_menu_item():
             "role": "button",  # Ensure screen readers announce this as a button
             "data-a11y-dialog-show": "keyboard-shortcuts-dialog",
             "data-action": "w-action#noop:prevent:stop",
-            "data-controller": "w-action",
+            "data-controller": "w-kbd w-action",
+            "data-w-kbd-key-value": "?",
         },
         name="keyboard-shortcuts-trigger",
         url="#",

wagtail/admin/widgets/slug.py

@@ -1,6 +1,5 @@
 import json
 import re
-from typing import List, Optional, Tuple, Union
 
 from django.conf import settings
 from django.forms import widgets
@@ -19,16 +18,17 @@ class SlugInput(widgets.TextInput):
 
     def __init__(
         self,
-        attrs: Optional[dict] = None,
-        formatters: Optional[
-            List[
-                Tuple[
-                    Union[re.Pattern, str, bytes],
-                    Optional[str],
+        attrs: dict | None = None,
+        formatters: None
+        | (
+            list[
+                tuple[
+                    re.Pattern | str | bytes,
+                    str | None,
                 ],
             ]
-        ] = [],
-        locale: Optional[object] = None,
+        ) = [],
+        locale: object | None = None,
     ):
         default_attrs = {
             "data-controller": "w-slug",
@@ -63,7 +63,7 @@ class SlugInput(widgets.TextInput):
         if locale is not None:
             # Attempt to resolve a non-empty locale string from a `Locale` instance or the string itself.
             # If no locale can be found, use 'und' - as per ISO639-2 standard, 'und' represents 'undetermined'.
-            # If the attribute is not set, the input will fall back to the ``ACTIVE_LOCALE`` or document lang within the CleanController.
+            # If the attribute is not set, the input will fall back to the ``ACTIVE_CONTENT_LOCALE`` or document lang within the CleanController.
             default_attrs["data-w-slug-locale-value"] = (
                 getattr(locale, "language_code", locale) or "und"
             )

wagtail/api/v2/serializers.py

@@ -376,7 +376,7 @@ class PageSerializer(BaseSerializer):
         # Find all relation fields that point to child class and make them use
         # the ChildRelationField class.
         if relation_info.to_many:
-            model = getattr(self.Meta, "model")
+            model = self.Meta.model
             child_relations = {
                 child_relation.field.remote_field.related_name: child_relation.related_model
                 for child_relation in get_all_child_relations(model)