Add CustomLogEntry model support and update tests:

- Added support for CustomLogEntry data model to extend django-auditlog capabilities

- Updated existing test cases to align with new model structure and data handling logic

- Added new test cases to validate CustomLogEntry behavior, model registration, and signal handling

- Ensured backward compatibility with existing LogEntry model where applicable

Author: mostafaeftekharizadeh

auditlog/__init__.py

@@ -1,3 +1,25 @@
+from __future__ import annotations
+
 from importlib.metadata import version
 
+from django.apps import apps as django_apps
+from django.conf import settings
+from django.core.exceptions import ImproperlyConfigured
+
 __version__ = version("django-auditlog")
+
+
+def get_logentry_model():
+    try:
+        return django_apps.get_model(
+            settings.AUDITLOG_LOGENTRY_MODEL, require_ready=False
+        )
+    except ValueError:
+        raise ImproperlyConfigured(
+            "AUDITLOG_ENTRY_MODEL must be of the form 'app_label.model_name'"
+        )
+    except LookupError:
+        raise ImproperlyConfigured(
+            "AUDITLOG_LOGENTRY_MODEL refers to model '%s' that has not been installed"
+            % settings.AUDITLOG_LOGENTRY_MODEL
+        )

auditlog/admin.py

@@ -4,9 +4,11 @@
 from django.contrib.auth import get_user_model
 from django.utils.translation import gettext_lazy as _
 
+from auditlog import get_logentry_model
 from auditlog.filters import CIDFilter, ResourceTypeFilter
 from auditlog.mixins import LogEntryAdminMixin
-from auditlog.models import LogEntry
+
+LogEntry = get_logentry_model()
 
 
 @admin.register(LogEntry)

auditlog/conf.py

@@ -62,3 +62,7 @@
 )
 
 settings.AUDITLOG_MASK_CALLABLE = getattr(settings, "AUDITLOG_MASK_CALLABLE", None)
+
+settings.AUDITLOG_LOGENTRY_MODEL = getattr(
+    settings, "AUDITLOG_LOGENTRY_MODEL", "auditlog.LogEntry"
+)

auditlog/context.py

@@ -6,31 +6,41 @@
 from django.contrib.auth import get_user_model
 from django.db.models.signals import pre_save
 
-from auditlog.models import LogEntry
+from auditlog import get_logentry_model
 
 auditlog_value = ContextVar("auditlog_value")
 auditlog_disabled = ContextVar("auditlog_disabled", default=False)
 
 
 @contextlib.contextmanager
 def set_actor(actor, remote_addr=None, remote_port=None):
-    """Connect a signal receiver with current user attached."""
-    # Initialize thread local storage
     context_data = {
-        "signal_duid": ("set_actor", time.time()),
+        "actor": actor,
         "remote_addr": remote_addr,
         "remote_port": remote_port,
     }
+    return call_context_manager(context_data)
+
+
+@contextlib.contextmanager
+def set_extra_data(context_data):
+    return call_context_manager(context_data)
+
+
+def call_context_manager(context_data):
+    """Connect a signal receiver with current user attached."""
+    LogEntry = get_logentry_model()
+    # Initialize thread local storage
+    context_data["signal_duid"] = ("set_actor", time.time())
     auditlog_value.set(context_data)
 
     # Connect signal for automatic logging
