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

wagtail/tests/test_utils.py

@@ -1,9 +1,13 @@
 import hashlib
+import os
 import pickle
+import tempfile
 import unittest
+import warnings
 from io import BytesIO
 from pathlib import Path
 
+from django.conf import settings
 from django.contrib.contenttypes.models import ContentType
 from django.core.exceptions import ImproperlyConfigured, SuspiciousOperation
 from django.core.files.uploadedfile import SimpleUploadedFile
@@ -27,7 +31,9 @@ from wagtail.coreutils import (
     string_to_ascii,
 )
 from wagtail.models import Page, Site
+from wagtail.utils.deprecation import RemovedInWagtail70Warning
 from wagtail.utils.file import hash_filelike
+from wagtail.utils.templates import template_is_overridden
 from wagtail.utils.utils import deep_update, flatten_choices
 from wagtail.utils.version import get_main_version
 
@@ -578,6 +584,41 @@ class HashFileLikeTestCase(SimpleTestCase):
         )
 
 
+class TestTemplateIsOverridden(SimpleTestCase):
+    def setUp(self):
+        template_is_overridden.cache_clear()
+
+    def test_template_is_overridden_false(self):
+        self.assertIs(
+            template_is_overridden(
+                "wagtailcore/shared/block_preview.html",
+                "templates",
+            ),
+            False,
+        )
+
+    def test_template_is_overridden_true(self):
+        with tempfile.TemporaryDirectory() as temp_dir:
+            path = os.path.join(temp_dir, "wagtailcore/shared")
+            os.makedirs(path, exist_ok=True)
+            with open(os.path.join(path, "block_preview.html"), "w") as f:
+                f.write("Custom file")
+
+            with self.settings(
+                TEMPLATES=[
+                    {**settings.TEMPLATES[0], "DIRS": [temp_dir], "NAME": "tmp"},
+                    *settings.TEMPLATES,
+                ]
+            ):
+                self.assertIs(
+                    template_is_overridden(
+                        "wagtailcore/shared/block_preview.html",
+                        "templates",
+                    ),
+                    True,
+                )
+
+
 class TestVersion(SimpleTestCase):
     def test_get_main_version(self):
         cases = [
@@ -616,3 +657,23 @@ class TestFlattenChoices(SimpleTestCase):
                 "unknown": "Unknown",
             },
         )
+
+
+class TestWidgetWithScript(TestCase):
+    def test_deprecation(self):
+        message = "The usage of `WidgetWithScript` hook is deprecated. Use external scripts instead."
+
+        with unittest.mock.patch("warnings.warn", wraps=warnings.warn) as warn_mock:
+            with self.assertWarnsMessage(RemovedInWagtail70Warning, message):
+                from wagtail.utils.widgets import WidgetWithScript
+
+                class MyWidget(WidgetWithScript):
+                    pass
+
+        # Make sure warn was called with stacklevel=3, so the actual caller
+        # that imports WidgetWithScript is shown in the warning message
+        warn_mock.assert_called_with(
+            message,
+            category=RemovedInWagtail70Warning,
+            stacklevel=3,
+        )

wagtail/users/forms.py

@@ -15,6 +15,7 @@ from django.utils.html import mark_safe
 from django.utils.translation import gettext_lazy as _
 
 from wagtail import hooks
+from wagtail.admin.forms.formsets import BaseFormSetMixin
 from wagtail.admin.widgets import AdminPageChooser
 from wagtail.models import (
     PAGE_PERMISSION_CODENAMES,
@@ -319,7 +320,7 @@ class PagePermissionsForm(forms.Form):
     )
 
 
-class BaseGroupPagePermissionFormSet(forms.BaseFormSet):
+class BaseGroupPagePermissionFormSet(BaseFormSetMixin, forms.BaseFormSet):
     # defined here for easy access from templates
     permission_types = PAGE_PERMISSION_TYPES
 
