wagtail 6.0.2__py3-none-any.whl → 6.1rc1__py3-none-any.whl

wagtail/templatetags/wagtailcore_tags.py

@@ -100,7 +100,7 @@ def wagtail_release_notes_path():
 def wagtail_feature_release_whats_new_link():
     major, minor, patch, release, num = VERSION
     if release == "final":
-        return f"https://guide.wagtail.org/en-latest/releases/new-in-wagtail-{major}-{minor}/"
+        return f"https://guide.wagtail.org/en-{major}.{minor}.x/releases/new-in-wagtail-{major}-{minor}/"
     return "https://guide.wagtail.org/en-latest/releases/latest/"
 
 

wagtail/test/demosite/models.py

@@ -471,7 +471,7 @@ class EventPage(Page):
 
     def get_event_index(self):
         # Find closest ancestor which is an event index
-        return EventIndexPage.objects.ancester_of(self).last()
+        return EventIndexPage.objects.ancestor_of(self).last()
 
 
 class EventPageCarouselItem(Orderable, AbstractCarouselItem):

wagtail/test/middleware.py

@@ -1,6 +1,9 @@
-from django.http import HttpResponseForbidden
+from django.http import Http404, HttpResponse, HttpResponseForbidden
 from django.utils.deprecation import MiddlewareMixin
 
+from wagtail.models import Page
+from wagtail.views import serve
+
 
 class BlockDodgyUserAgentMiddleware(MiddlewareMixin):
     # Used to test that we're correctly handling responses returned from middleware during page
@@ -16,3 +19,13 @@ class BlockDodgyUserAgentMiddleware(MiddlewareMixin):
             and request.headers.get("user-agent") == "EvilHacker"
         ):
             return HttpResponseForbidden("Forbidden")
+
+
+class SimplePageViewInterceptorMiddleware(MiddlewareMixin):
+    def process_view(self, request, view_func, view_args, view_kwargs):
+        if serve == view_func:
+            page = Page.find_for_request(request, *view_args, **view_kwargs)
+            if page is None:
+                raise Http404
+            elif page.content == "Intercept me":
+                return HttpResponse("Intercepted")

wagtail/test/testapp/fixtures/test.json

@@ -878,6 +878,15 @@
       "file": "documents/test.pdf"
     }
   },
+  {
+    "pk": 2,
+    "model": "wagtaildocs.Document",
+    "fields": {
+      "title": "another test document",
+      "created_at": "2020-01-01T12:00:00.000Z",
+      "file": "documents/another_test.pdf"
+    }
+  },
   {
     "pk": 1,
     "model": "wagtailcore.pageviewrestriction",
@@ -915,6 +924,17 @@
       "created_at": "2014-01-01T12:00:00.000Z"
     }
   },