-    set_actor = partial(
-        _set_actor,
-        user=actor,
+    set_extra_data = partial(
+        _set_extra_data,
         signal_duid=context_data["signal_duid"],
     )
     pre_save.connect(
-        set_actor,
+        set_extra_data,
         sender=LogEntry,
         dispatch_uid=context_data["signal_duid"],
         weak=False,
@@ -47,29 +57,42 @@ def set_actor(actor, remote_addr=None, remote_port=None):
             pre_save.disconnect(sender=LogEntry, dispatch_uid=auditlog["signal_duid"])
 
 
-def _set_actor(user, sender, instance, signal_duid, **kwargs):
+def _set_actor(auditlog, instance, sender):
+    LogEntry = get_logentry_model()
+    auth_user_model = get_user_model()
+    if "actor" in auditlog:
+        actor = auditlog.get("actor")
+        if (
+            sender == LogEntry
+            and isinstance(actor, auth_user_model)
+            and instance.actor is None
+        ):
+            instance.actor = actor
+            instance.actor_email = getattr(actor, "email", None)
+
+
+def _set_extra_data(sender, instance, signal_duid, **kwargs):
     """Signal receiver with extra 'user' and 'signal_duid' kwargs.
 
     This function becomes a valid signal receiver when it is curried with the actor and a dispatch id.
     """
+    LogEntry = get_logentry_model()
     try:
         auditlog = auditlog_value.get()
     except LookupError:
         pass
     else:
         if signal_duid != auditlog["signal_duid"]:
             return
-        auth_user_model = get_user_model()
-        if (
-            sender == LogEntry
-            and isinstance(user, auth_user_model)
-            and instance.actor is None
-        ):
-            instance.actor = user
-            instance.actor_email = getattr(user, "email", None)
 
-        instance.remote_addr = auditlog["remote_addr"]
-        instance.remote_port = auditlog["remote_port"]
+        _set_actor(auditlog, instance, sender)
+
+        for key in auditlog:
+            if key != "actor" and hasattr(LogEntry, key):
+                if callable(auditlog[key]):
+                    setattr(instance, key, auditlog[key]())
+                else:
+                    setattr(instance, key, auditlog[key])
 
 
 @contextlib.contextmanager

auditlog/diff.py

@@ -9,6 +9,8 @@
 from django.utils.encoding import smart_str
 from django.utils.module_loading import import_string
 
+from auditlog import get_logentry_model
+
 
 def track_field(field):
     """
@@ -21,7 +23,6 @@ def track_field(field):
     :return: Whether the given field should be tracked.
     :rtype: bool
     """
-    from auditlog.models import LogEntry
 
     # Do not track many to many relations
     if field.many_to_many:
@@ -30,7 +31,7 @@ def track_field(field):
     # Do not track relations to LogEntry
     if (
         getattr(field, "remote_field", None) is not None
-        and field.remote_field.model == LogEntry
+        and field.remote_field.model == get_logentry_model()
     ):
         return False
 

auditlog/management/commands/auditlogflush.py

@@ -3,7 +3,9 @@
 from django.core.management.base import BaseCommand
 from django.db import connection
 
-from auditlog.models import LogEntry
+from auditlog import get_logentry_model
+
+LogEntry = get_logentry_model()
 
 
 class Command(BaseCommand):

auditlog/management/commands/auditlogmigratejson.py

@@ -4,7 +4,9 @@
 from django.core.management import CommandError, CommandParser
 from django.core.management.base import BaseCommand
 
-from auditlog.models import LogEntry
+from auditlog import get_logentry_model
+
+LogEntry = get_logentry_model()
 
 
 class Command(BaseCommand):
@@ -125,8 +127,8 @@ def migrate_using_sql(self, database):
         def postgres():
             with connection.cursor() as cursor:
                 cursor.execute(
-                    """
-                    UPDATE auditlog_logentry
+                    f"""
+                    UPDATE {LogEntry._meta.db_table}
                     SET changes="changes_text"::jsonb
                     WHERE changes_text IS NOT NULL
                         AND changes_text <> ''

auditlog/middleware.py

@@ -4,7 +4,7 @@
 from django.contrib.auth import get_user_model
 
 from auditlog.cid import set_cid
-from auditlog.context import set_actor
+from auditlog.context import set_extra_data
 
 
 class AuditlogMiddleware:
@@ -56,12 +56,18 @@ def _get_actor(request):
             return user
         return None
 
+    def _get_extra_data(self, request):
+        context_data = {}
+        context_data["remote_addr"] = self._get_remote_addr(request)
+        context_data["remote_port"] = self._get_remote_port(request)
+
+        context_data["actor"] = self._get_actor(request)
+
+        return context_data
+
     def __call__(self, request):
-        remote_addr = self._get_remote_addr(request)
-        remote_port = self._get_remote_port(request)
-        user = self._get_actor(request)
 
         set_cid(request)
 
-        with set_actor(actor=user, remote_addr=remote_addr, remote_port=remote_port):
+        with set_extra_data(context_data=self._get_extra_data(request)):
             return self.get_response(request)

auditlog/mixins.py

@@ -14,10 +14,12 @@
 from django.utils.timezone import is_aware, localtime
 from django.utils.translation import gettext_lazy as _
 
-from auditlog.models import LogEntry
+from auditlog import get_logentry_model
 from auditlog.render import get_field_verbose_name, render_logentry_changes_html
 from auditlog.signals import accessed
 
+LogEntry = get_logentry_model()
+
 MAX = 75
 
 

auditlog/models.py

@@ -23,6 +23,7 @@
 from django.utils.encoding import smart_str
 from django.utils.translation import gettext_lazy as _
 
+from auditlog import get_logentry_model
 from auditlog.diff import get_mask_function
 
 DEFAULT_OBJECT_REPR = "<error forming object repr>"
@@ -303,7 +304,7 @@ def _mask_serialized_fields(
         return data
 
 
-class LogEntry(models.Model):
+class AbstractLogEntry(models.Model):
     """
     Represents an entry in the audit log. The content type is saved along with the textual and numeric
     (if available) primary key, as well as the textual representation of the object when it was saved.
@@ -392,6 +393,7 @@ class Action:
     objects = LogEntryManager()
 
     class Meta:
+        abstract = True
         get_latest_by = "timestamp"
         ordering = ["-timestamp"]
         verbose_name = _("log entry")
@@ -559,6 +561,11 @@ def _get_changes_display_for_fk_field(
             return f"Deleted '{field.related_model.__name__}' ({value})"
 
 
+class LogEntry(AbstractLogEntry):
+    class Meta(AbstractLogEntry.Meta):
+        swappable = "AUDITLOG_LOGENTRY_MODEL"
+
+
 class AuditlogHistoryField(GenericRelation):
     """
     A subclass of py:class:`django.contrib.contenttypes.fields.GenericRelation` that sets some default
@@ -579,7 +586,7 @@ class AuditlogHistoryField(GenericRelation):
     """
 
     def __init__(self, pk_indexable=True, delete_related=False, **kwargs):
-        kwargs["to"] = LogEntry
+        kwargs["to"] = get_logentry_model()
 
         if pk_indexable:
             kwargs["object_id_field"] = "object_id"