@@ -350,14 +351,6 @@ class BaseGroupPagePermissionFormSet(forms.BaseFormSet):
             )
 
         super().__init__(data, files, initial=initial_data, prefix=prefix)
-        for form in self.forms:
-            form.fields["DELETE"].widget = forms.HiddenInput()
-
-    @property
-    def empty_form(self):
-        empty_form = super().empty_form
-        empty_form.fields["DELETE"].widget = forms.HiddenInput()
-        return empty_form
 
     def clean(self):
         """Checks that no two forms refer to the same page object"""

wagtail/users/locale/en/LC_MESSAGES/django.po

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2024-10-21 17:53+0100\n"
+"POT-Creation-Date: 2025-01-20 17:59+0000\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
@@ -22,63 +22,63 @@ msgstr ""
 msgid "Wagtail users"
 msgstr ""
 
-#: forms.py:55
+#: forms.py:56
 msgid "Required. Letters, digits and @/./+/-/_ only."
 msgstr ""
 
-#: forms.py:60
+#: forms.py:61
 msgid "This value may contain only letters, numbers and @/./+/-/_ characters."
 msgstr ""
 
-#: forms.py:86
+#: forms.py:87
 msgid "A user with that username already exists."
 msgstr ""
 
-#: forms.py:87
+#: forms.py:88
 msgid "The two password fields didn't match."
 msgstr ""
 
-#: forms.py:90
+#: forms.py:91
 msgid "Email"
 msgstr ""
 
-#: forms.py:91
+#: forms.py:92
 msgid "First Name"
 msgstr ""
 
-#: forms.py:92
+#: forms.py:93
 msgid "Last Name"
 msgstr ""
 
-#: forms.py:95
+#: forms.py:96
 msgid "Password"
 msgstr ""
 
-#: forms.py:98
+#: forms.py:99
 msgid "Leave blank if not changing."
 msgstr ""
 
-#: forms.py:102
+#: forms.py:103
 msgid "Password confirmation"
 msgstr ""
 
-#: forms.py:105
+#: forms.py:106
 msgid "Enter the same password as above, for verification."
 msgstr ""
 
-#: forms.py:110 forms.py:247 views/users.py:110
+#: forms.py:111 forms.py:248 views/users.py:110
 msgid "Administrator"
 msgstr ""
 
-#: forms.py:113 forms.py:249
+#: forms.py:114 forms.py:250
 msgid "Administrators have full access to manage any object or setting."
 msgstr ""
 
-#: forms.py:243
+#: forms.py:244
 msgid "A group with that name already exists."
 msgstr ""
 
-#: forms.py:378
+#: forms.py:371
 msgid "You cannot have multiple permission records for the same page."
 msgstr ""
 
@@ -400,7 +400,7 @@ msgstr ""
 msgid "Can view"
 msgstr ""
 
-#: utils.py:53
+#: utils.py:85
 #, python-format
 msgid "user %(id)s (deleted)"
 msgstr ""

wagtail/users/templates/wagtailusers/groups/create.html

@@ -24,8 +24,3 @@
         </div>
     {% endblock %}
 {% endblock %}
-
-{% block extra_js %}
-    {{ block.super }}
-    {% include "wagtailusers/groups/includes/group_form_js.html" %}
-{% endblock %}

wagtail/users/templates/wagtailusers/groups/includes/page_permissions_form.html

@@ -10,5 +10,5 @@
 {% endfor %}
 
 <td>
-    <button class="button button-small no" type="button" id="{{ form.DELETE.id_for_label }}-button">{% trans "Delete" %}</button>
+    <button class="button button-small no" type="button" id="{{ form.DELETE.id_for_label }}-button" data-action="w-formset#delete">{% trans "Delete" %}</button>
 </td>

wagtail/users/templates/wagtailusers/groups/includes/page_permissions_formset.html

@@ -1,7 +1,7 @@
 {% load i18n wagtailadmin_tags %}
 
 {% trans "Page permissions" as heading %}
