Merge pull request #14177 from dogboat/locations-more-models

Locations more models

Author: dogboat

dojo/auditlog.py

@@ -292,10 +292,12 @@ def register_django_pghistory_models():
     triggers.
     """
     # Import models inside function to avoid AppRegistryNotReady errors
+    from dojo.location.models import Location  # noqa: PLC0415
     from dojo.models import (  # noqa: PLC0415
         App_Analysis,
         Cred_User,
         Dojo_User,
+        # TODO: Delete this after the move to Locations
         Endpoint,
         Engagement,
         Finding,
@@ -308,6 +310,7 @@ def register_django_pghistory_models():
         Risk_Acceptance,
         Test,
     )
+    from dojo.url.models import URL  # noqa: PLC0415
 
     # Only log during actual application startup, not during shell commands
     if "shell" not in sys.argv:
@@ -526,6 +529,34 @@ class Meta:
         },
     )(FindingReviewers)
 
+    pghistory.track(
+        pghistory.InsertEvent(),
+        pghistory.UpdateEvent(condition=pghistory.AnyChange(exclude_auto=True)),
+        pghistory.DeleteEvent(),
+        pghistory.ManualEvent(label="initial_backfill"),
+        meta={
+            "indexes": [
+                models.Index(fields=["pgh_created_at"]),
+                models.Index(fields=["pgh_label"]),
+                models.Index(fields=["pgh_context_id"]),
+            ],
+        },
+    )(Location)
+
+    pghistory.track(
+        pghistory.InsertEvent(),
+        pghistory.UpdateEvent(condition=pghistory.AnyChange(exclude_auto=True)),
+        pghistory.DeleteEvent(),
+        pghistory.ManualEvent(label="initial_backfill"),
+        meta={
+            "indexes": [
+                models.Index(fields=["pgh_created_at"]),
+                models.Index(fields=["pgh_label"]),
+                models.Index(fields=["pgh_context_id"]),
+            ],
+        },
+    )(URL)
+
     # Track tag through models for all TagField relationships
     # Must use proxy pattern like FindingReviewers because tagulous auto-generates
     # through models that cannot be imported at module level
@@ -1026,6 +1057,7 @@ def get_tracked_models():
         "Product_Type", "Product", "Test", "Risk_Acceptance",
         "Finding_Template", "Cred_User", "Notification_Webhooks",
         "FindingReviewers",  # M2M through table for Finding.reviewers
+        "Location", "URL",
         # Tag through tables (tagulous auto-generated)
         "FindingTags",
         "FindingInheritedTags",

…ted_alter_engagement_created_and_more.py dojo/db_migrations/0258_locations.pydojo/db_migrations/0252_location_finding_updated_alter_engagement_created_and_more.py renamed to dojo/db_migrations/0258_locations.py dojo/db_migrations/0252_location_finding_updated_alter_engagement_created_and_more.py renamed to dojo/db_migrations/0258_locations.py

@@ -1,4 +1,4 @@
-# Generated by Django 5.2.9 on 2025-12-20 21:54
+# Generated by Django 5.2.9 on 2025-12-31 13:30
 
 import django.core.validators
 import django.db.models.deletion
@@ -14,7 +14,8 @@
 class Migration(migrations.Migration):
 
     dependencies = [
-        ('dojo', '0251_usercontactinfo_reset_timestamps'),
+        ('dojo', '0257_pghistory_tags_backfill'),
+        ('pghistory', '0007_auto_20250421_0444'),
     ]
 
     operations = [
@@ -32,6 +33,22 @@ class Migration(migrations.Migration):
                 'verbose_name_plural': 'Locations - Locations',
             },
         ),
+        migrations.CreateModel(
+            name='LocationEvent',
+            fields=[
+                ('pgh_id', models.AutoField(primary_key=True, serialize=False)),
+                ('pgh_created_at', models.DateTimeField(auto_now_add=True)),
+                ('pgh_label', models.TextField(help_text='The event label.')),
+                ('id', models.IntegerField()),
+                ('created', models.DateTimeField(auto_now_add=True, help_text='Time that the object was initially created, and saved to the database', null=True, verbose_name='Created')),
+                ('updated', models.DateTimeField(auto_now=True, help_text='Time that the object was most recently saved to the database', null=True, verbose_name='Updated')),
+                ('location_type', models.CharField(editable=False, help_text='The type of location that is stored. This field is automatically managed', max_length=12, validators=[dojo.base_models.validators.validate_not_empty], verbose_name='Location type')),
+                ('location_value', models.CharField(editable=False, help_text='The string representation of a given location. This field is automatically managed', max_length=2048, validators=[dojo.base_models.validators.validate_not_empty], verbose_name='Location Value')),
+            ],
+            options={
+                'abstract': False,
+            },
+        ),
         migrations.CreateModel(
             name='LocationFindingReference',
             fields=[
@@ -59,6 +76,21 @@ class Migration(migrations.Migration):
                 'verbose_name_plural': 'Locations - ProductReferences',
             },
         ),
+        migrations.CreateModel(
+            name='Tagulous_Location_inherited_tags',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('name', models.CharField(max_length=255, unique=True)),
+                ('slug', models.SlugField()),
+                ('count', models.IntegerField(default=0, help_text='Internal counter of how many times this tag is in use')),
+                ('protected', models.BooleanField(default=False, help_text='Will not be deleted when the count reaches 0')),
+            ],
+            options={
+                'ordering': ('name',),
+                'abstract': False,
+            },
+            bases=(tagulous.models.models.BaseTagModel, models.Model),
+        ),
         migrations.CreateModel(
             name='Tagulous_Location_tags',
             fields=[
@@ -92,6 +124,26 @@ class Migration(migrations.Migration):
                 'verbose_name_plural': 'Locations - URLs',
             },
         ),
+        migrations.CreateModel(
+            name='URLEvent',
+            fields=[
+                ('pgh_id', models.AutoField(primary_key=True, serialize=False)),
+                ('pgh_created_at', models.DateTimeField(auto_now_add=True)),
+                ('pgh_label', models.TextField(help_text='The event label.')),
+                ('id', models.IntegerField()),
+                ('protocol', models.CharField(blank=True, default='', help_text='The protocol of the URL (e.g., http, https, ftp, etc.)', max_length=10, validators=[dojo.url.validators.validate_protocol])),
+                ('user_info', models.CharField(blank=True, default='', help_text='Connection details for a given user', max_length=512, validators=[dojo.url.validators.validate_user_info])),
+                ('host', models.CharField(help_text='The host of the URL, which can be a domain name or an IP address', max_length=256, validators=[dojo.base_models.validators.validate_not_empty])),
+                ('port', models.PositiveIntegerField(blank=True, help_text='The port number of the URL (optional)', null=True, validators=[django.core.validators.MinValueValidator(1), django.core.validators.MaxValueValidator(65535)])),
+                ('path', models.CharField(blank=True, default='', help_text='The path of the URL (optional),', max_length=2048)),
+                ('query', models.CharField(blank=True, default='', help_text='The query string of the URL (optional)', max_length=2048, validators=[dojo.url.validators.validate_query])),
+                ('fragment', models.CharField(blank=True, default='', help_text='The fragment identifier of the URL (optional)', max_length=2048, validators=[dojo.url.validators.validate_fragment])),
+                ('host_validation_failure', models.BooleanField(default=False, help_text='Dictates whether the endpoint was found to have host validation issues during creation')),
+            ],
+            options={
+                'abstract': False,
+            },
+        ),
         pgtrigger.migrations.RemoveTrigger(
             model_name='finding',
             name='insert_insert',
@@ -219,6 +271,16 @@ class Migration(migrations.Migration):
             name='dojometa',
             unique_together={('endpoint', 'name'), ('finding', 'name'), ('location', 'name'), ('product', 'name')},
         ),
+        migrations.AddField(
+            model_name='locationevent',
+            name='pgh_context',
+            field=models.ForeignKey(db_constraint=False, null=True, on_delete=django.db.models.deletion.DO_NOTHING, related_name='+', to='pghistory.context'),
+        ),
+        migrations.AddField(
+            model_name='locationevent',
+            name='pgh_obj',
+            field=models.ForeignKey(db_constraint=False, on_delete=django.db.models.deletion.DO_NOTHING, related_name='events', to='dojo.location'),
+        ),
         migrations.AddField(
             model_name='locationfindingreference',
             name='auditor',
@@ -244,6 +306,15 @@ class Migration(migrations.Migration):
             name='product',
             field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='locations', to='dojo.product'),
         ),
+        migrations.AlterUniqueTogether(
+            name='tagulous_location_inherited_tags',
+            unique_together={('slug',)},
+        ),
+        migrations.AddField(
+            model_name='location',
+            name='inherited_tags',
+            field=tagulous.models.fields.TagField(_set_tag_meta=True, blank=True, force_lowercase=True, help_text='Internal use tags sepcifically for maintaining parity with product. This field will be present as a subset in the tags field', to='dojo.tagulous_location_inherited_tags'),
+        ),
         migrations.AlterUniqueTogether(
             name='tagulous_location_tags',
             unique_together={('slug',)},
@@ -258,6 +329,33 @@ class Migration(migrations.Migration):
             name='location',
             field=models.OneToOneField(editable=False, on_delete=django.db.models.deletion.CASCADE, related_name='%(class)s', to='dojo.location'),
         ),
+        migrations.AddField(
+            model_name='urlevent',
+            name='location',
+            field=models.ForeignKey(db_constraint=False, db_index=False, editable=False, on_delete=django.db.models.deletion.DO_NOTHING, related_name='+', related_query_name='+', to='dojo.location'),
+        ),
+        migrations.AddField(
+            model_name='urlevent',
+            name='pgh_context',
+            field=models.ForeignKey(db_constraint=False, null=True, on_delete=django.db.models.deletion.DO_NOTHING, related_name='+', to='pghistory.context'),
+        ),
+        migrations.AddField(
+            model_name='urlevent',
+            name='pgh_obj',
+            field=models.ForeignKey(db_constraint=False, on_delete=django.db.models.deletion.DO_NOTHING, related_name='events', to='dojo.url'),
+        ),
+        migrations.AddIndex(
+            model_name='locationevent',
+            index=models.Index(fields=['pgh_created_at'], name='dojo_locati_pgh_cre_f68343_idx'),
+        ),
+        migrations.AddIndex(
+            model_name='locationevent',
+            index=models.Index(fields=['pgh_label'], name='dojo_locati_pgh_lab_a8d664_idx'),
+        ),
+        migrations.AddIndex(
+            model_name='locationevent',
+            index=models.Index(fields=['pgh_context_id'], name='dojo_locati_pgh_con_4d6540_idx'),
+        ),
         migrations.AddIndex(
             model_name='locationfindingreference',
             index=models.Index(fields=['location'], name='dojo_locati_locatio_b2391a_idx'),
@@ -290,8 +388,44 @@ class Migration(migrations.Migration):
             model_name='location',
             index=models.Index(fields=['location_value'], name='dojo_locati_locatio_e7d251_idx'),
         ),
+        pgtrigger.migrations.AddTrigger(
+            model_name='location',
+            trigger=pgtrigger.compiler.Trigger(name='insert_insert', sql=pgtrigger.compiler.UpsertTriggerSql(func='INSERT INTO "dojo_locationevent" ("created", "id", "location_type", "location_value", "pgh_context_id", "pgh_created_at", "pgh_label", "pgh_obj_id", "updated") VALUES (NEW."created", NEW."id", NEW."location_type", NEW."location_value", _pgh_attach_context(), NOW(), \'insert\', NEW."id", NEW."updated"); RETURN NULL;', hash='645dec2b5ed2c7fadcead7f144854dc788300cb0', operation='INSERT', pgid='pgtrigger_insert_insert_d5ba2', table='dojo_location', when='AFTER')),
+        ),
+        pgtrigger.migrations.AddTrigger(
+            model_name='location',
+            trigger=pgtrigger.compiler.Trigger(name='update_update', sql=pgtrigger.compiler.UpsertTriggerSql(condition='WHEN (OLD."id" IS DISTINCT FROM (NEW."id") OR OLD."location_type" IS DISTINCT FROM (NEW."location_type") OR OLD."location_value" IS DISTINCT FROM (NEW."location_value"))', func='INSERT INTO "dojo_locationevent" ("created", "id", "location_type", "location_value", "pgh_context_id", "pgh_created_at", "pgh_label", "pgh_obj_id", "updated") VALUES (NEW."created", NEW."id", NEW."location_type", NEW."location_value", _pgh_attach_context(), NOW(), \'update\', NEW."id", NEW."updated"); RETURN NULL;', hash='4c3d9633d78f12dba4637e94abe63b246578f24a', operation='UPDATE', pgid='pgtrigger_update_update_a892f', table='dojo_location', when='AFTER')),
+        ),
+        pgtrigger.migrations.AddTrigger(
+            model_name='location',
+            trigger=pgtrigger.compiler.Trigger(name='delete_delete', sql=pgtrigger.compiler.UpsertTriggerSql(func='INSERT INTO "dojo_locationevent" ("created", "id", "location_type", "location_value", "pgh_context_id", "pgh_created_at", "pgh_label", "pgh_obj_id", "updated") VALUES (OLD."created", OLD."id", OLD."location_type", OLD."location_value", _pgh_attach_context(), NOW(), \'delete\', OLD."id", OLD."updated"); RETURN NULL;', hash='b8a61e7fc8b8a548b8f4035e6545f53ffd50a514', operation='DELETE', pgid='pgtrigger_delete_delete_73982', table='dojo_location', when='AFTER')),
+        ),
         migrations.AddIndex(
             model_name='url',
             index=models.Index(fields=['host'], name='dojo_url_host_b469c8_idx'),
         ),
+        pgtrigger.migrations.AddTrigger(
+            model_name='url',
+            trigger=pgtrigger.compiler.Trigger(name='insert_insert', sql=pgtrigger.compiler.UpsertTriggerSql(func='INSERT INTO "dojo_urlevent" ("fragment", "host", "host_validation_failure", "id", "location_id", "path", "pgh_context_id", "pgh_created_at", "pgh_label", "pgh_obj_id", "port", "protocol", "query", "user_info") VALUES (NEW."fragment", NEW."host", NEW."host_validation_failure", NEW."id", NEW."location_id", NEW."path", _pgh_attach_context(), NOW(), \'insert\', NEW."id", NEW."port", NEW."protocol", NEW."query", NEW."user_info"); RETURN NULL;', hash='a0e52733b9245b44b3e1d221a4150f4172634360', operation='INSERT', pgid='pgtrigger_insert_insert_9de22', table='dojo_url', when='AFTER')),
+        ),
+        pgtrigger.migrations.AddTrigger(
+            model_name='url',
+            trigger=pgtrigger.compiler.Trigger(name='update_update', sql=pgtrigger.compiler.UpsertTriggerSql(condition='WHEN (OLD.* IS DISTINCT FROM NEW.*)', func='INSERT INTO "dojo_urlevent" ("fragment", "host", "host_validation_failure", "id", "location_id", "path", "pgh_context_id", "pgh_created_at", "pgh_label", "pgh_obj_id", "port", "protocol", "query", "user_info") VALUES (NEW."fragment", NEW."host", NEW."host_validation_failure", NEW."id", NEW."location_id", NEW."path", _pgh_attach_context(), NOW(), \'update\', NEW."id", NEW."port", NEW."protocol", NEW."query", NEW."user_info"); RETURN NULL;', hash='d7d58cefa0ada5ae4e74dacebf49cf9f654623ef', operation='UPDATE', pgid='pgtrigger_update_update_4785e', table='dojo_url', when='AFTER')),
+        ),
+        pgtrigger.migrations.AddTrigger(
+            model_name='url',
+            trigger=pgtrigger.compiler.Trigger(name='delete_delete', sql=pgtrigger.compiler.UpsertTriggerSql(func='INSERT INTO "dojo_urlevent" ("fragment", "host", "host_validation_failure", "id", "location_id", "path", "pgh_context_id", "pgh_created_at", "pgh_label", "pgh_obj_id", "port", "protocol", "query", "user_info") VALUES (OLD."fragment", OLD."host", OLD."host_validation_failure", OLD."id", OLD."location_id", OLD."path", _pgh_attach_context(), NOW(), \'delete\', OLD."id", OLD."port", OLD."protocol", OLD."query", OLD."user_info"); RETURN NULL;', hash='74e1ffe8b7b0a80d9d089babcf7c5a37daacbc4e', operation='DELETE', pgid='pgtrigger_delete_delete_ca7d6', table='dojo_url', when='AFTER')),
+        ),
+        migrations.AddIndex(
+            model_name='urlevent',
+            index=models.Index(fields=['pgh_created_at'], name='dojo_urleve_pgh_cre_de0a00_idx'),
+        ),
+        migrations.AddIndex(
+            model_name='urlevent',
+            index=models.Index(fields=['pgh_label'], name='dojo_urleve_pgh_lab_53223a_idx'),
+        ),
+        migrations.AddIndex(
+            model_name='urlevent',
+            index=models.Index(fields=['pgh_context_id'], name='dojo_urleve_pgh_con_b0d6dd_idx'),
+        ),
     ]

dojo/location/api/__init__.py

@@ -1,3 +1,3 @@
-path = "location"
-finding_path = "location_findings"
-product_path = "location_products"
+path = "location"  # noqa: RUF067
+finding_path = "location_findings"  # noqa: RUF067
+product_path = "location_products"  # noqa: RUF067