djgentelella 0.5.0__py3-none-any.whl → 0.5.1__py3-none-any.whl

djgentelella/__init__.py

@@ -1,4 +1,4 @@
-__version__ = '0.5.0'
+__version__ = '0.5.1'
 
 if __name__ == '__main__':
     print(__version__)

djgentelella/admin.py

@@ -5,7 +5,9 @@ from djgentelella.models import MenuItem, Help, GentelellaSettings, Notification
     ChunkedUpload, Trash
 from djgentelella.models import PermissionsCategoryManagement
 from djgentelella.utils import clean_cache
-
+from django.contrib.admin.models import LogEntry
+from djgentelella.history.utils import ACTIONS
+from django.utils.translation import gettext_lazy as _
 
 class MenuAdmin(admin.ModelAdmin):
     filter_horizontal = ['permission']
@@ -38,6 +40,36 @@ class TrashAdmin(admin.ModelAdmin):
     ordering = ("-created_at",)
     search_fields = ("id",)
 
+
+class ActionFlagFilter(admin.SimpleListFilter):
+    title = _("Action")
+    parameter_name = "action_flag"
+
+    def lookups(self, request, model_admin):
+        return [(k, str(v)) for k, v in ACTIONS.items()]
+
+    def queryset(self, request, queryset):
+        val = self.value()
+        if not val:
+            return queryset
+        try:
+            return queryset.filter(action_flag=int(val))
+        except ValueError:
+            return queryset.none()
+
+class LogEntryAdmin(admin.ModelAdmin):
+    verbose_name = _("History")
+    verbose_name_plural = _("History")
+    list_display = ("id", "action_time", "user", "content_type", "object_id", "object_repr", "action_label", "change_message")
+    search_fields = ("content_type__app_label", "content_type__model", "object_id", "user__username")
+    list_filter = (
+        ActionFlagFilter,
+    )
+    def action_label(self, obj):
+        return ACTIONS.get(obj.action_flag, obj.get_action_flag_display() or obj.action_flag)
+    action_label.short_description = _("Action")
+
+
 admin.site.register(UserSignatureConfig, UserSignatureConfigAdmin)
 admin.site.register(ChunkedUpload, ChunkedUploadAdmin)
 admin.site.register(MenuItem, MenuAdmin)
@@ -46,3 +78,4 @@ admin.site.register(PermissionsCategoryManagement)
 admin.site.register(GentelellaSettings, GentelellaSettingsAdmin)
 admin.site.register(Notification, NotificationAdmin)
 admin.site.register(Trash, TrashAdmin)
+admin.site.register(LogEntry, LogEntryAdmin)

djgentelella/firmador_digital/models.py

@@ -1,49 +1,26 @@
-from django.utils.translation import gettext_lazy as _
 from django.contrib.auth import get_user_model
 from django.db import models
+from django.utils.translation import gettext_lazy as _
 
-FORMATS_DATE = [
-    ("dd/MM/yyyy hh:mm:ss a", "dd/MM/yyyy hh:mm:ss a"),
-    ("yyyy/MM/dd HH:mm:ss", "yyyy/MM/dd HH:mm:ss"),
-    ("MM/dd/yyyy hh:mm:ss a", "MM/dd/yyyy hh:mm:ss a"),
-    ("dd-MM-yyyy", "dd-MM-yyyy"),
-]
+FORMATS_DATE = [("dd/MM/yyyy hh:mm:ss a", "dd/MM/yyyy hh:mm:ss a"),
+                ("yyyy/MM/dd HH:mm:ss", "yyyy/MM/dd HH:mm:ss"),
+                ("MM/dd/yyyy hh:mm:ss a", "MM/dd/yyyy hh:mm:ss a"),
+                ("dd-MM-yyyy", "dd-MM-yyyy"), ]
 
