netbox-plugin-dns 1.0.7__py3-none-any.whl → 1.1.0b1__py3-none-any.whl

netbox_dns/__init__.py

@@ -1,13 +1,18 @@
+from django.conf import settings
+
 from netbox.plugins import PluginConfig
+from ipam.choices import IPAddressStatusChoices
+
+from netbox_dns.choices import RecordTypeChoices
 
-__version__ = "1.0.7"
+__version__ = "1.1.0-beta1"
 
 
 class DNSConfig(PluginConfig):
     name = "netbox_dns"
     verbose_name = "NetBox DNS"
     description = "NetBox plugin for DNS data"
-    min_version = "4.0.0"
+    min_version = "4.1.0-beta1"
     version = __version__
     author = "Peter Eckel"
     author_email = "pete@netbox-dns.org"
@@ -20,13 +25,18 @@ class DNSConfig(PluginConfig):
         "zone_soa_retry": 7200,
         "zone_soa_expire": 2419200,
         "zone_soa_minimum": 3600,
-        "feature_ipam_coupling": False,
+        "autodns_disabled": False,
+        "autodns_ipaddress_active_status": [
+            IPAddressStatusChoices.STATUS_ACTIVE,
+            IPAddressStatusChoices.STATUS_DHCP,
+            IPAddressStatusChoices.STATUS_SLAAC,
+        ],
         "tolerate_characters_in_zone_labels": "",
         "tolerate_underscores_in_labels": False,
         "tolerate_underscores_in_hostnames": False,  # Deprecated, will be removed in 1.2.0
         "tolerate_leading_underscore_types": [
-            "TXT",
-            "SRV",
+            RecordTypeChoices.TXT,
+            RecordTypeChoices.SRV,
         ],
         "tolerate_non_rfc1035_types": [],
         "enable_root_zones": False,
@@ -37,6 +47,12 @@ class DNSConfig(PluginConfig):
     }
     base_url = "netbox-dns"
 
+    def ready(self):
+        super().ready()
+
+        if not settings.PLUGINS_CONFIG["netbox_dns"].get("autodns_disabled"):
+            from netbox_dns.signals import ipam_autodns
+
 
 #
 # Initialize plugin config

netbox_dns/api/nested_serializers.py

@@ -59,22 +59,6 @@ class NestedZoneSerializer(WritableNestedSerializer):
         ]
 
 
-class NestedZoneTemplateSerializer(WritableNestedSerializer):
-    url = serializers.HyperlinkedIdentityField(
-        view_name="plugins-api:netbox_dns-api:zonetemplate-detail"
-    )
-
-    class Meta:
-        model = ZoneTemplate
-        fields = (
-            "id",
-            "url",
-            "name",
-            "display",
-            "description",
-        )
-
-
 class NestedRecordSerializer(WritableNestedSerializer):
     url = serializers.HyperlinkedIdentityField(
         view_name="plugins-api:netbox_dns-api:record-detail"
@@ -102,7 +86,6 @@ class NestedRecordSerializer(WritableNestedSerializer):
             "status",
             "ttl",
             "zone",
-            "managed",
             "active",
         ]
 
@@ -126,3 +109,19 @@ class NestedRecordTemplateSerializer(WritableNestedSerializer):
             "ttl",
             "description",
         )
+
+
+class NestedZoneTemplateSerializer(WritableNestedSerializer):
+    url = serializers.HyperlinkedIdentityField(
+        view_name="plugins-api:netbox_dns-api:zonetemplate-detail"
+    )
+
+    class Meta:
+        model = ZoneTemplate
+        fields = (
+            "id",
+            "url",
+            "name",
+            "display",
+            "description",
+        )

netbox_dns/api/serializers.py

@@ -6,5 +6,6 @@ from .serializers_.view import *
 from .serializers_.zone import *
 from .serializers_.zone_template import *
 from .serializers_.record_template import *
+from .serializers_.prefix import *
 
 from .nested_serializers import *

netbox_dns/api/serializers_/prefix.py

@@ -0,0 +1,18 @@
+from rest_framework.serializers import HyperlinkedIdentityField
+
+from ipam.api.serializers import PrefixSerializer as IPAMPrefixSerializer
+
+
+__all__ = ("PrefixSerializer",)
+
+
+class PrefixSerializer(IPAMPrefixSerializer):
+    url = HyperlinkedIdentityField(view_name="plugins-api:netbox_dns-api:prefix-detail")
+
+    def to_representation(self, instance):
+        representation = super().to_representation(instance)
+
+        if instance.vrf is not None:
+            representation["display"] += f" [{instance.vrf.name}]"
+
+        return representation

