Allow to add a comment when cancelling an order (#2580)

src/pretix/control/forms/event.py

@@ -1075,7 +1075,7 @@ class MailSettingsForm(SettingsForm):
         'mail_text_order_free': ['event', 'order'],
         'mail_text_order_free_attendee': ['event', 'order', 'position'],
         'mail_text_order_changed': ['event', 'order'],
-        'mail_text_order_canceled': ['event', 'order'],
+        'mail_text_order_canceled': ['event', 'order', 'comment'],
         'mail_text_order_expire_warning': ['event', 'order'],
         'mail_text_order_custom_mail': ['event', 'order'],
         'mail_text_download_reminder': ['event', 'order'],

src/pretix/control/forms/orders.py

@@ -167,6 +167,12 @@ class CancelForm(ForceQuotaConfirmationForm):
         initial=True,
         required=False
     )
+    comment = forms.CharField(
+        label=_('Comment (will be sent to the user)'),
+        help_text=_('Will be included in the notification email when the respective placeholder is present in the '
+                    'configured email text.'),
+        required=False,
+    )
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)

src/pretix/control/logdisplay.py

@@ -341,7 +341,6 @@ def pretixcontrol_logentry_display(sender: Event, logentry: LogEntry, **kwargs):
         'pretix.event.order.paid': _('The order has been marked as paid.'),
         'pretix.event.order.cancellationrequest.deleted': _('The cancellation request has been deleted.'),
         'pretix.event.order.refunded': _('The order has been refunded.'),
-        'pretix.event.order.canceled': _('The order has been canceled.'),
         'pretix.event.order.reactivated': _('The order has been reactivated.'),
         'pretix.event.order.deleted': _('The test mode order {code} has been deleted.'),
         'pretix.event.order.placed': _('The order has been created.'),
@@ -532,6 +531,13 @@ def pretixcontrol_logentry_display(sender: Event, logentry: LogEntry, **kwargs):
             bleach.clean(logentry.parsed_data.get('msg'), tags=[], strip=True)
         )
 
+    if logentry.action_type == 'pretix.event.order.canceled':
+        comment = logentry.parsed_data.get('comment')
+        if comment:
+            return _('The order has been canceled (comment: "{}").').format(comment)
+        else:
+            return _('The order has been canceled.')
+
     if logentry.action_type in ('pretix.control.views.checkin.reverted', 'pretix.event.checkin.reverted'):
         if 'list' in data:
             try:

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

@@ -35,6 +35,7 @@
             {% bootstrap_field form.cancellation_fee layout='' %}
         {% endif %}
         {% bootstrap_field form.send_email layout='' %}
+        {% bootstrap_field form.comment layout='' %}
         {% if form.cancel_invoice %}
             {% bootstrap_field form.cancel_invoice layout='' %}
         {% endif %}

src/pretix/control/views/orders.py

@@ -1266,6 +1266,7 @@ class OrderTransition(OrderView):
         elif self.order.cancel_allowed() and to == 'c' and self.mark_canceled_form.is_valid():
             try:
                 cancel_order(self.order.pk, user=self.request.user,
+                             email_comment=self.mark_canceled_form.cleaned_data['comment'],
                              send_mail=self.mark_canceled_form.cleaned_data['send_email'],
                              cancel_invoice=self.mark_canceled_form.cleaned_data.get('cancel_invoice', True),
                              cancellation_fee=self.mark_canceled_form.cleaned_data.get('cancellation_fee'))