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

wagtail/contrib/search_promotions/views/__init__.py

@@ -0,0 +1 @@
+from .settings import *  # NOQA: F403

wagtail/contrib/search_promotions/views/reports.py

@@ -0,0 +1,56 @@
+from django.utils.translation import gettext_lazy as _
+from django_filters import DateFromToRangeFilter
+
+from wagtail.admin.auth import permission_denied
+from wagtail.admin.filters import DateRangePickerWidget, WagtailFilterSet
+from wagtail.admin.ui.tables import Column
+from wagtail.admin.views.reports import ReportView
+from wagtail.contrib.search_promotions.models import Query
+
+
+class SearchTermsReportFilterSet(WagtailFilterSet):
+    hit_date = DateFromToRangeFilter(
+        label=_("Date"),
+        field_name="daily_hits__date",
+        widget=DateRangePickerWidget,
+    )
+
+    class Meta:
+        model = Query
+        fields = []
+
+
+class SearchTermsReportView(ReportView):
+    page_title = _("Search terms")
+    header_icon = "search"
+    is_searchable = True
+    search_fields = ["query_string"]
+    filterset_class = SearchTermsReportFilterSet
+    default_ordering = "-_hits"
+    index_url_name = "wagtailsearchpromotions:search_terms"
+    index_results_url_name = "wagtailsearchpromotions:search_terms_results"
+    columns = [
+        Column("query_string", label=_("Search term(s)"), sort_key="query_string"),
+        Column("_hits", label=_("Views"), sort_key="_hits"),
+    ]
+    export_headings = {
+        "query_string": _("Search term(s)"),
+        "_hits": _("Views"),
+    }
+    list_export = [
+        "query_string",
+        "_hits",
+    ]
+
+    def get_filterset_kwargs(self):
+        kwargs = super().get_filterset_kwargs()
+        kwargs["queryset"] = self.get_base_queryset()
+        return kwargs
+
+    def get_base_queryset(self):
+        return Query.get_most_popular()
+
+    def dispatch(self, request, *args, **kwargs):
+        if not self.request.user.is_superuser:
+            return permission_denied(request)
+        return super().dispatch(request, *args, **kwargs)

wagtail/contrib/search_promotions/views/settings.py

