netbox-plugin-dns 1.1.0__py3-none-any.whl → 1.1.0b1__py3-none-any.whl

netbox_dns/models/zone.py

@@ -3,8 +3,9 @@ from math import ceil
 from datetime import datetime
 
 from dns import name as dns_name
-from dns.exception import DNSException
 from dns.rdtypes.ANY import SOA
+from dns.exception import DNSException
+
 from django.core.validators import (
     MinValueValidator,
     MaxValueValidator,
@@ -18,7 +19,6 @@ from django.dispatch import receiver
 from django.conf import settings
 
 from netbox.models import NetBoxModel
-from netbox.models.features import ContactsMixin
 from netbox.search import SearchIndex, register_search
 from netbox.plugins.utils import get_plugin_config
 from utilities.querysets import RestrictedQuerySet
@@ -28,7 +28,6 @@ from netbox_dns.choices import RecordClassChoices, RecordTypeChoices, ZoneStatus
 from netbox_dns.fields import NetworkField, RFC2317NetworkField
 from netbox_dns.utilities import (
     update_dns_records,
-    check_dns_records,
     get_ip_addresses_by_zone,
     arpa_to_prefix,
     name_to_unicode,
@@ -36,7 +35,7 @@ from netbox_dns.utilities import (
     NameFormatError,
 )
 from netbox_dns.validators import (
-    validate_rname,
+    validate_fqdn,
     validate_domain_name,
 )
 from netbox_dns.mixins import ObjectModificationMixin
@@ -69,7 +68,7 @@ class ZoneManager(models.Manager.from_queryset(RestrictedQuerySet)):
         )
 
 
-class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
+class Zone(ObjectModificationMixin, NetBoxModel):
     ACTIVE_STATUS_LIST = (ZoneStatusChoices.STATUS_ACTIVE,)
 
     def __init__(self, *args, **kwargs):
@@ -78,7 +77,6 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
         super().__init__(*args, **kwargs)
 
         self._soa_serial_dirty = False
-        self._ip_addresses_checked = False
 
     view = models.ForeignKey(
         to="View",
@@ -192,7 +190,7 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
         null=True,
     )
     registrant = models.ForeignKey(
-        to="RegistrationContact",
+        to="Contact",
         on_delete=models.SET_NULL,
         verbose_name="Registrant",
         help_text="The owner of the domain",
@@ -200,7 +198,7 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
         null=True,
     )
     admin_c = models.ForeignKey(
-        to="RegistrationContact",
+        to="Contact",
         on_delete=models.SET_NULL,
         verbose_name="Admin Contact",
         related_name="admin_c_zones",
@@ -209,16 +207,16 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
         null=True,
     )
     tech_c = models.ForeignKey(
-        to="RegistrationContact",
+        to="Contact",
         on_delete=models.SET_NULL,
-        verbose_name="Technical Contact",
+        verbose_name="Tech Contact",
         related_name="tech_c_zones",
         help_text="The technical contact for the domain",
         blank=True,
         null=True,
     )
     billing_c = models.ForeignKey(
-        to="RegistrationContact",
+        to="Contact",
         on_delete=models.SET_NULL,
         verbose_name="Billing Contact",
         related_name="billing_c_zones",
@@ -249,7 +247,7 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
 
     objects = ZoneManager()
 
-    clone_fields = (
+    clone_fields = [
         "view",
         "name",
         "status",
@@ -263,12 +261,9 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
         "soa_expire",
         "soa_minimum",
         "description",
-    )
+    ]
 
     class Meta:
-        verbose_name = "Zone"
-        verbose_name_plural = "Zones"
-
         ordering = (
             "view",
             "name",
@@ -284,7 +279,7 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
         else:
             try:
                 name = dns_name.from_text(self.name, origin=None).to_unicode()
-            except DNSException:
+            except dns_name.IDNAException:
                 name = self.name
 
         try:
@@ -312,14 +307,6 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
     def soa_serial_dirty(self, soa_serial_dirty):
         self._soa_serial_dirty = soa_serial_dirty
 
-    @property
-    def ip_addresses_checked(self):
-        return self._ip_addresses_checked
-
-    @ip_addresses_checked.setter
-    def ip_addresses_checked(self, ip_addresses_checked):
-        self._ip_addresses_checked = ip_addresses_checked
-
     @property
     def display_name(self):
         return name_to_unicode(self.name)
@@ -633,7 +620,7 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
             raise ValidationError("soa_rname not set and no default value defined")
         try:
             dns_name.from_text(self.soa_rname, origin=dns_name.root)
-            validate_rname(self.soa_rname)
+            validate_fqdn(self.soa_rname)
         except (DNSException, ValidationError) as exc:
             raise ValidationError(
                 {
@@ -653,7 +640,7 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
             old_zone = Zone.objects.get(pk=self.pk)
             if not self.soa_serial_auto:
                 self.check_soa_serial_increment(old_zone.soa_serial, self.soa_serial)
-            elif not old_zone.soa_serial_auto:
+            else:
                 try:
                     self.check_soa_serial_increment(
                         old_zone.soa_serial, self.get_auto_serial()
@@ -665,26 +652,6 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
                         }
                     )
 
-            if (
-                not self.ip_addresses_checked
-                and old_zone.name != self.name
-                or old_zone.view != self.view
-            ):
-                ip_addresses = IPAddress.objects.filter(
-                    netbox_dns_records__in=self.record_set.filter(
-                        ipam_ip_address__isnull=False
-                    )
-                )
-                ip_addresses |= get_ip_addresses_by_zone(self)
-
-                for ip_address in ip_addresses.distinct():
-                    try:
-                        check_dns_records(ip_address, zone=self)
-                    except ValidationError as exc:
-                        raise ValidationError(exc.messages)
-
-                self.ip_addresses_checked = True
-
         if self.is_reverse_zone:
             self.arpa_network = self.network_from_name
 
@@ -799,13 +766,12 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
 
         elif changed_fields is not None and {"name", "view", "status"} & changed_fields:
             for address_record in self.record_set.filter(
-                type__in=(RecordTypeChoices.A, RecordTypeChoices.AAAA),
-                ipam_ip_address__isnull=True,
+                type__in=(RecordTypeChoices.A, RecordTypeChoices.AAAA)
             ):
                 address_record.save(update_fields=["ptr_record"])
 
         if changed_fields is not None and "name" in changed_fields:
-            for _record in self.record_set.filter(ipam_ip_address__isnull=True):
+            for _record in self.record_set.all():
                 _record.save(
                     update_fields=["fqdn"],
                     save_zone_serial=False,
@@ -814,14 +780,13 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
                 )
 
         if changed_fields is None or {"name", "view"} & changed_fields:
-            ip_addresses = IPAddress.objects.filter(
-                netbox_dns_records__in=self.record_set.filter(
+            update_ip_addresses = IPAddress.objects.filter(
+                pk__in=self.record_set.filter(
                     ipam_ip_address__isnull=False
-                )
+                ).values_list("ipam_ip_address", flat=True)
             )
-            ip_addresses |= get_ip_addresses_by_zone(self)
-
-            for ip_address in ip_addresses.distinct():
+            update_ip_addresses |= get_ip_addresses_by_zone(self)
+            for ip_address in update_ip_addresses:
                 update_dns_records(ip_address)
 
         self.save_soa_serial()
@@ -864,9 +829,7 @@ class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
                     netbox_dns_records__in=self.record_set.filter(
                         ipam_ip_address__isnull=False
                     )
-                )
-                .distinct()
-                .values_list("pk", flat=True)
+                ).values_list("pk", flat=True)
             )
 
             super().delete(*args, **kwargs)

netbox_dns/models/zone_template.py

@@ -47,7 +47,7 @@ class ZoneTemplate(NetBoxModel):
         null=True,
     )
     registrant = models.ForeignKey(
-        to="RegistrationContact",
+        to="Contact",
         on_delete=models.SET_NULL,
         related_name="+",
         help_text="The owner of the domain",
@@ -55,7 +55,7 @@ class ZoneTemplate(NetBoxModel):
         null=True,
     )
     admin_c = models.ForeignKey(
-        to="RegistrationContact",
+        to="Contact",
         on_delete=models.SET_NULL,
         verbose_name="Admin contact",
         related_name="+",
@@ -64,7 +64,7 @@ class ZoneTemplate(NetBoxModel):
         null=True,
     )
     tech_c = models.ForeignKey(
-        to="RegistrationContact",
+        to="Contact",
         on_delete=models.SET_NULL,
         verbose_name="Tech contact",
         related_name="+",
@@ -73,7 +73,7 @@ class ZoneTemplate(NetBoxModel):
         null=True,
     )
     billing_c = models.ForeignKey(
-        to="RegistrationContact",
+        to="Contact",
         on_delete=models.SET_NULL,
         verbose_name="Billing contact",
         related_name="+",
@@ -82,7 +82,7 @@ class ZoneTemplate(NetBoxModel):
         null=True,
     )
 
-    clone_fields = (
+    clone_fields = [
         "description",
         "nameservers",
         "record_templates",
@@ -92,22 +92,19 @@ class ZoneTemplate(NetBoxModel):
         "admin_c",
         "tech_c",
         "billing_c",
-    )
+    ]
 
-    template_fields = (
+    template_fields = [
         "tenant",
         "registrar",
         "registrant",
         "admin_c",
         "tech_c",
         "billing_c",
-    )
+    ]
 
     class Meta:
-        verbose_name = "Zone Template"
-        verbose_name_plural = "Zone Templates"
-
-        ordering = ("name",)
+        ordering = ["name"]
 
     def __str__(self):
         return str(self.name)

netbox_dns/navigation.py

@@ -151,21 +151,21 @@ registrar_menu_item = PluginMenuItem(
 )
 
 contact_menu_item = PluginMenuItem(
-    link="plugins:netbox_dns:registrationcontact_list",
-    link_text="Registration Contacts",
-    permissions=["netbox_dns.view_registrationcontact"],
+    link="plugins:netbox_dns:contact_list",
+    link_text="Contacts",
+    permissions=["netbox_dns.view_contact"],
     buttons=(
         PluginMenuButton(
-            "plugins:netbox_dns:registrationcontact_add",
+            "plugins:netbox_dns:contact_add",
             "Add",
             "mdi mdi-plus-thick",
-            permissions=["netbox_dns.add_registrationcontact"],
+            permissions=["netbox_dns.add_contact"],
         ),
         PluginMenuButton(
-            "plugins:netbox_dns:registrationcontact_import",
+            "plugins:netbox_dns:contact_import",
             "Import",
             "mdi mdi-upload",
-            permissions=["netbox_dns.add_registrationcontact"],
+            permissions=["netbox_dns.add_contact"],
         ),
     ),
 )

netbox_dns/signals/ipam_autodns.py

@@ -0,0 +1,138 @@
+from netaddr import IPNetwork
+
+from django.dispatch import receiver
+from django.db.models.signals import pre_delete, pre_save, post_save, m2m_changed
+from django.core.exceptions import ValidationError
+
+from netbox.context import current_request
+from netbox.signals import post_clean
+from ipam.models import IPAddress, Prefix
+from utilities.exceptions import AbortRequest
+
+from netbox_dns.models import view as _view
+from netbox_dns.utilities import (
+    update_dns_records,
+    delete_dns_records,
+    get_views_by_prefix,
+    get_ip_addresses_by_prefix,
+    get_ip_addresses_by_view,
+)
+
+
+@receiver(post_clean, sender=IPAddress)
+def ipam_autodns_ipaddress_post_clean(instance, **kwargs):
+    if not isinstance(instance.address, IPNetwork):
+        return
+
+    try:
+        update_dns_records(instance, commit=False)
+    except ValidationError as exc:
+        if hasattr(exc, "error_dict"):
+            for field in ("name", "ttl", "value", "type"):
+                value = exc.error_dict.pop(field, None)
+                if value is not None:
+                    raise ValidationError({"dns_name": value})
+
+        raise exc
+
+
+@receiver(pre_delete, sender=IPAddress)
+def ipam_autodns_ipaddress_pre_delete(instance, **kwargs):
+    delete_dns_records(instance)
+
+
+@receiver(pre_save, sender=IPAddress)
+def ipam_autodns_ipaddress_post_save(instance, **kwargs):
+    update_dns_records(instance, commit=False)
+
+
+@receiver(post_save, sender=IPAddress)
+def ipam_autodns_ipaddress_post_save(instance, **kwargs):
+    update_dns_records(instance)
+
+
+@receiver(pre_save, sender=Prefix)
+def ipam_autodns_prefix_pre_save(instance, **kwargs):
+    """
+    Changes that modify the prefix hierarchy cannot be validated properly before
+    commiting them. So the solution in this case is to remove a prefix whose
+    VRF or network has changed from all views it currently is assigned to.
+    """
+    if instance.pk is None or not instance.netbox_dns_views.exists():
+        return
+
+    saved_prefix = Prefix.objects.get(pk=instance.pk)
+    if saved_prefix.prefix != instance.prefix or saved_prefix.vrf != instance.vrf:
+        for view in saved_prefix.netbox_dns_views.all():
+            view.prefixes.remove(saved_prefix)
+
+
+@receiver(pre_delete, sender=Prefix)
+def ipam_autodns_prefix_pre_delete(instance, **kwargs):
+    parent = instance.get_parents().last()
+    request = current_request.get()
+
+    if parent is not None and get_views_by_prefix(instance) != get_views_by_prefix(
+        parent
+    ):
+        try:
+            for prefix in instance.get_children().filter(
+                _depth=instance.depth + 1, netbox_dns_views__isnull=True
+            ):
+                for ip_address in get_ip_addresses_by_prefix(prefix):
+                    update_dns_records(ip_address, commit=False)
+        except ValidationError as exc:
+            if request is not None:
+                raise AbortRequest(
+                    f"Prefix deletion would cause DNS errors: {exc.messages[0]} "
+                    "Please review DNS View assignments for this and the parent prefix"
+                )
+            else:
+                raise exc
+
+    # +
+    # CAUTION: This only works because the NetBox workaround for an ancient
+    # Django bug (see https://code.djangoproject.com/ticket/17688) has already
+    # removed the relations between the prefix and the views when this signal
+    # handler runs.
+    #
+    # Should anything be fixed, this code will stop working and need to be
+    # revisited.
+    #
+    # The NetBox workaround only works for requests, not for model level
+    # operations. The following code replicates it for non-requests.
+    # -
+    if request is None:
+        for view in instance.netbox_dns_views.all():
+            view.snapshot()
+            view.prefixes.remove(instance)
+
+    for ip_address in get_ip_addresses_by_prefix(instance):
+        update_dns_records(ip_address)
+
+
+@receiver(m2m_changed, sender=_view.View.prefixes.through)
+def ipam_autodns_view_prefix_changed(**kwargs):
+    action = kwargs.get("action")
+    request = current_request.get()
+
+    # +
+    # Handle all post_add and post_remove signals except the ones directly
+    # handled by the pre_delete handler for the Prefix model.
+    #
+    # Yes. This IS ugly.
+    # -
+    if action not in ("post_add", "post_remove") or (
+        request is not None
+        and action == "post_remove"
+        and (
+            request.path.startswith("/ipam/prefixes/")
+            or request.path.startswith("/api/ipam/prefixes/")
+        )
+    ):
+        return
+
+    check_view = action != "post_remove"
+    for prefix in Prefix.objects.filter(pk__in=kwargs.get("pk_set")):
+        for ip_address in get_ip_addresses_by_prefix(prefix, check_view=check_view):
+            update_dns_records(ip_address)

netbox_dns/tables/__init__.py

@@ -2,7 +2,7 @@ from .view import *
 from .zone import *
 from .nameserver import *
 from .record import *
-from .registration_contact import *
+from .contact import *
 from .registrar import *
 from .zone_template import *
 from .record_template import *

netbox_dns/tables/{registration_contact.py → contact.py}

@@ -2,23 +2,24 @@ import django_tables2 as tables
 
 from netbox.tables import NetBoxTable, TagColumn
 
-from netbox_dns.models import RegistrationContact
+from netbox_dns.models import Contact
 
 
-__all__ = ("RegistrationContactTable",)
+__all__ = ("ContactTable",)
 
 
-class RegistrationContactTable(NetBoxTable):
+class ContactTable(NetBoxTable):
     contact_id = tables.Column(
         linkify=True,
     )
     tags = TagColumn(
-        url_name="plugins:netbox_dns:registrationcontact_list",
+        url_name="plugins:netbox_dns:contact_list",
     )
 
     class Meta(NetBoxTable.Meta):
-        model = RegistrationContact
+        model = Contact
         fields = (
+            "contact_id",
             "name",
             "description",
             "organization",

netbox_dns/tables/nameserver.py

@@ -22,7 +22,13 @@ class NameServerTable(TenancyColumnsMixin, NetBoxTable):
 
     class Meta(NetBoxTable.Meta):
         model = NameServer
-        fields = ("description",)
+        fields = (
+            "name",
+            "description",
+            "tags",
+            "tenant",
+            "tenant_group",
+        )
         default_columns = (
             "name",
             "tags",

netbox_dns/tables/record.py

@@ -1,6 +1,4 @@
 import django_tables2 as tables
-from django.utils.html import format_html
-
 
 from netbox.tables import (
     NetBoxTable,
@@ -13,10 +11,6 @@ from tenancy.tables import TenancyColumnsMixin
 from netbox_dns.models import Record
 from netbox_dns.utilities import value_to_unicode
 
-import logging
-
-logger = logging.getLogger("netbox_dns")
-
 
 __all__ = (
     "RecordTable",
@@ -29,18 +23,10 @@ class RecordBaseTable(TenancyColumnsMixin, NetBoxTable):
     zone = tables.Column(
         linkify=True,
     )
-    view = tables.Column(
-        accessor="zone__view",
-        linkify=True,
-    )
     type = tables.Column()
     name = tables.Column(
         linkify=True,
     )
-    fqdn = tables.Column(
-        verbose_name="FQDN",
-        linkify=True,
-    )
     value = tables.TemplateColumn(
         template_code="{{ value|truncatechars:64 }}",
     )
@@ -79,8 +65,20 @@ class RecordTable(RecordBaseTable):
     class Meta(NetBoxTable.Meta):
         model = Record
         fields = (
+            "name",
+            "zone",
+            "ttl",
+            "type",
+            "value",
+            "unicode_value",
             "status",
+            "disable_ptr",
+            "ptr_record",
+            "tags",
+            "active",
             "description",
+            "tenant",
+            "tenant_group",
         )
         default_columns = (
             "name",
@@ -102,16 +100,21 @@ class ManagedRecordTable(RecordBaseTable):
         verbose_name="IPAM IP Address",
         linkify=True,
     )
-    related_ip_address = tables.Column(
-        verbose_name="Related IP Address",
-        empty_values=(),
-        orderable=False,
-    )
     actions = ActionsColumn(actions=("changelog",))
 
     class Meta(NetBoxTable.Meta):
         model = Record
-        fields = ()
+        fields = (
+            "name",
+            "zone",
+            "ttl",
+            "type",
+            "value",
+            "unicode_value",
+            "address_record",
+            "ipam_ip_address",
+            "active",
+        )
         default_columns = (
             "name",
             "zone",
@@ -121,35 +124,19 @@ class ManagedRecordTable(RecordBaseTable):
             "active",
         )
 
-    def render_related_ip_address(self, record):
-        if record.ipam_ip_address is not None:
-            address = record.ipam_ip_address
-        elif (
-            hasattr(record, "address_record")
-            and record.address_record.ipam_ip_address is not None
-        ):
-            address = record.address_record.ipam_ip_address
-        else:
-            return format_html("—")
-
-        return format_html(f"<a href='{address.get_absolute_url()}'>{address}</a>")
-
-    def value_related_ip_address(self, record):
-        if record.ipam_ip_address is not None:
-            return record.ipam_ip_address
-        elif (
-            hasattr(record, "address_record")
-            and record.address_record.ipam_ip_address is not None
-        ):
-            return record.address_record.ipam_ip_address
-
 
 class RelatedRecordTable(RecordBaseTable):
     actions = ActionsColumn(actions=())
 
     class Meta(NetBoxTable.Meta):
         model = Record
-        fields = ()
+        fields = (
+            "name",
+            "zone",
+            "type",
+            "value",
+            "unicode_value",
+        )
         default_columns = (
             "name",
             "zone",

netbox_dns/tables/record_template.py

@@ -43,8 +43,18 @@ class RecordTemplateTable(TenancyColumnsMixin, NetBoxTable):
     class Meta(NetBoxTable.Meta):
         model = RecordTemplate
         fields = (
+            "name",
+            "record_name",
+            "ttl",
+            "type",
+            "value",
+            "unicode_value",
             "status",
+            "disable_ptr",
+            "tags",
             "description",
+            "tenant",
+            "tenant_group",
         )
         default_columns = (
             "name",
@@ -62,7 +72,14 @@ class RecordTemplateDisplayTable(RecordTemplateTable):
     class Meta(NetBoxTable.Meta):
         model = RecordTemplate
         fields = (
+            "name",
+            "record_name",
+            "ttl",
+            "type",
+            "value",
+            "unicode_value",
             "status",
+            "disable_ptr",
             "description",
         )
         default_columns = (

netbox_dns/tables/registrar.py

@@ -19,11 +19,13 @@ class RegistrarTable(NetBoxTable):
     class Meta(NetBoxTable.Meta):
         model = Registrar
         fields = (
+            "name",
             "description",
             "iana_id",
             "referral_url",
             "whois_server",
             "abuse_email",
             "abuse_phone",
+            "tags",
         )
         default_columns = ("name", "iana_id", "referral_url")