Add order lifecycle signals

src/pretix/base/services/orders.py

@@ -42,7 +42,9 @@ from pretix.base.services.mail import SendMailException
 from pretix.base.services.pricing import get_price
 from pretix.base.services.tasks import ProfiledTask
 from pretix.base.signals import (
-    allow_ticket_download, order_fee_calculation, order_placed, periodic_task,
+    allow_ticket_download, order_approved, order_canceled, order_changed,
+    order_denied, order_expired, order_fee_calculation, order_placed,
+    periodic_task,
 )
 from pretix.celery_app import app
 from pretix.helpers.models import modelcopy
@@ -134,55 +136,58 @@ def mark_order_refunded(order, user=None, auth=None, api_token=None):
     )
 
 
-@transaction.atomic
 def mark_order_expired(order, user=None, auth=None):
     """
     Mark this order as expired. This sets the payment status and returns the order object.
     :param order: The order to change
     :param user: The user that performed the change
     """
-    if isinstance(order, int):
-        order = Order.objects.get(pk=order)
-    if isinstance(user, int):
-        user = User.objects.get(pk=user)
-    with order.event.lock():
-        order.status = Order.STATUS_EXPIRED
-        order.save(update_fields=['status'])
+    with transaction.atomic():
+        if isinstance(order, int):
+            order = Order.objects.get(pk=order)
+        if isinstance(user, int):
+            user = User.objects.get(pk=user)
+        with order.event.lock():
+            order.status = Order.STATUS_EXPIRED
+            order.save(update_fields=['status'])
 
-    order.log_action('pretix.event.order.expired', user=user, auth=auth)
-    i = order.invoices.filter(is_cancellation=False).last()
-    if i:
-        generate_cancellation(i)
+        order.log_action('pretix.event.order.expired', user=user, auth=auth)
+        i = order.invoices.filter(is_cancellation=False).last()
+        if i:
+            generate_cancellation(i)
 
+    order_expired.send(order.event, order=order)
     return order
 
 
-@transaction.atomic
 def approve_order(order, user=None, send_mail: bool=True, auth=None):
     """
     Mark this order as approved
     :param order: The order to change
     :param user: The user that performed the change
     """
-    if not order.require_approval or not order.status == Order.STATUS_PENDING:
-        raise OrderError(_('This order is not pending approval.'))
+    with transaction.atomic():
+        if not order.require_approval or not order.status == Order.STATUS_PENDING:
+            raise OrderError(_('This order is not pending approval.'))
 
-    order.require_approval = False
-    order.set_expires(now(), order.event.subevents.filter(id__in=[p.subevent_id for p in order.positions.all()]))
-    order.save(update_fields=['require_approval', 'expires'])
+        order.require_approval = False
+        order.set_expires(now(), order.event.subevents.filter(id__in=[p.subevent_id for p in order.positions.all()]))
+        order.save(update_fields=['require_approval', 'expires'])
 
-    order.log_action('pretix.event.order.approved', user=user, auth=auth)
-    if order.total == Decimal('0.00'):
-        p = order.payments.create(
-            state=OrderPayment.PAYMENT_STATE_CREATED,
-            provider='free',
-            amount=0,
-            fee=None
-        )
-        try:
-            p.confirm(send_mail=False, count_waitinglist=False, user=user, auth=auth)
-        except Quota.QuotaExceededException:
-            raise OrderError(error_messages['unavailable'])
+        order.log_action('pretix.event.order.approved', user=user, auth=auth)
+        if order.total == Decimal('0.00'):
+            p = order.payments.create(
+                state=OrderPayment.PAYMENT_STATE_CREATED,
+                provider='free',
+                amount=0,
+                fee=None
+            )
+            try:
+                p.confirm(send_mail=False, count_waitinglist=False, user=user, auth=auth)
+            except Quota.QuotaExceededException:
+                raise OrderError(error_messages['unavailable'])
+
+    order_approved.send(order.event, order=order)
 
     invoice = order.invoices.last()  # Might be generated by plugin already
     if order.event.settings.get('invoice_generate') == 'True' and invoice_qualified(order):
@@ -234,30 +239,32 @@ def approve_order(order, user=None, send_mail: bool=True, auth=None):
     return order.pk
 
 
