Merge remote-tracking branch 'upstream/master'

Author: morlandi

README.md

@@ -59,6 +59,23 @@ Below are some of the settings you may want to use. These should be defined in y
   will be matched against the URL path.
   [Check our wiki](https://github.com/soynatan/django-easy-audit/wiki/Settings#request-auditing)
   for more details on how to use it.
+  
+* `DJANGO_EASY_AUDIT_CRUD_DIFFERENCE_CALLBACKS`
+
+  May point to a list of callables/string-paths-to-functions-classes in which the application code can determine
+  on a per CRUDEvent whether or not the application chooses to create the CRUDEvent or not. This is different
+  from the registered/unregistered settings (e.g. `DJANGO_EASY_AUDIT_UNREGISTERED_CLASSES_EXTRA`). 
+  This is meant to be for dynamic configurations where the application
+  may inspect the current save/create/delete and choose whether or not to save that into the database or ignore it.
+  
+* `DJANGO_EASY_AUDIT_USER_DB_CONSTRAINT`
+
+  Default is `True`. This is reserved for future use (does not do anything yet). The functionality provided by the 
+  setting (whether enabled or disabled) could be handled more explicitly in certain 
+  code paths (or even internally as custom model managers). For projects that separate the easyaudit database, such
+  that the tables are not on the same database as the user table, this could help with making certain queries easier.
+  Again, this doesn't do anything yet, and if it ever does, the version will be increased and the README will be
+  updated accordingly. If you keep your database together (the standard usage), you have nothing to worry about.
 
 ## What does it do
 

easyaudit/migrations/0009_auto_20180314_2225.py

@@ -20,6 +20,6 @@ class Migration(migrations.Migration):
         migrations.AlterField(
             model_name='requestevent',
             name='url',
-            field=models.TextField(db_index=True),
+            field=models.TextField(db_index=False),
         ),
     ]

easyaudit/migrations/0011_auto_20181101_1339.py

@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11 on 2018-11-01 13:39
+from __future__ import unicode_literals
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('easyaudit', '0010_repr_text'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='requestevent',
+            name='url',
+            field=models.TextField(),
+        ),
+    ]

easyaudit/migrations/0012_auto_20181018_0012.py

@@ -0,0 +1,42 @@
+# -*- coding: utf-8 -*-
+# Generated by Django 1.11.12 on 2018-10-18 00:12
+from __future__ import unicode_literals
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('easyaudit', '0011_auto_20181101_1339'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='crudevent',
+            name='user',
+            field=models.ForeignKey(blank=True, db_constraint=False, null=True, on_delete=django.db.models.deletion.SET_NULL, to=settings.AUTH_USER_MODEL),
+        ),
+        migrations.AlterField(
+            model_name='crudevent',
+            name='content_type',
+            field=models.ForeignKey(to='contenttypes.ContentType', db_constraint=False, on_delete=models.CASCADE),
+        ),
+        migrations.AlterField(
+            model_name='loginevent',
+            name='user',
+            field=models.ForeignKey(blank=True, db_constraint=False, null=True,
+                                    on_delete=django.db.models.deletion.SET_NULL,
+                                    to=settings.AUTH_USER_MODEL),
+        ),
+        migrations.AlterField(
+            model_name='requestevent',
+            name='user',
+            field=models.ForeignKey(blank=True, db_constraint=False, null=True,
+                                    on_delete=django.db.models.deletion.SET_NULL,
+                                    to=settings.AUTH_USER_MODEL),
+        ),
+
+    ]

easyaudit/models.py

@@ -21,14 +21,15 @@ class CRUDEvent(models.Model):
 
     event_type = models.SmallIntegerField(choices=TYPES)
     object_id = models.IntegerField()  # we should try to allow other ID types
-    content_type = models.ForeignKey(ContentType, on_delete=models.CASCADE)
+    content_type = models.ForeignKey(ContentType, on_delete=models.CASCADE, db_constraint=False)
     object_repr = models.TextField(null=True, blank=True)
     object_json_repr = models.TextField(null=True, blank=True)
     changed_fields = models.TextField(null=True, blank=True)
     user = models.ForeignKey(settings.AUTH_USER_MODEL, null=True,
-                             blank=True, on_delete=models.SET_NULL)
+                             blank=True, on_delete=models.SET_NULL,
+                             db_constraint=False)
     user_pk_as_string = models.CharField(max_length=255, null=True, blank=True,
-                                     help_text='String version of the user pk')
+                                         help_text='String version of the user pk')
     datetime = models.DateTimeField(auto_now_add=True)
 
     def is_create(self):
@@ -59,7 +60,7 @@ class LoginEvent(models.Model):
     login_type = models.SmallIntegerField(choices=TYPES)
     username = models.CharField(max_length=255, null=True, blank=True)
     user = models.ForeignKey(settings.AUTH_USER_MODEL, null=True, blank=True,
-                             on_delete=models.SET_NULL)
+                             on_delete=models.SET_NULL, db_constraint=False)
     remote_ip = models.CharField(max_length=50, null=True, db_index=True)
     datetime = models.DateTimeField(auto_now_add=True)
 
