LogEntryType registry (#4235)

Move display of LogEntry details from the `logentry_display` and 
`logentry_object_link` signals to a class hierarchy based approach. 
For each action_type, an instance of a subclass of `LogEntryType` 
is registered in the `log_entry_types` registry.

Analogous to EventPluginSignal, this registry is an `EventPluginRegistry`, 
so it keeps track of the plugin the LogEntryType is defined in.

---------

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

src/pretix/plugins/badges/signals.py

@@ -26,13 +26,12 @@ from collections import defaultdict
 from django.dispatch import receiver
 from django.template.loader import get_template
 from django.urls import resolve, reverse
-from django.utils.html import escape
 from django.utils.translation import gettext_lazy as _
 
+from pretix.base.logentrytypes import EventLogEntryType, log_entry_types
 from pretix.base.models import Event, Order
 from pretix.base.signals import (
-    event_copy_data, item_copy_data, logentry_display, logentry_object_link,
-    register_data_exporters,
+    event_copy_data, item_copy_data, register_data_exporters,
 )
 from pretix.control.signals import (
     item_forms, nav_event, order_info, order_position_buttons,
@@ -173,35 +172,13 @@ def control_order_info(sender: Event, request, order: Order, **kwargs):
     return template.render(ctx, request=request)
 
 
-@receiver(signal=logentry_display, dispatch_uid="badges_logentry_display")
-def badges_logentry_display(sender, logentry, **kwargs):
-    if not logentry.action_type.startswith('pretix.plugins.badges'):
-        return
-
-    plains = {
-        'pretix.plugins.badges.layout.added': _('Badge layout created.'),
-        'pretix.plugins.badges.layout.deleted': _('Badge layout deleted.'),
-        'pretix.plugins.badges.layout.changed': _('Badge layout changed.'),
-    }
-
-    if logentry.action_type in plains:
-        return plains[logentry.action_type]
-
-
-@receiver(signal=logentry_object_link, dispatch_uid="badges_logentry_object_link")
-def badges_logentry_object_link(sender, logentry, **kwargs):
-    if not logentry.action_type.startswith('pretix.plugins.badges.layout') or not isinstance(logentry.content_object,
-                                                                                             BadgeLayout):
-        return
-
-    a_text = _('Badge layout {val}')
-    a_map = {
-        'href': reverse('plugins:badges:edit', kwargs={
-            'event': sender.slug,
-            'organizer': sender.organizer.slug,
-            'layout': logentry.content_object.id
-        }),
-        'val': escape(logentry.content_object.name),
-    }
-    a_map['val'] = '<a href="{href}">{val}</a>'.format_map(a_map)
-    return a_text.format_map(a_map)
+@log_entry_types.new_from_dict({
+    'pretix.plugins.badges.layout.added': _('Badge layout created.'),
+    'pretix.plugins.badges.layout.deleted': _('Badge layout deleted.'),
+    'pretix.plugins.badges.layout.changed': _('Badge layout changed.'),
+})
+class BadgeLogEntryType(EventLogEntryType):
+    object_type = BadgeLayout
+    object_link_wrapper = _('Badge layout {val}')
+    object_link_viewname = 'plugins:badges:edit'
+    object_link_argname = 'layout'

src/pretix/plugins/banktransfer/signals.py

@@ -25,9 +25,12 @@ from django.urls import resolve, reverse
 from django.utils.translation import gettext_lazy as _, gettext_noop
 from i18nfield.strings import LazyI18nString
 
-from pretix.base.signals import logentry_display, register_payment_providers
+from pretix.base.signals import register_payment_providers
 from pretix.control.signals import html_head, nav_event, nav_organizer
 
+from ...base.logentrytypes import (
+    ClearDataShredderMixin, OrderLogEntryType, log_entry_types,
+)
 from ...base.settings import settings_hierarkey
 from .payment import BankTransfer
 
@@ -117,13 +120,10 @@ def html_head_presale(sender, request=None, **kwargs):
         return ""
 
 
-@receiver(signal=logentry_display)
-def pretixcontrol_logentry_display(sender, logentry, **kwargs):
-    plains = {
-        'pretix.plugins.banktransfer.order.email.invoice': _('The invoice was sent to the designated email address.'),
-    }
-    if logentry.action_type in plains:
-        return plains[logentry.action_type]
+@log_entry_types.new()
+class BanktransferOrderEmailInvoiceLogEntryType(OrderLogEntryType, ClearDataShredderMixin):
+    action_type = 'pretix.plugins.banktransfer.order.email.invoice'
+    plain = _('The invoice was sent to the designated email address.')
 
 
 settings_hierarkey.add_default(

src/pretix/plugins/paypal/signals.py

@@ -22,17 +22,10 @@
 
 from django.dispatch import receiver
 
-from pretix.base.signals import logentry_display, register_payment_providers
+from pretix.base.signals import register_payment_providers
 
 
 @receiver(register_payment_providers, dispatch_uid="payment_paypal")
 def register_payment_provider(sender, **kwargs):
     from .payment import Paypal
     return Paypal
-
-
-@receiver(signal=logentry_display, dispatch_uid="paypal_logentry_display")
-def pretixcontrol_logentry_display(sender, logentry, **kwargs):
-    from pretix.plugins.paypal2.signals import pretixcontrol_logentry_display
-
-    return pretixcontrol_logentry_display(sender, logentry, **kwargs)

src/pretix/plugins/paypal2/signals.py

@@ -19,7 +19,6 @@
 # You should have received a copy of the GNU Affero General Public License along with this program.  If not, see
 # <https://www.gnu.org/licenses/>.
 #
-import json
 from collections import OrderedDict
 
 from django import forms
@@ -32,10 +31,11 @@ from django.utils.crypto import get_random_string
 from django.utils.translation import gettext_lazy as _, pgettext_lazy
 
 from pretix.base.forms import SecretKeySettingsField
+from pretix.base.logentrytypes import EventLogEntryType, log_entry_types
 from pretix.base.middleware import _merge_csp, _parse_csp, _render_csp
 from pretix.base.settings import settings_hierarkey
 from pretix.base.signals import (
-    logentry_display, register_global_settings, register_payment_providers,
+    register_global_settings, register_payment_providers,
 )
 from pretix.plugins.paypal2.payment import PaypalMethod
 from pretix.presale.signals import html_head, process_response
@@ -47,33 +47,32 @@ def register_payment_provider(sender, **kwargs):
     return [PaypalSettingsHolder, PaypalWallet, PaypalAPM]
 
 
-@receiver(signal=logentry_display, dispatch_uid="paypal2_logentry_display")
-def pretixcontrol_logentry_display(sender, logentry, **kwargs):
-    if logentry.action_type != 'pretix.plugins.paypal.event':
-        return
+@log_entry_types.new()
+class PaypalEventLogEntryType(EventLogEntryType):
+    action_type = 'pretix.plugins.paypal.event'
 
-    data = json.loads(logentry.data)
-    event_type = data.get('event_type')
-    text = None
-    plains = {
-        'PAYMENT.SALE.COMPLETED': _('Payment completed.'),
-        'PAYMENT.SALE.DENIED': _('Payment denied.'),
-        'PAYMENT.SALE.REFUNDED': _('Payment refunded.'),
-        'PAYMENT.SALE.REVERSED': _('Payment reversed.'),
-        'PAYMENT.SALE.PENDING': _('Payment pending.'),
-        'CHECKOUT.ORDER.APPROVED': pgettext_lazy('paypal', 'Order approved.'),
-        'CHECKOUT.ORDER.COMPLETED': pgettext_lazy('paypal', 'Order completed.'),
-        'PAYMENT.CAPTURE.COMPLETED': pgettext_lazy('paypal', 'Capture completed.'),
-        'PAYMENT.CAPTURE.PENDING': pgettext_lazy('paypal', 'Capture pending.'),
-    }
+    def display(self, logentry):
+        event_type = logentry.parsed_data.get('event_type')
+        text = None
+        plains = {
+            'PAYMENT.SALE.COMPLETED': _('Payment completed.'),
+            'PAYMENT.SALE.DENIED': _('Payment denied.'),
+            'PAYMENT.SALE.REFUNDED': _('Payment refunded.'),
+            'PAYMENT.SALE.REVERSED': _('Payment reversed.'),
+            'PAYMENT.SALE.PENDING': _('Payment pending.'),
+            'CHECKOUT.ORDER.APPROVED': pgettext_lazy('paypal', 'Order approved.'),
+            'CHECKOUT.ORDER.COMPLETED': pgettext_lazy('paypal', 'Order completed.'),
+            'PAYMENT.CAPTURE.COMPLETED': pgettext_lazy('paypal', 'Capture completed.'),
+            'PAYMENT.CAPTURE.PENDING': pgettext_lazy('paypal', 'Capture pending.'),
+        }
 
-    if event_type in plains:
-        text = plains[event_type]
-    else:
-        text = event_type
+        if event_type in plains:
+            text = plains[event_type]
+        else:
+            text = event_type
 
-    if text:
-        return _('PayPal reported an event: {}').format(text)
+        if text:
+            return _('PayPal reported an event: {}').format(text)
 
 
 @receiver(register_global_settings, dispatch_uid='paypal2_global_settings')

src/pretix/plugins/sendmail/signals.py

@@ -46,13 +46,16 @@ from django.utils.timezone import now
 from django.utils.translation import gettext_lazy as _
 from django_scopes import scope, scopes_disabled
 
+from pretix.base.logentrytypes import (
+    EventLogEntryType, OrderLogEntryType, log_entry_types,
+)
 from pretix.base.models import SubEvent
 from pretix.base.signals import (
-    EventPluginSignal, event_copy_data, logentry_display, periodic_task,
+    EventPluginSignal, event_copy_data, periodic_task,
 )
 from pretix.control.signals import nav_event
 from pretix.helpers import OF_SELF
-from pretix.plugins.sendmail.models import ScheduledMail
+from pretix.plugins.sendmail.models import Rule, ScheduledMail
 from pretix.plugins.sendmail.views import OrderSendView, WaitinglistSendView
 
 logger = logging.getLogger(__name__)
@@ -115,21 +118,28 @@ def control_nav_import(sender, request=None, **kwargs):
     ]
 
 
-@receiver(signal=logentry_display)
-def pretixcontrol_logentry_display(sender, logentry, **kwargs):
-    plains = {
-        'pretix.plugins.sendmail.sent': _('Mass email was sent to customers or attendees.'),
-        'pretix.plugins.sendmail.sent.waitinglist': _('Mass email was sent to waiting list entries.'),
-        'pretix.plugins.sendmail.order.email.sent': _('The order received a mass email.'),
-        'pretix.plugins.sendmail.order.email.sent.attendee': _('A ticket holder of this order received a mass email.'),
-        'pretix.plugins.sendmail.rule.added': _('An email rule was created'),
-        'pretix.plugins.sendmail.rule.changed': _('An email rule was updated'),
-        'pretix.plugins.sendmail.rule.order.email.sent': _('A scheduled email was sent to the order'),
-        'pretix.plugins.sendmail.rule.order.position.email.sent': _('A scheduled email was sent to a ticket holder'),
-        'pretix.plugins.sendmail.rule.deleted': _('An email rule was deleted'),
-    }
-    if logentry.action_type in plains:
-        return plains[logentry.action_type]
+@log_entry_types.new('pretix.plugins.sendmail.sent', _('Mass email was sent to customers or attendees.'))
+@log_entry_types.new('pretix.plugins.sendmail.sent.waitinglist', _('Mass email was sent to waiting list entries.'))
+class SendmailPluginLogEntryType(EventLogEntryType):
+    pass
+
+
+@log_entry_types.new('pretix.plugins.sendmail.order.email.sent', _('The order received a mass email.'))
+@log_entry_types.new('pretix.plugins.sendmail.order.email.sent.attendee', _('A ticket holder of this order received a mass email.'))
+class SendmailPluginOrderLogEntryType(OrderLogEntryType):
+    pass
+
+
+@log_entry_types.new('pretix.plugins.sendmail.rule.added', _('An email rule was created'))
+@log_entry_types.new('pretix.plugins.sendmail.rule.changed', _('An email rule was updated'))
+@log_entry_types.new('pretix.plugins.sendmail.rule.order.email.sent', _('A scheduled email was sent to the order'))
+@log_entry_types.new('pretix.plugins.sendmail.rule.order.position.email.sent', _('A scheduled email was sent to a ticket holder'))
+@log_entry_types.new('pretix.plugins.sendmail.rule.deleted', _('An email rule was deleted'))
+class SendmailPluginRuleLogEntryType(EventLogEntryType):
+    object_type = Rule
+    object_link_wrapper = _('Mail rule {val}')
+    object_link_viewname = 'plugins:sendmail:rule.update'
+    object_link_argname = 'rule'
 
 
 @receiver(periodic_task)

src/pretix/plugins/ticketoutputpdf/signals.py

@@ -24,10 +24,9 @@ import json
 
 from django.dispatch import receiver
 from django.template.loader import get_template
-from django.urls import reverse
-from django.utils.html import escape
 from django.utils.translation import gettext_lazy as _
 
+from pretix.base.logentrytypes import EventLogEntryType, log_entry_types
 from pretix.base.models import Event, SalesChannel
 from pretix.base.signals import (  # NOQA: legacy import
     EventPluginSignal, event_copy_data, item_copy_data, layout_text_variables,
@@ -134,38 +133,16 @@ def pdf_event_copy_data_receiver(sender, other, item_map, question_map, **kwargs
     return layout_map
 
 
-@receiver(signal=logentry_display, dispatch_uid="pretix_ticketoutputpdf_logentry_display")
-def pdf_logentry_display(sender, logentry, **kwargs):
-    if not logentry.action_type.startswith('pretix.plugins.ticketoutputpdf'):
-        return
-
-    plains = {
-        'pretix.plugins.ticketoutputpdf.layout.added': _('Ticket layout created.'),
-        'pretix.plugins.ticketoutputpdf.layout.deleted': _('Ticket layout deleted.'),
-        'pretix.plugins.ticketoutputpdf.layout.changed': _('Ticket layout changed.'),
-    }
-
-    if logentry.action_type in plains:
-        return plains[logentry.action_type]
-
-
-@receiver(signal=logentry_object_link, dispatch_uid="pretix_ticketoutputpdf_logentry_object_link")
-def pdf_logentry_object_link(sender, logentry, **kwargs):
-    if not logentry.action_type.startswith('pretix.plugins.ticketoutputpdf.layout') or not isinstance(
-            logentry.content_object, TicketLayout):
-        return
-
-    a_text = _('Ticket layout {val}')
-    a_map = {
-        'href': reverse('plugins:ticketoutputpdf:edit', kwargs={
-            'event': sender.slug,
-            'organizer': sender.organizer.slug,
-            'layout': logentry.content_object.id
-        }),
-        'val': escape(logentry.content_object.name),
-    }
-    a_map['val'] = '<a href="{href}">{val}</a>'.format_map(a_map)
-    return a_text.format_map(a_map)
+@log_entry_types.new_from_dict({
+    'pretix.plugins.ticketoutputpdf.layout.added': _('Ticket layout created.'),
+    'pretix.plugins.ticketoutputpdf.layout.deleted': _('Ticket layout deleted.'),
+    'pretix.plugins.ticketoutputpdf.layout.changed': _('Ticket layout changed.'),
+})
+class PdfTicketLayoutLogEntryType(EventLogEntryType):
+    object_type = TicketLayout
+    object_link_wrapper = _('Ticket layout {val}')
+    object_link_viewname = 'plugins:ticketoutputpdf:edit'
+    object_link_argname = 'layout'
 
 
 def _ticket_layouts_for_item(request, item):