wagtail 7.1.1__py3-none-any.whl → 7.2rc1__py3-none-any.whl

wagtail/images/templates/wagtailimages/chooser/results.html

@@ -4,26 +4,30 @@
 {% block listing_title %}<h2>{% trans "Latest images" %}</h2>{% endblock %}
 
 {% block results_listing %}
-    <ul class="listing horiz images chooser">
-        {% for image in results %}
-            <li>
-                {% if is_multiple_choice %}
-                    <label title="Select {% if collections %}{{ image.collection.name }} » {% endif %}{{ image.title }}">
-                        <div class="image">{% image image max-165x165 class="show-transparency" %}</div>
-                        <h3>
-                            <input type="checkbox" data-multiple-choice-select name="id" value="{{ image.id }}" title="{% blocktrans trimmed with title=image.title %}Select {{ title }}{% endblocktrans %}">
-                            {{ image.title|ellipsistrim:60 }}
-                        </h3>
-                    </label>
-                {% else %}
-                    <a data-chooser-modal-choice class="image-choice" title="{% if collections %}{{ image.collection.name }} » {% endif %}{{ image.title }}" href="{{ image.chosen_url }}">
-                        <div class="image">{% image image max-165x165 class="show-transparency" %}</div>
-                        <h3>{{ image.title|ellipsistrim:60 }}</h3>
-                    </a>
-                {% endif %}
-            </li>
-        {% endfor %}
-    </ul>
+    {% if layout == "list" %}
+        {% include "wagtailadmin/tables/table.html" with table_classname="listing" %}
+    {% else %}
+        <ul class="listing horiz images chooser">
+            {% for image in results %}
+                <li>
+                    {% if is_multiple_choice %}
+                        <label title="Select {% if collections %}{{ image.collection.name }} » {% endif %}{{ image.title }}">
+                            <div class="image">{% image image max-165x165 class="show-transparency" %}</div>
+                            <h3>
+                                <input type="checkbox" data-multiple-choice-select name="id" value="{{ image.id }}" title="{% blocktrans trimmed with title=image.title %}Select {{ title }}{% endblocktrans %}">
+                                {{ image.title|ellipsistrim:60 }}
+                            </h3>
+                        </label>
+                    {% else %}
+                        <a data-chooser-modal-choice class="image-choice" title="{% if collections %}{{ image.collection.name }} » {% endif %}{{ image.title }}" href="{{ image.chosen_url }}">
+                            <div class="image">{% image image max-165x165 class="show-transparency" %}</div>
+                            <h3>{{ image.title|ellipsistrim:60 }}</h3>
+                        </a>
+                    {% endif %}
+                </li>
+            {% endfor %}
+        </ul>
+    {% endif %}
 {% endblock %}
 
 {% block no_items_message %}

wagtail/images/templates/wagtailimages/chooser/title_column_cell.html

@@ -0,0 +1,15 @@
+{% extends "wagtailadmin/tables/title_cell.html" %}
+{% load wagtailadmin_tags %}
+
+{% block title %}
+    {% if link_url %}
+        <a data-chooser-modal-choice href="{{ link_url }}">{{ value }}</a>
+    {% else %}
+        {{ value }}
+    {% endif %}
+{% endblock %}
+{% block extra %}
+    <div class="filename-wrapper">
+        <span>{{ instance.filename }}</span>
+    </div>
+{% endblock %}

wagtail/images/templates/wagtailimages/images/add.html

@@ -2,40 +2,6 @@
 {% load wagtailimages_tags wagtailadmin_tags i18n %}
 {% block titletag %}{% trans "Add an image" %}{% endblock %}
 
-{% block extra_js %}
-    {{ block.super }}
-
-    <script>
-        $(function() {
-            $('#id_file').on(
-                'change',
-                function() {
-                    var $titleField = $('#id_title');
-
-                    // do not override a title that already exists (from manual editing or previous upload)
-                    if ($titleField.val()) return;
-
-                    // file widget value example: `C:\fakepath\image.jpg` - convert to just the filename part
-                    var filename = $(this).val().split('\\').slice(-1)[0];
-                    var data = { title: filename.replace(/\.[^.]+$/, '') };
-                    var maxTitleLength = parseInt($titleField.attr('maxLength') || '0', 10) || null;
-
-                    // allow an event handler to customise data or call event.preventDefault to stop any title pre-filling
-                    var form = $(this).closest('form').get(0);
-                    var event = form.dispatchEvent(new CustomEvent(
-                        'wagtail:images-upload',
-                        { bubbles: true, cancelable: true, detail: { data: data, filename: filename, maxTitleLength: maxTitleLength } }
-                    ));
-
-                    if (!event) return; // do not set a title if event.preventDefault(); is called by handler
-
-                    $titleField.val(data.title);
-                }
-            );
-        });
-    </script>
-{% endblock %}
-
 {% block actions %}
     <button
         type="submit"

