netbox-plugin-dns 1.1.1__py3-none-any.whl → 1.1.3__py3-none-any.whl

netbox_dns/models/record.py

@@ -8,15 +8,17 @@ from django.db import transaction, models
 from django.db.models import Q, ExpressionWrapper, BooleanField, Min
 from django.urls import reverse
 from django.conf import settings
+from django.utils.translation import gettext_lazy as _
 
 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 +43,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 = {
@@ -110,58 +126,67 @@ class Record(ObjectModificationMixin, ContactsMixin, NetBoxModel):
     )
 
     name = models.CharField(
+        verbose_name=_("Name"),
         max_length=255,
     )
     zone = models.ForeignKey(
-        "Zone",
+        verbose_name=_("Zone"),
+        to="Zone",
         on_delete=models.CASCADE,
     )
     fqdn = models.CharField(
+        verbose_name=_("FQDN"),
         max_length=255,
         null=True,
         blank=True,
         default=None,
     )
     type = models.CharField(
+        verbose_name=_("Type"),
         choices=RecordTypeChoices,
         max_length=10,
     )
     value = models.CharField(
+        verbose_name=_("Value"),
         max_length=65535,
     )
     status = models.CharField(
+        verbose_name=_("Status"),
         max_length=50,
         choices=RecordStatusChoices,
         default=RecordStatusChoices.STATUS_ACTIVE,
         blank=False,
     )
     ttl = models.PositiveIntegerField(
-        verbose_name="TTL",
+        verbose_name=_("TTL"),
         null=True,
         blank=True,
     )
     managed = models.BooleanField(
+        verbose_name=_("Managed"),
         null=False,
         default=False,
     )
     ptr_record = models.OneToOneField(
-        "self",
+        verbose_name="PTR Record",
+        to="self",
         on_delete=models.SET_NULL,
         related_name="address_record",
-        verbose_name="PTR record",
         null=True,
         blank=True,
     )
     disable_ptr = models.BooleanField(
-        verbose_name="Disable PTR",
-        help_text="Disable PTR record creation",
+        verbose_name=_("Disable PTR"),
+        help_text=_("Disable PTR record creation"),
         default=False,
     )
     description = models.CharField(
+        verbose_name=_("Description"),
         max_length=200,
         blank=True,
     )
     tenant = models.ForeignKey(
+        verbose_name=_("Tenant"),
         to="tenancy.Tenant",
         on_delete=models.PROTECT,
         related_name="netbox_dns_records",
@@ -169,13 +194,13 @@ class Record(ObjectModificationMixin, ContactsMixin, NetBoxModel):
         null=True,
     )
     ip_address = AddressField(
-        verbose_name="Related IP Address",
-        help_text="IP address related to an address (A/AAAA) or PTR record",
+        verbose_name=_("Related IP Address"),
+        help_text=_("IP address related to an address (A/AAAA) or PTR record"),
         blank=True,
         null=True,
     )
     ipam_ip_address = models.ForeignKey(
-        verbose_name="IPAM IP Address",
+        verbose_name=_("IPAM IP Address"),
         to="ipam.IPAddress",
         on_delete=models.CASCADE,
         related_name="netbox_dns_records",
@@ -183,10 +208,10 @@ class Record(ObjectModificationMixin, ContactsMixin, NetBoxModel):
         null=True,
     )
     rfc2317_cname_record = models.ForeignKey(
-        "self",
+        verbose_name=_("RFC2317 CNAME Record"),
+        to="self",
         on_delete=models.SET_NULL,
         related_name="rfc2317_ptr_records",
-        verbose_name="RFC2317 CNAME record",
         null=True,
         blank=True,
     )
@@ -206,8 +231,8 @@ class Record(ObjectModificationMixin, ContactsMixin, NetBoxModel):
     )
 
     class Meta:
