netbox-plugin-dns 1.1.0b7__py3-none-any.whl → 1.1.2__py3-none-any.whl

netbox_dns/mixins/object_modification.py

@@ -17,15 +17,37 @@ class ObjectModificationMixin:
 
             self.__class__.check_fields.add("custom_field_data")
 
+        self._save_field_values()
+
+    def _save_field_values(self):
+        for field in self.check_fields:
+            if f"{field}_id" in self.__dict__:
+                setattr(self, f"_saved_{field}_id", self.__dict__.get(f"{field}_id"))
+            else:
+                setattr(self, f"_saved_{field}", self.__dict__.get(field))
+
+    def save(self, *args, **kwargs):
+        super().save(*args, **kwargs)
+
+        self._save_field_values()
+
     @property
     def changed_fields(self):
-        if self.pk is None:
+        if self._state.adding:
             return None
 
-        saved = self.__class__.objects.get(pk=self.pk)
-
-        return {
-            field
-            for field in self.check_fields
-            if getattr(self, field) != getattr(saved, field)
-        }
+        _changed_fields = set()
+        for field in self.check_fields:
+            if f"_saved_{field}_id" in self.__dict__:
+                if self.__dict__.get(f"_saved_{field}_id") != self.__dict__.get(
+                    f"{field}_id"
+                ):
+                    _changed_fields.add(field)
+            else:
+                if self.__dict__.get(f"_saved_{field}") != self.__dict__.get(field):
+                    _changed_fields.add(field)
+
+        return _changed_fields
+
+    def get_saved_value(self, field):
+        return self.__dict__.get(f"_saved_{field}")

netbox_dns/models/__init__.py

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

netbox_dns/models/nameserver.py

@@ -7,6 +7,7 @@ from django.urls import reverse
 
 from netbox.models import NetBoxModel
 from netbox.search import SearchIndex, register_search
+from netbox.models.features import ContactsMixin
 
 from netbox_dns.utilities import (
     name_to_unicode,
@@ -26,7 +27,7 @@ __all__ = (
 )
 
 
-class NameServer(ObjectModificationMixin, NetBoxModel):
+class NameServer(ObjectModificationMixin, ContactsMixin, NetBoxModel):
     name = models.CharField(
         unique=True,
         max_length=255,
@@ -43,13 +44,17 @@ class NameServer(ObjectModificationMixin, NetBoxModel):
         null=True,
     )
 
-    clone_fields = ["name", "description"]
+    clone_fields = (
+        "name",
+        "description",
+    )
 
     class Meta:
-        ordering = ("name",)
         verbose_name = "Nameserver"
         verbose_name_plural = "Nameservers"
 
+        ordering = ("name",)
+
     def __str__(self):
         try:
             return dns_name.from_text(self.name, origin=None).to_unicode()

netbox_dns/models/record.py

@@ -10,12 +10,14 @@ from django.urls import reverse
 from django.conf import settings
 
 from netbox.models import NetBoxModel
+from ipam.models import IPAddress
+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
 
 from netbox_dns.fields import AddressField
-from netbox_dns.utilities import arpa_to_prefix, name_to_unicode
+from netbox_dns.utilities import arpa_to_prefix, name_to_unicode, get_query_from_filter
 from netbox_dns.validators import validate_generic_name, validate_record_value
 from netbox_dns.mixins import ObjectModificationMixin
 from netbox_dns.choices import RecordTypeChoices, RecordStatusChoices
@@ -40,6 +42,20 @@ def record_data_from_ip_address(ip_address, zone):
     cf_data = ip_address.custom_field_data
 
     if cf_data.get("ipaddress_dns_disabled"):
+        # +
+        # DNS record creation disabled for this address
+        # -
+        return None
+
+    if (
+        zone.view.ip_address_filter is not None
+        and not IPAddress.objects.filter(
+            Q(pk=ip_address.pk), get_query_from_filter(zone.view.ip_address_filter)
+        ).exists()
+    ):
+        # +
+        # IP address does not match the filter
+        # -
         return None
 
     data = {
@@ -100,7 +116,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(
@@ -193,7 +209,7 @@ class Record(ObjectModificationMixin, NetBoxModel):
     objects = RecordManager()
     raw_objects = RestrictedQuerySet.as_manager()
 
-    clone_fields = [
+    clone_fields = (
         "zone",
         "type",
         "name",
@@ -202,10 +218,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:
@@ -462,22 +488,29 @@ class Record(ObjectModificationMixin, NetBoxModel):
                 self.rfc2317_cname_record = None
 
     def update_from_ip_address(self, ip_address, zone=None):
+        """
+        Update an address record according to data from an IPAddress object.
+
+        Returns a tuple of two booleans: (update, delete).
+
+        update: The record was updated and needs to be cleaned and/or saved
+        delete: The record is no longer needed and needs to be deleted
+        """
         if zone is None:
             zone = self.zone
 
         data = record_data_from_ip_address(ip_address, zone)
 
         if data is None:
-            self.delete()
-            return
+            return False, True
 
         if all((getattr(self, attr) == data[attr] for attr in data.keys())):
-            return
+            return False, False
 
         for attr, value in data.items():
             setattr(self, attr, value)
 
-        return self
+        return True, False
 
     @classmethod
     def create_from_ip_address(cls, ip_address, zone):
@@ -574,7 +607,7 @@ class Record(ObjectModificationMixin, NetBoxModel):
             status__in=Record.ACTIVE_STATUS_LIST,
         )
 
-        if self.pk is not None:
+        if not self._state.adding:
             records = records.exclude(pk=self.pk)
 
         if records.exists():
@@ -613,7 +646,7 @@ class Record(ObjectModificationMixin, NetBoxModel):
             record.save(update_fields=["status"])
 
     def check_unique_rrset_ttl(self):
-        if self.pk is not None:
+        if not self._state.adding:
             return
 
         if not get_plugin_config("netbox_dns", "enforce_unique_rrset_ttl", False):
@@ -652,7 +685,7 @@ class Record(ObjectModificationMixin, NetBoxModel):
         ) from None
 
     def update_rrset_ttl(self, ttl=None):
-        if self.pk is None:
+        if self._state.adding:
             return
 
         if not get_plugin_config("netbox_dns", "enforce_unique_rrset_ttl", False):
@@ -688,7 +721,7 @@ class Record(ObjectModificationMixin, NetBoxModel):
         self.validate_name(new_zone=new_zone)
         self.validate_value()
         self.check_unique_record(new_zone=new_zone)
-        if self.pk is None:
+        if self._state.adding:
             self.check_unique_rrset_ttl()
 
         if not self.is_active:
@@ -776,7 +809,7 @@ class Record(ObjectModificationMixin, NetBoxModel):
     ):
         self.full_clean()
 
-        if self.pk is not None and update_rrset_ttl:
+        if not self._state.adding and update_rrset_ttl:
             self.update_rrset_ttl()
 
         if self.is_ptr_record:

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,11 +3,19 @@ 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
 
 from netbox_dns.mixins import ObjectModificationMixin
+from netbox_dns.utilities import (
+    get_ip_addresses_by_view,
+    check_dns_records,
+    update_dns_records,
+    delete_dns_records,
+    get_query_from_filter,
+)
 
 
 __all__ = (
@@ -16,7 +24,7 @@ __all__ = (
 )
 
 
-class View(ObjectModificationMixin, NetBoxModel):
+class View(ObjectModificationMixin, ContactsMixin, NetBoxModel):
     name = models.CharField(
         unique=True,
         max_length=255,
@@ -33,6 +41,11 @@ class View(ObjectModificationMixin, NetBoxModel):
         related_name="netbox_dns_views",
         blank=True,
     )
+    ip_address_filter = models.JSONField(
+        verbose_name="IP Address Filter",
+        blank=True,
+        null=True,
+    )
     tenant = models.ForeignKey(
         to="tenancy.Tenant",
         on_delete=models.PROTECT,
@@ -41,7 +54,10 @@ class View(ObjectModificationMixin, NetBoxModel):
         null=True,
     )
 
-    clone_fields = ["name", "description"]
+    clone_fields = (
+        "name",
+        "description",
+    )
 
     @classmethod
     def get_default_view(cls):
@@ -54,6 +70,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):
@@ -80,6 +99,21 @@ class View(ObjectModificationMixin, NetBoxModel):
                 }
             )
 