-{% panel id="page-permissions" heading=heading icon="folder-open-inverse" %}
+{% panel id="page-permissions" heading=heading icon="folder-open-inverse" attrs=formset.attrs %}
 
     {{ formset.management_form }}
 
@@ -27,9 +27,9 @@
                 {% endfor %}
             </tr>
         </thead>
-        <tbody id="id_{{ formset.prefix }}-FORMS">
+        <tbody id="id_{{ formset.prefix }}-FORMS" data-w-formset-target="forms">
             {% for form in formset.forms %}
-                <tr id="inline_child_{{ form.prefix }}"{% if form.DELETE.value %} style="display: none;"{% endif %}>
+                <tr id="inline_child_{{ form.prefix }}"{% if form.DELETE.value %} hidden data-w-formset-target="deleted"{% else %}data-w-formset-target="child"{% endif %}>
                     {% if form.non_field_errors %}
                         <p class="error-message">
                             {% for error in form.non_field_errors %}
@@ -43,14 +43,14 @@
         </tbody>
     </table>
 
-    <template id="id_{{ formset.prefix }}-EMPTY_FORM_TEMPLATE">
-        <tr id="inline_child_{{ formset.empty_form.prefix }}">
+    <template id="id_{{ formset.prefix }}-EMPTY_FORM_TEMPLATE" data-w-formset-target="template">
+        <tr id="inline_child_{{ formset.empty_form.prefix }}" data-w-formset-target="child">
             {% include "wagtailusers/groups/includes/page_permissions_form.html" with form=formset.empty_form only %}
         </tr>
     </template>
 
     <p class="add">
-        <button class="button bicolor button--icon" id="id_{{ formset.prefix }}-ADD" value="Add" type="button">{% icon name="plus" wrapped=1 %}{% trans "Add a page permission" %}</button>
+        <button class="button bicolor button--icon" id="id_{{ formset.prefix }}-ADD" value="Add" type="button" data-action="w-formset#add">{% icon name="plus" wrapped=1 %}{% trans "Add a page permission" %}</button>
     </p>
 
 {% endpanel %}

wagtail/users/tests/test_admin_views.py

@@ -1735,9 +1735,7 @@ class TestGroupCreateView(AdminTemplateTestUtils, WagtailTestUtils, TestCase):
         )
         # Should contain the JS from the form and the template include
         page_chooser_js = versioned_static("wagtailadmin/js/page-chooser.js")
-        group_form_js = versioned_static("wagtailusers/js/group-form.js")
         self.assertContains(response, page_chooser_js)
-        self.assertContains(response, group_form_js)
 
     def test_num_queries(self):
         # Warm up the cache
@@ -2009,6 +2007,49 @@ class TestGroupCreateView(AdminTemplateTestUtils, WagtailTestUtils, TestCase):
             custom_label.get_text(strip=True), "Can sync roadmap items from GitHub"
         )
 
+    def test_formset_data_attributes(self):
+        response = self.get()
+        soup = self.get_soup(response.content)
+
+        panel = soup.find(id="page-permissions-section")
+        self.assertIn("w-formset", panel.attrs["data-controller"])
+        self.assertEqual(
+            "totalFormsInput",
+            panel.find(id="id_page_permissions-TOTAL_FORMS").attrs[
+                "data-w-formset-target"
+            ],
+        )
+        self.assertEqual(
+            "template",
+            panel.find("template").attrs["data-w-formset-target"],
+        )
+
+        self.assertEqual(
+            "forms",
+            panel.find("table").find("tbody").attrs["data-w-formset-target"],
+        )
+
+        # Other panels are rendered with different formset classes, test one of them
+
+        panel = soup.find(id="collection-management-permissions-section")
+        self.assertIn("w-formset", panel.attrs["data-controller"])
+
+        self.assertEqual(
+            "totalFormsInput",
+            panel.find(id="id_collection_permissions-TOTAL_FORMS").attrs[
+                "data-w-formset-target"
+            ],
+        )
+        self.assertEqual(
+            "template",
+            panel.find("template").attrs["data-w-formset-target"],
+        )
+
+        self.assertEqual(
+            "forms",
+            panel.find("table").find("tbody").attrs["data-w-formset-target"],
+        )
+
 
 class TestGroupEditView(AdminTemplateTestUtils, WagtailTestUtils, TestCase):
     def setUp(self):