-FONT_ALIGNMENT = (
-    ('NONE', _('None')),
-    ('RIGHT', _('Right')),
-    ('LEFT', _('Left')),
-    ('TOP', _('Top')),
-    ('BOTTOM', _('Bottom')),
-)
+FONT_ALIGNMENT = (('NONE', _('None')), ('RIGHT', _('Right')), ('LEFT', _('Left')),
+                  ('TOP', _('Top')), ('BOTTOM', _('Bottom')),)
 
 
 def get_signature_default():
-    return {
-        "backgroundColor": "transparent",
-        "cAdESLevel": "LTA",
-        "contact": "",
-        "country": "CR",
-        "dateFormat": "dd/MM/yyyy hh\:mm\:ss a",
-        "defaultSignMessage": "Esta es una representación gráfica únicamente,\nverifique la validez de la firma.",
-        "font": "Nimbus Sans Regular",
-        "fontAlignment": "None",
-        "fontColor": "000000",
-        "fontSize": "7",
-        "image": "",
-        "language": "es",
-        "pAdESLevel": "LTA",
-        "place": "",
-        "portNumber": "3516",
-        "reason": "",
-        "signHeight": "33",
-        "signWidth": "133",
-        "signX": "40",
-        "signY": "60",
-        "xAdESLevel": "LTA",
-        "isVisibleSignature": False,
-        "hideSignatureAdvice": False,
-    }
+    return {"backgroundColor": "transparent", "cAdESLevel": "LTA", "contact": "",
+            "country": "CR", "dateFormat": "dd/MM/yyyy hh:mm:ss a",
+            "defaultSignMessage": "Esta es una representación gráfica únicamente,\nverifique la validez de la firma.",
+            "font": "Nimbus Sans Regular", "fontAlignment": "None",
+            "fontColor": "000000",
+            "fontSize": "7", "image": "", "language": "es", "pAdESLevel": "LTA",
+            "place": "", "portNumber": "3516", "reason": "", "signHeight": "33",
+            "signWidth": "133", "signX": "40", "signY": "60", "xAdESLevel": "LTA",
+            "isVisibleSignature": False, "hideSignatureAdvice": False, }
 
 
 class UserSignatureConfig(models.Model):

djgentelella/history/api.py

@@ -0,0 +1,145 @@
+from djgentelella.objectmanagement import AuthAllPermBaseObjectManagement
+from django.utils.translation import gettext_lazy as _
+from djgentelella.history.utils import add_log
+from django.contrib.admin.models import LogEntry, ADDITION, CHANGE, DELETION
+from djgentelella.history.serializers import HistoryDataTableSerializer
+from djgentelella.history.filterset import HistoryFilterSet
+from rest_framework.authentication import SessionAuthentication
+from rest_framework.filters import SearchFilter, OrderingFilter
+from rest_framework.pagination import LimitOffsetPagination
+from django_filters.rest_framework import DjangoFilterBackend
+from rest_framework.response import Response
+from django.conf import settings
+from django.db.models import Q
+from django.contrib.contenttypes.models import ContentType
+
+
+
+class BaseViewSetWithLogs(AuthAllPermBaseObjectManagement):
+
+    def perform_create(self, serializer):
+        super().perform_create(serializer)
+        new_instance = serializer.instance
+
+        add_log(
+            self.request.user,
+            new_instance,
+            ADDITION,
+            new_instance._meta.verbose_name.title().lower(),
+            [],
+            change_message=_("Created"),
+        )
+
+    def perform_update(self, serializer):
+        # get the instance before the update
+        instance = self.get_object()
+        old_values = {
+            field: getattr(instance, field)
+            for field in serializer.validated_data.keys()
+        }
+
+        super().perform_update(serializer)
+
+        new_instance = serializer.instance
+        # get changed fields
+        changed_fields = []
+
+        for field in serializer.validated_data.keys():
+            old_value = old_values.get(field)
+            new_value = getattr(new_instance, field)
+            if old_value != new_value:
+                changed_fields.append(field)
+
+        add_log(
+            self.request.user,
+            new_instance,
+            CHANGE,
+            new_instance._meta.verbose_name.title().lower(),
+            changed_data=changed_fields,
+            change_message=_("Updated"),
+        )
+
+    def perform_destroy(self, instance):
+        instance = self.get_object()
+        if instance._meta.verbose_name.title() in self.models_log:
+            add_log(
+                self.request.user,
+                instance,
+                DELETION,
+                instance._meta.verbose_name.title().lower(),
+                change_message=_("Deleted"),
+            )
+
+        super().perform_destroy(instance)
+
+
+class HistoryViewSet(AuthAllPermBaseObjectManagement):
+    authentication_classes = [SessionAuthentication]
+    serializer_class = HistoryDataTableSerializer
+    queryset = LogEntry.objects.all()
+    pagination_class = LimitOffsetPagination
+    filter_backends = (DjangoFilterBackend, SearchFilter, OrderingFilter)
+    search_fields = ["object_repr"]
+    filterset_class = HistoryFilterSet
+    ordering_fields = ["-action_time"]
+    ordering = ("-action_time",)
+    perms = {"list": ["admin.view_logentry"]}
+
+    def get_queryset(self):
+        queryset = self.queryset
+
+        # check allowed models in settings
+        allowed = getattr(settings, "GT_HISTORY_ALLOWED_MODELS", None)
+
+        if allowed:
+            allowed_ctypes = self.contenttypes_from_settings(allowed)
+
+            if not allowed_ctypes.exists():
+                return queryset.none()
+
+            queryset = queryset.filter(content_type__in=allowed_ctypes).distinct()
+
+
+        # check contenttype param in form
+        ctypes_param = self.request.GET.get("contenttype")
+        print(allowed)
+        if ctypes_param and ctypes_param in allowed:
+
+            ctypes_qs = self.contenttypes_from_settings([ctypes_param])
+            print(ctypes_qs)
+
+
+            if not ctypes_qs.exists():
+                return queryset.none()
+
+            queryset = queryset.filter(content_type__in=ctypes_qs).distinct()
+
+        # default values
+        return queryset
+
+    def contenttypes_from_settings(self, entries):
+        q = Q()
+        for item in entries:
+            if isinstance(item, str) and "." in item:
+                app_label, model_name = item.split(".", 1)
+                app_label = app_label.strip()
+                model_key = model_name.strip().lower()
+                q |= Q(app_label=app_label, model=model_key)
+
+        if not q:
+            return ContentType.objects.none()
+        return ContentType.objects.filter(q)
+
+
+    def list(self, request, *args, **kwargs):
+        queryset = self.filter_queryset(self.get_queryset())
+        page = self.paginate_queryset(queryset)
+        data = page if page is not None else queryset
+
+        response = {
+            "data": data,
+            "recordsTotal": LogEntry.objects.count(),
+            "recordsFiltered": queryset.count(),
+            "draw": self.request.GET.get("draw", 1),
+        }
+        return Response(self.get_serializer(response).data)

djgentelella/history/filterset.py

@@ -0,0 +1,23 @@
+from django.contrib.admin.models import LogEntry
+from django_filters.rest_framework import FilterSet, ChoiceFilter
+from django_filters import DateTimeFromToRangeFilter
+from djgentelella.fields.drfdatetime import DateTimeRangeTextWidget
+from djgentelella.history.utils import ACTIONS
+
+class HistoryFilterSet(FilterSet):
+    action_time = DateTimeFromToRangeFilter(
+        widget=DateTimeRangeTextWidget(attrs={"placeholder": "DD/MM/YYYY/"})
+    )
+
+    action_flag = ChoiceFilter(
+        field_name="action_flag",
+        choices=[(k, str(v)) for k, v in ACTIONS.items()],  # added 4 y 5
+    )
+
+    class Meta:
+        model = LogEntry
+        fields = {
+            "object_repr": ["icontains"],
+            "change_message": ["icontains"],
+            "user": ["exact"],
+        }

djgentelella/history/serializers.py