-@transaction.atomic
 def deny_order(order, comment='', user=None, send_mail: bool=True, auth=None):
     """
     Mark this order as canceled
     :param order: The order to change
     :param user: The user that performed the change
     """
-    if not order.require_approval or not order.status == Order.STATUS_PENDING:
-        raise OrderError(_('This order is not pending approval.'))
+    with transaction.atomic():
+        if not order.require_approval or not order.status == Order.STATUS_PENDING:
+            raise OrderError(_('This order is not pending approval.'))
 
-    with order.event.lock():
-        order.status = Order.STATUS_CANCELED
-        order.save(update_fields=['status'])
+        with order.event.lock():
+            order.status = Order.STATUS_CANCELED
+            order.save(update_fields=['status'])
 
-    order.log_action('pretix.event.order.denied', user=user, auth=auth, data={
-        'comment': comment
-    })
-    i = order.invoices.filter(is_cancellation=False).last()
-    if i:
-        generate_cancellation(i)
+        order.log_action('pretix.event.order.denied', user=user, auth=auth, data={
+            'comment': comment
+        })
+        i = order.invoices.filter(is_cancellation=False).last()
+        if i:
+            generate_cancellation(i)
 
-    for position in order.positions.all():
-        if position.voucher:
-            Voucher.objects.filter(pk=position.voucher.pk).update(redeemed=Greatest(0, F('redeemed') - 1))
+        for position in order.positions.all():
+            if position.voucher:
+                Voucher.objects.filter(pk=position.voucher.pk).update(redeemed=Greatest(0, F('redeemed') - 1))
+
+    order_denied.send(order.event, order=order)
 
     if send_mail:
         try:
@@ -294,7 +301,6 @@ def deny_order(order, comment='', user=None, send_mail: bool=True, auth=None):
     return order.pk
 
 
-@transaction.atomic
 def _cancel_order(order, user=None, send_mail: bool=True, api_token=None, device=None, oauth_application=None,
                   cancellation_fee=None):
     """
@@ -302,85 +308,87 @@ def _cancel_order(order, user=None, send_mail: bool=True, api_token=None, device
     :param order: The order to change
     :param user: The user that performed the change
     """
-    if isinstance(order, int):
-        order = Order.objects.get(pk=order)
-    if isinstance(user, int):
-        user = User.objects.get(pk=user)
-    if isinstance(api_token, int):
-        api_token = TeamAPIToken.objects.get(pk=api_token)
-    if isinstance(device, int):
-        device = Device.objects.get(pk=device)
-    if isinstance(oauth_application, int):
-        oauth_application = OAuthApplication.objects.get(pk=oauth_application)
-    if isinstance(cancellation_fee, str):
-        cancellation_fee = Decimal(cancellation_fee)
+    with transaction.atomic():
+        if isinstance(order, int):
+            order = Order.objects.get(pk=order)
+        if isinstance(user, int):
+            user = User.objects.get(pk=user)
+        if isinstance(api_token, int):
+            api_token = TeamAPIToken.objects.get(pk=api_token)
+        if isinstance(device, int):
+            device = Device.objects.get(pk=device)
+        if isinstance(oauth_application, int):
+            oauth_application = OAuthApplication.objects.get(pk=oauth_application)
+        if isinstance(cancellation_fee, str):
+            cancellation_fee = Decimal(cancellation_fee)
 
-    if not order.cancel_allowed():
-        raise OrderError(_('You cannot cancel this order.'))
-    i = order.invoices.filter(is_cancellation=False).last()
-    if i:
-        generate_cancellation(i)
+        if not order.cancel_allowed():
+            raise OrderError(_('You cannot cancel this order.'))
+        i = order.invoices.filter(is_cancellation=False).last()
+        if i:
+            generate_cancellation(i)
+
+        if cancellation_fee:
+            with order.event.lock():
+                for position in order.positions.all():
+                    if position.voucher:
+                        Voucher.objects.filter(pk=position.voucher.pk).update(redeemed=Greatest(0, F('redeemed') - 1))
+                    position.canceled = True
+                    position.save(update_fields=['canceled'])
+                for fee in order.fees.all():
+                    fee.canceled = True
+                    fee.save(update_fields=['canceled'])
+
+                f = OrderFee(
+                    fee_type=OrderFee.FEE_TYPE_CANCELLATION,
+                    value=cancellation_fee,
+                    tax_rule=order.event.settings.tax_rate_default,
+                    order=order,
+                )
+                f._calculate_tax()
+                f.save()
+
+                if order.payment_refund_sum < cancellation_fee:
+                    raise OrderError(_('The cancellation fee cannot be higher than the payment credit of this order.'))
+                order.status = Order.STATUS_PAID
+                order.total = f.value
+                order.save(update_fields=['status', 'total'])
+
+            if i:
+                generate_invoice(order)
+        else:
+            with order.event.lock():
+                order.status = Order.STATUS_CANCELED
+                order.save(update_fields=['status'])
 
