[IMP] base_iban: don't break on empty IBAN values, support more countries, reviewed...

      - fixed checking of empty IBAN
      - used consistent letter code for IBAN examples
      - added IBAN support for Costa Rica (CR), Kuwait (KW),
       Dominican Rep. (DO), United Arab Emirates (AE),
       Mauritania (MR), Bahrain (BH)
      - minor cleanup

bzr revid: odo@openerp.com-20120130111521-hxnmnd07xkewr4hp

diff --git a/addons/base_iban/base_iban.py b/addons/base_iban/base_iban.py
index 157b889..4519271 100644 (file)
--- a/addons/base_iban/base_iban.py
+++ b/addons/base_iban/base_iban.py
@@ -20,62 +20,61 @@
 ##############################################################################
 import string
 
-import netsvc
 from osv import fields, osv
 from tools.translate import _
 
-# Length of IBAN
-_iban_len = {'al':28, 'ad':24, 'at':20, 'be': 16, 'ba': 20, 'bg': 22, 'hr': 21, 'cy': 28,
-'cz': 24, 'dk': 18, 'ee': 20, 'fo':18, 'fi': 18, 'fr': 27, 'ge': 22, 'de': 22, 'gi': 23,
-'gr': 27, 'gl': 18, 'hu': 28, 'is':26, 'ie': 22, 'il': 23, 'it': 27, 'kz': 20, 'lv': 21,
-'lb': 28, 'li': 21, 'lt': 20, 'lu':20 ,'mk': 19, 'mt': 31, 'mu': 30, 'mc': 27, 'gb': 22,
-'me': 22, 'nl': 18, 'no': 15, 'pl':28, 'pt': 25, 'ro': 24, 'sm': 27, 'sa': 24, 'rs': 22,
-'sk': 24, 'si': 19, 'es': 24, 'se':24, 'ch': 21, 'tn': 24, 'tr': 26}
-
 # Reference Examples of IBAN
 _ref_iban = { 'al':'ALkk BBBS SSSK CCCC CCCC CCCC CCCC', 'ad':'ADkk BBBB SSSS CCCC CCCC CCCC',
-'at':'ATkk BBBB BCCC CCCC CCCC', 'be': 'BEkk BBBC CCCC CCKK', 'ba': 'BAkk BBBS SSCC CCCC CoKK',
-'bg': 'BGkk BBBB SSSS DDCC CCCC CC', 'hr': 'HRkk BBBB BBBC CCCC CCCC C',
-'cy': 'CYkk BBBS SSSS CCCC CCCC CCCC CCCC',
+'at':'ATkk BBBB BCCC CCCC CCCC', 'be': 'BEkk BBBC CCCC CCKK', 'ba': 'BAkk BBBS SSCC CCCC CCKK',
+'bg': 'BGkk BBBB SSSS DDCC CCCC CC', 'bh': 'BHkk BBBB SSSS SSSS SSSS SS',
+'cr': 'CRkk BBBC CCCC CCCC CCCC C',
+'hr': 'HRkk BBBB BBBC CCCC CCCC C', 'cy': 'CYkk BBBS SSSS CCCC CCCC CCCC CCCC',
 'cz': 'CZkk BBBB SSSS SSCC CCCC CCCC', 'dk': 'DKkk BBBB CCCC CCCC CC',
+'do': 'DOkk BBBB CCCC CCCC CCCC CCCC CCCC',
  'ee': 'EEkk BBSS CCCC CCCC CCCK', 'fo': 'FOkk CCCC CCCC CCCC CC',
  'fi': 'FIkk BBBB BBCC CCCC CK', 'fr': 'FRkk BBBB BGGG GGCC CCCC CCCC CKK',
  'ge': 'GEkk BBCC CCCC CCCC CCCC CC', 'de': 'DEkk BBBB BBBB CCCC CCCC CC',
  'gi': 'GIkk BBBB CCCC CCCC CCCC CCC', 'gr': 'GRkk BBBS SSSC CCCC CCCC CCCC CCC',
  'gl': 'GLkk BBBB CCCC CCCC CC', 'hu': 'HUkk BBBS SSSC CCCC CCCC CCCC CCCC',
- 'is':'ISkk BBBB SSCC CCCC XXXX XXXX XX', 'ie': 'IEkk AAAA BBBB BBCC CCCC CC',
- 'il': 'ILkk BBBN NNCC CCCC CCCC CCC', 'it': 'ITkk KAAA AABB BBBC CCCC CCCC CCC',
- 'kz': 'KZkk BBBC CCCC CCCC CCCC', 'lv': 'LVkk BBBB CCCC CCCC CCCC C',
-'lb': 'LBkk BBBB AAAA AAAA AAAA AAAA AAAA', 'li': 'LIkk BBBB BCCC CCCC CCCC C',
+ 'is':'ISkk BBBB SSCC CCCC XXXX XXXX XX', 'ie': 'IEkk BBBB SSSS SSCC CCCC CC',
+ 'il': 'ILkk BBBS SSCC CCCC CCCC CCC', 'it': 'ITkk KBBB BBSS SSSC CCCC CCCC CCC',
+ 'kz': 'KZkk BBBC CCCC CCCC CCCC', 'kw': 'KWkk BBBB CCCC CCCC CCCC CCCC CCCC CC',
+ 'lv': 'LVkk BBBB CCCC CCCC CCCC C',
+'lb': 'LBkk BBBB CCCC CCCC CCCC CCCC CCCC', 'li': 'LIkk BBBB BCCC CCCC CCCC C',
 'lt': 'LTkk BBBB BCCC CCCC CCCC', 'lu': 'LUkk BBBC CCCC CCCC CCCC' ,
 'mk': 'MKkk BBBC CCCC CCCC CKK', 'mt': 'MTkk BBBB SSSS SCCC CCCC CCCC CCCC CCC',
+'mr': 'MRkk BBBB BSSS SSCC CCCC CCCC CKK',
 'mu': 'MUkk BBBB BBSS CCCC CCCC CCCC CCCC CC', 'mc': 'MCkk BBBB BGGG GGCC CCCC CCCC CKK',
-'gb': 'GBkk BBBB SSSS SSCC CCCC CC', 'me': 'MEkk BBBC CCCC CCCC CCCC KK',
-'nl': 'NLkk BBBB CCCC CCCC CC', 'no': 'NOkk BBBB CCCC CCK', 'pl':'PLkk BBBS SSSK CCCC CCCC CCCC CCCC',
+'me': 'MEkk BBBC CCCC CCCC CCCC KK',
+'nl': 'NLkk BBBB CCCC CCCC CC', 'no': 'NOkk BBBB CCCC CCK',
+'pl':'PLkk BBBS SSSK CCCC CCCC CCCC CCCC',
 'pt': 'PTkk BBBB SSSS CCCC CCCC CCCK K', 'ro': 'ROkk BBBB CCCC CCCC CCCC CCCC',
-'sm': 'SMkk KAAA AABB BBBC CCCC CCCC CCC', 'sa': 'SAkk BBCC CCCC CCCC CCCC CCCC',
+'sm': 'SMkk KBBB BBSS SSSC CCCC CCCC CCC', 'sa': 'SAkk BBCC CCCC CCCC CCCC CCCC',
 'rs': 'RSkk BBBC CCCC CCCC CCCC KK', 'sk': 'SKkk BBBB SSSS SSCC CCCC CCCC',
-'si': 'SIkk BBSS SCCC CCCC CKK', 'es': 'ESkk BBBB GGGG KKCC CCCC CCCC',
+'si': 'SIkk BBSS SCCC CCCC CKK', 'es': 'ESkk BBBB SSSS KKCC CCCC CCCC',
 'se': 'SEkk BBBB CCCC CCCC CCCC CCCC', 'ch': 'CHkk BBBB BCCC CCCC CCCC C',
-'tn': 'TNkk BBSS SCCC CCCC CCCC CCCC', 'tr': 'TRkk BBBB BRCC CCCC CCCC CCCC CC'
+'tn': 'TNkk BBSS SCCC CCCC CCCC CCCC', 'tr': 'TRkk BBBB BRCC CCCC CCCC CCCC CC',
+'ae': 'AEkk BBBC CCCC CCCC CCCC CCC',
+'gb': 'GBkk BBBB SSSS SSCC CCCC CC',
 }
 
