Reorganize UI for exporters (#3025)

Co-authored-by: Richard Schreiber <schreiber@rami.io>

src/pretix/control/templates/pretixcontrol/orders/export.html

@@ -4,35 +4,32 @@
 {% load order_overview %}
 {% block title %}{% trans "Data export" %}{% endblock %}
 {% block content %}
-	<h1>
+    <h1>
         {% trans "Data export" %}
-        {% if "identifier" in request.GET %}
-            <a href="?" class="btn btn-default">{% trans "Show all" %}</a>
-        {% endif %}
     </h1>
-    {% for e in exporters %}
-        <details class="panel panel-default"
-            {% if request.GET.identifier == e.identifier or request.POST.exporter == e.identifier %}open{% endif %}>
-            <summary class="panel-heading">
-                <h3 class="panel-title">
-                    {{ e.verbose_name }}
-                    <i class="fa fa-angle-down collapse-indicator"></i>
-                </h3>
-            </summary>
-            <div id="{{ e.identifier }}">
-                <div class="panel-body">
-                    <form action="{% url "control:event.orders.export.do" event=request.event.slug organizer=request.organizer.slug %}"
-                            method="post" class="form-horizontal" data-asynctask data-asynctask-download
-                            data-asynctask-long>
-                        {% csrf_token %}
-                        <input type="hidden" name="exporter" value="{{ e.identifier }}" />
-                        {% bootstrap_form e.form layout='control' %}
-                        <button class="btn btn-primary pull-right flip" type="submit">
-                            <span class="icon icon-upload"></span> {% trans "Start export" %}
-                        </button>
-                    </form>
-                </div>
-            </div>
-        </details>
+    {% regroup exporters by category as category_list %}
+    {% for c, c_ex in category_list %}
+        {% if c %}
+            <h2>{{ c }}</h2>
+        {% else %}
+            <h2>{% trans "Other exports" %}</h2>
+        {% endif %}
+        <div class="list-group large-link-group">
+            {% for e in c_ex %}
+                <a class="list-group-item" href="?identifier={{ e.identifier }}">
+                    <h4>
+                        {{ e.verbose_name }}
+                        {% if e.featured %}
+                            <span class="fa fa-star text-success" data-toggle="tooltip" title="{% trans "Recommended for new users" %}" aria-hidden="true"></span>
+                        {% endif %}
+                    </h4>
+                    {% if e.description %}
+                        <p>
+                            {{ e.description }}
+                        </p>
+                    {% endif %}
+                </a>
+            {% endfor %}
+        </div>
     {% endfor %}
 {% endblock %}

src/pretix/control/templates/pretixcontrol/orders/export_form.html

@@ -0,0 +1,30 @@
+{% extends "pretixcontrol/event/base.html" %}
+{% load i18n %}
+{% load bootstrap3 %}
+{% load order_overview %}
+{% block title %}{% trans "Data export" %}{% endblock %}
+{% block content %}
+    <h1>
+        {% trans "Data export" %}
+        {% if exporter %}
+            <small>
+                {{ exporter.verbose_name }}
+            </small>
+        {% endif %}
+    </h1>
+    {% if exporter.description %}
+        <p class="help-block">{{ exporter.description }}</p>
+    {% endif %}
+    <form action="{% url "control:event.orders.export.do" event=request.event.slug organizer=request.organizer.slug %}"
+          method="post" class="form-horizontal" data-asynctask data-asynctask-download
+          data-asynctask-long>
+        {% csrf_token %}
+        <input type="hidden" name="exporter" value="{{ exporter.identifier }}"/>
+        {% bootstrap_form exporter.form layout='control' %}
+        <div class="form-group submit-group">
+            <button type="submit" class="btn btn-primary btn-save">
+                {% trans "Start export" %}
+            </button>
+        </div>
+    </form>
+{% endblock %}

src/pretix/control/templates/pretixcontrol/organizers/export.html

@@ -4,34 +4,27 @@
 {% load order_overview %}
 {% block title %}{% trans "Data export" %}{% endblock %}
 {% block content %}
-	<h1>
+    <h1>
         {% trans "Data export" %}
-        {% if "identifier" in request.GET %}
-            <a href="?" class="btn btn-default">{% trans "Show all" %}</a>
-        {% endif %}
     </h1>
-    {% for e in exporters %}
-        <details class="panel panel-default" {% if "identifier" in request.GET or "exporter" in request.POST %}open{% endif %}>
-            <summary class="panel-heading">
-                <h3 class="panel-title">
-                    {{ e.verbose_name }}
-                    <i class="fa fa-angle-down collapse-indicator"></i>
-                </h3>
-            </summary>
-            <div id="{{ e.identifier }}">
-                <div class="panel-body">
-                    <form action="{% url "control:organizer.export.do" organizer=request.organizer.slug %}"
-                            method="post" class="form-horizontal" data-asynctask data-asynctask-download
-                            data-asynctask-long>
-                        {% csrf_token %}
-                        <input type="hidden" name="exporter" value="{{ e.identifier }}" />
-                        {% bootstrap_form e.form layout='control' %}
-                        <button class="btn btn-primary pull-right flip" type="submit">
-                            <span class="icon icon-upload"></span> {% trans "Start export" %}
-                        </button>
-                    </form>
-                </div>
-            </div>
-        </details>
+    {% regroup exporters by category as category_list %}
+    {% for c, c_ex in category_list %}
+        {% if c %}
+            <h2>{{ c }}</h2>
+        {% else %}
+            <h2>{% trans "Other exports" %}</h2>
+        {% endif %}
+        <div class="list-group large-link-group">
+            {% for e in c_ex %}
+                <a class="list-group-item" href="?identifier={{ e.identifier }}">
+                    <h4>{{ e.verbose_name }}</h4>
+                    {% if e.description %}
+                        <p>
+                            {{ e.description }}
+                        </p>
+                    {% endif %}
+                </a>
+            {% endfor %}
+        </div>
     {% endfor %}
 {% endblock %}

src/pretix/control/templates/pretixcontrol/organizers/export_form.html

@@ -0,0 +1,30 @@
+{% extends "pretixcontrol/event/base.html" %}
+{% load i18n %}
+{% load bootstrap3 %}
+{% load order_overview %}
+{% block title %}{% trans "Data export" %}{% endblock %}
+{% block content %}
+    <h1>
+        {% trans "Data export" %}
+        {% if exporter %}
+            <small>
+                {{ exporter.verbose_name }}
+            </small>
+        {% endif %}
+    </h1>
+    {% if exporter.description %}
+        <p class="help-block">{{ exporter.description }}</p>
+    {% endif %}
+    <form action="{% url "control:organizer.export.do" organizer=request.organizer.slug %}"
+          method="post" class="form-horizontal" data-asynctask data-asynctask-download
+          data-asynctask-long>
+        {% csrf_token %}
+        <input type="hidden" name="exporter" value="{{ exporter.identifier }}"/>
+        {% bootstrap_form exporter.form layout='control' %}
+        <div class="form-group submit-group">
+            <button type="submit" class="btn btn-primary btn-save">
+                {% trans "Start export" %}
+            </button>
+        </div>
+    </form>
+{% endblock %}

src/pretix/control/views/orders.py

@@ -2237,11 +2237,19 @@ class OrderGo(EventPermissionRequiredMixin, View):
 class ExportMixin:
     @cached_property
     def exporters(self):
-        exporters = []
         responses = register_data_exporters.send(self.request.event)
+        return sorted(
+            [response(self.request.event, self.request.organizer) for r, response in responses if response],
+            key=lambda ex: (0 if ex.category else 1, ex.category or "", 0 if ex.featured else 1, str(ex.verbose_name).lower())
+        )
+
+    @cached_property
+    def exporter(self):
         id = self.request.GET.get("identifier") or self.request.POST.get("exporter")
-        for ex in sorted([response(self.request.event, self.request.organizer) for r, response in responses if response], key=lambda ex: str(ex.verbose_name)):
-            if id and ex.identifier != id:
+        if not id:
+            return None
+        for ex in self.exporters:
+            if id != ex.identifier:
                 continue
 
             # Use form parse cycle to generate useful defaults
@@ -2258,12 +2266,12 @@ class ExportMixin:
                 initial=initial
             )
             ex.form.fields = ex.export_form_fields
