wagtail 6.1.3__py3-none-any.whl → 6.2__py3-none-any.whl

wagtail/snippets/tests/test_snippets.py

@@ -9,7 +9,7 @@ from django.contrib.auth import get_user_model
 from django.contrib.auth.models import AnonymousUser, Permission
 from django.contrib.contenttypes.models import ContentType
 from django.core import checks, management
-from django.core.exceptions import ValidationError
+from django.core.exceptions import ImproperlyConfigured, ValidationError
 from django.core.files.base import ContentFile
 from django.core.files.uploadedfile import SimpleUploadedFile
 from django.core.handlers.wsgi import WSGIRequest
@@ -24,9 +24,11 @@ from taggit.models import Tag
 from wagtail import hooks
 from wagtail.admin.admin_url_finder import AdminURLFinder
 from wagtail.admin.forms import WagtailAdminModelForm
+from wagtail.admin.menu import admin_menu
 from wagtail.admin.panels import FieldPanel, ObjectList, get_edit_handler
 from wagtail.admin.widgets.button import ButtonWithDropdown
 from wagtail.blocks.field_block import FieldBlockAdapter
+from wagtail.coreutils import get_dummy_request
 from wagtail.models import Locale, ModelLogEntry, Revision
 from wagtail.signals import published, unpublished
 from wagtail.snippets.action_menu import (
@@ -95,6 +97,26 @@ class TestSnippetIndexView(AdminTemplateTestUtils, WagtailTestUtils, TestCase):
         response = self.get()
         self.assertEqual(response.status_code, 302)
 
+    def test_get_with_only_view_permissions(self):
+        self.user.is_superuser = False
+        self.user.user_permissions.add(
+            Permission.objects.get(
+                content_type__app_label="wagtailadmin", codename="access_admin"
+            ),
+            Permission.objects.get(
+                content_type__app_label="tests", codename="view_advert"
+            ),
+        )
+        self.user.save()
+
+        response = self.get()
+        self.assertEqual(response.status_code, 200)
+        self.assertTemplateUsed(response, "wagtailadmin/generic/listing.html")
+        soup = self.get_soup(response.content)
+        link = soup.select_one("tr td a")
+        self.assertEqual(link["href"], reverse("wagtailsnippets_tests_advert:list"))
+        self.assertEqual(link.text.strip(), "Adverts")
+
     def test_simple(self):
         response = self.get()
         self.assertEqual(response.status_code, 200)
@@ -110,6 +132,29 @@ class TestSnippetIndexView(AdminTemplateTestUtils, WagtailTestUtils, TestCase):
     def test_displays_snippet(self):
         self.assertContains(self.get(), "Adverts")
 
+    def test_snippets_menu_item_shown_with_only_view_permission(self):
+        self.user.is_superuser = False
+        self.user.user_permissions.add(
+            Permission.objects.get(
+                content_type__app_label="wagtailadmin", codename="access_admin"
+            ),
+            Permission.objects.get(
+                content_type__app_label="tests", codename="view_advert"
+            ),
+        )
+        self.user.save()
+
+        request = get_dummy_request()
+        request.user = self.user
+        menu_items = admin_menu.menu_items_for_request(request)
+        snippets = [item for item in menu_items if item.name == "snippets"]
+        self.assertEqual(len(snippets), 1)
+        item = snippets[0]
+        self.assertEqual(item.name, "snippets")
+        self.assertEqual(item.label, "Snippets")
+        self.assertEqual(item.icon_name, "snippet")
+        self.assertEqual(item.url, reverse("wagtailsnippets:index"))
+
 
 class TestSnippetListView(WagtailTestUtils, TestCase):
     def setUp(self):
@@ -319,6 +364,23 @@ class TestSnippetListView(WagtailTestUtils, TestCase):
         self.assertEqual(response.status_code, 200)
         self.assertTemplateUsed(response, "wagtailadmin/shared/buttons.html")
 
+    def test_dropdown_not_rendered_when_no_child_buttons_exist(self):
+        Advert.objects.create(text="My Lovely advert")
+
+        def remove_all_buttons(buttons, snippet, user):
+            buttons[:] = []
+            self.assertEqual(len(buttons), 0)
+
+        with hooks.register_temporarily(
+            "construct_snippet_listing_buttons",
+            remove_all_buttons,
+        ):
+            response = self.get()
+
+        soup = self.get_soup(response.content)
+        actions = soup.select_one("tbody tr td ul.actions")
+        self.assertIsNone(actions)
+
     def test_use_latest_draft_as_title(self):
         snippet = DraftStateModel.objects.create(text="Draft-enabled Foo, Published")
         snippet.save_revision().publish()
@@ -1124,12 +1186,14 @@ class TestCreateDraftStateSnippet(WagtailTestUtils, TestCase):
             allow_extra_attrs=True,
         )
         # Should show the dialog template pointing to the [data-edit-form] selector as the root