-def _format_iban(string):
+def _format_iban(iban_str):
     '''
-    This function removes all characters from given 'string' that isn't a alpha numeric and converts it to upper case.
+    This function removes all characters from given 'iban_str' that isn't a alpha numeric and converts it to upper case.
     '''
     res = ""
-    for char in string:
-        if char.isalnum():
-            res += char.upper()
+    if iban_str:
+        for char in iban_str:
+            if char.isalnum():
+                res += char.upper()
     return res
 
-def _pretty_iban(string):
-    "return string in groups of four characters separated by a single space"
+def _pretty_iban(iban_str):
+    "return iban_str in groups of four characters separated by a single space"
     res = []
-    while string:
-        res.append(string[:4])
-        string = string[4:]
+    while iban_str:
+        res.append(iban_str[:4])
+        iban_str = iban_str[4:]
     return ' '.join(res)
 
 class res_partner_bank(osv.osv):
@@ -103,7 +102,7 @@ class res_partner_bank(osv.osv):
             if bank_acc.state<>'iban':
                 continue
             iban = _format_iban(bank_acc.acc_number).lower()
-            if iban[:2] in _iban_len and len(iban) != _iban_len[iban[:2]]:
+            if iban[:2] in _ref_iban and len(iban) != len(_format_iban(_ref_iban[iban[:2]])):
                 return False
             #the four first digits have to be shifted to the end
             iban = iban[4:] + iban[:4]
@@ -126,8 +125,11 @@ class res_partner_bank(osv.osv):
 
         iban_country = self.browse(cr, uid, ids)[0].acc_number[:2].lower()
         if default_iban_check(iban_country):
-            iban_example = iban_country in _ref_iban and _ref_iban[iban_country] + ' \nWhere A = Account number, B = National bank code, S = Branch code, C = account No, N = branch No, K = National check digits....' or ''
-            return _('The IBAN does not seem to be correct. You should have entered something like this %s'), (iban_example)
+            if iban_country in _ref_iban:
+                return _('The IBAN does not seem to be correct. You should have entered something like this %s'), \
+                        ('%s \nWhere B = National bank code, S = Branch code,'\
+                         ' C = Account No, K = Check digit' % _ref_iban[iban_country])
+            return _('This IBAN does not pass the validation check, please verify it'), ()
         return _('The IBAN is invalid, it should begin with the country code'), ()
 
     def _check_bank(self, cr, uid, ids, context=None):