netbox-plugin-dns 1.0.4__py3-none-any.whl → 1.0.6__py3-none-any.whl

netbox_dns/graphql/schema.py

@@ -3,7 +3,16 @@ from typing import List
 import strawberry
 import strawberry_django
 
-from netbox_dns.models import NameServer, View, Zone, Record, Contact, Registrar
+from netbox_dns.models import (
+    NameServer,
+    View,
+    Zone,
+    Record,
+    Contact,
+    Registrar,
+    ZoneTemplate,
+    RecordTemplate,
+)
 from .types import (
     NetBoxDNSNameServerType,
     NetBoxDNSViewType,
@@ -11,6 +20,8 @@ from .types import (
     NetBoxDNSRecordType,
     NetBoxDNSContactType,
     NetBoxDNSRegistrarType,
+    NetBoxDNSZoneTemplateType,
+    NetBoxDNSRecordTemplateType,
 )
 
 
@@ -68,3 +79,25 @@ class NetBoxDNSRegistrarQuery:
         return Registrar.objects.get(pk=id)
 
     netbox_dns_registrar_list: List[NetBoxDNSRegistrarType] = strawberry_django.field()
+
+
+@strawberry.type
+class NetBoxDNSZoneTemplateQuery:
+    @strawberry.field
+    def netbox_dns_zone_template(self, id: int) -> NetBoxDNSZoneTemplateType:
+        return ZoneTemplate.objects.get(pk=id)
+
+    netbox_dns_zone_template_list: List[NetBoxDNSZoneTemplateType] = (
+        strawberry_django.field()
+    )
+
+
+@strawberry.type
+class NetBoxDNSRecordTemplateQuery:
+    @strawberry.field
+    def netbox_dns_record_template(self, id: int) -> NetBoxDNSRecordTemplateType:
+        return RecordTemplate.objects.get(pk=id)
+
+    netbox_dns_record_template_list: List[NetBoxDNSRecordTemplateType] = (
+        strawberry_django.field()
+    )

netbox_dns/graphql/types.py

@@ -6,7 +6,16 @@ import strawberry_django
 from netbox.graphql.types import NetBoxObjectType
 from netbox.graphql.scalars import BigInt
 
-from netbox_dns.models import NameServer, View, Zone, Record, Contact, Registrar
+from netbox_dns.models import (
+    NameServer,
+    View,
+    Zone,
+    Record,
+    Contact,
+    Registrar,
+    ZoneTemplate,
+    RecordTemplate,
+)
 from .filters import (
     NetBoxDNSNameServerFilter,
     NetBoxDNSViewFilter,
@@ -14,6 +23,8 @@ from .filters import (
     NetBoxDNSRecordFilter,
     NetBoxDNSContactFilter,
     NetBoxDNSRegistrarFilter,
+    NetBoxDNSZoneTemplateFilter,
+    NetBoxDNSRecordTemplateFilter,
 )
 
 
@@ -140,3 +151,61 @@ class NetBoxDNSRegistrarType(NetBoxObjectType):
     address: str
     abuse_email: str
     abuse_phone: str
+
+
+@strawberry_django.type(
+    ZoneTemplate, fields="__all__", filters=NetBoxDNSZoneTemplateFilter
+)
+class NetBoxDNSZoneTemplateType(NetBoxObjectType):
+    name: str
+    nameservers: List[
+        Annotated[
+            "NetBoxDNSNameServerType", strawberry.lazy("netbox_dns.graphql.types")
+        ]
+    ]
+    record_templates: List[
+        Annotated[
+            "NetBoxDNSRecordTemplateType", strawberry.lazy("netbox_dns.graphql.types")
+        ]
+    ]
+    description: str | None
+    tenant: Annotated["TenantType", strawberry.lazy("tenancy.graphql.types")] | None
+    registrar: (
+        Annotated["NetBoxDNSRegistrarType", strawberry.lazy("netbox_dns.graphql.types")]
+        | None
+    )
+    registrant: (
+        Annotated["NetBoxDNSContactType", strawberry.lazy("netbox_dns.graphql.types")]
+        | None
+    )
+    admin_c: (
+        Annotated["NetBoxDNSContactType", strawberry.lazy("netbox_dns.graphql.types")]
+        | None
+    )
+    tech_c: (
+        Annotated["NetBoxDNSContactType", strawberry.lazy("netbox_dns.graphql.types")]
+        | None
+    )
+    billing_c: (
+        Annotated["NetBoxDNSContactType", strawberry.lazy("netbox_dns.graphql.types")]
+        | None
+    )
+
+
+@strawberry_django.type(
+    RecordTemplate, fields="__all__", filters=NetBoxDNSRecordTemplateFilter
+)
+class NetBoxDNSRecordTemplateType(NetBoxObjectType):
+    name: str
+    record_name: str
+    type: str
+    value: str
+    ttl: BigInt | None
+    disable_ptr: bool
+    description: str | None
+    tenant: Annotated["TenantType", strawberry.lazy("tenancy.graphql.types")] | None
+    zone_templates: List[
+        Annotated[
+            "NetBoxDNSZoneTemplateType", strawberry.lazy("netbox_dns.graphql.types")
+        ]
+    ]

netbox_dns/management/commands/cleanup_database.py

@@ -2,12 +2,8 @@ from netaddr import IPAddress, IPNetwork, AddrFormatError
 
 from django.core.management.base import BaseCommand
 
-from netbox_dns.models import (
-    Zone,
-    ZoneStatusChoices,
-    Record,
-    RecordTypeChoices,
-)
+from netbox_dns.models import Zone, Record
+from netbox_dns.choices import ZoneStatusChoices, RecordTypeChoices
 
 
 def zone_rename_passive_status_to_parked(verbose=False):

netbox_dns/management/commands/cleanup_rrset_ttl.py

@@ -1,10 +1,8 @@
 from django.core.management.base import BaseCommand
 from django.db.models import Max, Min
 
-from netbox_dns.models import (
-    Record,
-    RecordTypeChoices,
-)
+from netbox_dns.models import Record
+from netbox_dns.choices import RecordTypeChoices
 
 
 class Command(BaseCommand):

netbox_dns/migrations/0001_squashed_netbox_dns_0_22.py

@@ -11,8 +11,7 @@ import taggit.managers
 import utilities.json
 from django.db import migrations, models
 
-
-from netbox_dns.models import RecordTypeChoices
+from netbox_dns.choices import RecordTypeChoices
 from netbox_dns.utilities import arpa_to_prefix
 
 

netbox_dns/migrations/0006_templating.py

@@ -0,0 +1,172 @@
+# Generated by Django 5.0.7 on 2024-07-12 11:38
+
+import django.db.models.deletion
+import taggit.managers
+import utilities.json
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("extras", "0115_convert_dashboard_widgets"),
+        ("netbox_dns", "0005_alter_zone_view_not_null"),
+        ("tenancy", "0015_contactassignment_rename_content_type"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="RecordTemplate",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True, primary_key=True, serialize=False
+                    ),
+                ),
+                ("created", models.DateTimeField(auto_now_add=True, null=True)),
+                ("last_updated", models.DateTimeField(auto_now=True, null=True)),
+                (
+                    "custom_field_data",
+                    models.JSONField(
+                        blank=True,
+                        default=dict,
+                        encoder=utilities.json.CustomFieldJSONEncoder,
+                    ),
+                ),
+                ("name", models.CharField(max_length=200, unique=True)),
+                ("record_name", models.CharField(max_length=255)),
+                ("description", models.CharField(blank=True, max_length=200)),
+                ("type", models.CharField()),
+                ("value", models.CharField(max_length=65535)),
+                ("status", models.CharField(default="active")),
+                ("ttl", models.PositiveIntegerField(blank=True, null=True)),
+                ("disable_ptr", models.BooleanField(default=False)),
+                (
+                    "tags",
+                    taggit.managers.TaggableManager(
+                        through="extras.TaggedItem", to="extras.Tag"
+                    ),
+                ),
+                (
+                    "tenant",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.PROTECT,
+                        related_name="+",
+                        to="tenancy.tenant",
+                    ),
+                ),
+            ],
+            options={
+                "ordering": ["name"],
+            },
+        ),
+        migrations.CreateModel(
+            name="ZoneTemplate",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True, primary_key=True, serialize=False
+                    ),
+                ),
+                ("created", models.DateTimeField(auto_now_add=True, null=True)),
+                ("last_updated", models.DateTimeField(auto_now=True, null=True)),
+                (
+                    "custom_field_data",
+                    models.JSONField(
+                        blank=True,
+                        default=dict,
+                        encoder=utilities.json.CustomFieldJSONEncoder,
+                    ),
+                ),
+                ("name", models.CharField(max_length=200, unique=True)),
+                ("description", models.CharField(blank=True, max_length=200)),
+                (
+                    "admin_c",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        related_name="+",
+                        to="netbox_dns.contact",
+                    ),
+                ),
+                (
+                    "billing_c",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        related_name="+",
+                        to="netbox_dns.contact",
+                    ),
+                ),
+                (
+                    "nameservers",
+                    models.ManyToManyField(
+                        blank=True, related_name="+", to="netbox_dns.nameserver"
+                    ),
+                ),
+                (
+                    "record_templates",
+                    models.ManyToManyField(
+                        blank=True,
+                        related_name="zone_templates",
+                        to="netbox_dns.recordtemplate",
+                    ),
+                ),
+                (
+                    "registrant",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        related_name="+",
+                        to="netbox_dns.contact",
+                    ),
+                ),
+                (
+                    "registrar",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        related_name="+",
+                        to="netbox_dns.registrar",
+                    ),
+                ),
+                (
+                    "tags",
+                    taggit.managers.TaggableManager(
+                        through="extras.TaggedItem", to="extras.Tag"
+                    ),
+                ),
+                (
+                    "tech_c",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        related_name="+",
+                        to="netbox_dns.contact",
+                    ),
+                ),
+                (
+                    "tenant",
+                    models.ForeignKey(
+                        blank=True,
+                        null=True,
+                        on_delete=django.db.models.deletion.SET_NULL,
+                        related_name="+",
+                        to="tenancy.tenant",
+                    ),
+                ),
+            ],
+            options={
+                "ordering": ["name"],
+            },
+        ),
+    ]

