Add public filters based on meta data (#3673)

* Add public filters based on meta data

* Fix licenseheaders

* ignore empty values

* Fix tests

* Full non-widget implementation

* Widget support

* Add a few tests

* Allow to reorder properties

* Fix isort

* Allow to opt-out for specific events

* Fix name clash between new and old field to make migration feasible

src/pretix/presale/forms/organizer.py

@@ -0,0 +1,90 @@
+#
+# This file is part of pretix (Community Edition).
+#
+# Copyright (C) 2014-2020 Raphael Michel and contributors
+# Copyright (C) 2020-2021 rami.io GmbH and contributors
+#
+# This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General
+# Public License as published by the Free Software Foundation in version 3 of the License.
+#
+# ADDITIONAL TERMS APPLY: Pursuant to Section 7 of the GNU Affero General Public License, additional terms are
+# applicable granting you additional permissions and placing additional restrictions on your usage of this software.
+# Please refer to the pretix LICENSE file to obtain the full terms applicable to this work. If you did not receive
+# this file, see <https://pretix.eu/about/en/license>.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
+# warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
+# details.
+#
+# You should have received a copy of the GNU Affero General Public License along with this program.  If not, see
+# <https://www.gnu.org/licenses/>.
+#
+from django import forms
+from django.conf import settings
+from i18nfield.strings import LazyI18nString
+
+from pretix.base.models import EventMetaValue, SubEventMetaValue
+
+
+def meta_filtersets(organizer, event=None):
+    fields = {}
+    if not (event or organizer).settings.event_list_filters:
+        return fields
+    for prop in organizer.meta_properties.filter(filter_public=True):
+        if prop.choices:
+            choices = [(v["key"], str(LazyI18nString(v["label"])) or v["key"]) for v in prop.choices]
+        elif event:
+            existing_values = set()
+            if event.meta_data.get(prop.name):
+                existing_values.add(event.meta_data.get(prop.name))
+            existing_values |= set(SubEventMetaValue.objects.using(settings.DATABASE_REPLICA).filter(
+                property=prop,
+                subevent__event=event,
+                subevent__event__live=True,
+                subevent__event__is_public=True,
+                subevent__active=True,
+                subevent__is_public=True,
+            ).values_list("value", flat=True).distinct())
+            choices = [(k, k) for k in sorted(existing_values)]
+        else:
+            existing_values = set()
+            if prop.default:
+                existing_values.add(prop.default)
+            existing_values |= set(EventMetaValue.objects.using(settings.DATABASE_REPLICA).filter(
+                property=prop,
+                event__organizer=organizer,
+                event__live=True,
+                event__is_public=True,
+            ).values_list("value", flat=True).distinct())
+            existing_values |= set(SubEventMetaValue.objects.using(settings.DATABASE_REPLICA).filter(
+                property=prop,
+                subevent__event__organizer=organizer,
+                subevent__event__live=True,
+                subevent__event__is_public=True,
+                subevent__active=True,
+                subevent__is_public=True,
+            ).values_list("value", flat=True).distinct())
+            choices = [(k, k) for k in sorted(existing_values)]
+
+        choices.insert(0, ("", ""))
+        if len(choices) > 1:
+            fields[f"attr[{prop.name}]"] = {
+                "label": str(prop.public_label) or prop.name,
+                "choices": choices
+            }
+    return fields
+
+
+class EventListFilterForm(forms.Form):
+
+    def __init__(self, *args, **kwargs):
+        self.organizer = kwargs.pop('organizer')
+        self.event = kwargs.pop('event', None)
+        super().__init__(*args, **kwargs)
+
+        for k, v in meta_filtersets(self.organizer, self.event).items():
+            self.fields[k] = forms.ChoiceField(
+                label=v["label"],
+                choices=v["choices"],
+                required=False,
+            )

src/pretix/presale/templates/pretixpresale/event/fragment_subevent_calendar.html

@@ -1,6 +1,7 @@
 {% load i18n %}
 {% load eventurl %}
 {% load urlreplace %}
+{% include "pretixpresale/fragment_event_list_filter.html" with request=request %}
 <nav aria-label="{% trans "calendar navigation" %}">
     <ul class="row calendar-nav">
         <li class="col-sm-4 col-xs-2 text-left flip">

src/pretix/presale/templates/pretixpresale/event/fragment_subevent_calendar_week.html

@@ -1,6 +1,7 @@
 {% load i18n %}
 {% load eventurl %}
 {% load urlreplace %}
+{% include "pretixpresale/fragment_event_list_filter.html" with request=request %}
 <nav aria-label="{% trans "calendar navigation" %}">
     <ul class="row calendar-nav">
         <li class="col-sm-4 col-xs-2 text-left flip">

src/pretix/presale/templates/pretixpresale/event/fragment_subevent_list.html

@@ -1,5 +1,6 @@
 {% load i18n %}
 {% load eventurl %}
+{% include "pretixpresale/fragment_event_list_filter.html" with request=request %}
 <ul class="list-unstyled">
 {% for subev in subevent_list.subevent_list %}
     <li class="subevent-row">

src/pretix/presale/templates/pretixpresale/event/index.html

@@ -70,7 +70,7 @@
             {% endif %}
         {% endif %}
 
-        {% if subevent and "date" not in request.GET %}
+        {% if subevent and "date" not in request.GET and "filtered" not in request.GET %}
             <p>
             {% if show_cart %}
                 <button class="subevent-toggle btn btn-primary btn-block btn-lg" aria-expanded="false">

src/pretix/presale/templates/pretixpresale/fragment_event_list_filter.html

@@ -0,0 +1,25 @@
+{% load i18n %}
+{% load eventurl %}
+{% load urlreplace %}
+{% load bootstrap3 %}
+{% load getitem %}
+
+{% if filter_form.fields %}
+    <form class="event-list-filter-form" method="get">
+        <input type="hidden" name="filtered" value="1">
+        {% for f, v in request.GET.items %}
+            {% if f not in filter_form.fields %}
+                <input type="hidden" name="{{ f }}" value="{{ v }}">
+            {% endif %}
+        {% endfor %}
+        <div class="event-list-filter-form-row">
+            {% for f in filter_form.fields %}
+                {% bootstrap_field filter_form|getitem:f %}
+            {% endfor %}
+            <button type="submit" class="btn btn-primary">
+                <span class="fa fa-filter" aria-hidden="true"></span>
+                {% trans "Filter" %}
+            </button>
+        </div>
+    </form>
+{% endif %}

src/pretix/presale/templates/pretixpresale/organizers/calendar.html

@@ -53,6 +53,7 @@
             </div>
         </div>
     </form>
+    {% include "pretixpresale/fragment_event_list_filter.html" with request=request %}
     {% include "pretixpresale/fragment_calendar.html" with show_avail=request.organizer.settings.event_list_availability %}
 
     {% if multiple_timezones %}

src/pretix/presale/templates/pretixpresale/organizers/calendar_day.html

@@ -46,6 +46,7 @@
             </div>
         </div>
     </form>
+    {% include "pretixpresale/fragment_event_list_filter.html" with request=request %}
     {% include "pretixpresale/fragment_day_calendar.html" with show_avail=request.organizer.settings.event_list_availability %}
     <div class="col-sm-4 visible-xs text-center">
         {% if has_before %}

src/pretix/presale/templates/pretixpresale/organizers/calendar_week.html

@@ -58,6 +58,7 @@
             </div>
         </div>
     </form>
+    {% include "pretixpresale/fragment_event_list_filter.html" with request=request %}
     {% include "pretixpresale/fragment_week_calendar.html" with show_avail=request.organizer.settings.event_list_availability %}
     <div class="col-sm-12 visible-sm visible-xs text-center">
         {% if has_before %}

src/pretix/presale/templates/pretixpresale/organizers/index.html

@@ -33,6 +33,7 @@
             </div>
         </div>
     </div>
+    {% include "pretixpresale/fragment_event_list_filter.html" with request=request %}
     {% if events %}
     <div class="event-list">
         <div class="row hidden-xs hidden-sm">
@@ -124,7 +125,7 @@
                     {% endif %}
                 </div>
                 <div class="col-md-2 col-xs-6 text-right flip">
-                    <a class="btn btn-primary btn-block" href="{{ url }}">
+                    <a class="btn btn-primary btn-block" href="{{ url }}{% if e.has_subevents and e.match_by_subevents %}{{ filterquery }}{% endif %}">
                         {% if e.has_subevents %}<span class="fa fa-ticket" aria-hidden="true"></span> {% trans "Tickets" %}
                         {% elif e.presale_is_running and e.best_availability_state == 100 %}
                             <span class="fa fa-ticket" aria-hidden="true"></span> {% trans "Tickets" %}

src/pretix/presale/views/organizer.py

@@ -34,6 +34,7 @@
 import calendar
 import hashlib
 import math
+import operator
 from collections import defaultdict
 from datetime import date, datetime, time, timedelta
 from functools import reduce
@@ -46,11 +47,12 @@ from django.conf import settings
 from django.core.cache import caches
 from django.db.models import Exists, Max, Min, OuterRef, Prefetch, Q
 from django.db.models.functions import Coalesce, Greatest
-from django.http import Http404, HttpResponse
+from django.http import Http404, HttpResponse, QueryDict
 from django.shortcuts import redirect
 from django.templatetags.static import static
 from django.utils.decorators import method_decorator
 from django.utils.formats import date_format, get_format
+from django.utils.functional import cached_property
 from django.utils.timezone import get_current_timezone, now
 from django.views import View
 from django.views.decorators.cache import cache_page
@@ -68,19 +70,25 @@ from pretix.helpers.formats.en.formats import (
 )
 from pretix.helpers.thumb import get_thumbnail
 from pretix.multidomain.urlreverse import eventreverse
+from pretix.presale.forms.organizer import EventListFilterForm
 from pretix.presale.ical import get_public_ical
 from pretix.presale.views import OrganizerViewMixin
 
 
-def filter_qs_by_attr(qs, request):
+def filter_qs_by_attr(qs, request, match_subevents_with_conditions: Q=None):
     """
     We'll allow to filter the event list using attributes defined in the event meta data
     models in the format ?attr[meta_name]=meta_value
+
+    :param qs: The base queryset over events or subevents
+    :param request: The request
+    :param match_subevents_with_conditions: If not None, an Event will also match if it has at least one subevent
+                                            fulfilling the conditions given and matching the search
     """
     attrs = {}
     for i, item in enumerate(request.GET.items()):
         k, v = item
-        if k.startswith("attr[") and k.endswith("]"):
+        if k.startswith("attr[") and k.endswith("]") and v.strip():
             attrs[k[5:-1]] = v
 
     skey = 'filter_qs_by_attr_{}_{}'.format(request.organizer.pk, request.event.pk if hasattr(request, 'event') else '')
@@ -91,10 +99,11 @@ def filter_qs_by_attr(qs, request):
 
     props = {
         p.name: p for p in request.organizer.meta_properties.filter(
+            Q(filter_allowed=True) | Q(filter_public=True),
             name__in=attrs.keys(),
-            filter_allowed=True,
         )
     }
+    conditions = []
 
     for i, item in enumerate(attrs.items()):
         attr, v = item
@@ -136,13 +145,42 @@ def filter_qs_by_attr(qs, request):
                 annotations['attr_{}_any'.format(i)] = Exists(emv_with_any_value)
                 filters |= Q(**{'attr_{}_any'.format(i): False})
 
-        qs = qs.annotate(**annotations).filter(filters)
+        qs = qs.annotate(**annotations)
+        conditions.append(filters)
+
+    if conditions:
+        if match_subevents_with_conditions:
+            qs = qs.annotate(
+                match_by_subevents=Exists(
+                    filter_qs_by_attr(
+                        SubEvent.objects.filter(
+                            match_subevents_with_conditions,
+                            event=OuterRef('pk'),
+                        ),
+                        request,
+                    )
+                )
+            ).filter(reduce(operator.and_, conditions) | Q(match_by_subevents=True))
+        else:
+            qs = qs.filter(reduce(operator.and_, conditions))
     return qs
 
 
 class EventListMixin:
+    @cached_property
+    def filter_form(self):
+        return EventListFilterForm(
+            data=self.request.GET,
+            organizer=self.request.organizer,
+            event=getattr(self.request, 'event', None),
+        )
 
-    def _get_event_queryset(self):
+    def get_context_data(self, **kwargs):
+        ctx = super().get_context_data(**kwargs)
+        ctx['filter_form'] = self.filter_form
+        return ctx
+
+    def _get_event_list_queryset(self):
         query = Q(is_public=True) & Q(live=True)
         qs = self.request.organizer.events.using(settings.DATABASE_REPLICA).filter(query)
         qs = qs.filter(sales_channels__contains=self.request.sales_channel.identifier)
@@ -154,26 +192,26 @@ class EventListMixin:
             max_fromto=Greatest(Max('subevents__date_to'), Max('subevents__date_from')),
         )
         if "old" in self.request.GET:
