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

wagtail/models/collections.py

@@ -1,190 +1,5 @@
-from django.contrib.auth.models import Group, Permission
-from django.db import models
-from django.utils.html import format_html
-from django.utils.safestring import mark_safe
-from django.utils.translation import gettext_lazy as _
-from treebeard.mp_tree import MP_Node
+# wagtail.models.collections was moved to wagtail.models.media in #11555;
+# this import is retained to accommodate migration files importing from the old location.
+# See #11874
 
-from wagtail.query import TreeQuerySet
-from wagtail.search import index
-
-from .view_restrictions import BaseViewRestriction
-
-
-class CollectionQuerySet(TreeQuerySet):
-    def get_indented_choices(self):
-        """
-        Return a list of (id, label) tuples for use as a list of choices in a collection chooser
-        dropdown, where the label is formatted with get_indented_name to provide a tree layout.
-        The indent level is chosen to place the minimum-depth collection at indent 0.
-        """
-        min_depth = self.aggregate(models.Min("depth"))["depth__min"] or 2
-        return [
-            (collection.pk, collection.get_indented_name(min_depth, html=True))
-            for collection in self
-        ]
-
-
-class BaseCollectionManager(models.Manager):
-    def get_queryset(self):
-        return CollectionQuerySet(self.model).order_by("path")
-
-
-CollectionManager = BaseCollectionManager.from_queryset(CollectionQuerySet)
-
-
-class CollectionViewRestriction(BaseViewRestriction):
-    collection = models.ForeignKey(
-        "Collection",
-        verbose_name=_("collection"),
-        related_name="view_restrictions",
-        on_delete=models.CASCADE,
-    )
-
-    passed_view_restrictions_session_key = "passed_collection_view_restrictions"
-
-    class Meta:
-        verbose_name = _("collection view restriction")
-        verbose_name_plural = _("collection view restrictions")
-
-
-class Collection(MP_Node):
-    """
-    A location in which resources such as images and documents can be grouped
-    """
-
-    name = models.CharField(max_length=255, verbose_name=_("name"))
-
-    objects = CollectionManager()
-    # Tell treebeard to order Collections' paths such that they are ordered by name at each level.
-    node_order_by = ["name"]
-
-    def __str__(self):
-        return self.name
-
-    def get_ancestors(self, inclusive=False):
-        return Collection.objects.ancestor_of(self, inclusive)
-
-    def get_descendants(self, inclusive=False):
-        return Collection.objects.descendant_of(self, inclusive)
-
-    def get_siblings(self, inclusive=True):
-        return Collection.objects.sibling_of(self, inclusive)
-
-    def get_next_siblings(self, inclusive=False):
-        return self.get_siblings(inclusive).filter(path__gte=self.path).order_by("path")
-
-    def get_prev_siblings(self, inclusive=False):
-        return (
-            self.get_siblings(inclusive).filter(path__lte=self.path).order_by("-path")
-        )
-
-    def get_view_restrictions(self):
-        """Return a query set of all collection view restrictions that apply to this collection"""
-        return CollectionViewRestriction.objects.filter(
-            collection__in=self.get_ancestors(inclusive=True)
-        )
-
-    def get_indented_name(self, indentation_start_depth=2, html=False):
-        """
-        Renders this Collection's name as a formatted string that displays its hierarchical depth via indentation.
-        If indentation_start_depth is supplied, the Collection's depth is rendered relative to that depth.
-        indentation_start_depth defaults to 2, the depth of the first non-Root Collection.
-        Pass html=True to get a HTML representation, instead of the default plain-text.
-
-        Example text output: "    ↳ Pies"
-        Example HTML output: "    &#x21b3 Pies"
-        """
-        display_depth = self.depth - indentation_start_depth
-        # A Collection with a display depth of 0 or less (Root's can be -1), should have no indent.
-        if display_depth <= 0:
-            return self.name
-
-        # Indent each level of depth by 4 spaces (the width of the ↳ character in our admin font), then add ↳
-        # before adding the name.
-        if html:
-            # NOTE: &#x21b3 is the hex HTML entity for ↳.
-            return format_html(
-                "{indent}{icon} {name}",
-                indent=mark_safe("&nbsp;" * 4 * display_depth),
-                icon=mark_safe("&#x21b3"),
-                name=self.name,
-            )
-        # Output unicode plain-text version
-        return "{}↳ {}".format(" " * 4 * display_depth, self.name)
-
-    class Meta:
-        verbose_name = _("collection")
-        verbose_name_plural = _("collections")
-
-
-def get_root_collection_id():
-    return Collection.get_first_root_node().id
-
-
-class CollectionMember(models.Model):
-    """
-    Base class for models that are categorised into collections
-    """
-
-    collection = models.ForeignKey(
-        Collection,
-        default=get_root_collection_id,
-        verbose_name=_("collection"),
-        related_name="+",
-        on_delete=models.CASCADE,
-    )
-
-    search_fields = [
-        index.FilterField("collection"),
-    ]
-
-    class Meta:
-        abstract = True
-
-
-class GroupCollectionPermissionManager(models.Manager):
-    def get_by_natural_key(self, group, collection, permission):
-        return self.get(group=group, collection=collection, permission=permission)
-
-
-class GroupCollectionPermission(models.Model):
-    """
-    A rule indicating that a group has permission for some action (e.g. "create document")
-    within a specified collection.
-    """
-
-    group = models.ForeignKey(
-        Group,
-        verbose_name=_("group"),
-        related_name="collection_permissions",
-        on_delete=models.CASCADE,
-    )
-    collection = models.ForeignKey(
-        Collection,
-        verbose_name=_("collection"),
-        related_name="group_permissions",
-        on_delete=models.CASCADE,
-    )
-    permission = models.ForeignKey(
-        Permission, verbose_name=_("permission"), on_delete=models.CASCADE
-    )
-
-    def __str__(self):
-        return "Group %d ('%s') has permission '%s' on collection %d ('%s')" % (
-            self.group.id,
-            self.group,
-            self.permission,
-            self.collection.id,
-            self.collection,
-        )
-
-    def natural_key(self):
-        return (self.group, self.collection, self.permission)
-
-    objects = GroupCollectionPermissionManager()
-
-    class Meta:
-        unique_together = ("group", "collection", "permission")
-        verbose_name = _("group collection permission")
-        verbose_name_plural = _("group collection permissions")
+from wagtail.models.media import get_root_collection_id  # noqa

