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

netbox_dns/management/commands/setup_coupling.py

@@ -1,109 +0,0 @@
-from django.core.management.base import BaseCommand
-
-from core.models import ObjectType
-from extras.models import CustomField
-from extras.choices import CustomFieldTypeChoices
-from ipam.models import IPAddress
-from netbox_dns.models import Zone
-
-
-class Command(BaseCommand):
-    help = "Setup IPAddress custom fields needed for IPAM-DNS coupling"
-
-    def add_arguments(self, parser):
-        parser.add_argument(
-            "--remove", action="store_true", help="Remove custom fields"
-        )
-        parser.add_argument("--verbose", action="store_true", help="Verbose output")
-
-    def handle(self, *model_names, **options):
-        ipaddress_object_type = ObjectType.objects.get_for_model(IPAddress)
-
-        if options["remove"]:
-            for cf in (
-                "ipaddress_dns_record_name",
-                "ipaddress_dns_record_ttl",
-                "ipaddress_dns_record_disable_ptr",
-                "ipaddress_dns_zone_id",
-            ):
-                try:
-                    CustomField.objects.get(
-                        name=cf, object_types=ipaddress_object_type
-                    ).delete()
-                    if options.get("verbose"):
-                        self.stdout.write(f"Custom field '{cf}' removed")
-                except CustomField.DoesNotExist:
-                    pass
-
-        else:
-            if not CustomField.objects.filter(
-                name="ipaddress_dns_record_name",
-                type=CustomFieldTypeChoices.TYPE_TEXT,
-                object_types=ipaddress_object_type,
-            ).exists():
-                cf_name = CustomField.objects.create(
-                    name="ipaddress_dns_record_name",
-                    label="Name",
-                    type=CustomFieldTypeChoices.TYPE_TEXT,
-                    required=False,
-                    group_name="DNS",
-                )
-                cf_name.object_types.set([ipaddress_object_type])
-                if options.get("verbose"):
-                    self.stdout.write(
-                        "Created custom field 'ipaddress_dns_record_name'"
-                    )
-
-            if not CustomField.objects.filter(
-                name="ipaddress_dns_record_ttl",
-                type=CustomFieldTypeChoices.TYPE_INTEGER,
-                object_types=ipaddress_object_type,
-            ).exists():
-                cf_ttl = CustomField.objects.create(
-                    name="ipaddress_dns_record_ttl",
-                    label="TTL",
-                    type=CustomFieldTypeChoices.TYPE_INTEGER,
-                    validation_minimum=0,
-                    validation_maximum=2147483647,
-                    required=False,
-                    group_name="DNS",
-                )
-                cf_ttl.object_types.set([ipaddress_object_type])
-                if options.get("verbose"):
-                    self.stdout.write("Created custom field 'ipaddress_dns_record_ttl'")
-
-            if not CustomField.objects.filter(
-                name="ipaddress_dns_record_disable_ptr",
-                type=CustomFieldTypeChoices.TYPE_BOOLEAN,
-                object_types=ipaddress_object_type,
-            ).exists():
-                cf_disable_ptr = CustomField.objects.create(
-                    name="ipaddress_dns_record_disable_ptr",
-                    label="Disable PTR",
-                    type=CustomFieldTypeChoices.TYPE_BOOLEAN,
-                    required=False,
-                    default=False,
-                    group_name="DNS",
-                )
-                cf_disable_ptr.object_types.set([ipaddress_object_type])
-                if options.get("verbose"):
-                    self.stdout.write(
-                        "Created custom field 'ipaddress_dns_record_disable_ptr'"
-                    )
-
-            if not CustomField.objects.filter(
-                name="ipaddress_dns_zone_id",
-                type=CustomFieldTypeChoices.TYPE_OBJECT,
-                object_types=ipaddress_object_type,
-            ).exists():
-                cf_zone = CustomField.objects.create(
-                    name="ipaddress_dns_zone_id",
-                    label="Zone",
-                    type=CustomFieldTypeChoices.TYPE_OBJECT,
-                    related_object_type=ObjectType.objects.get_for_model(Zone),
-                    required=False,
-                    group_name="DNS",
-                )
-                cf_zone.object_types.set([ipaddress_object_type])
-                if options.get("verbose"):
-                    self.stdout.write("Created custom field 'ipaddress_dns_zone_id'")