+            date_q = Q(date_to__lt=now()) | (Q(date_to__isnull=True) & Q(date_from__lt=now()))
             qs = qs.filter(
-                Q(Q(has_subevents=False) & Q(
-                    Q(date_to__lt=now()) | Q(Q(date_to__isnull=True) & Q(date_from__lt=now()))
-                )) | Q(Q(has_subevents=True) & Q(
-                    Q(min_to__lt=now()) | Q(min_from__lt=now()))
+                Q(Q(has_subevents=False) & date_q) | Q(
+                    Q(has_subevents=True) & Q(Q(min_to__lt=now()) | Q(min_from__lt=now()))
                 )
             ).annotate(
                 order_to=Coalesce('max_fromto', 'max_to', 'max_from', 'date_to', 'date_from'),
             ).order_by('-order_to')
         else:
+            date_q = Q(date_to__gte=now()) | (Q(date_to__isnull=True) & Q(date_from__gte=now()))
             qs = qs.filter(
-                Q(Q(has_subevents=False) & Q(
-                    Q(date_to__gte=now()) | Q(Q(date_to__isnull=True) & Q(date_from__gte=now()))
-                )) | Q(Q(has_subevents=True) & Q(
+                Q(Q(has_subevents=False) & date_q) | Q(Q(has_subevents=True) & Q(
                     Q(max_to__gte=now()) | Q(max_from__gte=now()))
                 )
             ).annotate(
                 order_from=Coalesce('min_from', 'date_from'),
             ).order_by('order_from')
-        qs = Event.annotated(filter_qs_by_attr(qs, self.request))
+        qs = Event.annotated(filter_qs_by_attr(
+            qs, self.request, match_subevents_with_conditions=Q(active=True) & Q(is_public=True) & date_q
+        ))
         return qs
 
     def _set_month_to_next_subevent(self):
@@ -387,7 +425,7 @@ class OrganizerIndex(OrganizerViewMixin, EventListMixin, ListView):
             return super().get(request, *args, **kwargs)
 
     def get_queryset(self):
-        return self._get_event_queryset()
+        return self._get_event_list_queryset()
 
     def get_context_data(self, **kwargs):
         ctx = super().get_context_data(**kwargs)
@@ -398,6 +436,14 @@ class OrganizerIndex(OrganizerViewMixin, EventListMixin, ListView):
                     event.min_from.astimezone(event.tzname),
                     (event.max_fromto or event.max_to or event.max_from).astimezone(event.tzname)
                 )
+
+        query_data = self.request.GET.copy()
+        filter_query_data = QueryDict(mutable=True)
+        for k, v in query_data.items():
+            if k.startswith("attr[") and v:
+                filter_query_data[k] = v
+        ctx["filterquery"] = f"?{filter_query_data.urlencode()}" if filter_query_data else ""
+
         return ctx
 
 

src/pretix/presale/views/widget.py

@@ -63,6 +63,7 @@ from pretix.base.templatetags.rich_text import rich_text
 from pretix.helpers.daterange import daterange
 from pretix.helpers.thumb import get_thumbnail
 from pretix.multidomain.urlreverse import build_absolute_uri
+from pretix.presale.forms.organizer import meta_filtersets
 from pretix.presale.views.cart import get_or_create_cart_id
 from pretix.presale.views.event import (
     get_grouped_items, item_group_by_category,
@@ -464,6 +465,9 @@ class WidgetAPIProductList(EventListMixin, View):
         o = getattr(request, 'event', request.organizer)
         list_type = self.request.GET.get("style", o.settings.event_list_type)
         data['list_type'] = list_type
+        data['meta_filter_fields'] = [
+            {**v, "key": k} for k, v in meta_filtersets(request.organizer, getattr(request, 'event', None)).items()
+        ]
 
         if hasattr(self.request, 'event') and data['list_type'] not in ("calendar", "week"):
             # only allow list-view of more than 50 subevents if ordering is by data as this can be done in the database
@@ -596,7 +600,14 @@ class WidgetAPIProductList(EventListMixin, View):
             offset = int(self.request.GET.get("offset", 0))
             limit = 50
             if hasattr(self.request, 'event'):
-                evs = filter_qs_by_attr(self.request.event.subevents_annotated(self.request.sales_channel.identifier), self.request)
+                evs = filter_qs_by_attr(
+                    self.request.event.subevents_annotated(self.request.sales_channel.identifier),
+                    self.request,
+                    match_subevents_with_conditions=(
+                        Q(Q(date_to__isnull=True) & Q(date_from__gte=now() - timedelta(hours=24)))
+                        | Q(date_to__gte=now() - timedelta(hours=24))
+                    ),
+                )
                 evs = self.request.event.subevents_sorted(evs)
                 ordering = self.request.event.settings.get('frontpage_subevent_ordering', default='date_ascending', as_type=str)
                 data['has_more_events'] = False
@@ -629,7 +640,7 @@ class WidgetAPIProductList(EventListMixin, View):
                 ]
             else:
                 data['events'] = []
-                qs = self._get_event_queryset()
+                qs = self._get_event_list_queryset()
                 for event in qs:
                     tz = ZoneInfo(event.cache.get_or_set('timezone', lambda: event.settings.timezone))
                     if event.has_subevents: