1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
|
from django.core.exceptions import ValidationError
from django.db import models
from ipaddress import ip_interface, ip_network
from netaddr import EUI
from netaddr.core import AddrFormatError
from netfields.compat import DatabaseWrapper, is_psycopg3
from netfields.forms import (
InetAddressFormField,
NoPrefixInetAddressFormField,
CidrAddressFormField,
MACAddressFormField,
MACAddress8FormField
)
from netfields.mac import mac_unix_common, mac_eui64
if is_psycopg3:
from netfields.psycopg3_types import Inet, Macaddr, Macaddr8
else:
from netfields.psycopg2_types import Inet, Macaddr, Macaddr8
NET_OPERATORS = DatabaseWrapper.operators.copy()
for operator in ['contains', 'startswith', 'endswith']:
NET_OPERATORS[operator] = 'ILIKE %s'
NET_OPERATORS['i%s' % operator] = 'ILIKE %s'
NET_OPERATORS['iexact'] = NET_OPERATORS['exact']
NET_OPERATORS['regex'] = NET_OPERATORS['iregex']
NET_OPERATORS['net_contained'] = '<< %s'
NET_OPERATORS['net_contained_or_equal'] = '<<= %s'
NET_OPERATORS['net_contains'] = '>> %s'
NET_OPERATORS['net_contains_or_equals'] = '>>= %s'
NET_OPERATORS['net_overlaps'] = '&& %s'
NET_OPERATORS['max_prefixlen'] = '%s'
NET_OPERATORS['min_prefixlen'] = '%s'
NET_TEXT_OPERATORS = ['ILIKE %s', '~* %s']
class _NetAddressField(models.Field):
empty_strings_allowed = False
def __init__(self, *args, **kwargs):
kwargs['max_length'] = self.max_length
super(_NetAddressField, self).__init__(*args, **kwargs)
def from_db_value(self, value, expression, connection, *args):
if isinstance(value, list):
# Aggregation detected, return a list of values. This is no longer
# necessary in Django 2.1
return [self.to_python(v) for v in value]
return self.to_python(value)
def to_python(self, value):
if not value:
return value
if isinstance(value, bytes):
value = value.decode('ascii')
try:
return self.python_type()(value)
except ValueError as e:
raise ValidationError(e)
def get_prep_lookup(self, lookup_type, value):
if hasattr(value, '_prepare'):
try:
# Django 1.8
return value._prepare()
except TypeError:
# Django 1.9
return value._prepare(self)
if (lookup_type in NET_OPERATORS and
NET_OPERATORS[lookup_type] not in NET_TEXT_OPERATORS):
if (lookup_type.startswith('net_') or
lookup_type.endswith('prefixlen')) and value is not None:
return str(value)
return self.get_prep_value(value)
return super(_NetAddressField, self).get_prep_lookup(
lookup_type, value)
def get_prep_value(self, value):
if not value:
return None
return str(self.to_python(value))
def get_db_prep_value(self, value, connection, prepared=False):
if value is None:
return None
if self.model._meta.get_field(self.name).get_internal_type() == 'ArrayField':
is_array_field = True
else:
is_array_field = False
if prepared is False and is_array_field is False:
return self.get_prep_value(value)
return Inet(self.get_prep_value(value))
def get_db_prep_lookup(self, lookup_type, value, connection,
prepared=False):
if not value:
return []
if (lookup_type in NET_OPERATORS and
NET_OPERATORS[lookup_type] not in NET_TEXT_OPERATORS):
if prepared:
return [value]
if (lookup_type.startswith('net_') or
lookup_type.endswith('prefixlen')) and value is not None:
return str(value)
return [self.get_prep_value(value)]
return super(_NetAddressField, self).get_db_prep_lookup(
lookup_type, value, connection=connection, prepared=prepared)
def get_placeholder(self, value, compiler, connection):
return "%s::{}".format(self.db_type(connection))
def formfield(self, **kwargs):
defaults = {'form_class': self.form_class()}
defaults.update(kwargs)
return super(_NetAddressField, self).formfield(**defaults)
def deconstruct(self):
name, path, args, kwargs = super(_NetAddressField, self).deconstruct()
if self.max_length is not None:
kwargs['max_length'] = self.max_length
return name, path, args, kwargs
class InetAddressField(_NetAddressField):
description = "PostgreSQL INET field"
max_length = 39
def __init__(self, *args, **kwargs):
self.store_prefix_length = kwargs.pop('store_prefix_length', True)
super(InetAddressField, self).__init__(*args, **kwargs)
def db_type(self, connection):
return 'inet'
def python_type(self):
return ip_interface
def to_python(self, value):
value = super(InetAddressField, self).to_python(value)
if value:
if self.store_prefix_length:
return value
else:
return value.ip
return value
def form_class(self):
if self.store_prefix_length:
return InetAddressFormField
return NoPrefixInetAddressFormField
class CidrAddressField(_NetAddressField):
description = "PostgreSQL CIDR field"
max_length = 43
python_type = ip_network
def db_type(self, connection):
return 'cidr'
def python_type(self):
return ip_network
def form_class(self):
return CidrAddressFormField
class MACAddressField(models.Field):
description = "PostgreSQL MACADDR field"
max_length = 17
def db_type(self, connection):
return 'macaddr'
def from_db_value(self, value, expression, connection, *args):
return self.to_python(value)
def to_python(self, value):
if not value:
return value
try:
return EUI(value, version=48, dialect=mac_unix_common)
except (AddrFormatError, IndexError, TypeError) as e:
raise ValidationError(e)
def get_prep_value(self, value):
if not value:
return None
return str(self.to_python(value))
def get_db_prep_value(self, value, connection, prepared=False):
if value is None:
return None
if self.model._meta.get_field(self.name).get_internal_type() == 'ArrayField':
is_array_field = True
else:
is_array_field = False
if prepared is False and is_array_field is False:
return self.get_prep_value(value)
return Macaddr(self.get_prep_value(value))
def formfield(self, **kwargs):
defaults = {'form_class': MACAddressFormField}
defaults.update(kwargs)
return super(MACAddressField, self).formfield(**defaults)
class MACAddress8Field(models.Field):
"""A MAC Address field with 8 bytes"""
description = "PostgreSQL MACADDR8 field"
max_length = 23
def db_type(self, connection):
return "macaddr8"
def from_db_value(self, value, expression, connection, *args):
return self.to_python(value)
def to_python(self, value):
if not value:
return value
try:
mac = EUI(value, dialect=mac_eui64)
if mac.version == 64:
return mac
mac = mac.eui64()
mac.dialect = mac_eui64
return mac
except (AddrFormatError, IndexError, TypeError) as e:
raise ValidationError(e)
def get_prep_value(self, value):
if not value:
return None
return str(self.to_python(value))
def get_db_prep_value(self, value, connection, prepared=False):
if value is None:
return None
if self.model._meta.get_field(self.name).get_internal_type() == 'ArrayField':
is_array_field = True
else:
is_array_field = False
if prepared is False and is_array_field is False:
return self.get_prep_value(value)
return Macaddr8(self.get_prep_value(value))
def formfield(self, **kwargs):
defaults = {'form_class': MACAddress8FormField}
defaults.update(kwargs)
return super(MACAddress8Field, self).formfield(**defaults)
|