netbox-plugin-dns 1.1.1__tar.gz → 1.1.2__tar.gz

{netbox_plugin_dns-1.1.1/netbox_plugin_dns.egg-info → netbox_plugin_dns-1.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: netbox-plugin-dns
-Version: 1.1.1
+Version: 1.1.2
 Summary: NetBox DNS is a NetBox plugin for managing DNS data.
 Author-email: Peter Eckel <pete@netbox-dns.org>
 Project-URL: Homepage, https://github.com/peteeckel/netbox-plugin-dns

{netbox_plugin_dns-1.1.1 → netbox_plugin_dns-1.1.2}/netbox_dns/__init__.py

@@ -5,7 +5,7 @@ from ipam.choices import IPAddressStatusChoices
 
 from netbox_dns.choices import RecordTypeChoices
 
-__version__ = "1.1.1"
+__version__ = "1.1.2"
 
 
 class DNSConfig(PluginConfig):
@@ -37,8 +37,9 @@ class DNSConfig(PluginConfig):
         "tolerate_underscores_in_labels": False,
         "tolerate_underscores_in_hostnames": False,  # Deprecated, will be removed in 1.2.0
         "tolerate_leading_underscore_types": [
-            RecordTypeChoices.TXT,
             RecordTypeChoices.SRV,
+            RecordTypeChoices.TLSA,
+            RecordTypeChoices.TXT,
         ],
         "tolerate_non_rfc1035_types": [],
         "enable_root_zones": False,

{netbox_plugin_dns-1.1.1 → netbox_plugin_dns-1.1.2}/netbox_dns/api/serializers_/view.py

@@ -65,5 +65,6 @@ class ViewSerializer(NetBoxModelSerializer):
             "custom_fields",
             "tenant",
             "prefixes",
+            "ip_address_filter",
         )
         brief_fields = ("id", "url", "display", "name", "default_view", "description")

{netbox_plugin_dns-1.1.1 → netbox_plugin_dns-1.1.2}/netbox_dns/forms/view.py

@@ -1,6 +1,6 @@
 from django import forms
 from django.conf import settings
-from django.core.exceptions import ValidationError
+from django.core.exceptions import ValidationError, FieldError
 from django.db.models import Q, Count
 
 from netbox.forms import (
@@ -18,9 +18,10 @@ from utilities.forms.fields import (
 )
 from utilities.forms import BOOLEAN_WITH_BLANK_CHOICES
 from utilities.forms.rendering import FieldSet
+from utilities.forms.fields import JSONField
 from tenancy.models import Tenant
 from tenancy.forms import TenancyForm, TenancyFilterForm
-from ipam.models import Prefix
+from ipam.models import Prefix, IPAddress
 from netbox.context import current_request
 
 from netbox_dns.models import View
@@ -29,6 +30,7 @@ from netbox_dns.utilities import (
     check_dns_records,
     get_ip_addresses_by_prefix,
     get_views_by_prefix,
+    get_query_from_filter,
 )
 
 
@@ -45,7 +47,7 @@ class ViewPrefixUpdateMixin:
     def clean(self, *args, **kwargs):
         super().clean(*args, **kwargs)
 
-        if self.instance.pk is None or "prefixes" not in self.changed_data:
+        if self.instance._state.adding or "prefixes" not in self.changed_data:
             return
 
         prefixes = self.cleaned_data.get("prefixes")
@@ -97,6 +99,7 @@ class ViewForm(ViewPrefixUpdateMixin, TenancyForm, NetBoxModelForm):
 
         if settings.PLUGINS_CONFIG["netbox_dns"].get("dnssync_disabled"):
             del self.fields["prefixes"]
+            del self.fields["ip_address_filter"]
 
         if request := current_request.get():
             if not request.user.has_perm("ipam.view_prefix"):
@@ -107,12 +110,6 @@ class ViewForm(ViewPrefixUpdateMixin, TenancyForm, NetBoxModelForm):
                     "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,
@@ -121,10 +118,15 @@ class ViewForm(ViewPrefixUpdateMixin, TenancyForm, NetBoxModelForm):
             "depth": None,
         },
     )