netbox_dns/migrations/0021_record_ip_address.py

@@ -5,7 +5,7 @@ import django.db.models.deletion
 from django.db import migrations, models
 
 import netbox_dns.fields.address
-from netbox_dns.models import RecordTypeChoices
+from netbox_dns.choices import RecordTypeChoices
 from netbox_dns.utilities import arpa_to_prefix
 
 

netbox_dns/mixins/object_modification.py

@@ -1,6 +1,9 @@
 from netbox.models import NetBoxModel
 
 
+__all__ = ("ObjectModificationMixin",)
+
+
 class ObjectModificationMixin:
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
@@ -12,6 +15,8 @@ class ObjectModificationMixin:
                 - {"id"}
             )
 
+            self.__class__.check_fields.add("custom_field_data")
+
     @property
     def changed_fields(self):
         if self.pk is None:

netbox_dns/models/__init__.py

@@ -4,5 +4,12 @@ from .record import *
 from .view import *
 from .contact import *
 from .registrar import *
+from .zone_template import *
+from .record_template import *
+
+# +
+# Backwards compatibility fix, will be removed in version 1.1
+# -
+from netbox_dns.choices import *
 
 from netbox_dns.signals import ipam_coupling

netbox_dns/models/contact.py

@@ -7,6 +7,12 @@ from netbox.search import SearchIndex, register_search
 from taggit.managers import TaggableManager
 
 