netbox_dns/api/serializers_/record.py

@@ -87,6 +87,5 @@ class RecordSerializer(NetBoxModelSerializer):
             "status",
             "ttl",
             "description",
-            "managed",
             "active",
         )

netbox_dns/api/serializers_/view.py

@@ -1,7 +1,8 @@
 from rest_framework import serializers
 
 from netbox.api.serializers import NetBoxModelSerializer
-from tenancy.api.serializers_.tenants import TenantSerializer
+from tenancy.api.serializers import TenantSerializer
+from ipam.api.serializers import PrefixSerializer
 
 from netbox_dns.models import View
 
@@ -16,8 +17,38 @@ class ViewSerializer(NetBoxModelSerializer):
     default_view = serializers.BooleanField(
         read_only=True,
     )
+    prefixes = PrefixSerializer(
+        many=True,
+        nested=True,
+        read_only=False,
+        required=False,
+        help_text="IPAM Prefixes assigned to the View",
+    )
+    tenant = TenantSerializer(
+        nested=True,
+        required=False,
+        allow_null=True,
+    )
+
+    def create(self, validated_data):
+        prefixes = validated_data.pop("prefixes", None)
+
+        view = super().create(validated_data)
+
+        if prefixes is not None:
+            view.prefixes.set(prefixes)
+
+        return view
+
+    def update(self, instance, validated_data):
+        prefixes = validated_data.pop("prefixes", None)
+
+        view = super().update(instance, validated_data)
+
+        if prefixes is not None:
+            view.prefixes.set(prefixes)
 
-    tenant = TenantSerializer(nested=True, required=False, allow_null=True)
+        return view
 
     class Meta:
         model = View
@@ -33,5 +64,6 @@ class ViewSerializer(NetBoxModelSerializer):
             "last_updated",
             "custom_fields",
             "tenant",
+            "prefixes",
         )
         brief_fields = ("id", "url", "display", "name", "default_view", "description")

netbox_dns/api/urls.py

@@ -10,6 +10,7 @@ from netbox_dns.api.views import (
     ContactViewSet,
     ZoneTemplateViewSet,
     RecordTemplateViewSet,
+    PrefixViewSet,
 )
 
 router = NetBoxRouter()
@@ -24,4 +25,6 @@ router.register("contacts", ContactViewSet)
 router.register("zonetemplates", ZoneTemplateViewSet)
 router.register("recordtemplates", RecordTemplateViewSet)
 
+router.register("prefixes", PrefixViewSet)
+
 urlpatterns = router.urls

netbox_dns/api/views.py

@@ -1,6 +1,10 @@
 from rest_framework import serializers
+from rest_framework.decorators import action
+from rest_framework.response import Response
 from rest_framework.routers import APIRootView
 
