netbox-plugin-dns 1.0.3__py3-none-any.whl → 1.0.5__py3-none-any.whl

netbox_dns/models/record_template.py

@@ -0,0 +1,180 @@
+import dns
+from dns import name as dns_name
+
+from django.core.exceptions import ValidationError
+from django.db import models
+from django.urls import reverse
+
+from netbox.models import NetBoxModel
+from netbox.search import SearchIndex, register_search
+from netbox.plugins.utils import get_plugin_config
+
+from netbox_dns.choices import RecordTypeChoices, RecordStatusChoices
+from netbox_dns.validators import validate_generic_name, validate_record_value
+
+from .record import Record
+
+
+__ALL__ = (
+    "RecordTemplate",
+    "RecordTemplateIndex",
+)
+
+
+class RecordTemplate(NetBoxModel):
+    name = models.CharField(
+        verbose_name="Template name",
+        unique=True,
+        max_length=200,
+    )
+    record_name = models.CharField(
+        verbose_name="Name",
+        max_length=255,
+    )
+    description = models.CharField(
+        max_length=200,
+        blank=True,
+    )
+    type = models.CharField(
+        choices=RecordTypeChoices,
+    )
+    value = models.CharField(
+        max_length=65535,
+    )
+    status = models.CharField(
+        choices=RecordStatusChoices,
+        default=RecordStatusChoices.STATUS_ACTIVE,
+        blank=False,
+    )
+    ttl = models.PositiveIntegerField(
+        verbose_name="TTL",
+        null=True,
+        blank=True,
+    )
+    disable_ptr = models.BooleanField(
+        verbose_name="Disable PTR",
+        help_text="Disable PTR record creation",
+        default=False,
+    )
+    tenant = models.ForeignKey(
+        to="tenancy.Tenant",
+        on_delete=models.PROTECT,
+        related_name="+",
+        blank=True,
+        null=True,
+    )
+
+    clone_fields = (
+        "record_name",
+        "description",
+        "type",
+        "value",
+        "status",
+        "ttl",
+        "disable_ptr",
+        "tenant",
+    )
+
+    template_fields = (
+        "type",
+        "value",
+        "status",
+        "ttl",
+        "disable_ptr",
+        "tenant",
+    )
+
+    class Meta:
+        ordering = ["name"]
+
+    def __str__(self):
+        return str(self.name)
+
+    def get_status_color(self):
+        return RecordStatusChoices.colors.get(self.status)
+
+    def get_absolute_url(self):
+        return reverse("plugins:netbox_dns:recordtemplate", kwargs={"pk": self.pk})
+
+    def validate_name(self):
+        try:
+            name = dns_name.from_text(self.record_name, origin=None)
+            name.to_unicode()
+
+        except dns.exception.DNSException as exc:
+            raise ValidationError({"record_name": str(exc)})
+
+        if self.type not in get_plugin_config(
+            "netbox_dns", "tolerate_non_rfc1035_types", default=[]
+        ):
+            try:
+                validate_generic_name(
+                    self.record_name,
+                    (
+                        self.type
+                        in get_plugin_config(
+                            "netbox_dns",
+                            "tolerate_leading_underscore_types",
+                            default=[],
+                        )
+                    ),
+                )
+            except ValidationError as exc:
+                raise ValidationError(
+                    {
+                        "record_name": exc,
+                    }
+                ) from None
+
+    def validate_value(self):
+        try:
+            validate_record_value(self.type, self.value)
+        except ValidationError as exc:
+            raise ValidationError({"value": exc}) from None
+
+    def matching_records(self, zone):
+        return Record.objects.filter(
+            zone=zone, name=self.record_name, type=self.type, value=self.value
+        )
+
+    def create_record(self, zone):
+        if self.matching_records(zone).exists():
+            return
+
+        record_data = {
+            "zone": zone,
+            "name": self.record_name,
+        }
+        for field in self.template_fields:
+            record_data[field] = getattr(self, field)
+
+        try:
+            record = Record.objects.create(**record_data)
+        except ValidationError as exc:
+            raise ValidationError(
+                f"Error while processing record template {self}: {exc.messages[0]}"
+            )
+
+        if tags := self.tags.all():
+            record.tags.set(tags)
+
+    def clean_fields(self, *args, **kwargs):
+        self.type = self.type.upper()
+        super().clean_fields(*args, **kwargs)
+
+    def clean(self, *args, **kwargs):
+        self.validate_name()
+        self.validate_value()
+
+        super().clean(*args, **kwargs)
+
+
+@register_search
+class RecordTemplateIndex(SearchIndex):
+    model = RecordTemplate
+    fields = (
+        ("name", 100),
+        ("record_name", 120),
+        ("value", 150),
+        ("type", 200),
+    )

netbox_dns/models/registrar.py

@@ -5,6 +5,12 @@ from netbox.models import NetBoxModel
 from netbox.search import SearchIndex, register_search
 
 
+__ALL__ = (
+    "Registrar",
+    "RegistrarIndex",
+)
+
+
 class Registrar(NetBoxModel):
     # +
     # Data fields according to https://www.icann.org/resources/pages/rdds-labeling-policy-2017-02-01-en

netbox_dns/models/view.py

@@ -10,6 +10,12 @@ from utilities.exceptions import AbortRequest
 from netbox_dns.mixins import ObjectModificationMixin
 
 
+__ALL__ = (
+    "View",
+    "ViewIndex",
+)
+
+
 class View(ObjectModificationMixin, NetBoxModel):
     name = models.CharField(
         unique=True,
@@ -54,7 +60,7 @@ class View(ObjectModificationMixin, NetBoxModel):
 
         super().delete(*args, **kwargs)
 
-    def clean(self, *args, old_state=None, **kwargs):
+    def clean(self, *args, **kwargs):
         if (changed_fields := self.changed_fields) is None:
             return
 

netbox_dns/models/zone.py

@@ -22,9 +22,9 @@ 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 ipam.models import IPAddress
 
+from netbox_dns.choices import RecordClassChoices, RecordTypeChoices, ZoneStatusChoices
 from netbox_dns.fields import NetworkField, RFC2317NetworkField
 from netbox_dns.utilities import (
     arpa_to_prefix,
@@ -38,12 +38,15 @@ from netbox_dns.validators import (
 )
 from netbox_dns.mixins import ObjectModificationMixin
 
-# +
-# This is a hack designed to break cyclic imports between View, Record and Zone
-# -
-import netbox_dns.models.record as record
-import netbox_dns.models.view as view
-import netbox_dns.models.nameserver as nameserver
+from .record import Record
+from .view import View
+from .nameserver import NameServer
+
+
+__ALL__ = (
+    "Zone",
+    "ZoneIndex",
+)
 
 
 class ZoneManager(models.Manager.from_queryset(RestrictedQuerySet)):
@@ -63,24 +66,15 @@ class ZoneManager(models.Manager.from_queryset(RestrictedQuerySet)):
         )
 
 
-class ZoneStatusChoices(ChoiceSet):
-    key = "Zone.status"
-
-    STATUS_ACTIVE = "active"
-    STATUS_RESERVED = "reserved"
-    STATUS_DEPRECATED = "deprecated"
-    STATUS_PARKED = "parked"
+class Zone(ObjectModificationMixin, NetBoxModel):
+    ACTIVE_STATUS_LIST = (ZoneStatusChoices.STATUS_ACTIVE,)
 
-    CHOICES = [
-        (STATUS_ACTIVE, "Active", "blue"),
-        (STATUS_RESERVED, "Reserved", "cyan"),
-        (STATUS_DEPRECATED, "Deprecated", "red"),
-        (STATUS_PARKED, "Parked", "gray"),
-    ]
+    def __init__(self, *args, **kwargs):
+        kwargs.pop("template", None)
 
+        super().__init__(*args, **kwargs)
 
-class Zone(ObjectModificationMixin, NetBoxModel):
-    ACTIVE_STATUS_LIST = (ZoneStatusChoices.STATUS_ACTIVE,)
+        self._soa_serial_dirty = False
 
     view = models.ForeignKey(
         to="View",
@@ -249,8 +243,6 @@ class Zone(ObjectModificationMixin, NetBoxModel):
         null=True,
     )
 
-    soa_serial_dirty = False
-
     objects = ZoneManager()
 
     clone_fields = [
@@ -288,8 +280,11 @@ class Zone(ObjectModificationMixin, NetBoxModel):
             except dns_name.IDNAException:
                 name = self.name
 
-        if not self.view.default_view:
-            return f"[{self.view}] {name}"
+        try:
+            if not self.view.default_view:
+                return f"[{self.view}] {name}"
+        except ObjectDoesNotExist:
+            return f"[<no view assigned>] {name}"
 
         return str(name)
 
@@ -302,6 +297,14 @@ class Zone(ObjectModificationMixin, NetBoxModel):
             and field not in ("zone_soa_mname", "zone_nameservers")
         }
 
+    @property
+    def soa_serial_dirty(self):
+        return self._soa_serial_dirty
+
+    @soa_serial_dirty.setter
+    def soa_serial_dirty(self, soa_serial_dirty):
+        self._soa_serial_dirty = soa_serial_dirty
+
     @property
     def display_name(self):
         return name_to_unicode(self.name)
@@ -371,7 +374,7 @@ class Zone(ObjectModificationMixin, NetBoxModel):
             return None
 
     def record_count(self, managed=False):
-        return record.Record.objects.filter(zone=self, managed=managed).count()
+        return Record.objects.filter(zone=self, managed=managed).count()
 
     def rfc2317_child_zone_count(self):
         return Zone.objects.filter(rfc2317_parent_zone=self).count()
@@ -380,8 +383,8 @@ class Zone(ObjectModificationMixin, NetBoxModel):
         soa_name = "@"
         soa_ttl = self.soa_ttl
         soa_rdata = SOA.SOA(
-            rdclass=record.RecordClassChoices.IN,
-            rdtype=record.RecordTypeChoices.SOA,
+            rdclass=RecordClassChoices.IN,
+            rdtype=RecordTypeChoices.SOA,
             mname=self.soa_mname.name,
             rname=self.soa_rname,
             serial=self.soa_serial,
@@ -392,9 +395,7 @@ class Zone(ObjectModificationMixin, NetBoxModel):
         )
 
         try:
-            soa_record = self.record_set.get(
-                type=record.RecordTypeChoices.SOA, name=soa_name
-            )
+            soa_record = self.record_set.get(type=RecordTypeChoices.SOA, name=soa_name)
 
             if soa_record.ttl != soa_ttl or soa_record.value != soa_rdata.to_text():
                 soa_record.ttl = soa_ttl
@@ -402,10 +403,10 @@ class Zone(ObjectModificationMixin, NetBoxModel):
                 soa_record.managed = True
                 soa_record.save()
 
-        except record.Record.DoesNotExist:
-            record.Record.objects.create(
+        except Record.DoesNotExist:
+            Record.objects.create(
                 zone_id=self.pk,
-                type=record.RecordTypeChoices.SOA,
+                type=RecordTypeChoices.SOA,
                 name=soa_name,
                 ttl=soa_ttl,
                 value=soa_rdata.to_text(),
@@ -417,14 +418,14 @@ class Zone(ObjectModificationMixin, NetBoxModel):
 
         nameservers = [f"{nameserver.name}." for nameserver in self.nameservers.all()]
 
-        self.record_set.filter(type=record.RecordTypeChoices.NS, managed=True).exclude(
+        self.record_set.filter(type=RecordTypeChoices.NS, managed=True).exclude(
             value__in=nameservers
         ).delete()
 
         for ns in nameservers:
-            record.Record.raw_objects.update_or_create(
+            Record.raw_objects.update_or_create(
                 zone_id=self.pk,
-                type=record.RecordTypeChoices.NS,
+                type=RecordTypeChoices.NS,
                 name=ns_name,
                 value=ns,
                 managed=True,
@@ -452,14 +453,11 @@ class Zone(ObjectModificationMixin, NetBoxModel):
                 continue
 
             relative_name = name.relativize(parent).to_text()
-            address_records = record.Record.objects.filter(
+            address_records = Record.objects.filter(
                 Q(zone=ns_zone),
-                Q(status__in=record.Record.ACTIVE_STATUS_LIST),
+                Q(status__in=Record.ACTIVE_STATUS_LIST),
                 Q(Q(name=f"{_nameserver.name}.") | Q(name=relative_name)),
-                Q(
-                    Q(type=record.RecordTypeChoices.A)
-                    | Q(type=record.RecordTypeChoices.AAAA)
-                ),
+                Q(Q(type=RecordTypeChoices.A) | Q(type=RecordTypeChoices.AAAA)),
             )
 
             if not address_records:
@@ -482,8 +480,8 @@ class Zone(ObjectModificationMixin, NetBoxModel):
             )
 
     def get_auto_serial(self):
-        records = record.Record.objects.filter(zone_id=self.pk).exclude(
-            type=record.RecordTypeChoices.SOA
+        records = Record.objects.filter(zone_id=self.pk).exclude(
+            type=RecordTypeChoices.SOA
         )
         if records:
             soa_serial = (
@@ -541,7 +539,7 @@ class Zone(ObjectModificationMixin, NetBoxModel):
                 self.save(update_fields=["rfc2317_parent_zone"])
 
         ptr_records = self.record_set.filter(
-            type=record.RecordTypeChoices.PTR
+            type=RecordTypeChoices.PTR
         ).prefetch_related("zone", "rfc2317_cname_record")
         ptr_zones = {ptr_record.zone for ptr_record in ptr_records}
 
@@ -576,7 +574,7 @@ class Zone(ObjectModificationMixin, NetBoxModel):
         defaults = settings.PLUGINS_CONFIG.get("netbox_dns")
 
         if self.view_id is None:
-            self.view_id = view.View.get_default_view().pk
+            self.view_id = View.get_default_view().pk
 
         for field, value in self.get_defaults().items():
             if getattr(self, field) in (None, ""):
@@ -586,10 +584,8 @@ class Zone(ObjectModificationMixin, NetBoxModel):
         if self.soa_mname_id is None:
             default_soa_mname = defaults.get("zone_soa_mname")
             try:
-                self.soa_mname = nameserver.NameServer.objects.get(
-                    name=default_soa_mname
-                )
-            except nameserver.NameServer.DoesNotExist:
+                self.soa_mname = NameServer.objects.get(name=default_soa_mname)
+            except NameServer.DoesNotExist:
                 raise ValidationError(
                     f"Default soa_mname instance {default_soa_mname} does not exist"
                 )
@@ -715,12 +711,9 @@ class Zone(ObjectModificationMixin, NetBoxModel):
                 view=self.view,
                 arpa_network__net_contains_or_equals=self.arpa_network,
             )
-            address_records = record.Record.objects.filter(
+            address_records = Record.objects.filter(
                 Q(ptr_record__isnull=True) | Q(ptr_record__zone__in=zones),
-                type__in=(
-                    record.RecordTypeChoices.A,
-                    record.RecordTypeChoices.AAAA,
-                ),
+                type__in=(RecordTypeChoices.A, RecordTypeChoices.AAAA),
                 disable_ptr=False,
             )
 
@@ -749,11 +742,11 @@ class Zone(ObjectModificationMixin, NetBoxModel):
                 view=self.view,
                 arpa_network__net_contains=self.rfc2317_prefix,
             )
-            address_records = record.Record.objects.filter(
+            address_records = Record.objects.filter(
                 Q(ptr_record__isnull=True)
                 | Q(ptr_record__zone__in=zones)
                 | Q(ptr_record__zone=self),
-                type=record.RecordTypeChoices.A,
+                type=RecordTypeChoices.A,
                 disable_ptr=False,
             )
 
@@ -771,7 +764,7 @@ class Zone(ObjectModificationMixin, NetBoxModel):
 
         elif changed_fields is not None and {"name", "view", "status"} & changed_fields:
             for address_record in self.record_set.filter(
-                type__in=(record.RecordTypeChoices.A, record.RecordTypeChoices.AAAA)
+                type__in=(RecordTypeChoices.A, RecordTypeChoices.AAAA)
             ):
                 address_record.save(update_fields=["ptr_record"])
 
@@ -809,9 +802,7 @@ class Zone(ObjectModificationMixin, NetBoxModel):
             ptr_records = self.record_set.filter(address_record__isnull=False)
             update_records = [
                 address_record.pk
-                for address_record in record.Record.objects.filter(
-                    ptr_record__in=ptr_records
-                )
+                for address_record in Record.objects.filter(ptr_record__in=ptr_records)
             ]
 
             cname_records = {
@@ -842,9 +833,9 @@ class Zone(ObjectModificationMixin, NetBoxModel):
 
             super().delete(*args, **kwargs)
 
-        address_records = record.Record.objects.filter(
-            pk__in=update_records
-        ).prefetch_related("zone")
+        address_records = Record.objects.filter(pk__in=update_records).prefetch_related(
+            "zone"
+        )
 
         for address_record in address_records:
             address_record.save(save_zone_serial=False)

netbox_dns/models/zone_template.py

@@ -0,0 +1,149 @@
+from django.db import models
+from django.urls import reverse
+
+from netbox.models import NetBoxModel
+from netbox.search import SearchIndex, register_search
+
+
+__ALL__ = (
+    "ZoneTemplate",
+    "ZoneTemplateIndex",
+)
+
+
+class ZoneTemplate(NetBoxModel):
+    name = models.CharField(
+        verbose_name="Template name",
+        unique=True,
+        max_length=200,
+    )
+    description = models.CharField(
+        max_length=200,
+        blank=True,
+    )
+    nameservers = models.ManyToManyField(
+        to="NameServer",
+        related_name="+",
+        blank=True,
+    )
+    record_templates = models.ManyToManyField(
+        to="RecordTemplate",
+        related_name="zone_templates",
+        blank=True,
+    )
+    tenant = models.ForeignKey(
+        to="tenancy.Tenant",
+        on_delete=models.SET_NULL,
+        related_name="+",
+        blank=True,
+        null=True,
+    )
+    registrar = models.ForeignKey(
+        to="Registrar",
+        on_delete=models.SET_NULL,
+        related_name="+",
+        help_text="The external registrar the domain is registered with",
+        blank=True,
+        null=True,
+    )
+    registrant = models.ForeignKey(
+        to="Contact",
+        on_delete=models.SET_NULL,
+        related_name="+",
+        help_text="The owner of the domain",
+        blank=True,
+        null=True,
+    )
+    admin_c = models.ForeignKey(
+        to="Contact",
+        on_delete=models.SET_NULL,
+        verbose_name="Admin contact",
+        related_name="+",
+        help_text="The administrative contact for the domain",
+        blank=True,
+        null=True,
+    )
+    tech_c = models.ForeignKey(
+        to="Contact",
+        on_delete=models.SET_NULL,
+        verbose_name="Tech contact",
+        related_name="+",
+        help_text="The technical contact for the domain",
+        blank=True,
+        null=True,
+    )
+    billing_c = models.ForeignKey(
+        to="Contact",
+        on_delete=models.SET_NULL,
+        verbose_name="Billing contact",
+        related_name="+",
+        help_text="The billing contact for the domain",
+        blank=True,
+        null=True,
+    )
+
+    clone_fields = [
+        "description",
+        "nameservers",
+        "tenant",
+        "registrar",
+        "registrant",
+        "admin_c",
+        "tech_c",
+        "billing_c",
+    ]
+
+    template_fields = [
+        "tenant",
+        "registrar",
+        "registrant",
+        "admin_c",
+        "tech_c",
+        "billing_c",
+    ]
+
+    class Meta:
+        ordering = ["name"]
+
+    def __str__(self):
+        return str(self.name)
+
+    def get_absolute_url(self):
+        return reverse("plugins:netbox_dns:zonetemplate", kwargs={"pk": self.pk})
+
+    def apply_to_zone(self, zone):
+        if not zone.nameservers.all() and self.nameservers.all():
+            zone.nameservers.set(self.nameservers.all())
+
+        if not zone.tags.all() and self.tags.all():
+            zone.tags.set(self.tags.all())
+
+        fields_changed = True
+        for field in self.template_fields:
+            if getattr(zone, field) is None and getattr(self, field) is not None:
+                fields_changed = True
+                setattr(zone, field, getattr(self, field))
+
+        if fields_changed:
+            zone.save()
+
+        self.create_records(zone)
+
+    def create_records(self, zone):
+        for record_template in self.record_templates.all():
+            record_template.create_record(zone=zone)
+
+
+@register_search
+class ZoneTemplateIndex(SearchIndex):
+    model = ZoneTemplate
+    fields = (
+        ("name", 100),
+        ("tenant", 300),
+        ("registrar", 300),
+        ("registrant", 300),
+        ("admin_c", 300),
+        ("tech_c", 300),
+        ("billing_c", 300),
+        ("description", 500),
+    )