Initial

Author: CleitonDeLima

auditlog/__init__.py

@@ -1,3 +1,26 @@
 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():
+    """
+    Return the LogEntry model that is active in this project.
+    """
+    try:
+        return django_apps.get_model(
+            settings.AUDITLOG_LOGENTRY_MODEL, require_ready=False
+        )
+    except ValueError:
+        raise ImproperlyConfigured(
+            "AUDITLOG_LOGENTRY_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

@@ -45,3 +45,8 @@
 settings.AUDITLOG_DISABLE_REMOTE_ADDR = getattr(
     settings, "AUDITLOG_DISABLE_REMOTE_ADDR", False
 )
+
+# Swap default model
+settings.AUDITLOG_LOGENTRY_MODEL = getattr(
+    settings, "AUDITLOG_LOGENTRY_MODEL", "auditlog.LogEntry"
+)

auditlog/context.py

@@ -6,12 +6,15 @@
 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)
 
 
+LogEntry = get_logentry_model()
+
+
 @contextlib.contextmanager
 def set_actor(actor, remote_addr=None):
     """Connect a signal receiver with current user attached."""

auditlog/diff.py

@@ -20,7 +20,9 @@ def track_field(field):
     :return: Whether the given field should be tracked.
     :rtype: bool
     """
-    from auditlog.models import LogEntry
+    from auditlog import get_logentry_model
+
+    LogEntry = get_logentry_model()
 
     # Do not track many to many relations
     if field.many_to_many:

auditlog/management/commands/auditlogflush.py

@@ -2,7 +2,9 @@
 
 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):

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):

auditlog/migrations/0001_initial.py

@@ -67,6 +67,7 @@ class Migration(migrations.Migration):
                 ),
             ],
             options={
+                "swappable": "AUDITLOG_LOGENTRY_MODEL",
                 "ordering": ["-timestamp"],
                 "get_latest_by": "timestamp",
                 "verbose_name": "log entry",

auditlog/mixins.py

@@ -10,12 +10,14 @@
 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.registry import auditlog
 from auditlog.signals import accessed
 
 MAX = 75
 
+LogEntry = get_logentry_model()
+
 
 class LogEntryAdminMixin:
     request: HttpRequest

auditlog/models.py

@@ -302,17 +302,7 @@ def _mask_serialized_fields(
         return data
 
 
-class LogEntry(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.
-    It holds the action performed and the fields that were changed in the transaction.
-
-    If AuditlogMiddleware is used, the actor will be set automatically. Keep in mind that
-    editing / re-saving LogEntry instances may set the actor to a wrong value - editing LogEntry
-    instances is not recommended (and it should not be necessary).
-    """
-
+class AbstractLogEntry(models.Model):
     class Action:
         """
         The actions that Auditlog distinguishes: creating, updating and deleting objects. Viewing objects
@@ -385,6 +375,7 @@ class Action:
     objects = LogEntryManager()
 
     class Meta:
+        abstract = True
         get_latest_by = "timestamp"
         ordering = ["-timestamp"]
         verbose_name = _("log entry")
@@ -544,6 +535,21 @@ def _get_changes_display_for_fk_field(
             return f"Deleted '{field.related_model.__name__}' ({value})"
 
 
+class LogEntry(AbstractLogEntry):
+    """
+    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.
+    It holds the action performed and the fields that were changed in the transaction.
+
+    If AuditlogMiddleware is used, the actor will be set automatically. Keep in mind that
+    editing / re-saving LogEntry instances may set the actor to a wrong value - editing LogEntry
+    instances is not recommended (and it should not be necessary).
+    """
+
+    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

auditlog/receivers.py

@@ -2,11 +2,13 @@
 
 from django.conf import settings
 
+from auditlog import get_logentry_model
 from auditlog.context import auditlog_disabled
 from auditlog.diff import model_instance_diff
-from auditlog.models import LogEntry
 from auditlog.signals import post_log, pre_log
 
+LogEntry = get_logentry_model()
+
 
 def check_disable(signal_handler):
     """