@@ -0,0 +1,258 @@
+from django.core.paginator import InvalidPage, Paginator
+from django.db import transaction
+from django.db.models import Sum, functions
+from django.http import Http404
+from django.shortcuts import redirect
+from django.template.response import TemplateResponse
+from django.utils.functional import cached_property
+from django.utils.translation import gettext_lazy
+
+from wagtail.admin import messages
+from wagtail.admin.forms.search import SearchForm
+from wagtail.admin.modal_workflow import render_modal_workflow
+from wagtail.admin.ui.tables import Column, RelatedObjectsColumn, TitleColumn
+from wagtail.admin.views import generic
+from wagtail.contrib.search_promotions import forms, models
+from wagtail.contrib.search_promotions.models import Query, SearchPromotion
+from wagtail.log_actions import log
+from wagtail.permission_policies.base import ModelPermissionPolicy
+from wagtail.search.utils import normalise_query_string
+
+
+class SearchPromotionColumn(RelatedObjectsColumn):
+    cell_template_name = "wagtailsearchpromotions/search_promotion_column.html"
+
+
+class IndexView(generic.IndexView):
+    model = Query
+    template_name = "wagtailsearchpromotions/index.html"
+    results_template_name = "wagtailsearchpromotions/index_results.html"
+    context_object_name = "queries"
+    page_title = gettext_lazy("Promoted search results")
+    header_icon = "pick"
+    paginate_by = 20
+    permission_policy = ModelPermissionPolicy(SearchPromotion)
+    index_url_name = "wagtailsearchpromotions:index"
+    index_results_url_name = "wagtailsearchpromotions:index_results"
+    search_fields = ["query_string"]
+    default_ordering = "query_string"
+    add_url_name = "wagtailsearchpromotions:add"
+    add_item_label = gettext_lazy("Add new promoted result")
+    columns = [
+        TitleColumn(
+            "query_string",
+            label=gettext_lazy("Search term(s)"),
+            width="40%",
+            url_name="wagtailsearchpromotions:edit",
+            sort_key="query_string",
+        ),
+        SearchPromotionColumn(
+            "editors_picks",
+            label=gettext_lazy("Promoted results"),
+            width="40%",
+        ),
+        Column(
+            "views",
+            label=gettext_lazy("Views (past week)"),
+            width="20%",
+            sort_key="views",
+        ),
+    ]
+
+    def get_base_queryset(self):
+        # Use a subquery to filter out the Query objects that do not have a
+        # SearchPromotion instead of using .filter(editors_picks__isnull=False).
+        # The latter would use a JOIN which would result in duplicate rows before
+        # the sum is calculated, causing the sum to be incorrect.
+        has_promotions = SearchPromotion.objects.values_list("query_id", flat=True)
+        queryset = self.model.objects.filter(pk__in=has_promotions)
+
+        # Prevent N+1 queries by annotating the sum instead of using the
+        # Query.hits property and prefetching the related editors_picks.
+        queryset = queryset.annotate(
+            views=functions.Coalesce(Sum("daily_hits__hits"), 0)
+        ).prefetch_related("editors_picks", "editors_picks__page")
+        return queryset
+
+    def get_breadcrumbs_items(self):
+        breadcrumbs = super().get_breadcrumbs_items()
+        breadcrumbs[-1]["label"] = self.get_page_title()
+        return breadcrumbs
+
+
+class SearchPromotionCreateEditMixin:
+    model = Query
+    permission_policy = ModelPermissionPolicy(SearchPromotion)
+    index_url_name = "wagtailsearchpromotions:index"
+    edit_url_name = "wagtailsearchpromotions:edit"
+    form_class = forms.QueryForm
+    header_icon = "pick"
+    _show_breadcrumbs = True
+    page_subtitle = gettext_lazy("Promoted search result")
+
+    def get_success_message(self, instance=None):
+        return self.success_message % {"query": instance}
+
+    def get_error_message(self):
+        if formset_errors := self.searchpicks_formset.non_form_errors():
+            # formset level error (e.g. no forms submitted)
+            return " ".join(error for error in formset_errors)
+        return super().get_error_message()
+
+    def get_breadcrumbs_items(self):
+        breadcrumbs = super().get_breadcrumbs_items()
+        breadcrumbs[-2]["label"] = IndexView.page_title
+        return breadcrumbs
+
+    def get_context_data(self, **kwargs):
+        context = super().get_context_data(**kwargs)
+        context["searchpicks_formset"] = self.searchpicks_formset
+        context["media"] += self.searchpicks_formset.media
+        return context
+
+    def save_searchpicks(self, query, new_query):
+        searchpicks_formset = self.searchpicks_formset
+        if not searchpicks_formset.is_valid():
+            return False
+
+        # Set sort_order
+        for i, form in enumerate(searchpicks_formset.ordered_forms):
+            form.instance.sort_order = i
+
+            # Make sure the form is marked as changed so it gets saved with the new order
+            form.has_changed = lambda: True
+
+        # log deleted items before saving, otherwise we lose their IDs
+        items_for_deletion = [
+            form.instance
+            for form in searchpicks_formset.deleted_forms
+            if form.instance.pk
+        ]
+        with transaction.atomic():
+            for search_pick in items_for_deletion:
+                log(search_pick, "wagtail.delete")
+
+            searchpicks_formset.save()
+
+            for search_pick in searchpicks_formset.new_objects:
+                log(search_pick, "wagtail.create")
+
+            # If query was changed, move all search picks to the new query
+            if query != new_query:
+                searchpicks_formset.get_queryset().update(query=new_query)
+                # log all items in the formset as having changed
+                for search_pick, changed_fields in searchpicks_formset.changed_objects:
+                    log(search_pick, "wagtail.edit")
+            else:
+                # only log objects with actual changes
+                for search_pick, changed_fields in searchpicks_formset.changed_objects:
+                    if changed_fields:
+                        log(search_pick, "wagtail.edit")
+
+        return True
+
+    @cached_property
+    def searchpicks_formset(self):
+        if self.request.method == "POST":
+            return forms.SearchPromotionsFormSet(
+                self.request.POST, instance=self.object
+            )
+        return forms.SearchPromotionsFormSet(instance=self.object)
+
+    def form_valid(self, form):
+        self.form = form
+        new_query = Query.get(form.cleaned_data["query_string"])
+        if not self.object:
+            self.object = new_query
+
+        if self.save_searchpicks(self.object, new_query):
+            messages.success(
+                self.request,
+                self.get_success_message(self.object),
+                buttons=self.get_success_buttons(),
+            )
+            return redirect(self.index_url_name)
+
+        return super().form_invalid(form)
+
+
+class CreateView(SearchPromotionCreateEditMixin, generic.CreateView):
+    success_message = gettext_lazy("Editor's picks for '%(query)s' created.")
+    error_message = gettext_lazy("Recommendations have not been created due to errors")
+    template_name = "wagtailsearchpromotions/add.html"
+    add_url_name = "wagtailsearchpromotions:add"
+
+
+class EditView(SearchPromotionCreateEditMixin, generic.EditView):
+    pk_url_kwarg = "query_id"
+    context_object_name = "query"
+    delete_url_name = "wagtailsearchpromotions:delete"
+    success_message = gettext_lazy("Editor's picks for '%(query)s' updated.")
+    error_message = gettext_lazy("Recommendations have not been saved due to errors")
+    template_name = "wagtailsearchpromotions/edit.html"
+
+
+class DeleteView(generic.DeleteView):
+    model = Query
+    permission_policy = ModelPermissionPolicy(SearchPromotion)
+    pk_url_kwarg = "query_id"
+    context_object_name = "query"
+    success_message = gettext_lazy("Editor's picks deleted.")
+    index_url_name = "wagtailsearchpromotions:index"
+    delete_url_name = "wagtailsearchpromotions:delete"
+    header_icon = "pick"
+    template_name = "wagtailsearchpromotions/confirm_delete.html"
+
+    def delete_action(self):
+        editors_picks = self.object.editors_picks.all()
+        with transaction.atomic():
+            for search_pick in editors_picks:
+                log(search_pick, "wagtail.delete")
+            editors_picks.delete()
+
+
+def chooser(request, get_results=False):
+    # Get most popular queries
+    queries = models.Query.get_most_popular()
+
+    # If searching, filter results by query string
+    if "q" in request.GET:
+        searchform = SearchForm(request.GET)
+        if searchform.is_valid():
+            query_string = searchform.cleaned_data["q"]
+            queries = queries.filter(
+                query_string__icontains=normalise_query_string(query_string)
+            )
+    else:
+        searchform = SearchForm()
+
+    paginator = Paginator(queries, per_page=10)
+    try:
+        queries = paginator.page(request.GET.get("p", 1))
+    except InvalidPage:
+        raise Http404
+
+    # Render
+    if get_results:
+        return TemplateResponse(
+            request,
+            "wagtailsearchpromotions/queries/chooser/results.html",
+            {
+                "queries": queries,
+            },
+        )
+    else:
+        return render_modal_workflow(
+            request,
+            "wagtailsearchpromotions/queries/chooser/chooser.html",
+            None,
+            {
+                "queries": queries,
+                "searchform": searchform,
+            },
+            json_data={"step": "chooser"},
+        )
+
+
+def chooserresults(request):
+    return chooser(request, get_results=True)

