wagtail 6.2.2__py3-none-any.whl → 6.3rc2__py3-none-any.whl

wagtail/documents/templates/wagtaildocs/multiple/add.html

@@ -1,4 +1,4 @@
-{% extends "wagtailadmin/base.html" %}
+{% extends "wagtailadmin/generic/base.html" %}
 {% load i18n %}
 {% load l10n %}
 {% load wagtailadmin_tags %}
@@ -9,43 +9,45 @@
     {{ form_media.css }}
 {% endblock %}
 
-{% block content %}
-    {% trans "Add documents" as add_str %}
-    {% include "wagtailadmin/shared/header.html" with title=add_str icon="doc-full-inverse" %}
+{% block main_content %}
+    <div class="drop-zone w-mt-8">
+        <p>{% trans "Drag and drop documents into this area to upload immediately." %}</p>
+        <p>{{ help_text }}</p>
 
-    <div class="nice-padding">
-        <div class="drop-zone">
-            <p>{% trans "Drag and drop documents into this area to upload immediately." %}</p>
-            <p>{{ help_text }}</p>
-
-            <form action="{% url 'wagtaildocs:add_multiple' %}" method="POST" enctype="multipart/form-data">
-                <div class="replace-file-input">
-                    <button class="button bicolor button--icon">{% icon name="plus" wrapped=1 %}{% trans "Or choose from your computer" %}</button>
-                    <input id="fileupload" type="file" name="files[]" data-url="{% url 'wagtaildocs:add_multiple' %}" multiple>
-                </div>
-                {% csrf_token %}
-                {% if collections %}
-                    {% trans "Add to collection:" as label_text %}
-                    {% rawformattedfield label_text=label_text id_for_label="id_adddocument_collection" classname="w-mx-auto w-mt-4 w-grid w-justify-center"  %}
-                        <select id="id_adddocument_collection" name="collection">
-                            {% for pk, display_name in collections.get_indented_choices %}
-                                <option value="{{ pk|unlocalize }}"{% if pk|unlocalize == selected_collection_id %} selected{% endif %}>
-                                    {{ display_name }}
-                                </option>
-                            {% endfor %}
-                        </select>
-                    {% endrawformattedfield %}
-                {% endif %}
-            </form>
-        </div>
-
-        <div id="overall-progress" class="progress progress-secondary">
-            <div class="bar" style="width: 0%;">0%</div>
-        </div>
+        <form action="{% url 'wagtaildocs:add_multiple' %}" method="POST" enctype="multipart/form-data">
+            <div class="replace-file-input">
+                <button class="button bicolor button--icon">{% icon name="plus" wrapped=1 %}{% trans "Or choose from your computer" %}</button>
+                <input
+                    id="fileupload"
+                    multiple
+                    name="files[]"
+                    type="file"
+                    data-max-title-length="{{ max_title_length|stringformat:'s'|default:'null' }}"
+                    data-url="{% url 'wagtaildocs:add_multiple' %}"
+                >
+            </div>
+            {% csrf_token %}
+            {% if collections %}
+                {% trans "Add to collection:" as label_text %}
+                {% rawformattedfield label_text=label_text id_for_label="id_adddocument_collection" classname="w-mx-auto w-mt-4 w-grid w-justify-center"  %}
+                    <select id="id_adddocument_collection" name="collection">
+                        {% for pk, display_name in collections.get_indented_choices %}
+                            <option value="{{ pk|unlocalize }}"{% if pk|unlocalize == selected_collection_id %} selected{% endif %}>
+                                {{ display_name }}
+                            </option>
+                        {% endfor %}
+                    </select>
+                {% endrawformattedfield %}
+            {% endif %}
+        </form>
+    </div>
 
-        <ul id="upload-list" class="upload-list multiple"></ul>
+    <div id="overall-progress" class="progress progress-secondary">
+        <div class="bar" style="width: 0%;">0%</div>
     </div>
 
+    <ul id="upload-list" class="upload-list multiple"></ul>
+
     <template id="upload-list-item">
         <li class="row">
             <div class="left col3">
@@ -78,11 +80,4 @@
 
     <!-- Main script -->
     <script src="{% versioned_static 'wagtaildocs/js/add-multiple.js' %}"></script>
-
-    <script>
-        window.fileupload_opts = {
-            max_title_length: {{ max_title_length|stringformat:"s"|default:"null" }}, //numeric format
-            simple_upload_url: "{% url 'wagtaildocs:add' %}"
-        }
-    </script>
 {% endblock %}

wagtail/documents/tests/test_admin_views.py

