accrete 0.0.111__tar.gz → 0.0.113__tar.gz

{accrete-0.0.111 → accrete-0.0.113}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: accrete
-Version: 0.0.111
+Version: 0.0.113
 Summary: Django Shared Schema Multi Tenant
 Author-email: Benedikt Jilek <benedikt.jilek@pm.me>
 License: Copyright (c) 2023 Benedikt Jilek

accrete-0.0.113/accrete/contrib/log/admin.py

@@ -0,0 +1,43 @@
+import django.apps
+from django.contrib import admin
+from django import forms
+from . import models
+
+installed_models = django.apps.apps.get_models(
+    include_auto_created=True, include_swapped=True
+)
+model_choices = [(
+    f'{m._meta.app_label}.{m._meta.model_name}',
+    f'{m._meta.app_label}.{m._meta.verbose_name}'
+) for m in installed_models]
+
+
+class LogConfigForm(forms.ModelForm):
+
+    model = forms.ChoiceField(choices=model_choices)
+
+
+class LogConfigFieldInLine(admin.TabularInline):
+
+    model = models.LogConfigField
+
+
+class LogConfigAdmin(admin.ModelAdmin):
+
+    model = models.LogConfig
+    list_display = ('model', 'ignore_errors')
+    search_fields = ('pk', 'model')
+    list_filter = ['ignore_errors']
+    form = LogConfigForm
+    inlines = [LogConfigFieldInLine]
+
+    def formfield_for_choice_field(self, db_field, request, **kwargs):
+        if db_field.name == "model":
+            kwargs["choices"] = [
+                ("accepted", "Accepted"),
+                ("denied", "Denied"),
+            ]
+        return super().formfield_for_choice_field(db_field, request, **kwargs)
+
+
+admin.site.register(models.LogConfig, LogConfigAdmin)

accrete-0.0.113/accrete/contrib/log/apps.py

@@ -0,0 +1,13 @@
+from django.apps import AppConfig
+from django.db.models.signals import post_save
+
+
+class LogConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'accrete.contrib.log'
+
+    def ready(self):
+        from . import signals
+        post_save.connect(
+            signals.create_log, weak=False, dispatch_uid="accrete.contrib.log"
+        )

accrete-0.0.113/accrete/contrib/log/helper.py

@@ -0,0 +1,79 @@
+from django.db import models
+from django.db.models.query import RawQuerySet
+from django.forms import model_to_dict
+
+from .models import Log, LogConfig
+
+TYPES_FK = ['AutoField', 'BigAutoField', 'ForeignKey']
+TYPES_INT = ['IntegerField', 'PositiveSmallIntegerField']
+TYPES_DECIMAL = ['DecimalField']
+TYPES_FLOAT = ['FloatField']
+TYPES_STR = ['CharField', 'TextField']
+TYPES_BOOL = ['BooleanField']
+TYPES_DATETIME = ['DateTimeField']
+TYPES_DATE = ['DateField']
+TYPES_TIME = ['TimeField']
+
+
+def internal_type_to_log_type(field: models.Field):
+    internal_type = field.get_internal_type()
+    if internal_type in TYPES_FK:
+        return 'fk'
+    if internal_type in TYPES_INT:
+        return 'int'
+    if internal_type in TYPES_FLOAT:
+        return 'float'
+    if internal_type in TYPES_DECIMAL:
+        return 'decimal'
+    if internal_type in TYPES_BOOL:
+        return 'bool'
+    if internal_type in TYPES_STR:
+        return 'str'
+    if internal_type in TYPES_DATE:
+        return 'date'
+    if internal_type in TYPES_DATETIME:
+        return 'datetime'
+
+
+def log_state_to_dict(logs: RawQuerySet) -> tuple[dict, dict]:
+    state = dict()
+    info = dict()
+    if not logs:
+        return state, info
+    for log in logs:
+        state.update({log.field: log.cast_value()})
+        info.update({log.field: {'new_value_type': log.new_value_type}})
+    return state, info
+
+
+def log_value_to_instance_value(log: Log):
+    if log.new_value_type == 'bool':
+        return bool(log.new_value == 'True')
+
+    if log.new_value == '':
+        return None
+    if log.new_value_type in ['fk', 'int']:
+        return int(log.new_value)
+
+
+def get_instance_state(instance: models.Model):
+    state = model_to_dict(instance)
+    cleaned_state = dict()
+    log_config = LogConfig.objects.filter(
+        model=f'{instance._meta.app_label}.{instance._meta.model_name}'
+    ).prefetch_related('fields').first()
+    if not log_config:
+        return cleaned_state
+    all_fields = list(map(lambda x: x.name, instance._meta.get_fields()))
+    if log_config.exclude_fields:
+        fields_to_log = list(f for f in all_fields if f not in log_config.fields.all().values_list('field_name', flat=True))
+    else:
+        fields_to_log = log_config.fields.all().values_list('field_name', flat=True)
+
+    for f, v in state.items():
+        if isinstance(v, (list, tuple, dict)):
+            continue
+        if f not in fields_to_log:
+            continue
+        cleaned_state.update({f: v})
+    return cleaned_state

accrete-0.0.113/accrete/contrib/log/migrations/0001_initial.py

@@ -0,0 +1,38 @@
+# Generated by Django 5.1.1 on 2025-01-08 20:04
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ('accrete', '0002_initial'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Log',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('model', models.CharField(help_text='Combination of app label and model name seperated by a dot', max_length=255, verbose_name='Model')),
+                ('field', models.CharField(max_length=255, verbose_name='Field')),
+                ('object_id', models.BigIntegerField(verbose_name='Object ID')),
+                ('log_date', models.DateTimeField(auto_now_add=True, verbose_name='Date')),
+                ('old_value_type', models.CharField(choices=[('fk', 'Foreign Key'), ('int', 'Integer'), ('float', 'Float'), ('decimal', 'Decimal'), ('bool', 'Boolean'), ('str', 'String')], max_length=100, verbose_name='Old Value Type')),
+                ('new_value_type', models.CharField(choices=[('fk', 'Foreign Key'), ('int', 'Integer'), ('float', 'Float'), ('decimal', 'Decimal'), ('bool', 'Boolean'), ('str', 'String')], max_length=100, verbose_name='New Value Type')),
+                ('old_value', models.TextField(blank=True, null=True, verbose_name='Old Value')),
+                ('new_value', models.TextField(blank=True, null=True, verbose_name='New Value')),
+                ('tenant', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='accrete.tenant', verbose_name='Tenant')),
+            ],
+            options={
+                'verbose_name': 'Log',
+                'verbose_name_plural': 'Logs',
+                'db_table': 'accrete_log',
+                'indexes': [models.Index(fields=['model', 'object_id'], name='accrete_log_model_cf888c_idx')],
+                'constraints': [models.UniqueConstraint(fields=('model', 'field', 'object_id', 'log_date'), name='unique_group_fields')],
+            },
+        ),
+    ]

accrete-0.0.113/accrete/contrib/log/migrations/0002_log_user_alter_log_new_value_type_and_more.py

@@ -0,0 +1,31 @@
+# Generated by Django 5.1.1 on 2025-01-10 07:56
+
+import django.db.models.deletion
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('log', '0001_initial'),
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='log',
+            name='user',
+            field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.SET_NULL, related_name='logs', to=settings.AUTH_USER_MODEL),
+        ),
+        migrations.AlterField(
+            model_name='log',
+            name='new_value_type',
+            field=models.CharField(choices=[('fk', 'Foreign Key'), ('int', 'Integer'), ('float', 'Float'), ('decimal', 'Decimal'), ('bool', 'Boolean'), ('str', 'String'), ('date', 'Date'), ('datetime', 'Date Time')], max_length=100, verbose_name='New Value Type'),
+        ),
+        migrations.AlterField(
+            model_name='log',
+            name='old_value_type',
+            field=models.CharField(choices=[('fk', 'Foreign Key'), ('int', 'Integer'), ('float', 'Float'), ('decimal', 'Decimal'), ('bool', 'Boolean'), ('str', 'String'), ('date', 'Date'), ('datetime', 'Date Time')], max_length=100, verbose_name='Old Value Type'),
+        ),
+    ]

accrete-0.0.113/accrete/contrib/log/migrations/0003_alter_log_tenant.py

@@ -0,0 +1,20 @@
+# Generated by Django 5.1.1 on 2025-01-10 08:02
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('accrete', '0003_remove_member_name'),
+        ('log', '0002_log_user_alter_log_new_value_type_and_more'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='log',
+            name='tenant',
+            field=models.ForeignKey(blank=True, null=True, on_delete=django.db.models.deletion.CASCADE, to='accrete.tenant', verbose_name='Tenant'),
+        ),
+    ]

accrete-0.0.113/accrete/contrib/log/migrations/0004_logconfig_logconfigfield.py

@@ -0,0 +1,47 @@
+# Generated by Django 5.1.1 on 2025-01-10 15:20
+
+import django.db.models.deletion
+import django.db.models.functions.text
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('log', '0003_alter_log_tenant'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='LogConfig',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('model', models.CharField(help_text='Combination of app label and model name seperated by a dot', max_length=255, verbose_name='Model')),
+                ('ignore_errors', models.BooleanField(default=False, help_text='IF true, exceptions during log creation will be ignored', verbose_name='Ignore Errors')),
+            ],
+            options={
+                'verbose_name': 'Log Configuration',
+                'verbose_name_plural': 'Log Configs',
+                'db_table': 'accrete_log_config',
+                'ordering': [django.db.models.functions.text.Lower('model')],
+                'indexes': [models.Index(fields=['model'], name='accrete_log_model_a89071_idx')],
+                'constraints': [models.UniqueConstraint(fields=('model',), name='unique_model')],
+            },
+        ),
+        migrations.CreateModel(
+            name='LogConfigField',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('field_name', models.CharField(help_text='Name of the field to log', max_length=255, verbose_name='Field Name')),
+                ('log_config', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='log.logconfig', verbose_name='Log Configuration')),
+            ],
+            options={
+                'verbose_name': 'Log Configuration Field',
+                'verbose_name_plural': 'Log Configuration Fields',
+                'db_table': 'accrete_log_config_field',
+                'ordering': [django.db.models.functions.text.Lower('field_name')],
+                'indexes': [models.Index(fields=['log_config'], name='accrete_log_log_con_22f45e_idx')],
+                'constraints': [models.UniqueConstraint(fields=('log_config', 'field_name'), name='unique_config_field_name')],
+            },
+        ),
+    ]

accrete-0.0.113/accrete/contrib/log/migrations/0005_logconfig_exclude_fields_and_more.py

@@ -0,0 +1,29 @@
+# Generated by Django 5.1.1 on 2025-01-12 09:24
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('log', '0004_logconfig_logconfigfield'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='logconfig',
+            name='exclude_fields',
+            field=models.BooleanField(default=False, help_text='If set, Log Configuration Fields will be excluded from logging. Otherwise only configured fields will be logged.', verbose_name='Exclude Fields'),
+        ),
+        migrations.AlterField(
+            model_name='logconfig',
+            name='ignore_errors',
+            field=models.BooleanField(default=False, help_text='If set, exceptions during log creation will be ignored', verbose_name='Ignore Errors'),
+        ),
+        migrations.AlterField(
+            model_name='logconfigfield',
+            name='log_config',
+            field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='fields', to='log.logconfig', verbose_name='Log Configuration'),
+        ),
+    ]

accrete-0.0.113/accrete/contrib/log/models.py

