wagtail 6.3.2__py3-none-any.whl → 6.4rc1__py3-none-any.whl

wagtail/contrib/redirects/views.py

@@ -1,9 +1,8 @@
 import os
 
-from django.core.exceptions import PermissionDenied, SuspiciousOperation
+from django.core.exceptions import SuspiciousOperation
 from django.db import transaction
-from django.shortcuts import get_object_or_404, redirect, render
-from django.template.response import TemplateResponse
+from django.shortcuts import redirect, render
 from django.urls import reverse
 from django.utils.encoding import force_str
 from django.utils.functional import cached_property
@@ -18,7 +17,6 @@ from wagtail.admin.ui.tables import Column, StatusTagColumn, TitleColumn
 from wagtail.admin.views import generic
 from wagtail.admin.widgets.button import Button
 from wagtail.contrib.frontend_cache.utils import PurgeBatch, purge_urls_from_cache
-from wagtail.contrib.redirects import models
 from wagtail.contrib.redirects.filters import RedirectsReportFilterSet
 from wagtail.contrib.redirects.forms import (
     ConfirmImportForm,
@@ -147,7 +145,6 @@ class EditView(generic.EditView):
     pk_url_kwarg = "redirect_id"
     error_message = gettext_lazy("The redirect could not be saved due to errors.")
     header_icon = "redirect"
-    _show_breadcrumbs = True
 
     def get_success_message(self):
         return _("Redirect '%(redirect_title)s' updated.") % {
@@ -169,80 +166,45 @@ class EditView(generic.EditView):
         return instance
 
 
-@permission_checker.require("delete")
-def delete(request, redirect_id):
-    theredirect = get_object_or_404(models.Redirect, id=redirect_id)
-
-    if not permission_policy.user_has_permission_for_instance(
-        request.user, "delete", theredirect
-    ):
-        raise PermissionDenied
-
-    if request.method == "POST":
-        with transaction.atomic():
-            log(instance=theredirect, action="wagtail.delete")
-            theredirect.delete()
+class DeleteView(generic.DeleteView):
+    model = Redirect
+    pk_url_kwarg = "redirect_id"
+    permission_policy = permission_policy
+    template_name = "wagtailredirects/confirm_delete.html"
+    index_url_name = "wagtailredirects:index"
+    delete_url_name = "wagtailredirects:delete"
+    header_icon = "redirect"
 
-        purge_urls_from_cache(theredirect.old_links())
+    def delete_action(self):
+        super().delete_action()
+        purge_urls_from_cache(self.object.old_links())
 
-        messages.success(
-            request,
-            _("Redirect '%(redirect_title)s' deleted.")
-            % {"redirect_title": theredirect.title},
-        )
-        return redirect("wagtailredirects:index")
+    def get_success_message(self):
+        return _("Redirect '%(redirect_title)s' deleted.") % {
+            "redirect_title": self.object.title
+        }
 
-    return TemplateResponse(
-        request,
-        "wagtailredirects/confirm_delete.html",
-        {
-            "redirect": theredirect,
-        },
-    )
 
+class CreateView(generic.CreateView):
+    model = Redirect
+    form_class = RedirectForm
+    permission_policy = permission_policy
+    template_name = "wagtailredirects/add.html"
+    add_url_name = "wagtailredirects:add"
+    index_url_name = "wagtailredirects:index"
+    edit_url_name = "wagtailredirects:edit"
+    error_message = gettext_lazy("The redirect could not be created due to errors.")
+    header_icon = "redirect"
 
-@permission_checker.require("add")
-def add(request):
-    if request.method == "POST":
-        form = RedirectForm(request.POST, request.FILES)
-        if form.is_valid():
-            with transaction.atomic():
-                theredirect = form.save()
-                log(instance=theredirect, action="wagtail.create")
-
-            purge_urls_from_cache(theredirect.old_links())
-
-            messages.success(
-                request,
-                _("Redirect '%(redirect_title)s' added.")
-                % {"redirect_title": theredirect.title},
-                buttons=[
-                    messages.button(
-                        reverse("wagtailredirects:edit", args=(theredirect.id,)),
-                        _("Edit"),
-                    )
-                ],
-            )
-            return redirect("wagtailredirects:index")
-        else:
-            messages.error(
-                request, _("The redirect could not be created due to errors.")
-            )
-    else:
-        form = RedirectForm()
+    def get_success_message(self, instance):
+        return _("Redirect '%(redirect_title)s' added.") % {
+            "redirect_title": instance.title
+        }
 
-    return TemplateResponse(
-        request,
-        "wagtailredirects/add.html",
-        {
-            "form": form,
-            # Remove these when this view is refactored to a generic.CreateView subclass.
-            # Avoid defining new translatable strings.
-            "submit_button_label": generic.CreateView.submit_button_label,
-            "submit_button_active_label": generic.CreateView.submit_button_active_label,
-            "media": form.media,
-        },
-    )
+    def save_instance(self):
+        instance = super().save_instance()
+        purge_urls_from_cache(instance.old_links())
+        return instance
 
 
 @permission_checker.require_any("add")

wagtail/contrib/search_promotions/admin_urls.py

@@ -1,18 +1,25 @@
 from django.urls import path
 
 from wagtail.contrib.search_promotions import views
+from wagtail.contrib.search_promotions.views.reports import SearchTermsReportView
 
 app_name = "wagtailsearchpromotions"
 urlpatterns = [
     path("", views.IndexView.as_view(), name="index"),
     path("results/", views.IndexView.as_view(results_only=True), name="index_results"),
-    path("add/", views.add, name="add"),
-    path("<int:query_id>/", views.edit, name="edit"),
-    path("<int:query_id>/delete/", views.delete, name="delete"),
+    path("add/", views.CreateView.as_view(), name="add"),
+    path("<int:query_id>/", views.EditView.as_view(), name="edit"),
+    path("<int:query_id>/delete/", views.DeleteView.as_view(), name="delete"),
     path("queries/chooser/", views.chooser, name="chooser"),
     path(
         "queries/chooser/results/",
         views.chooserresults,
         name="chooserresults",
     ),
+    path("reports/search-terms/", SearchTermsReportView.as_view(), name="search_terms"),
+    path(
+        "reports/search-terms/results/",
+        SearchTermsReportView.as_view(results_only=True),
+        name="search_terms_results",
+    ),
 ]

wagtail/contrib/search_promotions/forms.py

@@ -6,7 +6,7 @@ from wagtail.admin.widgets import AdminPageChooser
 from wagtail.contrib.search_promotions.models import Query, SearchPromotion
 
 
-class QueryForm(forms.Form):
+class QueryForm(forms.ModelForm):
     query_string = forms.CharField(
         label=_("Search term(s)/phrase"),
         help_text=_(
@@ -17,6 +17,17 @@ class QueryForm(forms.Form):
         required=True,
     )
 
+    def clean(self):
+        # We allow using an existing query string on the CreateView, so we need
+        # to skip the unique validation on `query_string`. This can be done by
+        # overriding the `clean()` method without calling `super().clean()`:
+        # https://docs.djangoproject.com/en/stable/topics/forms/modelforms/#overriding-the-clean-method
+        pass
+
+    class Meta:
+        model = Query
+        fields = ["query_string"]
+
 
 class SearchPromotionForm(forms.ModelForm):
     sort_order = forms.IntegerField(required=False)
@@ -25,6 +36,49 @@ class SearchPromotionForm(forms.ModelForm):
         super().__init__(*args, **kwargs)
         self.fields["page"].widget = AdminPageChooser()
 
+    def clean(self):
+        cleaned_data = super().clean()
+
+        # Use the raw value instead of from form.cleaned_data so we don't
+        # consider an invalid field as empty. For example, leaving the
+        # page field empty and entering an invalid external_link_url
+        # shouldn't raise an error about needing to enter a page or URL,
+        # since the user *has* entered (or tried to enter) a URL.
+        page = self["page"].value()
+        external_link_url = self["external_link_url"].value()
+        external_link_text = self["external_link_text"].value()
+
+        # Must supply a page or external_link_url (but not both)
+        if page is None:
+            if external_link_url:
+                # if an external_link_url is supplied,
+                # then external_link_text is also required
+                if not external_link_text:
+                    self.add_error(
+                        "external_link_text",
+                        forms.ValidationError(
+                            _(
+                                "You must enter an external link text if you enter an external link URL."
+                            )
+                        ),
+                    )
+            else:
+                self.add_error(
+                    None,
+                    forms.ValidationError(
+                        _("You must recommend a page OR an external link.")
+                    ),
+                )
+        elif external_link_url:
+            self.add_error(
+                None,
+                forms.ValidationError(
+                    _("Please only select a page OR enter an external link.")
+                ),
+            )
+
+        return cleaned_data
+
     class Meta:
         model = SearchPromotion
         fields = (
@@ -73,31 +127,6 @@ class SearchPromotionsFormSet(SearchPromotionsFormSetBase):
         non_empty_forms = 0
         for i in range(0, self.total_form_count()):
             form = self.forms[i]
-
-            page = form.cleaned_data["page"]
-            external_link_url = form.cleaned_data["external_link_url"]
-            external_link_text = form.cleaned_data["external_link_text"]
-
-            # only a page or external_link_url can be supplied
-            if page is None:
-                if external_link_url:
-                    # if an external_link_url then external_link_text is also required
-                    if not external_link_text:
-                        raise forms.ValidationError(
-                            _(
-                                "You must enter an external link text if you enter an external link URL."
-                            )
-                        )
-                else:
-                    raise forms.ValidationError(
-                        _("You must recommend a page OR an external link.")
-                    )
-            else:
-                if external_link_url:
-                    raise forms.ValidationError(
-                        _("Please only select a page OR enter an external link.")
-                    )
-
             if self.can_delete and self._should_delete_form(form):
                 non_deleted_forms -= 1
             if not (form.instance.id is None and not form.has_changed()):

wagtail/contrib/search_promotions/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-10-21 17:53+0100\n"
+"POT-Creation-Date: 2025-01-20 17:59+0000\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"
@@ -32,22 +32,22 @@ msgid ""
 "Promoted Results to be displayed, wildcards are NOT allowed."
 msgstr ""
 
-#: forms.py:56
-msgid "Please specify at least one recommendation for this search term."
-msgstr ""
-
-#: forms.py:88
+#: forms.py:61
 msgid "You must enter an external link text if you enter an external link URL."
 msgstr ""
 
-#: forms.py:93
+#: forms.py:69
 msgid "You must recommend a page OR an external link."
 msgstr ""
 
-#: forms.py:98
+#: forms.py:76
 msgid "Please only select a page OR enter an external link."
 msgstr ""
 
+#: forms.py:110
+msgid "Please specify at least one recommendation for this search term."
+msgstr ""
+
 #: models.py:92 models.py:93
 msgid "Query Daily Hits"
 msgstr ""
@@ -80,15 +80,7 @@ msgstr ""
 msgid "search promotion"
 msgstr ""
 
-#: templates/wagtailsearchpromotions/add.html:3
-msgid "Add search promotion"
-msgstr ""
-
-#: templates/wagtailsearchpromotions/add.html:5
-msgid "Add search pick"
-msgstr ""
-
-#: templates/wagtailsearchpromotions/add.html:11
+#: templates/wagtailsearchpromotions/add.html:7
 msgid ""
 "<p>Promoted search results are a means of recommending specific pages or "
 "external links that might not organically come high up in search results. E."
@@ -96,7 +88,7 @@ msgid ""
 "common term \"<em>giving</em>\".</p>"
 msgstr ""
 
-#: templates/wagtailsearchpromotions/add.html:15
+#: templates/wagtailsearchpromotions/add.html:11
 msgid ""
 "<p>The \"Search term(s)/phrase\" field below must contain the full and exact "
 "search for which you wish to provide recommended results, <em>including</em> "
@@ -110,28 +102,10 @@ msgid "Delete %(query)s"
 msgstr ""
 
 #: templates/wagtailsearchpromotions/confirm_delete.html:5
-#: templates/wagtailsearchpromotions/includes/searchpromotion_form.html:10
-msgid "Delete"
-msgstr ""
-
-#: templates/wagtailsearchpromotions/confirm_delete.html:9
 msgid ""
 "Are you sure you want to delete all promoted results for this search term?"
 msgstr ""
 
-#: templates/wagtailsearchpromotions/confirm_delete.html:12
-msgid "Yes, delete"
-msgstr ""
-
-#: templates/wagtailsearchpromotions/edit.html:3
-#, python-format
-msgid "Editing %(query)s"
-msgstr ""
-
-#: templates/wagtailsearchpromotions/edit.html:5
-msgid "Editing"
-msgstr ""
-
 #: templates/wagtailsearchpromotions/includes/searchpromotion_form.html:8
 msgid "Move up"
 msgstr ""
@@ -140,12 +114,20 @@ msgstr ""
 msgid "Move down"
 msgstr ""
 
-#: templates/wagtailsearchpromotions/includes/searchpromotion_form.html:13
+#: templates/wagtailsearchpromotions/includes/searchpromotion_form.html:10
+msgid "Drag"
+msgstr ""
+
+#: templates/wagtailsearchpromotions/includes/searchpromotion_form.html:11
+msgid "Delete"
+msgstr ""
+
+#: templates/wagtailsearchpromotions/includes/searchpromotion_form.html:14
 msgid "Recommended search result"
 msgstr ""
 
 #: templates/wagtailsearchpromotions/includes/searchpromotions_formset.html:4
-#: views.py:81 wagtail_hooks.py:36
+#: views/settings.py:31 wagtail_hooks.py:36
 msgid "Promoted search results"
 msgstr ""
 
@@ -184,7 +166,7 @@ msgid "Terms"
 msgstr ""
 
 #: templates/wagtailsearchpromotions/queries/chooser/results.html:10
-#: views.py:58
+#: views/settings.py:56
 msgid "Views (past week)"
 msgstr ""
 
@@ -204,44 +186,52 @@ msgstr ""
 msgid "None"
 msgstr ""
 
-#: views.py:33
-msgid "Search Terms"
+#: views/reports.py:13
+msgid "Date"
 msgstr ""
 
-#: views.py:42
-msgid "Add new promoted result"
+#: views/reports.py:24 wagtail_hooks.py:47
+msgid "Search terms"
 msgstr ""
 
-#: views.py:46
+#: views/reports.py:33 views/reports.py:37 views/settings.py:44
 msgid "Search term(s)"
 msgstr ""
 
-#: views.py:53
+#: views/reports.py:34 views/reports.py:38
+msgid "Views"
+msgstr ""
+
+#: views/settings.py:40
+msgid "Add new promoted result"
+msgstr ""
+
+#: views/settings.py:51
 msgid "Promoted results"
 msgstr ""
 
-#: views.py:144
-#, python-format
-msgid "Editor's picks for '%(query)s' created."
+#: views/settings.py:91
+msgid "Promoted search result"
 msgstr ""
 
-#: views.py:148 views.py:212
-msgid "Edit"
+#: views/settings.py:180
+#, python-format
+msgid "Editor's picks for '%(query)s' created."
 msgstr ""
 
-#: views.py:166
+#: views/settings.py:181
 msgid "Recommendations have not been created due to errors"
 msgstr ""
 
-#: views.py:208
+#: views/settings.py:190
 #, python-format
 msgid "Editor's picks for '%(query)s' updated."
 msgstr ""
 
-#: views.py:228
+#: views/settings.py:191
 msgid "Recommendations have not been saved due to errors"
 msgstr ""
 
-#: views.py:267
+#: views/settings.py:200
 msgid "Editor's picks deleted."
 msgstr ""

wagtail/contrib/search_promotions/templates/wagtailsearchpromotions/add.html

@@ -1,40 +1,30 @@
 {% extends "wagtailadmin/generic/form.html" %}
 {% load i18n wagtailadmin_tags %}
-{% block titletag %}{% trans "Add search promotion" %}{% endblock %}
-{% block content %}
-    {% trans "Add search pick" as add_str %}
-    {% include "wagtailadmin/shared/header.html" with title=add_str icon="pick" %}
 
-    <div class="nice-padding">
-        <div class="help-block help-info">
-            {% icon name='help' %}
-            {% blocktrans trimmed %}
-                <p>Promoted search results are a means of recommending specific pages or external links that might not organically come high up in search results. E.g recommending your primary donation page to a user searching with the less common term "<em>giving</em>".</p>
-            {% endblocktrans %}
+{% block before_form %}
+    <div class="help-block help-info w-form-width">
+        {% icon name='help' %}
+        {% blocktrans trimmed %}
+            <p>Promoted search results are a means of recommending specific pages or external links that might not organically come high up in search results. E.g recommending your primary donation page to a user searching with the less common term "<em>giving</em>".</p>
+        {% endblocktrans %}
 
-            {% blocktrans trimmed %}
-                <p>The "Search term(s)/phrase" field below must contain the full and exact search for which you wish to provide recommended results, <em>including</em> any misspellings/user error. To help, you can choose from search terms that have been popular with users of your site.</p>
-            {% endblocktrans %}
-        </div>
-        <form action="{% url 'wagtailsearchpromotions:add' %}" method="POST" novalidate>
-            {% csrf_token %}
-
-            <ul class="fields">
-                <li>
-                    {% include "wagtailsearchpromotions/queries/chooser_field.html" with field=query_form.query_string only %}
-                </li>
-                <li>
-                    {% include "wagtailsearchpromotions/includes/searchpromotions_formset.html" with formset=searchpicks_formset only %}
-                </li>
-            </ul>
-
-            {% block footer %}
-                {{ block.super }}
-            {% endblock %}
-        </form>
+        {% blocktrans trimmed %}
+            <p>The "Search term(s)/phrase" field below must contain the full and exact search for which you wish to provide recommended results, <em>including</em> any misspellings/user error. To help, you can choose from search terms that have been popular with users of your site.</p>
+        {% endblocktrans %}
     </div>
 {% endblock %}
 
+{% block form_content %}
+    <ul class="fields">
+        <li>
+            {% include "wagtailsearchpromotions/queries/chooser_field.html" with field=form.query_string only %}
+        </li>
+        <li>
+            {% include "wagtailsearchpromotions/includes/searchpromotions_formset.html" with formset=searchpicks_formset only %}
+        </li>
+    </ul>
+{% endblock %}
+
 {% block extra_js %}
     {{ block.super }}
     <script src="{% versioned_static 'wagtailsearchpromotions/js/query-chooser-modal.js' %}"></script>
@@ -44,7 +34,7 @@
         {% include "wagtailsearchpromotions/queries/chooser_field.js" only %}
 
         $(function() {
-            createQueryChooser('{{ query_form.query_string.auto_id }}');
+            createQueryChooser('{{ form.query_string.auto_id }}');
         });
     </script>
 {% endblock %}

wagtail/contrib/search_promotions/templates/wagtailsearchpromotions/confirm_delete.html

@@ -1,15 +1,6 @@
-{% extends "wagtailadmin/base.html" %}
+{% extends "wagtailadmin/generic/confirm_delete.html" %}
 {% load i18n %}
 {% block titletag %}{% blocktrans trimmed with query=query.query_string %}Delete {{ query }}{% endblocktrans %}{% endblock %}
-{% block content %}
-    {% trans "Delete" as delete_str %}
-    {% include "wagtailadmin/shared/header.html" with title=delete_str subtitle=query.query_string %}
-
-    <div class="nice-padding">
-        <p>{% trans "Are you sure you want to delete all promoted results for this search term?" %}</p>
-        <form action="{% url 'wagtailsearchpromotions:delete' query.id %}" method="POST">
-            {% csrf_token %}
-            <input type="submit" value="{% trans 'Yes, delete' %}" class="button serious" />
-        </form>
-    </div>
+{% block confirmation_message %}
+    <p>{% trans "Are you sure you want to delete all promoted results for this search term?" %}</p>
 {% endblock %}

wagtail/contrib/search_promotions/templates/wagtailsearchpromotions/edit.html

@@ -1,37 +1,14 @@
-{% extends "wagtailadmin/generic/form.html" %}
+{% extends "wagtailadmin/generic/edit.html" %}
 {% load i18n wagtailadmin_tags %}
-{% block titletag %}{% blocktrans trimmed with query=query.query_string %}Editing {{ query }}{% endblocktrans %}{% endblock %}
-{% block content %}
-    {% trans "Editing" as editing_str %}
-    {% include "wagtailadmin/shared/header.html" with title=editing_str subtitle=query.query_string icon="pick"  %}
-
-    <form action="{% url 'wagtailsearchpromotions:edit' query.id %}" method="POST" class="nice-padding" novalidate>
-        {% csrf_token %}
-
-        <ul class="fields">
-            <li>
-                {% include "wagtailsearchpromotions/queries/chooser_field.html" with field=query_form.query_string only %}
-            </li>
-            <li>
-                {% include "wagtailsearchpromotions/includes/searchpromotions_formset.html" with formset=searchpicks_formset only %}
-            </li>
-        </ul>
-
-        {% block footer %}
-            {{ block.super }}
-        {% endblock %}
-    </form>
-{% endblock %}
-
-{% block extra_actions %}
-    {% comment %}
-        The view hasn't extended from generic EditView, so we cannot use the new
-        header buttons in the breadcrumbs for the Delete button. Instead, we'll
-        add a Delete button to the footer actions.
-    {% endcomment %}
-    {% if can_delete %}
-        <a href="{{ delete_url }}" class="button">{{ delete_item_label }}</a>
-    {% endif %}
+{% block form_content %}
+    <ul class="fields">
+        <li>
+            {% include "wagtailsearchpromotions/queries/chooser_field.html" with field=form.query_string only %}
+        </li>
+        <li>
+            {% include "wagtailsearchpromotions/includes/searchpromotions_formset.html" with formset=searchpicks_formset only %}
+        </li>
+    </ul>
 {% endblock %}
 
 {% block extra_js %}
@@ -43,7 +20,7 @@
         {% include "wagtailsearchpromotions/queries/chooser_field.js" only %}
 
         $(function() {
-            createQueryChooser('{{ query_form.query_string.auto_id }}');
+            createQueryChooser('{{ form.query_string.auto_id }}');
         });
     </script>
 {% endblock %}

wagtail/contrib/search_promotions/templates/wagtailsearchpromotions/includes/searchpromotion_form.html

@@ -7,6 +7,7 @@
     {% fragment as header_controls %}
         <button type="button" class="button button--icon text-replace" data-inline-panel-child-move-up>{% icon name="arrow-up" %}{% trans "Move up" %}</button>
         <button type="button" class="button button--icon text-replace" data-inline-panel-child-move-down>{% icon name="arrow-down" %}{% trans "Move down" %}</button>
+        <button type="button" class="button button--icon text-replace" data-inline-panel-child-drag>{% icon name="grip" %}{% trans "Drag" %}</button>
         <button type="button" class="button button--icon text-replace" id="{{ form.DELETE.id_for_label }}-button">{% icon name="bin" %}{% trans "Delete" %}</button>
     {% endfragment %}
 

wagtail/contrib/search_promotions/templates/wagtailsearchpromotions/includes/searchpromotions_formset.js

@@ -1,5 +1,6 @@
+/* global InlinePanel */
+
 $(function () {
-  // eslint-disable-next-line no-undef
   var panel = new InlinePanel({
     formsetPrefix: 'id_{{ formset.prefix }}',
     emptyChildFormPrefix: '{{ formset.empty_form.prefix }}',

wagtail/contrib/search_promotions/templates/wagtailsearchpromotions/index.html

@@ -1,2 +1 @@
 {% extends "wagtailadmin/generic/index.html" %}
-{% load i18n %}