wagtail/models/i18n.py

@@ -378,7 +378,7 @@ def bootstrap_translatable_model(model, locale):
     This function populates the "translation_key", and "locale" fields on model instances that were created
     before wagtail-localize was added to the site.
 
-    This can be called from a data migration, or instead you could use the "boostrap_translatable_models"
+    This can be called from a data migration, or instead you could use the "bootstrap_translatable_models"
     management command.
     """
     for instance in (

wagtail/models/media.py

@@ -0,0 +1,221 @@
+from django.conf import settings
+from django.contrib.auth.models import Group, Permission
+from django.contrib.contenttypes.models import ContentType
+from django.db import models
+from django.utils.html import format_html
+from django.utils.safestring import mark_safe
+from django.utils.translation import gettext_lazy as _
+from treebeard.mp_tree import MP_Node
+
+from wagtail.query import TreeQuerySet
+from wagtail.search import index
+
+from .view_restrictions import BaseViewRestriction
+
+
+class CollectionQuerySet(TreeQuerySet):
+    def get_min_depth(self):
+        return self.aggregate(models.Min("depth"))["depth__min"] or 2
+
+    def get_indented_choices(self):
+        """
+        Return a list of (id, label) tuples for use as a list of choices in a collection chooser
+        dropdown, where the label is formatted with get_indented_name to provide a tree layout.
+        The indent level is chosen to place the minimum-depth collection at indent 0.
+        """
+        min_depth = self.get_min_depth()
+        return [
+            (collection.pk, collection.get_indented_name(min_depth, html=True))
+            for collection in self
+        ]
+
+
+class BaseCollectionManager(models.Manager):
+    def get_queryset(self):
+        return CollectionQuerySet(self.model).order_by("path")
+
+
+CollectionManager = BaseCollectionManager.from_queryset(CollectionQuerySet)
+
+
+class CollectionViewRestriction(BaseViewRestriction):
+    collection = models.ForeignKey(
+        "Collection",
+        verbose_name=_("collection"),
+        related_name="view_restrictions",
+        on_delete=models.CASCADE,
+    )
+
+    passed_view_restrictions_session_key = "passed_collection_view_restrictions"
+
+    class Meta:
+        verbose_name = _("collection view restriction")
+        verbose_name_plural = _("collection view restrictions")
+
+
+class Collection(MP_Node):
+    """
+    A location in which resources such as images and documents can be grouped
+    """
+
+    name = models.CharField(max_length=255, verbose_name=_("name"))
+
+    objects = CollectionManager()
+    # Tell treebeard to order Collections' paths such that they are ordered by name at each level.
+    node_order_by = ["name"]
+
+    def __str__(self):
+        return self.name
+
+    def get_ancestors(self, inclusive=False):
+        return Collection.objects.ancestor_of(self, inclusive)
+
+    def get_descendants(self, inclusive=False):
+        return Collection.objects.descendant_of(self, inclusive)
+
+    def get_siblings(self, inclusive=True):
+        return Collection.objects.sibling_of(self, inclusive)
+
+    def get_next_siblings(self, inclusive=False):
+        return self.get_siblings(inclusive).filter(path__gte=self.path).order_by("path")
+
+    def get_prev_siblings(self, inclusive=False):
+        return (
+            self.get_siblings(inclusive).filter(path__lte=self.path).order_by("-path")
+        )
+
+    def get_view_restrictions(self):
+        """Return a query set of all collection view restrictions that apply to this collection"""
+        return CollectionViewRestriction.objects.filter(
+            collection__in=self.get_ancestors(inclusive=True)
+        )
+
+    def get_indented_name(self, indentation_start_depth=2, html=False):
+        """
+        Renders this Collection's name as a formatted string that displays its hierarchical depth via indentation.
+        If indentation_start_depth is supplied, the Collection's depth is rendered relative to that depth.
+        indentation_start_depth defaults to 2, the depth of the first non-Root Collection.
+        Pass html=True to get an HTML representation, instead of the default plain-text.
+
+        Example text output: "    ↳ Pies"
+        Example HTML output: "    &#x21b3 Pies"
+        """
+        display_depth = self.depth - indentation_start_depth
+        # A Collection with a display depth of 0 or less (Root's can be -1), should have no indent.
+        if display_depth <= 0:
+            return self.name
+
+        # Indent each level of depth by 4 spaces (the width of the ↳ character in our admin font), then add ↳
+        # before adding the name.
+        if html:
+            # NOTE: &#x21b3 is the hex HTML entity for ↳.
+            return format_html(
+                "{indent}{icon} {name}",
+                indent=mark_safe("&nbsp;" * 4 * display_depth),
+                icon=mark_safe("&#x21b3"),
+                name=self.name,
+            )
+        # Output unicode plain-text version
+        return "{}↳ {}".format(" " * 4 * display_depth, self.name)
+
+    class Meta:
+        verbose_name = _("collection")
+        verbose_name_plural = _("collections")
+
+
+def get_root_collection_id():
+    return Collection.get_first_root_node().id
+
+
+class CollectionMember(models.Model):
+    """
+    Base class for models that are categorised into collections
+    """
+
+    collection = models.ForeignKey(
+        Collection,
+        default=get_root_collection_id,
+        verbose_name=_("collection"),
+        related_name="+",
+        on_delete=models.CASCADE,
+    )
+
+    search_fields = [
+        index.FilterField("collection"),
+    ]
+
+    class Meta:
+        abstract = True
+
+
+class GroupCollectionPermissionManager(models.Manager):
+    def get_by_natural_key(self, group, collection, permission):
+        return self.get(group=group, collection=collection, permission=permission)
+
+
+class GroupCollectionPermission(models.Model):
+    """
+    A rule indicating that a group has permission for some action (e.g. "create document")
+    within a specified collection.
+    """
+
+    group = models.ForeignKey(
+        Group,
+        verbose_name=_("group"),
+        related_name="collection_permissions",
+        on_delete=models.CASCADE,
+    )
+    collection = models.ForeignKey(
+        Collection,
+        verbose_name=_("collection"),
+        related_name="group_permissions",
+        on_delete=models.CASCADE,
+    )
+    permission = models.ForeignKey(
+        Permission, verbose_name=_("permission"), on_delete=models.CASCADE
+    )
+
+    def __str__(self):
+        return "Group %d ('%s') has permission '%s' on collection %d ('%s')" % (
+            self.group.id,
+            self.group,
+            self.permission,
+            self.collection.id,
+            self.collection,
+        )
+
+    def natural_key(self):
+        return (self.group, self.collection, self.permission)
+
+    objects = GroupCollectionPermissionManager()
+
+    class Meta:
+        unique_together = ("group", "collection", "permission")
+        verbose_name = _("group collection permission")
+        verbose_name_plural = _("group collection permissions")
+
+
+class UploadedFile(models.Model):
+    """
+    Temporary storage for media fields uploaded through the multiple image/document uploader.
+    When validation rules (e.g. required metadata fields) prevent creating an Image/Document object from the file alone.
+    In this case, the file is stored against this model, to be turned into an Image/Document object once the full form
+    has been filled in.
+    """
+
+    for_content_type = models.ForeignKey(
+        ContentType,
+        verbose_name=_("for content type"),
+        related_name="uploads",
+        on_delete=models.CASCADE,
+        null=True,
+    )
+    file = models.FileField(upload_to="wagtail_uploads", max_length=200)
+    uploaded_by_user = models.ForeignKey(
+        settings.AUTH_USER_MODEL,
+        verbose_name=_("uploaded by user"),
+        null=True,
+        blank=True,
+        editable=False,
+        on_delete=models.SET_NULL,
+    )

wagtail/models/reference_index.py

@@ -160,7 +160,7 @@ class ReferenceIndex(models.Model):
     # linked by a ParentalKey.
     tracked_models = set()
 
-    # Ths set of models that can appear as the 'from' object in the reference index.
+    # The set of models that can appear as the 'from' object in the reference index.
     # This only includes those registered with `register_model`, and NOT child models linked
     # by ParentalKey (object references on those are recorded under the parent).
     indexed_models = set()

wagtail/models/view_restrictions.py

@@ -19,13 +19,20 @@ class BaseViewRestriction(models.Model):
 
     RESTRICTION_CHOICES = (
         (NONE, _("Public")),
-        (LOGIN, _("Private, accessible to logged-in users")),
-        (PASSWORD, _("Private, accessible with the following password")),
+        (PASSWORD, _("Private, accessible with a shared password")),
+        (LOGIN, _("Private, accessible to any logged-in users")),
         (GROUPS, _("Private, accessible to users in specific groups")),
     )
 
     restriction_type = models.CharField(max_length=20, choices=RESTRICTION_CHOICES)
-    password = models.CharField(verbose_name=_("password"), max_length=255, blank=True)
+    password = models.CharField(
+        verbose_name=_("shared password"),
+        max_length=255,
+        blank=True,
+        help_text=_(
+            "Shared passwords should not be used to protect sensitive content. Anyone who has this password will be able to view the content."
+        ),
+    )
     groups = models.ManyToManyField(Group, verbose_name=_("groups"), blank=True)
 
     def accept_request(self, request):

wagtail/project_template/project_name/settings/base.py

@@ -172,3 +172,9 @@ WAGTAILSEARCH_BACKENDS = {
 # Base URL to use when referring to full URLs within the Wagtail admin backend -
 # e.g. in notification emails. Don't include '/admin' or a trailing slash
 WAGTAILADMIN_BASE_URL = "http://example.com"
+
+# Allowed file extensions for documents in the document library.
+# This can be omitted to allow all files, but note that this may present a security risk
+# if untrusted users are allowed to upload files -
+# see https://docs.wagtail.org/en/stable/advanced_topics/deploying.html#user-uploaded-files
+WAGTAILDOCS_EXTENSIONS = ['csv', 'docx', 'key', 'odt', 'pdf', 'pptx', 'rtf', 'txt', 'xlsx', 'zip']

wagtail/project_template/requirements.txt

@@ -1,2 +1,2 @@
 Django>=4.2,<5.1
-wagtail>=6.0,<6.1
+wagtail==6.1rc2

wagtail/rich_text/__init__.py

@@ -1,6 +1,7 @@
 import re
 from functools import lru_cache
 from html import unescape
+from typing import List
 
 from django.core.validators import MaxLengthValidator
 from django.db.models import Model
@@ -26,23 +27,23 @@ def get_rewriter():
     return MultiRuleRewriter(
         [
             LinkRewriter(
-                {
-                    linktype: handler.expand_db_attributes
+                bulk_rules={
+                    linktype: handler.expand_db_attributes_many
                     for linktype, handler in link_rules.items()
                 },
-                {
+                reference_extractors={
                     linktype: handler.extract_references
                     for linktype, handler in link_rules.items()
                 },
             ),
             EmbedRewriter(
-                {
-                    embedtype: handler.expand_db_attributes
+                bulk_rules={
+                    embedtype: handler.expand_db_attributes_many
                     for embedtype, handler in embed_rules.items()
                 },
-                {
-                    linktype: handler.extract_references
-                    for linktype, handler in embed_rules.items()
+                reference_extractors={
+                    embedtype: handler.extract_references
+                    for embedtype, handler in embed_rules.items()
                 },
             ),
         ]
@@ -130,6 +131,14 @@ class EntityHandler:
         model = cls.get_model()
         return model._default_manager.get(id=attrs["id"])
 
+    @classmethod
+    def get_many(cls, attrs_list: List[dict]) -> List[Model]:
+        model = cls.get_model()
+        instance_ids = [attrs.get("id") for attrs in attrs_list]
+        instances_by_id = model._default_manager.in_bulk(instance_ids)
+        instances_by_str_id = {str(k): v for k, v in instances_by_id.items()}
+        return [instances_by_str_id.get(str(id_)) for id_ in instance_ids]
+
     @staticmethod
     def expand_db_attributes(attrs: dict) -> str:
         """