@@ -0,0 +1,229 @@
+from decimal import Decimal
+from datetime import date, datetime
+
+from django.conf import settings
+from django.db.models.functions import Lower
+from django.utils.translation import gettext_lazy as _
+from django.db import models
+
+
+class Log(models.Model):
+
+    class Meta:
+        verbose_name = _('Log')
+        verbose_name_plural = _('Logs')
+        db_table = 'accrete_log'
+        indexes = [
+            models.Index(fields=['model', 'object_id'])
+        ]
+        constraints = [
+            models.UniqueConstraint(
+                name='unique_group_fields',
+                fields=('model', 'field', 'object_id', 'log_date')
+            )
+        ]
+
+    tenant = models.ForeignKey(
+        verbose_name=_('Tenant'),
+        to='accrete.Tenant',
+        on_delete=models.CASCADE,
+        null=True,
+        blank=True
+    )
+
+    model = models.CharField(
+        verbose_name=_('Model'),
+        max_length=255,
+        help_text='Combination of app label and model name seperated by a dot'
+    )
+
+    field = models.CharField(
+        verbose_name=_('Field'),
+        max_length=255
+    )
+
+    object_id = models.BigIntegerField(
+        verbose_name='Object ID'
+    )
+
+    log_date = models.DateTimeField(
+        verbose_name=_('Date'),
+        auto_now_add=True
+    )
+
+    old_value_type = models.CharField(
+        verbose_name=_('Old Value Type'),
+        choices=[
+            ('fk', 'Foreign Key'),
+            ('int', 'Integer'),
+            ('float', 'Float'),
+            ('decimal', 'Decimal'),
+            ('bool', 'Boolean'),
+            ('str', 'String'),
+            ('date', 'Date'),
+            ('datetime', 'Date Time')
+        ],
+        max_length=100,
+    )
+
+    new_value_type = models.CharField(
+        verbose_name=_('New Value Type'),
+        choices=[
+            ('fk', 'Foreign Key'),
+            ('int', 'Integer'),
+            ('float', 'Float'),
+            ('decimal', 'Decimal'),
+            ('bool', 'Boolean'),
+            ('str', 'String'),
+            ('date', 'Date'),
+            ('datetime', 'Date Time')
+        ],
+        max_length=100
+    )
+
+    old_value = models.TextField(
+        verbose_name=_('Old Value'),
+        null=True,
+        blank=True
+    )
+
+    new_value = models.TextField(
+        verbose_name=_('New Value'),
+        null=True,
+        blank=True
+    )
+
+    user = models.ForeignKey(
+        to=settings.AUTH_USER_MODEL,
+        related_name='logs',
+        on_delete=models.SET_NULL,
+        null=True,
+        blank=True
+    )
+
+    def __str__(self):
+        return f'{self.model}.{self.field},{self.object_id}'
+
+    def cast_value(self):
+        if self.new_value is None:
+            return None
+        if self.new_value_type == 'fk':
+            return self.cast_fk()
+        if self.new_value_type == 'int':
+            return self.cast_int()
+        if self.new_value_type == 'float':
+            return self.cast_float()
+        if self.new_value_type == 'decimal':
+            return self.cast_decimal()
+        if self.new_value_type == 'bool':
+            return self.cast_bool()
+        if self.new_value_type == 'str':
+            return self.cast_str()
+        if self.new_value_type == 'date':
+            return self.cast_date()
+        if self.new_value_type == 'datetime':
+            return self.cast_date_time()
+
+    def cast_fk(self):
+        return self.cast_int()
+
+    def cast_int(self):
+        if self.new_value == '':
+            return None
+        return int(self.new_value)
+
+    def cast_float(self):
+        if self.new_value == '':
+            return 0.0
+        return float(self.new_value)
+
+    def cast_decimal(self):
+        if self.new_value == '':
+            return Decimal(0)
+        return Decimal(self.new_value)
+
+    def cast_bool(self):
+        return self.new_value == 'True'
+
+    def cast_str(self):
+        return self.new_value
+
+    def cast_date(self):
+        if self.new_value == '':
+            return None
+        return date.fromisoformat(str(self.new_value))
+
+    def cast_date_time(self):
+        if self.new_value == '':
+            return None
+        return datetime.fromisoformat(self.new_value)
+
+
+class LogConfig(models.Model):
+
+    class Meta:
+        verbose_name = _('Log Configuration')
+        verbose_name_plural = _('Log Configs')
+        db_table = 'accrete_log_config'
+        ordering = [Lower('model')]
+        indexes = [
+            models.Index(fields=['model'])
+        ]
+        constraints = [
+            models.UniqueConstraint(
+                name='unique_model',
+                fields=('model',)
+            )
+        ]
+
+    model = models.CharField(
+        verbose_name=_('Model'),
+        max_length=255,
+        help_text=_('Combination of app label and model name seperated by a dot')
+    )
+
+    ignore_errors = models.BooleanField(
+        verbose_name=_('Ignore Errors'),
+        default=False,
+        help_text=_('If set, exceptions during log creation will be ignored')
+    )
+
+    exclude_fields = models.BooleanField(
+        verbose_name=_('Exclude Fields'),
+        default=False,
+        help_text=_(
+            'If set, Log Configuration Fields will be excluded from logging. '
+            'Otherwise only configured fields will be logged.'
+        )
+    )
+
+
+class LogConfigField(models.Model):
+
+    class Meta:
+        verbose_name = _('Log Configuration Field')
+        verbose_name_plural = _('Log Configuration Fields')
+        db_table = 'accrete_log_config_field'
+        ordering = [Lower('field_name')]
+        indexes = [
+            models.Index(fields=['log_config'])
+        ]
+        constraints = [
+            models.UniqueConstraint(
+                name='unique_config_field_name',
+                fields=('log_config', 'field_name')
+            )
+        ]
+
+    log_config = models.ForeignKey(
+        verbose_name=_('Log Configuration'),
+        to='log.LogConfig',
+        related_name='fields',
+        on_delete=models.CASCADE
+    )
+
+    field_name = models.CharField(
+        verbose_name=_('Field Name'),
+        max_length=255,
+        help_text=_('Name of the field to log')
+    )

