netbox-plugin-dns 0.22.9__py3-none-any.whl → 1.0.0__py3-none-any.whl

netbox_dns/models/record.py

@@ -7,21 +7,14 @@ from dns import name as dns_name
 from django.core.exceptions import ValidationError
 from django.db import transaction, models
 from django.db.models import Q, ExpressionWrapper, BooleanField, Min
-from django.db.models.functions import Length
 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 utilities.querysets import RestrictedQuerySet
 from utilities.choices import ChoiceSet
 
-try:
-    # NetBox 3.5.0 - 3.5.7, 3.5.9+
-    from extras.plugins import get_plugin_config
-except ImportError:
-    # NetBox 3.5.8
-    from extras.plugins.utils import get_plugin_config
-
 from netbox_dns.fields import AddressField
 from netbox_dns.utilities import (
     arpa_to_prefix,
@@ -43,7 +36,9 @@ def min_ttl(*ttl_list):
 
 
 class RecordManager(models.Manager.from_queryset(RestrictedQuerySet)):
-    """Special Manager for records providing the activity status annotation"""
+    """
+    Custom manager for records providing the activity status annotation
+    """
 
     def get_queryset(self):
         return (
@@ -218,7 +213,7 @@ class Record(NetBoxModel):
             name = dns_name.from_text(self.fqdn).relativize(dns_name.root).to_unicode()
         except dns_name.IDNAException:
             name = self.name
-        except dns_name.LabelTooLong as exc:
+        except dns_name.LabelTooLong:
             name = f"{self.name[:59]}..."
 
         return f"{name} [{self.type}]"
@@ -231,15 +226,15 @@ class Record(NetBoxModel):
         return RecordStatusChoices.colors.get(self.status)
 
     def get_absolute_url(self):
-        return reverse("plugins:netbox_dns:record", kwargs={"pk": self.id})
+        return reverse("plugins:netbox_dns:record", kwargs={"pk": self.pk})
 
     @property
     def value_fqdn(self):
         if self.type != RecordTypeChoices.CNAME:
             return None
 
-        zone = dns_name.from_text(self.zone.name)
-        value_fqdn = dns_name.from_text(self.value, origin=zone)
+        _zone = dns_name.from_text(self.zone.name)
+        value_fqdn = dns_name.from_text(self.value, origin=_zone)
 
         return value_fqdn.to_text()
 
@@ -291,12 +286,14 @@ class Record(NetBoxModel):
                 dns_name.from_text(self.ptr_record.zone.rfc2317_parent_zone.name)
             )
 
+        return None
+
     @property
     def ptr_zone(self):
         if self.type == RecordTypeChoices.A:
             ptr_zone = (
                 zone.Zone.objects.filter(
-                    self.zone.view_filter,
+                    view=self.zone.view,
                     rfc2317_prefix__net_contains=self.value,
                 )
                 .order_by("rfc2317_prefix__net_mask_length")
@@ -308,7 +305,7 @@ class Record(NetBoxModel):
 
         ptr_zone = (
             zone.Zone.objects.filter(
-                self.zone.view_filter, arpa_network__net_contains=self.value
+                view=self.zone.view, arpa_network__net_contains=self.value
             )
             .order_by("arpa_network__net_mask_length")
             .last()
@@ -422,10 +419,8 @@ class Record(NetBoxModel):
                     self.rfc2317_cname_record.save(save_zone_serial=save_zone_serial)
 
                     return
-                else:
-                    self.remove_from_rfc2317_cname_record(
-                        save_zone_serial=save_zone_serial
-                    )
+
+                self.remove_from_rfc2317_cname_record(save_zone_serial=save_zone_serial)
 
             rfc2317_cname_record = Record.objects.filter(
                 name=cname_name,
@@ -466,14 +461,14 @@ class Record(NetBoxModel):
 
     def validate_name(self):
         try:
-            zone = dns_name.from_text(self.zone.name, origin=dns_name.root)
+            _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)
+            fqdn = dns_name.from_text(self.name, origin=_zone)
 
-            zone.to_unicode()
+            _zone.to_unicode()
             name.to_unicode()
 
-            self.name = name.relativize(zone).to_text()
+            self.name = name.relativize(_zone).to_text()
             self.fqdn = fqdn.to_text()
 
         except dns.exception.DNSException as exc:
@@ -483,7 +478,7 @@ class Record(NetBoxModel):
                 }
             )
 
-        if not fqdn.is_subdomain(zone):
+        if not fqdn.is_subdomain(_zone):
             raise ValidationError(
                 {
                     "name": f"{self.name} is not a name in {self.zone.name}",
@@ -491,7 +486,7 @@ class Record(NetBoxModel):
             )
 
         if self.type not in get_plugin_config(
-            "netbox_dns", "tolerate_non_rfc1035_types", default=list()
+            "netbox_dns", "tolerate_non_rfc1035_types", default=[]
         ):
             try:
                 validate_extended_hostname(
@@ -501,7 +496,7 @@ class Record(NetBoxModel):
                         in get_plugin_config(
                             "netbox_dns",
                             "tolerate_leading_underscore_types",
-                            default=list(),
+                            default=[],
                         )
                     ),
                 )
@@ -669,7 +664,7 @@ class Record(NetBoxModel):
         if self.type == RecordTypeChoices.SOA and self.name != "@":
             raise ValidationError(
                 {
-                    "name": f"SOA records are only allowed with name @ and are created automatically by NetBox DNS"
+                    "name": "SOA records are only allowed with name @ and are created automatically by NetBox DNS"
                 }
             ) from None
 
@@ -738,9 +733,9 @@ class Record(NetBoxModel):
 
         super().save(*args, **kwargs)
 
-        zone = self.zone
-        if self.type != RecordTypeChoices.SOA and zone.soa_serial_auto:
-            zone.update_serial(save_zone_serial=save_zone_serial)
+        _zone = self.zone
+        if self.type != RecordTypeChoices.SOA and _zone.soa_serial_auto:
+            _zone.update_serial(save_zone_serial=save_zone_serial)
 
     def delete(self, *args, save_zone_serial=True, **kwargs):
         if self.rfc2317_cname_record:
@@ -751,9 +746,9 @@ class Record(NetBoxModel):
 
         super().delete(*args, **kwargs)
 
-        zone = self.zone
-        if zone.soa_serial_auto:
-            zone.update_serial(save_zone_serial=save_zone_serial)
+        _zone = self.zone
+        if _zone.soa_serial_auto:
+            _zone.update_serial(save_zone_serial=save_zone_serial)
 
 
 @register_search

netbox_dns/models/registrar.py

@@ -13,6 +13,10 @@ class Registrar(NetBoxModel):
         unique=True,
         max_length=255,
     )
+    description = models.CharField(
+        blank=True,
+        max_length=200,
+    )
     iana_id = models.IntegerField(
         verbose_name="IANA ID",
         null=True,
@@ -43,7 +47,7 @@ class Registrar(NetBoxModel):
     )
 
     def get_absolute_url(self):
-        return reverse("plugins:netbox_dns:registrar", kwargs={"pk": self.id})
+        return reverse("plugins:netbox_dns:registrar", kwargs={"pk": self.pk})
 
     def __str__(self):
         return str(self.name)

netbox_dns/models/view.py

@@ -1,8 +1,11 @@
 from django.db import models
 from django.urls import reverse
+from django.core.exceptions import ValidationError
 
 from netbox.models import NetBoxModel
 from netbox.search import SearchIndex, register_search
+from netbox.context import current_request
+from utilities.exceptions import AbortRequest
 
 
 class View(NetBoxModel):
@@ -14,6 +17,9 @@ class View(NetBoxModel):
         max_length=200,
         blank=True,
     )
+    default_view = models.BooleanField(
+        default=False,
+    )
     tenant = models.ForeignKey(
         to="tenancy.Tenant",
         on_delete=models.PROTECT,
@@ -24,8 +30,12 @@ class View(NetBoxModel):
 
     clone_fields = ["name", "description"]
 
+    @classmethod
+    def get_default_view(cls):
+        return cls.objects.get(default_view=True)
+
     def get_absolute_url(self):
-        return reverse("plugins:netbox_dns:view", kwargs={"pk": self.id})
+        return reverse("plugins:netbox_dns:view", kwargs={"pk": self.pk})
 
     def __str__(self):
         return str(self.name)
@@ -33,6 +43,49 @@ class View(NetBoxModel):
     class Meta:
         ordering = ("name",)
 
+    def delete(self, *args, **kwargs):
+        if self.default_view:
+            if current_request.get() is not None:
+                raise AbortRequest("The default view cannot be deleted")
+
+            raise ValidationError("The default view cannot be deleted")
+
+        super().delete(*args, **kwargs)
+
+    def clean(self, *args, old_state=None, **kwargs):
+        if self.pk is None:
+            return
+
+        old_state = View.objects.get(pk=self.pk)
+
+        if (
+            old_state.default_view
+            and not self.default_view
+            and not View.objects.filter(default_view=True).exclude(pk=self.pk).exists()
+        ):
+            raise ValidationError(
+                {
+                    "default_view": "Please select a different view as default view to change this setting!"
+                }
+            )
+
+        super().clean(*args, **kwargs)
+
+    def save(self, *args, **kwargs):
+        self.clean()
+
+        old_state = None if self.pk is None else View.objects.get(pk=self.pk)
+
+        super().save(*args, **kwargs)
+
+        if (old_state is None and self.default_view) or (
+            old_state is not None and self.default_view and not old_state.default_view
+        ):
+            other_views = View.objects.filter(default_view=True).exclude(pk=self.pk)
+            for view in other_views:
+                view.default_view = False
+                view.save()
+
 
 @register_search
 class ViewIndex(SearchIndex):

netbox_dns/models/zone.py

@@ -15,20 +15,15 @@ from django.db.models import Q, Max, ExpressionWrapper, BooleanField
 from django.urls import reverse
 from django.db.models.signals import m2m_changed
 from django.dispatch import receiver
+from django.conf import settings
 
 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
 
-try:
-    # NetBox 3.5.0 - 3.5.7, 3.5.9+
-    from extras.plugins import get_plugin_config
-except ImportError:
-    # NetBox 3.5.8
-    from extras.plugins.utils import get_plugin_config
-
 from netbox_dns.fields import NetworkField, RFC2317NetworkField
 from netbox_dns.utilities import (
     arpa_to_prefix,
@@ -42,13 +37,17 @@ from netbox_dns.validators import (
 )
 
 # +
-# This is a hack designed to break cyclic imports between Record and Zone
+# 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
 
 
 class ZoneManager(models.Manager.from_queryset(RestrictedQuerySet)):
-    """Special Manager for zones providing the activity status annotation"""
+    """
+    Custom manager for zones providing the activity status annotation
+    """
 
     def get_queryset(self):
         return (
@@ -84,8 +83,7 @@ class Zone(NetBoxModel):
     view = models.ForeignKey(
         to="View",
         on_delete=models.PROTECT,
-        blank=True,
-        null=True,
+        null=False,
     )
     name = models.CharField(
         max_length=255,
@@ -288,11 +286,20 @@ class Zone(NetBoxModel):
             except dns_name.IDNAException:
                 name = self.name
 
-        if self.view:
+        if not self.view.default_view:
             return f"[{self.view}] {name}"
 
         return str(name)
 
+    @staticmethod
+    def get_defaults():
+        return {
+            field[5:]: value
+            for field, value in settings.PLUGINS_CONFIG.get("netbox_dns").items()
+            if field.startswith("zone_")
+            and field not in ("zone_soa_mname", "zone_nameservers")
+        }
+
     @property
     def display_name(self):
         return name_to_unicode(self.name)
@@ -320,11 +327,11 @@ class Zone(NetBoxModel):
 
     def get_rfc2317_parent_zone(self):
         if not self.is_rfc2317_zone:
-            return
+            return None
 
         return (
             Zone.objects.filter(
-                self.view_filter,
+                view=self.view,
                 arpa_network__net_contains=self.rfc2317_prefix,
             )
             .order_by("arpa_network__net_mask_length")
@@ -345,12 +352,6 @@ class Zone(NetBoxModel):
             )
         )
 
-    @property
-    def view_filter(self):
-        if self.view is None:
-            return Q(view__isnull=True)
-        return Q(view=self.view)
-
     def record_count(self, managed=False):
         return record.Record.objects.filter(zone=self, managed=managed).count()
 
@@ -420,19 +421,15 @@ class Zone(NetBoxModel):
         if not nameservers:
             ns_errors.append(f"No nameservers are configured for zone {self}")
 
-        for nameserver in nameservers:
-            name = dns_name.from_text(nameserver.name, origin=None)
+        for _nameserver in nameservers:
+            name = dns_name.from_text(_nameserver.name, origin=None)
             parent = name.parent()
 
             if len(parent) < 2:
                 continue
 
-            view_condition = (
-                Q(view__isnull=True) if self.view is None else Q(view_id=self.view.pk)
-            )
-
             try:
-                ns_zone = Zone.objects.get(view_condition, name=parent.to_text())
+                ns_zone = Zone.objects.get(view_id=self.view.pk, name=parent.to_text())
             except ObjectDoesNotExist:
                 continue
 
@@ -440,7 +437,7 @@ class Zone(NetBoxModel):
             address_records = record.Record.objects.filter(
                 Q(zone=ns_zone),
                 Q(status__in=record.Record.ACTIVE_STATUS_LIST),
-                Q(Q(name=f"{nameserver.name}.") | Q(name=relative_name)),
+                Q(Q(name=f"{_nameserver.name}.") | Q(name=relative_name)),
                 Q(
                     Q(type=record.RecordTypeChoices.A)
                     | Q(type=record.RecordTypeChoices.AAAA)
@@ -449,13 +446,13 @@ class Zone(NetBoxModel):
 
             if not address_records:
                 ns_warnings.append(
-                    f"Nameserver {nameserver.name} does not have an active address record in zone {ns_zone}"
+                    f"Nameserver {_nameserver.name} does not have an active address record in zone {ns_zone}"
                 )
 
         return ns_warnings, ns_errors
 
     def get_auto_serial(self):
-        records = record.Record.objects.filter(zone=self).exclude(
+        records = record.Record.objects.filter(zone_id=self.pk).exclude(
             type=record.RecordTypeChoices.SOA
         )
         if records:
@@ -495,19 +492,6 @@ class Zone(NetBoxModel):
     def network_from_name(self):
         return arpa_to_prefix(self.name)
 
-    def check_name_conflict(self):
-        if self.view is None:
-            if (
-                Zone.objects.exclude(pk=self.pk)
-                .filter(name=self.name.rstrip("."), view__isnull=True)
-                .exists()
-            ):
-                raise ValidationError(
-                    {
-                        "name": f"A zone with name {self.name} and no view already exists."
-                    }
-                )
-
     def update_rfc2317_parent_zone(self):
         if not self.is_rfc2317_zone:
             return
@@ -558,8 +542,33 @@ class Zone(NetBoxModel):
             ptr_zone.save_soa_serial()
             ptr_zone.update_soa_record()
 
+    def clean_fields(self, exclude=None):
+        defaults = settings.PLUGINS_CONFIG.get("netbox_dns")
+
+        if self.view_id is None:
+            self.view_id = view.View.get_default_view().pk
+
+        for field, value in self.get_defaults().items():
+            if getattr(self, field) in (None, ""):
+                if value not in (None, ""):
+                    setattr(self, field, value)
+
+        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:
+                raise ValidationError(
+                    f"Default soa_mname instance {default_soa_mname} does not exist"
+                )
+
+        super().clean_fields(exclude=exclude)
+
     def clean(self, *args, **kwargs):
-        self.check_name_conflict()
+        if self.soa_ttl is None:
+            self.soa_ttl = self.default_ttl
 
         try:
             self.name = normalize_name(self.name)
@@ -579,6 +588,8 @@ class Zone(NetBoxModel):
                 }
             ) from None
 
+        if self.soa_rname in (None, ""):
+            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)
@@ -589,12 +600,13 @@ class Zone(NetBoxModel):
                 }
             ) from None
 
-        if self.soa_serial is None and not self.soa_serial_auto:
-            raise ValidationError(
-                {
-                    "soa_serial": f"soa_serial is not defined and soa_serial_auto is disabled for zone {self.name}."
-                }
-            )
+        if not self.soa_serial_auto:
+            if self.soa_serial is None:
+                raise ValidationError(
+                    {
+                        "soa_serial": f"soa_serial is not defined and soa_serial_auto is disabled for zone {self.name}."
+                    }
+                )
 
         if self.is_reverse_zone:
             self.arpa_network = self.network_from_name
@@ -603,7 +615,7 @@ class Zone(NetBoxModel):
             if self.arpa_network is not None:
                 raise ValidationError(
                     {
-                        "rfc2317_prefix": f"A regular reverse zone can not be used as an RFC2317 zone."
+                        "rfc2317_prefix": "A regular reverse zone can not be used as an RFC2317 zone."
                     }
                 )
 
@@ -622,7 +634,7 @@ class Zone(NetBoxModel):
                 self.rfc2317_parent_zone = None
 
             overlapping_zones = Zone.objects.filter(
-                self.view_filter,
+                view=self.view,
                 rfc2317_prefix__net_overlap=self.rfc2317_prefix,
                 active=True,
             ).exclude(pk=self.pk)
@@ -638,6 +650,8 @@ class Zone(NetBoxModel):
             self.rfc2317_parent_managed = False
             self.rfc2317_parent_zone = None
 
+        super().clean(*args, **kwargs)
+
     def save(self, *args, **kwargs):
         self.full_clean()
 
@@ -662,7 +676,7 @@ class Zone(NetBoxModel):
             new_zone or name_changed or view_changed or status_changed
         ) and self.is_reverse_zone:
             zones = Zone.objects.filter(
-                self.view_filter,
+                view=self.view,
                 arpa_network__net_contains_or_equals=self.arpa_network,
             )
             address_records = record.Record.objects.filter(
@@ -698,7 +712,7 @@ class Zone(NetBoxModel):
             or rfc2317_changed
         ) and self.is_rfc2317_zone:
             zones = Zone.objects.filter(
-                self.view_filter,
+                view=self.view,
                 arpa_network__net_contains=self.rfc2317_prefix,
             )
             address_records = record.Record.objects.filter(

netbox_dns/navigation.py

@@ -1,6 +1,4 @@
-from extras.plugins import PluginMenuButton, PluginMenuItem
-from extras.plugins import PluginMenu
-from utilities.choices import ButtonColorChoices
+from netbox.plugins import PluginMenuButton, PluginMenuItem, PluginMenu
 
 view_menu_item = PluginMenuItem(
     link="plugins:netbox_dns:view_list",
@@ -11,14 +9,12 @@ view_menu_item = PluginMenuItem(
             "plugins:netbox_dns:view_add",
             "Add",
             "mdi mdi-plus-thick",
-            ButtonColorChoices.GREEN,
             permissions=["netbox_dns.add_view"],
         ),
         PluginMenuButton(
             "plugins:netbox_dns:view_import",
             "Import",
             "mdi mdi-upload",
-            ButtonColorChoices.CYAN,
             permissions=["netbox_dns.add_view"],
         ),
     ),
@@ -33,14 +29,12 @@ zone_menu_item = PluginMenuItem(
             "plugins:netbox_dns:zone_add",
             "Add",
             "mdi mdi-plus-thick",
-            ButtonColorChoices.GREEN,
             permissions=["netbox_dns.add_zone"],
         ),
         PluginMenuButton(
             "plugins:netbox_dns:zone_import",
             "Import",
             "mdi mdi-upload",
-            ButtonColorChoices.CYAN,
             permissions=["netbox_dns.add_zone"],
         ),
     ),
