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

netbox_dns/models/zone_template.py

@@ -47,7 +47,7 @@ class ZoneTemplate(NetBoxModel):
         null=True,
     )
     registrant = models.ForeignKey(
-        to="Contact",
+        to="RegistrationContact",
         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="Contact",
+        to="RegistrationContact",
         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="Contact",
+        to="RegistrationContact",
         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="Contact",
+        to="RegistrationContact",
         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,19 +92,22 @@ class ZoneTemplate(NetBoxModel):
         "admin_c",
         "tech_c",
         "billing_c",
-    ]
+    )
 
-    template_fields = [
+    template_fields = (
         "tenant",
         "registrar",
         "registrant",
         "admin_c",
         "tech_c",
         "billing_c",
-    ]
+    )
 
     class Meta:
-        ordering = ["name"]
+        verbose_name = "Zone Template"
+        verbose_name_plural = "Zone Templates"
+
+        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:contact_list",
-    link_text="Contacts",
-    permissions=["netbox_dns.view_contact"],
+    link="plugins:netbox_dns:registrationcontact_list",
+    link_text="Registration Contacts",
+    permissions=["netbox_dns.view_registrationcontact"],
     buttons=(
         PluginMenuButton(
-            "plugins:netbox_dns:contact_add",
+            "plugins:netbox_dns:registrationcontact_add",
             "Add",
             "mdi mdi-plus-thick",
-            permissions=["netbox_dns.add_contact"],
+            permissions=["netbox_dns.add_registrationcontact"],
         ),
         PluginMenuButton(
-            "plugins:netbox_dns:contact_import",
+            "plugins:netbox_dns:registrationcontact_import",
             "Import",
             "mdi mdi-upload",
-            permissions=["netbox_dns.add_contact"],
+            permissions=["netbox_dns.add_registrationcontact"],
         ),
     ),
 )

netbox_dns/signals/ipam_dnssync.py

