Source code for pretalx.common.models.log

import json
import logging
from contextlib import suppress

from django.contrib.contenttypes.fields import GenericForeignKey
from django.contrib.contenttypes.models import ContentType
from django.db import models
from django.utils.functional import cached_property
from django_scopes import ScopedManager

[docs] class ActivityLog(models.Model): """This model logs actions within an event. It is **not** designed to provide a complete or reliable audit trail. :param is_orga_action: True, if the logged action was performed by a privileged user. """ event = models.ForeignKey( to="event.Event", on_delete=models.PROTECT, related_name="log_entries", null=True, blank=True, ) person = models.ForeignKey( to="person.User", on_delete=models.PROTECT, related_name="log_entries", null=True, blank=True, ) content_type = models.ForeignKey(to=ContentType, on_delete=models.CASCADE) object_id = models.PositiveIntegerField(db_index=True) content_object = GenericForeignKey("content_type", "object_id") timestamp = models.DateTimeField(auto_now_add=True, db_index=True) action_type = models.CharField(max_length=200) data = models.TextField(null=True, blank=True) is_orga_action = models.BooleanField(default=False) objects = ScopedManager(event="event") class Meta: ordering = ("-timestamp",) def __str__(self): """Custom __str__ to help with debugging.""" event = getattr(self.event, "slug", "None") person = getattr(self.person, "name", "None") return f"ActivityLog(event={event}, person={person}, content_object={self.content_object}, action_type={self.action_type})" @cached_property def json_data(self): if with suppress(json.JSONDecodeError): return json.loads( return {} @cached_property def display(self): from pretalx.common.signals import activitylog_display for _receiver, response in activitylog_display.send( self.event, activitylog=self ): if response: return response logger = logging.getLogger(__name__) logger.warning(f'Unknown log action "{self.action_type}".') return self.action_type @cached_property def display_object(self) -> str: """Returns a link (formatted HTML) to the object in question.""" from pretalx.common.signals import activitylog_object_link if not self.content_object: return "" responses = activitylog_object_link.send(sender=self.event, activitylog=self) if responses: for _receiver, response in responses: if response: return response return ""