@@ -9,6 +9,7 @@ from django.test.utils import override_settings
 from django.urls import reverse
 from django.utils.html import escape
 from django.utils.http import urlencode
+from django.utils.text import capfirst
 
 from wagtail.admin.admin_url_finder import AdminURLFinder
 from wagtail.documents import get_document_model, models
@@ -28,6 +29,7 @@ from wagtail.test.testapp.models import (
     VariousOnDeleteModel,
 )
 from wagtail.test.utils import WagtailTestUtils
+from wagtail.test.utils.template_tests import AdminTemplateTestUtils
 
 
 class TestDocumentIndexView(WagtailTestUtils, TestCase):
@@ -71,7 +73,11 @@ class TestDocumentIndexView(WagtailTestUtils, TestCase):
         response = self.get({"p": "Hello World!"})
 
         # Check response
-        self.assertEqual(response.status_code, 404)
+        self.assertEqual(response.status_code, 200)
+        self.assertTemplateUsed(response, "wagtaildocs/documents/index.html")
+
+        # Check that we got page one
+        self.assertEqual(response.context["page_obj"].number, 1)
 
     def test_pagination_out_of_range(self):
         self.make_docs()
@@ -79,7 +85,14 @@ class TestDocumentIndexView(WagtailTestUtils, TestCase):
         response = self.get({"p": 99999})
 
         # Check response
-        self.assertEqual(response.status_code, 404)
+        self.assertEqual(response.status_code, 200)
+        self.assertTemplateUsed(response, "wagtaildocs/documents/index.html")
+
+        # Check that we got the last page
+        self.assertEqual(
+            response.context["page_obj"].number,
+            response.context["paginator"].num_pages,
+        )
 
     def test_ordering(self):
         orderings = ["title", "-created_at"]
@@ -392,7 +405,7 @@ class TestDocumentIndexResultsView(WagtailTestUtils, TransactionTestCase):
         self.assertContains(response, "<td>Root</td>", html=True)
 
 
-class TestDocumentAddView(WagtailTestUtils, TestCase):
+class TestDocumentAddView(AdminTemplateTestUtils, WagtailTestUtils, TestCase):
     def setUp(self):
         self.login()
 
@@ -414,6 +427,14 @@ class TestDocumentAddView(WagtailTestUtils, TestCase):
         # draftail should NOT be a standard JS include on this page
         self.assertNotContains(response, "wagtailadmin/js/draftail.js")
 
+        self.assertBreadcrumbsItemsRendered(
+            [
+                {"url": reverse("wagtaildocs:index"), "label": "Documents"},
+                {"url": "", "label": "New: Document"},
+            ],
+            response.content,
+        )
+
     def test_get_with_collections(self):
         root_collection = Collection.get_first_root_node()
         root_collection.add_child(name="Evil plans")
@@ -606,7 +627,7 @@ class TestDocumentAddViewWithLimitedCollectionPermissions(WagtailTestUtils, Test
         )
 
 
-class TestDocumentEditView(WagtailTestUtils, TestCase):
+class TestDocumentEditView(AdminTemplateTestUtils, WagtailTestUtils, TestCase):
     def setUp(self):
         self.user = self.login()
 
@@ -665,6 +686,14 @@ class TestDocumentEditView(WagtailTestUtils, TestCase):
         # definitions are being respected)
         self.assertNotContains(response, "wagtailadmin/js/draftail.js")
 
+        self.assertBreadcrumbsItemsRendered(
+            [
+                {"url": reverse("wagtaildocs:index"), "label": "Documents"},
+                {"url": "", "label": "Test document"},
+            ],
+            response.content,
+        )
+
         url_finder = AdminURLFinder(self.user)
         expected_url = "/admin/documents/edit/%d/" % self.document.id
         self.assertEqual(url_finder.get_edit_url(self.document), expected_url)
@@ -1013,7 +1042,7 @@ class TestDocumentDeleteView(WagtailTestUtils, TestCase):
         self.assertContains(response, "This document is referenced 0 times")
 
 
-class TestMultipleDocumentUploader(WagtailTestUtils, TestCase):
+class TestMultipleDocumentUploader(AdminTemplateTestUtils, WagtailTestUtils, TestCase):
     """
     This tests the multiple document upload views located in wagtaildocs/views/multiple.py
     """
@@ -1052,6 +1081,17 @@ class TestMultipleDocumentUploader(WagtailTestUtils, TestCase):
         self.assertEqual(response.status_code, 200)
         self.assertTemplateUsed(response, "wagtaildocs/multiple/add.html")
 
