wagtail 6.4rc1__py3-none-any.whl → 7.0__py3-none-any.whl

wagtail/admin/views/generic/preview.py

@@ -11,6 +11,7 @@ from django.utils.functional import cached_property
 from django.utils.translation import gettext
 from django.views.generic import TemplateView, View
 
+from wagtail.admin.forms.models import WagtailAdminModelForm
 from wagtail.admin.panels import get_edit_handler
 from wagtail.blocks.base import Block
 from wagtail.models import PreviewableMixin, RevisionMixin
@@ -77,10 +78,15 @@ class PreviewOnEdit(View):
             post_data = ""
         return QueryDict(post_data)
 
+    def validate_form(self, form):
+        if isinstance(form, WagtailAdminModelForm):
+            form.defer_required_fields()
+        return form.is_valid()
+
     def post(self, request, *args, **kwargs):
         self.remove_old_preview_data()
         form = self.get_form(request.POST)
-        is_valid = form.is_valid()
+        is_valid = self.validate_form(form)
 
         if is_valid:
             # TODO: Handle request.FILES.
@@ -89,7 +95,7 @@ class PreviewOnEdit(View):
         else:
             # Check previous data in session to determine preview availability
             form = self.get_form(self._get_data_from_session())
-            is_available = form.is_valid()
+            is_available = self.validate_form(form)
 
         return JsonResponse({"is_valid": is_valid, "is_available": is_available})
 
@@ -104,7 +110,7 @@ class PreviewOnEdit(View):
     def get(self, request, *args, **kwargs):
         form = self.get_form(self._get_data_from_session())
 
-        if not form.is_valid():
+        if not self.validate_form(form):
             return self.error_response()
 
         form.save(commit=False)
@@ -197,6 +203,8 @@ class StreamFieldBlockPreview(TemplateView):
     def base_context(self):
         # Do NOT use the name `block` in the context, as it will conflict with
         # the current block inside a template {% block %} tag.
