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

netbox_dns/forms/__init__.py

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

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

@@ -9,18 +9,18 @@ from netbox.forms import (
 from utilities.forms.fields import TagFilterField
 from utilities.forms.rendering import FieldSet
 
-from netbox_dns.models import Contact
+from netbox_dns.models import RegistrationContact
 
 
 __all__ = (
-    "ContactForm",
-    "ContactFilterForm",
-    "ContactImportForm",
-    "ContactBulkEditForm",
+    "RegistrationContactForm",
+    "RegistrationContactFilterForm",
+    "RegistrationContactImportForm",
+    "RegistrationContactBulkEditForm",
 )
 
 
-class ContactForm(NetBoxModelForm):
+class RegistrationContactForm(NetBoxModelForm):
     fieldsets = (
         FieldSet(
             "name",
@@ -37,13 +37,13 @@ class ContactForm(NetBoxModelForm):
             "fax",
             "fax_ext",
             "email",
-            name="Contact",
+            name="RegistrationContact",
         ),
         FieldSet("tags", name="Tags"),
     )
 
     class Meta:
-        model = Contact
+        model = RegistrationContact
         fields = (
             "name",
             "description",
@@ -63,8 +63,8 @@ class ContactForm(NetBoxModelForm):
         )
 
 
-class ContactFilterForm(NetBoxModelFilterSetForm):
-    model = Contact
+class RegistrationContactFilterForm(NetBoxModelFilterSetForm):
+    model = RegistrationContact
 
     fieldsets = (
         FieldSet("q", "filter_id", "tag"),
@@ -89,7 +89,7 @@ class ContactFilterForm(NetBoxModelFilterSetForm):
     )
     contact_id = forms.CharField(
         required=False,
-        label="Contact ID",
+        label="RegistrationContact ID",
     )
     organization = forms.CharField(
         required=False,
@@ -128,12 +128,12 @@ class ContactFilterForm(NetBoxModelFilterSetForm):
     email = forms.CharField(
         required=False,
     )
-    tag = TagFilterField(Contact)
+    tag = TagFilterField(RegistrationContact)
 
 
-class ContactImportForm(NetBoxModelImportForm):
+class RegistrationContactImportForm(NetBoxModelImportForm):
     class Meta:
-        model = Contact
+        model = RegistrationContact
         fields = (
             "name",
             "description",
@@ -153,8 +153,8 @@ class ContactImportForm(NetBoxModelImportForm):
         )
 
 
-class ContactBulkEditForm(NetBoxModelBulkEditForm):
-    model = Contact
+class RegistrationContactBulkEditForm(NetBoxModelBulkEditForm):
+    model = RegistrationContact
 
     name = forms.CharField(
         required=False,

netbox_dns/forms/view.py

@@ -1,4 +1,7 @@
 from django import forms
+from django.conf import settings
+from django.core.exceptions import ValidationError
+from django.db.models import Q, Count
 
 from netbox.forms import (
     NetBoxModelBulkEditForm,
@@ -9,14 +12,24 @@ from netbox.forms import (
 from utilities.forms.fields import (
     TagFilterField,
     CSVModelChoiceField,
+    CSVModelMultipleChoiceField,
     DynamicModelChoiceField,
+    DynamicModelMultipleChoiceField,
 )
 from utilities.forms import BOOLEAN_WITH_BLANK_CHOICES
 from utilities.forms.rendering import FieldSet
 from tenancy.models import Tenant
 from tenancy.forms import TenancyForm, TenancyFilterForm
+from ipam.models import Prefix
+from netbox.context import current_request
 
 from netbox_dns.models import View
+from netbox_dns.fields import PrefixDynamicModelMultipleChoiceField
+from netbox_dns.utilities import (
+    check_dns_records,
+    get_ip_addresses_by_prefix,
+    get_views_by_prefix,
+)
 
 
 __all__ = (
@@ -24,25 +37,121 @@ __all__ = (
     "ViewFilterForm",
     "ViewImportForm",
     "ViewBulkEditForm",
+    "ViewPrefixEditForm",
 )
 
 
-class ViewForm(TenancyForm, NetBoxModelForm):
+class ViewPrefixUpdateMixin:
+    def clean(self, *args, **kwargs):
+        super().clean(*args, **kwargs)
+
+        if self.instance.pk is None or "prefixes" not in self.changed_data:
+            return
+
+        prefixes = self.cleaned_data.get("prefixes")
+        old_prefixes = View.objects.get(pk=self.instance.pk).prefixes.all()
+
+        for prefix in prefixes.difference(old_prefixes):
+            for ip_address in get_ip_addresses_by_prefix(prefix, check_view=False):
+                try:
+                    check_dns_records(ip_address, view=self.instance)
+                except ValidationError as exc:
+                    self.add_error("prefixes", exc.messages)
+
+        # +
+        # Determine the prefixes that, when removed from the view, have no direct view
+        # assignment left. These prefixes will potentially inherit from a different view,
+        # which means that they have to be validated against different zones.
+        # -
+        check_prefixes = set(
+            old_prefixes.annotate(view_count=Count("netbox_dns_views")).filter(
+                Q(view_count=1, netbox_dns_views=self.instance)
+                | Q(netbox_dns_views__isnull=True)
+            )
+        ) - set(prefixes)
+
+        for check_prefix in check_prefixes:
+            # +
+            # Check whether the prefix will get a new view by inheritance from its
+            # parent. If that's the case, the IP addresses need to be checked.
+            # -
+            if (parent := check_prefix.get_parents().last()) is None:
+                continue
+
+            for view in get_views_by_prefix(parent):
+                if view == self.instance:
+                    continue
+
+                for ip_address in get_ip_addresses_by_prefix(
+                    check_prefix, check_view=False
+                ):
+                    try:
+                        check_dns_records(ip_address, view=view)
+                    except ValidationError as exc:
+                        self.add_error("prefixes", exc.messages)
+
+
+class ViewForm(ViewPrefixUpdateMixin, TenancyForm, NetBoxModelForm):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        if settings.PLUGINS_CONFIG["netbox_dns"].get("dnssync_disabled"):
+            del self.fields["prefixes"]
+
+        if request := current_request.get():
+            if not request.user.has_perm("ipam.view_prefix"):
+                self._saved_prefixes = self.initial["prefixes"]
+                self.initial["prefixes"] = []
+                self.fields["prefixes"].disabled = True
+                self.fields["prefixes"].widget.attrs[
+                    "placeholder"
+                ] = "You do not have permission to modify assigned prefixes"
+
+    def clean_prefixes(self):
+        if hasattr(self, "_saved_prefixes"):
+            return self._saved_prefixes
+
+        return self.cleaned_data["prefixes"]
+
+    prefixes = PrefixDynamicModelMultipleChoiceField(
+        queryset=Prefix.objects.all(),
+        required=False,
+        label="IPAM Prefixes",
+        context={
+            "depth": None,
+        },
+    )
+
     fieldsets = (
         FieldSet("name", "default_view", "description", "tags", name="View"),
+        FieldSet("prefixes"),
         FieldSet("tenant_group", "tenant", name="Tenancy"),
     )
 
     class Meta:
         model = View
-        fields = ("name", "default_view", "description", "tags", "tenant")
+        fields = (
+            "name",
+            "default_view",
+            "description",
+            "tags",
+            "tenant",
+            "prefixes",
+        )
 
 
 class ViewFilterForm(TenancyFilterForm, NetBoxModelFilterSetForm):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        if settings.PLUGINS_CONFIG["netbox_dns"].get("dnssync_disabled"):
+            del self.fields["prefix_id"]
+
     model = View
     fieldsets = (
         FieldSet("q", "filter_id", "tag"),
         FieldSet("name", "default_view", "description", name="Attributes"),
+        FieldSet("prefix_id"),
         FieldSet("tenant_group_id", "tenant_id", name="Tenancy"),
     )
 
@@ -56,10 +165,30 @@ class ViewFilterForm(TenancyFilterForm, NetBoxModelFilterSetForm):
     description = forms.CharField(
         required=False,
     )
+    prefix_id = PrefixDynamicModelMultipleChoiceField(
+        queryset=Prefix.objects.all(),
+        required=False,
+        label="Prefix",
+        context={
+            "depth": None,
+        },
+    )
     tag = TagFilterField(View)
 
 
-class ViewImportForm(NetBoxModelImportForm):
+class ViewImportForm(ViewPrefixUpdateMixin, NetBoxModelImportForm):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        if settings.PLUGINS_CONFIG["netbox_dns"].get("dnssync_disabled"):
+            del self.fields["prefixes"]
+
+    prefixes = CSVModelMultipleChoiceField(
+        queryset=Prefix.objects.all(),
+        to_field_name="id",
+        required=False,
+        help_text="Prefix IDs assigned to the view",
+    )
     tenant = CSVModelChoiceField(
         queryset=Tenant.objects.all(),
         to_field_name="name",
@@ -69,7 +198,7 @@ class ViewImportForm(NetBoxModelImportForm):
 
     class Meta:
         model = View
-        fields = ("name", "description", "tenant", "tags")
+        fields = ("name", "description", "prefixes", "tenant", "tags")
 
 
 class ViewBulkEditForm(NetBoxModelBulkEditForm):
@@ -88,3 +217,74 @@ class ViewBulkEditForm(NetBoxModelBulkEditForm):
     )
 
     nullable_fields = ("description", "tenant")
+
+
+class ViewPrefixEditForm(forms.ModelForm):
+    views = DynamicModelMultipleChoiceField(
+        queryset=View.objects.all(),
+        required=False,
+        label="Assigned DNS Views",
+        help_text="Explicitly assigning DNS views overrides all inherited views for this prefix",
+    )
+
+    class Meta:
+        model = Prefix
+        fields = ("views",)
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        self.initial["views"] = self.instance.netbox_dns_views.all()
+        self._permission_denied = False
+
+        if request := current_request.get():
+            if not request.user.has_perm("netbox_dns.change_view"):
+                self._permission_denied = True
+                self.initial["views"] = []
+                self.fields["views"].disabled = True
+                self.fields["views"].widget.attrs[
+                    "placeholder"
+                ] = "You do not have permission to modify assigned views"
+
+    def clean(self, *args, **kwargs):
+        if self._permission_denied:
+            return
+
+        prefix = self.instance
+
+        super().clean(*args, **kwargs)
+
+        views = self.cleaned_data.get("views")
+        old_views = prefix.netbox_dns_views.all()
+
+        check_views = View.objects.none()
+
+        if not views.exists():
+            if (parent := prefix.get_parents().last()) is not None:
+                check_views = parent.netbox_dns_views.all().difference(old_views)
+
+        else:
+            check_views = views.difference(old_views)
+
+        for view in check_views:
+            try:
+                for ip_address in get_ip_addresses_by_prefix(prefix, check_view=False):
+                    check_dns_records(ip_address, view=view)
+            except ValidationError as exc:
+                self.add_error("views", exc.messages)
+
+    def save(self, *args, **kwargs):
+        prefix = self.instance
+
+        if self._permission_denied:
+            return prefix
+
+        old_views = prefix.netbox_dns_views.all()
+        views = self.cleaned_data.get("views")
+
+        for view in views.difference(old_views):
+            view.prefixes.add(prefix)
+        for view in old_views.difference(views):
+            view.prefixes.remove(prefix)
+
+        return prefix

netbox_dns/forms/zone.py

@@ -30,7 +30,7 @@ from netbox_dns.models import (
     Zone,
     NameServer,
     Registrar,
-    Contact,
+    RegistrationContact,
     ZoneTemplate,
 )
 from netbox_dns.choices import ZoneStatusChoices
@@ -81,7 +81,7 @@ class ZoneTemplateUpdateMixin:
                 else:
                     zone_data = self.cleaned_data.copy()
 
-                    custom_fields = dict()
+                    custom_fields = {}
                     for key, value in zone_data.copy().items():
                         if key.startswith("cf_"):
                             custom_fields[key[3:]] = value
@@ -105,10 +105,7 @@ class ZoneTemplateUpdateMixin:
                 raise RollbackTransaction
 
         except ValidationError as exc:
-            if isinstance(exc, dict):
-                template_error = item.value()
-            else:
-                template_error = [exc]
+            self.add_error("template", exc.messages)
         except RollbackTransaction:
             pass
 
@@ -424,22 +421,22 @@ class ZoneFilterForm(TenancyFilterForm, NetBoxModelFilterSetForm):
         label="Registry Domain ID",
     )
     registrant_id = DynamicModelMultipleChoiceField(
-        queryset=Contact.objects.all(),
+        queryset=RegistrationContact.objects.all(),
         required=False,
         label="Registrant",
     )
     admin_c_id = DynamicModelMultipleChoiceField(
-        queryset=Contact.objects.all(),
+        queryset=RegistrationContact.objects.all(),
         required=False,
         label="Admin-C",
     )
     tech_c_id = DynamicModelMultipleChoiceField(
-        queryset=Contact.objects.all(),
+        queryset=RegistrationContact.objects.all(),
         required=False,
         label="Tech-C",
     )
     billing_c_id = DynamicModelMultipleChoiceField(
-        queryset=Contact.objects.all(),
+        queryset=RegistrationContact.objects.all(),
         required=False,
         label="Billing-C",
     )
@@ -535,7 +532,7 @@ class ZoneImportForm(ZoneTemplateUpdateMixin, NetBoxModelImportForm):
         help_text="Domain ID assigned by the registry",
     )
     registrant = CSVModelChoiceField(
-        queryset=Contact.objects.all(),
+        queryset=RegistrationContact.objects.all(),
         required=False,
         to_field_name="contact_id",
         help_text="Owner of the domain",
@@ -544,7 +541,7 @@ class ZoneImportForm(ZoneTemplateUpdateMixin, NetBoxModelImportForm):
         },
     )
     admin_c = CSVModelChoiceField(
-        queryset=Contact.objects.all(),
+        queryset=RegistrationContact.objects.all(),
         required=False,
         to_field_name="contact_id",
         help_text="Administrative contact for the domain",
@@ -553,7 +550,7 @@ class ZoneImportForm(ZoneTemplateUpdateMixin, NetBoxModelImportForm):
         },
     )
     tech_c = CSVModelChoiceField(
-        queryset=Contact.objects.all(),
+        queryset=RegistrationContact.objects.all(),
         required=False,
         to_field_name="contact_id",
         help_text="Technical contact for the domain",
@@ -562,7 +559,7 @@ class ZoneImportForm(ZoneTemplateUpdateMixin, NetBoxModelImportForm):
         },
     )
     billing_c = CSVModelChoiceField(
-        queryset=Contact.objects.all(),
+        queryset=RegistrationContact.objects.all(),
         required=False,
         to_field_name="contact_id",
         help_text="Billing contact for the domain",
@@ -722,21 +719,21 @@ class ZoneBulkEditForm(NetBoxModelBulkEditForm):
         label="Registry Domain ID",
     )
     registrant = DynamicModelChoiceField(
-        queryset=Contact.objects.all(),
+        queryset=RegistrationContact.objects.all(),
         required=False,
     )
     admin_c = DynamicModelChoiceField(
-        queryset=Contact.objects.all(),
+        queryset=RegistrationContact.objects.all(),
         required=False,
         label="Administrative Contact",
     )
     tech_c = DynamicModelChoiceField(
-        queryset=Contact.objects.all(),
+        queryset=RegistrationContact.objects.all(),
         required=False,
         label="Technical Contact",
     )
     billing_c = DynamicModelChoiceField(
-        queryset=Contact.objects.all(),
+        queryset=RegistrationContact.objects.all(),
         required=False,
         label="Billing Contact",
     )

netbox_dns/forms/zone_template.py

@@ -22,7 +22,7 @@ from netbox_dns.models import (
     RecordTemplate,
     NameServer,
     Registrar,
-    Contact,
+    RegistrationContact,
 )
 
 
@@ -117,22 +117,22 @@ class ZoneTemplateFilterForm(TenancyFilterForm, NetBoxModelFilterSetForm):
         label="Registrar",
     )
     registrant_id = DynamicModelMultipleChoiceField(
-        queryset=Contact.objects.all(),
+        queryset=RegistrationContact.objects.all(),
         required=False,
         label="Registrant",
     )
     admin_c_id = DynamicModelMultipleChoiceField(
-        queryset=Contact.objects.all(),
+        queryset=RegistrationContact.objects.all(),
         required=False,
         label="Admin-C",
     )
     tech_c_id = DynamicModelMultipleChoiceField(
-        queryset=Contact.objects.all(),
+        queryset=RegistrationContact.objects.all(),
         required=False,
         label="Tech-C",
     )
     billing_c_id = DynamicModelMultipleChoiceField(
-        queryset=Contact.objects.all(),
+        queryset=RegistrationContact.objects.all(),
         required=False,
         label="Billing-C",
     )
@@ -162,7 +162,7 @@ class ZoneTemplateImportForm(NetBoxModelImportForm):
         },
     )
     registrant = CSVModelChoiceField(
-        queryset=Contact.objects.all(),
+        queryset=RegistrationContact.objects.all(),
         required=False,
         to_field_name="contact_id",
         help_text="Owner of the domain",
@@ -171,7 +171,7 @@ class ZoneTemplateImportForm(NetBoxModelImportForm):
         },
     )
     admin_c = CSVModelChoiceField(
-        queryset=Contact.objects.all(),
+        queryset=RegistrationContact.objects.all(),
         required=False,
         to_field_name="contact_id",
         help_text="Administrative contact for the domain",
@@ -180,7 +180,7 @@ class ZoneTemplateImportForm(NetBoxModelImportForm):
         },
     )
     tech_c = CSVModelChoiceField(
-        queryset=Contact.objects.all(),
+        queryset=RegistrationContact.objects.all(),
         required=False,
         to_field_name="contact_id",
         help_text="Technical contact for the domain",
@@ -189,7 +189,7 @@ class ZoneTemplateImportForm(NetBoxModelImportForm):
         },
     )
     billing_c = CSVModelChoiceField(
-        queryset=Contact.objects.all(),
+        queryset=RegistrationContact.objects.all(),
         required=False,
         to_field_name="contact_id",
         help_text="Billing contact for the domain",
@@ -237,21 +237,21 @@ class ZoneTemplateBulkEditForm(NetBoxModelBulkEditForm):
         required=False,
     )
     registrant = DynamicModelChoiceField(
-        queryset=Contact.objects.all(),
+        queryset=RegistrationContact.objects.all(),
         required=False,
     )
     admin_c = DynamicModelChoiceField(
-        queryset=Contact.objects.all(),
+        queryset=RegistrationContact.objects.all(),
         required=False,
         label="Administrative Contact",
     )
     tech_c = DynamicModelChoiceField(
-        queryset=Contact.objects.all(),
+        queryset=RegistrationContact.objects.all(),
         required=False,
         label="Technical Contact",
     )
     billing_c = DynamicModelChoiceField(
-        queryset=Contact.objects.all(),
+        queryset=RegistrationContact.objects.all(),
         required=False,
         label="Billing Contact",
     )

netbox_dns/graphql/__init__.py

@@ -1,7 +1,7 @@
 from .schema import (
     NetBoxDNSViewQuery,
     NetBoxDNSNameServerQuery,
-    NetBoxDNSContactQuery,
+    NetBoxDNSRegistrationContactQuery,
     NetBoxDNSRegistrarQuery,
     NetBoxDNSZoneQuery,
     NetBoxDNSRecordQuery,
@@ -14,7 +14,7 @@ schema = [
     NetBoxDNSViewQuery,
     NetBoxDNSZoneQuery,
     NetBoxDNSRecordQuery,
-    NetBoxDNSContactQuery,
+    NetBoxDNSRegistrationContactQuery,
     NetBoxDNSRegistrarQuery,
     NetBoxDNSZoneTemplateQuery,
     NetBoxDNSRecordTemplateQuery,

netbox_dns/graphql/filters.py

@@ -7,7 +7,7 @@ from netbox_dns.models import (
     View,
     Zone,
     Record,
-    Contact,
+    RegistrationContact,
     Registrar,
     ZoneTemplate,
     RecordTemplate,
@@ -17,7 +17,7 @@ from netbox_dns.filtersets import (
     ViewFilterSet,
     ZoneFilterSet,
     RecordFilterSet,
-    ContactFilterSet,
+    RegistrationContactFilterSet,
     RegistrarFilterSet,
     ZoneTemplateFilterSet,
     RecordTemplateFilterSet,
@@ -60,9 +60,9 @@ class NetBoxDNSRecordTemplateFilter(BaseFilterMixin):
     pass
 
 
-@strawberry_django.filter(Contact, lookups=True)
-@autotype_decorator(ContactFilterSet)
-class NetBoxDNSContactFilter(BaseFilterMixin):
+@strawberry_django.filter(RegistrationContact, lookups=True)
+@autotype_decorator(RegistrationContactFilterSet)
+class NetBoxDNSRegistrationContactFilter(BaseFilterMixin):
     pass