+        self.assertBreadcrumbsItemsRendered(
+            [
+                {
+                    "url": reverse("wagtaildocs:index"),
+                    "label": capfirst(self.doc._meta.verbose_name_plural),
+                },
+                {"url": "", "label": "Add documents"},
+            ],
+            response.content,
+        )
+
         # no collection chooser when only one collection exists
         self.assertNotContains(response, "id_adddocument_collection")
 
@@ -2041,7 +2081,7 @@ class TestUsageCount(WagtailTestUtils, TestCase):
         self.assertContains(response, "Used 0 times")
 
 
-class TestGetUsage(WagtailTestUtils, TestCase):
+class TestGetUsage(AdminTemplateTestUtils, WagtailTestUtils, TestCase):
     fixtures = ["test.json"]
 
     def setUp(self):
@@ -2075,6 +2115,24 @@ class TestGetUsage(WagtailTestUtils, TestCase):
         self.assertContains(response, "Christmas")
         self.assertContains(response, '<table class="listing">')
         self.assertContains(response, "<td>Event page</td>", html=True)
+        self.assertBreadcrumbsItemsRendered(
+            [
+                {
+                    "url": reverse("wagtaildocs:index"),
+                    "label": "Documents",
+                },
+                {
+                    "url": reverse("wagtaildocs:edit", args=(1,)),
+                    "label": "test document",
+                },
+                {
+                    "url": "",
+                    "label": "Usage",
+                    "sublabel": "test document",
+                },
+            ],
+            response.content,
+        )
 
     def test_usage_page_no_usage(self):
         response = self.client.get(reverse("wagtaildocs:document_usage", args=(1,)))

wagtail/documents/tests/test_site_summary.py

@@ -122,9 +122,9 @@ class TestDocumentsSummary(WagtailTestUtils, TestCase):
 
     def test_user_sees_proper_doc_count(self):
         cases = (
-            (self.superuser, "<span>3</span> Documents"),
-            (self.report_adder, "<span>2</span> Documents"),
-            (self.report_chooser, "<span>2</span> Documents"),
+            (self.superuser, "3 Documents"),
+            (self.report_adder, "2 Documents"),
+            (self.report_chooser, "2 Documents"),
         )
         for user, content in cases:
             with self.subTest(user=user):

wagtail/documents/views/documents.py

@@ -2,9 +2,7 @@ import os
 
 from django.contrib.admin.utils import quote
 from django.core.exceptions import PermissionDenied
-from django.shortcuts import get_object_or_404, redirect
-from django.template.response import TemplateResponse
-from django.urls import reverse
+from django.http.response import HttpResponse as HttpResponse
 from django.utils.functional import cached_property
 from django.utils.http import urlencode
 from django.utils.translation import gettext as _
@@ -78,7 +76,6 @@ class IndexView(generic.IndexView):
     model = get_document_model()
     add_item_label = gettext_lazy("Add a document")
     show_other_searches = True
-    _show_breadcrumbs = True
 
     def get_base_queryset(self):
         # Get documents (filtered by user permission)
@@ -157,117 +154,108 @@ class IndexView(generic.IndexView):
         return context
 
 
-@permission_checker.require("add")
-def add(request):
-    Document = get_document_model()
-    DocumentForm = get_document_form(Document)
+class CreateView(generic.CreateView):
+    permission_policy = permission_policy
+    index_url_name = "wagtaildocs:index"
+    add_url_name = "wagtaildocs:add"
+    edit_url_name = "wagtaildocs:edit"
+    error_message = gettext_lazy("The document could not be created due to errors.")
+    template_name = "wagtaildocs/documents/add.html"
+    header_icon = "doc-full-inverse"
+    _show_breadcrumbs = True
 
-    if request.method == "POST":
-        doc = Document(uploaded_by_user=request.user)
-        form = DocumentForm(
-            request.POST, request.FILES, instance=doc, user=request.user
-        )
-        if form.is_valid():
-            form.save()
-
-            messages.success(
-                request,
-                _("Document '%(document_title)s' added.")
-                % {"document_title": doc.title},
-                buttons=[
-                    messages.button(
-                        reverse("wagtaildocs:edit", args=(doc.id,)), _("Edit")
-                    )
-                ],
-            )
-            return redirect("wagtaildocs:index")
-        else:
-            messages.error(request, _("The document could not be saved due to errors."))
-    else:
-        form = DocumentForm(user=request.user)
-
-    return TemplateResponse(
-        request,
-        "wagtaildocs/documents/add.html",
-        {
-            "form": form,
-        },
-    )
-
-
-@permission_checker.require("change")
-def edit(request, document_id):
-    Document = get_document_model()
-    DocumentForm = get_document_form(Document)
-
-    doc = get_object_or_404(Document, id=document_id)
-
-    if not permission_policy.user_has_permission_for_instance(
-        request.user, "change", doc
-    ):
-        raise PermissionDenied
-
-    next_url = get_valid_next_url_from_request(request)
-
-    if request.method == "POST":
-        form = DocumentForm(
-            request.POST, request.FILES, instance=doc, user=request.user
-        )
-        if form.is_valid():
-            doc = form.save()
-
-            edit_url = reverse("wagtaildocs:edit", args=(doc.id,))
-            redirect_url = "wagtaildocs:index"
-            if next_url:
-                edit_url = f"{edit_url}?{urlencode({'next': next_url})}"
-                redirect_url = next_url
-
-            messages.success(
-                request,
-                _("Document '%(document_title)s' updated")
-                % {"document_title": doc.title},
-                buttons=[messages.button(edit_url, _("Edit"))],
-            )
-            return redirect(redirect_url)
-        else:
-            messages.error(request, _("The document could not be saved due to errors."))
-    else:
-        form = DocumentForm(instance=doc, user=request.user)
-
-    try:
-        local_path = doc.file.path
-    except NotImplementedError:
-        # Document is hosted externally (eg, S3)
-        local_path = None
-
-    if local_path:
-        # Give error if document file doesn't exist
-        if not os.path.isfile(local_path):
-            messages.error(
-                request,
-                _(
-                    "The file could not be found. Please change the source or delete the document"
-                ),
-                buttons=[
-                    messages.button(
-                        reverse("wagtaildocs:delete", args=(doc.id,)), _("Delete")
-                    )
-                ],
-            )
+    @cached_property
+    def model(self):
+        # Use a property instead of setting this as a class attribute so it is
+        # accessed at request-time, thus can be tested with override_settings
+        return get_document_model()
 
-    return TemplateResponse(
-        request,
-        "wagtaildocs/documents/edit.html",
-        {
-            "document": doc,
-            "filesize": doc.get_file_size(),
-            "form": form,
-            "user_can_delete": permission_policy.user_has_permission_for_instance(
-                request.user, "delete", doc
-            ),
-            "next": next_url,
-        },
-    )
+    def get_form_class(self):
+        return get_document_form(self.model)
+
+    def get_form_kwargs(self):
+        kwargs = super().get_form_kwargs()
+        kwargs["user"] = self.request.user
+        return kwargs
+
+    def get_initial_form_instance(self):
+        return self.model(uploaded_by_user=self.request.user)
+
+    def get_success_message(self, instance):
+        return _("Document '%(document_title)s' added.") % {
+            "document_title": instance.title
+        }
+
+
+class EditView(generic.EditView):
+    permission_policy = permission_policy
+    pk_url_kwarg = "document_id"
+    error_message = gettext_lazy("The document could not be saved due to errors.")
+    template_name = "wagtaildocs/documents/edit.html"
+    index_url_name = "wagtaildocs:index"
+    edit_url_name = "wagtaildocs:edit"
+    delete_url_name = "wagtaildocs:delete"
+    header_icon = "doc-full-inverse"
+    context_object_name = "document"
+    _show_breadcrumbs = True
+
+    @cached_property
+    def model(self):
+        return get_document_model()
+
+    def get_form_class(self):
+        return get_document_form(self.model)
+
+    def get_object(self, queryset=None):
+        obj = super().get_object(queryset)
+        if not self.permission_policy.user_has_permission_for_instance(
+            self.request.user, self.permission_required, obj
+        ):
+            raise PermissionDenied
+        return obj
+
+    def get_form_kwargs(self):
+        kwargs = super().get_form_kwargs()
+        kwargs["user"] = self.request.user
+        return kwargs
+
+    def get_success_message(self):
+        return _("Document '%(document_title)s' updated") % {
+            "document_title": self.object.title
+        }
+
+    @cached_property
+    def next_url(self):
+        return get_valid_next_url_from_request(self.request)
+
+    def get_success_url(self):
+        return self.next_url or super().get_success_url()
+
+    def get_delete_url(self):
+        delete_url = super().get_delete_url()
+        if self.next_url:
+            delete_url += "?" + urlencode({"next": self.next_url})
+        return delete_url
+
+    def render_to_response(self, context, **response_kwargs):
+        if self.object.is_stored_locally():
+            # Give error if document file doesn't exist
+            if not os.path.isfile(self.object.file.path):
+                messages.error(
+                    self.request,
+                    _(
+                        "The file could not be found. Please change the source or delete the document"
+                    ),
+                    buttons=[messages.button(self.get_delete_url(), _("Delete"))],
+                )
+
+        return super().render_to_response(context, **response_kwargs)
+
+    def get_context_data(self, **kwargs):
+        context = super().get_context_data(**kwargs)
+        context["filesize"] = self.object.get_file_size()
+        context["next"] = self.next_url
+        return context
 
 
 class DeleteView(generic.DeleteView):
@@ -308,6 +296,8 @@ class UsageView(generic.UsageView):
     permission_policy = permission_policy
     permission_required = "change"
     header_icon = "doc-full-inverse"
+    index_url_name = "wagtaildocs:index"
+    edit_url_name = "wagtaildocs:edit"
 
     def user_has_permission(self, permission):
         return self.permission_policy.user_has_permission_for_instance(

wagtail/documents/views/multiple.py

@@ -1,5 +1,10 @@
 import os.path
 
+from django.urls import reverse
+from django.utils.text import capfirst
+from django.utils.translation import gettext_lazy
+
+from wagtail.admin.views.generic.base import WagtailAdminTemplateMixin
 from wagtail.admin.views.generic.multiple_upload import AddView as BaseAddView
 from wagtail.admin.views.generic.multiple_upload import (
     CreateFromUploadView as BaseCreateFromUploadView,
@@ -15,10 +20,14 @@ from ..forms import get_document_form, get_document_multi_form
 from ..permissions import permission_policy
 
 
-class AddView(BaseAddView):
+class AddView(WagtailAdminTemplateMixin, BaseAddView):
     permission_policy = permission_policy
     template_name = "wagtaildocs/multiple/add.html"
+    header_icon = "doc-full-inverse"
+    page_title = gettext_lazy("Add documents")
+    _show_breadcrumbs = True
 
+    index_url_name = "wagtaildocs:index"
     edit_object_url_name = "wagtaildocs:edit_multiple"
     delete_object_url_name = "wagtaildocs:delete_multiple"
     edit_object_form_prefix = "doc"
@@ -31,6 +40,15 @@ class AddView(BaseAddView):
     context_upload_name = "uploaded_document"
     context_upload_id_name = "uploaded_file_id"
 
+    def get_breadcrumbs_items(self):
+        return self.breadcrumbs_items + [
+            {
+                "url": reverse(self.index_url_name),
+                "label": capfirst(self.model._meta.verbose_name_plural),
+            },
+            {"url": "", "label": self.get_page_title()},
+        ]
+
     def get_model(self):
         return get_document_model()
 

wagtail/embeds/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-08-07 10:06+0100\n"
+"POT-Creation-Date: 2024-10-21 17:53+0100\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"

wagtail/embeds/oembed_providers.py

@@ -88,6 +88,14 @@ coub = {
     ],
 }
 
+crowdsignal = {
+    "endpoint": "https://api.crowdsignal.com/oembed",
+    "urls": [
+        r"^https?://(?:[-\w]+\.)?polldaddy\.com/.+$",
+        r"^https?://poll.fm/\d+$",
+    ],
+}
+
 crowd_ranking = {
     "endpoint": "http://crowdranking.com/api/oembed.{format}",
     "urls": [
@@ -384,23 +392,6 @@ pinterest = {
 }
 
 
-polldaddy = {
-    "endpoint": "https://polldaddy.com/oembed/",
-    "urls": [
-        r"^https?://(?:[-\w]+\.)?polldaddy\.com/.+$",
-    ],
-}
-
-
-polleverywhere = {
-    "endpoint": "https://www.polleverywhere.com/services/oembed/",
-    "urls": [
-        r"^https?://www\.polleverywhere\.com/polls/.+$",
-        r"^https?://www\.polleverywhere\.com/multiple_choice_polls/.+$",
-        r"^https?://www\.polleverywhere\.com/free_text_polls/.+$",
-    ],
-}
-
 qik = {
     "endpoint": "http://qik.com/api/oembed.{format}",
     "urls": [
@@ -700,6 +691,7 @@ all_providers = [
     clikthrough,
     collegehumor,
     coub,
+    crowdsignal,
     crowd_ranking,
     dailymile,
     dailymotion,
@@ -736,8 +728,6 @@ all_providers = [
     opera,
     photobucket,
     pinterest,
-    polldaddy,
-    polleverywhere,
     qik,
     rdio,
     reddit,