+from ipam.models import Prefix
+
 from netbox.api.viewsets import NetBoxModelViewSet
 
 from netbox_dns.api.serializers import (
@@ -12,6 +16,7 @@ from netbox_dns.api.serializers import (
     ContactSerializer,
     ZoneTemplateSerializer,
     RecordTemplateSerializer,
+    PrefixSerializer,
 )
 from netbox_dns.filtersets import (
     ViewFilterSet,
@@ -45,6 +50,12 @@ class ViewViewSet(NetBoxModelViewSet):
     serializer_class = ViewSerializer
     filterset_class = ViewFilterSet
 
+    @action(detail=True, methods=["get"])
+    def views(self, request, pk=None):
+        views = View.objects.filter(zone=pk)
+        serializer = ViewSerializer(views, many=True, context={"request": request})
+        return Response(serializer.data)
+
 
 class ZoneViewSet(NetBoxModelViewSet):
     queryset = Zone.objects.prefetch_related(
@@ -58,12 +69,32 @@ class ZoneViewSet(NetBoxModelViewSet):
     serializer_class = ZoneSerializer
     filterset_class = ZoneFilterSet
 
+    @action(detail=True, methods=["get"])
+    def records(self, request, pk=None):
+        records = Record.objects.filter(zone=pk)
+        serializer = RecordSerializer(records, many=True, context={"request": request})
+        return Response(serializer.data)
+
+    @action(detail=True, methods=["get"])
+    def nameservers(self, request, pk=None):
+        nameservers = NameServer.objects.filter(zones__id=pk)
+        serializer = NameServerSerializer(
+            nameservers, many=True, context={"request": request}
+        )
+        return Response(serializer.data)
+
 
 class NameServerViewSet(NetBoxModelViewSet):
     queryset = NameServer.objects.prefetch_related("zones", "tenant")
     serializer_class = NameServerSerializer
     filterset_class = NameServerFilterSet
 
+    @action(detail=True, methods=["get"])
+    def zones(self, request, pk=None):
+        zones = Zone.objects.filter(nameservers__id=pk)
+        serializer = ZoneSerializer(zones, many=True, context={"request": request})
+        return Response(serializer.data)
+
 
 class RecordViewSet(NetBoxModelViewSet):
     queryset = Record.objects.all().prefetch_related("zone", "zone__view", "tenant")
@@ -124,3 +155,8 @@ class RecordTemplateViewSet(NetBoxModelViewSet):
     queryset = RecordTemplate.objects.all()
     serializer_class = RecordTemplateSerializer
     filterset_class = RecordTemplateFilterSet
+
+
+class PrefixViewSet(NetBoxModelViewSet):
+    queryset = Prefix.objects.all()
+    serializer_class = PrefixSerializer

netbox_dns/fields/__init__.py

@@ -1,3 +1,4 @@
 from .network import *
 from .address import *
 from .rfc2317 import *
+from .ipam import *

netbox_dns/fields/ipam.py

@@ -0,0 +1,18 @@
+from utilities.forms.fields import DynamicModelMultipleChoiceField
+from utilities.forms.widgets import APISelectMultiple
+
+
+__all__ = ("PrefixDynamicModelMultipleChoiceField",)
+
+
+class PrefixDynamicModelMultipleChoiceField(DynamicModelMultipleChoiceField):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+    widget = APISelectMultiple(api_url="/api/plugins/netbox-dns/prefixes")
+
+    def label_from_instance(self, obj):
+        if obj.vrf:
+            return f"{str(obj.prefix)} [{obj.vrf.name}]"
+
+        return str(obj.prefix)

netbox_dns/filtersets/record.py

@@ -121,7 +121,7 @@ class RecordFilterSet(TenancyFilterSet, NetBoxModelFilterSet):
         if not value.strip():
             return queryset
         qs_filter = (
-            Q(fqdn__icontains=value)
+            Q(name__icontains=value)
             | Q(value__icontains=value)
             | Q(zone__name__icontains=value)
         )

netbox_dns/filtersets/view.py

@@ -1,7 +1,10 @@
+import django_filters
+
 from django.db.models import Q
 
 from netbox.filtersets import NetBoxModelFilterSet
 from tenancy.filtersets import TenancyFilterSet
+from ipam.models import Prefix
 
 from netbox_dns.models import View
 
@@ -10,6 +13,19 @@ __all__ = ("ViewFilterSet",)
 
 
 class ViewFilterSet(NetBoxModelFilterSet, TenancyFilterSet):
+    prefix_id = django_filters.ModelMultipleChoiceFilter(
+        queryset=Prefix.objects.all(),
+        field_name="prefixes",
+        to_field_name="id",
+        label="Prefixes ID",
+    )
+    prefix = django_filters.ModelMultipleChoiceFilter(
+        queryset=Prefix.objects.all(),
+        field_name="prefixes__prefix",
+        to_field_name="prefix",
+        label="Prefix",
+    )
+
     class Meta:
         model = View
         fields = ("id", "name", "default_view", "description")

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,23 @@ 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_dns.models import View
+from netbox_dns.fields import PrefixDynamicModelMultipleChoiceField
+from netbox_dns.utilities import (
+    get_ip_addresses_by_prefix,
+    update_dns_records,
+    get_views_by_prefix,
+)
 
 
 __all__ = (
@@ -27,22 +39,102 @@ __all__ = (
 )
 
 
-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:
+                    update_dns_records(ip_address, commit=False, 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:
+                return
+
+            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:
+                        update_dns_records(ip_address, commit=False, 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("autodns_disabled"):
+            del self.fields["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("autodns_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 +148,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("autodns_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 +181,7 @@ class ViewImportForm(NetBoxModelImportForm):
 
     class Meta:
         model = View
-        fields = ("name", "description", "tenant", "tags")
+        fields = ("name", "description", "prefixes", "tenant", "tags")
 
 
 class ViewBulkEditForm(NetBoxModelBulkEditForm):

netbox_dns/forms/zone.py

@@ -81,14 +81,6 @@ class ZoneTemplateUpdateMixin:
                 else:
                     zone_data = self.cleaned_data.copy()
 
-                    custom_fields = dict()
-                    for key, value in zone_data.copy().items():
-                        if key.startswith("cf_"):
-                            custom_fields[key[3:]] = value
-                            zone_data.pop(key)
-                    if custom_fields:
-                        zone_data["custom_field_data"] = custom_fields
-
                     zone_data.pop("template", None)
                     zone_data.pop("tenant_group", None)
                     zone_data.pop("_init_time", None)

netbox_dns/graphql/schema.py

@@ -25,55 +25,79 @@ from .types import (
 )
 
 
-@strawberry.type(name="Query")
+@strawberry.type
 class NetBoxDNSNameServerQuery:
-    netbox_dns_nameserver: NetBoxDNSNameServerType = strawberry_django.field()
+    @strawberry.field
+    def netbox_dns_nameserver(self, id: int) -> NetBoxDNSNameServerType:
+        return NameServer.objects.get(pk=id)
+
     netbox_dns_nameserver_list: List[NetBoxDNSNameServerType] = (
         strawberry_django.field()
     )
 
 
-@strawberry.type(name="Query")
+@strawberry.type
 class NetBoxDNSViewQuery:
-    netbox_dns_view: NetBoxDNSViewType = strawberry_django.field()
+    @strawberry.field
+    def netbox_dns_view(self, id: int) -> NetBoxDNSViewType:
+        return View.objects.get(pk=id)
+
     netbox_dns_view_list: List[NetBoxDNSViewType] = strawberry_django.field()
 
 
-@strawberry.type(name="Query")
+@strawberry.type
 class NetBoxDNSZoneQuery:
-    netbox_dns_zone: NetBoxDNSZoneType = strawberry_django.field()
+    @strawberry.field
+    def netbox_dns_zone(self, id: int) -> NetBoxDNSZoneType:
+        return Zone.objects.get(pk=id)
+
     netbox_dns_zone_list: List[NetBoxDNSZoneType] = strawberry_django.field()
 
 
-@strawberry.type(name="Query")
+@strawberry.type
 class NetBoxDNSRecordQuery:
-    netbox_dns_record: NetBoxDNSRecordType = strawberry_django.field()
+    @strawberry.field
+    def netbox_dns_record(self, id: int) -> NetBoxDNSRecordType:
+        return Record.objects.get(pk=id)
+
     netbox_dns_record_list: List[NetBoxDNSRecordType] = strawberry_django.field()
 
 
-@strawberry.type(name="Query")
+@strawberry.type
 class NetBoxDNSContactQuery:
-    netbox_dns_contact: NetBoxDNSContactType = strawberry_django.field()
+    @strawberry.field
+    def netbox_dns_contact(self, id: int) -> NetBoxDNSContactType:
+        return Contact.objects.get(pk=id)
+
     netbox_dns_contact_list: List[NetBoxDNSContactType] = strawberry_django.field()
 
 
-@strawberry.type(name="Query")
+@strawberry.type
 class NetBoxDNSRegistrarQuery:
-    netbox_dns_registrar: NetBoxDNSRegistrarType = strawberry_django.field()
+    @strawberry.field
+    def netbox_dns_registrar(self, id: int) -> NetBoxDNSRegistrarType:
+        return Registrar.objects.get(pk=id)
+
     netbox_dns_registrar_list: List[NetBoxDNSRegistrarType] = strawberry_django.field()
 
 
-@strawberry.type(name="Query")
+@strawberry.type
 class NetBoxDNSZoneTemplateQuery:
-    netbox_dns_zone_template: NetBoxDNSZoneTemplateType = strawberry_django.field()
+    @strawberry.field
+    def netbox_dns_zone_template(self, id: int) -> NetBoxDNSZoneTemplateType:
+        return ZoneTemplate.objects.get(pk=id)
+
     netbox_dns_zone_template_list: List[NetBoxDNSZoneTemplateType] = (
         strawberry_django.field()
     )
 
 
-@strawberry.type(name="Query")
+@strawberry.type
 class NetBoxDNSRecordTemplateQuery:
-    netbox_dns_record_template: NetBoxDNSRecordTemplateType = strawberry_django.field()
+    @strawberry.field
+    def netbox_dns_record_template(self, id: int) -> NetBoxDNSRecordTemplateType:
+        return RecordTemplate.objects.get(pk=id)
+
     netbox_dns_record_template_list: List[NetBoxDNSRecordTemplateType] = (
         strawberry_django.field()
     )

netbox_dns/graphql/types.py

@@ -40,6 +40,7 @@ class NetBoxDNSViewType(NetBoxObjectType):
     name: str
     description: str
     tenant: Annotated["TenantType", strawberry.lazy("tenancy.graphql.types")] | None
+    prefixes: List[Annotated["PrefixType", strawberry.lazy("ipam.graphql.types")]]
 
 
 @strawberry_django.type(Zone, fields="__all__", filters=NetBoxDNSZoneFilter)