wbcore 2.2.1__py2.py3-none-any.whl

wbcore/migrations/0001_initial_squashed_squashed_0010_preset_appliedpreset.py

@@ -0,0 +1,398 @@
+# Generated by Django 4.1.8 on 2023-04-19 05:42
+
+import uuid
+
+import colorfield.fields
+import django.db.models.deletion
+import django_better_admin_arrayfield.models.fields
+import wbcore.markdown.models
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    initial = True
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ("reversion", "0001_squashed_0004_auto_20160611_1202"),
+        ("auth", "0012_alter_user_first_name_max_length"),
+        ("contenttypes", "0002_remove_content_type_name"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="FrontendUserConfiguration",
+            fields=[
+                ("id", models.UUIDField(default=uuid.uuid4, editable=False, primary_key=True, serialize=False)),
+                ("config", models.JSONField(blank=True, default=dict, null=True)),
+                (
+                    "parent_configuration",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="child_configurations",
+                        to="wbcore.frontenduserconfiguration",
+                    ),
+                ),
+                (
+                    "user",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="configurations",
+                        to=settings.AUTH_USER_MODEL,
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "Frontend User Settings",
+                "verbose_name_plural": "Frontend User Settings",
+            },
+        ),
+        migrations.CreateModel(
+            name="Notification",
+            fields=[
+                ("id", models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
+                ("title", models.CharField(max_length=512)),
+                ("message", models.TextField(blank=True, null=True)),
+                ("buttons", models.JSONField(blank=True, default=list, null=True)),
+                ("timestamp_created", models.DateTimeField(auto_now_add=True, verbose_name="Created")),
+                ("timestamp_received", models.DateTimeField(blank=True, null=True, verbose_name="Received")),
+                ("timestamp_read", models.DateTimeField(blank=True, null=True, verbose_name="Read")),
+                ("timestamp_mailed", models.DateTimeField(blank=True, null=True, verbose_name="Mailed")),
+                (
+                    "send_type",
+                    models.CharField(
+                        choices=[("system", "System"), ("mail", "Mail"), ("system_and_mail", "System and Mail")],
+                        default="system",
+                        max_length=32,
+                    ),
+                ),
+                (
+                    "recipient",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="notifications",
+                        to=settings.AUTH_USER_MODEL,
+                    ),
+                ),
+                ("endpoint", models.URLField(blank=True, max_length=2048, null=True)),
+            ],
+        ),
+        migrations.CreateModel(
+            name="Tag",
+            fields=[
+                ("id", models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
+                ("title", models.CharField(max_length=255, unique=True)),
+                ("color", models.CharField(default="#D3D3D3", max_length=7)),
+                ("slug", models.CharField(blank=True, max_length=255, null=True)),
+            ],
+            options={
+                "verbose_name": "Tag",
+                "verbose_name_plural": "Tags",
+            },
+        ),
+        migrations.CreateModel(
+            name="RevisionAbstract",
+            fields=[],
+            options={
+                "proxy": True,
+                "indexes": [],
+                "constraints": [],
+            },
+            bases=("reversion.revision",),
+        ),
+        migrations.CreateModel(
+            name="VersionAbstract",
+            fields=[],
+            options={
+                "proxy": True,
+                "indexes": [],
+                "constraints": [],
+            },
+            bases=("reversion.version",),
+        ),
+        migrations.CreateModel(
+            name="Asset",
+            fields=[
+                ("id", models.UUIDField(default=uuid.uuid4, editable=False, primary_key=True, serialize=False)),
+                ("file", models.FileField(upload_to=wbcore.markdown.models.upload_to)),
+                ("content_type", models.CharField(blank=True, max_length=32, null=True)),
+                ("file_url_name", models.CharField(blank=True, max_length=1024, null=True)),
+            ],
+            options={
+                "verbose_name": "Asset",
+                "verbose_name_plural": "Assets",
+            },
+        ),
+        migrations.CreateModel(
+            name="BigUserObjectPermission",
+            fields=[
+                ("object_pk", models.CharField(max_length=255, verbose_name="object ID")),
+                ("id", models.BigAutoField(editable=False, primary_key=True, serialize=False, unique=True)),
+                (
+                    "content_type",
+                    models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to="contenttypes.contenttype"),
+                ),
+                ("permission", models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to="auth.permission")),
+                ("user", models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to=settings.AUTH_USER_MODEL)),
+            ],
+            options={
+                "abstract": False,
+            },
+        ),
+        migrations.AddIndex(
+            model_name="biguserobjectpermission",
+            index=models.Index(fields=["content_type", "object_pk"], name="wbcore_big_content_6fb9b7_idx"),
+        ),
+        migrations.AddIndex(
+            model_name="biguserobjectpermission",
+            index=models.Index(fields=["content_type", "object_pk", "user"], name="wbcore_big_content_bcec08_idx"),
+        ),
+        migrations.AlterUniqueTogether(
+            name="biguserobjectpermission",
+            unique_together={("user", "permission", "object_pk")},
+        ),
+        migrations.CreateModel(
+            name="BigGroupObjectPermission",
+            fields=[
+                ("object_pk", models.CharField(max_length=255, verbose_name="object ID")),
+                ("id", models.BigAutoField(editable=False, primary_key=True, serialize=False, unique=True)),
+                (
+                    "content_type",
+                    models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to="contenttypes.contenttype"),
+                ),
+                ("group", models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to="auth.group")),
+                ("permission", models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to="auth.permission")),
+            ],
+            options={
+                "abstract": False,
+            },
+        ),
+        migrations.AddIndex(
+            model_name="biggroupobjectpermission",
+            index=models.Index(fields=["content_type", "object_pk"], name="wbcore_big_content_9cf161_idx"),
+        ),
+        migrations.AddIndex(
+            model_name="biggroupobjectpermission",
+            index=models.Index(fields=["content_type", "object_pk", "group"], name="wbcore_big_content_c9791f_idx"),
+        ),
+        migrations.AlterUniqueTogether(
+            name="biggroupobjectpermission",
+            unique_together={("group", "permission", "object_pk")},
+        ),
+        migrations.CreateModel(
+            name="ReleaseNote",
+            fields=[
+                ("id", models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
+                ("version", models.CharField(help_text="The version/identifier of the release", max_length=18)),
+                ("release_date", models.DateField(help_text="The date, when this new version was released")),
+                ("module", models.CharField(help_text="The workbench-module of the release", max_length=255)),
+                ("notes", models.TextField(default="", help_text="What's new? What's improved? What's fixed?")),
+                ("read_by", models.ManyToManyField(related_name="read_patch_notes", to=settings.AUTH_USER_MODEL)),
+            ],
+            options={
+                "verbose_name": "Release Note",
+                "verbose_name_plural": "Release Notes",
+            },
+        ),
+        migrations.AddConstraint(
+            model_name="releasenote",
+            constraint=models.UniqueConstraint(
+                fields=("version", "module"), name="release_note_unique_version_module"
+            ),
+        ),
+        migrations.AddField(
+            model_name="releasenote",
+            name="summary",
+            field=models.CharField(default="abc", help_text="A brief summary of the release", max_length=512),
+            preserve_default=False,
+        ),
+        migrations.DeleteModel(
+            name="RevisionAbstract",
+        ),
+        migrations.DeleteModel(
+            name="VersionAbstract",
+        ),
+        migrations.DeleteModel(
+            name="Tag",
+        ),
+        migrations.AlterField(
+            model_name="asset",
+            name="file",
+            field=models.FileField(max_length=256, upload_to=wbcore.markdown.models.upload_to),
+        ),
+        migrations.AddField(
+            model_name="biggroupobjectpermission",
+            name="editable",
+            field=models.BooleanField(default=True),
+        ),
+        migrations.AddField(
+            model_name="biguserobjectpermission",
+            name="editable",
+            field=models.BooleanField(default=True),
+        ),
+        migrations.CreateModel(
+            name="PermissionTestModel",
+            fields=[
+                ("id", models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
+                (
+                    "permission_type",
+                    models.CharField(
+                        choices=[("INTERNAL", "Internal"), ("PUBLIC", "Public"), ("PRIVATE", "Private")],
+                        default="PRIVATE",
+                        max_length=8,
+                    ),
+                ),
+            ],
+            options={
+                "abstract": False,
+                "managed": False,
+                "default_permissions": ("add", "change", "delete", "view", "administrate"),
+            },
+        ),
+        migrations.CreateModel(
+            name="ColorGradient",
+            fields=[
+                ("id", models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
+                ("title", models.CharField(default="", max_length=128)),
+                (
+                    "colors",
+                    django_better_admin_arrayfield.models.fields.ArrayField(
+                        base_field=colorfield.fields.ColorField(
+                            default="#FF0000", image_field=None, max_length=18, samples=None
+                        ),
+                        default=list,
+                        size=None,
+                    ),
+                ),
+            ],
+        ),
+        migrations.AlterField(
+            model_name="releasenote",
+            name="module",
+            field=models.CharField(help_text="The workbench module of the release", max_length=255),
+        ),
+        migrations.AlterField(
+            model_name="releasenote",
+            name="release_date",
+            field=models.DateField(help_text="The date when this new version was released"),
+        ),
+        migrations.AlterField(
+            model_name="releasenote",
+            name="read_by",
+            field=models.ManyToManyField(
+                db_table="bridger_releasenote_read_by", related_name="read_patch_notes", to=settings.AUTH_USER_MODEL
+            ),
+        ),
+        migrations.AlterModelTable(
+            name="asset",
+            table="bridger_asset",
+        ),
+        migrations.AlterModelTable(
+            name="biggroupobjectpermission",
+            table="bridger_biggroupobjectpermission",
+        ),
+        migrations.AlterModelTable(
+            name="biguserobjectpermission",
+            table="bridger_biguserobjectpermission",
+        ),
+        migrations.AlterModelTable(
+            name="colorgradient",
+            table="bridger_colorgradient",
+        ),
+        migrations.AlterModelTable(
+            name="frontenduserconfiguration",
+            table="bridger_frontenduserconfiguration",
+        ),
+        migrations.AlterModelTable(
+            name="notification",
+            table="bridger_notification",
+        ),
+        migrations.AlterModelTable(
+            name="releasenote",
+            table="bridger_releasenote",
+        ),
+        migrations.RenameIndex(
+            model_name="biggroupobjectpermission",
+            new_name="bridger_big_content_9cf161_idx",
+            old_name="wbcore_big_content_9cf161_idx",
+        ),
+        migrations.RenameIndex(
+            model_name="biggroupobjectpermission",
+            new_name="bridger_big_content_c9791f_idx",
+            old_name="wbcore_big_content_c9791f_idx",
+        ),
+        migrations.RenameIndex(
+            model_name="biguserobjectpermission",
+            new_name="bridger_big_content_6fb9b7_idx",
+            old_name="wbcore_big_content_6fb9b7_idx",
+        ),
+        migrations.RenameIndex(
+            model_name="biguserobjectpermission",
+            new_name="bridger_big_content_bcec08_idx",
+            old_name="wbcore_big_content_bcec08_idx",
+        ),
+        migrations.AlterField(
+            model_name="notification",
+            name="endpoint",
+            field=models.CharField(blank=True, max_length=2048, null=True),
+        ),
+        migrations.AddField(
+            model_name="notification",
+            name="share_endpoint_as_widget",
+            field=models.BooleanField(
+                default=True,
+                help_text="If True, it will share the endpoint as widget_endpoint. Otherwise, sends the endpoint as url",
+            ),
+        ),
+        migrations.DeleteModel(
+            name="PermissionTestModel",
+        ),
+        migrations.CreateModel(
+            name="Preset",
+            fields=[
+                ("id", models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
+                ("title", models.CharField(max_length=64)),
+                ("display_identifier", models.CharField(max_length=512)),
+                ("display", models.JSONField(blank=True, null=True)),
+                (
+                    "user",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="presets",
+                        to=settings.AUTH_USER_MODEL,
+                    ),
+                ),
+            ],
+        ),
+        migrations.CreateModel(
+            name="AppliedPreset",
+            fields=[
+                ("id", models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
+                ("display_identifier_path", models.CharField(max_length=1024)),
+                ("display", models.JSONField(blank=True, null=True)),
+                (
+                    "preset",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        related_name="applied_presets",
+                        to="wbcore.preset",
+                    ),
+                ),
+                (
+                    "user",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="applied_presets",
+                        to=settings.AUTH_USER_MODEL,
+                    ),
+                ),
+            ],
+        ),
+    ]

wbcore/migrations/0011_genericmodel.py

@@ -0,0 +1,22 @@
+# Generated by Django 4.1.8 on 2023-04-28 13:36
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("wbcore", "0001_initial_squashed_squashed_0010_preset_appliedpreset"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="GenericModel",
+            fields=[
+                ("id", models.IntegerField(primary_key=True, serialize=False)),
+                ("label", models.CharField(max_length=256)),
+            ],
+            options={
+                "managed": False,
+            },
+        ),
+    ]

