wagtail 7.0.2__py3-none-any.whl → 7.1rc1__py3-none-any.whl

wagtail/users/tests/test_bulk_actions/test_bulk_delete.py

@@ -1,9 +1,14 @@
+import unittest
+
+from django.conf import settings
 from django.contrib.auth import get_user_model
 from django.contrib.auth.models import Permission
 from django.http import HttpRequest, HttpResponse
 from django.test import TestCase
 from django.urls import reverse
+from django.utils.http import urlencode
 
+from wagtail.test.testapp.models import VariousOnDeleteModel
 from wagtail.test.utils import WagtailTestUtils
 from wagtail.users.views.bulk_actions.user_bulk_action import UserBulkAction
 
@@ -11,10 +16,11 @@ User = get_user_model()
 
 
 class TestUserDeleteView(WagtailTestUtils, TestCase):
-    def setUp(self):
+    @classmethod
+    def setUpTestData(cls):
         # create a set of test users
-        self.test_users = [
-            self.create_user(
+        cls.test_users = [
+            cls.create_user(
                 username=f"testuser-{i}",
                 email=f"testuser{i}@email.com",
                 password=f"password-{i}",
@@ -22,13 +28,12 @@ class TestUserDeleteView(WagtailTestUtils, TestCase):
             for i in range(1, 6)
         ]
         # also create a superuser to delete
-        self.superuser = self.create_superuser(
+        cls.superuser = cls.create_superuser(
             username="testsuperuser",
             email="testsuperuser@email.com",
             password="password",
         )
-        self.current_user = self.login()
-        self.url = (
+        cls.base_url = (
             reverse(
                 "wagtail_bulk_action",
                 args=(
@@ -39,11 +44,17 @@ class TestUserDeleteView(WagtailTestUtils, TestCase):
             )
             + "?"
         )
-        for user in self.test_users:
-            self.url += f"id={user.pk}&"
+        cls.query_params = {
+            "next": reverse("wagtailusers_users:index"),
+            "id": [user.pk for user in cls.test_users],
+        }
+        cls.url = cls.base_url + urlencode(cls.query_params, doseq=True)
 
-        self.self_delete_url = self.url + f"id={self.current_user.pk}"
-        self.superuser_delete_url = self.url + f"id={self.superuser.pk}"
+        cls.superuser_delete_url = cls.base_url + f"id={cls.superuser.pk}"
+
+    def setUp(self):
+        self.current_user = self.login()
+        self.self_delete_url = self.base_url + f"id={self.current_user.pk}"
 
     def test_simple(self):
         response = self.client.get(self.url)
@@ -142,3 +153,99 @@ class TestUserDeleteView(WagtailTestUtils, TestCase):
 
         for user in self.test_users:
             self.assertFalse(User.objects.filter(email=user.email).exists())
+
+    def test_delete_get_with_protected_reference(self):
+        protected = self.test_users[0]
+        model_name = User._meta.verbose_name
+        with self.captureOnCommitCallbacks(execute=True):
+            VariousOnDeleteModel.objects.create(
+                text="Undeletable",
+                protected_user=protected,
+            )
+        response = self.client.get(self.url)
+        self.assertEqual(response.status_code, 200)
+        soup = self.get_soup(response.content)
+        main = soup.select_one("main")
+        usage_link = main.find(
+            "a",
+            href=reverse("wagtailusers_users:usage", args=[protected.pk])
+            + "?describe_on_delete=1",
+        )
+        self.assertIsNotNone(usage_link)
+        self.assertEqual(
+            usage_link.text.strip(), f"This {model_name} is referenced 1 time."
+        )
+        self.assertContains(
+            response,
+            f"One or more references to this {model_name} prevent it from being deleted.",
+        )
+        submit_button = main.select_one("form button[type=submit]")
+        self.assertIsNone(submit_button)
+        back_button = main.find("a", href=reverse("wagtailusers_users:index"))
+        self.assertIsNotNone(back_button)
+        self.assertEqual(back_button.text.strip(), "Go back")
+
+    def test_delete_post_with_protected_reference(self):
+        protected = self.test_users[0]
+        with self.captureOnCommitCallbacks(execute=True):
+            VariousOnDeleteModel.objects.create(
+                text="Undeletable",
+                protected_user=protected,
+            )
+        response = self.client.post(self.url)
+
+        # Should throw a PermissionDenied error and redirect to the dashboard
+        self.assertEqual(response.status_code, 302)
+        self.assertRedirects(response, reverse("wagtailadmin_home"))
+        self.assertEqual(
+            response.context["message"],
+            "Sorry, you do not have permission to access this area.",
+        )
+
+        # Check that the user is still here
+        self.assertTrue(User.objects.filter(pk=protected.pk).exists())
+
+    def test_with_search(self):
+        self.create_user(
+            username="raz",
+            email="raz@email.com",
+            password="password",
+            first_name="Razputin",
+            last_name="Aquato",
+        )
+        response = self.client.get(
+            reverse(
+                "wagtail_bulk_action",
+                args=(User._meta.app_label, User._meta.model_name, "delete"),
+            ),
+            {"q": "raz", "id": "all"},
+        )
+        self.assertEqual(response.status_code, 200)
+        self.assertContains(response, "Razputin")
+        self.assertNotContains(response, "testuser")
+
+    @unittest.skipUnless(
+        settings.AUTH_USER_MODEL == "customuser.CustomUser",
+        "Only applicable to CustomUser",
+    )
+    def test_with_search_backend(self):
+        self.create_user(
+            username="raz",
+            email="raz@email.com",
+            password="password",
+            first_name="Razputin",
+            last_name="Aquato",
+            country="Grulovia",
+        )
+        response = self.client.get(
+            reverse(
+                "wagtail_bulk_action",
+                args=(User._meta.app_label, User._meta.model_name, "delete"),
+            ),
+            # The country field is defined in the model's search_fields,
+            # which only works with an indexed model
+            {"q": "gru", "id": "all"},
+        )
+        self.assertEqual(response.status_code, 200)
+        self.assertContains(response, "Razputin")
+        self.assertNotContains(response, "testuser")

wagtail/users/views/bulk_actions/delete.py

@@ -1,11 +1,13 @@
+from django.urls import reverse
 from django.utils.translation import gettext_lazy as _
 from django.utils.translation import ngettext
 
+from wagtail.admin.views.bulk_action.mixins import ReferenceIndexMixin
 from wagtail.users.utils import user_can_delete_user
 from wagtail.users.views.bulk_actions.user_bulk_action import UserBulkAction
 
 
-class DeleteBulkAction(UserBulkAction):
+class DeleteBulkAction(ReferenceIndexMixin, UserBulkAction):
     display_name = _("Delete")
     action_type = "delete"
     aria_label = _("Delete selected users")
@@ -26,6 +28,12 @@ class DeleteBulkAction(UserBulkAction):
         model.objects.filter(pk__in=[obj.pk for obj in objects]).delete()
         return len(objects), 0
 
+    def get_usage_url(self, item):
+        return (
+            reverse("wagtailusers_users:usage", args=(item.pk,))
+            + "?describe_on_delete=1"
+        )
+
     def get_success_message(self, num_parent_objects, num_child_objects):
         return ngettext(
             "%(num_parent_objects)d user has been deleted",

wagtail/users/views/bulk_actions/user_bulk_action.py

@@ -1,9 +1,11 @@
 from django.contrib.auth import get_user_model
+from django.db.models import Q
 
 from wagtail.admin.views.bulk_action import BulkAction
 from wagtail.admin.views.generic.permissions import PermissionCheckedMixin
 from wagtail.permission_policies import ModelPermissionPolicy
-from wagtail.users.views.users import get_users_filter_query
+from wagtail.search.backends import get_search_backend
+from wagtail.search.index import class_is_indexed
 
 User = get_user_model()
 
@@ -15,11 +17,18 @@ class UserBulkAction(PermissionCheckedMixin, BulkAction):
 
     def get_all_objects_in_listing_query(self, parent_id):
         listing_objects = self.model.objects.all().values_list("pk", flat=True)
-        if "q" in self.request.GET:
-            q = self.request.GET.get("q")
-            model_fields = {f.name for f in self.model._meta.get_fields()}
-            conditions = get_users_filter_query(q, model_fields)
 
-            listing_objects = listing_objects.filter(conditions)
+        if q := self.request.GET.get("q"):
+            if class_is_indexed(self.model):
+                search_backend = get_search_backend()
+                return search_backend.autocomplete(q, listing_objects)
+
+            model_fields = {f.name for f in self.model._meta.get_fields()}
+            filterable_fields = {"username", "first_name", "last_name", "email"}
+            common_fields = model_fields & filterable_fields
+            conditions = Q()
+            for field in common_fields:
+                conditions |= Q(**{f"{field}__icontains": q})
+            return listing_objects.filter(conditions)
 
         return listing_objects

wagtail/users/views/users.py

@@ -5,7 +5,6 @@ from django.contrib.auth import (
 )
 from django.contrib.auth.models import Group
 from django.core.exceptions import FieldDoesNotExist, PermissionDenied
-from django.db.models import Q
 from django.forms import CheckboxSelectMultiple
 from django.urls import reverse
 from django.utils.functional import cached_property
@@ -13,13 +12,18 @@ from django.utils.translation import gettext as _
 from django.utils.translation import gettext_lazy
 
 from wagtail import hooks
-from wagtail.admin.filters import DateRangePickerWidget, WagtailFilterSet
+from wagtail.admin.filters import (
+    DateRangePickerWidget,
+    RelatedFilterMixin,
+    WagtailFilterSet,
+)
 from wagtail.admin.search import SearchArea
+from wagtail.admin.ui.menus import MenuItem
 from wagtail.admin.ui.tables import (
+    BooleanColumn,
     BulkActionsCheckboxColumn,
     Column,
     DateColumn,
-    StatusTagColumn,
     TitleColumn,
 )
 from wagtail.admin.utils import get_user_display_name
@@ -27,10 +31,12 @@ from wagtail.admin.views import generic
 from wagtail.admin.viewsets.model import ModelViewSet
 from wagtail.admin.widgets.boolean_radio_select import BooleanRadioSelect
 from wagtail.admin.widgets.button import (
-    BaseDropdownMenuButton,
+    BaseButton,
+    Button,
     ButtonWithDropdown,
 )
 from wagtail.compat import AUTH_USER_APP_LABEL, AUTH_USER_MODEL_NAME
+from wagtail.search import index
 from wagtail.users.forms import UserCreationForm, UserEditForm
 from wagtail.users.utils import user_can_delete_user
 
@@ -49,29 +55,14 @@ delete_user_perm = "{}.delete_{}".format(
 )
 
 
-def get_users_filter_query(q, model_fields):
-    conditions = Q()
-
-    for term in q.split():
-        if "username" in model_fields:
-            conditions |= Q(username__icontains=term)
-
-        if "first_name" in model_fields:
-            conditions |= Q(first_name__icontains=term)
-
-        if "last_name" in model_fields:
-            conditions |= Q(last_name__icontains=term)
-
-        if "email" in model_fields:
-            conditions |= Q(email__icontains=term)
-
-    return conditions
-
-
 class UserColumn(TitleColumn):
     cell_template_name = "wagtailusers/users/user_cell.html"
 
 
+class GroupFilter(RelatedFilterMixin, django_filters.ModelMultipleChoiceFilter):
+    pass
+
+
 class UserFilterSet(WagtailFilterSet):
     is_superuser = django_filters.BooleanFilter(
         label=gettext_lazy("Administrator"),
@@ -81,14 +72,10 @@ class UserFilterSet(WagtailFilterSet):
         label=gettext_lazy("Last login"),
         widget=DateRangePickerWidget,
     )
-    group = django_filters.ModelMultipleChoiceFilter(
-        field_name="groups",
-        queryset=Group.objects.all(),
-        label=gettext_lazy("Group"),
-        widget=CheckboxSelectMultiple,
-    )
 
-    def __init__(self, data=None, queryset=None, *, request=None, prefix=None):
+    def __init__(
+        self, data=None, queryset=None, *, request=None, prefix=None, is_searching=False
+    ):
         super().__init__(data, queryset, request=request, prefix=prefix)
         try:
             self._meta.model._meta.get_field("is_active")
@@ -102,6 +89,14 @@ class UserFilterSet(WagtailFilterSet):
             )
             self.filters.move_to_end("is_active", last=False)
 
+        self.filters["group"] = GroupFilter(
+            field_name="groups",
+            queryset=Group.objects.all(),
+            label=gettext_lazy("Group"),
+            use_subquery=is_searching,
+            widget=CheckboxSelectMultiple,
+        )
+
     class Meta:
         model = User
         fields = []
@@ -116,9 +111,6 @@ class IndexView(generic.IndexView):
     results_template_name = "wagtailusers/users/index_results.html"
     add_item_label = gettext_lazy("Add a user")
     context_object_name = "users"
-    # We don't set search_fields and the model may not be indexed, but we override
-    # search_queryset, so we set is_searchable to True to enable search
-    is_searchable = True
     page_title = gettext_lazy("Users")
     show_other_searches = True
 
@@ -153,13 +145,9 @@ class IndexView(generic.IndexView):
                 classname="level",
                 width="10%",
             ),
-            StatusTagColumn(
+            BooleanColumn(
                 "is_active",
-                accessor=lambda u: gettext_lazy("Active")
-                if u.is_active
-                else gettext_lazy("Inactive"),
-                primary=lambda u: u.is_active,
-                label=gettext_lazy("Status"),
+                label=gettext_lazy("Active"),
                 sort_key="is_active" if "is_active" in self.model_fields else None,
                 classname="status",
                 width="10%",
@@ -177,29 +165,46 @@ class IndexView(generic.IndexView):
     def model_fields(self):
         return {f.name for f in User._meta.get_fields()}
 
+    @cached_property
+    def search_fields(self):
+        # Use search_fields from the model if we're using Wagtail search
+        if index.class_is_indexed(User) and self.search_backend_name:
+            return None
+        return self.model_fields & {"username", "first_name", "last_name", "email"}
+
+    def get_filterset_kwargs(self):
+        kwargs = super().get_filterset_kwargs()
+        kwargs["is_searching"] = self.is_searching
+        return kwargs
+
     def get_delete_url(self, instance):
         if user_can_delete_user(self.request.user, instance):
             return super().get_delete_url(instance)
 
     def get_list_buttons(self, instance):
-        more_buttons = self.get_list_more_buttons(instance)
+        more_buttons = []
         list_buttons = []
 
+        buttons = self.get_list_more_buttons(instance)
         for hook in hooks.get_hooks("register_user_listing_buttons"):
-            hook_buttons = hook(user=instance, request_user=self.request.user)
-
-            for button in hook_buttons:
-                if isinstance(button, BaseDropdownMenuButton):
-                    # If the button is a dropdown menu, add it to the top-level
-                    # because we do not support nested dropdowns
-                    list_buttons.append(button)
-                else:
-                    # Otherwise, add it to the default "More" dropdown
-                    more_buttons.append(button)
+            buttons.extend(hook(user=instance, request_user=self.request.user))
+
+        for button in buttons:
+            if isinstance(button, BaseButton) and not button.allow_in_dropdown:
+                # If the button is not allowed in a dropdown menu, add it to
+                # the top-level list of buttons
+                list_buttons.append(button)
+            elif isinstance(button, MenuItem):
+                # Allow simple MenuItem instances to be passed in directly
+                if button.is_shown(self.request.user):
+                    more_buttons.append(Button.from_menu_item(button))
+            elif button.show:
+                # Otherwise, add it to the default "More" dropdown
+                more_buttons.append(button)
 
         list_buttons.append(
             ButtonWithDropdown(
-                buttons=sorted(more_buttons),
+                buttons=more_buttons,
                 icon_name="dots-horizontal",
                 attrs={
                     "aria-label": _("More options for '%(title)s'")
@@ -208,7 +213,7 @@ class IndexView(generic.IndexView):
             )
         )
 
-        return sorted(list_buttons)
+        return list_buttons
 
     def get_base_queryset(self):
         users = User._default_manager.all()
@@ -225,12 +230,6 @@ class IndexView(generic.IndexView):
             return queryset.order_by("-last_name", "-first_name")
         return super().order_queryset(queryset)
 
-    def search_queryset(self, queryset):
-        if self.is_searching:
-            conditions = get_users_filter_query(self.search_query, self.model_fields)
-            return queryset.filter(conditions)
-        return queryset
-
 
 class CreateView(generic.CreateView):
     """
@@ -362,14 +361,6 @@ class UserViewSet(ModelViewSet):
 
     template_prefix = "wagtailusers/users/"
 
-    def get_common_view_kwargs(self, **kwargs):
-        return super().get_common_view_kwargs(
-            **{
-                "usage_url_name": None,
-                **kwargs,
-            }
-        )
-
     def get_form_class(self, for_update=False):
         if for_update:
             return UserEditForm

wagtail/users/widgets.py

@@ -1,5 +1,15 @@
-from wagtail.admin.widgets import ListingButton
+from warnings import warn
 
+from wagtail.admin.widgets import Button
+from wagtail.utils.deprecation import RemovedInWagtail80Warning
 
-class UserListingButton(ListingButton):
-    pass
+
+class UserListingButton(Button):
+    def __init__(self, *args, **kwargs):
+        warn(
+            "`UserListingButton` is deprecated. "
+            "Use `wagtail.admin.widgets.button.Button` "
+            "or `wagtail.admin.widgets.button.ListingButton` instead.",
+            category=RemovedInWagtail80Warning,
+        )
+        super().__init__(*args, **kwargs)

wagtail/widget_adapters.py

@@ -1,80 +1,16 @@
-"""
-Register Telepath adapters for core Django form widgets, so that they can
-have corresponding Javascript objects with the ability to render new instances
-and extract field values.
-"""
-
-from django import forms
-from django.core.exceptions import ValidationError
-from django.utils.functional import cached_property
-
-from wagtail.admin.staticfiles import versioned_static
-from wagtail.telepath import Adapter, register
-
-
-class WidgetAdapter(Adapter):
-    js_constructor = "wagtail.widgets.Widget"
-
-    def js_args(self, widget):
-        return [
-            widget.render("__NAME__", None, attrs={"id": "__ID__"}),
-            widget.id_for_label("__ID__"),
-        ]
-
-    def get_media(self, widget):
-        media = super().get_media(widget)
-        return media + widget.media
-
-    @cached_property
-    def media(self):
-        return forms.Media(
-            js=[
-                versioned_static("wagtailadmin/js/telepath/widgets.js"),
-            ]
-        )
-
-
-register(WidgetAdapter(), forms.widgets.Input)
-register(WidgetAdapter(), forms.Textarea)
-
-
-class CheckboxInputAdapter(WidgetAdapter):
-    js_constructor = "wagtail.widgets.CheckboxInput"
-
-
-register(CheckboxInputAdapter(), forms.CheckboxInput)
-
-
-class RadioSelectAdapter(WidgetAdapter):
-    js_constructor = "wagtail.widgets.RadioSelect"
-
-
-register(RadioSelectAdapter(), forms.RadioSelect)
-register(RadioSelectAdapter(), forms.CheckboxSelectMultiple)
-
-
-class SelectAdapter(WidgetAdapter):
-    js_constructor = "wagtail.widgets.Select"
-
-
-register(SelectAdapter(), forms.Select)
-
-
-class ValidationErrorAdapter(Adapter):
-    js_constructor = "wagtail.errors.ValidationError"
-
-    def js_args(self, error):
-        return [
-            error.messages,
-        ]
-
-    @cached_property
-    def media(self):
-        return forms.Media(
-            js=[
-                versioned_static("wagtailadmin/js/telepath/widgets.js"),
-            ]
-        )
-
-
-register(ValidationErrorAdapter(), ValidationError)
+import warnings
+
+from wagtail.admin.telepath.widgets import (  # noqa: F401
+    CheckboxInputAdapter,
+    RadioSelectAdapter,
+    SelectAdapter,
+    ValidationErrorAdapter,
+    WidgetAdapter,
+)
+from wagtail.utils.deprecation import RemovedInWagtail80Warning
+
+warnings.warn(
+    "wagtail.widget_adapters has been moved to wagtail.admin.telepath.widgets",
+    RemovedInWagtail80Warning,
+    stacklevel=2,
+)

{wagtail-7.0.2.dist-info → wagtail-7.1rc1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wagtail
-Version: 7.0.2
+Version: 7.1rc1
 Summary: A Django content management system.
 Author-email: Wagtail core team + contributors <hello@wagtail.org>
 License-Expression: BSD-3-Clause
@@ -56,6 +56,7 @@ Requires-Dist: freezegun>=0.3.8; extra == "testing"
 Requires-Dist: azure-mgmt-cdn<13.0,>=12.0; extra == "testing"
 Requires-Dist: azure-mgmt-frontdoor<1.1,>=1.0; extra == "testing"
 Requires-Dist: django-pattern-library>=0.7; extra == "testing"
+Requires-Dist: responses<1,>=0.25; extra == "testing"
 Requires-Dist: coverage>=3.7.0; extra == "testing"
 Requires-Dist: doc8==1.1.2; extra == "testing"
 Requires-Dist: ruff==0.9.6; extra == "testing"
@@ -217,8 +218,5 @@ We thank the following organisations for their services used in Wagtail's develo
 [![Browserstack](https://cdn.jsdelivr.net/gh/wagtail/wagtail@main/.github/browserstack-logo.svg)](https://www.browserstack.com/)<br>
 [BrowserStack](https://www.browserstack.com/) provides the project with free access to their live web-based browser testing tool, and automated Selenium cloud testing.
 
-[![squash.io](https://cdn.jsdelivr.net/gh/wagtail/wagtail@main/.github/squash-logo.svg)](https://www.squash.io/)<br>
-[Squash](https://www.squash.io/) provides the project with free test environments for reviewing pull requests.
-
 [![Assistiv Labs](https://cdn.jsdelivr.net/gh/wagtail/wagtail@main/.github/assistivlabs-logo.png)](https://assistivlabs.com/)<br>
 [Assistiv Labs](https://assistivlabs.com/) provides the project with unlimited access to their remote testing with assistive technologies.