wagtail/images/templates/wagtailimages/images/index.html

@@ -8,9 +8,6 @@
 
 {% block slim_header %}
     {% fragment as extra_form_fields %}
-        <div id="layout-toggle-button">
-            {% include "wagtailimages/images/layout_toggle_button.html" %}
-        </div>
         {% rawformattedfield label_text=_("Sort by") id_for_label="order_images_by" sr_only_label=True %}
             <select id="order_images_by" name="ordering">
                 {% for ordering, ordering_text in ORDERING_OPTIONS.items %}
@@ -18,6 +15,9 @@
                 {% endfor %}
             </select>
         {% endrawformattedfield %}
+        <div id="layout-switch-control" class="w-layout-switch-control">
+            {% include "wagtailimages/images/layout_toggle_button.html" %}
+        </div>
     {% endfragment %}
     {% include "wagtailimages/images/image_listing_header.html" with breadcrumbs_items=breadcrumbs_items side_panels=side_panels history_url=history_url title=header_title search_url=index_results_url search_form=search_form filters=filters buttons=header_buttons icon_name=header_icon extra_form_fields=extra_form_fields only %}
 {% endblock %}

wagtail/images/templates/wagtailimages/images/index_results.html

@@ -4,7 +4,7 @@
 
 {% block before_results %}
     {{ block.super }}
-    <template data-controller="w-teleport" data-w-teleport-target-value="#layout-toggle-button" data-w-teleport-reset-value="true">
+    <template data-controller="w-teleport" data-w-teleport-target-value="#layout-switch-control" data-w-teleport-reset-value="true">
         {% include "wagtailimages/images/layout_toggle_button.html" %}
     </template>
 {% endblock %}

wagtail/images/templates/wagtailimages/images/layout_toggle_button.html

@@ -1,10 +1,11 @@
 {% load wagtailadmin_tags i18n %}
 
-<label class="w-slim-header-action-button w-layout-toggle-button">
-    {% if layout == "list" %}
-        {% icon name="grid" %}
-    {% else %}
-        {% icon name="list-ul" %}
-    {% endif %}
-    <input type="checkbox" aria-label="{% translate 'Toggle layout' %}" name="layout" value="list" {% if layout == "list" %}checked{% endif %} data-controller="w-tooltip" data-w-tooltip-content-value="{% translate 'Toggle layout' %}">
+<label class="w-layout-toggle-button w-layout-toggle-button-right" tabindex="0">
+    {% icon name="grid" %}
+    <input type="radio" aria-label="{% translate 'Grid layout' %}" name="layout" value="grid" {% if layout == "grid" %}checked{% endif %} data-controller="w-tooltip" data-w-tooltip-content-value="{% translate 'Grid layout' %}">
 </label>
+<label class="w-layout-toggle-button w-layout-toggle-button-left" tabindex="0">
+    {% icon name="list-ul" %}
+    <input type="radio" aria-label="{% translate 'List layout' %}" name="layout" value="list" {% if layout == "list" %}checked{% endif %} data-controller="w-tooltip" data-w-tooltip-content-value="{% translate 'List layout' %}">
+</label>
+

wagtail/images/templatetags/wagtailimages_tags.py

@@ -104,11 +104,11 @@ class ImageNode(template.Node):
         image_expr,
         filter_specs,
         output_var_name=None,
-        attrs={},
+        attrs=None,
     ):
         self.image_expr = image_expr
         self.output_var_name = output_var_name
-        self.attrs = attrs
+        self.attrs = attrs or {}
         self.filter_specs = filter_specs
 
     def get_filter(self):

wagtail/images/tests/test_admin_views.py

@@ -609,6 +609,46 @@ class TestImageIndexView(WagtailTestUtils, TestCase):
                         expected_order,
                     )
 
