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

netbox_dns/signals/ipam_autodns.py

@@ -0,0 +1,138 @@
+from netaddr import IPNetwork
+
+from django.dispatch import receiver
+from django.db.models.signals import pre_delete, pre_save, post_save, m2m_changed
+from django.core.exceptions import ValidationError
+
+from netbox.context import current_request
+from netbox.signals import post_clean
+from ipam.models import IPAddress, Prefix
+from utilities.exceptions import AbortRequest
+
+from netbox_dns.models import view as _view
+from netbox_dns.utilities import (
+    update_dns_records,
+    delete_dns_records,
+    get_views_by_prefix,
+    get_ip_addresses_by_prefix,
+    get_ip_addresses_by_view,
+)
+
+
+@receiver(post_clean, sender=IPAddress)
+def ipam_autodns_ipaddress_post_clean(instance, **kwargs):
+    if not isinstance(instance.address, IPNetwork):
+        return
+
+    try:
+        update_dns_records(instance, commit=False)
+    except ValidationError as exc:
+        if hasattr(exc, "error_dict"):
+            for field in ("name", "ttl", "value", "type"):
+                value = exc.error_dict.pop(field, None)
+                if value is not None:
+                    raise ValidationError({"dns_name": value})
+
+        raise exc
+
+
+@receiver(pre_delete, sender=IPAddress)
+def ipam_autodns_ipaddress_pre_delete(instance, **kwargs):
+    delete_dns_records(instance)
+
+
+@receiver(pre_save, sender=IPAddress)
+def ipam_autodns_ipaddress_post_save(instance, **kwargs):
+    update_dns_records(instance, commit=False)
+
+
+@receiver(post_save, sender=IPAddress)
+def ipam_autodns_ipaddress_post_save(instance, **kwargs):
+    update_dns_records(instance)
+
+
+@receiver(pre_save, sender=Prefix)
+def ipam_autodns_prefix_pre_save(instance, **kwargs):
+    """
+    Changes that modify the prefix hierarchy cannot be validated properly before
+    commiting them. So the solution in this case is to remove a prefix whose
+    VRF or network has changed from all views it currently is assigned to.
+    """
+    if instance.pk is None or not instance.netbox_dns_views.exists():
+        return
+
+    saved_prefix = Prefix.objects.get(pk=instance.pk)
+    if saved_prefix.prefix != instance.prefix or saved_prefix.vrf != instance.vrf:
+        for view in saved_prefix.netbox_dns_views.all():
+            view.prefixes.remove(saved_prefix)
+
+
+@receiver(pre_delete, sender=Prefix)
+def ipam_autodns_prefix_pre_delete(instance, **kwargs):
+    parent = instance.get_parents().last()
+    request = current_request.get()
+
+    if parent is not None and get_views_by_prefix(instance) != get_views_by_prefix(
+        parent
+    ):
+        try:
+            for prefix in instance.get_children().filter(
+                _depth=instance.depth + 1, netbox_dns_views__isnull=True
+            ):
+                for ip_address in get_ip_addresses_by_prefix(prefix):
+                    update_dns_records(ip_address, commit=False)
+        except ValidationError as exc:
+            if request is not None:
+                raise AbortRequest(
+                    f"Prefix deletion would cause DNS errors: {exc.messages[0]} "
+                    "Please review DNS View assignments for this and the parent prefix"
+                )
+            else:
+                raise exc
+
+    # +
+    # CAUTION: This only works because the NetBox workaround for an ancient
+    # Django bug (see https://code.djangoproject.com/ticket/17688) has already
+    # removed the relations between the prefix and the views when this signal
+    # handler runs.
+    #
+    # Should anything be fixed, this code will stop working and need to be
+    # revisited.
+    #
+    # The NetBox workaround only works for requests, not for model level
+    # operations. The following code replicates it for non-requests.
+    # -
+    if request is None:
+        for view in instance.netbox_dns_views.all():
+            view.snapshot()
+            view.prefixes.remove(instance)
+
+    for ip_address in get_ip_addresses_by_prefix(instance):
+        update_dns_records(ip_address)
+
+
+@receiver(m2m_changed, sender=_view.View.prefixes.through)
+def ipam_autodns_view_prefix_changed(**kwargs):
+    action = kwargs.get("action")
+    request = current_request.get()
+
+    # +
+    # Handle all post_add and post_remove signals except the ones directly
+    # handled by the pre_delete handler for the Prefix model.
+    #
+    # Yes. This IS ugly.
+    # -
+    if action not in ("post_add", "post_remove") or (
+        request is not None
+        and action == "post_remove"
+        and (
+            request.path.startswith("/ipam/prefixes/")
+            or request.path.startswith("/api/ipam/prefixes/")
+        )
+    ):
+        return
+
+    check_view = action != "post_remove"
+    for prefix in Prefix.objects.filter(pk__in=kwargs.get("pk_set")):
+        for ip_address in get_ip_addresses_by_prefix(prefix, check_view=check_view):
+            update_dns_records(ip_address)