@@ -0,0 +1,50 @@
+from django.contrib.admin.models import LogEntry
+from django.contrib.contenttypes.models import ContentType
+from django.utils.translation import gettext_lazy as _
+from rest_framework import serializers
+from djgentelella.serializers import GTDateField, GTDateTimeField
+
+
+
+class HistorySerializer(serializers.ModelSerializer):
+    user = serializers.SerializerMethodField()
+    action_flag = serializers.SerializerMethodField()
+    action_time = GTDateTimeField()
+    change_message = serializers.SerializerMethodField()
+    actions = serializers.SerializerMethodField()
+
+    def get_user(self, obj):
+        if not obj or not obj.user:
+            return _("No user found")
+        name = obj.user.get_full_name()
+        return name or obj.user.username
+
+    def get_action_flag(self, obj):
+        if obj.action_flag == 4:
+            return _("Hard deleted")
+        elif obj.action_flag == 5:
+            return _("Restored")
+
+        return obj.get_action_flag_display()
+
+    def get_change_message(self, obj):
+        return obj.change_message
+
+    def get_actions(self, obj):
+        return {
+            "create": False,
+            "update": False,
+            "destroy": False,
+        }
+
+    class Meta:
+        model = LogEntry
+        fields = "__all__"
+
+
+class HistoryDataTableSerializer(serializers.Serializer):
+    data = serializers.ListField(child=HistorySerializer(), required=True)
+    draw = serializers.IntegerField(required=True)
+    recordsFiltered = serializers.IntegerField(required=True)
+    recordsTotal = serializers.IntegerField(required=True)
+

djgentelella/history/utils.py

@@ -0,0 +1,70 @@
+from django.utils.translation import gettext_lazy as _
+from django.contrib.admin.models import LogEntry, ADDITION, CHANGE, DELETION
+from django.contrib.contenttypes.models import ContentType
+
+HARD_DELETION = 4
+RESTORE = 5
+
+ACTIONS = {
+    ADDITION: _("created"),
+    CHANGE: _("updated"),
+    DELETION: _("deleted"),
+    HARD_DELETION: _("hard deleted"),
+    RESTORE: _("restored"),
+}
+
+
+def add_log(
+    user,
+    object,
+    action_flag,
+    model_name=None,
+    changed_data=None,
+    object_repr="",
+    change_message="",
+    content_type=None,
+):
+    if content_type is None:
+        content_type = ContentType.objects.get_for_model(object)
+
+    if model_name is None:
+        model_name = object._meta.verbose_name
+
+    if not isinstance(action_flag, int):
+        raise ValueError("action_flag must be an integer")
+
+    action_label = ACTIONS.get(action_flag, str(action_flag))
+
+    if not object_repr:
+        object_repr = _("An object of model %(model)s has been %(action)s") % {
+            "model": _(str(model_name).capitalize()),
+            "action": action_label,
+        }
+
+    changed_data = changed_data or []
+
+    if change_message:
+        if action_flag != DELETION and changed_data:
+            verbose_changes = [object._meta.get_field(f).verbose_name for f in
+                               changed_data]
+
+            change_message = _("%(msg)s. Fields: %(fields)s") % {
+                "msg": change_message,
+                "fields": ", ".join(verbose_changes),
+            }
+        else: # delete, restore, hard delete
+            change_message = _("The record %(obj)s of model %(model)s has been %(action)s") % {
+                "obj": str(object),
+                "model": _(model_name),
+                "action": action_label,
+            }
+
+    LogEntry.objects.log_action(
+        user_id=user.id,
+        content_type_id=content_type.id,
+        object_id=object.pk,
+        object_repr=object_repr,
+        action_flag=action_flag,
+        change_message=change_message,
+    )
+

djgentelella/locale/es/LC_MESSAGES/django.po

@@ -673,6 +673,7 @@ msgstr "El registro fue restaurado con éxito."
 
 msgid "The registry could not be restored."
 msgstr "No se pudo restaurar el registro."
+
 msgid "Signature image"
 msgstr "Imagen de firma"
 
@@ -683,3 +684,40 @@ msgid "Image signature"
 msgstr "Imagen de firma"
 msgid "Expand"
 msgstr "Expandir"
