Allow to sort the list of check-in lists (Z#23128978) (#3568)

src/pretix/control/forms/filter.py

@@ -2397,6 +2397,61 @@ class CheckinFilterForm(FilterForm):
         return qs
 
 
+class CheckinListFilterForm(FilterForm):
+    orders = {
+        "name": ("name", "subevent__date_from", "pk"),
+        "-name": ("-name", "-subevent__date_from", "-pk"),
+        "subevent": ("subevent__date_from", "name", "pk"),
+        "-subevent": ("-subevent__date_from", "-name", "-pk"),
+    }
+    subevent = forms.ModelChoiceField(
+        label=pgettext_lazy('subevent', 'Date'),
+        queryset=SubEvent.objects.none(),
+        required=False,
+        empty_label=pgettext_lazy('subevent', 'All dates')
+    )
+
+    def __init__(self, *args, **kwargs):
+        self.event = kwargs.pop("event")
+        super().__init__(*args, **kwargs)
+        if self.event.has_subevents:
+            self.fields['subevent'].queryset = self.event.subevents.all()
+            self.fields['subevent'].widget = Select2(
+                attrs={
+                    'data-model-select2': 'event',
+                    'data-select2-url': reverse('control:event.subevents.select2', kwargs={
+                        'event': self.event.slug,
+                        'organizer': self.event.organizer.slug,
+                    }),
+                    'data-placeholder': pgettext_lazy('subevent', 'All dates')
+                }
+            )
+            self.fields['subevent'].widget.choices = self.fields['subevent'].choices
+        elif 'subevent':
+            del self.fields['subevent']
+
+    def filter_qs(self, qs):
+        fdata = self.cleaned_data
+
+        if fdata.get('subevent'):
+            qs = qs.filter(subevent=fdata.get('subevent'))
+
+        if fdata.get("ordering"):
+            ob = self.orders[fdata.get('ordering')]
+            if isinstance(ob, dict):
+                ob = dict(ob)
+                o = ob.pop('_order')
+                qs = qs.annotate(**ob).order_by(*get_deterministic_ordering(OrderPosition, [o]))
+            elif isinstance(ob, (list, tuple)):
+                qs = qs.order_by(*get_deterministic_ordering(OrderPosition, ob))
+            else:
+                qs = qs.order_by(*get_deterministic_ordering(OrderPosition, [ob]))
+        else:
+            qs = qs.order_by("subevent__date_from", "name", "pk")
+
+        return qs.distinct()
+
+
 class DeviceFilterForm(FilterForm):
     orders = {
         'name': Upper('name'),

src/pretix/control/templates/pretixcontrol/checkin/lists.html

@@ -1,5 +1,7 @@
 {% extends "pretixcontrol/items/base.html" %}
 {% load i18n %}
+{% load bootstrap3 %}
+{% load urlreplace %}
 {% block title %}{% trans "Check-in lists" %}{% endblock %}
 {% block inside %}
     <h1>{% trans "Check-in lists" %}</h1>
@@ -27,11 +29,26 @@
         {% endblocktrans %}
     </p>
     {% if request.event.has_subevents %}
-        <form class="form-inline helper-display-inline" action="" method="get">
-            <form class="form-inline helper-display-inline" action="" method="get">
-                {% include "pretixcontrol/event/fragment_subevent_choice_simple.html" %}
+        <div class="panel panel-default">
+            <div class="panel-heading">
+                <h3 class="panel-title">{% trans "Filter" %}</h3>
+            </div>
+            <form class="panel-body filter-form" action="" method="get">
+                <div class="row">
+                    {% if filter_form.subevent %}
+                        <div class="col-md-12 col-sm-12 col-xs-12">
+                            {% bootstrap_field filter_form.subevent %}
+                        </div>
+                    {% endif %}
+                </div>
+                <div class="text-right">
+                    <button class="btn btn-primary btn-lg" type="submit">
+                        <span class="fa fa-filter"></span>
+                        {% trans "Filter" %}
+                    </button>
+                </div>
             </form>
-        </form>
+        </div>
     {% endif %}
     {% if checkinlists|length == 0 %}
         <div class="empty-collection">
@@ -47,7 +64,8 @@
 
             {% if "can_change_event_settings" in request.eventpermset %}
                 <a href="{% url "control:event.orders.checkinlists.add" organizer=request.event.organizer.slug event=request.event.slug %}"
-                   class="btn btn-primary btn-lg"><i class="fa fa-plus"></i> {% trans "Create a new check-in list" %}</a>
+                   class="btn btn-primary btn-lg"><i class="fa fa-plus"></i> {% trans "Create a new check-in list" %}
+                </a>
             {% endif %}
             {% if can_change_organizer_settings %}
                 <a href="{% url "control:organizer.devices" organizer=request.organizer.slug %}"
@@ -69,10 +87,18 @@
             <table class="table table-hover table-quotas">
                 <thead>
                 <tr>
-                    <th>{% trans "Check-in lists" %}</th>
+                    <th>
+                        {% trans "Name" %}
+                        <a href="?{% url_replace request 'ordering' '-name' %}"><i class="fa fa-caret-down"></i></a>
+                        <a href="?{% url_replace request 'ordering' 'name' %}"><i class="fa fa-caret-up"></i></a>
+                    </th>
                     <th>{% trans "Checked in" %}</th>
                     {% if request.event.has_subevents %}
-                        <th>{% trans "Date" context "subevent" %}</th>
+                        <th>
+                            {% trans "Date" context "subevent" %}
+                            <a href="?{% url_replace request 'ordering' '-subevent' %}"><i class="fa fa-caret-down"></i></a>
+                            <a href="?{% url_replace request 'ordering' 'subevent' %}"><i class="fa fa-caret-up"></i></a>
+                        </th>
                     {% endif %}
                     <th class="iconcol">{% trans "Automated check-in" %}</th>
                     <th>{% trans "Products" %}</th>
@@ -83,7 +109,8 @@
                 {% for cl in checkinlists %}
                     <tr>
                         <td>
-                            <strong><a href="{% url "control:event.orders.checkinlists.show" organizer=request.event.organizer.slug event=request.event.slug list=cl.id %}">{{ cl.name }}</a></strong>
+                            <strong><a
+                                    href="{% url "control:event.orders.checkinlists.show" organizer=request.event.organizer.slug event=request.event.slug list=cl.id %}">{{ cl.name }}</a></strong>
                         </td>
                         <td>
                             <div class="quotabox availability">
@@ -92,14 +119,16 @@
                                     </div>
                                 </div>
                                 <div class="numbers">
-                                    {{ cl.checkin_count|default_if_none:"0" }} / {{ cl.position_count|default_if_none:"0" }}
+                                    {{ cl.checkin_count|default_if_none:"0" }} /
+                                    {{ cl.position_count|default_if_none:"0" }}
                                 </div>
                             </div>
                         </td>
                         {% if request.event.has_subevents %}
                             {% if cl.subevent %}
                                 <td>
-                                    {{ cl.subevent.name }} – {{ cl.subevent.get_date_range_display }} {{ cl.subevent.date_from|date:"TIME_FORMAT" }}
+                                    {{ cl.subevent.name }} – {{ cl.subevent.get_date_range_display }}
+                                    {{ cl.subevent.date_from|date:"TIME_FORMAT" }}
                                 </td>
                             {% else %}
                                 <td>
@@ -127,17 +156,20 @@
                             {% endif %}
                         </td>
                         <td class="text-right flip">
-                            <a href="{% url "control:event.orders.checkinlists.show" organizer=request.event.organizer.slug event=request.event.slug list=cl.id %}" class="btn btn-default btn-sm"><i class="fa fa-eye"></i></a>
+                            <a href="{% url "control:event.orders.checkinlists.show" organizer=request.event.organizer.slug event=request.event.slug list=cl.id %}"
+                               class="btn btn-default btn-sm"><i class="fa fa-eye"></i></a>
                             {% if "can_change_event_settings" in request.eventpermset %}
                                 <a href="{% url "control:event.orders.checkinlists.add" organizer=request.event.organizer.slug event=request.event.slug %}?copy_from={{ cl.id }}"
-                                        class="btn btn-sm btn-default" title="{% trans "Clone" %}" data-toggle="tooltip">
+                                   class="btn btn-sm btn-default" title="{% trans "Clone" %}" data-toggle="tooltip">
                                     <span class="fa fa-copy"></span>
                                 </a>
                                 <a href="{% url "control:event.orders.checkinlists.simulator" organizer=request.event.organizer.slug event=request.event.slug list=cl.id %}"
                                    title="{% trans "Check-in simulator" %}" data-toggle="tooltip"
                                    class="btn btn-default btn-sm"><i class="fa fa-flask"></i></a>
-                                <a href="{% url "control:event.orders.checkinlists.edit" organizer=request.event.organizer.slug event=request.event.slug list=cl.id %}" class="btn btn-default btn-sm"><i class="fa fa-wrench"></i></a>
-                                <a href="{% url "control:event.orders.checkinlists.delete" organizer=request.event.organizer.slug event=request.event.slug list=cl.id %}" class="btn btn-danger btn-sm"><i class="fa fa-trash"></i></a>
+                                <a href="{% url "control:event.orders.checkinlists.edit" organizer=request.event.organizer.slug event=request.event.slug list=cl.id %}"
+                                   class="btn btn-default btn-sm"><i class="fa fa-wrench"></i></a>
+                                <a href="{% url "control:event.orders.checkinlists.delete" organizer=request.event.organizer.slug event=request.event.slug list=cl.id %}"
+                                   class="btn btn-danger btn-sm"><i class="fa fa-trash"></i></a>
                             {% endif %}
                         </td>
                     </tr>

src/pretix/control/views/checkin.py

@@ -61,7 +61,7 @@ from pretix.control.forms.checkin import (
     CheckinListForm, CheckinListSimulatorForm,
 )
 from pretix.control.forms.filter import (
-    CheckinFilterForm, CheckinListAttendeeFilterForm,
+    CheckinFilterForm, CheckinListAttendeeFilterForm, CheckinListFilterForm,
 )
 from pretix.control.permissions import EventPermissionRequiredMixin
 from pretix.control.views import CreateView, PaginationMixin, UpdateView
@@ -279,13 +279,13 @@ class CheckinListList(EventPermissionRequiredMixin, PaginationMixin, ListView):
     context_object_name = 'checkinlists'
     permission = 'can_view_orders'
     template_name = 'pretixcontrol/checkin/lists.html'
+    ordering = ('subevent__date_from', 'name', 'pk')
 
     def get_queryset(self):
         qs = self.request.event.checkin_lists.select_related('subevent').prefetch_related("limit_products")
 
-        if self.request.GET.get("subevent", "") != "":
-            s = self.request.GET.get("subevent", "")
-            qs = qs.filter(subevent_id=s)
+        if self.filter_form.is_valid():
+            qs = self.filter_form.filter_qs(qs)
         return qs
 
     def get_context_data(self, **kwargs):
@@ -304,9 +304,14 @@ class CheckinListList(EventPermissionRequiredMixin, PaginationMixin, ListView):
             'can_change_organizer_settings',
             self.request
         )
+        ctx['filter_form'] = self.filter_form
 
         return ctx
 
+    @cached_property
+    def filter_form(self):
+        return CheckinListFilterForm(data=self.request.GET, event=self.request.event)
+
 
 class CheckinListCreate(EventPermissionRequiredMixin, CreateView):
     model = CheckinList