+__all__ = (
+    "Contact",
+    "ContactIndex",
+)
+
+
 class Contact(NetBoxModel):
     # +
     # Data fields according to https://www.icann.org/resources/pages/rdds-labeling-policy-2017-02-01-en

netbox_dns/models/nameserver.py

@@ -13,10 +13,17 @@ from netbox_dns.utilities import (
     normalize_name,
     NameFormatError,
 )
+from netbox_dns.choices import RecordTypeChoices
 from netbox_dns.validators import validate_fqdn
 from netbox_dns.mixins import ObjectModificationMixin
 
-from .record import Record, RecordTypeChoices
+from .record import Record
+
+
+__all__ = (
+    "NameServer",
+    "NameServerIndex",
+)
 
 
 class NameServer(ObjectModificationMixin, NetBoxModel):

netbox_dns/models/record.py

@@ -1,7 +1,6 @@
 import ipaddress
 
 import dns
-from dns import rdata, rdatatype, rdataclass
 from dns import name as dns_name
 
 from django.core.exceptions import ValidationError
@@ -13,24 +12,23 @@ from netbox.models import NetBoxModel
 from netbox.search import SearchIndex, register_search
 from netbox.plugins.utils import get_plugin_config
 from utilities.querysets import RestrictedQuerySet
-from utilities.choices import ChoiceSet
 
 from netbox_dns.fields import AddressField