wagtail/contrib/search_promotions/wagtail_hooks.py

@@ -7,7 +7,7 @@ from wagtail.admin.admin_url_finder import (
     ModelAdminURLFinder,
     register_admin_url_finder,
 )
-from wagtail.admin.menu import MenuItem
+from wagtail.admin.menu import AdminOnlyMenuItem, MenuItem
 from wagtail.contrib.search_promotions import admin_urls
 from wagtail.permission_policies import ModelPermissionPolicy
 
@@ -41,6 +41,17 @@ def register_search_picks_menu_item():
     )
 
 
+@hooks.register("register_reports_menu_item")
+def register_query_search_report_menu_item():
+    return AdminOnlyMenuItem(
+        _("Search terms"),
+        reverse("wagtailsearchpromotions:search_terms"),
+        name="search-terms",
+        icon_name="search",
+        order=1300,
+    )
+
+
 @hooks.register("register_permissions")
 def register_permissions():
     return Permission.objects.filter(

wagtail/contrib/settings/locale/ar/LC_MESSAGES/django.po

@@ -8,6 +8,7 @@
 # Bashar Al-Abdulhadi, 2020
 # Bashar Al-Abdulhadi, 2020
 # Khaled Arnaout <khaledarnaout@live.com>, 2018
+# Tarek Berkane, 2025
 # Younes Oumakhou, 2022
 # Younes Oumakhou, 2022
 # abdulaziz alfuhigi <abajall@gmail.com>, 2016
@@ -17,7 +18,7 @@ msgstr ""
 "Report-Msgid-Bugs-To: \n"
 "POT-Creation-Date: 2024-10-21 17:53+0100\n"
 "PO-Revision-Date: 2016-03-01 19:20+0000\n"
-"Last-Translator: abdulaziz alfuhigi <abajall@gmail.com>, 2016\n"
+"Last-Translator: Tarek Berkane, 2025\n"
 "Language-Team: Arabic (http://app.transifex.com/torchbox/wagtail/language/"
 "ar/)\n"
 "MIME-Version: 1.0\n"
@@ -30,6 +31,10 @@ msgstr ""
 msgid "default"
 msgstr "الإفتراضي"
 
+#, python-format
+msgid "%(site_setting)s for %(site)s"
+msgstr " %(site_setting)s الخاص ب%(site)s"
+
 msgid "Site"
 msgstr "موقع"
 

wagtail/contrib/settings/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"
@@ -40,11 +40,11 @@ msgstr ""
 msgid "This setting could not be opened because there is no site defined."
 msgstr ""
 
-#: views.py:84
+#: views.py:85
 msgid "The setting could not be saved due to errors."
 msgstr ""
 
-#: views.py:152
+#: views.py:138
 #, python-format
 msgid "%(setting_type)s updated."
 msgstr ""

wagtail/contrib/settings/templates/wagtailsettings/edit.html

@@ -1,5 +1,5 @@
 {% extends "wagtailadmin/generic/edit.html" %}
-{% load i18n wagtailadmin_tags %}
+{% load i18n %}
 
 {% block before_form %}
     {% if site_switcher %}
@@ -11,7 +11,3 @@
         </form>
     {% endif %}
 {% endblock %}
-
-{% block form_content %}
-    {{ edit_handler.render_form_content }}
-{% endblock %}

wagtail/contrib/settings/tests/generic/test_admin.py

@@ -233,11 +233,8 @@ class TestGenericSettingEditView(BaseTestGenericSettingView):
     def test_register_with_icon(self):
         edit_url = reverse("wagtailsettings:edit", args=("tests", "IconGenericSetting"))
         edit_response = self.client.get(edit_url, follow=True)
-
-        self.assertContains(
-            edit_response,
-            """<svg class="icon icon-icon-setting-tag w-header__glyph" aria-hidden="true"><use href="#icon-icon-setting-tag"></use></svg>""",
-        )
+        soup = self.get_soup(edit_response.content)
+        self.assertIsNotNone(soup.select_one("h2 svg use[href='#icon-tag']"))
 
     def test_edit_invalid(self):
         response = self.post(post_data={"foo": "bar"})

wagtail/contrib/settings/tests/generic/test_register.py

@@ -21,4 +21,4 @@ class GenericSettingRegisterTestCase(WagtailTestUtils, TestCase):
 
     def test_icon(self):
         admin = self.client.get(reverse("wagtailadmin_home"))
-        self.assertContains(admin, "icon-setting-tag")
+        self.assertContains(admin, '"tag"')

wagtail/contrib/settings/tests/site_specific/test_admin.py

@@ -230,11 +230,8 @@ class TestSiteSettingEditView(BaseTestSiteSettingView):
     def test_register_with_icon(self):
         edit_url = reverse("wagtailsettings:edit", args=("tests", "IconGenericSetting"))
         edit_response = self.client.get(edit_url, follow=True)
-
-        self.assertContains(
-            edit_response,
-            """<svg class="icon icon-icon-setting-tag w-header__glyph" aria-hidden="true"><use href="#icon-icon-setting-tag"></use></svg>""",
-        )
+        soup = self.get_soup(edit_response.content)
+        self.assertIsNotNone(soup.select_one("h2 svg use[href='#icon-tag']"))
 
     def test_edit_invalid(self):
         response = self.post(post_data={"foo": "bar"})

wagtail/contrib/settings/tests/site_specific/test_register.py

@@ -21,4 +21,4 @@ class TestRegister(WagtailTestUtils, TestCase):
 
     def test_icon(self):
         admin = self.client.get(reverse("wagtailadmin_home"))
-        self.assertContains(admin, "icon-setting-tag")
+        self.assertContains(admin, '"tag"')

wagtail/contrib/settings/views.py

@@ -81,6 +81,7 @@ def redirect_to_relevant_instance(request, app_name, model_name):
 
 class EditView(generic.EditView):
     template_name = "wagtailsettings/edit.html"
+    edit_url_name = "wagtailsettings:edit"
     error_message = gettext_lazy("The setting could not be saved due to errors.")
     permission_required = "change"
 
@@ -92,6 +93,9 @@ class EditView(generic.EditView):
         self.pk = kwargs.get(self.pk_url_kwarg)
         super().setup(request, app_name, model_name, *args, **kwargs)
 
+    def get_header_icon(self):
+        return registry._model_icons.get(self.model)
+
     def get_object(self, queryset=None):
         self.site = None
         if issubclass(self.model, BaseSiteSetting):
@@ -100,12 +104,12 @@ class EditView(generic.EditView):
         else:
             return get_object_or_404(self.model, pk=self.pk)
 
-    def get_form_class(self):
-        return get_setting_edit_handler(self.model).get_form_class()
+    def get_panel(self):
+        return get_setting_edit_handler(self.model)
 
     def get_edit_url(self):
         return reverse(
-            "wagtailsettings:edit",
+            self.edit_url_name,
             args=(self.app_name, self.model_name, self.pk),
         )
 
@@ -121,27 +125,9 @@ class EditView(generic.EditView):
         site_switcher = None
         if self.site and Site.objects.count() > 1:
             site_switcher = SiteSwitchForm(self.site, self.model)
-            media = context.get("media") + site_switcher.media
-
-        form = self.get_form()
-
-        edit_handler = get_setting_edit_handler(self.model).get_bound_panel(
-            instance=self.object, request=self.request, form=form
-        )
-
-        media = form.media + edit_handler.media
-
-        header_icon = registry._model_icons.get(self.model)
-
-        context.update(
-            {
-                "edit_handler": edit_handler,
-                "site_switcher": site_switcher,
-                "media": media,
-                "header_icon": header_icon,
-            }
-        )
+            context["media"] += site_switcher.media
 
+        context["site_switcher"] = site_switcher
         return context
 
     def get_success_url(self):

wagtail/contrib/simple_translation/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"

wagtail/contrib/styleguide/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"

wagtail/contrib/table_block/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"

wagtail/contrib/table_block/tests.py

@@ -558,7 +558,7 @@ class TestTableBlockForm(WagtailTestUtils, SimpleTestCase):
         self.assertIs(block_3_opts["allowEmpty"], False)
 
     def test_adapt(self):
-        block = TableBlock()
+        block = TableBlock(description="A table to display data.")
 
         block.set_name("test_tableblock")
         js_args = FieldBlockAdapter().js_args(block)
@@ -569,8 +569,11 @@ class TestTableBlockForm(WagtailTestUtils, SimpleTestCase):
             js_args[2],
             {
                 "label": "Test tableblock",
+                "description": "A table to display data.",
                 "required": True,
                 "icon": "table",
+                "blockDefId": block.definition_prefix,
+                "isPreviewable": block.is_previewable,
                 "classname": "w-field w-field--char_field w-field--table_input",
                 "showAddCommentButton": True,
                 "strings": {"ADD_COMMENT": "Add Comment"},

wagtail/contrib/typed_table_block/blocks.py

@@ -332,8 +332,11 @@ class TypedTableBlockAdapter(Adapter):
     def js_args(self, block):
         meta = {
             "label": block.label,
+            "description": block.get_description(),
             "required": block.required,
             "icon": block.meta.icon,
+            "blockDefId": block.definition_prefix,
+            "isPreviewable": block.is_previewable,
             "strings": {
                 "CAPTION": _("Caption"),
                 "CAPTION_HELP_TEXT": _(

wagtail/contrib/typed_table_block/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"
@@ -18,40 +18,40 @@ msgstr ""
 "Content-Transfer-Encoding: 8bit\n"
 "Plural-Forms: nplurals=2; plural=(n != 1);\n"
 
-#: blocks.py:338
+#: blocks.py:341
 msgid "Caption"
 msgstr ""
 
-#: blocks.py:340
+#: blocks.py:343
 msgid ""
 "A heading that identifies the overall topic of the table, and is useful for "
 "screen reader users."
 msgstr ""
 
-#: blocks.py:342
+#: blocks.py:345
 msgid "Add column"
 msgstr ""
 
-#: blocks.py:343
+#: blocks.py:346
 msgid "Add row"
 msgstr ""
 
-#: blocks.py:344
+#: blocks.py:347
 msgid "Column heading"
 msgstr ""
 
-#: blocks.py:345
+#: blocks.py:348
 msgid "Insert column"
 msgstr ""
 
-#: blocks.py:346
+#: blocks.py:349
 msgid "Delete column"
 msgstr ""
 
-#: blocks.py:347
+#: blocks.py:350
 msgid "Insert row"
 msgstr ""
 
-#: blocks.py:348
+#: blocks.py:351
 msgid "Delete row"
 msgstr ""