Ticket #811: ipv46address.diff

docs/topics/forms/modelforms.txt

@@ -83 +83 @@
 
     ``IPAddressField``               ``IPAddressField``
 
+    ``IPv46AddressField``            ``IPv46AddressField``
+
     ``ManyToManyField``              ``ModelMultipleChoiceField`` (see
                                      below)
 

docs/ref/models/fields.txt

@@ -755 +755 @@
 An IP address, in string format (e.g. "192.0.2.30"). The admin represents this
 as an ``<input type="text">`` (a single-line input).
 
+``IPv46AddressField``
+---------------------
+
+.. class:: IPv46AddressField([**options])
+
+.. versionadded:: 1.4
+
+An IPv4 or IPv6 address, in string format (e.g. "192.0.2.30" or "2a02:42fe::4") 
+The admin represents this as an ``<input type="text">`` (a single-line input).
+
 ``NullBooleanField``
 --------------------
 

docs/ref/forms/fields.txt

@@ -622 +622 @@
       expression.
     * Error message keys: ``required``, ``invalid``
 
+``IPv46AddressField``
+~~~~~~~~~~~~~~~~~~~~~
+
+.. class:: IPv46AddressField(**kwargs)
+
+.. versionadded:: 1.4
+
+A field containing either an IPv4 or an IPv6 address.
+
+    * Default widget: ``TextInput``
+    * Empty value: ``''`` (an empty string)
+    * Normalizes to: A Unicode object. By default, IPv6 addresses are
+      normalized as described below.
+    * Validates that the given value is a valid IP address, using regular
+      expressions.
+    * Error message keys: ``required``, ``invalid``
+
+The IPv6 address normalisation follows `RFC4291 section 2.2`_, including using
+the IPv4 format suggested in paragraph 3 of that section. For example,
+``2001:0::0:01`` would be compressed to ``2001::1`` and ``::0a0a:0a0a``
+to ``::10.10.10.10``. This behaviour can be disabled by setting the
+``skip_ipv6_normalisation`` attribute.
+
+.. _RFC4291 section 2.2: http://tools.ietf.org/html/rfc4291#section-2.2
+
+Takes three optional arguments:
+
+.. attribute:: IPv46AddressField.skip_ipv6_normalisation
+
+    Disables the IPv6 address normalisation described above.
+
+.. attribute:: IPv46AddressField.only_ipv4
+
+    Limits valid inputs to only IPv4 addresses
+
+.. attribute:: IPv46AddressField.only_ipv6
+
+    Limits valid inputs to only IPv6 addresses
+
+Setting both ``only_ipv4`` and ``only_ipv6`` is invalid.
+
 ``MultipleChoiceField``
 ~~~~~~~~~~~~~~~~~~~~~~~
 

django/db/models/fields/__init__.py

@@ -919 +919 @@
 
 class IPAddressField(Field):
     empty_strings_allowed = False
-    description = _("IP address")
+    description = _("IPv4 address")
     def __init__(self, *args, **kwargs):
         kwargs['max_length'] = 15
         Field.__init__(self, *args, **kwargs)
@@ -932 +932 @@
         defaults.update(kwargs)
         return super(IPAddressField, self).formfield(**defaults)
 