-        self.assertTagInHTML(
-            '<template data-controller="w-teleport" data-w-teleport-target-value="[data-edit-form]">',
-            html,
-            count=1,
-            allow_extra_attrs=True,
-        )
+        soup = self.get_soup(html)
+        dialog = soup.select_one(
+            """
+            template[data-controller="w-teleport"][data-w-teleport-target-value="[data-edit-form]"]
+            #schedule-publishing-dialog
+            """
+        )
+        self.assertIsNotNone(dialog)
         # Should render the main form with data-edit-form attribute
         self.assertTagInHTML(
             f'<form action="{add_url}" method="POST" data-edit-form>',
@@ -1524,12 +1588,14 @@ class BaseTestSnippetEditView(WagtailTestUtils, TestCase):
             allow_extra_attrs=True,
         )
         # Should show the dialog template pointing to the [data-edit-form] selector as the root
-        self.assertTagInHTML(
-            '<template data-controller="w-teleport" data-w-teleport-target-value="[data-edit-form]">',
-            html,
-            count=1,
-            allow_extra_attrs=True,
-        )
+        soup = self.get_soup(html)
+        dialog = soup.select_one(
+            """
+            template[data-controller="w-teleport"][data-w-teleport-target-value="[data-edit-form]"]
+            #schedule-publishing-dialog
+            """
+        )
+        self.assertIsNotNone(dialog)
         # Should render the main form with data-edit-form attribute
         self.assertTagInHTML(
             f'<form action="{self.get_edit_url()}" method="POST" data-edit-form>',
@@ -5283,6 +5349,11 @@ class TestSnippetChooserBlock(TestCase):
         # None should not yield any references
         self.assertListEqual(list(block.extract_references(None)), [])
 
+    def test_exception_on_non_snippet_model(self):
+        with self.assertRaises(ImproperlyConfigured):
+            block = SnippetChooserBlock(Locale)
+            block.widget
+
 
 class TestAdminSnippetChooserWidget(WagtailTestUtils, TestCase):
     def test_adapt(self):

wagtail/snippets/tests/test_viewset.py

@@ -1607,3 +1607,25 @@ class TestCustomMethods(BaseSnippetViewSetTests):
         self.assertIsNotNone(template)
         links = template.find_all("a", attrs={"href": add_url})
         self.assertEqual(len(links), 1)
+
+
+class TestCustomPermissionPolicy(BaseSnippetViewSetTests):
+    model = FullFeaturedSnippet
+
+    @classmethod
+    def setUpTestData(cls):
+        cls.object = cls.model.objects.create(text="Hello World")
+
+    def test_get_edit_view_not_allowed(self):
+        response = self.client.get(self.get_url("edit", args=(quote(self.object.pk),)))
+        self.assertEqual(response.status_code, 200)
+
+        # The custom permission policy disallows any user with [FORBIDDEN]
+        # in their name, even if they are a superuser
+        self.user.first_name = "[FORBIDDEN]"
+        self.user.last_name = "Joe"
+        self.user.save()
+        self.assertTrue(self.user.is_superuser)
+        self.assertEqual(self.user.get_full_name(), "[FORBIDDEN] Joe")
+        response = self.client.get(self.get_url("edit", args=(quote(self.object.pk),)))
+        self.assertRedirects(response, reverse("wagtailadmin_home"))

wagtail/snippets/views/snippets.py

@@ -47,7 +47,6 @@ from wagtail.models import (
 from wagtail.permissions import ModelPermissionPolicy
 from wagtail.snippets.action_menu import SnippetActionMenu
 from wagtail.snippets.models import SnippetAdminURLFinder, get_snippet_models
-from wagtail.snippets.permissions import user_can_edit_snippet_type
 from wagtail.snippets.side_panels import SnippetStatusSidePanel
 from wagtail.snippets.views.chooser import SnippetChooserViewSet
 from wagtail.utils.deprecation import RemovedInWagtail70Warning
@@ -90,9 +89,10 @@ class ModelIndexView(generic.BaseListingView):
                 "name": capfirst(model._meta.verbose_name_plural),
                 "count": model._default_manager.all().count(),
                 "model": model,
+                "url": url,
             }
             for model in get_snippet_models()
-            if user_can_edit_snippet_type(self.request.user, model)
+            if (url := self.get_list_url(model))
         ]
 
     def dispatch(self, request, *args, **kwargs):
