nk20/apps/logs/signals.py

183 lines
6.8 KiB
Python
Raw Normal View History

# Copyright (C) 2018-2021 by BDE ENS Paris-Saclay
2020-02-24 17:18:44 +00:00
# SPDX-License-Identifier: GPL-3.0-or-later
from django.contrib.contenttypes.models import ContentType
2020-03-10 23:41:37 +00:00
from rest_framework.renderers import JSONRenderer
from rest_framework.serializers import ModelSerializer
from note.models import NoteUser, Alias
from note_kfet.middlewares import get_current_request
2020-03-20 01:14:43 +00:00
2020-02-24 17:18:44 +00:00
from .models import Changelog
2020-03-20 01:20:13 +00:00
import getpass
2020-02-24 17:18:44 +00:00
# Ces modèles ne nécessitent pas de logs
2020-02-24 17:18:44 +00:00
EXCLUDED = [
2020-03-07 21:28:59 +00:00
'admin.logentry',
'authtoken.token',
2020-03-11 14:13:34 +00:00
'cas_server.proxygrantingticket',
'cas_server.proxyticket',
'cas_server.serviceticket',
2020-03-07 21:28:59 +00:00
'cas_server.user',
'cas_server.userattributes',
'contenttypes.contenttype',
2020-03-11 16:20:16 +00:00
'logs.changelog', # Never remove this line
2020-08-06 06:53:47 +00:00
'mailer.dontsendentry',
'mailer.message',
'mailer.messagelog',
2020-03-07 21:28:59 +00:00
'migrations.migration',
2020-03-11 16:20:16 +00:00
'note.note' # We only store the subclasses
2020-03-10 23:41:37 +00:00
'note.transaction',
2020-03-07 21:28:59 +00:00
'sessions.session',
]
2020-02-24 17:18:44 +00:00
def pre_save_object(sender, instance, **kwargs):
"""
2020-03-11 16:54:54 +00:00
Before a model get saved, we get the previous instance that is currently in the database
"""
qs = sender.objects.filter(pk=instance.pk).all()
if qs.exists():
instance._previous = qs.get()
else:
instance._previous = None
2020-02-24 17:18:44 +00:00
def save_object(sender, instance, **kwargs):
"""
2020-03-11 16:54:54 +00:00
Each time a model is saved, an entry in the table `Changelog` is added in the database
in order to store each modification made
"""
2020-02-27 14:30:16 +00:00
# noinspection PyProtectedMember
if instance._meta.label_lower in EXCLUDED or hasattr(instance, "_no_signal"):
2020-04-01 01:42:19 +00:00
return
# noinspection PyProtectedMember
previous = instance._previous
2020-02-27 12:34:38 +00:00
# Si un utilisateur est connecté, on récupère l'utilisateur courant ainsi que son adresse IP
request = get_current_request()
2020-03-07 15:45:45 +00:00
if request is None:
# Si la modification n'a pas été faite via le client Web, on suppose que c'est du à `manage.py`
# On récupère alors l'utilisateur·trice connecté·e à la VM, et on récupère la note associée
# IMPORTANT : l'utilisateur dans la VM doit être un des alias note du respo info
ip = "127.0.0.1"
username = Alias.normalize(getpass.getuser())
2020-03-10 23:41:37 +00:00
note = NoteUser.objects.filter(alias__normalized_name=username)
# if not note.exists():
# print("WARNING: A model attempted to be saved in the DB, but the actor is unknown: " + username)
# else:
if note.exists():
user = note.get().user
else:
user = None
else:
user = request.user
if 'HTTP_X_REAL_IP' in request.META:
ip = request.META.get('HTTP_X_REAL_IP')
elif 'HTTP_X_FORWARDED_FOR' in request.META:
ip = request.META.get('HTTP_X_FORWARDED_FOR').split(', ')[0]
else:
ip = request.META.get('REMOTE_ADDR')
if not user.is_authenticated:
# For registration and OAuth2 purposes
user = None
# noinspection PyProtectedMember
if request is not None and instance._meta.label_lower == "auth.user" and previous:
# On n'enregistre pas les connexions
if instance.last_login != previous.last_login:
return
2020-08-13 15:08:15 +00:00
changed_fields = '__all__'
if previous:
# On ne garde que les champs modifiés
changed_fields = []
for field in instance._meta.fields:
2020-08-15 20:54:16 +00:00
if field.name.endswith("_ptr"):
# A field ending with _ptr is a OneToOneRel with a subclass, e.g. NoteClub.note_ptr -> Note
continue
if getattr(instance, field.name) != getattr(previous, field.name):
changed_fields.append(field.name)
if len(changed_fields) == 0:
# Pas de log s'il n'y a pas de modification
return
# On crée notre propre sérialiseur JSON pour pouvoir sauvegarder les modèles avec uniquement les champs modifiés
2020-03-10 23:41:37 +00:00
class CustomSerializer(ModelSerializer):
class Meta:
model = instance.__class__
fields = changed_fields
2020-03-10 23:41:37 +00:00
previous_json = JSONRenderer().render(CustomSerializer(previous).data).decode("UTF-8") if previous else ""
instance_json = JSONRenderer().render(CustomSerializer(instance).data).decode("UTF-8")
2020-02-24 17:18:44 +00:00
Changelog.objects.create(user=user,
2020-02-27 13:47:34 +00:00
ip=ip,
model=ContentType.objects.get_for_model(instance),
instance_pk=instance.pk,
previous=previous_json,
data=instance_json,
action=("edit" if previous else "create")
2020-02-27 13:47:34 +00:00
).save()
2020-02-24 17:18:44 +00:00
2020-02-27 12:34:38 +00:00
2020-02-24 17:18:44 +00:00
def delete_object(sender, instance, **kwargs):
"""
2020-03-11 16:54:54 +00:00
Each time a model is deleted, an entry in the table `Changelog` is added in the database
"""
2020-02-27 14:30:16 +00:00
# noinspection PyProtectedMember
if instance._meta.label_lower in EXCLUDED or hasattr(instance, "_no_signal"):
2020-04-01 01:42:19 +00:00
return
# Si un utilisateur est connecté, on récupère l'utilisateur courant ainsi que son adresse IP
request = get_current_request()
2020-02-27 12:34:38 +00:00
if request is None:
# Si la modification n'a pas été faite via le client Web, on suppose que c'est du à `manage.py`
# On récupère alors l'utilisateur·trice connecté·e à la VM, et on récupère la note associée
# IMPORTANT : l'utilisateur dans la VM doit être un des alias note du respo info
ip = "127.0.0.1"
username = Alias.normalize(getpass.getuser())
note = NoteUser.objects.filter(alias__normalized_name=username)
# if not note.exists():
# print("WARNING: A model attempted to be saved in the DB, but the actor is unknown: " + username)
# else:
if note.exists():
user = note.get().user
else:
user = None
else:
user = request.user
if 'HTTP_X_REAL_IP' in request.META:
ip = request.META.get('HTTP_X_REAL_IP')
elif 'HTTP_X_FORWARDED_FOR' in request.META:
ip = request.META.get('HTTP_X_FORWARDED_FOR').split(', ')[0]
else:
ip = request.META.get('REMOTE_ADDR')
if not user.is_authenticated:
# For registration and OAuth2 purposes
user = None
2020-03-10 23:41:37 +00:00
# On crée notre propre sérialiseur JSON pour pouvoir sauvegarder les modèles
class CustomSerializer(ModelSerializer):
class Meta:
model = instance.__class__
fields = '__all__'
instance_json = JSONRenderer().render(CustomSerializer(instance).data).decode("UTF-8")
2020-03-10 23:41:37 +00:00
2020-02-24 17:18:44 +00:00
Changelog.objects.create(user=user,
2020-02-27 13:47:34 +00:00
ip=ip,
model=ContentType.objects.get_for_model(instance),
instance_pk=instance.pk,
previous=instance_json,
data="",
2020-02-27 13:47:34 +00:00
action="delete"
).save()