+        # If any changes are made here that needs to be publicly documented,
+        # make sure to update the docs for `Block.get_preview_context`.
         return {
             "request": self.request,
             "block_def": self.block_def,

wagtail/admin/views/generic/workflow.py

@@ -47,6 +47,11 @@ class BaseWorkflowFormView(BaseObjectMixin, View):
     def get_form_class(self):
         return self.task.get_form_for_action(self.action_name)
 
+    def get_template_names(self):
+        if template := self.task.get_template_for_action(self.action_name):
+            return [template]
+        return [self.template_name]
+
     def add_not_in_moderation_error(self):
         messages.error(
             self.request,
@@ -103,7 +108,7 @@ class BaseWorkflowFormView(BaseObjectMixin, View):
     def render_modal_form(self, request, form):
         return render_modal_workflow(
             request,
-            self.template_name,
+            self.get_template_names(),
             None,
             self.get_context_data(form=form),
             json_data={"step": "action"},
@@ -195,6 +200,11 @@ class ConfirmWorkflowCancellation(BaseObjectMixin, View):
                 json_data={"step": "no_confirmation_needed"},
             )
 
+        # This confirmation step is specific to the
+        # `WAGTAIL_WORKFLOW_CANCEL_ON_PUBLISH` setting that happens when a user
+        # publishes a page with a workflow in progress, which is different from
+        # a "cancel" action on the task. So, we use `self.template_name`
+        # directly and not make it customisable.
         return render_modal_workflow(
             request,
             self.template_name,

wagtail/admin/views/i18n.py

@@ -0,0 +1,14 @@
+from django.views.i18n import JavaScriptCatalog
+
+from wagtail.admin.localization import get_localized_response
+
+js_catalog = JavaScriptCatalog.as_view(packages=["wagtail.admin"])
+
+
+def localized_js_catalog(request, *args, **kwargs):
+    """
+    Django's JavaScriptCatalog that has been decorated to ensure it is localized
+    in the user's preferred language.
+    https://github.com/wagtail/wagtail/issues/11074
+    """
+    return get_localized_response(js_catalog, request, *args, **kwargs)

wagtail/admin/views/pages/bulk_actions/move.py

@@ -43,7 +43,7 @@ class MoveBulkAction(PageBulkAction):
 
     def get_form_kwargs(self):
         ctx = super().get_form_kwargs()
-        ctx["destination"] = self.destination or Page.get_first_root_node()
+        ctx["destination"] = self.destination
         ctx["target_parent_models"] = self.target_parent_models
         ctx["pages_to_move"] = self.pages_to_move
         return ctx

wagtail/admin/views/pages/create.py

@@ -8,6 +8,7 @@ from django.shortcuts import get_object_or_404, redirect
 from django.template.response import TemplateResponse
 from django.urls import reverse
 from django.utils import timezone
+from django.utils.functional import cached_property
 from django.utils.translation import gettext as _
 from django.utils.translation import gettext_lazy
 from django.views.generic.base import View
@@ -24,7 +25,13 @@ from wagtail.admin.ui.side_panels import (
 from wagtail.admin.utils import get_valid_next_url_from_request
 from wagtail.admin.views.generic import HookResponseMixin
 from wagtail.admin.views.generic.base import WagtailAdminTemplateMixin
-from wagtail.models import Locale, Page, PageSubscription
+from wagtail.models import (
+    BaseViewRestriction,
+    Locale,
+    Page,
+    PageSubscription,
+    PageViewRestriction,
+)
 
 
 def add_subpage(request, parent_page_id):
@@ -144,25 +151,40 @@ class CreateView(WagtailAdminTemplateMixin, HookResponseMixin, View):
             parent_page=self.parent_page,
             for_user=self.request.user,
         )
+        if self.action_name == "save":
+            self.form.defer_required_fields()
 
         if self.form.is_valid():
             return self.form_valid(self.form)
         else:
+            self.form.restore_required_fields()
             return self.form_invalid(self.form)
 
-    def form_valid(self, form):
+    @cached_property
+    def action_name_and_method(self):
         if (
             bool(self.request.POST.get("action-publish"))
             and self.parent_page_perms.can_publish_subpage()
         ):
-            return self.publish_action()
+            return ("publish", self.publish_action)
         elif (
             bool(self.request.POST.get("action-submit"))
             and self.parent_page.has_workflow
         ):
-            return self.submit_action()
+            return ("submit", self.submit_action)
         else:
-            return self.save_action()
+            return ("save", self.save_action)
+
+    @property
+    def action_name(self):
+        return self.action_name_and_method[0]
+
+    @property
+    def action_method(self):
+        return self.action_name_and_method[1]
+
+    def form_valid(self, form):
+        return self.action_method()
 
     def get_page_subtitle(self):
         return self.page_class.get_verbose_name()
@@ -182,6 +204,37 @@ class CreateView(WagtailAdminTemplateMixin, HookResponseMixin, View):
     def get_view_live_message_button(self):
         return messages.button(self.page.url, _("View live"), new_window=False)
 
+    def set_default_privacy_setting(self):
+        # privacy setting options BaseViewRestriction.RESTRICTION_CHOICES
+        default_privacy_setting = self.page.get_default_privacy_setting(self.request)
+
+        if default_privacy_setting["type"] == BaseViewRestriction.NONE:
+            # default privacy setting is public no need to do anything
+            pass
+        elif default_privacy_setting["type"] == BaseViewRestriction.LOGIN:
+            PageViewRestriction.objects.create(
+                page=self.page,
+                restriction_type=BaseViewRestriction.LOGIN,
+            )
+        elif default_privacy_setting["type"] == BaseViewRestriction.PASSWORD:
+            PageViewRestriction.objects.create(
+                page=self.page,
+                restriction_type=BaseViewRestriction.PASSWORD,
+                password=default_privacy_setting["password"],
+            )
+        elif default_privacy_setting["type"] == BaseViewRestriction.GROUPS:
+            # Create a page view restriction for groups
+            groups_page_restriction = PageViewRestriction.objects.create(
+                page=self.page,
+                restriction_type=BaseViewRestriction.GROUPS,
+            )
+            # add groups to the page view restriction
+            groups_page_restriction.groups.set(default_privacy_setting["groups"])
+        else:
+            raise ValueError(
+                f"Invalid privacy setting {default_privacy_setting.get('type')!r}"
+            )
+
     def save_action(self):
         self.page = self.form.save(commit=False)
         self.page.live = False
@@ -189,8 +242,11 @@ class CreateView(WagtailAdminTemplateMixin, HookResponseMixin, View):
         # Save page
         self.parent_page.add_child(instance=self.page)
 
+        # Set page privacy setting
+        self.set_default_privacy_setting()
+
         # Save revision
-        self.page.save_revision(user=self.request.user, log_action=True)
+        self.page.save_revision(user=self.request.user, log_action=True, clean=False)
 
         # Save subscription settings
         self.subscription.page = self.page
@@ -216,6 +272,9 @@ class CreateView(WagtailAdminTemplateMixin, HookResponseMixin, View):
         # Save page
         self.parent_page.add_child(instance=self.page)
 
+        # Set page privacy setting
+        self.set_default_privacy_setting()
+
         # Save revision
         revision = self.page.save_revision(user=self.request.user, log_action=True)
 
@@ -270,6 +329,9 @@ class CreateView(WagtailAdminTemplateMixin, HookResponseMixin, View):
         # Save page
         self.parent_page.add_child(instance=self.page)
 
+        # Set page privacy setting
+        self.set_default_privacy_setting()
+
         # Save revision
         self.page.save_revision(user=self.request.user, log_action=True)
 

wagtail/admin/views/pages/edit.py

@@ -9,6 +9,7 @@ from django.http import HttpResponse
 from django.shortcuts import get_object_or_404, redirect
 from django.urls import reverse
 from django.utils import timezone
+from django.utils.functional import cached_property
 from django.utils.html import format_html
 from django.utils.translation import gettext as _
 from django.views.generic.base import View
@@ -465,6 +466,14 @@ class EditView(WagtailAdminTemplateMixin, HookResponseMixin, View):
             ],
         )
 
+    @cached_property
+    def is_cancelling_workflow(self):
+        return (
+            bool(self.request.POST.get("action-cancel-workflow"))
+            and self.workflow_state
+            and self.workflow_state.user_can_cancel(self.request.user)
+        )
+
     def post(self, request, *args, **kwargs):
         # Don't allow POST requests if the page is an alias
         if self.page.alias_of_id:
@@ -480,15 +489,13 @@ class EditView(WagtailAdminTemplateMixin, HookResponseMixin, View):
             for_user=self.request.user,
         )
 