+  {
+    "pk": 2,
+    "model": "wagtailimages.image",
+    "fields": {
+      "title": "Another image",
+      "file": "original_images/another.jpg",
+      "width": 1000,
+      "height": 1000,
+      "created_at": "2020-01-01T12:00:00.000Z"
+    }
+  },
   {
     "model": "wagtailcore.collectionviewrestriction",
     "pk": 1,

wagtail/test/testapp/migrations/0001_squashed_0073_revisablechildmodel_secret_text.py

@@ -15,7 +15,7 @@ import wagtail.contrib.table_block.blocks
 import wagtail.fields
 import wagtail.images.blocks
 import wagtail.images.models
-import wagtail.models.collections
+import wagtail.models.media
 import wagtail.search.index
 import wagtail.test.testapp.models
 
@@ -1043,7 +1043,7 @@ class Migration(migrations.Migration):
                 (
                     "collection",
                     models.ForeignKey(
-                        default=wagtail.models.collections.get_root_collection_id,
+                        default=wagtail.models.media.get_root_collection_id,
                         on_delete=django.db.models.deletion.CASCADE,
                         related_name="+",
                         to="wagtailcore.collection",
@@ -2244,7 +2244,7 @@ class Migration(migrations.Migration):
                 (
                     "collection",
                     models.ForeignKey(
-                        default=wagtail.models.collections.get_root_collection_id,
+                        default=wagtail.models.media.get_root_collection_id,
                         on_delete=django.db.models.deletion.CASCADE,
                         related_name="+",
                         to="wagtailcore.collection",
@@ -2341,7 +2341,7 @@ class Migration(migrations.Migration):
                 (
                     "collection",
                     models.ForeignKey(
-                        default=wagtail.models.collections.get_root_collection_id,
+                        default=wagtail.models.media.get_root_collection_id,
                         on_delete=django.db.models.deletion.CASCADE,
                         related_name="+",
                         to="wagtailcore.collection",
@@ -2622,7 +2622,7 @@ class Migration(migrations.Migration):
                 (
                     "collection",
                     models.ForeignKey(
-                        default=wagtail.models.collections.get_root_collection_id,
+                        default=wagtail.models.media.get_root_collection_id,
                         on_delete=django.db.models.deletion.CASCADE,
                         related_name="+",
                         to="wagtailcore.collection",
@@ -3891,7 +3891,7 @@ class Migration(migrations.Migration):
                 (
                     "collection",
                     models.ForeignKey(
-                        default=wagtail.models.collections.get_root_collection_id,
+                        default=wagtail.models.media.get_root_collection_id,
                         on_delete=django.db.models.deletion.CASCADE,
                         related_name="+",
                         to="wagtailcore.collection",
@@ -3936,7 +3936,7 @@ class Migration(migrations.Migration):
                 (
                     "collection",
                     models.ForeignKey(
-                        default=wagtail.models.collections.get_root_collection_id,
+                        default=wagtail.models.media.get_root_collection_id,
                         on_delete=django.db.models.deletion.CASCADE,
                         related_name="+",
                         to="wagtailcore.collection",
@@ -4055,7 +4055,7 @@ class Migration(migrations.Migration):
                 (
                     "collection",
                     models.ForeignKey(
-                        default=wagtail.models.collections.get_root_collection_id,
+                        default=wagtail.models.media.get_root_collection_id,
                         on_delete=django.db.models.deletion.CASCADE,
                         related_name="+",
                         to="wagtailcore.collection",

wagtail/test/testapp/migrations/0023_snippetchoosermodel_full_featured.py

@@ -19,6 +19,7 @@ class Migration(migrations.Migration):
                 null=True,
                 on_delete=django.db.models.deletion.CASCADE,
                 to="tests.fullfeaturedsnippet",
+                verbose_name="Chosen snippet",
             ),
         ),
     ]

wagtail/test/testapp/migrations/0034_custompermissionmodel.py

@@ -0,0 +1,44 @@
+# Generated by Django 4.2.7 on 2024-02-22 09:21
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("tests", "0033_customcopyformpage"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="CustomPermissionModel",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("text", models.TextField(default="Tailwag")),
+            ],
+            options={
+                "verbose_name": "ADVANCED permission model",
+                "verbose_name_plural": "ADVANCED permission models",
+                "permissions": [
+                    ("can_start_trouble", "Can start trouble"),
+                    ("cause_chaos", "Cause chaos for advanced permission model"),
+                    ("change_text", "Change text"),
+                    ("control", "Manage custom permission model"),
+                ],
+                "default_permissions": (
+                    "add",
+                    "change",
+                    "delete",
+                    "view",
+                    "bulk_update",
+                ),
+            },
+        ),
+    ]

wagtail/test/testapp/migrations/0035_modelwithcustommanager.py

@@ -0,0 +1,30 @@
+# Generated by Django 5.0.1 on 2024-03-15 21:20
+
+import django.db.models.manager
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("tests", "0034_custompermissionmodel"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="ModelWithCustomManager",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+            ],
+            managers=[
+                ("instances", django.db.models.manager.Manager()),
+            ],
+        ),
+    ]

wagtail/test/testapp/migrations/0036_complexdefaultstreampage.py

@@ -0,0 +1,28 @@
+# Generated by Django 5.0.3 on 2024-04-15 22:12
+
+import django.db.models.deletion
+import wagtail.blocks
+import wagtail.fields
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('tests', '0035_modelwithcustommanager'),
+        ('wagtailcore', '0093_uploadedfile'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='ComplexDefaultStreamPage',
+            fields=[
+                ('page_ptr', models.OneToOneField(auto_created=True, on_delete=django.db.models.deletion.CASCADE, parent_link=True, primary_key=True, serialize=False, to='wagtailcore.page')),
+                ('body', wagtail.fields.StreamField([('text', wagtail.blocks.CharBlock()), ('rich_text', wagtail.blocks.RichTextBlock()), ('books', wagtail.blocks.StreamBlock([('title', wagtail.blocks.CharBlock()), ('author', wagtail.blocks.CharBlock())]))], default=[('rich_text', '<p>My <i>lovely</i> books</p>'), ('books', [('title', 'The Great Gatsby'), ('author', 'F. Scott Fitzgerald')])])),
+            ],
+            options={
+                'abstract': False,
+            },
+            bases=('wagtailcore.page',),
+        ),
+    ]

wagtail/test/testapp/models.py

@@ -556,7 +556,7 @@ class FormPage(AbstractEmailForm):
 
     # This is redundant (SubmissionsListView is the default view class), but importing
     # SubmissionsListView in this models.py helps us to confirm that this recipe
-    # https://docs.wagtail.org/en/stable/reference/contrib/forms/customisation.html#customise-form-submissions-listing-in-wagtail-admin
+    # https://docs.wagtail.org/en/stable/reference/contrib/forms/customization.html#customise-form-submissions-listing-in-wagtail-admin
     # works without triggering circular dependency issues -
     # see https://github.com/wagtail/wagtail/issues/6265
     submissions_list_view_class = SubmissionsListView
@@ -1011,6 +1011,17 @@ class AdvertWithTabbedInterface(models.Model):
 register_snippet(AdvertWithTabbedInterface)
 
 
+class CustomManager(models.Manager):
+    pass
+
+
+class ModelWithCustomManager(models.Model):
+    instances = CustomManager()
+
+
+register_snippet(ModelWithCustomManager)
+
+
 # Models with RevisionMixin
 class RevisableModel(RevisionMixin, models.Model):
     text = models.TextField()
@@ -1423,7 +1434,11 @@ class EventPageChooserModel(models.Model):
 class SnippetChooserModel(models.Model):
     advert = models.ForeignKey(Advert, help_text="help text", on_delete=models.CASCADE)
     full_featured = models.ForeignKey(
-        FullFeaturedSnippet, on_delete=models.CASCADE, null=True, blank=True
+        FullFeaturedSnippet,
+        on_delete=models.CASCADE,
+        null=True,
+        blank=True,
+        verbose_name="Chosen snippet",
     )
 
     panels = [
@@ -1611,6 +1626,36 @@ class DefaultStreamPage(Page):
     ]
 
 
+class ComplexDefaultStreamPage(Page):
+    body = StreamField(
+        [
+            ("text", CharBlock()),
+            ("rich_text", RichTextBlock()),
+            (
+                "books",
+                StreamBlock(
+                    [
+                        ("title", CharBlock()),
+                        ("author", CharBlock()),
+                    ]
+                ),
+            ),
+        ],
+        default=[
+            ("rich_text", "<p>My <i>lovely</i> books</p>"),
+            (
+                "books",
+                [("title", "The Great Gatsby"), ("author", "F. Scott Fitzgerald")],
+            ),
+        ],
+    )
+
+    content_panels = [
+        FieldPanel("title"),
+        FieldPanel("body"),
+    ]
+
+
 class MTIBasePage(Page):
     is_creatable = False
 
@@ -2256,3 +2301,35 @@ class CustomPermissionTester(PagePermissionTester):
 class CustomPermissionPage(Page):
     def permissions_for_user(self, user):
         return CustomPermissionTester(user, self)
+
+
+class CustomPermissionModel(models.Model):
+    text = models.TextField(default="Tailwag")
+
+    class Meta:
+        verbose_name = "ADVANCED permission model"
+        verbose_name_plural = "ADVANCED permission models"
+
+        # Django's default_permissions are ("add", "change", "delete", "view").
+        # Django will generate permissions for each of these actions with the
+        # format f"{action}_{model_name}" and the label "Can {action} {verbose_name}".
+        # This means if the action is "bulk_update", the codename will be
+        # "bulk_update_custompermissionmodel" and the label will be
+        # "Can bulk_update ADVANCED permission model".
+        # See https://github.com/django/django/blob/stable/5.0.x/django/contrib/auth/management/__init__.py#L22-L35
+        default_permissions = ("add", "change", "delete", "view", "bulk_update")
+
+        # Permissions with completely custom codenames and labels
+        permissions = [
+            # Starts with can_ and "Can "
+            ("can_start_trouble", "Can start trouble"),
+            # Doesn't start with can_ and "Can "
+            ("cause_chaos", "Cause chaos for advanced permission model"),
+            # Starts with an action similar to a built-in permission "change_"
+            ("change_text", "Change text"),
+            # Without any _ and the label ends with the default verbose_name
+            ("control", "Manage custom permission model"),
+        ]
+
+
+register_snippet(CustomPermissionModel)

wagtail/test/testapp/templates/tests/custom_docs_password_required.html

@@ -0,0 +1,10 @@
+{% extends "tests/base.html" %}
+
+{% block content %}
+    <p>Test only.</p>
+    <form action="{{ action_url }}" method="POST">
+        {% csrf_token %}
+        {{ form.as_p }}
+        <input type="submit" value="Continue" class="button" />
+    </form>
+{% endblock %}

wagtail/test/testapp/templates/tests/custom_page_password_required.html

@@ -0,0 +1,10 @@
+{% extends "tests/base.html" %}
+
+{% block content %}
+    <p>Test only.</p>
+    <form action="{{ action_url }}" method="POST">
+        {% csrf_token %}
+        {{ form.as_p }}
+        <input type="submit" value="Continue" class="button" />
+    </form>
+{% endblock %}

wagtail/test/testapp/views.py

@@ -12,14 +12,16 @@ from wagtail.admin import messages
 from wagtail.admin.auth import user_passes_test
 from wagtail.admin.filters import WagtailFilterSet
 from wagtail.admin.panels import FieldPanel
-from wagtail.admin.ui.tables import BooleanColumn, UpdatedAtColumn
+from wagtail.admin.ui.tables import BooleanColumn, Column, UpdatedAtColumn
 from wagtail.admin.views.generic import DeleteView, EditView, IndexView
 from wagtail.admin.viewsets.base import ViewSet, ViewSetGroup
 from wagtail.admin.viewsets.chooser import ChooserViewSet
 from wagtail.admin.viewsets.model import ModelViewSet, ModelViewSetGroup
+from wagtail.admin.viewsets.pages import PageListingViewSet
 from wagtail.contrib.forms.views import SubmissionsListView
 from wagtail.test.testapp.models import (
     Advert,
+    EventPage,
     FeatureCompleteToy,
     JSONBlockCountsStreamModel,
     JSONMinMaxCountStreamModel,
@@ -49,7 +51,7 @@ def message_test(request):
 
 class CustomSubmissionsListView(SubmissionsListView):
     paginate_by = 50
-    ordering = ("submit_time",)
+    default_ordering = ("submit_time",)
     ordering_csv = ("-submit_time",)
 
     def get_csv_filename(self):
@@ -295,3 +297,23 @@ animated_advert_chooser_viewset = AnimatedAdvertChooserViewSet(
 )
 
 AdvertChooserWidget = animated_advert_chooser_viewset.widget_class
+
+
+class EventPageFilterSet(PageListingViewSet.filterset_class):
+    class Meta:
+        model = EventPage
+        fields = ["audience"]
+
+
+class EventPageListingViewSet(PageListingViewSet):
+    model = EventPage
+    icon = "calendar"
+    menu_label = "Event pages"
+    add_to_admin_menu = True
+    columns = PageListingViewSet.columns + [
+        Column("audience", label="Audience", sort_key="audience"),
+    ]
+    filterset_class = EventPageFilterSet
+
+
+event_page_listing_viewset = EventPageListingViewSet("event_pages")

wagtail/test/testapp/wagtail_hooks.py

@@ -31,6 +31,7 @@ from wagtail.test.testapp.models import (
     ModeratedModel,
     RevisableChildModel,
     RevisableModel,
+    SnippetChooserModel,
     VariousOnDeleteModel,
 )
 from wagtail.test.testapp.views import (
@@ -39,6 +40,7 @@ from wagtail.test.testapp.views import (
     SearchTestModelViewSet,
     ToyViewSetGroup,
     animated_advert_chooser_viewset,
+    event_page_listing_viewset,
 )
 
 from .forms import FavouriteColourForm
@@ -384,12 +386,24 @@ class VariousOnDeleteModelViewSet(SnippetViewSet):
     inspect_view_enabled = True
 
 
+class SnippetChooserModelViewSet(SnippetViewSet):
+    model = SnippetChooserModel
+
+    list_display = [
+        "__str__",
+        "full_featured__text",
+        "full_featured__latest_revision__created_at",
+    ]
+    exclude_form_fields = []
+
+
 register_snippet(FullFeaturedSnippet, viewset=FullFeaturedSnippetViewSet)
 register_snippet(DraftStateModel, viewset=DraftStateModelViewSet)
 # Works with both classes and instances
 register_snippet(ModeratedModelViewSet())
 register_snippet(RevisableViewSetGroup)
 register_snippet(VariousOnDeleteModelViewSet)
+register_snippet(SnippetChooserModelViewSet)
 
 
 @hooks.register("register_bulk_action")
@@ -404,3 +418,8 @@ class DisableBulkAction(SnippetBulkAction):
 @hooks.register("register_admin_viewset")
 def register_animated_advert_chooser_viewset():
     return animated_advert_chooser_viewset
+
+
+@hooks.register("register_admin_viewset")
+def register_event_page_listing_viewset():
+    return event_page_listing_viewset

wagtail/test/utils/wagtail_tests.py

@@ -9,8 +9,8 @@ from django.test.testcases import assert_and_parse_html
 
 class WagtailTestUtils:
     @staticmethod
-    def get_soup(markup: Union[str, bytes], parser="html.parser") -> BeautifulSoup:
-        return BeautifulSoup(markup, parser)
+    def get_soup(markup: Union[str, bytes]) -> BeautifulSoup:
+        return BeautifulSoup(markup, "html.parser")
 
     @staticmethod
     def create_test_user():