-from netbox_dns.utilities import (
-    arpa_to_prefix,
-    name_to_unicode,
-)
-from netbox_dns.validators import (
-    validate_fqdn,
-    validate_generic_name,
-    validate_domain_name,
-)
+from netbox_dns.utilities import arpa_to_prefix, name_to_unicode
+from netbox_dns.validators import validate_generic_name, validate_record_value
 from netbox_dns.mixins import ObjectModificationMixin
+from netbox_dns.choices import RecordTypeChoices, RecordStatusChoices
 
 # +
 # This is a hack designed to break cyclic imports between Record and Zone
 # -
-import netbox_dns.models.zone as zone
+from netbox_dns.models import zone
+
+
+__all__ = (
+    "Record",
+    "RecordIndex",
+)
 
 
 def min_ttl(*ttl_list):
@@ -64,45 +62,6 @@ class RecordManager(models.Manager.from_queryset(RestrictedQuerySet)):
         )
 
 
-def initialize_choice_names(cls):
-    for choice in cls.CHOICES:
-        setattr(cls, choice[0], choice[0])
-    return cls
-
-
-@initialize_choice_names
-class RecordTypeChoices(ChoiceSet):
-    CHOICES = [
-        (rdtype.name, rdtype.name)
-        for rdtype in sorted(rdatatype.RdataType, key=lambda a: a.name)
-        if not rdatatype.is_metatype(rdtype)
-    ]
-    SINGLETONS = [
-        rdtype.name for rdtype in rdatatype.RdataType if rdatatype.is_singleton(rdtype)
-    ]
-
-
-@initialize_choice_names
-class RecordClassChoices(ChoiceSet):
-    CHOICES = [
-        (rdclass.name, rdclass.name)
-        for rdclass in sorted(rdataclass.RdataClass)
-        if not rdataclass.is_metaclass(rdclass)
-    ]
-
-
-class RecordStatusChoices(ChoiceSet):
-    key = "Record.status"
-
-    STATUS_ACTIVE = "active"
-    STATUS_INACTIVE = "inactive"
-
-    CHOICES = [
-        (STATUS_ACTIVE, "Active", "blue"),
-        (STATUS_INACTIVE, "Inactive", "red"),
-    ]
-
-
 class Record(ObjectModificationMixin, NetBoxModel):
     ACTIVE_STATUS_LIST = (RecordStatusChoices.STATUS_ACTIVE,)
 