netbox_dns/migrations/0007_alter_ordering_options.py

@@ -1,25 +0,0 @@
-# Generated by Django 5.0.7 on 2024-08-27 09:29
-
-from django.db import migrations
-
-
-class Migration(migrations.Migration):
-
-    dependencies = [
-        ("netbox_dns", "0006_templating"),
-    ]
-
-    operations = [
-        migrations.AlterModelOptions(
-            name="record",
-            options={"ordering": ("fqdn", "zone", "name", "type", "value", "status")},
-        ),
-        migrations.AlterModelOptions(
-            name="recordtemplate",
-            options={"ordering": ("name",)},
-        ),
-        migrations.AlterModelOptions(
-            name="zonetemplate",
-            options={"ordering": ("name",)},
-        ),
-    ]

netbox_dns/signals/ipam_coupling.py

@@ -1,168 +0,0 @@
-from django.dispatch import receiver
-from django.db.models.signals import pre_save, post_save, pre_delete
-from django.core.exceptions import ValidationError, PermissionDenied
-from rest_framework.exceptions import PermissionDenied as APIPermissionDenied
-
-from netbox.signals import post_clean
-from netbox.context import current_request
-from netbox.plugins.utils import get_plugin_config
-from ipam.models import IPAddress
-
-from netbox_dns.models import Zone
-from netbox_dns.utilities.ipam_coupling import (
-    ipaddress_cf_data,
-    get_address_record,
-    new_address_record,
-    update_address_record,
-    check_permission,
-    dns_changed,
-    DNSPermissionDenied,
-)
-
-
-@receiver(post_clean, sender=IPAddress)
-def ip_address_check_permissions_save(instance, **kwargs):
-    if not instance.address:
-        return
-
-    if not get_plugin_config("netbox_dns", "feature_ipam_coupling"):
-        return
-
-    request = current_request.get()
-    if request is None:
-        return
-
-    try:
-        if instance.pk is None:
-            record = new_address_record(instance)
-            if record is not None:
-                record.full_clean()
-                check_permission(request, "netbox_dns.add_record", record)
-
-        else:
-            if not dns_changed(IPAddress.objects.get(pk=instance.pk), instance):
-                return
-
-            record = get_address_record(instance)
-            if record is not None:
-                name, ttl, disable_ptr, zone_id = ipaddress_cf_data(instance)
-                if zone_id is not None:
-                    update_address_record(record, instance)
-                    record.full_clean()
-                    check_permission(request, "netbox_dns.change_record", record)
-                else:
-                    check_permission(request, "netbox_dns.delete_record", record)
-
-            else:
-                record = new_address_record(instance)
-                if record is not None:
-                    record.full_clean()
-                    check_permission(request, "netbox_dns.add_record", record)
-
-    except ValidationError as exc:
-        if hasattr(exc, "error_dict"):
-            value = exc.error_dict.pop("name", None)
-            if value is not None:
-                exc.error_dict["cf_ipaddress_dns_record_name"] = value
-
-            value = exc.error_dict.pop("ttl", None)
-            if value is not None:
-                exc.error_dict["cf_ipaddress_dns_record_ttl"] = value
-
-            value = exc.error_dict.pop("value", None)
-            if value is not None:
-                exc.error_dict["cf_ipaddress_dns_record_name"] = value
-
-            value = exc.error_dict.pop("type", None)
-            if value is not None:
-                exc.error_dict["cf_ipaddress_dns_record_name"] = value
-
-        raise ValidationError(exc)
-
-    except DNSPermissionDenied as exc:
-        raise ValidationError(exc)
-
-
-@receiver(pre_delete, sender=IPAddress)
-def ip_address_delete_address_record(instance, **kwargs):
-    if not get_plugin_config("netbox_dns", "feature_ipam_coupling"):
-        return
-
-    request = current_request.get()
-    if request is not None:
-        try:
-            for record in instance.netbox_dns_records.all():
-                check_permission(request, "netbox_dns.delete_record", record)
-
-        except DNSPermissionDenied as exc:
-            if request.path_info.startswith("/api/"):
-                raise APIPermissionDenied(exc) from None
-
-            raise PermissionDenied(exc) from None
-
-    for record in instance.netbox_dns_records.all():
-        record.delete()
-
-
-#
-# Update DNS related fields according to the contents of the IPAM-DNS
-# coupling custom fields.
-#
-@receiver(pre_save, sender=IPAddress)
-def ip_address_update_dns_information(instance, **kwargs):
-    if not get_plugin_config("netbox_dns", "feature_ipam_coupling"):
-        return
-
-    name, ttl, disable_ptr, zone_id = ipaddress_cf_data(instance)
-
-    previous_zone_id = None
-    if instance.pk is not None:
-        try:
-            old_instance = IPAddress.objects.get(pk=instance.pk)
-            previous_zone_id = old_instance.custom_field_data.get(
-                "ipaddress_dns_zone_id"
-            )
-        except IPAddress.DoesNotExist:
-            pass
-
-    if zone_id is not None:
-        instance.dns_name = f"{name}.{Zone.objects.get(pk=zone_id).name}"
-    else:
-        instance.custom_field_data["ipaddress_dns_record_name"] = None
-        instance.custom_field_data["ipaddress_dns_record_ttl"] = None
-        instance.custom_field_data["ipaddress_dns_record_disable_ptr"] = False
-        instance.custom_field_data["ipaddress_dns_zone_id"] = None
-
-        if previous_zone_id is not None:
-            instance.dns_name = ""
-
-
-#
-# Handle DNS record operation after IPAddress has been created or modified
-#
-@receiver(post_save, sender=IPAddress)
-def ip_address_update_address_record(instance, **kwargs):
-    if not get_plugin_config("netbox_dns", "feature_ipam_coupling"):
-        return
-
-    name, ttl, disable_ptr, zone_id = ipaddress_cf_data(instance)
-
-    if zone_id is None:
-        #
-        # Name/Zone CF data has been removed: Remove the DNS address record
-        #
-        for record in instance.netbox_dns_records.all():
-            record.delete()
-
-    else:
-        #
-        # Name/Zone CF data is present: Check for a DNS address record and add
-        # or modify it as necessary
-        #
-        record = get_address_record(instance)
-        if record is None:
-            record = new_address_record(instance)
-        else:
-            update_address_record(record, instance)
-
-        record.save()