-        self.is_cancelling_workflow = (
-            bool(self.request.POST.get("action-cancel-workflow"))
-            and self.workflow_state
-            and self.workflow_state.user_can_cancel(self.request.user)
-        )
+        if self.action_name == "save":
+            self.form.defer_required_fields()
 
         if self.form.is_valid() and not self.locked_for_user:
             return self.form_valid(self.form)
         else:
+            self.form.restore_required_fields()
             return self.form_invalid(self.form)
 
     def workflow_action_is_valid(self):
@@ -501,32 +508,43 @@ class EditView(WagtailAdminTemplateMixin, HookResponseMixin, View):
         ]
         return self.workflow_action in available_action_names
 
-    def form_valid(self, form):
-        self.has_content_changes = self.form.has_changed()
-
+    @cached_property
+    def action_name_and_method(self):
         if self.request.POST.get("action-publish") and self.page_perms.can_publish():
-            return self.publish_action()
+            return ("publish", self.publish_action)
         elif (
             self.request.POST.get("action-submit")
             and self.page_perms.can_submit_for_moderation()
         ):
-            return self.submit_action()
+            return ("submit", self.submit_action)
         elif (
             self.request.POST.get("action-restart-workflow")
             and self.page_perms.can_submit_for_moderation()
             and self.workflow_state
             and self.workflow_state.user_can_cancel(self.request.user)
         ):
