netbox-ddns 1.4.0__py3-none-any.whl → 1.7.0__py3-none-any.whl

netbox_ddns/models.py

@@ -4,6 +4,7 @@ import logging
 import socket
 from django.core.exceptions import ValidationError
 from django.db import models
+from django.db.models import Q
 from django.db.models.functions import Length
 from django.utils.html import format_html
 from django.utils.translation import gettext_lazy as _
@@ -15,8 +16,10 @@ from typing import Optional
 from netbox.models import NetBoxModel
 from ipam.fields import IPNetworkField
 from ipam.models import IPAddress
+from utilities.querysets import RestrictedQuerySet
 from .utils import normalize_fqdn
-from .validators import HostnameAddressValidator, HostnameValidator, validate_base64, MinValueValidator, MaxValueValidator
+from .validators import DNSNameValidator, HostnameAddressValidator, HostnameValidator, validate_base64, MinValueValidator, \
+    MaxValueValidator
 
 logger = logging.getLogger('netbox_ddns')
 
@@ -61,8 +64,11 @@ def get_rcode_display(code):
     else:
         return _('Unknown response: {}').format(code)
 
+class Protocol(models.TextChoices):
+    UDP = 'udp', _('UDP')
+    TCP = 'tcp', _('TCP')
 
-class Server(models.Model):
+class Server(NetBoxModel):
     server = models.CharField(
         verbose_name=_('DDNS Server'),
         max_length=255,
@@ -92,6 +98,12 @@ class Server(models.Model):
         validators=[validate_base64],
         help_text=_('in base64 notation'),
     )
+    protocol = models.CharField(
+        verbose_name=_('Protocol'),
+        max_length=3,
+        choices=Protocol.choices,
+        default=Protocol.UDP,
+    )
 
     class Meta:
         unique_together = (
@@ -111,6 +123,9 @@ class Server(models.Model):
         # Ensure trailing dots from domain-style fields
         self.tsig_key_name = normalize_fqdn(self.tsig_key_name.lower().rstrip('.'))
 
+    def get_absolute_url(self):
+        return reverse('plugins:netbox_ddns:server', args=[self.pk])
+
     @property
     def address(self) -> Optional[str]:
         addrinfo = socket.getaddrinfo(self.server, self.server_port, proto=socket.IPPROTO_UDP)
@@ -129,7 +144,7 @@ class Server(models.Model):
         )
 
 
-class ZoneQuerySet(models.QuerySet):
+class ZoneQuerySet(RestrictedQuerySet):
     def find_for_dns_name(self, dns_name: str) -> Optional['Zone']:
         # Generate all possible zones
         zones = []
@@ -141,7 +156,7 @@ class ZoneQuerySet(models.QuerySet):
         return self.filter(name__in=zones).order_by(Length('name').desc()).first()
 
 
-class Zone(models.Model):
+class Zone(NetBoxModel):
     name = models.CharField(
         verbose_name=_('zone name'),
         max_length=255,
@@ -167,6 +182,28 @@ class Zone(models.Model):
     def __str__(self):
         return self.name
 
+    def get_managed_ip_address(self):
+        # Find all more-specific zones
+        more_specifics = Zone.objects.filter(name__endswith=self.name).exclude(pk=self.pk)
+
+        # Find all IPAddress objects in this self but not in the more-specifics
+        ip_addresses = IPAddress.objects.filter(Q(dns_name__endswith=self.name) |
+                                                Q(dns_name__endswith=self.name.rstrip('.')))
+        for more_specific in more_specifics:
+            ip_addresses = ip_addresses.exclude(Q(dns_name__endswith=more_specific.name) |
+                                                Q(dns_name__endswith=more_specific.name.rstrip('.')))
+        return ip_addresses
+
+    def get_managed_extra_dns_name(self):
+        # Find all more-specific zones
+        more_specifics = Zone.objects.filter(name__endswith=self.name).exclude(pk=self.pk)
+
+        # Find all ExtraDNSName objects in this zone but not in the more-specifics
+        extra_names = ExtraDNSName.objects.filter(name__endswith=self.name)
+        for more_specific in more_specifics:
+            extra_names = extra_names.exclude(name__endswith=more_specific.name)
+        return extra_names
+
     def clean(self):
         # Ensure trailing dots from domain-style fields
         self.name = normalize_fqdn(self.name)
@@ -174,8 +211,11 @@ class Zone(models.Model):
     def get_updater(self):
         return self.server.create_update(self.name)
 
+    def get_absolute_url(self):
+        return reverse('plugins:netbox_ddns:zone', args=[self.pk])
+
 
-class ReverseZoneQuerySet(models.QuerySet):
+class ReverseZoneQuerySet(RestrictedQuerySet):
     def find_for_address(self, address: ip.IPAddress) -> Optional['ReverseZone']:
         # Find the zone, if any
         zones = list(ReverseZone.objects.filter(prefix__net_contains=address))
@@ -186,7 +226,7 @@ class ReverseZoneQuerySet(models.QuerySet):
         return zones[-1]
 
 
-class ReverseZone(models.Model):
+class ReverseZone(NetBoxModel):
     prefix = IPNetworkField(
         verbose_name=_('prefix'),
         unique=True,
@@ -214,7 +254,19 @@ class ReverseZone(models.Model):
         verbose_name_plural = _('reverse zones')
 
     def __str__(self):
-        return f'for {self.prefix}'
+        return f'{self.prefix}'
+
+    def get_managed_ip_address(self):
+        # Find all more-specific zones
+        more_specifics = ReverseZone.objects.filter(prefix__net_contained=self.prefix).exclude(pk=self.pk)
+        # Find all IPAddress objects in this zone but not in the more-specifics
+        ip_addresses = IPAddress.objects.filter(address__net_contained_or_equal=self.prefix)
+        for more_specific in more_specifics:
+            ip_addresses = ip_addresses.exclude(address__net_contained_or_equal=more_specific.prefix)
+        return ip_addresses
+
+    def get_absolute_url(self):
+        return reverse('plugins:netbox_ddns:reversezone', args=[self.pk])
 
     def record_name(self, address: ip.IPAddress):
         record_name = self.name
@@ -334,7 +386,7 @@ class ExtraDNSName(NetBoxModel):
     name = models.CharField(
         verbose_name=_('DNS name'),
         max_length=255,
-        validators=[HostnameValidator()],
+        validators=[DNSNameValidator()],
     )
 
     last_update = models.DateTimeField(
@@ -367,7 +419,7 @@ class ExtraDNSName(NetBoxModel):
         return self.name
 
     def get_absolute_url(self):
-        return reverse('plugins:netbox_ddns:extradnsname', args=[self.ip_address.pk, self.pk])
+        return reverse('plugins:netbox_ddns:extradnsname', args=[self.pk])
 
     def clean(self):
         # Ensure trailing dots from domain-style fields

netbox_ddns/navigation.py

@@ -0,0 +1,62 @@
+from netbox.plugins import PluginMenuItem, PluginMenuButton, PluginMenu
+
+menu = PluginMenu(
+    label='DDNS',
+    groups=(
+        ('Configuration', (
+            PluginMenuItem(
+                link='plugins:netbox_ddns:managed_dns_name_list',
+                link_text='DNS Names',
+            ),
+            PluginMenuItem(
+                link='plugins:netbox_ddns:server_list',
+                link_text='DDNS Servers',
+                buttons=[
+                    PluginMenuButton(
+                        link='plugins:netbox_ddns:server_add',
+                        title='Add',
+                        icon_class='mdi mdi-plus-thick',
+                    )
+                ]
+            ),
+            PluginMenuItem(
+                link='plugins:netbox_ddns:zone_list',
+                link_text='Forward Zones',
+                buttons=[
+                    PluginMenuButton(
+                        link='plugins:netbox_ddns:zone_add',
+                        title='Add',
+                        icon_class='mdi mdi-plus-thick',
+                    )
+                ]
+            ),
+            PluginMenuItem(
+                link='plugins:netbox_ddns:reversezone_list',
+                link_text='Reverse Zones',
+                buttons=[
+                    PluginMenuButton(
+                        link='plugins:netbox_ddns:reversezone_add',
+                        title='Add',
+                        icon_class='mdi mdi-plus-thick',
+                    )
+                ]
+            ),
+        ),
+         ),
+        ('Extra DNS Names', (
+            PluginMenuItem(
+                link='plugins:netbox_ddns:extradnsname_list',
+                link_text='Extra DNS names',
+                buttons=[
+                    PluginMenuButton(
+                        link='plugins:netbox_ddns:extradnsname_add',
+                        title='Add',
+                        icon_class='mdi mdi-plus-thick',
+                    )
+                ]
+            ),
+        ),
+         ),
+    ),
+    icon_class='mdi mdi-router'
+)

netbox_ddns/tables.py

@@ -1,13 +1,23 @@
 import django_tables2 as tables
+from django_tables2 import LinkColumn, RelatedLinkColumn
 
-from netbox_ddns.models import ExtraDNSName
-try:
-    # NetBox >= 3.2.0
-    from netbox.tables import BaseTable
-    from netbox.tables.columns import ToggleColumn, DateTimeColumn
-except ImportError:
-    # NetBox < 3.2.0
-    from utilities.tables import BaseTable, ToggleColumn, DateTimeColumn
+from netbox_ddns.models import ExtraDNSName, Server, ReverseZone, Zone
+
+from netbox.tables import NetBoxTable
+
+MANAGED_DNS_ACTIONS = """
+<a href="{{ record.view_url }}" class="btn btn-sm btn-outline-primary" title="View">
+    <i class="mdi mdi-eye"></i>
+</a>
+<a href="{{ record.edit_url }}" class="btn btn-sm btn-outline-warning" title="Edit">
+    <i class="mdi mdi-pencil"></i>
+</a>
+{% if record.delete_url %}
+<a href="{{ record.delete_url }}" class="btn btn-sm btn-outline-danger" title="Delete">
+    <i class="mdi mdi-delete"></i>
+</a>
+{% endif %}
+"""
 
 FORWARD_DNS = """
     {% if record.forward_action is not None %}
@@ -18,33 +28,69 @@ FORWARD_DNS = """
     {% endif %}
 """
 
-ACTIONS = """
-    {% if perms.netbox_ddns.change_extradnsname %}
-        <a href="{% url 'plugins:netbox_ddns:extradnsname_edit' ipaddress_pk=record.ip_address.pk pk=record.pk %}" 
-           class="btn btn-warning">
-            <i class="mdi mdi-pencil" aria-hidden="true"></i>
-        </a>
-    {% endif %}
-    {% if perms.netbox_ddns.delete_extradnsname %}
-        <a href="{% url 'plugins:netbox_ddns:extradnsname_delete' ipaddress_pk=record.ip_address.pk pk=record.pk %}"
-           class="btn btn-danger">
-            <i class="mdi mdi-trash-can-outline" aria-hidden="true"></i>
-        </a>
-    {% endif %}
-"""
 
+class ReverseZoneTable(NetBoxTable):
+    name = LinkColumn()
+    server = RelatedLinkColumn()
+
+    class Meta(NetBoxTable.Meta):
+        model = ReverseZone
+        fields = ("id", "name", "prefix", "server", "ttl")
+
+
+class ZoneTable(NetBoxTable):
+    name = LinkColumn()
+    server = RelatedLinkColumn()
+
+    class Meta(NetBoxTable.Meta):
+        model = Zone
+        fields = ("id", "name", "server", "ttl")
+
+
+class ServerTable(NetBoxTable):
+    server = LinkColumn()
 
-class PrefixTable(BaseTable):
-    pk = ToggleColumn()
-    name = tables.Column()
-    last_update = DateTimeColumn()
+    class Meta(NetBoxTable.Meta):
+        model = Server
+        fields = ("id", "server", "server_port", "protocol", "tsig_key_name", "tsig_algorithm")
+
+
+class ExtraDNSNameTable(NetBoxTable):
+    ip_address = RelatedLinkColumn()
+    name = LinkColumn()
     forward_dns = tables.TemplateColumn(template_code=FORWARD_DNS)
+
+    class Meta(NetBoxTable.Meta):
+        model = ExtraDNSName
+        fields = ('id', 'name', 'ip_address', 'last_update', 'forward_dns')
+
+
+class ManagedDNSNameTable(tables.Table):
+    """Table for primary DNS names (from IPAddress.dns_name)."""
+    dns_name = tables.Column(
+        accessor='dns_name',
+        linkify=lambda record: record.view_url,
+    )
+    ip_address = tables.Column(
+        accessor='ip_address',
+        linkify=lambda record: record.ip_address.get_absolute_url(),
+    )
+    zone = tables.Column(
+        accessor='zone',
+        linkify=lambda record: record.zone.get_absolute_url() if record.zone else None,
+    )
+    forward_status = tables.TemplateColumn(
+        template_code='{{ record.forward_status_html|safe }}',
+        verbose_name='Forward DNS',
+    )
     actions = tables.TemplateColumn(
-        template_code=ACTIONS,
-        attrs={'td': {'class': 'text-right text-nowrap noprint'}},
-        verbose_name=''
+        template_code=MANAGED_DNS_ACTIONS,
+        verbose_name='Actions',
+        orderable=False,
     )
 
-    class Meta(BaseTable.Meta):
-        model = ExtraDNSName
-        fields = ('pk', 'name', 'last_update', 'forward_dns', 'actions')
+    def render_zone(self, value):
+        return value if value else '—'
+
+    class Meta:
+        attrs = {'class': 'table table-hover object-list'}

netbox_ddns/template_content.py

@@ -5,9 +5,45 @@ from netbox.plugins.templates import PluginTemplateExtension
 from . import tables
 
 
-# noinspection PyAbstractClass
+class ReverseZoneRecreate(PluginTemplateExtension):
+    # NetBox up to 4.1
+    model = 'netbox_ddns.reversezone'
+    # NetBox from 4.2, required to be present as of NetBox 4.3
+    models = [model]
+
+    def buttons(self):
+        """
+        A button to force DNS re-provisioning
+        """
+        context = {
+            'perms': PermWrapper(self.context['request'].user),
+        }
+        context.update(csrf(self.context['request']))
+        return self.render('netbox_ddns/update_reverse_zone.html', context)
+
+
+class ZoneRecreate(PluginTemplateExtension):
+    # NetBox up to 4.1
+    model = 'netbox_ddns.zone'
+    # NetBox from 4.2, required to be present as of NetBox 4.3
+    models = [model]
+
+    def buttons(self):
+        """
+        A button to force DNS re-provisioning
+        """
+        context = {
+            'perms': PermWrapper(self.context['request'].user),
+        }
+        context.update(csrf(self.context['request']))
+        return self.render('netbox_ddns/update_zone.html', context)
+
+
 class DNSInfo(PluginTemplateExtension):
+    # NetBox up to 4.1
     model = 'ipam.ipaddress'
+    # NetBox from 4.2, required to be present as of NetBox 4.3
+    models = [model]
 
     def buttons(self):
         """
@@ -23,7 +59,8 @@ class DNSInfo(PluginTemplateExtension):
         """
         An info-box with the status of the DNS modifications and records
         """
-        extra_dns_name_table = tables.PrefixTable(list(self.context['object'].extradnsname_set.all()), orderable=False)
+        extra_dns_name_table = tables.ExtraDNSNameTable(list(self.context['object'].extradnsname_set.all()),
+                                                        exclude=["id", "ip_address"], orderable=False)
 
         return (
                 self.render('netbox_ddns/ipaddress/dns_info.html') +
@@ -34,4 +71,4 @@ class DNSInfo(PluginTemplateExtension):
         )
 
 
-template_extensions = [DNSInfo]
+template_extensions = [DNSInfo, ZoneRecreate, ReverseZoneRecreate]

netbox_ddns/templates/netbox_ddns/extradnsname.html

@@ -1,134 +1,11 @@
-{% extends 'generic/_base.html' %}
-{% load buttons %}
-{% load custom_links %}
-{% load helpers %}
-{% load perms %}
-{% load plugins %}
-{% load tabs %}
-{% load i18n %}
-
-{% comment %}
-    Blocks:
-    - page-header:          Content displayed above the primary page content
-    - breadcrumbs:        Breadcrumb list items(HTML
-    <li> elements)
-    - object_identifier:  Unique identifier for the object
-    - title:                Page title
-    - subtitle:             Additional context displayed below the title
-    - controls:             Control elements displayed between the header and content
-    - control-buttons:    Action buttons (add/edit/delete/etc.)
-    - extra_controls:   Any additional action buttons to display
-    - tabs:                 Page tabs
-    - content:              Primary page content
-    - modals:               Any pre-loaded modals
-
-    Context:
-    - object: The object being viewed
-{% endcomment %}
-
-{% block page-header %}
-    <div class="container-fluid">
-        <div class="d-flex justify-content-between align-items-center mt-2">
-
-            {# Object identifier #}
-            <code class="d-block text-muted bg-transparent px-0">
-                {% block object_identifier %}
-                    {{ object|meta:"app_label" }}.{{ object|meta:"model_name" }}:{{ object.pk }}
-                    {% if object.slug %}({{ object.slug }}){% endif %}
-                {% endblock object_identifier %}
-            </code>
-
-        </div>
-    </div>
-    {{ block.super }}
-{% endblock page-header %}
-
-{% block title %}{{ object }}{% endblock %}
-
-{% block subtitle %}
-    <div class="text-secondary fs-5">
-        {% trans "Created" %} {{ object.created|isodatetime:"minutes" }}
-        {% if object.last_updated %}
-            <span class="separator">&middot;</span>
-            {% trans "Updated" %} {{ object.last_updated|isodatetime:"minutes" }}
-        {% endif %}
-    </div>
-{% endblock subtitle %}
-
-{% block controls %}
-    <div class="btn-list justify-content-end mb-2">
-        {% plugin_buttons object %}
-
-        {# Add/edit/delete/etc. buttons #}
-        {% block control-buttons %}
-
-            {# Extra buttons #}
-            {% block extra_controls %}{% endblock %}
-
-            {# Default buttons #}
-            {% if perms.extras.add_bookmark and object.bookmarks %}
-                {% bookmark_button object %}
-            {% endif %}
-            {% if perms.extras.add_subscription and object.subscriptions %}
-                {% subscribe_button object %}
-            {% endif %}
-            {% if request.user|can_change:object %}
-                {% load i18n %}
-                <a href="{% url 'plugins:netbox_ddns:extradnsname_edit' ipaddress_pk=object.ip_address.pk pk=object.pk %}"
-                   class="btn btn-yellow" role="button">
-                    <i class="mdi mdi-pencil" aria-hidden="true"></i> {% trans "Edit" %}
-                </a>
-            {% endif %}
-            {% if request.user|can_delete:object %}
-                {% load i18n %}
-                <a href="#"
-                   hx-get="{% url 'plugins:netbox_ddns:extradnsname_delete' ipaddress_pk=object.ip_address.pk pk=object.pk %}"
-                   hx-target="#htmx-modal-content"
-                   hx-swap="innerHTML"
-                   hx-select="form"
-                   class="btn btn-red"
-                   data-bs-toggle="modal"
-                   data-bs-target="#htmx-modal"
-                >
-                    <i class="mdi mdi-trash-can-outline" aria-hidden="true"></i> {% trans "Delete" %}
-                </a>
-
-            {% endif %}
-        {% endblock control-buttons %}
-    </div>
-
-    {# Custom links #}
-    <div class="d-flex justify-content-end">
-        <div class="btn-list">
-            {% block custom-links %}
-                {% custom_links object %}
-            {% endblock custom-links %}
-        </div>
-    </div>
-{% endblock controls %}
-
-{% block tabs %}
-    <ul class="nav nav-tabs" role="presentation">
-        {# Primary tab #}
-        <li class="nav-item">
-            <a class="nav-link{% if not tab %} active{% endif %}" href="{{ object.get_absolute_url }}">
-                {{ object|meta:"verbose_name"|bettertitle }}</a>
-        </li>
-
-        {# Include tabs for registered model views #}
-        {% model_view_tabs object %}
-    </ul>
-{% endblock tabs %}
-
-{% block alerts %}
-    {% plugin_alerts object %}
-{% endblock alerts %}
+{% extends 'generic/object.html' %}
+{% load render_table from django_tables2 %}
 
 {% block content %}
     <div class="row mb-3">
         <div class="col col-md-6">
             <div class="card">
-                <h5 class="card-header">Access List</h5>
+                <h5 class="card-header">Extra DNS name</h5>
                 <div class="card-body">
                     <table class="table table-hover attr-table">
                         <tr>
@@ -158,12 +35,27 @@
                     </table>
                 </div>
             </div>
+            <div class="card">
+                <h5 class="card-header">Managed by</h5>
+                <div class="card-body">
+                    <table class="table table-hover attr-table">
+                        <tr>
+                            <th scope="row">DDNS Server</th>
+                            <td>
+                                <a href="{{ server.get_absolute_url }}">{{ server }}</a>
+                            </td>
+                        </tr>
+                        <tr>
+                            <th scope="row">Zone</th>
+                            <td>
+                                <a href="{{ zone.get_absolute_url }}">{{ zone }}</a>
+                            </td>
+                        </tr>
+                    </table>
+                </div>
+            </div>
             {% include 'inc/panels/custom_fields.html' %}
         </div>
         <div class="col col-md-6">{% include 'inc/panels/tags.html' %}</div>
     </div>
-{% endblock content %}
-
-{% block modals %}
-    {% include 'inc/htmx_modal.html' %}
-{% endblock modals %}
+{% endblock content %}

netbox_ddns/templates/netbox_ddns/ipaddress/dns_extra.html

@@ -10,7 +10,7 @@
 
         {% if perms.netbox_ddns.add_extradnsname %}
             <div class="card-footer text-right noprint">
-                <a href="{% url 'plugins:netbox_ddns:extradnsname_create' ipaddress_pk=object.pk %}"
+                <a href="{% url 'plugins:netbox_ddns:extradnsname_ip_address_create' ipaddress_pk=object.pk %}"
                    class="btn btn-primary">
                     <span class="mdi mdi-plus" aria-hidden="true"></span>Add extra DNS name
                 </a>

netbox_ddns/templates/netbox_ddns/managed_dns_names.html

@@ -0,0 +1,17 @@
+{% extends 'base/layout.html' %}
+{% load render_table from django_tables2 %}
+
+{% block title %}DNS Names{% endblock %}
+
+{% block content %}
+    <div class="row">
+        <div class="col col-12">
+            <div class="card">
+                <h5 class="card-header">DNS Names</h5>
+                <div class="card-body table-responsive">
+                    {% render_table table 'inc/table.html' %}
+                </div>
+            </div>
+        </div>
+    </div>
+{% endblock content %}

netbox_ddns/templates/netbox_ddns/reversezone.html

@@ -0,0 +1,51 @@
+{% extends 'generic/object.html' %}
+{% load render_table from django_tables2 %}
+
+{% block content %}
+    <div class="row">
+        <div class="col col-md-6">
+            <div class="card">
+                <h2 class="card-header">Reverse Zone</h2>
+                <table class="table table-hover attr-table">
+                    <tr>
+                        <th scope="row">Name</th>
+                        <td>
+                            {{ object.name }}
+                        </td>
+                    </tr>
+                    <tr>
+                        <th scope="row">Prefix</th>
+                        <td>
+                            {{ object.prefix }}
+                        </td>
+                    </tr>
+                    <tr>
+                        <th scope="row">TTL</th>
+                        <td>
+                            {{ object.ttl }}
+                        </td>
+                    </tr>
+                    <tr>
+                        <th scope="row">Server</th>
+                        <td>
+                            <a href="{{ object.server.get_absolute_url }}">
+                                {{ object.server }}
+                            </a>
+                        </td>
+                    </tr>
+                </table>
+            </div>
+            <div class="card">
+                <div class="justify-content-between card-header">
+                    <h1 class="card-title">IP Addresses</h1>
+                </div>
+                <div class="card-body table-responsive">
+                    {% render_table ip_address_table %}
+                </div>
+            </div>
+            {% include 'inc/panels/custom_fields.html' %}
+            {% include 'inc/panels/tags.html' %}
+        </div>
+    </div>
+
+{% endblock content %}