Source code for localflavor.pl.forms

"""
Polish-specific form helpers
"""

from __future__ import unicode_literals

import re

from django.core.validators import EMPTY_VALUES
from django.forms import ValidationError
from django.forms.fields import RegexField, Select
from django.utils.translation import ugettext_lazy as _

from .pl_administrativeunits import ADMINISTRATIVE_UNIT_CHOICES
from .pl_voivodeships import VOIVODESHIP_CHOICES


[docs]class PLProvinceSelect(Select): """ A select widget with list of Polish administrative provinces as choices. """ def __init__(self, attrs=None): super(PLProvinceSelect, self).__init__(attrs, choices=VOIVODESHIP_CHOICES)
[docs]class PLCountySelect(Select): """ A select widget with list of Polish administrative units as choices. """ def __init__(self, attrs=None): super(PLCountySelect, self).__init__(attrs, choices=ADMINISTRATIVE_UNIT_CHOICES)
[docs]class PLPESELField(RegexField): """ A form field that validates as Polish Identification Number (PESEL). Checks the following rules: * the length consist of 11 digits * has a valid checksum The algorithm is documented at http://en.wikipedia.org/wiki/PESEL. """ default_error_messages = { 'invalid': _('National Identification Number consists of 11 digits.'), 'checksum': _('Wrong checksum for the National Identification Number.'), } def __init__(self, max_length=None, min_length=None, *args, **kwargs): super(PLPESELField, self).__init__(r'^\d{11}$', max_length, min_length, *args, **kwargs) def clean(self, value): super(PLPESELField, self).clean(value) if value in EMPTY_VALUES: return '' if not self.has_valid_checksum(value): raise ValidationError(self.error_messages['checksum']) return '%s' % value
[docs] def has_valid_checksum(self, number): """ Calculates a checksum with the provided algorithm. """ multiple_table = (1, 3, 7, 9, 1, 3, 7, 9, 1, 3, 1) result = 0 for i in range(len(number)): result += int(number[i]) * multiple_table[i] return result % 10 == 0
[docs]class PLNationalIDCardNumberField(RegexField): """ A form field that validates as Polish National ID Card Number. Checks the following rules: * the length consist of 3 letter and 6 digits * has a valid checksum The algorithm is documented at http://en.wikipedia.org/wiki/Polish_identity_card. """ default_error_messages = { 'invalid': _('National ID Card Number consists of 3 letters and 6 digits.'), 'checksum': _('Wrong checksum for the National ID Card Number.'), } def __init__(self, max_length=None, min_length=None, *args, **kwargs): super(PLNationalIDCardNumberField, self).__init__(r'^[A-Za-z]{3}\d{6}$', max_length, min_length, *args, **kwargs) def clean(self, value): super(PLNationalIDCardNumberField, self).clean(value) if value in EMPTY_VALUES: return '' value = value.upper() if not self.has_valid_checksum(value): raise ValidationError(self.error_messages['checksum']) return '%s' % value
[docs] def has_valid_checksum(self, number): """ Calculates a checksum with the provided algorithm. """ letter_dict = {'A': 10, 'B': 11, 'C': 12, 'D': 13, 'E': 14, 'F': 15, 'G': 16, 'H': 17, 'I': 18, 'J': 19, 'K': 20, 'L': 21, 'M': 22, 'N': 23, 'O': 24, 'P': 25, 'Q': 26, 'R': 27, 'S': 28, 'T': 29, 'U': 30, 'V': 31, 'W': 32, 'X': 33, 'Y': 34, 'Z': 35} # convert letters to integer values int_table = [(not c.isdigit()) and letter_dict[c] or int(c) for c in number] multiple_table = (7, 3, 1, -1, 7, 3, 1, 7, 3) result = 0 for i in range(len(int_table)): result += int_table[i] * multiple_table[i] return result % 10 == 0
[docs]class PLNIPField(RegexField): """ A form field that validates as Polish Tax Number (NIP). Valid forms are: XXX-YYY-YY-YY, XXX-YY-YY-YYY or XXXYYYYYYY. Checksum algorithm based on documentation at http://wipos.p.lodz.pl/zylla/ut/nip-rego.html """ default_error_messages = { 'invalid': _('Enter a tax number field (NIP) in the format XXX-XXX-XX-XX, XXX-XX-XX-XXX or XXXXXXXXXX.'), 'checksum': _('Wrong checksum for the Tax Number (NIP).'), } def __init__(self, max_length=None, min_length=None, *args, **kwargs): super(PLNIPField, self).__init__(r'^\d{3}-\d{3}-\d{2}-\d{2}$|^\d{3}-\d{2}-\d{2}-\d{3}$|^\d{10}$', max_length, min_length, *args, **kwargs) def clean(self, value): super(PLNIPField, self).clean(value) if value in EMPTY_VALUES: return '' value = re.sub("[-]", "", value) if not self.has_valid_checksum(value): raise ValidationError(self.error_messages['checksum']) return '%s' % value
[docs] def has_valid_checksum(self, number): """ Calculates a checksum with the provided algorithm. """ multiple_table = (6, 5, 7, 2, 3, 4, 5, 6, 7) result = 0 for i in range(len(number) - 1): result += int(number[i]) * multiple_table[i] result %= 11 if result == int(number[-1]): return True else: return False
[docs]class PLREGONField(RegexField): """ A form field that validates its input is a REGON number. Valid regon number consists of 9 or 14 digits. See http://www.stat.gov.pl/bip/regon_ENG_HTML.htm for more information. """ default_error_messages = { 'invalid': _('National Business Register Number (REGON) consists of 9 or 14 digits.'), 'checksum': _('Wrong checksum for the National Business Register Number (REGON).'), } def __init__(self, max_length=None, min_length=None, *args, **kwargs): super(PLREGONField, self).__init__(r'^\d{9,14}$', max_length, min_length, *args, **kwargs) def clean(self, value): super(PLREGONField, self).clean(value) if value in EMPTY_VALUES: return '' if not self.has_valid_checksum(value): raise ValidationError(self.error_messages['checksum']) return '%s' % value
[docs] def has_valid_checksum(self, number): """ Calculates a checksum with the provided algorithm. """ weights = ( (8, 9, 2, 3, 4, 5, 6, 7, -1), (2, 4, 8, 5, 0, 9, 7, 3, 6, 1, 2, 4, 8, -1), (8, 9, 2, 3, 4, 5, 6, 7, -1, 0, 0, 0, 0, 0), ) weights = [table for table in weights if len(table) == len(number)] for table in weights: checksum = sum([int(n) * w for n, w in zip(number, table)]) mod_result = checksum % 11 if mod_result == 10 and number[-1] != '0': return False if mod_result % 10: return False return bool(weights)
[docs]class PLPostalCodeField(RegexField): """ A form field that validates as Polish postal code. Valid code is XX-XXX where X is digit. """ default_error_messages = { 'invalid': _('Enter a postal code in the format XX-XXX.'), } def __init__(self, max_length=None, min_length=None, *args, **kwargs): super(PLPostalCodeField, self).__init__(r'^\d{2}-\d{3}$', max_length, min_length, *args, **kwargs)