-            return self.restart_workflow_action()
+            return ("restart_workflow", self.restart_workflow_action)
         elif (
             self.request.POST.get("action-workflow-action")
             and self.workflow_action_is_valid()
         ):
-            return self.perform_workflow_action()
+            return ("perform_workflow_action", self.perform_workflow_action)
         elif self.is_cancelling_workflow:
-            return self.cancel_workflow_action()
+            return ("cancel_workflow", self.cancel_workflow_action)
         else:
-            return self.save_action()
+            return ("save", self.save_action)
+
+    @property
+    def action_name(self):
+        return self.action_name_and_method[0]
+
+    @property
+    def action_method(self):
+        return self.action_name_and_method[1]
+
+    def form_valid(self, form):
+        self.has_content_changes = self.form.has_changed()
+        return self.action_method()
 
     def save_action(self):
         self.page = self.form.save(commit=not self.page.live)
@@ -537,6 +555,7 @@ class EditView(WagtailAdminTemplateMixin, HookResponseMixin, View):
             user=self.request.user,
             log_action=True,  # Always log the new revision on edit
             previous_revision=self.previous_revision,
+            clean=False,
         )
 
         self.add_save_confirmation_message()

wagtail/admin/views/pages/listing.py

@@ -23,7 +23,7 @@ from wagtail.admin.ui.components import MediaContainer
 from wagtail.admin.ui.side_panels import (
     PageStatusSidePanel,
 )
-from wagtail.admin.ui.tables import Column, DateColumn
+from wagtail.admin.ui.tables import DateColumn
 from wagtail.admin.ui.tables.pages import (
     BulkActionsColumn,
     NavigateToChildrenColumn,
@@ -31,6 +31,7 @@ from wagtail.admin.ui.tables.pages import (
     PageStatusColumn,
     PageTable,
     PageTitleColumn,
+    PageTypeColumn,
     ParentPageColumn,
 )
 from wagtail.admin.views import generic
@@ -147,7 +148,7 @@ class PageListingMixin:
             sort_key="latest_revision_created_at",
             width="12%",
         ),
-        Column(
+        PageTypeColumn(
             "type",
             label=_("Type"),
             accessor="page_type_display_name",

wagtail/admin/views/pages/move.py

@@ -4,6 +4,8 @@ from django.shortcuts import get_object_or_404, redirect
 from django.template.response import TemplateResponse
 from django.urls import reverse
 from django.utils.translation import gettext as _
+from django.views.generic.base import TemplateView
+from django.views.generic.edit import FormMixin
 
 from wagtail import hooks
 from wagtail.actions.move_page import MovePageAction
@@ -12,39 +14,51 @@ from wagtail.admin.forms.pages import MoveForm
 from wagtail.models import Page
 
 
-def move_choose_destination(request, page_to_move_id):
-    page_to_move = get_object_or_404(Page, id=page_to_move_id)
-    page_perms = page_to_move.permissions_for_user(request.user)
-    if not page_perms.can_move():
-        raise PermissionDenied
+class MoveChooseDestination(TemplateView, FormMixin):
+    template_name = "wagtailadmin/pages/move_choose_destination.html"
+    form_class = MoveForm
 
-    target_parent_models = set(page_to_move.specific_class.allowed_parent_page_models())
+    def setup(self, request, *args, **kwargs):
+        super().setup(request, *args, **kwargs)
+        self.page_to_move = get_object_or_404(Page, id=kwargs["page_to_move_id"])
+        self.page_perms = self.page_to_move.permissions_for_user(request.user)
 
-    move_form = MoveForm(
-        request.POST or None,
-        page_to_move=page_to_move,
-        target_parent_models=target_parent_models,
-    )
+        if not self.page_perms.can_move():
+            raise PermissionDenied
 
-    if request.method == "POST":
-        if move_form.is_valid():
-            # Receive the new parent page (this should never be empty)
-            if move_form.cleaned_data["new_parent_page"]:
-                new_parent_page = move_form.cleaned_data["new_parent_page"]
-                return redirect(
-                    "wagtailadmin_pages:move_confirm",
-                    page_to_move.id,
-                    new_parent_page.id,
-                )
+    def get_form_kwargs(self):
+        kwargs = super().get_form_kwargs()
+        target_parent_models = set(
+            self.page_to_move.specific_class.allowed_parent_page_models()
+        )
+        kwargs["target_parent_models"] = target_parent_models
+        kwargs["page_to_move"] = self.page_to_move
+
+        return kwargs
+
+    def get_context_data(self, **kwargs):
+        context = super().get_context_data(**kwargs)
+        context["page_to_move"] = self.page_to_move
+        context["move_form"] = self.get_form()
+
+        return context
+
+    def form_valid(self, form):
+        # Receive the new parent page (this should never be empty)
+        if form.cleaned_data["new_parent_page"]:
+            new_parent_page = form.cleaned_data["new_parent_page"]
+            return redirect(
+                "wagtailadmin_pages:move_confirm",
+                self.page_to_move.id,
+                new_parent_page.id,
+            )
+        return super().form_valid(form)
 
-    return TemplateResponse(
-        request,
-        "wagtailadmin/pages/move_choose_destination.html",
-        {
-            "page_to_move": page_to_move,
-            "move_form": move_form,
-        },
-    )
+    def post(self, request, *args, **kwargs):
+        form = self.get_form()
+        if form.is_valid():
+            return self.form_valid(form)
+        return self.form_invalid(form)
 
 
 def move_confirm(request, page_to_move_id, destination_id):

wagtail/admin/views/pages/preview.py

@@ -1,7 +1,10 @@
+import uuid
+
 from django.contrib.contenttypes.models import ContentType
 from django.core.exceptions import PermissionDenied
 from django.http import Http404
 from django.shortcuts import get_object_or_404
+from django.utils.translation import gettext
 
 from wagtail.admin.views.generic.preview import PreviewOnEdit as GenericPreviewOnEdit
 from wagtail.models import Page
@@ -43,6 +46,16 @@ class PreviewOnEdit(GenericPreviewOnEdit):
                 for_user=self.request.user,
             )
 
+        query_dict = query_dict.copy()
+
+        if not query_dict.get("title"):
+            query_dict["title"] = gettext("Placeholder title")
+
+        # Generate a random slug if one is not provided, use UUID to ensure
+        # uniqueness without needing to hit the database
+        if not query_dict.get("slug"):
+            query_dict["slug"] = str(uuid.uuid4())
+
         return form_class(
             query_dict,
             instance=self.object,
@@ -95,9 +108,9 @@ class PreviewOnCreate(PreviewOnEdit):
 
     def get_form(self, query_dict):
         form = super().get_form(query_dict)
-        if form.is_valid():
+        if self.validate_form(form):
             # Ensures our unsaved page has a suitable url.
             form.instance.set_url_path(form.parent_page)
 
-            form.instance.full_clean()
+            form.instance.minimal_clean()
         return form

wagtail/admin/views/pages/search.py

@@ -60,6 +60,9 @@ class SearchView(PageListingMixin, PermissionCheckedMixin, BaseListingView):
     index_results_url_name = "wagtailadmin_pages:search_results"
     # We override get_queryset here that has a custom search implementation
     is_searchable = True
+    # The queryset always gets passed to the search backend even if
+    # the search query is empty, so we are always "searching"
+    is_searching = True
     # This view has its own filtering mechanism that doesn't use django-filter
     filterset_class = None
     template_name = "wagtailadmin/pages/search.html"

wagtail/admin/views/reports/base.py

@@ -1,11 +1,8 @@
-from warnings import warn
-
 from django.utils.translation import gettext_lazy as _
 
 from wagtail.admin.views.generic import BaseListingView, PermissionCheckedMixin
 from wagtail.admin.views.mixins import SpreadsheetExportMixin
 from wagtail.permissions import page_permission_policy
-from wagtail.utils.deprecation import RemovedInWagtail70Warning
 
 
 class ReportView(SpreadsheetExportMixin, PermissionCheckedMixin, BaseListingView):
@@ -14,20 +11,6 @@ class ReportView(SpreadsheetExportMixin, PermissionCheckedMixin, BaseListingView
     title = ""
     paginate_by = 50
 
-    def get_page_title(self):
-        if self.page_title:
-            return self.page_title
-        # WagtailAdminTemplateMixin uses `page_title`, but the documented approach
-        # for ReportView used `title`, so we need to support both during the
-        # deprecation period. When `title` is removed, this and the `get_context_data`
-        # overrides can be removed.
-        warn(
-            f"The `title` attribute in `{self.__class__.__name__}` (a `ReportView` subclass) "
-            "is deprecated. Use `page_title` instead.",
-            RemovedInWagtail70Warning,
-        )
-        return self.title
-
     def get_filtered_queryset(self):
         return self.filter_queryset(self.get_queryset())
 
@@ -45,11 +28,6 @@ class ReportView(SpreadsheetExportMixin, PermissionCheckedMixin, BaseListingView
         )
         return self.render_to_response(context)
 
-    def get_context_data(self, *args, **kwargs):
-        context = super().get_context_data(*args, **kwargs)
-        context["title"] = self.get_page_title()
-        return context
-
     def render_to_response(self, context, **response_kwargs):
         if self.is_export:
             return self.as_spreadsheet(

wagtail/admin/views/reports/page_types_usage.py

@@ -1,12 +1,13 @@
 import django_filters
 from django.conf import settings
+from django.contrib.contenttypes.models import ContentType
 from django.db.models import Count, F, OuterRef, Q, Subquery
 from django.utils.translation import gettext_lazy as _
 
 from wagtail.admin.filters import WagtailFilterSet
 from wagtail.admin.views.reports import ReportView
 from wagtail.coreutils import get_content_languages
-from wagtail.models import ContentType, Page, Site, get_page_models
+from wagtail.models import Page, Site, get_page_models
 from wagtail.permissions import page_permission_policy
 
 

wagtail/admin/views/tags.py

@@ -2,6 +2,8 @@ from django.contrib.contenttypes.models import ContentType
 from django.http import Http404, JsonResponse
 from taggit.models import Tag, TagBase
 
+TAGS_AUTOCOMPLETE_LIMIT = 10
+
 
 def autocomplete(request, app_name=None, model_name=None):
     if app_name and model_name:
@@ -22,7 +24,7 @@ def autocomplete(request, app_name=None, model_name=None):
         tags = (
             tag_model.objects.filter(name__istartswith=term)
             .order_by("name")
-            .values_list("name", flat=True)[:10]
+            .values_list("name", flat=True)[:TAGS_AUTOCOMPLETE_LIMIT]
         )
     else:
         tags = tag_model.objects.none()

wagtail/admin/views/workflows.py

@@ -637,7 +637,6 @@ def select_task_type(request):
 
 class CreateTask(CreateView):
     permission_policy = task_permission_policy
-    model = None
     page_title = _("New workflow task")
     template_name = "wagtailadmin/workflows/create_task.html"
     success_message = _("Task '%(object)s' created.")
@@ -694,8 +693,6 @@ class CreateTask(CreateView):
 
 class EditTask(EditView):
     permission_policy = task_permission_policy
-    model = None
-    page_title = _("Editing workflow task")
     template_name = "wagtailadmin/workflows/edit_task.html"
     success_message = _("Task '%(object)s' updated.")
     add_url_name = "wagtailadmin_workflows:select_task_type"