@@ -513,78 +472,8 @@ class Record(ObjectModificationMixin, NetBoxModel):
                 ) from None
 
     def validate_value(self):
-        def _validate_idn(name):
-            try:
-                name.to_unicode()
-            except dns_name.IDNAException as exc:
-                raise ValidationError(
-                    f"{name.to_text()} is not a valid IDN: {exc}."
-                ) from None
-
         try:
-            rr = rdata.from_text(RecordClassChoices.IN, self.type, self.value)
-        except dns.exception.SyntaxError as exc:
-            raise ValidationError(
-                {
-                    "value": f"Record value {self.value} is not a valid value for a {self.type} record: {exc}."
-                }
-            ) from None
-
-        try:
-            match self.type:
-                case RecordTypeChoices.CNAME:
-                    _validate_idn(rr.target)
-                    validate_domain_name(
-                        rr.target.to_text(),
-                        always_tolerant=True,
-                        allow_empty_label=True,
-                    )
-
-                case (
-                    RecordTypeChoices.NS
-                    | RecordTypeChoices.HTTPS
-                    | RecordTypeChoices.SRV
-                    | RecordTypeChoices.SVCB
-                ):
-                    _validate_idn(rr.target)
-                    validate_domain_name(rr.target.to_text(), always_tolerant=True)
-
-                case RecordTypeChoices.DNAME:
-                    _validate_idn(rr.target)
-                    validate_domain_name(
-                        rr.target.to_text(), always_tolerant=True, zone_name=True
-                    )
-
-                case RecordTypeChoices.PTR | RecordTypeChoices.NSAP_PTR:
-                    _validate_idn(rr.target)
-                    validate_fqdn(rr.target.to_text(), always_tolerant=True)
-
-                case RecordTypeChoices.MX | RecordTypeChoices.RT | RecordTypeChoices.KX:
-                    _validate_idn(rr.exchange)
-                    validate_domain_name(rr.exchange.to_text(), always_tolerant=True)
-
-                case RecordTypeChoices.NSEC:
-                    _validate_idn(rr.next)
-                    validate_domain_name(rr.next.to_text(), always_tolerant=True)
-
-                case RecordTypeChoices.RP:
-                    _validate_idn(rr.mbox)
-                    validate_domain_name(rr.mbox.to_text(), always_tolerant=True)
-                    _validate_idn(rr.txt)
-                    validate_domain_name(rr.txt.to_text(), always_tolerant=True)
-
-                case RecordTypeChoices.NAPTR:
-                    _validate_idn(rr.replacement)
-                    validate_generic_name(
-                        rr.replacement.to_text(), always_tolerant=True
-                    )
-
-                case RecordTypeChoices.PX:
-                    _validate_idn(rr.map822)
-                    validate_domain_name(rr.map822.to_text(), always_tolerant=True)
-                    _validate_idn(rr.mapx400)
-                    validate_domain_name(rr.mapx400.to_text(), always_tolerant=True)
-
+            validate_record_value(self.type, self.value)
         except ValidationError as exc:
             raise ValidationError({"value": exc}) from None
 
@@ -631,6 +520,7 @@ class Record(ObjectModificationMixin, NetBoxModel):
             )
             .exclude(ttl=self.ttl)
             .exclude(type=RecordTypeChoices.PTR, managed=True)
+            .exclude(status=RecordStatusChoices.STATUS_INACTIVE)
         )
 
         if not records.exists():
@@ -665,6 +555,7 @@ class Record(ObjectModificationMixin, NetBoxModel):
             .exclude(pk=self.pk)
             .exclude(ttl=ttl)
             .exclude(type=RecordTypeChoices.PTR, managed=True)
+            .exclude(status=RecordStatusChoices.STATUS_INACTIVE)
         )
 
         for record in records: