netbox-plugin-dns 1.0b2__py3-none-any.whl → 1.0.2__py3-none-any.whl

netbox_dns/models/zone.py

@@ -15,15 +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
 
-from netbox.plugins.utils import get_plugin_config
-
 from netbox_dns.fields import NetworkField, RFC2317NetworkField
 from netbox_dns.utilities import (
     arpa_to_prefix,
@@ -35,11 +35,14 @@ from netbox_dns.validators import (
     validate_fqdn,
     validate_domain_name,
 )
+from netbox_dns.mixins import ObjectModificationMixin
 
 # +
-# 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)):
@@ -75,14 +78,13 @@ class ZoneStatusChoices(ChoiceSet):
     ]
 
 
-class Zone(NetBoxModel):
+class Zone(ObjectModificationMixin, NetBoxModel):
     ACTIVE_STATUS_LIST = (ZoneStatusChoices.STATUS_ACTIVE,)
 
     view = models.ForeignKey(
         to="View",
         on_delete=models.PROTECT,
-        blank=True,
-        null=True,
+        null=False,
     )
     name = models.CharField(
         max_length=255,
@@ -285,11 +287,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)
@@ -317,11 +328,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")
@@ -342,12 +353,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()
 
@@ -417,19 +422,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
 
@@ -437,7 +438,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)
@@ -446,11 +447,23 @@ 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 check_soa_serial_increment(self, old_serial, new_serial):
+        MAX_SOA_SERIAL_INCREMENT = 2**31 - 1
+        SOA_SERIAL_WRAP = 2**32
+
+        if old_serial is None:
+            return
+
+        if (new_serial - old_serial) % SOA_SERIAL_WRAP > MAX_SOA_SERIAL_INCREMENT:
+            raise ValidationError(
+                {"soa_serial": f"soa_serial must not decrease for zone {self.name}."}
+            )
+
     def get_auto_serial(self):
         records = record.Record.objects.filter(zone_id=self.pk).exclude(
             type=record.RecordTypeChoices.SOA
@@ -492,19 +505,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
@@ -555,8 +555,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)
@@ -576,6 +601,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)
@@ -586,12 +613,29 @@ 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.pk is not None:
+            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:
+                try:
+                    self.check_soa_serial_increment(
+                        old_zone.soa_serial, self.get_auto_serial()
+                    )
+                except ValidationError:
+                    raise ValidationError(
+                        {
+                            "soa_serial_auto": f"Enabling soa_serial_auto would decrease soa_serial for zone {self.name}."
+                        }
+                    )
 
         if self.is_reverse_zone:
             self.arpa_network = self.network_from_name
@@ -619,7 +663,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)
@@ -635,20 +679,12 @@ 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()
 
-        new_zone = self.pk is None
-        if not new_zone:
-            old_zone = Zone.objects.get(pk=self.pk)
-
-        name_changed = not new_zone and old_zone.name != self.name
-        view_changed = not new_zone and old_zone.view != self.view
-        status_changed = not new_zone and old_zone.status != self.status
-        rfc2317_changed = not new_zone and (
-            old_zone.rfc2317_prefix != self.rfc2317_prefix
-            or old_zone.rfc2317_parent_managed != self.rfc2317_parent_managed
-        )
+        changed_fields = self.changed_fields
 
         if self.soa_serial_auto:
             self.soa_serial = self.get_auto_serial()
@@ -656,10 +692,10 @@ class Zone(NetBoxModel):
         super().save(*args, **kwargs)
 
         if (
-            new_zone or name_changed or view_changed or status_changed
+            changed_fields is None or {"name", "view", "status"} & changed_fields
         ) 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(
@@ -688,14 +724,12 @@ class Zone(NetBoxModel):
                     child_zone.update_rfc2317_parent_zone()
 
         if (
-            new_zone
-            or name_changed
-            or view_changed
-            or status_changed
-            or rfc2317_changed
+            changed_fields is None
+            or {"name", "view", "status", "rfc2317_prefix", "rfc2317_parent_managed"}
+            & changed_fields
         ) 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(
@@ -718,7 +752,7 @@ class Zone(NetBoxModel):
 
             self.update_rfc2317_parent_zone()
 
-        elif name_changed or view_changed or status_changed:
+        elif changed_fields is not None and {"name", "view", "status"} & changed_fields:
             for address_record in self.record_set.filter(
                 type__in=(record.RecordTypeChoices.A, record.RecordTypeChoices.AAAA)
             ):
@@ -727,7 +761,7 @@ class Zone(NetBoxModel):
             # Fix name in IP Address when zone name is changed
             if (
                 get_plugin_config("netbox_dns", "feature_ipam_coupling")
-                and name_changed
+                and "name" in changed_fields
             ):
                 for ip in IPAddress.objects.filter(
                     custom_field_data__ipaddress_dns_zone_id=self.pk
@@ -735,7 +769,7 @@ class Zone(NetBoxModel):
                     ip.dns_name = f'{ip.custom_field_data["ipaddress_dns_record_name"]}.{self.name}'
                     ip.save(update_fields=["dns_name"])
 
-        if name_changed:
+        if changed_fields is not None and "name" in changed_fields:
             for _record in self.record_set.all():
                 _record.save(
                     update_fields=["fqdn"],

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,8 +19,6 @@ from netbox_dns.utilities.ipam_coupling import (
     DNSPermissionDenied,
 )
 
-from netbox.plugins.utils import get_plugin_config
-
 
 @receiver(post_clean, sender=IPAddress)
 def ip_address_check_permissions_save(instance, **kwargs):

netbox_dns/tables/view.py

@@ -10,9 +10,19 @@ class ViewTable(TenancyColumnsMixin, NetBoxTable):
     name = tables.Column(
         linkify=True,
     )
+    default_view = tables.BooleanColumn(
+        verbose_name="Default View",
+    )
     tags = TagColumn(url_name="plugins:netbox_dns:view_list")
 
     class Meta(NetBoxTable.Meta):
         model = View
-        fields = ("name", "description", "tenant", "tenant_group", "tags")
-        default_columns = ("name",)
+        fields = (
+            "name",
+            "default_view",
+            "description",
+            "tenant",
+            "tenant_group",
+            "tags",
+        )
+        default_columns = ("name", "default_view")

netbox_dns/template_content.py

@@ -117,7 +117,7 @@ class RelatedDNSObjects(PluginTemplateExtension):
         )
 
 
-template_extensions = list()
+template_extensions = []
 
 if version.parse(settings.VERSION) < version.parse("3.7.0"):
     template_extensions.append(RelatedDNSObjects)

netbox_dns/templates/netbox_dns/record.html

@@ -56,7 +56,7 @@
                     <td><a href="{% url 'plugins:netbox_dns:zone_records' pk=object.zone.pk %}">{{ object.zone }}</a></td>
                     {% endif %}
                 </tr>
-                {% if not object.managed %}
+                {% if not object.managed or object.tenant %}
                 <tr>
                     <th scope="row">Tenant</th>
                     <td>

netbox_dns/templates/netbox_dns/view.html

@@ -10,6 +10,10 @@
                         <th scope="row">Name</th>
                         <td>{{ object.name }}</td>
                     </tr>
+                    <tr>
+                        <th scope="row">Default View</th>
+                        <td>{% checkmark object.default_view %}</td>
+                    </tr>
                     {% if object.description %}
                     <tr>
                         <th scope="row">Description</th>

netbox_dns/templates/netbox_dns/zone.html

@@ -20,7 +20,6 @@
                         <td>{{ unicode_name }}</td>
                     </tr>
                 {% endif %}
-                {% if object.view %}
                 <tr>
                     <th scope="row">View</th>
                     <td>
@@ -29,7 +28,6 @@
                         </a>
                     </td>
                 </tr>
-                {% endif %}
                 {% if object.description %}
                 <tr>
                     <th scope="row">Description</th>
@@ -116,11 +114,11 @@
                     <td>{{ object.soa_ttl }}</td>
                 </tr>
                 <tr>
-                    <th scope="row">Primary Nameserver</th>
+                    <th scope="row">MName</th>
                     <td><a href="{% url 'plugins:netbox_dns:nameserver' pk=object.soa_mname.pk %}">{{ object.soa_mname }}</a></td>
                 </tr>
                 <tr>
-                    <th scope="row">Responsible</th>
+                    <th scope="row">RName</th>
                     <td>{{ object.soa_rname }}</td>
                 </tr>
                 {% if object.soa_serial_auto %}

netbox_dns/urls/__init__.py

@@ -0,0 +1,17 @@
+from .contact import contact_urlpatterns
+from .nameserver import nameserver_urlpatterns
+from .record import record_urlpatterns
+from .registrar import registrar_urlpatterns
+from .view import view_urlpatterns
+from .zone import zone_urlpatterns
+
+app_name = "netbox_dns"
+
+urlpatterns = (
+    contact_urlpatterns
+    + nameserver_urlpatterns
+    + record_urlpatterns
+    + registrar_urlpatterns
+    + view_urlpatterns
+    + zone_urlpatterns
+)

netbox_dns/urls/contact.py

@@ -0,0 +1,51 @@
+from django.urls import path
+
+from netbox.views.generic import ObjectChangeLogView, ObjectJournalView
+
+from netbox_dns.models import Contact
+from netbox_dns.views import (
+    ContactListView,
+    ContactView,
+    ContactDeleteView,
+    ContactEditView,
+    ContactBulkImportView,
+    ContactBulkEditView,
+    ContactBulkDeleteView,
+    ContactZoneListView,
+)
+
+contact_urlpatterns = [
+    path("contacts/", ContactListView.as_view(), name="contact_list"),
+    path("contacts/add/", ContactEditView.as_view(), name="contact_add"),
+    path("contacts/import/", ContactBulkImportView.as_view(), name="contact_import"),
+    path("contacts/edit/", ContactBulkEditView.as_view(), name="contact_bulk_edit"),
+    path(
+        "contacts/delete/",
+        ContactBulkDeleteView.as_view(),
+        name="contact_bulk_delete",
+    ),
+    path("contacts/<int:pk>/", ContactView.as_view(), name="contact"),
+    path("contacts/<int:pk>/edit/", ContactEditView.as_view(), name="contact_edit"),
+    path(
+        "contacts/<int:pk>/delete/",
+        ContactDeleteView.as_view(),
+        name="contact_delete",
+    ),
+    path(
+        "contacts/<int:pk>/zones/",
+        ContactZoneListView.as_view(),
+        name="contact_zones",
+    ),
+    path(
+        "contacts/<int:pk>/journal/",
+        ObjectJournalView.as_view(),
+        name="contact_journal",
+        kwargs={"model": Contact},
+    ),
+    path(
+        "contacts/<int:pk>/changelog/",
+        ObjectChangeLogView.as_view(),
+        name="contact_changelog",
+        kwargs={"model": Contact},
+    ),
+]

netbox_dns/urls/nameserver.py

@@ -0,0 +1,69 @@
+from django.urls import path
+
+from netbox.views.generic import ObjectChangeLogView, ObjectJournalView
+
+from netbox_dns.models import NameServer
+from netbox_dns.views import (
+    NameServerListView,
+    NameServerView,
+    NameServerEditView,
+    NameServerDeleteView,
+    NameServerBulkImportView,
+    NameServerBulkEditView,
+    NameServerBulkDeleteView,
+    NameServerZoneListView,
+    NameServerSOAZoneListView,
+)
+
+nameserver_urlpatterns = [
+    path("nameservers/", NameServerListView.as_view(), name="nameserver_list"),
+    path("nameservers/add/", NameServerEditView.as_view(), name="nameserver_add"),
+    path(
+        "nameservers/import/",
+        NameServerBulkImportView.as_view(),
+        name="nameserver_import",
+    ),
+    path(
+        "nameservers/edit/",
+        NameServerBulkEditView.as_view(),
+        name="nameserver_bulk_edit",
+    ),
+    path(
+        "nameservers/delete/",
+        NameServerBulkDeleteView.as_view(),
+        name="nameserver_bulk_delete",
+    ),
+    path("nameservers/<int:pk>/", NameServerView.as_view(), name="nameserver"),
+    path(
+        "nameservers/<int:pk>/edit",
+        NameServerEditView.as_view(),
+        name="nameserver_edit",
+    ),
+    path(
+        "nameservers/<int:pk>/delete",
+        NameServerDeleteView.as_view(),
+        name="nameserver_delete",
+    ),
+    path(
+        "nameservers/<int:pk>/journal/",
+        ObjectJournalView.as_view(),
+        name="nameserver_journal",
+        kwargs={"model": NameServer},
+    ),
+    path(
+        "nameservers/<int:pk>/changelog/",
+        ObjectChangeLogView.as_view(),
+        name="nameserver_changelog",
+        kwargs={"model": NameServer},
+    ),
+    path(
+        "nameservers/<int:pk>/zones/",
+        NameServerZoneListView.as_view(),
+        name="nameserver_zones",
+    ),
+    path(
+        "nameservers/<int:pk>/soazones/",
+        NameServerSOAZoneListView.as_view(),
+        name="nameserver_soa_zones",
+    ),
+]

netbox_dns/urls/record.py

@@ -0,0 +1,41 @@
+from django.urls import path
+
+from netbox.views.generic import ObjectChangeLogView, ObjectJournalView
+
+from netbox_dns.models import Record
+from netbox_dns.views import (
+    RecordListView,
+    RecordView,
+    RecordEditView,
+    RecordDeleteView,
+    RecordBulkImportView,
+    RecordBulkEditView,
+    RecordBulkDeleteView,
+    ManagedRecordListView,
+)
+
+record_urlpatterns = [
+    path("records/", RecordListView.as_view(), name="record_list"),
+    path("records/add/", RecordEditView.as_view(), name="record_add"),
+    path("records/import/", RecordBulkImportView.as_view(), name="record_import"),
+    path("records/edit/", RecordBulkEditView.as_view(), name="record_bulk_edit"),
+    path("records/delete/", RecordBulkDeleteView.as_view(), name="record_bulk_delete"),
+    path("records/<int:pk>/", RecordView.as_view(), name="record"),
+    path("records/<int:pk>/edit/", RecordEditView.as_view(), name="record_edit"),
+    path("records/<int:pk>/delete/", RecordDeleteView.as_view(), name="record_delete"),
+    path(
+        "records/<int:pk>/journal/",
+        ObjectJournalView.as_view(),
+        name="record_journal",
+        kwargs={"model": Record},
+    ),
+    path(
+        "records/<int:pk>/changelog/",
+        ObjectChangeLogView.as_view(),
+        name="record_changelog",
+        kwargs={"model": Record},
+    ),
+    path(
+        "managedrecords/", ManagedRecordListView.as_view(), name="managed_record_list"
+    ),
+]