+    ip_address_filter = JSONField(
+        label="IP Address Filter",
+        required=False,
+        help_text="Specify criteria for address record creation in JSON form",
+    )
 
     fieldsets = (
         FieldSet("name", "default_view", "description", "tags", name="View"),
-        FieldSet("prefixes"),
+        FieldSet("prefixes", "ip_address_filter"),
         FieldSet("tenant_group", "tenant", name="Tenancy"),
     )
 
@@ -137,8 +139,25 @@ class ViewForm(ViewPrefixUpdateMixin, TenancyForm, NetBoxModelForm):
             "tags",
             "tenant",
             "prefixes",
+            "ip_address_filter",
         )
 
+    def clean_prefixes(self):
+        if hasattr(self, "_saved_prefixes"):
+            return self._saved_prefixes
+
+        return self.cleaned_data["prefixes"]
+
+    def clean_ip_address_filter(self):
+        ip_address_filter = self.cleaned_data.get("ip_address_filter")
+
+        try:
+            IPAddress.objects.filter(get_query_from_filter(ip_address_filter)).exists()
+        except (FieldError, ValueError) as exc:
+            self.add_error("ip_address_filter", f"Invalid filter for IPAddress: {exc}")
+
+        return ip_address_filter
+
 
 class ViewFilterForm(TenancyFilterForm, NetBoxModelFilterSetForm):
     def __init__(self, *args, **kwargs):

{netbox_plugin_dns-1.1.1 → netbox_plugin_dns-1.1.2}/netbox_dns/graphql/schema.py

@@ -3,16 +3,6 @@ from typing import List
 import strawberry
 import strawberry_django
 
-from netbox_dns.models import (
-    NameServer,
-    View,
-    Zone,
-    Record,
-    RegistrationContact,
-    Registrar,
-    ZoneTemplate,
-    RecordTemplate,
-)
 from .types import (
     NetBoxDNSNameServerType,
     NetBoxDNSViewType,

{netbox_plugin_dns-1.1.1 → netbox_plugin_dns-1.1.2}/netbox_dns/graphql/types.py

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

netbox_plugin_dns-1.1.2/netbox_dns/migrations/0010_view_ip_address_filter.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.0.9 on 2024-09-18 13:12
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("netbox_dns", "0009_rename_contact_registrationcontact"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="view",
+            name="ip_address_filter",
+            field=models.JSONField(blank=True, null=True),
+        ),
+    ]

netbox_plugin_dns-1.1.2/netbox_dns/mixins/object_modification.py

@@ -0,0 +1,53 @@
+from netbox.models import NetBoxModel
+
+
+__all__ = ("ObjectModificationMixin",)
+
+
+class ObjectModificationMixin:
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        if not hasattr(self.__class__, "check_fields"):
+            self.__class__.check_fields = (
+                {field.name for field in self._meta.fields}
+                - {field.name for field in NetBoxModel._meta.fields}
+                - {"id"}
+            )
+
+            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._state.adding:
+            return None
+
+        _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_plugin_dns-1.1.1 → netbox_plugin_dns-1.1.2}/netbox_dns/models/record.py