-            exporters.append(ex)
-        return exporters
+            return ex
 
     def get_context_data(self, **kwargs):
         ctx = super().get_context_data(**kwargs)
         ctx['exporters'] = self.exporters
+        ctx['exporter'] = self.exporter
         return ctx
 
 
@@ -2288,16 +2296,6 @@ class ExportDoView(EventPermissionRequiredMixin, ExportMixin, AsyncAction, Templ
     def get_check_url(self, task_id, ajax):
         return self.request.path + '?async_id=%s&exporter=%s' % (task_id, self.exporter.identifier) + ('&ajax=1' if ajax else '')
 
-    @cached_property
-    def exporter(self):
-        if self.request.method == "POST":
-            identifier = self.request.POST.get("exporter")
-        else:
-            identifier = self.request.GET.get("exporter")
-        for ex in self.exporters:
-            if ex.identifier == identifier:
-                return ex
-
     def get(self, request, *args, **kwargs):
         if 'async_id' in request.GET and settings.HAS_CELERY:
             return self.get_result(request)
@@ -2324,7 +2322,11 @@ class ExportDoView(EventPermissionRequiredMixin, ExportMixin, AsyncAction, Templ
 
 class ExportView(EventPermissionRequiredMixin, ExportMixin, TemplateView):
     permission = 'can_view_orders'
-    template_name = 'pretixcontrol/orders/export.html'
+
+    def get_template_names(self):
+        if self.exporter:
+            return ['pretixcontrol/orders/export_form.html']
+        return ['pretixcontrol/orders/export.html']
 
 
 class RefundList(EventPermissionRequiredMixin, PaginationMixin, ListView):

src/pretix/control/views/organizer.py

@@ -1507,29 +1507,13 @@ class GiftCardUpdateView(OrganizerDetailViewMixin, OrganizerPermissionRequiredMi
 
 class ExportMixin:
     @cached_property
-    def exporters(self):
-        exporters = []
-        events = self.request.user.get_events_with_permission('can_view_orders', request=self.request).filter(
-            organizer=self.request.organizer
-        )
-        responses = register_multievent_data_exporters.send(self.request.organizer)
+    def exporter(self):
         id = self.request.GET.get("identifier") or self.request.POST.get("exporter")
-        raw_exporters = [
-            response(Event.objects.none() if issubclass(response, OrganizerLevelExportMixin) else events, self.request.organizer)
-            for r, response in responses
-            if response
-        ]
-        raw_exporters = [
-            ex for ex in raw_exporters
-            if (
-                not isinstance(ex, OrganizerLevelExportMixin) or
-                self.request.user.has_organizer_permission(self.request.organizer, ex.organizer_required_permission, self.request)
-            )
-        ]
-        for ex in sorted(raw_exporters, key=lambda ex: str(ex.verbose_name)):
-            if id and ex.identifier != id:
+        if not id:
+            return None
+        for ex in self.exporters:
+            if id != ex.identifier:
                 continue
-
             # Use form parse cycle to generate useful defaults
             test_form = ExporterForm(data=self.request.GET, prefix=ex.identifier)
             test_form.fields = ex.export_form_fields
@@ -1548,8 +1532,8 @@ class ExportMixin:
                 ex.form.fields.update([
                     ('events',
                      forms.ModelMultipleChoiceField(
-                         queryset=events,
-                         initial=events,
+                         queryset=self.events,
+                         initial=self.events,
                          widget=forms.CheckboxSelectMultiple(
                              attrs={'class': 'scrolling-multiple-choice'}
                          ),
@@ -1557,11 +1541,37 @@ class ExportMixin:
                          required=True
                      )),
                 ])
-            exporters.append(ex)
-        return exporters
+            return ex
+
+    @cached_property
+    def events(self):
+        return self.request.user.get_events_with_permission('can_view_orders', request=self.request).filter(
+            organizer=self.request.organizer
+        )
+
+    @cached_property
+    def exporters(self):
+        responses = register_multievent_data_exporters.send(self.request.organizer)
+        raw_exporters = [
+            response(Event.objects.none() if issubclass(response, OrganizerLevelExportMixin) else self.events, self.request.organizer)
+            for r, response in responses
+            if response
+        ]
+        raw_exporters = [
+            ex for ex in raw_exporters
+            if (
+                not isinstance(ex, OrganizerLevelExportMixin) or
+                self.request.user.has_organizer_permission(self.request.organizer, ex.organizer_required_permission, self.request)
+            )
+        ]
+        return sorted(
+            raw_exporters,
+            key=lambda ex: (0 if ex.category else 1, ex.category or "", 0 if ex.featured else 1, str(ex.verbose_name).lower())
+        )
 
     def get_context_data(self, **kwargs):
         ctx = super().get_context_data(**kwargs)
+        ctx['exporter'] = self.exporter
         ctx['exporters'] = self.exporters
         return ctx
 
@@ -1582,12 +1592,6 @@ class ExportDoView(OrganizerPermissionRequiredMixin, ExportMixin, AsyncAction, T
             'organizer': self.request.organizer.slug
         })
 
-    @cached_property
-    def exporter(self):
-        for ex in self.exporters:
-            if ex.identifier == self.request.POST.get("exporter"):
-                return ex
-
     def get(self, request, *args, **kwargs):
         if 'async_id' in request.GET and settings.HAS_CELERY:
             return self.get_result(request)
@@ -1621,7 +1625,10 @@ class ExportDoView(OrganizerPermissionRequiredMixin, ExportMixin, AsyncAction, T
 
 
 class ExportView(OrganizerPermissionRequiredMixin, ExportMixin, TemplateView):
-    template_name = 'pretixcontrol/organizers/export.html'
+    def get_template_names(self):
+        if self.exporter:
+            return ['pretixcontrol/organizers/export_form.html']
+        return ['pretixcontrol/organizers/export.html']
 
 
 class GateListView(OrganizerDetailViewMixin, OrganizerPermissionRequiredMixin, ListView):