+        if "ip_address_filter" in changed_fields and self.get_saved_value(
+            "ip_address_filter"
+        ):
+            try:
+                for ip_address in get_ip_addresses_by_view(self).filter(
+                    get_query_from_filter(self.ip_address_filter)
+                ):
+                    check_dns_records(ip_address, view=self)
+            except ValidationError as exc:
+                raise ValidationError(
+                    {
+                        "ip_address_filter": exc.messages,
+                    }
+                )
+
         super().clean(*args, **kwargs)
 
     def save(self, *args, **kwargs):
@@ -99,6 +133,19 @@ class View(ObjectModificationMixin, NetBoxModel):
                 view.default_view = False
                 view.save()
 
+        if changed_fields is not None and "ip_address_filter" in changed_fields:
+            ip_addresses = get_ip_addresses_by_view(self)
+
+            for ip_address in ip_addresses.exclude(
+                get_query_from_filter(self.ip_address_filter)
+            ):
+                delete_dns_records(ip_address, view=self)
+
+            for ip_address in ip_addresses.filter(
+                get_query_from_filter(self.ip_address_filter)
+            ):
+                update_dns_records(ip_address, view=self)
+
 
 @register_search
 class ViewIndex(SearchIndex):

netbox_dns/models/zone.py

@@ -5,8 +5,6 @@ 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,
@@ -20,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
@@ -37,7 +36,6 @@ from netbox_dns.utilities import (
     NameFormatError,
 )
 from netbox_dns.validators import (
-    validate_fqdn,
     validate_rname,
     validate_domain_name,
 )
@@ -71,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):
@@ -194,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",
@@ -202,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",
@@ -211,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",
@@ -251,7 +249,7 @@ class Zone(ObjectModificationMixin, NetBoxModel):
 
     objects = ZoneManager()
 
-    clone_fields = [
+    clone_fields = (
         "view",
         "name",
         "status",
@@ -265,9 +263,12 @@ class Zone(ObjectModificationMixin, NetBoxModel):
         "soa_expire",
         "soa_minimum",
         "description",
-    ]
+    )
 
     class Meta:
+        verbose_name = "Zone"
+        verbose_name_plural = "Zones"
+
         ordering = (
             "view",
             "name",
@@ -648,14 +649,16 @@ class Zone(ObjectModificationMixin, NetBoxModel):
                     }
                 )
 
-        if self.pk is not None:
-            old_zone = Zone.objects.get(pk=self.pk)
+        if not self._state.adding:
+            old_soa_serial = self.get_saved_value("soa_serial")
+            old_soa_serial_auto = self.get_saved_value("soa_serial_auto")
+
             if not self.soa_serial_auto:
-                self.check_soa_serial_increment(old_zone.soa_serial, self.soa_serial)
-            else:
+                self.check_soa_serial_increment(old_soa_serial, self.soa_serial)
+            elif not old_soa_serial_auto:
                 try:
                     self.check_soa_serial_increment(
-                        old_zone.soa_serial, self.get_auto_serial()
+                        old_soa_serial, self.get_auto_serial()
                     )
                 except ValidationError:
                     raise ValidationError(
@@ -664,10 +667,13 @@ class Zone(ObjectModificationMixin, NetBoxModel):
                         }
                     )
 
+            old_name = self.get_saved_value("name")
+            old_view_id = self.get_saved_value("view_id")
+
             if (
                 not self.ip_addresses_checked
-                and old_zone.name != self.name
-                or old_zone.view != self.view
+                and old_name != self.name
+                or old_view_id != self.view_id
             ):
                 ip_addresses = IPAddress.objects.filter(
                     netbox_dns_records__in=self.record_set.filter(

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"],
         ),
     ),
 )