@@ -10,13 +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
@@ -41,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 = {
@@ -473,22 +488,29 @@ class Record(ObjectModificationMixin, ContactsMixin, 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):
@@ -585,7 +607,7 @@ class Record(ObjectModificationMixin, ContactsMixin, 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():
@@ -624,7 +646,7 @@ class Record(ObjectModificationMixin, ContactsMixin, 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):
@@ -663,7 +685,7 @@ class Record(ObjectModificationMixin, ContactsMixin, 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):
@@ -699,7 +721,7 @@ class Record(ObjectModificationMixin, ContactsMixin, 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:
@@ -787,7 +809,7 @@ class Record(ObjectModificationMixin, ContactsMixin, 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_plugin_dns-1.1.1 → netbox_plugin_dns-1.1.2}/netbox_dns/models/view.py

@@ -9,6 +9,13 @@ 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__ = (
@@ -34,6 +41,11 @@ class View(ObjectModificationMixin, ContactsMixin, 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,
@@ -87,6 +99,21 @@ class View(ObjectModificationMixin, ContactsMixin, 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):
@@ -106,6 +133,19 @@ class View(ObjectModificationMixin, ContactsMixin, 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_plugin_dns-1.1.1 → netbox_plugin_dns-1.1.2}/netbox_dns/models/zone.py

@@ -649,14 +649,16 @@ class Zone(ObjectModificationMixin, ContactsMixin, 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)
-            elif not old_zone.soa_serial_auto:
+                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(
@@ -665,10 +667,13 @@ class Zone(ObjectModificationMixin, ContactsMixin, 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_plugin_dns-1.1.1 → netbox_plugin_dns-1.1.2}/netbox_dns/signals/ipam_dnssync.py

@@ -52,7 +52,7 @@ def ipam_dnssync_ipaddress_post_clean(instance, **kwargs):
         dns_name=instance.dns_name,
         status__in=IPADDRESS_ACTIVE_STATUS,
     )
-    if instance.pk is not None:
+    if not instance._state.adding:
         duplicate_addresses = duplicate_addresses.exclude(pk=instance.pk)
 
     if ENFORCE_UNIQUE_RECORDS and instance.status in IPADDRESS_ACTIVE_STATUS:
@@ -74,7 +74,7 @@ def ipam_dnssync_ipaddress_post_clean(instance, **kwargs):
     if (request := current_request.get()) is not None:
         cf_data = instance.custom_field_data
         if (
-            instance.pk is not None
+            not instance._state.adding
             and any(
                 (
                     cf_data.get(cf, cf_default)
@@ -86,7 +86,7 @@ def ipam_dnssync_ipaddress_post_clean(instance, **kwargs):
             )
             and not check_record_permission()
         ) or (
-            instance.pk is None
+            instance._state.adding
             and any(
                 (
                     cf_data.get(cf, cf_default) != cf_default
@@ -129,7 +129,7 @@ def ipam_dnssync_prefix_pre_save(instance, **kwargs):
     """
     request = current_request.get()
 
-    if instance.pk is None or not instance.netbox_dns_views.exists():
+    if instance._state.adding or not instance.netbox_dns_views.exists():
         return
 
     saved_prefix = Prefix.objects.prefetch_related("netbox_dns_views").get(

{netbox_plugin_dns-1.1.1 → netbox_plugin_dns-1.1.2}/netbox_dns/tables/view.py

@@ -23,7 +23,7 @@ class ViewTable(TenancyColumnsMixin, NetBoxTable):
 
     class Meta(NetBoxTable.Meta):
         model = View
-        fields = ("description",)
+        fields = ("description", "ip_address_filter")
         default_columns = ("name", "default_view")
 
 

{netbox_plugin_dns-1.1.1 → netbox_plugin_dns-1.1.2}/netbox_dns/templates/netbox_dns/view.html

@@ -42,6 +42,7 @@
                 </h5>
                 <div class="card-body">
                     <table class="table table-hover attr-table">
+                        {% if object.prefixes.exists %}
                         {% for prefix in object.prefixes.all %}
                         <tr>
                             <td>
@@ -56,9 +57,24 @@
                             {% endif %}
                         </tr>
                         {% endfor %}
+                        {% else %}
+                            <span class="text-muted">No prefixes assigned</span>
+                        {% endif %}
                     </table>
                 </div>
             </div>
+            <div class="card">
+                <h5 class="card-header">
+                    IP Address Filters
+                </h5>
+                <div class="card-body">
+                    {% if object.ip_address_filter %}
+                        <pre>{{ object.ip_address_filter|json }}</pre>
+                    {% else %}
+                        <span class="text-muted">No filters defined</span>
+                    {% endif %}
+                </div>
+            </div>
             {% endif %}
         </div>
     </div>