@@ -103,8 +103,12 @@ class ModelIndexView(generic.BaseListingView):
     def get_breadcrumbs_items(self):
         return self.breadcrumbs_items + [{"url": "", "label": _("Snippets")}]
 
-    def get_list_url(self, type):
-        return reverse(type["model"].snippet_viewset.get_url_name("list"))
+    def get_list_url(self, model):
+        if model.snippet_viewset.permission_policy.user_has_any_permission(
+            self.request.user,
+            {"add", "change", "delete", "view"},
+        ):
+            return reverse(model.snippet_viewset.get_url_name("list"))
 
     def get_queryset(self):
         return None
@@ -115,7 +119,7 @@ class ModelIndexView(generic.BaseListingView):
             TitleColumn(
                 "name",
                 label=_("Name"),
-                get_url=self.get_list_url,
+                get_url=lambda type: type["url"],
                 sort_key="name",
             ),
             Column(
@@ -206,16 +210,17 @@ class IndexView(generic.IndexViewOptionalFeaturesMixin, generic.IndexView):
                 )
                 hook(more_buttons, instance, self.request.user, {})
 
-        list_buttons.append(
-            ButtonWithDropdown(
-                buttons=more_buttons,
-                icon_name="dots-horizontal",
-                attrs={
-                    "aria-label": _("More options for '%(title)s'")
-                    % {"title": str(instance)},
-                },
+        if more_buttons:
+            list_buttons.append(
+                ButtonWithDropdown(
+                    buttons=more_buttons,
+                    icon_name="dots-horizontal",
+                    attrs={
+                        "aria-label": _("More options for '%(title)s'")
+                        % {"title": str(instance)},
+                    },
+                )
             )
-        )
 
         return list_buttons
 

wagtail/snippets/wagtail_hooks.py

@@ -1,5 +1,3 @@
-from django.contrib.auth.models import Permission
-from django.contrib.contenttypes.models import ContentType
 from django.urls import include, path, reverse
 from django.utils.functional import cached_property
 from django.utils.translation import gettext_lazy as _
@@ -8,7 +6,7 @@ from wagtail import hooks
 from wagtail.admin.menu import MenuItem
 from wagtail.snippets.bulk_actions.delete import DeleteBulkAction
 from wagtail.snippets.models import get_snippet_models
-from wagtail.snippets.permissions import user_can_edit_snippets
+from wagtail.snippets.permissions import user_can_access_snippets
 from wagtail.snippets.views import snippets as snippet_views
 
 
@@ -35,7 +33,7 @@ class SnippetsMenuItem(MenuItem):
         )
 
     def is_shown(self, request):
-        return not self._all_have_menu_items and user_can_edit_snippets(request.user)
+        return not self._all_have_menu_items and user_can_access_snippets(request.user)
 
 
 @hooks.register("register_admin_menu_item")
@@ -49,10 +47,4 @@ def register_snippets_menu_item():
     )
 
 
-@hooks.register("register_permissions")
-def register_permissions():
-    content_types = ContentType.objects.get_for_models(*get_snippet_models()).values()
-    return Permission.objects.filter(content_type__in=content_types)
-
-
 hooks.register("register_bulk_action", DeleteBulkAction)

wagtail/templatetags/wagtailcore_tags.py

@@ -3,6 +3,7 @@ from django.shortcuts import resolve_url
 from django.template.defaulttags import token_kwargs
 from django.template.loader import render_to_string
 from django.utils.encoding import force_str
+from django.utils.functional import Promise
 from django.utils.html import conditional_escape
 
 from wagtail import VERSION, __version__
@@ -120,6 +121,8 @@ def richtext(value):
     elif value is None:
         html = ""
     else:
+        if isinstance(value, Promise):
+            value = str(value)
         if isinstance(value, str):
             html = expand_db_html(value)
         else:

wagtail/test/dummy_external_storage.py

@@ -7,7 +7,7 @@
 #  - File.size exceptions raise DummyExternalStorageError
 #  - Storage._save() fails loudly if the content file's pointer is not at the start
 
-from django.core.files.base import File
+from django.core.files import File
 from django.core.files.storage import FileSystemStorage, Storage
 from django.utils.deconstruct import deconstructible
 

wagtail/test/i18n/migrations/0003_alter_clusterabletestmodel_locale_and_more.py