+    def test_filter_by_usage_count(self):
+        unused_image = Image.objects.create(
+            title="an abandoned toy",
+            file=get_test_image_file(size=(1, 1)),
+        )
+        with self.captureOnCommitCallbacks(execute=True):
+            VariousOnDeleteModel.objects.create(protected_image=self.kitten_image)
+            VariousOnDeleteModel.objects.create(protected_image=self.kitten_image)
+            VariousOnDeleteModel.objects.create(protected_image=self.puppy_image)
+
+        response = self.client.get(
+            reverse("wagtailimages:index"),
+            {"usage_count_min": "1"},
+        )
+        self.assertEqual(response.status_code, 200)
+        self.assertCountEqual(
+            response.context["page_obj"].object_list,
+            [self.kitten_image, self.puppy_image],
+        )
+
+        response = self.client.get(
+            reverse("wagtailimages:index"),
+            {"usage_count_min": "1", "usage_count_max": "1"},
+        )
+        self.assertEqual(response.status_code, 200)
+        self.assertCountEqual(
+            response.context["page_obj"].object_list,
+            [self.puppy_image],
+        )
+
+        response = self.client.get(
+            reverse("wagtailimages:index"),
+            {"usage_count_max": "0"},
+        )
+        self.assertEqual(response.status_code, 200)
+        self.assertCountEqual(
+            response.context["page_obj"].object_list,
+            [unused_image],
+        )
+
 
 class TestBulkActionsColumn(WagtailTestUtils, TestCase):
     def setUp(self):
@@ -857,6 +897,25 @@ class TestImageAddView(AdminTemplateTestUtils, WagtailTestUtils, TestCase):
             response.content,
         )
 
+        soup = self.get_soup(response.content)
+        form = soup.select_one("main form")
+        self.assertIsNotNone(form)
+        title_input = form.select_one('input[type="text"][name="title"]')
+        self.assertIsNotNone(title_input)
+        self.assertEqual(title_input.get("id"), "id_title")
+        file_input = form.select_one('input[type="file"][name="file"]')
+        self.assertIsNotNone(file_input)
+        expected_attributes = {
+            "data-controller": "w-sync",
+            "data-action": "change->w-sync#apply",
+            "data-w-sync-bubbles-param": "true",
+            "data-w-sync-name-value": "wagtail:images-upload",
+            "data-w-sync-normalize-value": "true",
+            "data-w-sync-target-value": "#id_title",
+        }
+        for attr, expected_value in expected_attributes.items():
+            self.assertEqual(file_input.get(attr), expected_value)
+
     def test_get_with_collections(self):
         root_collection = Collection.get_first_root_node()
         root_collection.add_child(name="Evil plans")
@@ -1913,6 +1972,27 @@ class TestImageChooserView(WagtailTestUtils, TestCase):
         self.assertEqual(
             soup.select_one('input[type="file"]').get("accept"), "image/*, image/avif"
         )
+        form = soup.select_one("form[data-chooser-modal-creation-form]")
+        self.assertIsNotNone(form)
+        title_input = form.select_one(
+            'input[type="text"][name="image-chooser-upload-title"]'
+        )
+        self.assertIsNotNone(title_input)
+        self.assertEqual(title_input.get("id"), "id_image-chooser-upload-title")
+        file_input = form.select_one(
+            'input[type="file"][name="image-chooser-upload-file"]'
+        )
+        self.assertIsNotNone(file_input)
+        expected_attributes = {
+            "data-controller": "w-sync",
+            "data-action": "change->w-sync#apply",
+            "data-w-sync-bubbles-param": "true",
+            "data-w-sync-name-value": "wagtail:images-upload",
+            "data-w-sync-normalize-value": "true",
+            "data-w-sync-target-value": "#id_image-chooser-upload-title",
+        }
+        for attr, expected_value in expected_attributes.items():
+            self.assertEqual(file_input.get(attr), expected_value)
 
     def test_simple_with_collection_nesting(self):
         root_collection = Collection.get_first_root_node()
@@ -3808,6 +3888,13 @@ class TestURLGeneratorView(AdminTemplateTestUtils, WagtailTestUtils, TestCase):
             response.content,
         )
 