@@ -70,11 +71,11 @@ class Meta:
 
 
 class RequestEvent(models.Model):
-    url = models.TextField(null=False, db_index=True)
+    url = models.TextField(null=False, db_index=False)
     method = models.CharField(max_length=20, null=False, db_index=True)
     query_string = models.TextField(null=True)
     user = models.ForeignKey(settings.AUTH_USER_MODEL, null=True, blank=True,
-                             on_delete=models.SET_NULL)
+                             on_delete=models.SET_NULL, db_constraint=False)
     remote_ip = models.CharField(max_length=50, null=True, db_index=True)
     datetime = models.DateTimeField(auto_now_add=True)
 

easyaudit/settings.py

@@ -1,8 +1,7 @@
 from importlib import import_module
 
-from django.apps.registry import apps
+from django.apps import apps
 from django.conf import settings
-from django.contrib.admin.models import LogEntry
 from django.contrib.auth.models import Permission
 from django.contrib.contenttypes.models import ContentType
 from django.contrib.sessions.models import Session
@@ -31,12 +30,20 @@ def get_model_list(class_list):
 WATCH_REQUEST_EVENTS = getattr(settings, 'DJANGO_EASY_AUDIT_WATCH_REQUEST_EVENTS', True)
 REMOTE_ADDR_HEADER = getattr(settings, 'DJANGO_EASY_AUDIT_REMOTE_ADDR_HEADER', 'REMOTE_ADDR')
 
+USER_DB_CONSTRAINT = bool(getattr(settings, 'DJANGO_EASY_AUDIT_USER_DB_CONSTRAINT', True))
+
 
 # Models which Django Easy Audit will not log.
 # By default, all but some models will be audited.
 # The list of excluded models can be overwritten or extended
 # by defining the following settings in the project.
-UNREGISTERED_CLASSES = [CRUDEvent, LoginEvent, RequestEvent, Migration, LogEntry, Session, Permission, ContentType, MigrationRecorder.Migration]
+UNREGISTERED_CLASSES = [CRUDEvent, LoginEvent, RequestEvent, Migration, Session, Permission, ContentType, MigrationRecorder.Migration]
+
+# Import and unregister LogEntry class only if Django Admin app is installed
+if apps.is_installed('django.contrib.admin'):
+    from django.contrib.admin.models import LogEntry
+    UNREGISTERED_CLASSES += [LogEntry]
+
 UNREGISTERED_CLASSES = getattr(settings, 'DJANGO_EASY_AUDIT_UNREGISTERED_CLASSES_DEFAULT', UNREGISTERED_CLASSES)
 UNREGISTERED_CLASSES.extend(getattr(settings, 'DJANGO_EASY_AUDIT_UNREGISTERED_CLASSES_EXTRA', []))
 get_model_list(UNREGISTERED_CLASSES)
@@ -60,6 +67,13 @@ def get_model_list(class_list):
 UNREGISTERED_URLS.extend(getattr(settings, 'DJANGO_EASY_AUDIT_UNREGISTERED_URLS_EXTRA', []))
 
 
+# URLs which Django Easy Audit WILL log.
+# If the following setting is defined in the project,
+# only the listed URLs will be audited, and every other
+# URL will be excluded.
+REGISTERED_URLS = getattr(settings, 'DJANGO_EASY_AUDIT_REGISTERED_URLS', [])
+
+
 # By default all modules are listed in the admin.
 # This can be changed with the following settings.
 ADMIN_SHOW_MODEL_EVENTS = getattr(settings, 'DJANGO_EASY_AUDIT_ADMIN_SHOW_MODEL_EVENTS', True)

easyaudit/signals/auth_signals.py

@@ -10,7 +10,7 @@ def user_logged_in(sender, request, user, **kwargs):
         with transaction.atomic():
             login_event = LoginEvent.objects.create(login_type=LoginEvent.LOGIN,
                                      username=getattr(user, user.USERNAME_FIELD),
-                                     user=user,
+                                     user_id=getattr(user, 'id', None),
                                      remote_ip=request.META[REMOTE_ADDR_HEADER])
     except:
         pass
@@ -20,8 +20,8 @@ def user_logged_out(sender, request, user, **kwargs):
     try:
         with transaction.atomic():
             login_event = LoginEvent.objects.create(login_type=LoginEvent.LOGOUT,
-                                                    username=getattr(user, user.USERNAME_FIELD),
-                                                    user=user,
+                                                    username=getattr(user, user.USERNAME_FIELD, None),
+                                                    user_id=getattr(user, 'id', None),
                                                     remote_ip=request.META[REMOTE_ADDR_HEADER])
     except:
         pass