Self-service refund form (#1135)

* Auto-refund

* Add missing template

* Notification for requested refund

* Model-level tests

* Add front-end tests

* Default to notify

src/pretix/control/forms/event.py

@@ -435,6 +435,39 @@ class EventSettingsForm(SettingsForm):
         )
 
 
+class CancelSettingsForm(SettingsForm):
+    cancel_allow_user = forms.BooleanField(
+        label=_("Customers can cancel their unpaid orders"),
+        required=False
+    )
+    cancel_allow_user_until = RelativeDateTimeField(
+        label=_("Do not allow cancellations after"),
+        required=False
+    )
+    cancel_allow_user_paid = forms.BooleanField(
+        label=_("Customers can cancel their paid orders"),
+        help_text=_("Paid money will be automatically paid back if the payment method allows it. "
+                    "Otherwise, a manual refund will be created for you to process manually."),
+        required=False
+    )
+    cancel_allow_user_paid_keep = forms.DecimalField(
+        label=_("Keep a fixed cancellation fee"),
+        required=False
+    )
+    cancel_allow_user_paid_keep_fees = forms.BooleanField(
+        label=_("Keep payment, shipping and service fees"),
+        required=False
+    )
+    cancel_allow_user_paid_keep_percentage = forms.DecimalField(
+        label=_("Keep a percentual cancellation fee"),
+        required=False
+    )
+    cancel_allow_user_paid_until = RelativeDateTimeField(
+        label=_("Do not allow cancellations after"),
+        required=False
+    )
+
+
 class PaymentSettingsForm(SettingsForm):
     payment_term_days = forms.IntegerField(
         label=_('Payment term in days'),

src/pretix/control/logdisplay.py

@@ -212,8 +212,10 @@ def pretixcontrol_logentry_display(sender: Event, logentry: LogEntry, **kwargs):
         'pretix.event.order.quotaexceeded': _('The order could not be marked as paid: {message}'),
         'pretix.event.order.refund.created': _('Refund {local_id} has been created.'),
         'pretix.event.order.refund.created.externally': _('Refund {local_id} has been created by an external entity.'),
+        'pretix.event.order.refund.requested': _('The customer requested you to issue a refund.'),
         'pretix.event.order.refund.done': _('Refund {local_id} has been completed.'),
         'pretix.event.order.refund.canceled': _('Refund {local_id} has been canceled.'),
+        'pretix.event.order.refund.failed': _('Refund {local_id} has failed.'),
         'pretix.control.auth.user.created': _('The user has been created.'),
         'pretix.user.settings.2fa.enabled': _('Two-factor authentication has been enabled.'),
         'pretix.user.settings.2fa.disabled': _('Two-factor authentication has been disabled.'),

src/pretix/control/navigation.py

@@ -88,6 +88,14 @@ def get_event_navigation(request: HttpRequest):
                 }),
                 'active': url.url_name == 'event.settings.invoice',
             },
+            {
+                'label': pgettext_lazy('action', 'Cancellation'),
+                'url': reverse('control:event.settings.cancel', kwargs={
+                    'event': request.event.slug,
+                    'organizer': request.event.organizer.slug,
+                }),
+                'active': url.url_name == 'event.settings.cancel',
+            },
             {
                 'label': _('Widget'),
                 'url': reverse('control:event.settings.widget', kwargs={

src/pretix/control/templates/pretixcontrol/event/cancel.html

@@ -0,0 +1,40 @@
+{% extends "pretixcontrol/event/settings_base.html" %}
+{% load i18n %}
+{% load bootstrap3 %}
+{% block inside %}
+    <h1>{% trans "Cancellation settings" %}</h1>
+    <form action="" method="post" class="form-horizontal" enctype="multipart/form-data">
+        {% csrf_token %}
+        {% bootstrap_form_errors form %}
+        <fieldset>
+            <legend>{% trans "Cancellation of unpaid or free orders" %}</legend>
+            {% bootstrap_field form.cancel_allow_user layout="control" %}
+            {% bootstrap_field form.cancel_allow_user_until layout="control" %}
+        </fieldset>
+        <fieldset>
+            <legend>{% trans "Cancellation of paid orders" %}</legend>
+            {% bootstrap_field form.cancel_allow_user_paid layout="control" %}
+            {% bootstrap_field form.cancel_allow_user_paid_keep layout="control" %}
+            {% bootstrap_field form.cancel_allow_user_paid_keep_percentage layout="control" %}
+            {% bootstrap_field form.cancel_allow_user_paid_keep_fees layout="control" %}
+            {% bootstrap_field form.cancel_allow_user_paid_until layout="control" %}
+            {% if not gets_notification %}
+                <div class="alert alert-warning">
+                    {% blocktrans trimmed %}
+                        If a user requests cancels a paid order and the money can not be refunded automatically, e.g.
+                        due to the selected payment method, you will need to take manual action. However, you have
+                        currently turned off notifications for this event.
+                    {% endblocktrans %}
+                    <a href="{% url "control:user.settings.notifications" %}" class="btn btn-default">
+                        {% trans "Change notification settings" %}
+                    </a>
+                </div>
+            {% endif %}
+        </fieldset>
+        <div class="form-group submit-group">
+            <button type="submit" class="btn btn-primary btn-save">
+                {% trans "Save" %}
+            </button>
+        </div>
+    </form>
+{% endblock %}

src/pretix/control/templates/pretixcontrol/order/index.html

@@ -150,7 +150,7 @@
                             <dd>
                                 {% for i in invoices %}
                                     <a href="{% url "control:event.invoice.download" invoice=i.pk event=request.event.slug organizer=request.event.organizer.slug %}">
-                                        {% if i.is_cancellation %}{% trans "Cancellation" %}{% else %}{% trans "Invoice" %}{% endif %}
+                                        {% if i.is_cancellation %}{% trans "Cancellation" context "invoice" %}{% else %}{% trans "Invoice" %}{% endif %}
                                         {{ i.number }}</a> ({{ i.date|date:"SHORT_DATE_FORMAT" }})
                                     {% if not i.canceled %}
                                         <form class="form-inline helper-display-inline" method="post"

src/pretix/control/urls.py

@@ -124,6 +124,7 @@ urlpatterns = [
         url(r'^settings/email/preview$', event.MailSettingsPreview.as_view(), name='event.settings.mail.preview'),
         url(r'^settings/email/layoutpreview$', event.MailSettingsRendererPreview.as_view(),
             name='event.settings.mail.preview.layout'),
+        url(r'^settings/cancel', event.CancelSettings.as_view(), name='event.settings.cancel'),
         url(r'^settings/invoice$', event.InvoiceSettings.as_view(), name='event.settings.invoice'),
         url(r'^settings/invoice/preview$', event.InvoicePreview.as_view(), name='event.settings.invoice.preview'),
         url(r'^settings/display', event.DisplaySettings.as_view(), name='event.settings.display'),

src/pretix/control/views/event.py

@@ -41,10 +41,10 @@ from pretix.base.signals import register_ticket_outputs
 from pretix.base.templatetags.money import money_filter
 from pretix.base.templatetags.rich_text import markdown_compile
 from pretix.control.forms.event import (
-    CommentForm, DisplaySettingsForm, EventDeleteForm, EventMetaValueForm,
-    EventSettingsForm, EventUpdateForm, InvoiceSettingsForm, MailSettingsForm,
-    PaymentSettingsForm, ProviderForm, QuickSetupForm,
-    QuickSetupProductFormSet, TaxRuleForm, TaxRuleLineFormSet,
+    CancelSettingsForm, CommentForm, DisplaySettingsForm, EventDeleteForm,
+    EventMetaValueForm, EventSettingsForm, EventUpdateForm,
+    InvoiceSettingsForm, MailSettingsForm, PaymentSettingsForm, ProviderForm,
+    QuickSetupForm, QuickSetupProductFormSet, TaxRuleForm, TaxRuleLineFormSet,
     TicketSettingsForm, WidgetCodeForm,
 )
 from pretix.control.permissions import EventPermissionRequiredMixin
@@ -407,6 +407,43 @@ class InvoiceSettings(EventSettingsViewMixin, EventSettingsFormView):
         })
 
 
+class CancelSettings(EventSettingsViewMixin, EventSettingsFormView):
+    model = Event
+    form_class = CancelSettingsForm
+    template_name = 'pretixcontrol/event/cancel.html'
+    permission = 'can_change_event_settings'
+
+    def get_success_url(self) -> str:
+        return reverse('control:event.settings.cancel', kwargs={
+            'organizer': self.request.event.organizer.slug,
+            'event': self.request.event.slug
+        })
+
+    def get_context_data(self, **kwargs):
+        ctx = super().get_context_data()
+        ctx['gets_notification'] = self.request.user.notifications_send and (
+            (
+                self.request.user.notification_settings.filter(
+                    event=self.request.event,
+                    action_type='pretix.event.order.refund.requested',
+                    enabled=True
+                ).exists()
+            ) or (
+                self.request.user.notification_settings.filter(
+                    event__isnull=True,
+                    action_type='pretix.event.order.refund.requested',
+                    enabled=True
+                ).exists() and not
+                self.request.user.notification_settings.filter(
+                    event=self.request.event,
+                    action_type='pretix.event.order.refund.requested',
+                    enabled=False
+                ).exists()
+            )
+        )
+        return ctx
+
+
 class InvoicePreview(EventPermissionRequiredMixin, View):
     permission = 'can_change_event_settings'
 

src/pretix/control/views/orders.py

@@ -583,51 +583,15 @@ class OrderRefundView(OrderView):
         )
 
     def choose_form(self):
-        payments = self.order.payments.filter(
-            state=OrderPayment.PAYMENT_STATE_CONFIRMED
-        )
-        for p in payments:
-            p.full_refund_possible = p.payment_provider.payment_refund_supported(p)
-            p.partial_refund_possible = p.payment_provider.payment_partial_refund_supported(p)
-            p.propose_refund = Decimal('0.00')
-            p.available_amount = p.amount - p.refunded_amount
-
-        unused_payments = set(p for p in payments if p.full_refund_possible or p.partial_refund_possible)
-
-        # Algorithm to choose which payments are to be refunded to create the least hassle
+        payments = list(self.order.payments.filter(state=OrderPayment.PAYMENT_STATE_CONFIRMED))
         if self.start_form.cleaned_data.get('mode') == 'full':
-            to_refund = full_refund = self.order.payment_refund_sum
+            full_refund = self.order.payment_refund_sum
         else:
-            to_refund = full_refund = self.start_form.cleaned_data.get('partial_amount')
-
-        while to_refund and unused_payments:
-            bigger = sorted([p for p in unused_payments if p.available_amount > to_refund],
-                            key=lambda p: p.available_amount)
-            same = [p for p in unused_payments if p.available_amount == to_refund]
-            smaller = sorted([p for p in unused_payments if p.available_amount < to_refund],
-                             key=lambda p: p.available_amount,
-                             reverse=True)
-            if same:
-                for payment in same:
-                    if payment.full_refund_possible or payment.partial_refund_possible:
-                        payment.propose_refund = payment.available_amount
-                        to_refund -= payment.available_amount
-                        unused_payments.remove(payment)
-                        break
-            elif bigger:
-                for payment in bigger:
-                    if payment.partial_refund_possible:
-                        payment.propose_refund = to_refund
-                        to_refund -= to_refund
-                        unused_payments.remove(payment)
-                        break
-            elif smaller:
-                for payment in smaller:
-                    if payment.full_refund_possible or payment.partial_refund_possible:
-                        payment.propose_refund = payment.available_amount
-                        to_refund -= payment.available_amount
-                        unused_payments.remove(payment)
-                        break
+            full_refund = self.start_form.cleaned_data.get('partial_amount')
+        proposals = self.order.propose_auto_refunds(full_refund, payments=payments)
+        to_refund = full_refund - sum(proposals.values())
+        for p in payments:
+            p.propose_refund = proposals.get(p, 0)
 
         if 'perform' in self.request.POST:
             refund_selected = Decimal('0.00')