-        verbose_name = "Record"
-        verbose_name_plural = "Records"
+        verbose_name = _("Record")
+        verbose_name_plural = _("Records")
 
         ordering = (
             "fqdn",
@@ -473,22 +498,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):
@@ -515,7 +547,9 @@ class Record(ObjectModificationMixin, ContactsMixin, NetBoxModel):
         if not fqdn.is_subdomain(_zone):
             raise ValidationError(
                 {
-                    "name": f"{self.name} is not a name in {zone.name}",
+                    "name": _("{name} is not a name in {zone}").format(
+                        name=self.name, zone=zone.name
+                    ),
                 }
             )
 
@@ -559,13 +593,13 @@ class Record(ObjectModificationMixin, ContactsMixin, NetBoxModel):
                     {
                         "name": exc,
                     }
-                ) from None
+                )
 
     def validate_value(self):
         try:
             validate_record_value(self.type, self.value)
         except ValidationError as exc:
-            raise ValidationError({"value": exc}) from None
+            raise ValidationError({"value": exc})
 
     def check_unique_record(self, new_zone=None):
         if not get_plugin_config("netbox_dns", "enforce_unique_records", False):
@@ -585,7 +619,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():
@@ -599,9 +633,13 @@ class Record(ObjectModificationMixin, ContactsMixin, NetBoxModel):
 
             raise ValidationError(
                 {
-                    "value": f"There is already an active {self.type} record for name {self.name} in zone {self.zone} with value {self.value}."
+                    "value": _(
+                        "There is already an active {type} record for name {name} in zone {zone} with value {value}."
+                    ).format(
+                        type=self.type, name=self.name, zone=self.zone, value=self.value
+                    )
                 }
-            ) from None
+            )
 
     def handle_conflicting_address_records(self):
         if self.ipam_ip_address is None or not self.is_active:
@@ -624,7 +662,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):
@@ -658,12 +696,19 @@ class Record(ObjectModificationMixin, ContactsMixin, NetBoxModel):
         conflicting_ttls = ", ".join({str(record.ttl) for record in records})
         raise ValidationError(
             {
-                "ttl": f"There is at least one active {self.type} record for name {self.name} in zone {self.zone} and TTL is different ({conflicting_ttls})."
+                "ttl": _(
+                    "There is at least one active {type} record for name {name} in zone {zone} and TTL is different ({ttls})."
+                ).format(
+                    type=self.type,
+                    name=self.name,
+                    zone=self.zone,
+                    ttls=conflicting_ttls,
+                )
             }
-        ) 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 +744,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:
@@ -738,24 +783,30 @@ class Record(ObjectModificationMixin, ContactsMixin, NetBoxModel):
                 ):
                     raise ValidationError(
                         {
-                            "value": f"There is already an active record for name {ptr_cname_name} in zone {ptr_cname_zone}, RFC2317 CNAME is not allowed."
+                            "value": _(
+                                "There is already an active record for name {name} in zone {zone}, RFC2317 CNAME is not allowed."
+                            ).format(name=ptr_cname_name, zone=ptr_cname_zone)
                         }
-                    ) from None
+                    )
 
         if self.type == RecordTypeChoices.SOA and self.name != "@":
             raise ValidationError(
                 {
-                    "name": "SOA records are only allowed with name @ and are created automatically by NetBox DNS"
+                    "name": _(
+                        "SOA records are only allowed with name @ and are created automatically by NetBox DNS"
+                    )
                 }
-            ) from None
+            )
 
         if self.type == RecordTypeChoices.CNAME:
             if records.exclude(type=RecordTypeChoices.NSEC).exists():
                 raise ValidationError(
                     {
-                        "type": f"There is already an active record for name {self.name} in zone {self.zone}, CNAME is not allowed."
+                        "type": _(
+                            "There is already an active record for name {name} in zone {zone}, CNAME is not allowed."
+                        ).format(name=self.name, zone=self.zone)
                     }
-                ) from None
+                )
 
         elif (
             records.filter(type=RecordTypeChoices.CNAME).exists()
@@ -763,17 +814,21 @@ class Record(ObjectModificationMixin, ContactsMixin, NetBoxModel):
         ):
             raise ValidationError(
                 {
-                    "type": f"There is already an active CNAME record for name {self.name} in zone {self.zone}, no other record allowed."
+                    "type": _(
+                        "There is already an active CNAME record for name {name} in zone {zone}, no other record allowed."
+                    ).format(name=self.name, zone=self.zone)
                 }
-            ) from None
+            )
 
         elif self.type in RecordTypeChoices.SINGLETONS:
             if records.filter(type=self.type).exists():
                 raise ValidationError(
                     {
-                        "type": f"There is already an active {self.type} record for name {self.name} in zone {self.zone}, more than one are not allowed."
+                        "type": _(
+                            "There is already an active {type} record for name {name} in zone {zone}, more than one are not allowed."
+                        ).format(type=self.type, name=self.name, zone=self.zone)
                     }
-                ) from None
+                )
 
         super().clean(*args, **kwargs)
 