accrete-0.0.113/accrete/contrib/log/queries.py

@@ -0,0 +1,34 @@
+from .models import Log
+from accrete.tenant import get_tenant
+
+
+def current_log_state(model: str, object_id: int):
+    tenant = get_tenant()
+    tenant_id = tenant and tenant.id or None
+    logs = Log.objects.raw("""
+        SELECT
+            log_value.id,
+            log_value.model,
+            log_value.field,
+            log_value.object_id,
+            log_value.log_date,
+            log_value.old_value_type,
+            log_value.new_value_type,
+            log_value.old_value,
+            log_value.new_value
+        FROM (
+            SELECT model, field, object_id, MAX(log_date) AS log_date
+            FROM accrete_log
+            WHERE
+                model = %s AND
+                object_id = %s AND
+                tenant_id = %s
+            GROUP BY model, field, object_id
+        ) log_result
+        JOIN accrete_log log_value ON
+            log_value.model = log_result.model AND
+            log_value.field = log_result.field AND
+            log_value.object_id = log_result.object_id AND
+            log_result.log_date = log_value.log_date;
+    """, [model, object_id, tenant_id])
+    return logs

accrete-0.0.113/accrete/contrib/log/signals.py

@@ -0,0 +1,62 @@
+import logging
+
+from django.db import models
+
+from accrete.tenant import get_member, get_tenant
+from accrete.utils.log import log_time
+from .models import Log, LogConfig
+from . import helper, queries
+
+_logger = logging.getLogger(__name__)
+
+
+@log_time
+def create_log(sender, **kwargs):
+
+    def _create_log():
+        member = get_member()
+        user = member and member.user or None
+        object_id = instance.id
+        log_rows = queries.current_log_state(model, object_id)
+        log_state, log_info = helper.log_state_to_dict(log_rows)
+        instance_state = helper.get_instance_state(instance)
+        diff = dict(log_state.items() ^ instance_state.items())
+        logs_to_create = []
+        for field, value in instance_state.items():
+            if field not in diff.keys():
+                continue
+            value_type = helper.internal_type_to_log_type(instance._meta.get_field(field))
+            if value_type is None:
+                continue
+            if value is None:
+                new_value = None
+            else:
+                new_value = str(value)
+            log = Log(
+                model=model,
+                field=field,
+                object_id=instance.id,
+                old_value_type=log_info.get(field, {}).get('new_value_type', ''),
+                old_value=log_state.get(field),
+                new_value_type=helper.internal_type_to_log_type(instance._meta.get_field(field)),
+                new_value=new_value,
+                user=user,
+                tenant=get_tenant()
+            )
+            logs_to_create.append(log)
+        Log.objects.bulk_create(logs_to_create)
+
+    instance: models.Model = kwargs.get('instance')
+    model = f'{instance._meta.app_label}.{instance._meta.model_name}'
+    log_config = LogConfig.objects.filter(model=model).first()
+    if not log_config:
+        return
+
+    try:
+        _create_log()
+    except Exception as e:
+        _logger.exception(e)
+        if log_config.ignore_errors:
+            pass
+        else:
+            raise e

accrete-0.0.113/accrete/contrib/sequence/migrations/0003_alter_sequence_tenant.py

@@ -0,0 +1,20 @@
+# Generated by Django 5.1.1 on 2025-01-07 20:24
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('accrete', '0002_initial'),
+        ('sequence', '0002_alter_sequence_name'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='sequence',
+            name='tenant',
+            field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='accrete.tenant', verbose_name='Tenant'),
+        ),
+    ]

accrete-0.0.113/accrete/contrib/system_mail/views.py

@@ -0,0 +1,3 @@
+from django.shortcuts import render
+
+# Create your views here.

accrete-0.0.113/accrete/contrib/ui/templates/ui/form_error.html

@@ -0,0 +1,11 @@
+{% load i18n %}
+
+{% if form.non_field_errors or form.save_error %}
+    <div class="notification is-danger is-light">
+        {{ form.non_field_errors }}
+        {% if form.save_error %}
+            <p>{{ form.save_error }}</p>
+            <span>{% translate 'Error ID' %}: {{ form.save_error_id }}</span>
+        {% endif %}
+    </div>
+{% endif %}