@@ -2109,9 +2150,7 @@ class TestGroupEditView(AdminTemplateTestUtils, WagtailTestUtils, TestCase):
         )
         # Should contain the JS from the form and the template include
         page_chooser_js = versioned_static("wagtailadmin/js/page-chooser.js")
-        group_form_js = versioned_static("wagtailusers/js/group-form.js")
         self.assertContains(response, page_chooser_js)
-        self.assertContains(response, group_form_js)
 
         soup = self.get_soup(response.content)
         header = soup.select_one(".w-slim-header")
@@ -2608,6 +2647,59 @@ class TestGroupEditView(AdminTemplateTestUtils, WagtailTestUtils, TestCase):
         self.assertGreaterEqual(len(toggle_add_items), 30)
         self.assertEqual(toggle_add_items[0]["data-action"], "w-bulk#toggle")
 
+    def test_formset_data_attributes(self):
+        response = self.get()
+        soup = self.get_soup(response.content)
+
+        panel = soup.find(id="page-permissions-section")
+        self.assertIn("w-formset", panel.attrs["data-controller"])
+        self.assertEqual(
+            "totalFormsInput",
+            panel.find(id="id_page_permissions-TOTAL_FORMS").attrs[
+                "data-w-formset-target"
+            ],
+        )
+        self.assertEqual(
+            "template",
+            panel.find("template").attrs["data-w-formset-target"],
+        )
+
+        tbody = panel.find("table").find("tbody")
+        self.assertEqual(
+            "forms",
+            tbody.attrs["data-w-formset-target"],
+        )
+
+        row = tbody.find("tr")
+        self.assertEqual(
+            "child",
+            row.attrs["data-w-formset-target"],
+        )
+        self.assertEqual(
+            "deleteInput",
+            row.find(id="id_page_permissions-0-DELETE").attrs["data-w-formset-target"],
+        )
+
+        # Other panels are rendered with different formset classes, test one of them
+
+        panel = soup.find(id="collection-management-permissions-section")
+        self.assertIn("w-formset", panel.attrs["data-controller"])
+
+        self.assertEqual(
+            "totalFormsInput",
+            panel.find(id="id_collection_permissions-TOTAL_FORMS").attrs[
+                "data-w-formset-target"
+            ],
+        )
+        self.assertEqual(
+            "template",
+            panel.find("template").attrs["data-w-formset-target"],
+        )
+        self.assertEqual(
+            "forms",
+            panel.find("table").find("tbody").attrs["data-w-formset-target"],
+        )
+
 
 class TestGroupHistoryView(WagtailTestUtils, TestCase):
     # More thorough tests are in test_model_viewset

wagtail/users/tests/test_utils.py