-    if cancellation_fee:
-        with order.event.lock():
             for position in order.positions.all():
                 if position.voucher:
                     Voucher.objects.filter(pk=position.voucher.pk).update(redeemed=Greatest(0, F('redeemed') - 1))
-                position.canceled = True
-                position.save(update_fields=['canceled'])
-            for fee in order.fees.all():
-                fee.canceled = True
-                fee.save(update_fields=['canceled'])
 
-            f = OrderFee(
-                fee_type=OrderFee.FEE_TYPE_CANCELLATION,
-                value=cancellation_fee,
-                tax_rule=order.event.settings.tax_rate_default,
-                order=order,
-            )
-            f._calculate_tax()
-            f.save()
+        order.log_action('pretix.event.order.canceled', user=user, auth=api_token or oauth_application or device,
+                         data={'cancellation_fee': cancellation_fee})
 
-            if order.payment_refund_sum < cancellation_fee:
-                raise OrderError(_('The cancellation fee cannot be higher than the payment credit of this order.'))
-            order.status = Order.STATUS_PAID
-            order.total = f.value
-            order.save(update_fields=['status', 'total'])
-
-        if i:
-            generate_invoice(order)
-    else:
-        with order.event.lock():
-            order.status = Order.STATUS_CANCELED
-            order.save(update_fields=['status'])
-
-        for position in order.positions.all():
-            if position.voucher:
-                Voucher.objects.filter(pk=position.voucher.pk).update(redeemed=Greatest(0, F('redeemed') - 1))
-
-    order.log_action('pretix.event.order.canceled', user=user, auth=api_token or oauth_application or device,
-                     data={'cancellation_fee': cancellation_fee})
-
-    if send_mail:
-        email_template = order.event.settings.mail_text_order_canceled
-        email_context = {
-            'event': order.event.name,
-            'code': order.code,
-            'url': build_absolute_uri(order.event, 'presale:event.order', kwargs={
-                'order': order.code,
-                'secret': order.secret
-            })
-        }
-        with language(order.locale):
-            email_subject = _('Order canceled: %(code)s') % {'code': order.code}
-            try:
-                order.send_mail(
-                    email_subject, email_template, email_context,
-                    'pretix.event.order.email.order_canceled', user
-                )
-            except SendMailException:
-                logger.exception('Order canceled email could not be sent')
+        if send_mail:
+            email_template = order.event.settings.mail_text_order_canceled
+            email_context = {
+                'event': order.event.name,
+                'code': order.code,
+                'url': build_absolute_uri(order.event, 'presale:event.order', kwargs={
+                    'order': order.code,
+                    'secret': order.secret
+                })
+            }
+            with language(order.locale):
+                email_subject = _('Order canceled: %(code)s') % {'code': order.code}
+                try:
+                    order.send_mail(
+                        email_subject, email_template, email_context,
+                        'pretix.event.order.email.order_canceled', user
+                    )
+                except SendMailException:
+                    logger.exception('Order canceled email could not be sent')
 
+    order_canceled.send(order.event, order=order)
     return order.pk
 
 
@@ -1377,6 +1385,8 @@ class OrderChangeManager:
             if self.split_order:
                 self._notify_user(self.split_order)
 
+        order_changed.send(self.order.event, order=self.order)
+
     def _clear_tickets_cache(self):
         CachedTicket.objects.filter(order_position__order=self.order).delete()
         CachedCombinedTicket.objects.filter(order=self.order).delete()