netbox_dns/templates/netbox_dns/related_dns_objects.html

@@ -1,21 +0,0 @@
-{% load helpers %}
-
-<div class="card">
-  <h5 class="card-header">Related NetBox DNS Objects</h5>
-  <ul class="list-group list-group-flush">
-    {% for qs, filter_param in related_dns_models %}
-      {% with viewname=qs.model|viewname:"list" %}
-        <a href="{% url viewname %}?{{ filter_param }}={{ object.pk }}" class="list-group-item list-group-item-action d-flex justify-content-between">
-          {{ qs.model|meta:"verbose_name_plural"|bettertitle }}
-          {% with count=qs.count %}
-            {% if count %}
-              <span class="badge bg-primary rounded-pill">{{ count }}</span>
-            {% else %}
-              <span class="badge bg-light rounded-pill">&mdash;</span>
-            {% endif %}
-          {% endwith %}
-        </a>
-      {% endwith %}
-    {% endfor %}
-  </ul>
-</div>

netbox_dns/utilities/ipam_coupling.py

@@ -1,112 +0,0 @@
-from ipam.choices import IPAddressStatusChoices
-from utilities.permissions import resolve_permission
-
-from netbox_dns.models import Record
-from netbox_dns.choices import RecordTypeChoices, RecordStatusChoices
-
-from netbox.plugins.utils import get_plugin_config
-
-
-class DNSPermissionDenied(Exception):
-    pass
-
-
-def ipaddress_cf_data(ip_address):
-    name = ip_address.custom_field_data.get("ipaddress_dns_record_name")
-    ttl = ip_address.custom_field_data.get("ipaddress_dns_record_ttl")
-    disable_ptr = ip_address.custom_field_data.get("ipaddress_dns_record_disable_ptr")
-    if disable_ptr is None:
-        disable_ptr = False
-    zone_id = ip_address.custom_field_data.get("ipaddress_dns_zone_id")
-
-    if name is None or zone_id is None:
-        return None, None, False, None
-
-    return name, ttl, disable_ptr, zone_id
-
-
-def address_record_type(ip_address):
-    return RecordTypeChoices.AAAA if ip_address.family == 6 else RecordTypeChoices.A
-
-
-def address_record_status(ip_address):
-    ip_active_status_list = get_plugin_config(
-        "netbox_dns",
-        "ipam_coupling_ip_active_status_list",
-        (
-            IPAddressStatusChoices.STATUS_ACTIVE,
-            IPAddressStatusChoices.STATUS_DHCP,
-            IPAddressStatusChoices.STATUS_SLAAC,
-        ),
-    )
-
-    return (
-        RecordStatusChoices.STATUS_ACTIVE
-        if ip_address.status in ip_active_status_list
-        else RecordStatusChoices.STATUS_INACTIVE
-    )
-
-
-def get_address_record(ip_address):
-    return ip_address.netbox_dns_records.first()
-
-
-def new_address_record(instance):
-    name, ttl, disable_ptr, zone_id = ipaddress_cf_data(instance)
-
-    if zone_id is None:
-        return None
-
-    return Record(
-        name=name,
-        zone_id=zone_id,
-        ttl=ttl,
-        disable_ptr=disable_ptr,
-        status=address_record_status(instance),
-        type=address_record_type(instance),
-        value=str(instance.address.ip),
-        ipam_ip_address_id=instance.pk,
-        managed=True,
-    )
-
-
-def update_address_record(record, ip_address):
-    name, ttl, disable_ptr, zone_id = ipaddress_cf_data(ip_address)
-
-    record.name = name
-    record.ttl = ttl
-    record.disable_ptr = disable_ptr
-    record.zone_id = zone_id
-    record.status = address_record_status(ip_address)
-    record.value = str(ip_address.address.ip)
-
-
-def check_permission(request, permission, record=None):
-    if record is not None and record.pk is None:
-        check_record = None
-    else:
-        check_record = record
-
-    user = request.user
-
-    if not user.has_perm(permission, check_record):
-        action = resolve_permission(permission)[1]
-        item = "records" if check_record is None else f"record {check_record}"
-
-        raise DNSPermissionDenied(f"User {user} is not allowed to {action} DNS {item}")
-
-
-def dns_changed(old, new):
-    return any(
-        (
-            old.address.ip != new.address.ip,
-            old.custom_field_data.get("ipaddress_dns_record_name")
-            != new.custom_field_data.get("ipaddress_dns_record_name"),
-            old.custom_field_data.get("ipaddress_dns_record_ttl")
-            != new.custom_field_data.get("ipaddress_dns_record_ttl"),
-            old.custom_field_data.get("ipaddress_dns_record_disable_ptr")
-            != new.custom_field_data.get("ipaddress_dns_record_disable_ptr"),
-            old.custom_field_data.get("ipaddress_dns_zone_id")
-            != new.custom_field_data.get("ipaddress_dns_zone_id"),
-        )
-    )