+class IPv46AddressField(Field):
+    empty_strings_allowed = False
+    description = _("IP address")
+    def __init__(self, *args, **kwargs):
+        kwargs['max_length'] = 39
+        Field.__init__(self, *args, **kwargs)
+
+    def get_internal_type(self):
+        return "IPv46AddressField"
+
+    def formfield(self, **kwargs):
+        defaults = {'form_class': forms.IPv46AddressField}
+        defaults.update(kwargs)
+        return super(IPv46AddressField, self).formfield(**defaults)
+
 class NullBooleanField(Field):
     empty_strings_allowed = False
     default_error_messages = {

django/db/backends/sqlite3/creation.py

@@ -20 +20 @@
         'IntegerField':                 'integer',
         'BigIntegerField':              'bigint',
         'IPAddressField':               'char(15)',
+        'IPv46AddressField':            'char(39)',
         'NullBooleanField':             'bool',
         'OneToOneField':                'integer',
         'PositiveIntegerField':         'integer unsigned',

django/db/backends/mysql/creation.py

@@ -19 +19 @@
         'IntegerField':      'integer',
         'BigIntegerField':   'bigint',
         'IPAddressField':    'char(15)',
+        'IPv46AddressField': 'char(39)',
         'NullBooleanField':  'bool',
         'OneToOneField':     'integer',
         'PositiveIntegerField': 'integer UNSIGNED',

django/db/backends/oracle/creation.py

@@ -27 +27 @@
         'IntegerField':                 'NUMBER(11)',
         'BigIntegerField':              'NUMBER(19)',
         'IPAddressField':               'VARCHAR2(15)',
+        'IPv46AddressField':            'VARCHAR2(39)',
         'NullBooleanField':             'NUMBER(1) CHECK ((%(qn_column)s IN (0,1)) OR (%(qn_column)s IS NULL))',
         'OneToOneField':                'NUMBER(11)',
         'PositiveIntegerField':         'NUMBER(11) CHECK (%(qn_column)s >= 0)',

django/db/backends/postgresql_psycopg2/introspection.py

@@ -12 +12 @@
         700: 'FloatField',
         701: 'FloatField',
         869: 'IPAddressField',
+        869: 'IPv46AddressField',
         1043: 'CharField',
         1082: 'DateField',
         1083: 'TimeField',

django/db/backends/postgresql_psycopg2/creation.py

@@ -21 +21 @@
         'IntegerField':      'integer',
         'BigIntegerField':   'bigint',
         'IPAddressField':    'inet',
+        'IPv6AddressField':  'inet',
         'NullBooleanField':  'boolean',
         'OneToOneField':     'integer',
         'PositiveIntegerField': 'integer CHECK ("%(column)s" >= 0)',

django/forms/fields.py

@@ -9 +9 @@
 import time
 import urlparse
 import warnings
+import socket
 from decimal import Decimal, DecimalException
 try:
     from cStringIO import StringIO
@@ -37 +38 @@
     'RegexField', 'EmailField', 'FileField', 'ImageField', 'URLField',
     'BooleanField', 'NullBooleanField', 'ChoiceField', 'MultipleChoiceField',
     'ComboField', 'MultiValueField', 'FloatField', 'DecimalField',
-    'SplitDateTimeField', 'IPAddressField', 'FilePathField', 'SlugField',
-    'TypedChoiceField', 'TypedMultipleChoiceField'
+    'SplitDateTimeField', 'IPAddressField', 'IPv46AddressField', 'FilePathField',
+    'SlugField', 'TypedChoiceField', 'TypedMultipleChoiceField'
 )
 
 
@@ -947 +948 @@
     default_validators = [validators.validate_ipv4_address]
 
 