wbcore/migrations/0012_delete_notification.py

@@ -0,0 +1,15 @@
+# Generated by Django 4.1.8 on 2023-05-23 08:13
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("wbcore", "0011_genericmodel"),
+    ]
+
+    operations = [
+        migrations.DeleteModel(
+            name="Notification",
+        ),
+    ]

wbcore/migrations/0013_delete_colorgradient.py

@@ -0,0 +1,14 @@
+# Generated by Django 4.2.6 on 2023-11-16 10:08
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("wbcore", "0012_delete_notification"),
+    ]
+    database_operations = [migrations.AlterModelTable("ColorGradient", "color_colorgradient")]
+
+    state_operations = [migrations.DeleteModel("ColorGradient")]
+
+    operations = state_operations

wbcore/migrations/0014_biguserobjectpermission_system.py

@@ -0,0 +1,44 @@
+# Generated by Django 5.0.8 on 2024-09-09 15:14
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("wbcore", "0013_delete_colorgradient"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="biguserobjectpermission",
+            name="system",
+            field=models.BooleanField(default=False),
+        ),
+        migrations.SeparateDatabaseAndState(
+            database_operations=[],
+            state_operations=[
+                migrations.AlterUniqueTogether(
+                    name="biguserobjectpermission",
+                    unique_together=None,
+                ),
+                migrations.RemoveField(
+                    model_name="biguserobjectpermission",
+                    name="content_type",
+                ),
+                migrations.RemoveField(
+                    model_name="biguserobjectpermission",
+                    name="permission",
+                ),
+                migrations.RemoveField(
+                    model_name="biguserobjectpermission",
+                    name="user",
+                ),
+                migrations.DeleteModel(
+                    name="BigGroupObjectPermission",
+                ),
+                migrations.DeleteModel(
+                    name="BigUserObjectPermission",
+                ),
+            ],
+        ),
+    ]