@@ -0,0 +1,40 @@
+# Generated by Django 5.0.6 on 2024-06-21 06:47
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('i18n', '0002_clusterabletestmodel_clusterabletestmodelchild_clusterabletestmodeltranslatablechild'),
+        ('wagtailcore', '0094_alter_page_locale'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='clusterabletestmodel',
+            name='locale',
+            field=models.ForeignKey(editable=False, on_delete=django.db.models.deletion.PROTECT, related_name='+', to='wagtailcore.locale', verbose_name='locale'),
+        ),
+        migrations.AlterField(
+            model_name='clusterabletestmodeltranslatablechild',
+            name='locale',
+            field=models.ForeignKey(editable=False, on_delete=django.db.models.deletion.PROTECT, related_name='+', to='wagtailcore.locale', verbose_name='locale'),
+        ),
+        migrations.AlterField(
+            model_name='testchildobject',
+            name='locale',
+            field=models.ForeignKey(editable=False, on_delete=django.db.models.deletion.PROTECT, related_name='+', to='wagtailcore.locale', verbose_name='locale'),
+        ),
+        migrations.AlterField(
+            model_name='testmodel',
+            name='locale',
+            field=models.ForeignKey(editable=False, on_delete=django.db.models.deletion.PROTECT, related_name='+', to='wagtailcore.locale', verbose_name='locale'),
+        ),
+        migrations.AlterField(
+            model_name='testnonparentalchildobject',
+            name='locale',
+            field=models.ForeignKey(editable=False, on_delete=django.db.models.deletion.PROTECT, related_name='+', to='wagtailcore.locale', verbose_name='locale'),
+        ),
+    ]

wagtail/test/routablepage/models.py

@@ -62,6 +62,10 @@ class RoutablePageTest(RoutablePage):
             template="routablepagetests/routable_page_test_alternate.html",
         )
 
+    @route(r"^render-method-with-arg/(?P<slug>.+)/$")
+    def render_method_test_with_arg(self, request, slug):
+        return self.render(request)
+
     def get_route_paths(self):
         return [
             "/",

wagtail/test/snippets/migrations/0012_alter_translatablesnippet_locale.py

@@ -0,0 +1,20 @@
+# Generated by Django 5.0.6 on 2024-06-21 06:47
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('snippetstests', '0011_nonautocompletesearchablesnippet'),
+        ('wagtailcore', '0094_alter_page_locale'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='translatablesnippet',
+            name='locale',
+            field=models.ForeignKey(editable=False, on_delete=django.db.models.deletion.PROTECT, related_name='+', to='wagtailcore.locale', verbose_name='locale'),
+        ),
+    ]

wagtail/test/testapp/migrations/0038_sociallink.py

@@ -0,0 +1,52 @@
+# Generated by Django 4.2.13 on 2024-06-12 12:06
+
+from django.db import migrations, models
+import django.db.models.deletion
+import modelcluster.fields
+import wagtail.search.index
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("tests", "0037_testpermissionedgenericsetting_and_more"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="SocialLink",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("url", models.URLField()),
+                (
+                    "kind",
+                    models.CharField(
+                        choices=[("twitter", "Twitter"), ("facebook", "Facebook")],
+                        max_length=30,
+                    ),
+                ),
+                (
+                    "person",
+                    modelcluster.fields.ParentalKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="social_links",
+                        to="tests.personpage",
+                        verbose_name="Person",
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "Social link",
+                "verbose_name_plural": "Social links",
+            },
+            bases=(wagtail.search.index.Indexed, models.Model),
+        ),
+    ]

wagtail/test/testapp/migrations/0039_alter_eventcategory_locale_and_more.py

@@ -0,0 +1,45 @@
+# Generated by Django 5.0.6 on 2024-06-21 06:47
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('tests', '0038_sociallink'),
+        ('wagtailcore', '0094_alter_page_locale'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='eventcategory',
+            name='locale',
+            field=models.ForeignKey(editable=False, on_delete=django.db.models.deletion.PROTECT, related_name='+', to='wagtailcore.locale', verbose_name='locale'),
+        ),
+        migrations.AlterField(
+            model_name='eventpagecarouselitem',
+            name='locale',
+            field=models.ForeignKey(editable=False, on_delete=django.db.models.deletion.PROTECT, related_name='+', to='wagtailcore.locale', verbose_name='locale'),
+        ),
+        migrations.AlterField(
+            model_name='eventpagerelatedlink',
+            name='locale',
+            field=models.ForeignKey(editable=False, on_delete=django.db.models.deletion.PROTECT, related_name='+', to='wagtailcore.locale', verbose_name='locale'),
+        ),
+        migrations.AlterField(
+            model_name='eventpagespeaker',
+            name='locale',
+            field=models.ForeignKey(editable=False, on_delete=django.db.models.deletion.PROTECT, related_name='+', to='wagtailcore.locale', verbose_name='locale'),
+        ),
+        migrations.AlterField(
+            model_name='eventpagespeakeraward',
+            name='locale',
+            field=models.ForeignKey(editable=False, on_delete=django.db.models.deletion.PROTECT, related_name='+', to='wagtailcore.locale', verbose_name='locale'),
+        ),
+        migrations.AlterField(
+            model_name='fullfeaturedsnippet',
+            name='locale',
+            field=models.ForeignKey(editable=False, on_delete=django.db.models.deletion.PROTECT, related_name='+', to='wagtailcore.locale', verbose_name='locale'),
+        ),
+    ]