netbox_dns/tables/contact.py

@@ -19,6 +19,7 @@ class ContactTable(NetBoxTable):
     class Meta(NetBoxTable.Meta):
         model = Contact
         fields = (
+            "contact_id",
             "name",
             "description",
             "organization",

netbox_dns/tables/nameserver.py

@@ -22,7 +22,13 @@ class NameServerTable(TenancyColumnsMixin, NetBoxTable):
 
     class Meta(NetBoxTable.Meta):
         model = NameServer
-        fields = ("description",)
+        fields = (
+            "name",
+            "description",
+            "tags",
+            "tenant",
+            "tenant_group",
+        )
         default_columns = (
             "name",
             "tags",

netbox_dns/tables/record.py

@@ -23,18 +23,10 @@ class RecordBaseTable(TenancyColumnsMixin, NetBoxTable):
     zone = tables.Column(
         linkify=True,
     )
-    view = tables.Column(
-        accessor="zone__view",
-        linkify=True,
-    )
     type = tables.Column()
     name = tables.Column(
         linkify=True,
     )
-    fqdn = tables.Column(
-        verbose_name="FQDN",
-        linkify=True,
-    )
     value = tables.TemplateColumn(
         template_code="{{ value|truncatechars:64 }}",
     )
@@ -73,8 +65,20 @@ class RecordTable(RecordBaseTable):
     class Meta(NetBoxTable.Meta):
         model = Record
         fields = (
+            "name",
+            "zone",
+            "ttl",
+            "type",
+            "value",
+            "unicode_value",
             "status",
+            "disable_ptr",
+            "ptr_record",
+            "tags",
+            "active",
             "description",
+            "tenant",
+            "tenant_group",
         )
         default_columns = (
             "name",
@@ -100,7 +104,17 @@ class ManagedRecordTable(RecordBaseTable):
 
     class Meta(NetBoxTable.Meta):
         model = Record
-        fields = ()
+        fields = (
+            "name",
+            "zone",
+            "ttl",
+            "type",
+            "value",
+            "unicode_value",
+            "address_record",
+            "ipam_ip_address",
+            "active",
+        )
         default_columns = (
             "name",
             "zone",
@@ -116,7 +130,13 @@ class RelatedRecordTable(RecordBaseTable):
 
     class Meta(NetBoxTable.Meta):
         model = Record
-        fields = ()
+        fields = (
+            "name",
+            "zone",
+            "type",
+            "value",
+            "unicode_value",
+        )
         default_columns = (
             "name",
             "zone",

netbox_dns/tables/record_template.py

@@ -43,8 +43,18 @@ class RecordTemplateTable(TenancyColumnsMixin, NetBoxTable):
     class Meta(NetBoxTable.Meta):
         model = RecordTemplate
         fields = (
+            "name",
+            "record_name",
+            "ttl",
+            "type",
+            "value",
+            "unicode_value",
             "status",
+            "disable_ptr",
+            "tags",
             "description",
+            "tenant",
+            "tenant_group",
         )
         default_columns = (
             "name",
@@ -62,7 +72,14 @@ class RecordTemplateDisplayTable(RecordTemplateTable):
     class Meta(NetBoxTable.Meta):
         model = RecordTemplate
         fields = (
+            "name",
+            "record_name",
+            "ttl",
+            "type",
+            "value",
+            "unicode_value",
             "status",
+            "disable_ptr",
             "description",
         )
         default_columns = (

netbox_dns/tables/registrar.py

@@ -19,11 +19,13 @@ class RegistrarTable(NetBoxTable):
     class Meta(NetBoxTable.Meta):
         model = Registrar
         fields = (
+            "name",
             "description",
             "iana_id",
             "referral_url",
             "whois_server",
             "abuse_email",
             "abuse_phone",
+            "tags",
         )
         default_columns = ("name", "iana_id", "referral_url")

netbox_dns/tables/view.py

@@ -1,12 +1,15 @@
 import django_tables2 as tables
 
-from netbox.tables import NetBoxTable, TagColumn
+from netbox.tables import NetBoxTable, TagColumn, ActionsColumn
 from tenancy.tables import TenancyColumnsMixin
 
 from netbox_dns.models import View
 
 
-__all__ = ("ViewTable",)
+__all__ = (
+    "ViewTable",
+    "RelatedViewTable",
+)
 
 
 class ViewTable(TenancyColumnsMixin, NetBoxTable):
@@ -20,5 +23,31 @@ class ViewTable(TenancyColumnsMixin, NetBoxTable):
 
     class Meta(NetBoxTable.Meta):
         model = View
-        fields = ("description",)
+        fields = (
+            "name",
+            "default_view",
+            "description",
+            "tenant",
+            "tenant_group",
+            "tags",
+        )
         default_columns = ("name", "default_view")
+
+
+class RelatedViewTable(TenancyColumnsMixin, NetBoxTable):
+    actions = ActionsColumn(actions=())
+
+    name = tables.Column(
+        linkify=True,
+    )
+
+    class Meta(NetBoxTable.Meta):
+        model = View
+        fields = (
+            "name",
+            "description",
+            "tenant",
+            "tenant_group",
+            "tags",
+        )
+        default_columns = ("name", "description")

netbox_dns/tables/zone.py

@@ -58,11 +58,26 @@ class ZoneTable(TenancyColumnsMixin, NetBoxTable):
     class Meta(NetBoxTable.Meta):
         model = Zone
         fields = (
+            "name",
+            "view",
+            "status",
             "description",
+            "tags",
+            "default_ttl",
+            "soa_mname",
             "soa_rname",
             "soa_serial",
+            "rfc2317_prefix",
             "rfc2317_parent_managed",
+            "rfc2317_parent_zone",
+            "registrar",
             "registry_domain_id",
+            "registrant",
+            "admin_c",
+            "tech_c",
+            "billing_c",
+            "tenant",
+            "tenant_group",
         )
         default_columns = (
             "name",

netbox_dns/tables/zone_template.py

@@ -37,7 +37,18 @@ class ZoneTemplateTable(TenancyColumnsMixin, NetBoxTable):
 
     class Meta(NetBoxTable.Meta):
         model = ZoneTemplate
-        fields = ("description",)
+        fields = (
+            "name",
+            "description",
+            "tags",
+            "registrar",
+            "registrant",
+            "admin_c",
+            "tech_c",
+            "billing_c",
+            "tenant",
+            "tenant_group",
+        )
         default_columns = (
             "name",
             "tags",
@@ -49,7 +60,10 @@ class ZoneTemplateDisplayTable(ZoneTemplateTable):
 
     class Meta(NetBoxTable.Meta):
         model = ZoneTemplate
-        fields = ("description",)
+        fields = (
+            "name",
+            "description",
+        )
         default_columns = (
             "name",
             "description",

netbox_dns/template_content.py

@@ -1,9 +1,12 @@
+from django.conf import settings
+
 from netbox.plugins.utils import get_plugin_config
 from netbox.plugins import PluginTemplateExtension
 
 from netbox_dns.models import Record, Zone, View, NameServer
 from netbox_dns.choices import RecordTypeChoices
-from netbox_dns.tables import RelatedRecordTable
+from netbox_dns.tables import RelatedRecordTable, RelatedViewTable
+from netbox_dns.utilities import get_views_by_prefix
 
 
 class RelatedDNSRecords(PluginTemplateExtension):
@@ -42,6 +45,25 @@ class RelatedDNSRecords(PluginTemplateExtension):
         )
 
 
+class RelatedDNSViews(PluginTemplateExtension):
+    model = "ipam.prefix"
+
+    def right_page(self):
+        prefix = self.context.get("object")
+
+        if assigned_views := prefix.netbox_dns_views.all():
+            context = {"assigned_views": RelatedViewTable(data=assigned_views)}
+        elif inherited_views := get_views_by_prefix(prefix):
+            context = {"inherited_views": RelatedViewTable(data=inherited_views)}
+        else:
+            context = {}
+
+        return self.render(
+            "netbox_dns/view/related.html",
+            extra_context=context,
+        )
+
+
 class IPRelatedDNSRecords(PluginTemplateExtension):
     model = "ipam.ipaddress"
 
@@ -80,43 +102,10 @@ class IPRelatedDNSRecords(PluginTemplateExtension):
         )
 
 
-class RelatedDNSObjects(PluginTemplateExtension):
-    model = "tenancy.tenant"
-
-    def left_page(self):
-        obj = self.context.get("object")
-        request = self.context.get("request")
-
-        related_dns_models = (
-            (
-                View.objects.restrict(request.user, "view").filter(tenant=obj),
-                "tenant_id",
-            ),
-            (
-                NameServer.objects.restrict(request.user, "view").filter(tenant=obj),
-                "tenant_id",
-            ),
-            (
-                Zone.objects.restrict(request.user, "view").filter(tenant=obj),
-                "tenant_id",
-            ),
-            (
-                Record.objects.restrict(request.user, "view").filter(tenant=obj),
-                "tenant_id",
-            ),
-        )
-
-        return self.render(
-            "netbox_dns/related_dns_objects.html",
-            extra_context={
-                "related_dns_models": related_dns_models,
-            },
-        )
-
-
-template_extensions = []
+if not settings.PLUGINS_CONFIG["netbox_dns"].get("autodns_disabled"):
+    template_extensions = [RelatedDNSRecords, RelatedDNSViews]
+else:
+    template_extensions = []
 
-if get_plugin_config("netbox_dns", "feature_ipam_coupling"):
-    template_extensions.append(RelatedDNSRecords)
-elif get_plugin_config("netbox_dns", "feature_ipam_dns_info"):
+if get_plugin_config("netbox_dns", "feature_ipam_dns_info"):
     template_extensions.append(IPRelatedDNSRecords)

netbox_dns/templates/netbox_dns/record.html

@@ -102,12 +102,12 @@
                     <th scope="row">Address Record</th>
                     <td>{{ object.address_record|linkify }}</td>
                 </tr>
-                    {% if object.address_record.ipam_ip_address %}
-                    <tr>
-                        <th scope="row">IPAM IP Address</th>
-                        <td>{{ object.address_record.ipam_ip_address|linkify }}</td>
-                    </tr>
-                    {% endif %}
+                {% if object.address_record.ipam_ip_address %}
+                <tr>
+                    <th scope="row">IPAM IP Address</th>
+                    <td>{{ object.address_record.ipam_ip_address|linkify }}</td>
+                </tr>
+                {% endif %}
                 {% endif %}
                 {% if object.ipam_ip_address %}
                 <tr>

netbox_dns/templates/netbox_dns/view/related.html

@@ -0,0 +1,17 @@
+{% load perms %}
+
+{% if perms.netbox_dns.view_view %}
+    {% if assigned_views %}
+        {% if assigned_views.rows|length == 1 %}
+            {% include 'inc/panel_table.html' with table=assigned_views heading='Assigned DNS View' %}
+        {% else %}
+            {% include 'inc/panel_table.html' with table=assigned_views heading='Assigned DNS Views' %}
+        {% endif %}
+    {% elif inherited_views %}
+        {% if inherited_views.rows|length == 1 %}
+            {% include 'inc/panel_table.html' with table=inherited_views heading='Inherited DNS View' %}
+        {% else %}
+            {% include 'inc/panel_table.html' with table=inherited_views heading='Inherited DNS Views' %}
+        {% endif %}
+    {% endif %}
+{% endif %}

netbox_dns/templates/netbox_dns/view.html

@@ -35,6 +35,35 @@
         </div>
         <div class="col col-md-6">
             {% include 'inc/panels/tags.html' %}
+            {% if not settings.PLUGINS_CONFIG.netbox_dns.autodns_disabled %}
+            <div class="card">
+                <h5 class="card-header">
+                    IPAM Prefixes
+                </h5>
+                <div class="card-body">
+                    <table class="table table-hover attr-table">
+                        {% for prefix in object.prefixes.all %}
+                        <tr>
+                            <td>
+                                <a href="{% url 'ipam:prefix' pk=prefix.pk %}">
+                                    {{ prefix }}
+                                </a>
+                            </td>
+                            {% if prefix.vrf %}
+                            <td>
+                                <a href="{% url 'ipam:vrf' pk=prefix.vrf.pk %}">
+                                    {{ prefix.vrf }}
+                                </a>
+                            </td>
+                            {% else %}
+                            <td>Global</td>
+                            {% endif %}
+                        </tr>
+                        {% endfor %}
+                    </table>
+                </div>
+            </div>
+            {% endif %}
         </div>
     </div>
 {% endblock %}

netbox_dns/urls/contact.py

@@ -1,29 +1,51 @@
-from django.urls import include, path
+from django.urls import path
 
-from utilities.urls import get_model_urls
+from netbox.views.generic import ObjectChangeLogView, ObjectJournalView
 
+from netbox_dns.models import Contact
 from netbox_dns.views import (
-    ContactView,
     ContactListView,
-    ContactEditView,
+    ContactView,
     ContactDeleteView,
+    ContactEditView,
     ContactBulkImportView,
     ContactBulkEditView,
     ContactBulkDeleteView,
+    ContactZoneListView,
 )
 
 contact_urlpatterns = [
-    path("contacts/<int:pk>/", ContactView.as_view(), name="contact"),
     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"
+        "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/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"
+        "contacts/<int:pk>/changelog/",
+        ObjectChangeLogView.as_view(),
+        name="contact_changelog",
+        kwargs={"model": Contact},
     ),
-    path("contacts/<int:pk>/", include(get_model_urls("netbox_dns", "contact"))),
 ]