wbcore/models/__init__.py

@@ -0,0 +1,6 @@
+from wbcore.frontend_user_configuration import FrontendUserConfiguration
+from wbcore.metadata.configs.display.models import AppliedPreset, Preset
+from wbcore.release_notes.models import ReleaseNote
+
+from .base import DynamicModel, WBModel
+from .fields import DynamicDecimalField, DynamicFloatField, YearField

wbcore/models/base.py

@@ -0,0 +1,182 @@
+from contextlib import suppress
+from typing import Any, List, Optional
+
+from celery import shared_task
+from django.contrib.contenttypes.models import ContentType
+from django.core import checks
+from django.db import models
+from django.db.models.base import ModelBase
+from django.utils.functional import cached_property
+from django_better_admin_arrayfield.models.fields import ArrayField
+from igraph import Graph
+from wbcore.signals.models import get_dependant_dynamic_fields_instances
+
+from .fields import DynamicDecimalField, DynamicFloatField
+
+
+class DynamicMetaClass(ModelBase):
+    def __new__(cls, name, bases, attrs, **kwargs):
+        new_class = super().__new__(cls, name, bases, attrs, **kwargs)
+        # Construct dependencies graph
+        dynamic_field_names = {
+            field.name: field.dependencies
+            for field in new_class._meta.fields
+            if type(field) in [DynamicFloatField, DynamicDecimalField]
+        }
+        ordered_dependencies_fields = []
+        if dynamic_field_names:
+            g = Graph(len(dynamic_field_names), directed=True)
+            # label vertices
+            g.vs["name"] = list(dynamic_field_names.keys())
+            for field_name, dependencies in dynamic_field_names.items():
+                for dependency in dependencies:
+                    g[dependency, field_name] = 1
+            # Store dynamic field ordered by topological sorting
+            ordered_dependencies_fields = [g.vs[v_id]["name"] for v_id in g.topological_sorting()]
+        new_class.add_to_class("ordered_dependencies_fields", ordered_dependencies_fields)
+        return new_class
+
+
+class DynamicModel(models.Model, metaclass=DynamicMetaClass):
+    DATE_RANGE_UPPER_FIELD_NAME = "date"
+    DATE_RANGE_LOWER_FIELD_NAME = "date"
+
+    lock_all_dynamic_fields = models.BooleanField(
+        default=False, help_text="If True, will not allow dynamic fields to be updated"
+    )
+    locked_dynamic_fields = ArrayField(
+        models.CharField(
+            max_length=128,
+        ),
+        blank=True,
+        default=list,
+    )
+    updated_at = models.DateTimeField(auto_now=True)
+
+    @classmethod
+    def get_static_locked_fields(cls) -> list[str]:
+        """
+        Override if the model needs to define a set of dynamic fields that can only be set when the value is null
+
+        Returns:
+            Return a list of field names
+        """
+        return []
+
+    @cached_property
+    def _locked_fields(self) -> set[str]:
+        return set(self.locked_dynamic_fields + self.get_static_locked_fields())
+
+    def set_dynamic_field(
+        self,
+        update_all_dynamic_fields: bool,
+        update_only_fields: list[str] | None = None,
+        update_exclude_fields: list[str] | None = None,
+    ):
+        if not update_only_fields:
+            update_only_fields = []
+        if not update_exclude_fields:
+            update_exclude_fields = []
+        # Loop over the dynamic field ordered by their place in the dependency graph
+        for dynamic_field_name in self.ordered_dependencies_fields:
+            # Check if field value is not assigned or if we explicitly want to override its value
+            if (
+                not self.lock_all_dynamic_fields
+                and (
+                    getattr(self, dynamic_field_name, None) is None
+                    or (
+                        dynamic_field_name not in self._locked_fields
+                        and (update_all_dynamic_fields or dynamic_field_name in update_only_fields)
+                    )
+                )
+            ) and dynamic_field_name not in update_exclude_fields:
+                # call the appropriate callback and check if this is a function
+                if (
+                    (compute_function := getattr(self, f"_compute_{dynamic_field_name}", None))
+                    and (callable(compute_function))
+                    and (res := compute_function()) is not None
+                ):
+                    setattr(self, dynamic_field_name, res)
+
+    @classmethod
+    def update_dynamic_fields_of_dependant_objects(
+        cls,
+        updated_instance,
+        already_visited_instances: set[Any] | None = None,
+        update_all_dynamic_fields: bool | None = True,
+    ):
+        if not already_visited_instances:
+            already_visited_instances = set()
+        for _, dependant_instance_generator in get_dependant_dynamic_fields_instances.send(
+            sender=updated_instance.__class__, instance=updated_instance
+        ):
+            for dependant_instance in dependant_instance_generator:
+                if dependant_instance not in already_visited_instances:
+                    dependant_instance.set_dynamic_field(update_all_dynamic_fields)
+                    already_visited_instances.add(updated_instance)
+                    DynamicModel.update_dynamic_fields_of_dependant_objects(
+                        dependant_instance, already_visited_instances=already_visited_instances
+                    )
+
+    def save(
+        self,
+        *args,
+        update_all_dynamic_fields: Optional[bool] = False,
+        update_only_fields: Optional[List] = None,
+        update_exclude_fields: Optional[List] = None,
+        set_dynamic_field_on_save: Optional[bool] = True,
+        **kwargs,
+    ):
+        if set_dynamic_field_on_save:
+            self.set_dynamic_field(update_all_dynamic_fields, update_only_fields, update_exclude_fields)
+        return super().save(*args, **kwargs)
+
+    class Meta:
+        abstract = True
+
+
+@shared_task
+def set_dynamic_field_as_task(content_type_id, object_id, **kwargs):
+    content_type = ContentType.objects.get(id=content_type_id)
+    instance = content_type.model_class().objects.get(id=object_id)
+    instance.set_dynamic_field(True, **kwargs)
+    instance.save()
+
+
+class WBModel(models.Model):
+    """Implements checks on the model class"""
+
+    id: int
+
+    class Meta:
+        abstract = True
+
+    @classmethod
+    def _check_model_methods(cls) -> list[checks.Error]:
+        methods_to_check = [
+            "get_endpoint_basename",
+            "get_representation_value_key",
+            "get_representation_endpoint",
+            "get_representation_label_key",
+        ]
+        method_errors = []
+        for method in methods_to_check:
+            if not hasattr(cls._meta.model, method):
+                method_errors.append(checks.Error(f"{cls._meta.model.__name__} does not have method {method}"))
+        return method_errors
+
+    @classmethod
+    def check(cls, **kwargs):
+        errors = super().check(**kwargs)
+        errors.extend(cls._check_model_methods())
+        return errors
+
+
+@shared_task
+def merge_as_task(content_type_id: int, main_object_id: int, merged_object_id: int):
+    content_type = ContentType.objects.get(id=content_type_id)
+    with suppress(content_type.model_class().DoesNotExist):
+        main_object = content_type.get_object_for_this_type(id=main_object_id)
+        merged_object = content_type.get_object_for_this_type(id=merged_object_id)
+        if hasattr(main_object, "merge") and callable(main_object.merge):
+            main_object.merge(merged_object)