Fixed #17864 -- Added Hong Kong localflavor. Thanks to mrkschan and Adrien Lemaire.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@17886 bcc190cf-cafb-0310-a4f2-bffc1f526a37

2 files changed, 71 insertions, 0 deletions

diff --git a/django/contrib/localflavor/hk/__init__.py b/django/contrib/localflavor/hk/__init__.py
new file mode 100644
index 0000000000..e69de29bb2
--- /dev/null
+++ b/django/contrib/localflavor/hk/__init__.py
diff --git a/django/contrib/localflavor/hk/forms.py b/django/contrib/localflavor/hk/forms.py
new file mode 100644
index 0000000000..852ef7d4b2
--- /dev/null
+++ b/django/contrib/localflavor/hk/forms.py
@@ -0,0 +1,71 @@
+"""
+Hong Kong specific Form helpers
+"""
+from __future__ import absolute_import
+
+import re
+
+from django.core.validators import EMPTY_VALUES
+from django.forms import CharField
+from django.forms import ValidationError
+from django.utils.encoding import smart_unicode
+from django.utils.translation import ugettext_lazy as _
+
+
+hk_phone_digits_re = re.compile(r'^(?:852-?)?(\d{4})[-\.]?(\d{4})$')
+hk_special_numbers = ('999', '992', '112')
+hk_phone_prefixes = ('2', '3', '5', '6', '8', '9')
+hk_formats = ['XXXX-XXXX', '852-XXXX-XXXX', '(+852) XXXX-XXXX',
+    'XXXX XXXX', 'XXXXXXXX']
+
+
+
+class HKPhoneNumberField(CharField):
+    """
+    Validate Hong Kong phone number.
+    The input format can be either one of the followings:
+    'XXXX-XXXX', '852-XXXX-XXXX', '(+852) XXXX-XXXX',
+    'XXXX XXXX', or 'XXXXXXXX'.
+    The output format is 'XXXX-XXXX'.
+
+    Note: The phone number shall not start with 999, 992, or 112.
+          And, it should start with either 2, 3, 5, 6, 8, or 9.
+
+    Ref - http://en.wikipedia.org/wiki/Telephone_numbers_in_Hong_Kong
+    """
+    default_error_messages = {
+        'disguise': _('Phone number should not start with ' \
+                    'one of the followings: %s.' % \
+                    ', '.join(hk_special_numbers)),
+        'invalid': _('Phone number must be in one of the following formats: '
+                    '%s.' % ', '.join(hk_formats)),
+        'prefix': _('Phone number should start with ' \
+                  'one of the followings: %s.' % \
+                  ', '.join(hk_phone_prefixes)),
+    }
+
+    def __init__(self, *args, **kwargs):
+        super(HKPhoneNumberField, self).__init__(*args, **kwargs)
+
+    def clean(self, value):
+        super(HKPhoneNumberField, self).clean(value)
+
+        if value in EMPTY_VALUES:
+            return u''
+
+        value = re.sub('(\(|\)|\s+|\+)', '', smart_unicode(value))
+        m = hk_phone_digits_re.search(value)
+        if not m:
+            raise ValidationError(self.error_messages['invalid'])
+
+        value = u'%s-%s' % (m.group(1), m.group(2))
+        for special in hk_special_numbers:
+            if value.startswith(special):
+                raise ValidationError(self.error_messages['disguise'])
+
+        prefix_found = map(lambda prefix: value.startswith(prefix),
+                           hk_phone_prefixes)
+        if not any(prefix_found):
+            raise ValidationError(self.error_messages['prefix'])
+
+        return value