+class IPv46AddressField(CharField):
+    def __init__(self, only_ipv4=False, only_ipv6=False, skip_ipv6_normalisation=False, *args, **kwargs):
+        self.skip_ipv6_normalisation = skip_ipv6_normalisation
+
+        if only_ipv4 and only_ipv6:
+            raise ValueError(
+                "You can not simultaniously use both only_ipv4 and only_ipv6 on an IPv46AddressField - "
+                "it would generate a field that could never validate")
+
+        self.default_validators = [validators.validate_ipv46_address]
+        self.default_error_messages['invalid'] = _(u'Enter a valid IP address.')
+
+        if only_ipv4:
+            self.default_validators = [validators.validate_ipv4_address]
+            self.default_error_messages['invalid'] = _(u'Enter a valid IPv4 address.')
+
+        if only_ipv6:
+            self.default_validators = [validators.validate_ipv6_address]
+            self.default_error_messages['invalid'] = _(u'Enter a valid IPv6 address.')
+            
+        super(IPv46AddressField, self).__init__(*args, **kwargs)
+        
+    def to_python(self, value):
+        "Try to normalize the address using getaddrinfo"
+        if not value:
+            return ''
+        
+        if self.skip_ipv6_normalisation:
+            return value
+            
+        try:
+            new_value = socket.getaddrinfo(value, None, 0, 0, 0, socket.AI_NUMERICHOST)[0][4][0]
+            return new_value
+        except socket.gaierror:
+            return value
+        
+    default_error_messages = {}
+    
+
 class SlugField(CharField):
     default_error_messages = {
         'invalid': _(u"Enter a valid 'slug' consisting of letters, numbers,"

django/core/validators.py

@@ -143 +143 @@
 ipv4_re = re.compile(r'^(25[0-5]|2[0-4]\d|[0-1]?\d?\d)(\.(25[0-5]|2[0-4]\d|[0-1]?\d?\d)){3}$')
 validate_ipv4_address = RegexValidator(ipv4_re, _(u'Enter a valid IPv4 address.'), 'invalid')
 
+ipv6_re = re.compile(r'^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?$')
+validate_ipv6_address = RegexValidator(ipv6_re, _(u'Enter a valid IPv6 address.'), 'invalid')
+
+def validate_ipv46_address(value): 
+    try: 
+        validate_ipv4_address(value) 
+    except ValidationError: 
+        try: 
+            validate_ipv6_address(value) 
+        except ValidationError: 
+            raise ValidationError(_(u'Enter a valid IP address.'), code='invalid')
+            
 comma_separated_int_list_re = re.compile('^[\d,]+$')
 validate_comma_separated_integer_list = RegexValidator(comma_separated_int_list_re, _(u'Enter only digits separated by commas.'), 'invalid')
 

tests/regressiontests/forms/tests/error_messages.py

@@ -196 +196 @@
         self.assertFormErrors([u'REQUIRED'], f.clean, '')
         self.assertFormErrors([u'INVALID IP ADDRESS'], f.clean, '127.0.0')
 
+    def test_ipv46addressfield(self):
+        e = {
+            'required': 'REQUIRED',
+            'invalid': 'INVALID IP ADDRESS',
+        }
+        f = IPv46AddressField(error_messages=e)
+        self.assertFormErrors([u'REQUIRED'], f.clean, '')
+        self.assertFormErrors([u'INVALID IP ADDRESS'], f.clean, '127.0.0')
+
     def test_subclassing_errorlist(self):
         class TestForm(Form):
             first_name = CharField()

tests/regressiontests/forms/tests/extra.py

@@ -460 +460 @@
         self.assertFormErrors([u'Enter a valid IPv4 address.'], f.clean, '1.2.3.4.5')
         self.assertFormErrors([u'Enter a valid IPv4 address.'], f.clean, '256.125.1.5')
 
+
+    def test_ipv46address(self):
+        f = IPv46AddressField()
+        self.assertFormErrors([u'This field is required.'], f.clean, '')
+        self.assertFormErrors([u'This field is required.'], f.clean, None)
+        self.assertEqual(f.clean('127.0.0.1'), u'127.0.0.1')
+        self.assertFormErrors([u'Enter a valid IP address.'], f.clean, 'foo')
+        self.assertFormErrors([u'Enter a valid IP address.'], f.clean, '127.0.0.')
+        self.assertFormErrors([u'Enter a valid IP address.'], f.clean, '1.2.3.4.5')
+        self.assertFormErrors([u'Enter a valid IP address.'], f.clean, '256.125.1.5')
+        self.assertEqual(f.clean('fe80::223:6cff:fe8a:2e8a'), u'fe80::223:6cff:fe8a:2e8a')
+        self.assertEqual(f.clean('2a02::223:6cff:fe8a:2e8a'), u'2a02::223:6cff:fe8a:2e8a')
+        self.assertFormErrors([u'Enter a valid IP address.'], f.clean, 'foo')
+        self.assertFormErrors([u'Enter a valid IP address.'], f.clean, '12345:2:3:4')
+        self.assertFormErrors([u'Enter a valid IP address.'], f.clean, '1::2:3::4')
+        self.assertFormErrors([u'Enter a valid IP address.'], f.clean, 'foo::223:6cff:fe8a:2e8a')
+        self.assertFormErrors([u'Enter a valid IP address.'], f.clean, '1::2:3:4:5:6:7:8')
+        self.assertFormErrors([u'Enter a valid IP address.'], f.clean, '1:2')
+        
+        f = IPv46AddressField(only_ipv4=True)
+        self.assertFormErrors([u'This field is required.'], f.clean, '')
+        self.assertFormErrors([u'This field is required.'], f.clean, None)
+        self.assertEqual(f.clean('127.0.0.1'), u'127.0.0.1')
+        self.assertFormErrors([u'Enter a valid IPv4 address.'], f.clean, 'foo')
+        self.assertFormErrors([u'Enter a valid IPv4 address.'], f.clean, '127.0.0.')
+        self.assertFormErrors([u'Enter a valid IPv4 address.'], f.clean, '1.2.3.4.5')
+        self.assertFormErrors([u'Enter a valid IPv4 address.'], f.clean, '256.125.1.5')
+        self.assertFormErrors([u'Enter a valid IPv4 address.'], f.clean, 'fe80::223:6cff:fe8a:2e8a')
+        self.assertFormErrors([u'Enter a valid IPv4 address.'], f.clean, '2a02::223:6cff:fe8a:2e8a')
+        self.assertFormErrors([u'Enter a valid IPv4 address.'], f.clean, 'foo')
+        self.assertFormErrors([u'Enter a valid IPv4 address.'], f.clean, '12345:2:3:4')
+        self.assertFormErrors([u'Enter a valid IPv4 address.'], f.clean, '1::2:3::4')
+        self.assertFormErrors([u'Enter a valid IPv4 address.'], f.clean, 'foo::223:6cff:fe8a:2e8a')
+        self.assertFormErrors([u'Enter a valid IPv4 address.'], f.clean, '1::2:3:4:5:6:7:8')
+        self.assertFormErrors([u'Enter a valid IPv4 address.'], f.clean, '1:2')
+                
+        f = IPv46AddressField(only_ipv6=True)
+        self.assertFormErrors([u'This field is required.'], f.clean, '')
+        self.assertFormErrors([u'This field is required.'], f.clean, None)
+        self.assertFormErrors([u'Enter a valid IPv6 address.'], f.clean, '127.0.0.1')
+        self.assertFormErrors([u'Enter a valid IPv6 address.'], f.clean, 'foo')
+        self.assertFormErrors([u'Enter a valid IPv6 address.'], f.clean, '127.0.0.')
+        self.assertFormErrors([u'Enter a valid IPv6 address.'], f.clean, '1.2.3.4.5')
+        self.assertFormErrors([u'Enter a valid IPv6 address.'], f.clean, '256.125.1.5')
+        self.assertEqual(f.clean('fe80::223:6cff:fe8a:2e8a'), u'fe80::223:6cff:fe8a:2e8a')
+        self.assertEqual(f.clean('2a02::223:6cff:fe8a:2e8a'), u'2a02::223:6cff:fe8a:2e8a')
+        self.assertFormErrors([u'Enter a valid IPv6 address.'], f.clean, 'foo')
+        self.assertFormErrors([u'Enter a valid IPv6 address.'], f.clean, '12345:2:3:4')
+        self.assertFormErrors([u'Enter a valid IPv6 address.'], f.clean, '1::2:3::4')
+        self.assertFormErrors([u'Enter a valid IPv6 address.'], f.clean, 'foo::223:6cff:fe8a:2e8a')
+        self.assertFormErrors([u'Enter a valid IPv6 address.'], f.clean, '1::2:3:4:5:6:7:8')
+        self.assertFormErrors([u'Enter a valid IPv6 address.'], f.clean, '1:2')
+
+        f = IPv46AddressField(required=False)
+        self.assertEqual(f.clean(''), u'')
+        self.assertEqual(f.clean(None), u'')
+        self.assertEqual(f.clean('127.0.0.1'), u'127.0.0.1')
+        self.assertFormErrors([u'Enter a valid IP address.'], f.clean, 'foo')
+        self.assertFormErrors([u'Enter a valid IP address.'], f.clean, '127.0.0.')
+        self.assertFormErrors([u'Enter a valid IP address.'], f.clean, '1.2.3.4.5')
+        self.assertFormErrors([u'Enter a valid IP address.'], f.clean, '256.125.1.5')
+        self.assertEqual(f.clean('fe80::223:6cff:fe8a:2e8a'), u'fe80::223:6cff:fe8a:2e8a')
+        self.assertEqual(f.clean('2a02::223:6cff:fe8a:2e8a'), u'2a02::223:6cff:fe8a:2e8a')
+        self.assertFormErrors([u'Enter a valid IP address.'], f.clean, 'foo')
+        self.assertFormErrors([u'Enter a valid IP address.'], f.clean, '12345:2:3:4')
+        self.assertFormErrors([u'Enter a valid IP address.'], f.clean, '1::2:3::4')
+        self.assertFormErrors([u'Enter a valid IP address.'], f.clean, 'foo::223:6cff:fe8a:2e8a')
+        self.assertFormErrors([u'Enter a valid IP address.'], f.clean, '1::2:3:4:5:6:7:8')
+        self.assertFormErrors([u'Enter a valid IP address.'], f.clean, '1:2')
+
+        self.assertRaises(ValueError, IPv46AddressField, only_ipv4=True, only_ipv6=True)
+
+        # Test the normalising code
+        f = IPv46AddressField(only_ipv6=True)
+        self.assertEqual(f.clean('::ffff:0a0a:0a0a'), u'::ffff:10.10.10.10')
+        self.assertEqual(f.clean('::0a0a:0a0a'), u'::10.10.10.10')
+        self.assertEqual(f.clean('2001:000:a:0000:0:fe:fe:beef'), u'2001:0:a::fe:fe:beef')
+        self.assertEqual(f.clean('2001::a:0000:0:fe:fe:beef'), u'2001:0:a::fe:fe:beef')
+
+        # Test the normalising code
+        f = IPv46AddressField(only_ipv6=True, skip_ipv6_normalisation=True)
+        self.assertEqual(f.clean('::ffff:0a0a:0a0a'), u'::ffff:0a0a:0a0a')
+        self.assertEqual(f.clean('::0a0a:0a0a'), u'::0a0a:0a0a')
+        self.assertEqual(f.clean('2001:000:a:0000:0:fe:fe:beef'), u'2001:000:a:0000:0:fe:fe:beef')
+        self.assertEqual(f.clean('2001::a:0000:0:fe:fe:beef'), u'2001::a:0000:0:fe:fe:beef')
+        
+
     def test_smart_unicode(self):
         class Test:
             def __str__(self):

tests/regressiontests/serializers_regress/tests.py

@@ -196 +196 @@
     #(XX, ImageData
     (data_obj, 90, IPAddressData, "127.0.0.1"),
     (data_obj, 91, IPAddressData, None),
+    (data_obj, 95, IPv46AddressData, "fe80:1424:2223:6cff:fe8a:2e8a:2151:abcd"),
+    (data_obj, 96, IPv46AddressData, None),
     (data_obj, 100, NullBooleanData, True),
     (data_obj, 101, NullBooleanData, False),
     (data_obj, 102, NullBooleanData, None),
@@ -298 +300 @@
     (pk_obj, 682, IntegerPKData, 0),
 #     (XX, ImagePKData
     (pk_obj, 690, IPAddressPKData, "127.0.0.1"),
+    (pk_obj, 695, IPv46AddressPKData, "fe80:1424:2223:6cff:fe8a:2e8a:2151:abcd"),
     # (pk_obj, 700, NullBooleanPKData, True),
     # (pk_obj, 701, NullBooleanPKData, False),
     (pk_obj, 710, PhonePKData, "212-634-5789"),

tests/regressiontests/serializers_regress/models.py

@@ -52 +52 @@
 class IPAddressData(models.Model):
     data = models.IPAddressField(null=True)
 
+class IPv46AddressData(models.Model):
+    data = models.IPv46AddressField(null=True)
+
 class NullBooleanData(models.Model):
     data = models.NullBooleanField(null=True)
 
@@ -187 +190 @@
 class IPAddressPKData(models.Model):
     data = models.IPAddressField(primary_key=True)
 
+class IPv46AddressPKData(models.Model):
+    data = models.IPv46AddressField(primary_key=True)
+
 # This is just a Boolean field with null=True, and we can't test a PK value of NULL.
 # class NullBooleanPKData(models.Model):
 #     data = models.NullBooleanField(primary_key=True)