@@ -0,0 +1,224 @@
+from netaddr import IPNetwork
+
+from django.conf import settings
+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 (
+    check_dns_records,
+    check_record_permission,
+    update_dns_records,
+    delete_dns_records,
+    get_views_by_prefix,
+    get_ip_addresses_by_prefix,
+)
+
+DNSSYNC_CUSTOM_FIELDS = {
+    "ipaddress_dns_disabled": False,
+    "ipaddress_dns_record_ttl": None,
+    "ipaddress_dns_record_disable_ptr": False,
+}
+
+IPADDRESS_ACTIVE_STATUS = settings.PLUGINS_CONFIG["netbox_dns"][
+    "dnssync_ipaddress_active_status"
+]
+ENFORCE_UNIQUE_RECORDS = settings.PLUGINS_CONFIG["netbox_dns"]["enforce_unique_records"]
+
+
+@receiver(post_clean, sender=IPAddress)
+def ipam_dnssync_ipaddress_post_clean(instance, **kwargs):
+    if not isinstance(instance.address, IPNetwork):
+        return
+
+    if instance.custom_field_data.get("ipaddress_dns_disabled"):
+        return
+
+    # +
+    # Check for uniqueness of IP address and dns_name. If unique records are
+    # enforced, report an error when trying to create the same IP address with
+    # the same dns_name. Ignore existing IP addresses that have their CF
+    # "ipaddress_dns_disabled" set to "True".
+    # -
+    duplicate_addresses = IPAddress.objects.filter(
+        address=instance.address,
+        vrf=instance.vrf,
+        dns_name=instance.dns_name,
+        status__in=IPADDRESS_ACTIVE_STATUS,
+    )
+    if instance.pk is not None:
+        duplicate_addresses = duplicate_addresses.exclude(pk=instance.pk)
+
+    if ENFORCE_UNIQUE_RECORDS and instance.status in IPADDRESS_ACTIVE_STATUS:
+        for ip_address in duplicate_addresses.only("custom_field_data"):
+            if not ip_address.custom_field_data.get("ipaddress_dns_disabled"):
+                raise ValidationError(
+                    {
+                        "dns_name": "Unique DNS records are enforced and there is already "
+                        f"an active IP address {instance.address} with DNS name {instance.dns_name}. "
+                        "Plesase choose a different name or disable record creation for this "
+                        "IP address."
+                    }
+                )
+
+    # +
+    # Check NetBox DNS record permission for changes to IPAddress custom fields
+    #
+    # Normally, as the modfication of DNS fields
+    if (request := current_request.get()) is not None:
+        cf_data = instance.custom_field_data
+        if (
+            instance.pk is not None
+            and any(
+                (
+                    cf_data.get(cf, cf_default)
+                    != IPAddress.objects.get(pk=instance.pk).custom_field_data.get(
+                        cf, cf_default
+                    )
+                    for cf, cf_default in DNSSYNC_CUSTOM_FIELDS.items()
+                )
+            )
+            and not check_record_permission()
+        ) or (
+            instance.pk is None
+            and any(
+                (
+                    cf_data.get(cf, cf_default) != cf_default
+                    for cf, cf_default in DNSSYNC_CUSTOM_FIELDS.items()
+                )
+            )
+            and not check_record_permission(change=False, delete=False)
+        ):
+            raise ValidationError(
+                f"User '{request.user}' is not allowed to alter DNSsync custom fields"
+            )
+
+    try:
+        check_dns_records(instance)
+    except ValidationError as exc:
+        raise ValidationError({"dns_name": exc.messages})
+
+
+@receiver(pre_delete, sender=IPAddress)
+def ipam_dnssync_ipaddress_pre_delete(instance, **kwargs):
+    delete_dns_records(instance)
+
+
+@receiver(pre_save, sender=IPAddress)
+def ipam_dnssync_ipaddress_pre_save(instance, **kwargs):
+    check_dns_records(instance)
+
+
+@receiver(post_save, sender=IPAddress)
+def ipam_dnssync_ipaddress_post_save(instance, **kwargs):
+    update_dns_records(instance)
+
+
+@receiver(pre_save, sender=Prefix)
+def ipam_dnssync_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 ask the user to deassign
+    the prefix from any views it is assigned to and retry.
+    """
+    request = current_request.get()
+
+    if instance.pk is None or not instance.netbox_dns_views.exists():
+        return
+
+    saved_prefix = Prefix.objects.prefetch_related("netbox_dns_views").get(
+        pk=instance.pk
+    )
+    if saved_prefix.prefix != instance.prefix or saved_prefix.vrf != instance.vrf:
+        dns_views = ", ".join([view.name for view in instance.netbox_dns_views.all()])
+        if request is not None:
+            raise AbortRequest(
+                f"This prefix is currently assigned to the following DNS views: {dns_views}"
+                f"Please deassign it from these views before making changes to the prefix "
+                f"or VRF."
+            )
+
+        raise ValidationError(
+            f"Prefix is assigned to DNS views {dns_views}. Prefix and VRF must not be changed"
+        )
+
+
+@receiver(pre_delete, sender=Prefix)
+def ipam_dnssync_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):
+                    check_dns_records(ip_address)
+        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_dnssync_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"
+
+    ip_addresses = IPAddress.objects.none()
+    for prefix in Prefix.objects.filter(pk__in=kwargs.get("pk_set")):
+        ip_addresses |= get_ip_addresses_by_prefix(prefix, check_view=check_view)
+
+    for ip_address in ip_addresses.distinct():
+        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 .contact import *
+from .registration_contact import *
 from .registrar import *
 from .zone_template import *
 from .record_template import *

netbox_dns/tables/ipam_dnssync.py

@@ -0,0 +1,11 @@
+import django_tables2 as tables
+
+from ipam.tables import PrefixTable
+from utilities.tables import register_table_column
+
+views = tables.ManyToManyColumn(
+    verbose_name="DNS Views",
+    linkify_item=True,
+)
+
+register_table_column(views, "netbox_dns_views", PrefixTable)

netbox_dns/tables/nameserver.py

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

netbox_dns/tables/record.py

@@ -1,4 +1,6 @@
 import django_tables2 as tables
+from django.utils.html import format_html
+
 
 from netbox.tables import (
     NetBoxTable,
@@ -11,6 +13,10 @@ 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",
@@ -23,10 +29,18 @@ 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 }}",
     )
@@ -65,20 +79,8 @@ 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",
@@ -100,21 +102,16 @@ 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 = (
-            "name",
-            "zone",
-            "ttl",
-            "type",
-            "value",
-            "unicode_value",
-            "address_record",
-            "ipam_ip_address",
-            "active",
-        )
+        fields = ()
         default_columns = (
             "name",
             "zone",
@@ -124,19 +121,35 @@ 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 = (
-            "name",
-            "zone",
-            "type",
-            "value",
-            "unicode_value",
-        )
+        fields = ()
         default_columns = (
             "name",
             "zone",

netbox_dns/tables/record_template.py

@@ -43,18 +43,8 @@ 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",
@@ -72,14 +62,7 @@ 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,13 +19,11 @@ 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")

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

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

netbox_dns/tables/view.py

@@ -1,12 +1,15 @@
 import django_tables2 as tables
 
-from netbox.tables import NetBoxTable, TagColumn
+from netbox.tables import NetBoxTable, TagColumn, ActionsColumn
 from tenancy.tables import TenancyColumnsMixin
 
 from netbox_dns.models import View
 
 
-__all__ = ("ViewTable",)
+__all__ = (
+    "ViewTable",
+    "RelatedViewTable",
+)
 
 
 class ViewTable(TenancyColumnsMixin, NetBoxTable):
@@ -18,14 +21,26 @@ class ViewTable(TenancyColumnsMixin, NetBoxTable):
     )
     tags = TagColumn(url_name="plugins:netbox_dns:view_list")
 
+    class Meta(NetBoxTable.Meta):
+        model = View
+        fields = ("description",)
+        default_columns = ("name", "default_view")
+
+
+class RelatedViewTable(TenancyColumnsMixin, NetBoxTable):
+    actions = ActionsColumn(actions=())
+
+    name = tables.Column(
+        linkify=True,
+    )
+
     class Meta(NetBoxTable.Meta):
         model = View
         fields = (
             "name",
-            "default_view",
             "description",
             "tenant",
             "tenant_group",
             "tags",
         )
-        default_columns = ("name", "default_view")
+        default_columns = ("name", "description")

netbox_dns/tables/zone.py

@@ -58,26 +58,11 @@ class ZoneTable(TenancyColumnsMixin, NetBoxTable):
     class Meta(NetBoxTable.Meta):
         model = Zone
         fields = (
-            "name",
-            "view",
-            "status",
             "description",
-            "tags",
-            "default_ttl",
-            "soa_mname",
             "soa_rname",
             "soa_serial",
-            "rfc2317_prefix",
             "rfc2317_parent_managed",
-            "rfc2317_parent_zone",
-            "registrar",
             "registry_domain_id",
-            "registrant",
-            "admin_c",
-            "tech_c",
-            "billing_c",
-            "tenant",
-            "tenant_group",
         )
         default_columns = (
             "name",

netbox_dns/tables/zone_template.py

@@ -37,18 +37,7 @@ class ZoneTemplateTable(TenancyColumnsMixin, NetBoxTable):
 
     class Meta(NetBoxTable.Meta):
         model = ZoneTemplate
-        fields = (
-            "name",
-            "description",
-            "tags",
-            "registrar",
-            "registrant",
-            "admin_c",
-            "tech_c",
-            "billing_c",
-            "tenant",
-            "tenant_group",
-        )
+        fields = ("description",)
         default_columns = (
             "name",
             "tags",
@@ -60,10 +49,7 @@ class ZoneTemplateDisplayTable(ZoneTemplateTable):
 
     class Meta(NetBoxTable.Meta):
         model = ZoneTemplate
-        fields = (
-            "name",
-            "description",
-        )
+        fields = ("description",)
         default_columns = (
             "name",
             "description",