@@ -0,0 +1,76 @@
+from django.test import TestCase, override_settings
+
+from wagtail.users.utils import get_gravatar_url
+
+
+class TestGravatar(TestCase):
+    def test_gravatar_default(self):
+        """Test with the default settings"""
+        self.assertEqual(
+            get_gravatar_url("something@example.com"),
+            "//www.gravatar.com/avatar/76ebd6fecabc982c205dd056e8f0415a?d=mp&s=100",
+        )
+
+    def test_gravatar_custom_size(self):
+        """Test with a custom size (note that the size will be doubled)"""
+        self.assertEqual(
+            get_gravatar_url("something@example.com", size=100),
+            "//www.gravatar.com/avatar/76ebd6fecabc982c205dd056e8f0415a?d=mp&s=200",
+        )
+
+    @override_settings(
+        WAGTAIL_GRAVATAR_PROVIDER_URL="https://robohash.org/avatar?d=robohash&s=200"
+    )
+    def test_gravatar_params_that_overlap(self):
+        """
+        Test with params that overlap with default s (size) and d (default_image)
+        Also test the `s` is not overridden by the provider URL's query parameters.
+        """
+        self.assertEqual(
+            get_gravatar_url("something@example.com", size=80),
+            "https://robohash.org/avatar/76ebd6fecabc982c205dd056e8f0415a?d=robohash&s=160",
+        )
+
+    @override_settings(WAGTAIL_GRAVATAR_PROVIDER_URL="https://robohash.org/avatar?f=y")
+    def test_gravatar_params_that_dont_overlap(self):
+        """Test with params that don't default `s (size)` and `d (default_image)`"""
+        self.assertEqual(
+            get_gravatar_url("something@example.com"),
+            "https://robohash.org/avatar/76ebd6fecabc982c205dd056e8f0415a?d=mp&f=y&s=100",
+        )
+
+    @override_settings(
+        WAGTAIL_GRAVATAR_PROVIDER_URL="https://robohash.org/avatar?d=robohash&f=y"
+    )
+    def test_gravatar_query_params_override_default_params(self):
+        """Test that query parameters of `WAGTAIL_GRAVATAR_PROVIDER_URL` override default_params"""
+        self.assertEqual(
+            get_gravatar_url(
+                "something@example.com", default_params={"d": "monsterid"}
+            ),
+            "https://robohash.org/avatar/76ebd6fecabc982c205dd056e8f0415a?d=robohash&f=y&s=100",
+        )
+
+    @override_settings(WAGTAIL_GRAVATAR_PROVIDER_URL="https://robohash.org/avatar/")
+    def test_gravatar_trailing_slash(self):
+        """Test with a trailing slash in the URL"""
+        self.assertEqual(
+            get_gravatar_url("something@example.com"),
+            "https://robohash.org/avatar/76ebd6fecabc982c205dd056e8f0415a?d=mp&s=100",
+        )
+
+    @override_settings(WAGTAIL_GRAVATAR_PROVIDER_URL="https://robohash.org/avatar")
+    def test_gravatar_no_trailing_slash(self):
+        """Test with no trailing slash in the URL"""
+        self.assertEqual(
+            get_gravatar_url("something@example.com"),
+            "https://robohash.org/avatar/76ebd6fecabc982c205dd056e8f0415a?d=mp&s=100",
+        )
+
+    @override_settings(WAGTAIL_GRAVATAR_PROVIDER_URL="https://robohash.org/avatar?")
+    def test_gravatar_trailing_question_mark(self):
+        """Test with a trailing question mark in the URL"""
+        self.assertEqual(
+            get_gravatar_url("something@example.com"),
+            "https://robohash.org/avatar/76ebd6fecabc982c205dd056e8f0415a?d=mp&s=100",
+        )

wagtail/users/utils.py

@@ -1,3 +1,5 @@
+from urllib.parse import parse_qs, urlparse, urlunparse
+
 from django.conf import settings
 from django.utils.http import urlencode
 from django.utils.translation import gettext_lazy as _
@@ -25,11 +27,29 @@ def user_can_delete_user(current_user, user_to_delete):
     return True
 
 
-def get_gravatar_url(email, size=50):
-    default = "mm"
-    size = (
-        int(size) * 2
-    )  # requested at retina size by default and scaled down at point of use with css
+def get_gravatar_url(email, size=50, default_params={"d": "mp"}):
+    """
+    See https://gravatar.com/site/implement/images/ for Gravatar image options.
+
+    Example usage:
+
+    .. code-block:: python
+
+        # Basic usage
+        gravatar_url = get_gravatar_url('user@example.com')
+
+        # Customize size and default image
+        gravatar_url = get_gravatar_url(
+            'user@example.com',
+            size=100,
+            default_params={'d': 'robohash', 'f': 'y'}
+        )
+
+    Note:
+        If any parameter in ``default_params`` also exists in the provider URL,
+        it will be overridden by the provider URL's query parameter.
+    """
+
     gravatar_provider_url = getattr(
         settings, "WAGTAIL_GRAVATAR_PROVIDER_URL", "//www.gravatar.com/avatar"
     )