@@ -55,14 +49,12 @@ nameserver_menu_item = PluginMenuItem(
             "plugins:netbox_dns:nameserver_add",
             "Add",
             "mdi mdi-plus-thick",
-            ButtonColorChoices.GREEN,
             permissions=["netbox_dns.add_nameserver"],
         ),
         PluginMenuButton(
             "plugins:netbox_dns:nameserver_import",
             "Import",
             "mdi mdi-upload",
-            ButtonColorChoices.CYAN,
             permissions=["netbox_dns.add_nameserver"],
         ),
     ),
@@ -77,14 +69,12 @@ record_menu_item = PluginMenuItem(
             "plugins:netbox_dns:record_add",
             "Add",
             "mdi mdi-plus-thick",
-            ButtonColorChoices.GREEN,
             permissions=["netbox_dns.add_record"],
         ),
         PluginMenuButton(
             "plugins:netbox_dns:record_import",
             "Import",
             "mdi mdi-upload",
-            ButtonColorChoices.CYAN,
             permissions=["netbox_dns.add_record"],
         ),
     ),
@@ -105,14 +95,12 @@ registrar_menu_item = PluginMenuItem(
             "plugins:netbox_dns:registrar_add",
             "Add",
             "mdi mdi-plus-thick",
-            ButtonColorChoices.GREEN,
             permissions=["netbox_dns.add_registrar"],
         ),
         PluginMenuButton(
             "plugins:netbox_dns:registrar_import",
             "Import",
             "mdi mdi-upload",
-            ButtonColorChoices.CYAN,
             permissions=["netbox_dns.add_registrar"],
         ),
     ),
@@ -127,14 +115,12 @@ contact_menu_item = PluginMenuItem(
             "plugins:netbox_dns:contact_add",
             "Add",
             "mdi mdi-plus-thick",
-            ButtonColorChoices.GREEN,
             permissions=["netbox_dns.add_contact"],
         ),
         PluginMenuButton(
             "plugins:netbox_dns:contact_import",
             "Import",
             "mdi mdi-upload",
-            ButtonColorChoices.CYAN,
             permissions=["netbox_dns.add_contact"],
         ),
     ),

netbox_dns/signals/ipam_coupling.py

@@ -5,6 +5,7 @@ from rest_framework.exceptions import PermissionDenied as APIPermissionDenied
 
 from netbox.signals import post_clean
 from netbox.context import current_request
+from netbox.plugins.utils import get_plugin_config
 from ipam.models import IPAddress
 
 from netbox_dns.models import Zone
@@ -18,13 +19,6 @@ from netbox_dns.utilities.ipam_coupling import (
     DNSPermissionDenied,
 )
 
-try:
-    # NetBox 3.5.0 - 3.5.7, 3.5.9+
-    from extras.plugins import get_plugin_config
-except ImportError:
-    # NetBox 3.5.8
-    from extras.plugins.utils import get_plugin_config
-
 
 @receiver(post_clean, sender=IPAddress)
 def ip_address_check_permissions_save(instance, **kwargs):
@@ -39,14 +33,14 @@ def ip_address_check_permissions_save(instance, **kwargs):
         return
 
     try:
-        if instance.id is None:
+        if instance.pk is None:
             record = new_address_record(instance)
             if record is not None:
                 record.full_clean()
                 check_permission(request, "netbox_dns.add_record", record)
 
         else:
-            if not dns_changed(IPAddress.objects.get(pk=instance.id), instance):
+            if not dns_changed(IPAddress.objects.get(pk=instance.pk), instance):
                 return
 
             record = get_address_record(instance)