feat: add comments to revisions

This commit makes use of the reversion `set_comment` functionality.
Using comments, we can store additional information in the revisions.
That way we store the information if an object got added, if it was
updated and which fields. If another object was merged into it, we store
the original name of the other object. If an entity was created by
duplicating it, we store from which object it was duplicated.

apis_core/apis_entities/edit_generic.py

@@ -1,4 +1,5 @@
 import importlib
+import json
 
 from django.conf import settings
 from django.contrib.auth.decorators import login_required
@@ -14,6 +15,7 @@
 from django.views.generic import DeleteView
 from django_tables2 import RequestConfig
 from reversion.models import Version
+from reversion import set_comment as reversion_set_comment, create_revision
 
 from apis_core.apis_labels.models import Label
 from apis_core.apis_metainfo.models import Uri
@@ -139,6 +141,8 @@ def post(self, request, *args, **kwargs):
         form = form(request.POST, instance=self.instance)
         if form.is_valid():
             entity_2 = form.save()
+            comment = [{"changed": {"name": str(entity_2._meta.verbose_name), "object": str(entity_2), "fields": form.changed_data }}]
+            reversion_set_comment(json.dumps(comment))
             return redirect(
                 reverse(
                     "apis:apis_entities:generic_entities_edit_view",
@@ -186,6 +190,8 @@ def post(self, request, *args, **kwargs):
         form = form(request.POST)
         if form.is_valid():
             entity_2 = form.save()
+            comment = [{"added": {"name": str(entity_2._meta.verbose_name), "object": str(entity_2)}}]
+            reversion_set_comment(json.dumps(comment))
             return redirect(
                 reverse(
                     "apis:apis_entities:generic_entities_detail_view",
@@ -255,6 +261,7 @@ class GenericEntitiesDeleteView(EntityInstanceMixin, DeleteView):
     )
 
     def dispatch(self, request, *args, **kwargs):
+
         self.success_url = reverse(
             "apis_core:apis_entities:generic_entities_list",
             kwargs={"entity": self.entity},
@@ -265,9 +272,13 @@ def dispatch(self, request, *args, **kwargs):
 @method_decorator(login_required, name="dispatch")
 class GenericEntitiesDuplicateView(EntityInstanceMixin, View):
     def get(self, request, *args, **kwargs):
-        source_obj = get_object_or_404(self.entity_model, pk=self.pk)
+        with create_revision():
+            source_obj = get_object_or_404(self.entity_model, pk=self.pk)
+
+            newobj = source_obj.duplicate()
 
-        newobj = source_obj.duplicate()
+            comment = [{"added": {"name": str(newobj._meta.verbose_name), "object": str(newobj), "duplicate_from": str(source_obj)}}]
+            reversion_set_comment(json.dumps(comment))
 
         return redirect(
             reverse(

apis_core/apis_entities/models.py

@@ -1,6 +1,7 @@
 import re
 import re
 import unicodedata
+import json
 
 from django.contrib.contenttypes.models import ContentType
 from django.apps import apps
@@ -13,6 +14,7 @@
 from django.urls import reverse
 from model_utils.managers import InheritanceManager
 from django.db.models.query import QuerySet
+from reversion import set_comment as reversion_set_comment
 
 from apis_core.utils import caching
 from apis_core.utils import DateParser
@@ -322,6 +324,8 @@ def merge_with(self, entities):
         origin = self.__class__
         signals.pre_merge_with.send(sender=origin, instance=self, entities=entities)
 
+        reversion_comments = []
+
         # TODO: check if these imports can be put to top of module without
         #  causing circular import issues.
         from apis_core.apis_labels.models import Label
@@ -361,6 +365,10 @@ def merge_with(self, entities):
             TempTriple.objects.filter(obj__id=ent.id).update(obj=self)
             TempTriple.objects.filter(subj__id=ent.id).update(subj=self)
 
+            reversion_comments.append({"changed": {"name": str(self._meta.verbose_name), "object": str(self), "merged_from": str(ent) }})
+
+        reversion_set_comment(json.dumps(reversion_comments))
+
         for ent in entities:
             self.merge_fields(ent)