@@ -138,6 +147,14 @@ class EntityHandler:
         """
         raise NotImplementedError
 
+    @classmethod
+    def expand_db_attributes_many(cls, attrs_list: List[dict]) -> List[str]:
+        """
+        Given a list of attribute dicts from a list of entity tags stored in
+        the database, return the real HTML representation of each one.
+        """
+        return list(map(cls.expand_db_attributes, attrs_list))
+
     @classmethod
     def extract_references(cls, attrs):
         """

wagtail/rich_text/pages.py

@@ -1,3 +1,6 @@
+from typing import List
+
+from django.db.models import Model
 from django.utils.html import escape
 
 from wagtail.models import Page
@@ -12,16 +15,24 @@ class PageLinkHandler(LinkHandler):
         return Page
 
     @classmethod
-    def get_instance(cls, attrs):
-        return super().get_instance(attrs).specific
+    def get_many(cls, attrs_list: List[dict]) -> List[Model]:
+        # Override LinkHandler.get_many to reduce database queries through the
+        # use of PageQuerySet.specific() instead of QuerySet.in_bulk().
+        instance_ids = [attrs.get("id") for attrs in attrs_list]
+        qs = Page.objects.filter(id__in=instance_ids).defer_streamfields().specific()
+        pages_by_str_id = {str(page.id): page for page in qs}
+        return [pages_by_str_id.get(str(id_)) for id_ in instance_ids]
+
+    @classmethod
+    def expand_db_attributes(cls, attrs: dict) -> str:
+        return cls.expand_db_attributes_many([attrs])[0]
 
     @classmethod
-    def expand_db_attributes(cls, attrs):
-        try:
-            page = cls.get_instance(attrs)
-            return '<a href="%s">' % escape(page.localized.specific.url)
-        except Page.DoesNotExist:
-            return "<a>"
+    def expand_db_attributes_many(cls, attrs_list: List[dict]) -> List[str]:
+        return [
+            '<a href="%s">' % escape(page.localized.url) if page else "<a>"
+            for page in cls.get_many(attrs_list)
+        ]
 
     @classmethod
     def extract_references(self, attrs):