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

netbox_dns/models/record.py

@@ -7,8 +7,10 @@ from django.core.exceptions import ValidationError
 from django.db import transaction, models
 from django.db.models import Q, ExpressionWrapper, BooleanField, Min
 from django.urls import reverse
+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
@@ -35,6 +37,43 @@ def min_ttl(*ttl_list):
     return min((ttl for ttl in ttl_list if ttl is not None), default=None)
 
 
+def record_data_from_ip_address(ip_address, zone):
+    cf_data = ip_address.custom_field_data
+
+    if cf_data.get("ipaddress_dns_disabled"):
+        return None
+
+    data = {
+        "name": (
+            dns_name.from_text(ip_address.dns_name)
+            .relativize(dns_name.from_text(zone.name))
+            .to_text()
+        ),
+        "type": (
+            RecordTypeChoices.A
+            if ip_address.address.version == 4
+            else RecordTypeChoices.AAAA
+        ),
+        "value": str(ip_address.address.ip),
+        "status": (
+            RecordStatusChoices.STATUS_ACTIVE
+            if ip_address.status
+            in settings.PLUGINS_CONFIG["netbox_dns"].get(
+                "dnssync_ipaddress_active_status", []
+            )
+            else RecordStatusChoices.STATUS_INACTIVE
+        ),
+    }
+
+    if "ipaddress_dns_record_ttl" in cf_data:
+        data["ttl"] = cf_data.get("ipaddress_dns_record_ttl")
+
+    if (disable_ptr := cf_data.get("ipaddress_dns_record_disable_ptr")) is not None:
+        data["disable_ptr"] = disable_ptr
+
+    return data
+
+
 class RecordManager(models.Manager.from_queryset(RestrictedQuerySet)):
     """
     Custom manager for records providing the activity status annotation
@@ -62,7 +101,7 @@ class RecordManager(models.Manager.from_queryset(RestrictedQuerySet)):
         )
 
 
-class Record(ObjectModificationMixin, NetBoxModel):
+class Record(ObjectModificationMixin, ContactsMixin, NetBoxModel):
     ACTIVE_STATUS_LIST = (RecordStatusChoices.STATUS_ACTIVE,)
 
     unique_ptr_qs = Q(
@@ -155,7 +194,7 @@ class Record(ObjectModificationMixin, NetBoxModel):
     objects = RecordManager()
     raw_objects = RestrictedQuerySet.as_manager()
 
-    clone_fields = [
+    clone_fields = (
         "zone",
         "type",
         "name",
@@ -164,10 +203,20 @@ class Record(ObjectModificationMixin, NetBoxModel):
         "ttl",
         "disable_ptr",
         "description",
-    ]
+    )
 
     class Meta:
-        ordering = ("zone", "name", "type", "value", "status")
+        verbose_name = "Record"
+        verbose_name_plural = "Records"
+
+        ordering = (
+            "fqdn",
+            "zone",
+            "name",
+            "type",
+            "value",
+            "status",
+        )
 
     def __str__(self):
         try:
@@ -423,29 +472,70 @@ class Record(ObjectModificationMixin, NetBoxModel):
                 self.rfc2317_cname_record.delete(save_zone_serial=save_zone_serial)
                 self.rfc2317_cname_record = None
 
-    def validate_name(self):
-        try:
-            _zone = dns_name.from_text(self.zone.name, origin=dns_name.root)
-            name = dns_name.from_text(self.name, origin=None)
-            fqdn = dns_name.from_text(self.name, origin=_zone)
+    def update_from_ip_address(self, ip_address, zone=None):
+        if zone is None:
+            zone = self.zone
 
-            _zone.to_unicode()
-            name.to_unicode()
+        data = record_data_from_ip_address(ip_address, zone)
 
-            self.name = name.relativize(_zone).to_text()
-            self.fqdn = fqdn.to_text()
+        if data is None:
+            self.delete()
+            return
 
-        except dns.exception.DNSException as exc:
+        if all((getattr(self, attr) == data[attr] for attr in data.keys())):
+            return
+
+        for attr, value in data.items():
+            setattr(self, attr, value)
+
+        return self
+
+    @classmethod
+    def create_from_ip_address(cls, ip_address, zone):
+        data = record_data_from_ip_address(ip_address, zone)
+
+        if data is None:
+            return
+
+        return Record(
+            zone=zone,
+            managed=True,
+            ipam_ip_address=ip_address,
+            **data,
+        )
+
+    def update_fqdn(self, zone=None):
+        if zone is None:
+            zone = self.zone
+
+        _zone = dns_name.from_text(zone.name, origin=dns_name.root)
+        name = dns_name.from_text(self.name, origin=None)
+        fqdn = dns_name.from_text(self.name, origin=_zone)
+
+        if not fqdn.is_subdomain(_zone):
             raise ValidationError(
                 {
-                    "name": str(exc),
+                    "name": f"{self.name} is not a name in {zone.name}",
                 }
             )
 
-        if not fqdn.is_subdomain(_zone):
+        _zone.to_unicode()
+        name.to_unicode()
+
+        self.name = name.relativize(_zone).to_text()
+        self.fqdn = fqdn.to_text()
+
+    def validate_name(self, new_zone=None):
+        if new_zone is None:
+            new_zone = self.zone
+
+        try:
+            self.update_fqdn(zone=new_zone)
+
+        except dns.exception.DNSException as exc:
             raise ValidationError(
                 {
-                    "name": f"{self.name} is not a name in {self.zone.name}",
+                    "name": str(exc),
                 }
             )
 
@@ -477,15 +567,18 @@ class Record(ObjectModificationMixin, NetBoxModel):
         except ValidationError as exc:
             raise ValidationError({"value": exc}) from None
 
-    def check_unique_record(self):
+    def check_unique_record(self, new_zone=None):
         if not get_plugin_config("netbox_dns", "enforce_unique_records", False):
             return
 
         if not self.is_active:
             return
 
+        if new_zone is None:
+            new_zone = self.zone
+
         records = Record.objects.filter(
-            zone=self.zone,
+            zone=new_zone,
             name=self.name,
             type=self.type,
             value=self.value,
@@ -495,13 +588,41 @@ class Record(ObjectModificationMixin, NetBoxModel):
         if self.pk is not None:
             records = records.exclude(pk=self.pk)
 
-        if len(records):
+        if records.exists():
+            if self.ipam_ip_address is not None:
+                if not records.filter(
+                    ipam_ip_address__isnull=True
+                ).exists() or get_plugin_config(
+                    "netbox_dns", "dnssync_conflict_deactivate", False
+                ):
+                    return
+
             raise ValidationError(
                 {
                     "value": f"There is already an active {self.type} record for name {self.name} in zone {self.zone} with value {self.value}."
                 }
             ) from None
 
+    def handle_conflicting_address_records(self):
+        if self.ipam_ip_address is None or not self.is_active:
+            return
+
+        if not get_plugin_config("netbox_dns", "dnssync_conflict_deactivate", False):
+            return
+
+        records = Record.objects.filter(
+            zone=self.zone,
+            name=self.name,
+            type=self.type,
+            value=self.value,
+            status__in=Record.ACTIVE_STATUS_LIST,
+            ipam_ip_address__isnull=True,
+        )
+
+        for record in records:
+            record.status = RecordStatusChoices.STATUS_INACTIVE
+            record.save(update_fields=["status"])
+
     def check_unique_rrset_ttl(self):
         if self.pk is not None:
             return
@@ -509,6 +630,11 @@ class Record(ObjectModificationMixin, NetBoxModel):
         if not get_plugin_config("netbox_dns", "enforce_unique_rrset_ttl", False):
             return
 
+        if self.ipam_ip_address is not None and get_plugin_config(
+            "netbox_dns", "dnssync_conflict_deactivate", False
+        ):
+            return
+
         if self.type == RecordTypeChoices.PTR and self.managed:
             return
 
@@ -523,10 +649,13 @@ class Record(ObjectModificationMixin, NetBoxModel):
             .exclude(status=RecordStatusChoices.STATUS_INACTIVE)
         )
 
+        if self.ipam_ip_address is not None:
+            records = records.exclude(ipam_ip_address__isnull=False)
+
         if not records.exists():
             return
 
-        conflicting_ttls = ", ".join(set(str(record.ttl) for record in records))
+        conflicting_ttls = ", ".join({str(record.ttl) for record in records})
         raise ValidationError(
             {
                 "ttl": f"There is at least one active {self.type} record for name {self.name} in zone {self.zone} and TTL is different ({conflicting_ttls})."
@@ -566,10 +695,10 @@ class Record(ObjectModificationMixin, NetBoxModel):
         self.type = self.type.upper()
         super().clean_fields(*args, **kwargs)
 
-    def clean(self, *args, **kwargs):
-        self.validate_name()
+    def clean(self, *args, new_zone=None, **kwargs):
+        self.validate_name(new_zone=new_zone)
         self.validate_value()
-        self.check_unique_record()
+        self.check_unique_record(new_zone=new_zone)
         if self.pk is None:
             self.check_unique_rrset_ttl()
 
@@ -675,6 +804,7 @@ class Record(ObjectModificationMixin, NetBoxModel):
             self.ip_address = None
 
         if self.is_address_record:
+            self.handle_conflicting_address_records()
             self.update_ptr_record(
                 update_rfc2317_cname=update_rfc2317_cname,
                 save_zone_serial=save_zone_serial,

netbox_dns/models/record_template.py

@@ -85,7 +85,10 @@ class RecordTemplate(NetBoxModel):
     )
 
     class Meta:
-        ordering = ["name"]
+        verbose_name = "Record Template"
+        verbose_name_plural = "Record Templates"
+
+        ordering = ("name",)
 
     def __str__(self):
         return str(self.name)

netbox_dns/models/registrar.py

@@ -59,7 +59,13 @@ class Registrar(NetBoxModel):
         return str(self.name)
 
     class Meta:
-        ordering = ("name", "iana_id")
+        verbose_name = "Registrar"
+        verbose_name_plural = "Registrars"
+
+        ordering = (
+            "name",
+            "iana_id",
+        )
 
 
 @register_search

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

@@ -8,12 +8,12 @@ from taggit.managers import TaggableManager
 
 
 __all__ = (
-    "Contact",
-    "ContactIndex",
+    "RegistrationContact",
+    "RegistrationContactIndex",
 )
 
 
-class Contact(NetBoxModel):
+class RegistrationContact(NetBoxModel):
     # +
     # Data fields according to https://www.icann.org/resources/pages/rdds-labeling-policy-2017-02-01-en
     # -
@@ -87,7 +87,7 @@ class Contact(NetBoxModel):
         related_name="netbox_dns_contact_set",
     )
 
-    clone_fields = [
+    clone_fields = (
         "name",
         "description",
         "organization",
@@ -102,10 +102,10 @@ class Contact(NetBoxModel):
         "fax_ext",
         "email",
         "tags",
-    ]
+    )
 
     def get_absolute_url(self):
-        return reverse("plugins:netbox_dns:contact", kwargs={"pk": self.pk})
+        return reverse("plugins:netbox_dns:registrationcontact", kwargs={"pk": self.pk})
 
     def __str__(self):
         if self.name is not None:
@@ -114,7 +114,13 @@ class Contact(NetBoxModel):
         return self.contact_id
 
     class Meta:
-        ordering = ("name", "contact_id")
+        verbose_name = "Registration Contact"
+        verbose_name_plural = "Registration Contacts"
+
+        ordering = (
+            "name",
+            "contact_id",
+        )
 
     @property
     def zones(self):
@@ -127,8 +133,8 @@ class Contact(NetBoxModel):
 
 
 @register_search
-class ContactIndex(SearchIndex):
-    model = Contact
+class RegistrationContactIndex(SearchIndex):
+    model = RegistrationContact
     fields = (
         ("name", 100),
         ("contact_id", 100),

netbox_dns/models/view.py

@@ -3,6 +3,7 @@ from django.urls import reverse
 from django.core.exceptions import ValidationError
 
 from netbox.models import NetBoxModel
+from netbox.models.features import ContactsMixin
 from netbox.search import SearchIndex, register_search
 from netbox.context import current_request
 from utilities.exceptions import AbortRequest
@@ -16,7 +17,7 @@ __all__ = (
 )
 
 
-class View(ObjectModificationMixin, NetBoxModel):
+class View(ObjectModificationMixin, ContactsMixin, NetBoxModel):
     name = models.CharField(
         unique=True,
         max_length=255,
@@ -28,6 +29,11 @@ class View(ObjectModificationMixin, NetBoxModel):
     default_view = models.BooleanField(
         default=False,
     )
+    prefixes = models.ManyToManyField(
+        to="ipam.Prefix",
+        related_name="netbox_dns_views",
+        blank=True,
+    )
     tenant = models.ForeignKey(
         to="tenancy.Tenant",
         on_delete=models.PROTECT,
@@ -36,7 +42,10 @@ class View(ObjectModificationMixin, NetBoxModel):
         null=True,
     )
 
-    clone_fields = ["name", "description"]
+    clone_fields = (
+        "name",
+        "description",
+    )
 
     @classmethod
     def get_default_view(cls):
@@ -49,6 +58,9 @@ class View(ObjectModificationMixin, NetBoxModel):
         return str(self.name)
 
     class Meta:
+        verbose_name = "View"
+        verbose_name_plural = "Views"
+
         ordering = ("name",)
 
     def delete(self, *args, **kwargs):

netbox_dns/models/zone.py

@@ -3,9 +3,8 @@ from math import ceil
 from datetime import datetime
 
 from dns import name as dns_name
-from dns.rdtypes.ANY import SOA
 from dns.exception import DNSException
-
+from dns.rdtypes.ANY import SOA
 from django.core.validators import (
     MinValueValidator,
     MaxValueValidator,
@@ -19,6 +18,7 @@ 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
@@ -27,13 +27,16 @@ 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 (
+    update_dns_records,
+    check_dns_records,
+    get_ip_addresses_by_zone,
     arpa_to_prefix,
     name_to_unicode,
     normalize_name,
     NameFormatError,
 )
 from netbox_dns.validators import (
-    validate_fqdn,
+    validate_rname,
     validate_domain_name,
 )
 from netbox_dns.mixins import ObjectModificationMixin
@@ -66,7 +69,7 @@ class ZoneManager(models.Manager.from_queryset(RestrictedQuerySet)):
         )
 
 
-class Zone(ObjectModificationMixin, NetBoxModel):
+class Zone(ObjectModificationMixin, ContactsMixin, NetBoxModel):
     ACTIVE_STATUS_LIST = (ZoneStatusChoices.STATUS_ACTIVE,)
 
     def __init__(self, *args, **kwargs):
@@ -75,6 +78,7 @@ class Zone(ObjectModificationMixin, NetBoxModel):
         super().__init__(*args, **kwargs)
 
         self._soa_serial_dirty = False
+        self._ip_addresses_checked = False
 
     view = models.ForeignKey(
         to="View",
@@ -188,7 +192,7 @@ class Zone(ObjectModificationMixin, NetBoxModel):
         null=True,
     )
     registrant = models.ForeignKey(
-        to="Contact",
+        to="RegistrationContact",
         on_delete=models.SET_NULL,
         verbose_name="Registrant",
         help_text="The owner of the domain",
@@ -196,7 +200,7 @@ class Zone(ObjectModificationMixin, NetBoxModel):
         null=True,
     )
     admin_c = models.ForeignKey(
-        to="Contact",
+        to="RegistrationContact",
         on_delete=models.SET_NULL,
         verbose_name="Admin Contact",
         related_name="admin_c_zones",
@@ -205,16 +209,16 @@ class Zone(ObjectModificationMixin, NetBoxModel):
         null=True,
     )
     tech_c = models.ForeignKey(
-        to="Contact",
+        to="RegistrationContact",
         on_delete=models.SET_NULL,
-        verbose_name="Tech Contact",
+        verbose_name="Technical Contact",
         related_name="tech_c_zones",
         help_text="The technical contact for the domain",
         blank=True,
         null=True,
     )
     billing_c = models.ForeignKey(
-        to="Contact",
+        to="RegistrationContact",
         on_delete=models.SET_NULL,
         verbose_name="Billing Contact",
         related_name="billing_c_zones",
@@ -245,7 +249,7 @@ class Zone(ObjectModificationMixin, NetBoxModel):
 
     objects = ZoneManager()
 
-    clone_fields = [
+    clone_fields = (
         "view",
         "name",
         "status",
@@ -259,9 +263,12 @@ class Zone(ObjectModificationMixin, NetBoxModel):
         "soa_expire",
         "soa_minimum",
         "description",
-    ]
+    )
 
     class Meta:
+        verbose_name = "Zone"
+        verbose_name_plural = "Zones"
+
         ordering = (
             "view",
             "name",
@@ -277,7 +284,7 @@ class Zone(ObjectModificationMixin, NetBoxModel):
         else:
             try:
                 name = dns_name.from_text(self.name, origin=None).to_unicode()
-            except dns_name.IDNAException:
+            except DNSException:
                 name = self.name
 
         try:
@@ -305,6 +312,14 @@ class Zone(ObjectModificationMixin, 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)
@@ -618,7 +633,7 @@ class Zone(ObjectModificationMixin, 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_fqdn(self.soa_rname)
+            validate_rname(self.soa_rname)
         except (DNSException, ValidationError) as exc:
             raise ValidationError(
                 {
@@ -638,7 +653,7 @@ class Zone(ObjectModificationMixin, 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)
-            else:
+            elif not old_zone.soa_serial_auto:
                 try:
                     self.check_soa_serial_increment(
                         old_zone.soa_serial, self.get_auto_serial()
@@ -650,6 +665,26 @@ class Zone(ObjectModificationMixin, 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
 
@@ -764,23 +799,13 @@ 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=(RecordTypeChoices.A, RecordTypeChoices.AAAA)
+                type__in=(RecordTypeChoices.A, RecordTypeChoices.AAAA),
+                ipam_ip_address__isnull=True,
             ):
                 address_record.save(update_fields=["ptr_record"])
 
-            # Fix name in IP Address when zone name is changed
-            if (
-                get_plugin_config("netbox_dns", "feature_ipam_coupling")
-                and "name" in changed_fields
-            ):
-                for ip in IPAddress.objects.filter(
-                    custom_field_data__ipaddress_dns_zone_id=self.pk
-                ):
-                    ip.dns_name = f'{ip.custom_field_data["ipaddress_dns_record_name"]}.{self.name}'
-                    ip.save(update_fields=["dns_name"])
-
         if changed_fields is not None and "name" in changed_fields:
-            for _record in self.record_set.all():
+            for _record in self.record_set.filter(ipam_ip_address__isnull=True):
                 _record.save(
                     update_fields=["fqdn"],
                     save_zone_serial=False,
@@ -788,6 +813,17 @@ class Zone(ObjectModificationMixin, NetBoxModel):
                     update_rfc2317_cname=False,
                 )
 
+        if changed_fields is None or {"name", "view"} & changed_fields:
+            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():
+                update_dns_records(ip_address)
+
         self.save_soa_serial()
         self.update_soa_record()
 
@@ -823,14 +859,15 @@ class Zone(ObjectModificationMixin, NetBoxModel):
                 self.rfc2317_child_zones.all().values_list("pk", flat=True)
             )
 
-            if get_plugin_config("netbox_dns", "feature_ipam_coupling"):
-                for ip in IPAddress.objects.filter(
-                    custom_field_data__ipaddress_dns_zone_id=self.pk
-                ):
-                    ip.dns_name = ""
-                    ip.custom_field_data["ipaddress_dns_record_name"] = None
-                    ip.custom_field_data["ipaddress_dns_zone_id"] = None
-                    ip.save(update_fields=["dns_name", "custom_field_data"])
+            ipam_ip_addresses = list(
+                IPAddress.objects.filter(
+                    netbox_dns_records__in=self.record_set.filter(
+                        ipam_ip_address__isnull=False
+                    )
+                )
+                .distinct()
+                .values_list("pk", flat=True)
+            )
 
             super().delete(*args, **kwargs)
 
@@ -844,6 +881,10 @@ class Zone(ObjectModificationMixin, NetBoxModel):
             address_zone.save_soa_serial()
             address_zone.update_soa_record()
 
+        ip_addresses = IPAddress.objects.filter(pk__in=ipam_ip_addresses)
+        for ip_address in ip_addresses:
+            update_dns_records(ip_address)
+
         rfc2317_child_zones = Zone.objects.filter(pk__in=rfc2317_child_zones)
         if rfc2317_child_zones:
             for child_zone in rfc2317_child_zones: