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

wagtail/contrib/redirects/views.py

@@ -1,23 +1,23 @@
 import os
 
 from django.core.exceptions import PermissionDenied, SuspiciousOperation
-from django.core.paginator import InvalidPage, Paginator
 from django.db import transaction
-from django.db.models import Q
-from django.http import Http404
 from django.shortcuts import get_object_or_404, redirect, render
 from django.template.response import TemplateResponse
 from django.urls import reverse
 from django.utils.encoding import force_str
+from django.utils.functional import cached_property
 from django.utils.translation import gettext as _
-from django.utils.translation import ngettext
+from django.utils.translation import gettext_lazy, ngettext
 from django.views.decorators.http import require_http_methods
-from django.views.decorators.vary import vary_on_headers
 
 from wagtail.admin import messages
 from wagtail.admin.auth import PermissionPolicyChecker
 from wagtail.admin.forms.search import SearchForm
+from wagtail.admin.ui.tables import Column, StatusTagColumn, TitleColumn
+from wagtail.admin.views import generic
 from wagtail.admin.views.reports import ReportView
+from wagtail.admin.widgets.button import Button
 from wagtail.contrib.redirects import models
 from wagtail.contrib.redirects.filters import RedirectsReportFilterSet
 from wagtail.contrib.redirects.forms import (
@@ -26,6 +26,7 @@ from wagtail.contrib.redirects.forms import (
     ImportForm,
     RedirectForm,
 )
+from wagtail.contrib.redirects.models import Redirect
 from wagtail.contrib.redirects.permissions import permission_policy
 from wagtail.contrib.redirects.utils import (
     get_file_storage,
@@ -39,62 +40,91 @@ from wagtail.log_actions import log
 permission_checker = PermissionPolicyChecker(permission_policy)
 
 
-@permission_checker.require_any("add", "change", "delete")
-@vary_on_headers("X-Requested-With")
-def index(request):
-    query_string = request.GET.get("q", "")
-    ordering = request.GET.get("ordering", "old_path")
+class RedirectTargetColumn(Column):
+    cell_template_name = "wagtailredirects/redirect_target_cell.html"
+    url_name = "wagtailadmin_pages:edit"
 
-    redirects = models.Redirect.objects.prefetch_related("redirect_page", "site")
+    def get_value(self, instance):
+        if instance.redirect_page:
+            return instance.redirect_page.get_admin_display_title()
+        return instance.redirect_link
 
-    # Search
-    if query_string:
-        redirects = redirects.filter(
-            Q(old_path__icontains=query_string)
-            | Q(redirect_page__url_path__icontains=query_string)
-            | Q(redirect_link__icontains=query_string)
-        )
+    def get_url(self, instance):
+        if instance.redirect_page:
+            return reverse(self.url_name, args=[instance.redirect_page_id])
+        return None
 
-    # Ordering (A bit useless at the moment as only 'old_path' is allowed)
-    if ordering not in ["old_path"]:
-        ordering = "old_path"
+    def get_cell_context_data(self, instance, parent_context):
+        context = super().get_cell_context_data(instance, parent_context)
+        context["url"] = self.get_url(instance)
+        return context
 
-    redirects = redirects.order_by(ordering)
 
-    # Pagination
-    paginator = Paginator(redirects, per_page=20)
-    try:
-        redirects = paginator.page(request.GET.get("p", 1))
-    except InvalidPage:
-        raise Http404
+class IndexView(generic.IndexView):
+    template_name = "wagtailredirects/index.html"
+    results_template_name = "wagtailredirects/index_results.html"
+    permission_policy = permission_policy
+    model = Redirect
+    header_icon = "redirect"
+    add_item_label = gettext_lazy("Add redirect")
+    context_object_name = "redirects"
+    index_url_name = "wagtailredirects:index"
+    index_results_url_name = "wagtailredirects:index_results"
+    add_url_name = "wagtailredirects:add"
+    edit_url_name = "wagtailredirects:edit"
+    delete_url_name = "wagtailredirects:delete"
+    default_ordering = "old_path"
+    paginate_by = 20
+    page_title = gettext_lazy("Redirects")
+    search_fields = ["old_path", "redirect_page__url_path", "redirect_link"]
+    _show_breadcrumbs = True
+    columns = [
+        TitleColumn(
+            "old_path",
+            label=gettext_lazy("From"),
+            url_name="wagtailredirects:edit",
+            sort_key="old_path",
+        ),
+        Column(
+            "site",
+            label=gettext_lazy("Site"),
+            width="25%",
+            sort_key="site__site_name",
+        ),
+        RedirectTargetColumn(
+            "redirect_page",
+            label=gettext_lazy("To"),
+            width="30%",
+        ),
+        StatusTagColumn(
+            "is_permanent",
+            accessor="get_is_permanent_display",
+            label=gettext_lazy("Type"),
+            width="10%",
+            sort_key="is_permanent",
+            primary=lambda r: r.is_permanent,
+        ),
+    ]
 
-    # Render template
-    if request.headers.get("x-requested-with") == "XMLHttpRequest":
-        return TemplateResponse(
-            request,
-            "wagtailredirects/results.html",
-            {
-                "ordering": ordering,
-                "redirects": redirects,
-                "query_string": query_string,
-            },
-        )
-    else:
-        return TemplateResponse(
-            request,
-            "wagtailredirects/index.html",
-            {
-                "ordering": ordering,
-                "redirects": redirects,
-                "query_string": query_string,
-                "search_form": SearchForm(
-                    data={"q": query_string} if query_string else None,
-                ),
-                "user_can_add": permission_policy.user_has_permission(
-                    request.user, "add"
-                ),
-            },
-        )
+    def get_base_queryset(self):
+        return super().get_base_queryset().select_related("redirect_page", "site")
+
+    @cached_property
+    def header_more_buttons(self):
+        return [
+            Button(
+                _("Import redirects"),
+                url=reverse("wagtailredirects:start_import"),
+                icon_name="doc-full-inverse",
+                priority=90,
+            ),
+            Button(
+                _("Export redirects"),
+                url=reverse("wagtailredirects:report"),
+                icon_name="download",
+                priority=100,
+            ),
+        ]
 
 
 @permission_checker.require("change")

wagtail/contrib/search_promotions/admin_urls.py

@@ -4,7 +4,8 @@ from wagtail.contrib.search_promotions import views
 
 app_name = "wagtailsearchpromotions"
 urlpatterns = [
-    path("", views.index, name="index"),
+    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"),

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-01-24 13:51+0000\n"
+"POT-Creation-Date: 2024-04-18 17:28+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"
@@ -151,7 +151,7 @@ msgid "Recommended search result"
 msgstr ""
 
 #: templates/wagtailsearchpromotions/includes/searchpromotions_formset.html:4
-#: templates/wagtailsearchpromotions/index.html:6 wagtail_hooks.py:36
+#: views.py:82 wagtail_hooks.py:36
 msgid "Promoted search results"
 msgstr ""
 
@@ -159,118 +159,95 @@ msgstr ""
 msgid "Add a recommended result"
 msgstr ""
 
-#: templates/wagtailsearchpromotions/index.html:3
-msgid "Search Terms"
+#: templates/wagtailsearchpromotions/index_results.html:5
+#: templates/wagtailsearchpromotions/results.html:5
+#, python-format
+msgid "Sorry, no promoted results match \"<em>%(query_string)s</em>\""
 msgstr ""
 
-#: templates/wagtailsearchpromotions/index.html:7
-msgid "Add new promoted result"
+#: templates/wagtailsearchpromotions/index_results.html:7
+#: templates/wagtailsearchpromotions/results.html:8
+#, python-format
+msgid ""
+"No promoted results have been created. Why not <a "
+"href=\"%(wagtailsearchpromotions_add_url)s\">add one</a>?"
 msgstr ""
 
-#: templates/wagtailsearchpromotions/list.html:9
-msgid "Search term(s)"
+#: templates/wagtailsearchpromotions/index_results.html:9
+msgid "No promoted results have been created."
 msgstr ""
 
-#: templates/wagtailsearchpromotions/list.html:11
-#: templates/wagtailsearchpromotions/list.html:13
-msgid "Order by search term alphabetically"
+#: templates/wagtailsearchpromotions/queries/chooser/chooser.html:2
+msgid "Popular search terms"
 msgstr ""
 
-#: templates/wagtailsearchpromotions/list.html:11
-msgid "Order by search term reverse alphabetically"
+#: templates/wagtailsearchpromotions/queries/chooser/chooser.html:11
+msgid "Search"
 msgstr ""
 
-#: templates/wagtailsearchpromotions/list.html:16
-msgid "Promoted results"
+#: templates/wagtailsearchpromotions/queries/chooser/results.html:9
+msgid "Terms"
 msgstr ""
 
-#: templates/wagtailsearchpromotions/list.html:18
 #: templates/wagtailsearchpromotions/queries/chooser/results.html:10
+#: views.py:59
 msgid "Views (past week)"
 msgstr ""
 
-#: templates/wagtailsearchpromotions/list.html:20
-#: templates/wagtailsearchpromotions/list.html:22
-msgid "Order by views (lowest first)"
-msgstr ""
-
-#: templates/wagtailsearchpromotions/list.html:20
-msgid "Order by views (highest first)"
+#: templates/wagtailsearchpromotions/queries/chooser/results.html:24
+msgid "No results found"
 msgstr ""
 
-#: templates/wagtailsearchpromotions/list.html:31
-msgid "Edit this promotion"
+#: templates/wagtailsearchpromotions/queries/chooser_field.html:7
+msgid "Choose from popular search terms"
 msgstr ""
 
-#: templates/wagtailsearchpromotions/list.html:39
+#: templates/wagtailsearchpromotions/search_promotion_column.html:8
 msgid "External link"
 msgstr ""
 
-#: templates/wagtailsearchpromotions/list.html:44
+#: templates/wagtailsearchpromotions/search_promotion_column.html:13
 msgid "None"
 msgstr ""
 
-#: templates/wagtailsearchpromotions/queries/chooser/chooser.html:2
-msgid "Popular search terms"
-msgstr ""
-
-#: templates/wagtailsearchpromotions/queries/chooser/chooser.html:11
-msgid "Search"
-msgstr ""
-
-#: templates/wagtailsearchpromotions/queries/chooser/results.html:9
-msgid "Terms"
-msgstr ""
-
-#: templates/wagtailsearchpromotions/queries/chooser/results.html:24
-msgid "No results found"
+#: views.py:33
+msgid "Search Terms"
 msgstr ""
 
-#: templates/wagtailsearchpromotions/queries/chooser_field.html:7
-msgid "Choose from popular search terms"
+#: views.py:43
+msgid "Add new promoted result"
 msgstr ""
 
-#: templates/wagtailsearchpromotions/results.html:5
-#, python-format
-msgid "There is %(counter)s match"
-msgid_plural "There are %(counter)s matches"
-msgstr[0] ""
-msgstr[1] ""
-
-#: templates/wagtailsearchpromotions/results.html:18
-#, python-format
-msgid "Sorry, no promoted results match \"<em>%(query_string)s</em>\""
+#: views.py:47
+msgid "Search term(s)"
 msgstr ""
 
-#: templates/wagtailsearchpromotions/results.html:21
-#, python-format
-msgid ""
-"No promoted results have been created. Why not <a "
-"href=\"%(wagtailsearchpromotions_add_url)s\">add one</a>?"
+#: views.py:54
+msgid "Promoted results"
 msgstr ""
 
-#: views.py:144
+#: views.py:145
 #, python-format
 msgid "Editor's picks for '%(query)s' created."
 msgstr ""
 
-#: views.py:148 views.py:208
+#: views.py:149 views.py:209
 msgid "Edit"
 msgstr ""
 
-#: views.py:166
+#: views.py:167
 msgid "Recommendations have not been created due to errors"
 msgstr ""
 
-#: views.py:204
+#: views.py:205
 #, python-format
 msgid "Editor's picks for '%(query)s' updated."
 msgstr ""
 
-#: views.py:224
+#: views.py:225
 msgid "Recommendations have not been saved due to errors"
 msgstr ""
 
-#: views.py:254
+#: views.py:255
 msgid "Editor's picks deleted."
 msgstr ""

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

@@ -1,17 +1,2 @@
-{% extends "wagtailadmin/base.html" %}
+{% extends "wagtailadmin/generic/index.html" %}
 {% load i18n %}
-{% block titletag %}{% trans "Search Terms" %}{% endblock %}
-
-{% block content %}
-    {% trans "Promoted search results" as sp_title_str %}
-    {% trans "Add new promoted result" as sp_text_str %}
-    {% url 'wagtailsearchpromotions:index' as search_results_url %}
-    {% url "wagtailsearchpromotions:add" as add_link %}
-    {% include "wagtailadmin/shared/header.html" with title=sp_title_str action_url=add_link icon="pick" action_text=sp_text_str search_url="wagtailsearchpromotions:index" search_results_url=search_results_url search_target="#editorspicks-results" %}
-
-    <div class="nice-padding">
-        <div id="editorspicks-results" class="redirects">
-            {% include "wagtailsearchpromotions/results.html" %}
-        </div>
-    </div>
-{% endblock %}

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

@@ -0,0 +1,11 @@
+{% extends "wagtailadmin/generic/index_results.html" %}
+{% load i18n %}
+{% block no_results_message %}
+    {% if is_searching %}
+        <p role="alert">{% blocktrans trimmed %}Sorry, no promoted results match "<em>{{ query_string }}</em>"{% endblocktrans %}</p>
+    {% elif add_url %}
+        <p>{% blocktrans trimmed with wagtailsearchpromotions_add_url=add_url %}No promoted results have been created. Why not <a href="{{ wagtailsearchpromotions_add_url }}">add one</a>?{% endblocktrans %}</p>
+    {% else %}
+        <p>{% blocktrans trimmed %}No promoted results have been created.{% endblocktrans %}</p>
+    {% endif %}
+{% endblock %}

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

@@ -1,51 +0,0 @@
-{% load i18n wagtailadmin_tags %}
-<table class="listing">
-    <col width="40%" />
-    <col width="40%"/>
-    <col />
-    <thead>
-        <tr>
-            <th class="title">
-                {% trans "Search term(s)" %}
-                {% if "query_string" in ordering %}
-                    <a href="{% url 'wagtailsearchpromotions:index' %}?ordering={% if '-' not in ordering %}-{% endif %}query_string" class="icon icon-arrow-{% if '-' in ordering %}up{% else %}down{% endif %}-after teal" aria-label="{% if '-' in ordering %}{% trans 'Order by search term alphabetically' %}{% else %}{% trans 'Order by search term reverse alphabetically' %}{% endif %}"></a>
-                {% else %}
-                    <a href="{% url 'wagtailsearchpromotions:index' %}?ordering=query_string" class="icon icon-arrow-down-after" aria-label="{% trans 'Order by search term alphabetically' %}"></a>
-                {% endif %}
-            </th>
-            <th>{% trans "Promoted results" %}</th>
-            <th>
-                {% trans "Views (past week)" %}
-                {% if "views" in ordering %}
-                    <a href="{% url 'wagtailsearchpromotions:index' %}?ordering={% if '-' not in ordering %}-{% endif %}views" class="icon icon-arrow-{% if '-' in ordering %}up{% else %}down{% endif %}-after teal" aria-label="{% if '-' in ordering %}{% trans 'Order by views (lowest first)' %}{% else %}{% trans 'Order by views (highest first)' %}{% endif %}"></a>
-                {% else %}
-                    <a href="{% url 'wagtailsearchpromotions:index' %}?ordering=views" class="icon icon-arrow-down-after" aria-label="{% trans 'Order by views (lowest first)' %}"></a>
-                {% endif %}
-            </th>
-        </tr>
-    </thead>
-    <tbody>
-        {% for query in queries %}
-            <tr>
-                <td class="title">
-                    <div class="title-wrapper"><a href="{% url 'wagtailsearchpromotions:edit' query.id %}" title="{% trans 'Edit this promotion' %}">{{ query.query_string }}</a></div>
-                </td>
-                <td>
-                    {% for searchpick in query.editors_picks.all %}
-                        {% if searchpick.page %}
-                            <a href="{% url 'wagtailadmin_pages:edit' searchpick.page.id %}" class="nolink">{{ searchpick.title }}</a>
-                        {% else %}
-                            <a href="{{ searchpick.external_link_url }}" class="nolink" target="_blank" rel="noreferrer">
-                                {{ searchpick.title }} {% icon classname="initial" name="link-external" title=_("External link") %}
-                            </a>
-                        {% endif %}
-                        {% if not forloop.last %}, {% endif %}
-                    {% empty %}
-                        {% trans "None" %}
-                    {% endfor %}
-                </td>
-                <td>{{ query.hits }}</td>
-            </tr>
-        {% endfor %}
-    </tbody>
-</table>

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

@@ -1,23 +1,10 @@
+{% extends "wagtailadmin/generic/index_results.html" %}
 {% load i18n %}
-{% if queries %}
-    {% if is_searching %}
-        <h2 role="alert">
-            {% blocktrans trimmed count counter=queries|length %}
-                There is {{ counter }} match
-            {% plural %}
-                There are {{ counter }} matches
-            {% endblocktrans %}
-        </h2>
-    {% endif %}
-
-    {% include "wagtailsearchpromotions/list.html" %}
-
-    {% include "wagtailadmin/shared/pagination_nav.html" with items=queries linkurl="wagtailsearchpromotions:index" %}
-{% else %}
+{% block no_results_message %}
     {% if is_searching %}
         <p role="alert">{% blocktrans trimmed %}Sorry, no promoted results match "<em>{{ query_string }}</em>"{% endblocktrans %}</p>
     {% else %}
         {% url 'wagtailsearchpromotions:add' as wagtailsearchpromotions_add_url %}
         <p>{% blocktrans trimmed %}No promoted results have been created. Why not <a href="{{ wagtailsearchpromotions_add_url }}">add one</a>?{% endblocktrans %}</p>
     {% endif %}
-{% endif %}
+{% endblock %}

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

@@ -0,0 +1,15 @@
+{% load i18n wagtailadmin_tags %}
+<td>
+    {% for searchpick in value %}
+        {% if searchpick.page %}
+            <a href="{% url 'wagtailadmin_pages:edit' searchpick.page.id %}" class="nolink">{{ searchpick.title }}</a>
+        {% else %}
+            <a href="{{ searchpick.external_link_url }}" class="nolink" target="_blank" rel="noreferrer">
+                {{ searchpick.title }} {% icon classname="initial" name="link-external" title=_("External link") %}
+            </a>
+        {% endif %}
+        {% if not forloop.last %}, {% endif %}
+    {% empty %}
+        {% trans "None" %}
+    {% endfor %}
+</td>