wagtail/test/testapp/models.py

@@ -2097,6 +2097,7 @@ class PersonPage(Page):
             "Person",
         ),
         InlinePanel("addresses", label="Address"),
+        InlinePanel("social_links", label="Social links"),
     ]
 
     class Meta:
@@ -2133,6 +2134,29 @@ class AddressTag(TaggedItemBase):
     )
 
 
+class SocialLink(index.Indexed, ClusterableModel):
+    url = models.URLField()
+    kind = models.CharField(
+        max_length=30,
+        choices=[
+            ("twitter", "Twitter"),
+            ("facebook", "Facebook"),
+        ],
+    )
+    person = ParentalKey(
+        to="tests.PersonPage", related_name="social_links", verbose_name="Person"
+    )
+
+    panels = [
+        FieldPanel("url"),
+        FieldPanel("kind"),
+    ]
+
+    class Meta:
+        verbose_name = "Social link"
+        verbose_name_plural = "Social links"
+
+
 class RestaurantPage(Page):
     tags = ClusterTaggableManager(through="tests.TaggedRestaurant", blank=True)
 

wagtail/test/testapp/views.py

@@ -278,6 +278,7 @@ class ToyViewSetGroup(ModelViewSetGroup):
             index_view_class=FeatureCompleteToyIndexView,
             list_display=["name", "strid", "release_date"],
             ordering=["strid"],
+            copy_view_enabled=False,
         ),
     )
 

wagtail/test/testapp/wagtail_hooks.py

@@ -21,6 +21,7 @@ from wagtail.admin.ui.tables import BooleanColumn, UpdatedAtColumn
 from wagtail.admin.utils import set_query_params
 from wagtail.admin.views.account import BaseSettingsPanel
 from wagtail.admin.widgets import Button
+from wagtail.permission_policies.base import ModelPermissionPolicy
 from wagtail.snippets.bulk_actions.snippet_bulk_action import SnippetBulkAction
 from wagtail.snippets.models import register_snippet
 from wagtail.snippets.views.chooser import SnippetChooserViewSet
@@ -264,6 +265,13 @@ class FullFeaturedSnippetFilterSet(WagtailFilterSet):
         fields = ["country_code", "some_date"]
 
 
+class FullFeaturedPermissionPolicy(ModelPermissionPolicy):
+    def user_has_permission(self, user, action):
+        if not user.is_anonymous and "[FORBIDDEN]" in user.get_full_name():
+            return False
+        return super().user_has_permission(user, action)
+
+
 class FullFeaturedSnippetChooserViewSet(SnippetChooserViewSet):
     form_fields = ["text", "country_code", "some_number"]
 
@@ -303,6 +311,7 @@ class FullFeaturedSnippetViewSet(SnippetViewSet):
     # Ensure that the menu item is placed last
     menu_order = 999999
     inspect_view_enabled = True
+    permission_policy = FullFeaturedPermissionPolicy(FullFeaturedSnippet)
 
     class IndexView(SnippetViewSet.index_view_class):
         def get_add_url(self):

wagtail/test/urls_multilang.py

@@ -2,5 +2,10 @@ from django.conf.urls.i18n import i18n_patterns
 from django.urls import include, path
 
 from wagtail import urls as wagtail_urls
+from wagtail.admin import urls as wagtailadmin_urls
 
-urlpatterns = i18n_patterns(path("", include(wagtail_urls)))
+urlpatterns = [
+    path("admin/", include(wagtailadmin_urls)),
+]
+
+urlpatterns += i18n_patterns(path("", include(wagtail_urls)))

wagtail/test/urls_multilang_non_root.py

@@ -0,0 +1,11 @@
+from django.conf.urls.i18n import i18n_patterns
+from django.urls import include, path
+
+from wagtail import urls as wagtail_urls
+from wagtail.admin import urls as wagtailadmin_urls
+
+urlpatterns = [
+    path("admin/", include(wagtailadmin_urls)),
+]
+
+urlpatterns += i18n_patterns(path("site/", include(wagtail_urls)))