"""Base models using UUIDv7 for all id fields.""" __package__ = "archivebox.base_models" from archivebox.uuid_compat import uuid7 from pathlib import Path from django.db import models from django.db.models import F from django.utils import timezone from django.contrib.auth import get_user_model from django.urls import reverse_lazy from django.conf import settings from django_stubs_ext.db.models import TypedModelMeta def get_or_create_system_user_pk(username="system"): User = get_user_model() # If there's exactly one superuser, use that for all system operations if User.objects.filter(is_superuser=True).count() == 1: return User.objects.filter(is_superuser=True).values_list("pk", flat=True)[0] # Otherwise get or create the system user user, _ = User.objects.get_or_create( username=username, defaults={"is_staff": True, "is_superuser": True, "email": "", "password": "!"}, ) return user.pk class AutoDateTimeField(models.DateTimeField): """DateTimeField that automatically updates on save (legacy compatibility).""" def pre_save(self, model_instance, add): if add or not getattr(model_instance, self.attname): value = timezone.now() setattr(model_instance, self.attname, value) return value return super().pre_save(model_instance, add) class ModelWithUUID(models.Model): id = models.UUIDField(primary_key=True, default=uuid7, editable=False, unique=True) created_at = models.DateTimeField(default=timezone.now, db_index=True) modified_at = models.DateTimeField(auto_now=True) created_by = models.ForeignKey( settings.AUTH_USER_MODEL, on_delete=models.CASCADE, default=get_or_create_system_user_pk, null=False, db_index=True, ) class Meta(TypedModelMeta): abstract = True def __str__(self) -> str: return f"[{self.id}] {self.__class__.__name__}" @property def admin_change_url(self) -> str: return f"/admin/{self._meta.app_label}/{self._meta.model_name}/{self.pk}/change/" @property def api_url(self) -> str: return str(reverse_lazy("api-1:get_any", args=[self.id])) @property def api_docs_url(self) -> str: return f"/api/v1/docs#/{self._meta.app_label.title()}%20Models/api_v1_{self._meta.app_label}_get_{self._meta.db_table}" class ModelWithNotes(models.Model): """Mixin for models with a notes field.""" notes = models.TextField(blank=True, null=False, default="") class Meta(TypedModelMeta): abstract = True class ModelWithHealthStats(models.Model): """Mixin for models with health tracking fields.""" num_uses_failed = models.PositiveIntegerField(default=0) num_uses_succeeded = models.PositiveIntegerField(default=0) class Meta(TypedModelMeta): abstract = True @property def health(self) -> int: total = max(self.num_uses_failed + self.num_uses_succeeded, 1) return round((self.num_uses_succeeded / total) * 100) def increment_health_stats(self, success: bool): """Atomically increment success or failure counter using F() expression.""" field = "num_uses_succeeded" if success else "num_uses_failed" type(self).objects.filter(pk=self.pk).update(**{field: F(field) + 1}) class ModelWithConfig(models.Model): """Mixin for models with a JSON config field.""" config = models.JSONField(default=dict, null=True, blank=True, editable=True) class Meta(TypedModelMeta): abstract = True class ModelWithOutputDir(ModelWithUUID): class Meta(ModelWithUUID.Meta): abstract = True def save(self, *args, **kwargs): super().save(*args, **kwargs) Path(self.output_dir).mkdir(parents=True, exist_ok=True) # Note: index.json is deprecated, models should use write_index_jsonl() for full data @property def output_dir_parent(self) -> str: return f"{self._meta.model_name}s" @property def output_dir_name(self) -> str: return str(self.id) @property def output_dir_str(self) -> str: return f"{self.output_dir_parent}/{self.output_dir_name}" @property def output_dir(self) -> Path: raise NotImplementedError(f"{self.__class__.__name__} must implement output_dir property")