+
+# history
+msgid "Restoration"
+msgstr "Restaurado"
+
+msgid "deleted"
+msgstr "eliminado"
+
+msgid "Hard deleted"
+msgstr "Eliminación permanente"
+
+msgid "History"
+msgstr "Historial"
+
+msgid "General"
+msgstr "General"
+
+msgid "restored"
+msgstr "restaurado"
+
+msgid "Restored"
+msgstr "Restaurado"
+
+msgid "hard deleted"
+msgstr "eliminado permanentemente"
+
+msgid "%(msg)s. Fields: %(fields)s"
+msgstr "%(msg)s. Campos: %(fields)s"
+
+msgid "The record %(obj)s of model %(model)s has been %(action)s"
+msgstr "El registro %(obj)s del modelo %(model)s ha sido %(action)s"
+
+msgid "An object of model %(model)s has been %(action)s"
+msgstr "Un objeto del modelo %(model)s ha sido %(action)s"
+
+msgid "%(obj)s in trash"
+msgstr "%(obj)s en papelera"

djgentelella/locale/es/LC_MESSAGES/djangojs.po

@@ -222,3 +222,40 @@ msgstr "El documento no está firmado digitalmente. Por favor, firme el document
 
 msgid "The document was saved"
 msgstr "El documento se ha guardado"
+
+# history
+msgid "Restoration"
+msgstr "Restaurado"
+
+msgid "deleted"
+msgstr "eliminado"
+
+msgid "Hard deleted"
+msgstr "Eliminación permanente"
+
+msgid "History"
+msgstr "Historial"
+
+msgid "General"
+msgstr "General"
+
+msgid "restored"
+msgstr "restaurado"
+
+msgid "Restored"
+msgstr "Restaurado"
+
+msgid "hard deleted"
+msgstr "eliminado permanentemente"
+
+msgid "%(msg)s. Fields: %(fields)s"
+msgstr "%(msg)s. Campos: %(fields)s"
+
+msgid "The record %(obj)s of model %(model)s has been %(action)s"
+msgstr "El registro %(obj)s del modelo %(model)s ha sido %(action)s"
+
+msgid "An object of model %(model)s has been %(action)s"
+msgstr "Un objeto del modelo %(model)s ha sido %(action)s"
+
+msgid "%(obj)s in trash"
+msgstr "%(obj)s en papelera"

djgentelella/migrations/0017_alter_chunkedupload_status.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.2.5 on 2025-08-29 23:46
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('djgentelella', '0016_trash_created_at'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='chunkedupload',
+            name='status',
+            field=models.PositiveSmallIntegerField(choices=[(1, 'Uploading'), (2, 'Complete')], default=1),
+        ),
+    ]

djgentelella/migrations/0018_alter_chunkedupload_status.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.2.5 on 2025-08-29 23:55
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('djgentelella', '0017_alter_chunkedupload_status'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='chunkedupload',
+            name='status',
+            field=models.PositiveSmallIntegerField(choices=[(1, 'Subiendo'), (2, 'Completo')], default=1),
+        ),
+    ]

djgentelella/models.py

@@ -10,6 +10,7 @@ from django.contrib.contenttypes.fields import GenericForeignKey
 from .models_manager import ObjectManager, AllObjectsManager, \
     DeletedObjectsManager
 
+from djgentelella.history.utils import add_log, ADDITION
 
 class GentelellaSettings(models.Model):
     """
@@ -161,7 +162,7 @@ class Trash(models.Model):
         verbose_name_plural = _("Trash")
 
     def __str__(self):
-        return _("Registration in trash: %(obj)s") % {"obj": self.object_repr}
+        return _("%(obj)s in trash") % {"obj": self.object_repr}
 
     def restore(self, user=None):
         obj = self.content_object
@@ -206,7 +207,7 @@ class DeletedWithTrash(models.Model):
         self.save(update_fields=["is_deleted"])
 
         # create trash instance
-        Trash.objects.get_or_create(
+        trash = Trash.objects.get_or_create(
             content_type=ContentType.objects.get_for_model(self.__class__),
             object_id=self.pk,
             defaults={