auditlog/registry.py

@@ -38,7 +38,7 @@ class AuditlogModelRegistry:
     A registry that keeps track of the models that use Auditlog to track changes.
     """
 
-    DEFAULT_EXCLUDE_MODELS = ("auditlog.LogEntry", "admin.LogEntry")
+    DEFAULT_EXCLUDE_MODELS = (settings.AUDITLOG_LOGENTRY_MODEL, "admin.LogEntry")
 
     def __init__(
         self,

auditlog_tests/models.py

@@ -4,7 +4,7 @@
 from django.core.serializers.json import DjangoJSONEncoder
 from django.db import models
 
-from auditlog.models import AuditlogHistoryField
+from auditlog.models import AbstractLogEntry, AuditlogHistoryField
 from auditlog.registry import AuditlogModelRegistry, auditlog
 
 m2m_only_auditlog = AuditlogModelRegistry(create=False, update=False, delete=False)
@@ -356,6 +356,10 @@ class AutoManyRelatedModel(models.Model):
     related = models.ManyToManyField(SimpleModel)
 
 
+class CustomLogEntryModel(AbstractLogEntry):
+    pass
+
+
 auditlog.register(AltPrimaryKeyModel)
 auditlog.register(UUIDPrimaryKeyModel)
 auditlog.register(ModelPrimaryKeyModel)

auditlog_tests/test_two_step_json_migration.py

@@ -5,9 +5,11 @@
 from django.core.management import CommandError, call_command
 from django.test import TestCase, override_settings
 
-from auditlog.models import LogEntry
+from auditlog import get_logentry_model
 from auditlog_tests.models import SimpleModel
 
+LogEntry = get_logentry_model()
+
 
 class TwoStepMigrationTest(TestCase):
     def test_use_text_changes_first(self):

auditlog_tests/tests.py

@@ -27,12 +27,13 @@
 from django.utils.encoding import smart_str
 from django.utils.translation import gettext_lazy as _
 
+from auditlog import get_logentry_model
 from auditlog.admin import LogEntryAdmin
 from auditlog.cid import get_cid
 from auditlog.context import disable_auditlog, set_actor
 from auditlog.diff import model_instance_diff
 from auditlog.middleware import AuditlogMiddleware
-from auditlog.models import DEFAULT_OBJECT_REPR, LogEntry
+from auditlog.models import DEFAULT_OBJECT_REPR
 from auditlog.registry import AuditlogModelRegistry, AuditLogRegistrationError, auditlog
 from auditlog.signals import post_log, pre_log
 from auditlog_tests.fixtures.custom_get_cid import get_cid as custom_get_cid
@@ -42,6 +43,7 @@
     AutoManyRelatedModel,
     CharfieldTextfieldModel,
     ChoicesFieldModel,
+    CustomLogEntryModel,
     DateTimeFieldModel,
     JSONModel,
     ManyRelatedModel,
@@ -65,6 +67,8 @@
     UUIDPrimaryKeyModel,
 )
 
+LogEntry = get_logentry_model()
+
 
 class SimpleModelTest(TestCase):
     def setUp(self):
@@ -2733,3 +2737,15 @@ def test_get_changes_for_missing_model(self):
         history = self.obj.history.latest()
         self.assertEqual(history.changes_dict["text"][1], self.obj.text)
         self.assertEqual(history.changes_display_dict["text"][1], self.obj.text)
+
+
+class SwappableLogEntryModelTest(TestCase):
+
+    def test_log_changes(self):
+        with override_settings(
+            AUDITLOG_LOGENTRY_MODEL="auditlog_tests.CustomLogEntryModel"
+        ):
+            self.assertIsInstance(get_logentry_model(), CustomLogEntryModel)
+            obj = SimpleModel.objects.create(text="Hi!")
+            history = obj.history.latest()
+            self.assertEqual(history, CustomLogEntryModel.objects.first())