+        soup = self.get_soup(response.content)
+        form = soup.select_one("main form")
+        closeness = form.select_one("input[name=closeness]")
+        self.assertIsNotNone(closeness)
+        self.assertEqual(closeness.get("min"), "0")
+        self.assertEqual(closeness.get("max"), "100")
+
     def test_get_bad_permissions(self):
         """
         This tests that the view returns a "permission denied" redirect if a user without correct

wagtail/images/tests/test_form_overrides.py

@@ -49,7 +49,7 @@ class TestImageFormOverride(TestCase):
         self.assertIn("tags", form.errors)
         self.assertEqual(
             form.errors["tags"][0],
-            "Tag(s) ['{val}'] are over {max_tag_length} characters".format(
+            "Tag(s) ['{val}'] are over {max_tag_length} characters.".format(
                 val=long_value,
                 max_tag_length=taggit_models.TagBase._meta.get_field("name").max_length,
             ),

wagtail/images/tests/test_models.py

@@ -1,9 +1,11 @@
 import hashlib
 import unittest
+from io import StringIO
+from unittest import mock
 
 from django.conf import settings
 from django.contrib.auth.models import Group, Permission
-from django.core import checks
+from django.core import checks, management
 from django.core.cache import caches
 from django.core.files import File
 from django.core.files.storage import Storage, default_storage, storages
@@ -25,6 +27,10 @@ from wagtail.images.models import (
 )
 from wagtail.images.rect import Rect
 from wagtail.models import Collection, GroupCollectionPermission, Page, ReferenceIndex
+from wagtail.test.dummy_external_storage import (
+    DummyExternalStorage,
+    DummyExternalStorageFile,
+)
 from wagtail.test.testapp.models import (
     CustomRendition,
     EventPage,
@@ -45,6 +51,16 @@ class CustomStorage(Storage):
     pass
 
 
+class AnotherDummyExternalStorage(DummyExternalStorage):
+    def _open(self, name, mode="rb"):
+        # External storages has their own File type
+        return AnotherDummyExternalStorageFile(open(self.wrapped.path(name), mode))
+
+
+class AnotherDummyExternalStorageFile(DummyExternalStorageFile):
+    pass
+
+
 class TestImage(TestCase):
     def setUp(self):
         # Create an image for running tests on
@@ -122,6 +138,18 @@ class TestImage(TestCase):
     def test_is_stored_locally_with_external_storage(self):
         self.assertFalse(self.image.is_stored_locally())
 
+    @override_settings(
+        DEFAULT_FILE_STORAGE="wagtail.test.dummy_external_storage.DummyExternalStorage"
+    )
+    def test_reopen_based_on_storage_that_is_dynamically_set(self):
+        self.image.file.close()
+        # Simulate the case is which the storage is set dynamically
+        with mock.patch.object(
+            self.image.file, "storage", AnotherDummyExternalStorage()
+        ):
+            with self.image.open_file() as file:
+                self.assertIsInstance(file, AnotherDummyExternalStorageFile)
+
     def test_get_file_size(self):
         file_size = self.image.get_file_size()
         self.assertIsInstance(file_size, int)
@@ -1262,6 +1290,13 @@ class TestIssue613(WagtailTestUtils, TestCase):
         self.search_backend = self.get_elasticsearch_backend()
         self.login()
 
+        management.call_command(
+            "update_index",
+            backend_name="elasticsearch",
+            stdout=StringIO(),
+            chunk_size=50,
+        )
+
     def add_image(self, **params):
         post_data = {
             "title": "Test image",
@@ -1311,13 +1346,15 @@ class TestIssue613(WagtailTestUtils, TestCase):
         return image
 
     def test_issue_613_on_add(self):
-        # Reset the search index
-        self.search_backend.reset_index()
-        self.search_backend.add_type(Image)
+        # Note to future developer troubleshooting this test...
+        # This test previously started by calling self.search_backend.reset_index(), but that was evidently redundant because
+        # this was broken on Elasticsearch prior to the fix in
+        # https://github.com/wagtail/wagtailsearch/commit/53a98169bccc3cef5b234944037f2b3f78efafd4 .
+        # If this turns out to be necessary after all, you might want to compare how wagtail.tests.test_page_search.PageSearchTests does it.
 
         # Add an image with some tags
         image = self.add_image(tags="hello")
-        self.search_backend.refresh_index()
+        self.search_backend.refresh_indexes()
 
         # Search for it by tag
         results = self.search_backend.search("hello", Image)
@@ -1327,13 +1364,15 @@ class TestIssue613(WagtailTestUtils, TestCase):
         self.assertEqual(results[0].id, image.id)
 
     def test_issue_613_on_edit(self):
-        # Reset the search index
-        self.search_backend.reset_index()
-        self.search_backend.add_type(Image)
+        # Note to future developer troubleshooting this test...
+        # This test previously started by calling self.search_backend.reset_index(), but that was evidently redundant because
+        # this was broken on Elasticsearch prior to the fix in
+        # https://github.com/wagtail/wagtailsearch/commit/53a98169bccc3cef5b234944037f2b3f78efafd4 .
+        # If this turns out to be necessary after all, you might want to compare how wagtail.tests.test_page_search.PageSearchTests does it.
 
         # Add an image with some tags
         image = self.edit_image(tags="hello")
-        self.search_backend.refresh_index()
+        self.search_backend.refresh_indexes()
 
         # Search for it by tag
         results = self.search_backend.search("hello", Image)

wagtail/images/views/chooser.py

@@ -10,6 +10,13 @@ from django.views.generic.base import View
 from wagtail.admin.auth import PermissionPolicyChecker
 from wagtail.admin.modal_workflow import render_modal_workflow
 from wagtail.admin.models import popular_tags_for_model
+from wagtail.admin.ui.tables import (
+    BaseColumn,
+    Column,
+    DateColumn,
+    TitleColumn,
+    UsageCountColumn,
+)
 from wagtail.admin.views.generic.chooser import (
     BaseChooseView,
     ChooseResultsViewMixin,
@@ -27,6 +34,7 @@ from wagtail.images.formats import get_image_format
 from wagtail.images.forms import ImageInsertionForm, get_image_form
 from wagtail.images.permissions import permission_policy
 from wagtail.images.utils import find_image_duplicates
+from wagtail.models import ReferenceIndex
 
 permission_checker = PermissionPolicyChecker(permission_policy)
 
@@ -83,7 +91,8 @@ class BaseImageChooseView(BaseChooseView):
         return getattr(settings, "WAGTAILIMAGES_CHOOSER_PAGE_SIZE", 20)
 
     def get_object_list(self):
-        return (
+        # Get images (filtered by user permission)
+        images = (
             permission_policy.instances_user_has_any_permission_for(
                 self.request.user, ["choose"]
             )
@@ -91,6 +100,13 @@ class BaseImageChooseView(BaseChooseView):
             .prefetch_renditions("max-165x165")
         )
 
+        # Annotate with usage count from the ReferenceIndex
+        images = images.annotate(
+            usage_count=ReferenceIndex.usage_count_subquery(self.model)
+        )
+
+        return images
+
     def filter_object_list(self, objects):
         tag_name = self.request.GET.get("tag")
         if tag_name:
@@ -130,8 +146,53 @@ class BaseImageChooseView(BaseChooseView):
             )
 
         context["collections"] = self.collections
+        context["layout"] = self.layout
         return context
 
+    @cached_property
+    def layout(self):
+        return self.request.GET.get("layout", "grid")
+
+    @cached_property
+    def columns(self):
+        if self.layout == "grid":
+            return []
+        else:
+            columns = [
+                ImagePreviewColumn(
+                    "preview",
+                    label=_("Preview"),
+                    accessor="image",
+                    classname="image-preview",
+                ),
+                TitleColumnWithFilename(
+                    "title",
+                    label=_("Title"),
+                    get_url=lambda obj: obj.chosen_url,
+                    width="35%",
+                    classname="title-with-filename",
+                ),
+                Column("collection", label=_("Collection"), accessor="collection.name"),
+                DateColumn(
+                    "created_at",
+                    label=_("Created"),
+                ),
+                UsageCountColumn(
+                    "usage_count",
+                    label=_("Usage"),
+                    width="16%",
+                ),
+            ]
+        return columns
+
+
+class ImagePreviewColumn(BaseColumn):
+    cell_template_name = "wagtailimages/chooser/image_preview_column_cell.html"
+
+
+class TitleColumnWithFilename(TitleColumn):
+    cell_template_name = "wagtailimages/chooser/title_column_cell.html"
+
 
 class ImageChooseViewMixin(ChooseViewMixin):
     def get_context_data(self, **kwargs):
@@ -312,7 +373,10 @@ class ImageChooserViewSet(ChooserViewSet):
     select_format_view_class = ImageSelectFormatView
     permission_policy = permission_policy
     register_widget = False
-    preserve_url_parameters = ChooserViewSet.preserve_url_parameters + ["select_format"]
+    preserve_url_parameters = ChooserViewSet.preserve_url_parameters + [
+        "select_format",
+        "layout",
+    ]
 
     icon = "image"
     choose_one_text = _("Choose an image")