@@ -787,7 +842,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_dns/models/record_template.py

@@ -4,6 +4,7 @@ from dns import name as dns_name
 from django.core.exceptions import ValidationError
 from django.db import models
 from django.urls import reverse
+from django.utils.translation import gettext_lazy as _
 
 from netbox.models import NetBoxModel
 from netbox.search import SearchIndex, register_search
@@ -23,40 +24,45 @@ __all__ = (
 
 class RecordTemplate(NetBoxModel):
     name = models.CharField(
-        verbose_name="Template name",
+        verbose_name=_("Template Name"),
         unique=True,
         max_length=200,
     )
     record_name = models.CharField(
-        verbose_name="Name",
+        verbose_name=_("Name"),
         max_length=255,
     )
     description = models.CharField(
+        verbose_name=_("Description"),
         max_length=200,
         blank=True,
     )
     type = models.CharField(
+        verbose_name=_("Type"),
         choices=RecordTypeChoices,
     )
     value = models.CharField(
+        verbose_name=_("Value"),
         max_length=65535,
     )
     status = models.CharField(
+        verbose_name=_("Status"),
         choices=RecordStatusChoices,
         default=RecordStatusChoices.STATUS_ACTIVE,
         blank=False,
     )
     ttl = models.PositiveIntegerField(
-        verbose_name="TTL",
+        verbose_name=_("TTL"),
         null=True,
         blank=True,
     )
     disable_ptr = models.BooleanField(
-        verbose_name="Disable PTR",
-        help_text="Disable PTR record creation",
+        verbose_name=_("Disable PTR"),
+        help_text=_("Disable PTR record creation"),
         default=False,
     )
     tenant = models.ForeignKey(
+        verbose_name=_("Tenant"),
         to="tenancy.Tenant",
         on_delete=models.PROTECT,
         related_name="+",
@@ -85,8 +91,8 @@ class RecordTemplate(NetBoxModel):
     )
 
     class Meta:
-        verbose_name = "Record Template"
-        verbose_name_plural = "Record Templates"
+        verbose_name = _("Record Template")
+        verbose_name_plural = _("Record Templates")
 
         ordering = ("name",)
 
@@ -155,7 +161,9 @@ class RecordTemplate(NetBoxModel):
             record = Record.objects.create(**record_data)
         except ValidationError as exc:
             raise ValidationError(
-                f"Error while processing record template {self}: {exc.messages[0]}"
+                _("Error while processing record template {template}: {error}").format(
+                    template=self, error=exc.messages[0]
+                )
             )
 
         if tags := self.tags.all():

netbox_dns/models/registrar.py

@@ -1,5 +1,6 @@
 from django.db import models
 from django.urls import reverse
+from django.utils.translation import gettext_lazy as _
 
 from netbox.models import NetBoxModel
 from netbox.search import SearchIndex, register_search
@@ -16,38 +17,41 @@ class Registrar(NetBoxModel):
     # Data fields according to https://www.icann.org/resources/pages/rdds-labeling-policy-2017-02-01-en
     # -
     name = models.CharField(
+        verbose_name=_("Name"),
         unique=True,
         max_length=255,
     )
     description = models.CharField(
+        verbose_name=_("Description"),
         blank=True,
         max_length=200,
     )
     iana_id = models.IntegerField(
-        verbose_name="IANA ID",
+        verbose_name=_("IANA ID"),
         null=True,
         blank=True,
     )
     referral_url = models.URLField(
-        verbose_name="Referral URL",
+        verbose_name=_("Referral URL"),
         max_length=255,
         blank=True,
     )
     whois_server = models.CharField(
-        verbose_name="WHOIS Server",
+        verbose_name=_("WHOIS Server"),
         max_length=255,
         blank=True,
     )
     address = models.CharField(
+        verbose_name=_("Address"),
         max_length=200,
         blank=True,
     )
     abuse_email = models.EmailField(
-        verbose_name="Abuse Email",
+        verbose_name=_("Abuse Email"),
         blank=True,
     )
     abuse_phone = models.CharField(
-        verbose_name="Abuse Phone",
+        verbose_name=_("Abuse Phone"),
         max_length=50,
         blank=True,
     )
@@ -59,8 +63,8 @@ class Registrar(NetBoxModel):
         return str(self.name)
 
     class Meta:
-        verbose_name = "Registrar"
-        verbose_name_plural = "Registrars"
+        verbose_name = _("Registrar")
+        verbose_name_plural = _("Registrars")
 
         ordering = (
             "name",

netbox_dns/models/registration_contact.py

@@ -1,5 +1,6 @@
 from django.db import models
 from django.urls import reverse
+from django.utils.translation import gettext_lazy as _
 
 from netbox.models import NetBoxModel
 from netbox.search import SearchIndex, register_search
@@ -18,70 +19,81 @@ class RegistrationContact(NetBoxModel):
     # Data fields according to https://www.icann.org/resources/pages/rdds-labeling-policy-2017-02-01-en
     # -
     contact_id = models.CharField(
-        verbose_name="Contact ID",
+        verbose_name=_("Contact ID"),
         max_length=50,
         unique=True,
     )
     name = models.CharField(
+        verbose_name=_("Name"),
         blank=True,
         max_length=100,
     )
     description = models.CharField(
+        verbose_name=_("Description"),
         blank=True,
         max_length=200,
     )
     organization = models.CharField(
+        verbose_name=_("Organization"),
         blank=True,
         max_length=200,
     )
     street = models.CharField(
+        verbose_name=_("Street"),
         blank=True,
         max_length=50,
     )
     city = models.CharField(
+        verbose_name=_("City"),
         blank=True,
         max_length=50,
     )
     state_province = models.CharField(
-        verbose_name="State/Province",
+        verbose_name=_("State/Province"),
         blank=True,
         max_length=255,
     )
     postal_code = models.CharField(
-        verbose_name="Postal Code",
+        verbose_name=_("Postal Code"),
         blank=True,
         max_length=20,
     )
     country = models.CharField(
-        verbose_name="Country (ISO 3166)",
+        verbose_name=_("Country (ISO 3166)"),
         blank=True,
         max_length=2,
     )
     phone = models.CharField(
-        verbose_name="Phone",
+        verbose_name=_("Phone"),
         blank=True,
         max_length=50,
     )
     phone_ext = models.CharField(
-        verbose_name="Phone Extension",
+        verbose_name=_("Phone Extension"),
         blank=True,
         max_length=50,
     )
     fax = models.CharField(
-        verbose_name="Fax",
+        verbose_name=_("Fax"),
         blank=True,
         max_length=50,
     )
     fax_ext = models.CharField(
-        verbose_name="Fax Extension",
+        verbose_name=_("Fax Extension"),
         blank=True,
         max_length=50,
     )
     email = models.EmailField(
-        verbose_name="Email",
+        verbose_name=_("Email"),
         blank=True,
     )
 
+    # +
+    # TODO: Retained for backwards compatibility with older versions where
+    # 'RegistrationContact' was still ambiguously named 'Contact'.
+    #
+    # Removing it requires a data migration.
+    # -
     tags = TaggableManager(
         through="extras.TaggedItem",
         related_name="netbox_dns_contact_set",
@@ -114,8 +126,8 @@ class RegistrationContact(NetBoxModel):
         return self.contact_id
 
     class Meta:
-        verbose_name = "Registration Contact"
-        verbose_name_plural = "Registration Contacts"
+        verbose_name = _("Registration Contact")
+        verbose_name_plural = _("Registration Contacts")
 
         ordering = (
             "name",