script_consent/models.py - master - lesbeg/django-script-consent

script_consent/models.py
190 строк6 KB
Anton Trapeznikov
Release 0.2.0
11 авг 2026, 17:40
11 авг 2026, 17:405e335fc
import uuid

from django.conf import settings
from django.db import models
from django.db.models import F
from django.utils.functional import cached_property
from django.utils.translation import gettext_lazy as _


class RuntimeCacheStamp(models.Model):
    key = models.PositiveSmallIntegerField(primary_key=True, default=1, editable=False)
    generation = models.PositiveIntegerField(default=0)

    class Meta:
        verbose_name = _("Runtime cache stamp")
        verbose_name_plural = _("Runtime cache stamps")

    def __str__(self) -> str:
        return f"generation={self.generation}"

    @classmethod
    def current(cls) -> int:
        try:
            return int(cls.objects.values_list("generation", flat=True).get(pk=1))
        except cls.DoesNotExist:
            cls.objects.create(pk=1, generation=0)
            return 0

    @classmethod
    def bump(cls) -> int:
        cls.objects.get_or_create(pk=1, defaults={"generation": 0})
        cls.objects.filter(pk=1).update(generation=F("generation") + 1)
        return int(cls.objects.values_list("generation", flat=True).get(pk=1))


class ScriptCategory(models.Model):
    code = models.SlugField(_("Code"), max_length=64, unique=True)
    title = models.CharField(_("Title"), max_length=255)
    description = models.TextField(_("Description"), blank=True)
    is_required = models.BooleanField(
        _("Required"),
        default=False,
        help_text=_("Essential scripts: cannot be refused"),
    )
    order = models.PositiveIntegerField(_("Order"), default=0)
    is_active = models.BooleanField(_("Active"), default=True)

    class Meta:
        verbose_name = _("Script category")
        verbose_name_plural = _("Script categories")
        ordering = ["order", "id"]

    def __str__(self) -> str:
        return self.title


class BannerConfig(models.Model):
    title = models.CharField(_("Title"), max_length=255)
    text = models.TextField(_("Text"), help_text=_("Simple HTML is allowed"))
    version = models.PositiveIntegerField(_("Version"), default=1)
    is_active = models.BooleanField(_("Active"), default=True)
    updated_at = models.DateTimeField(_("Updated"), auto_now=True)

    class Meta:
        verbose_name = _("Banner configuration")
        verbose_name_plural = _("Banner configurations")
        ordering = ["-is_active", "-updated_at"]

    def __str__(self) -> str:
        return f"{self.title} (v{self.version})"

    def _get_version(self) -> int:
        prev_state = BannerConfig.objects.filter(pk=self.pk).first()
        if prev_state and any(
            [
                prev_state.title != self.title,
                prev_state.text != self.text,
                self.is_active and not prev_state.is_active,
            ]
        ):
            return prev_state.version + 1

        return self.version

    def save(self, *args, **kwargs):
        if self.pk and self.version != (new_version := self._get_version()):
            self.version = new_version

            if kwargs.get("update_fields") is not None:
                kwargs["update_fields"] = set(kwargs["update_fields"]) | {"version"}

        super().save(*args, **kwargs)

        if self.is_active:
            BannerConfig.objects.exclude(pk=self.pk).filter(is_active=True).update(
                is_active=False
            )

    @classmethod
    def get_solo(cls) -> "BannerConfig | None":
        return cls.objects.filter(is_active=True).order_by("-updated_at").first()


class ScriptSnippet(models.Model):
    class Placement(models.TextChoices):
        HEAD = "head", _("Head")
        BODY_START = "body_start", _("Body start")
        BODY_END = "body_end", _("Body end")

    name = models.CharField(_("Name"), max_length=255)
    category = models.ForeignKey(
        ScriptCategory,
        on_delete=models.PROTECT,
        related_name="scripts",
        verbose_name=_("Category"),
    )
    placement = models.CharField(
        _("Placement"),
        max_length=16,
        choices=Placement.choices,
        default=Placement.BODY_END,
    )
    code = models.TextField(_("Snippet code"), help_text=_("HTML/JS code"))
    always_load = models.BooleanField(
        _("Load without consent"),
        default=False,
        help_text=_(
            "If checked, the snippet is always loaded and does not participate "
            "in the consent prompt (regardless of category)."
        ),
    )
    is_active = models.BooleanField(_("Active"), default=True)
    order = models.PositiveIntegerField(_("Order"), default=0)

    class Meta:
        verbose_name = _("Script / snippet")
        verbose_name_plural = _("Scripts / snippets")
        ordering = ["order", "id"]
        indexes = [
            models.Index(fields=["is_active", "placement", "order"]),
        ]

    def __str__(self) -> str:
        return self.name

    @cached_property
    def requires_consent(self) -> bool:
        return False if self.always_load else not self.category.is_required


class ConsentRecord(models.Model):
    class Action(models.TextChoices):
        ACCEPT_ALL = "accept_all", _("Accept all")
        REJECT_OPTIONAL = "reject_optional", _("Necessary only")
        CUSTOM = "custom", _("Custom selection")
        WITHDRAW = "withdraw", _("Withdraw")

    consent_id = models.UUIDField(_("Consent ID"), default=uuid.uuid4, db_index=True)
    user = models.ForeignKey(
        settings.AUTH_USER_MODEL,
        on_delete=models.SET_NULL,
        null=True,
        blank=True,
        related_name="script_consents",
        verbose_name=_("User"),
    )
    created_at = models.DateTimeField(_("Created"), auto_now_add=True)
    ip_address = models.GenericIPAddressField(_("IP"), null=True, blank=True)
    user_agent = models.TextField(_("User-Agent"), blank=True)
    action = models.CharField(_("Action"), max_length=32, choices=Action.choices)
    accepted_categories = models.ManyToManyField(
        ScriptCategory,
        blank=True,
        related_name="consent_records",
        verbose_name=_("Accepted categories"),
    )
    banner_version = models.PositiveIntegerField(_("Banner version"))
    scripts_hash = models.CharField(_("Scripts hash"), max_length=64)

    class Meta:
        verbose_name = _("Consent record")
        verbose_name_plural = _("Consent records")
        ordering = ["-created_at"]
        indexes = [
            models.Index(fields=["created_at"]),
            models.Index(fields=["action"]),
        ]

    def __str__(self) -> str:
        return f"{self.consent_id} / {self.action} @ {self.created_at}"