mirror of
https://github.com/netbox-community/netbox.git
synced 2025-12-19 03:42:25 -06:00
9e75a2f955
Add `get_internal_type()` to custom field classes for Django compatibility, annotate path parameters and operation IDs for background endpoints, and provide serializer context on the RQ base viewset to clear schema warnings. Fixes #20365
129 lines
3.9 KiB
Python
129 lines
3.9 KiB
Python
from django.core.exceptions import ValidationError
|
|
from django.core.validators import MinValueValidator, MaxValueValidator
|
|
from django.db import models
|
|
from django.utils.translation import gettext as _
|
|
from netaddr import AddrFormatError, IPNetwork
|
|
|
|
from . import lookups, validators
|
|
from .formfields import IPNetworkFormField
|
|
|
|
__all__ = (
|
|
'ASNField',
|
|
'IPAddressField',
|
|
'IPNetworkField',
|
|
)
|
|
|
|
# BGP ASN bounds
|
|
BGP_ASN_MIN = 1
|
|
BGP_ASN_MAX = 2**32 - 1
|
|
|
|
|
|
class BaseIPField(models.Field):
|
|
|
|
def python_type(self):
|
|
return IPNetwork
|
|
|
|
def from_db_value(self, value, expression, connection):
|
|
return self.to_python(value)
|
|
|
|
def get_internal_type(self):
|
|
return 'CharField'
|
|
|
|
def to_python(self, value):
|
|
if not value:
|
|
return value
|
|
try:
|
|
# Always return a netaddr.IPNetwork object. (netaddr.IPAddress does not provide a mask.)
|
|
return IPNetwork(value)
|
|
except AddrFormatError:
|
|
raise ValidationError(_("Invalid IP address format: {address}").format(address=value))
|
|
except (TypeError, ValueError) as e:
|
|
raise ValidationError(e)
|
|
|
|
def get_prep_value(self, value):
|
|
if not value:
|
|
return None
|
|
if isinstance(value, list):
|
|
return [str(self.to_python(v)) for v in value]
|
|
return str(self.to_python(value))
|
|
|
|
def form_class(self):
|
|
return IPNetworkFormField
|
|
|
|
def formfield(self, **kwargs):
|
|
defaults = {'form_class': self.form_class()}
|
|
defaults.update(kwargs)
|
|
return super().formfield(**defaults)
|
|
|
|
|
|
class IPNetworkField(BaseIPField):
|
|
"""
|
|
IP prefix (network and mask)
|
|
"""
|
|
description = 'PostgreSQL CIDR field'
|
|
default_validators = [validators.prefix_validator]
|
|
|
|
def db_type(self, connection):
|
|
return 'cidr'
|
|
|
|
|
|
IPNetworkField.register_lookup(lookups.IExact)
|
|
IPNetworkField.register_lookup(lookups.EndsWith)
|
|
IPNetworkField.register_lookup(lookups.IEndsWith)
|
|
IPNetworkField.register_lookup(lookups.StartsWith)
|
|
IPNetworkField.register_lookup(lookups.IStartsWith)
|
|
IPNetworkField.register_lookup(lookups.Regex)
|
|
IPNetworkField.register_lookup(lookups.IRegex)
|
|
IPNetworkField.register_lookup(lookups.NetContained)
|
|
IPNetworkField.register_lookup(lookups.NetContainedOrEqual)
|
|
IPNetworkField.register_lookup(lookups.NetContains)
|
|
IPNetworkField.register_lookup(lookups.NetContainsOrEquals)
|
|
IPNetworkField.register_lookup(lookups.NetFamily)
|
|
IPNetworkField.register_lookup(lookups.NetMaskLength)
|
|
|
|
|
|
class IPAddressField(BaseIPField):
|
|
"""
|
|
IP address (host address and mask)
|
|
"""
|
|
description = 'PostgreSQL INET field'
|
|
|
|
def db_type(self, connection):
|
|
return 'inet'
|
|
|
|
|
|
IPAddressField.register_lookup(lookups.IExact)
|
|
IPAddressField.register_lookup(lookups.EndsWith)
|
|
IPAddressField.register_lookup(lookups.IEndsWith)
|
|
IPAddressField.register_lookup(lookups.StartsWith)
|
|
IPAddressField.register_lookup(lookups.IStartsWith)
|
|
IPAddressField.register_lookup(lookups.Regex)
|
|
IPAddressField.register_lookup(lookups.IRegex)
|
|
IPAddressField.register_lookup(lookups.NetContained)
|
|
IPAddressField.register_lookup(lookups.NetContainedOrEqual)
|
|
IPAddressField.register_lookup(lookups.NetContains)
|
|
IPAddressField.register_lookup(lookups.NetContainsOrEquals)
|
|
IPAddressField.register_lookup(lookups.NetHost)
|
|
IPAddressField.register_lookup(lookups.NetIn)
|
|
IPAddressField.register_lookup(lookups.NetHostContained)
|
|
IPAddressField.register_lookup(lookups.NetFamily)
|
|
IPAddressField.register_lookup(lookups.NetMaskLength)
|
|
IPAddressField.register_lookup(lookups.Host)
|
|
IPAddressField.register_lookup(lookups.Inet)
|
|
|
|
|
|
class ASNField(models.BigIntegerField):
|
|
description = '32-bit ASN field'
|
|
default_validators = [
|
|
MinValueValidator(BGP_ASN_MIN),
|
|
MaxValueValidator(BGP_ASN_MAX),
|
|
]
|
|
|
|
def formfield(self, **kwargs):
|
|
defaults = {
|
|
'min_value': BGP_ASN_MIN,
|
|
'max_value': BGP_ASN_MAX,
|
|
}
|
|
defaults.update(**kwargs)
|
|
return super().formfield(**defaults)
|