@@ -37,14 +57,26 @@ def get_gravatar_url(email, size=50):
     if (not email) or (gravatar_provider_url is None):
         return None
 
-    email_bytes = email.lower().encode("utf-8")
-    hash = safe_md5(email_bytes, usedforsecurity=False).hexdigest()
-    gravatar_url = "{gravatar_provider_url}/{hash}?{params}".format(
-        gravatar_provider_url=gravatar_provider_url.rstrip("/"),
-        hash=hash,
-        params=urlencode({"s": size, "d": default}),
+    parsed_url = urlparse(gravatar_provider_url)
+
+    params = {
+        **default_params,
+        **(parse_qs(parsed_url.query or "")),
+        # requested at retina size by default and scaled down at point of use with css
+        "s": int(size) * 2,
+    }
+
+    email_hash = safe_md5(
+        email.lower().encode("utf-8"), usedforsecurity=False
+    ).hexdigest()
+
+    parsed_url = parsed_url._replace(
+        path=f"{parsed_url.path.rstrip('/')}/{email_hash}",
+        query=urlencode(params, doseq=True),
     )
 
+    gravatar_url = urlunparse(parsed_url)
+
     return gravatar_url
 
 

wagtail/utils/setup.py

@@ -29,10 +29,10 @@ class assets_mixin:
         Writes the current Wagtail version number into package.json
         """
         path = os.path.join(".", "client", "package.json")
-        input_file = open(path)
 
         try:
-            package = json.loads(input_file.read().decode("utf-8"))
+            with open(path, "r") as f:
+                package = json.loads(f.read())
         except ValueError as e:
             print("Unable to read " + path + " " + e)  # noqa: T201
             raise SystemExit(1)

wagtail/utils/templates.py

@@ -0,0 +1,26 @@
+from functools import lru_cache
+from pathlib import Path
+
+from django.template import TemplateDoesNotExist
+from django.template.loader import select_template
+
+import wagtail
+
+
+@lru_cache(maxsize=None)
+def template_is_overridden(template_name: str, expected_location: str) -> bool:
+    """
+    Check if a template has been overridden.
+
+    A template is overridden if the resolved template file is different from the
+    expected location within the `wagtail` package directory.
+    """
+    try:
+        template = select_template([template_name])
+    except TemplateDoesNotExist:
+        return False
+
+    root = Path(wagtail.__file__).resolve().parent
+    path = str(root / expected_location / template_name)
+
+    return template.origin.name != path

wagtail/utils/widgets.py

@@ -10,6 +10,7 @@ class WidgetWithScript(Widget):
     warn(
         "The usage of `WidgetWithScript` hook is deprecated. Use external scripts instead.",
         category=RemovedInWagtail70Warning,
+        stacklevel=3,
     )
 
     def render_html(self, name, value, attrs):

wagtail/views.py

@@ -9,6 +9,10 @@ from wagtail.forms import PasswordViewRestrictionForm
 from wagtail.models import Page, PageViewRestriction
 
 
+def serve_chain(page, request, args, kwargs):
+    return page.serve(request, *args, **kwargs)
+
+
 def serve(request, path):
     route_result = Page.route_for_request(request, path)
     if route_result is None:
@@ -16,12 +20,16 @@ def serve(request, path):
     else:
         page, args, kwargs = route_result
 
+    on_serve_chain = serve_chain
+    for fn in reversed(hooks.get_hooks("on_serve_page")):
+        on_serve_chain = fn(on_serve_chain)
+
     for fn in hooks.get_hooks("before_serve_page"):
         result = fn(page, request, args, kwargs)
         if isinstance(result, HttpResponse):
             return result
 
-    return page.serve(request, *args, **kwargs)
+    return on_serve_chain(page, request, args, kwargs)
 
 
 def authenticate_with_password(request, page_view_restriction_id, page_id):