Merge lp:~therp-nl/banking-addons/6.1-dev-preserve-domestic into lp:~banking-addons-team/banking-addons/6.1-dev

[Stefan Rijnhart (Opener)]

Adapt to changes in base_iban: preserve the domestic account number

[James Jesudason (jamesj)]

The license for preserve domestic module needs to be 'AGPL-3' (not AGPL), otherwise this looks fine.

review: Approve

=== modified file 'account_banking/__openerp__.py'
--- account_banking/__openerp__.py	2012-02-01 15:36:09 +0000
+++ account_banking/__openerp__.py	2012-02-19 21:14:20 +0000
@@ -35,7 +35,8 @@
     'author': 'Banking addons community',
     'website': 'https://launchpad.net/banking-addons',
     'category': 'Banking addons',
-    'depends': ['base', 'account', 'base_iban', 'account_payment'],
+    'depends': ['base', 'account', 'base_iban', 'account_payment',
+                'account_iban_preserve_domestic'],
     'init_xml': [],
     'update_xml': [
         'security/ir.model.access.csv',
@@ -47,6 +48,9 @@
         'workflow/account_invoice.xml',
     ],
     'demo_xml': [],
+    'external_dependencies': {
+        'python' : ['BeautifulSoup'],
+    },
     'description': '''
     Module to do banking.
 

=== modified file 'account_banking/account_banking.py'
--- account_banking/account_banking.py	2012-02-17 23:36:43 +0000
+++ account_banking/account_banking.py	2012-02-19 21:14:20 +0000
@@ -66,6 +66,7 @@
 import decimal_precision as dp
 import pooler
 import netsvc
+from openerp import SUPERUSER_ID
 
 def warning(title, message):
     '''Convenience routine'''
@@ -1070,11 +1071,6 @@
            using IBAN specs.
     '''
     _inherit = 'res.partner.bank'
-    _columns = {
-        'iban': fields.char('IBAN', size=34,
-                            help="International Bank Account Number"
-                           ),
-    }
 
     def __init__(self, *args, **kwargs):
         '''
@@ -1091,61 +1087,64 @@
                 self._founder = mro[i]
                 break
 
-    def init(self, cursor):
+    def init(self, cr):
         '''
         Update existing iban accounts to comply to new regime
         Note that usage of the ORM is not possible here, as the ORM cannot
         search on values not provided by the client.
         '''
-        cursor.execute('SELECT id, acc_number, iban '
-                       'FROM res_partner_bank '
-                       'WHERE '
-                         'upper(iban) != iban OR '
-                         'acc_number IS NULL'
-                      )
-        for id, acc_number, iban in cursor.fetchall():
-            new_iban = new_acc_number = False
-            if iban:
-                iban_acc = sepa.IBAN(iban)
+        
+        partner_bank_obj = self.pool.get('res.partner.bank')
+        bank_ids = partner_bank_obj.search(
+            cr, SUPERUSER_ID, [('state', '=', 'iban')], limit=0)
+        for bank in partner_bank_obj.read(cr, SUPERUSER_ID, bank_ids):
+            write_vals = {}
+            if bank['state'] == 'iban':
+                iban_acc = sepa.IBAN(bank['acc_number'])
                 if iban_acc.valid:
-                    new_acc_number = iban_acc.localized_BBAN
-                    new_iban = str(iban_acc)
-                elif iban != iban.upper():
-                    new_iban = iban.upper
-            if iban != new_iban or new_acc_number != acc_number:
-                cursor.execute("UPDATE res_partner_bank "
-                               "SET iban = '%s', acc_number = '%s' "
-                               "WHERE id = %s" % (
-                                   new_iban, new_acc_number, id
-                               ))
+                    write_vals['acc_number_domestic'] = iban_acc.localized_BBAN
+                    write_vals['acc_number'] = str(iban_acc)
+                elif bank['acc_number'] != bank['acc_number'].upper():
+                    write_vals['acc_number'] = bank['acc_number'].upper()
+                if write_vals:
+                    partner_bank_obj.write(
+                        cr, SUPERUSER_ID, bank['id'], write_vals)
 
     @staticmethod
-    def _correct_IBAN(vals):
+    def _correct_IBAN(acc_number):
         '''
         Routine to correct IBAN values and deduce localized values when valid.
         Note: No check on validity IBAN/Country
         '''
-        if 'iban' in vals and vals['iban']:
-            iban = sepa.IBAN(vals['iban'])
-            vals['iban'] = str(iban)
-            vals['acc_number'] = iban.localized_BBAN
-        return vals
+        iban = sepa.IBAN(acc_number)
+        return (str(iban), iban.localized_BBAN)
 
     def create(self, cursor, uid, vals, context=None):
         '''
         Create dual function IBAN account for SEPA countries
         '''
-        return self._founder.create(cursor, uid,
-                                    self._correct_IBAN(vals), context
-                                   )
+        if vals['state'] == 'iban':
+            vals['acc_number'], vals['acc_number_domestic'] = (
+                self._correct_IBAN(vals['acc_number']))
+        return self._founder.create(cursor, uid, vals, context)
 
-    def write(self, cursor, uid, ids, vals, context=None):
+    def write(self, cr, uid, ids, vals, context=None):
         '''
         Create dual function IBAN account for SEPA countries
         '''
-        return self._founder.write(cursor, uid, ids,
-                                   self._correct_IBAN(vals), context
-                                  )
+        if ids and isinstance(ids, (int, long)):
+            ids = [ids]
+        for account in self.read(
+            cr, uid, ids, ['state', 'acc_number']):
+            if 'state' in vals or 'acc_number' in vals:
+                account.update(vals)
+                if 'state' in vals and vals['state'] == 'iban':
+                    vals['acc_number'], vals['acc_number_domestic'] = (
+                        self._correct_IBAN(account['acc_number']))
+                else:
+                    vals['acc_number_domestic'] = False
+            self._founder.write(cr, uid, account['id'], vals, context)
+        return True
 
     def search(self, cursor, uid, args, *rest, **kwargs):
         '''
@@ -1167,7 +1166,7 @@
             Extend the search criteria in term when appropriate.
             '''
             extra_term = None
-            if term[0].lower() == 'iban' and term[1] in ('=', '=='):
+            if term[0].lower() == 'acc_number' and term[1] in ('=', '=='):
                 iban = sepa.IBAN(term[2])
                 if iban.valid:
                     # Some countries can't convert to BBAN
@@ -1175,7 +1174,7 @@
                         bban = iban.localized_BBAN
                         # Prevent empty search filters
                         if bban:
-                            extra_term = ('acc_number', term[1], bban)
+                            extra_term = ('acc_number_domestic', term[1], bban)
                     except:
                         pass
             if extra_term:
@@ -1212,25 +1211,33 @@
                                       )
         return results
 
-    def read(self, *args, **kwargs):
+    def read(
+        self, cr, uid, ids, fields=None, context=None, load='_classic_read'):
         '''
         Convert IBAN electronic format to IBAN display format
+        SR 2012-02-19: do we really need this? Fields are converted upon write already.
         '''
-        records = self._founder.read(*args, **kwargs)
+        if fields and 'state' not in fields:
+            fields.append('state')
+        records = self._founder.read(cr, uid, ids, fields, context, load)
+        is_list = True
 	if not isinstance(records, list):
             records = [records,]
+            is_list = False
         for record in records:
-            if 'iban' in record and record['iban']:
-                record['iban'] = unicode(sepa.IBAN(record['iban']))
-        return records
+            if 'acc_number' in record and record['state'] == 'iban':
+                record['acc_number'] = unicode(sepa.IBAN(record['acc_number']))
+        if is_list:
+            return records
+        return records[0]
 
     def check_iban(self, cursor, uid, ids):
         '''
         Check IBAN number
         '''
         for bank_acc in self.browse(cursor, uid, ids):
-            if bank_acc.iban:
-                iban = sepa.IBAN(bank_acc.iban)
+            if bank_acc.state == 'iban' and bank_acc.acc_number:
+                iban = sepa.IBAN(bank_acc.acc_number)
                 if not iban.valid:
                     return False
         return True
@@ -1241,19 +1248,33 @@
         '''
         res = {}
         for record in self.browse(cursor, uid, ids, context):
-            if not record.iban:
+            if not record.state == 'iban':
                 res[record.id] = False
             else:
-                iban_acc = sepa.IBAN(record.iban)
+                iban_acc = sepa.IBAN(record.acc_number)
                 try:
                     res[record.id] = iban_acc.localized_BBAN
                 except NotImplementedError:
                     res[record.id] = False
         return res
 
-    def onchange_acc_number(self, cursor, uid, ids, acc_number,
-                            partner_id, country_id, context=None
-                           ):
+    def onchange_acc_number(
+        self, cr, uid, ids, acc_number, acc_number_domestic,
+        state, partner_id, country_id, context=None):
+        if state == 'iban':
+            return self.onchange_iban(
+                cr, uid, ids, acc_number, acc_number_domestic,
+                state, partner_id, country_id, context=None
+                )
+        else:
+            return self.onchange_domestic(
+                cr, uid, ids, acc_number,
+                partner_id, country_id, context=None
+                )
+
+    def onchange_domestic(
+        self, cursor, uid, ids, acc_number,
+        partner_id, country_id, context=None):
         '''
         Trigger to find IBAN. When found:
             1. Reformat BBAN
@@ -1314,14 +1335,18 @@
                                    )
         result = {'value': values}
         # Complete data with online database when available
-        if partner_id and country.code in sepa.IBAN.countries:
+        if country_ids:
+            country = country_obj.browse(
+                cursor, uid, country_ids[0], context=context)
+        if country and country.code in sepa.IBAN.countries:
             try:
                 info = sepa.online.account_info(country.code, acc_number)
                 if info:
                     iban_acc = sepa.IBAN(info.iban)
                     if iban_acc.valid:
-                        values['acc_number'] = iban_acc.localized_BBAN
-                        values['iban'] = unicode(iban_acc)
+                        values['acc_number_domestic'] = iban_acc.localized_BBAN
+                        values['acc_number'] = unicode(iban_acc)
+                        values['state'] = 'iban'
                         bank_id, country_id = get_or_create_bank(
                             self.pool, cursor, uid,
                             info.bic or iban_acc.BIC_searchkey,
@@ -1355,25 +1380,27 @@
                     values['acc_number'] = acc_number
         return result
 
-    def onchange_iban(self, cursor, uid, ids, iban, context=None):
+    def onchange_iban(
+        self, cr, uid, ids, acc_number, acc_number_domestic,
+        state, partner_id, country_id, context=None):
         '''
         Trigger to verify IBAN. When valid:
             1. Extract BBAN as local account
             2. Auto complete bank
         '''
-        if not iban:
+        if not acc_number:
             return {}
 
-        iban_acc = sepa.IBAN(iban)
+        iban_acc = sepa.IBAN(acc_number)
         if iban_acc.valid:
             bank_id, country_id = get_or_create_bank(
-                self.pool, cursor, uid, iban_acc.BIC_searchkey,
+                self.pool, cr, uid, iban_acc.BIC_searchkey,
                 code=iban_acc.BIC_searchkey
                 )
             return {
                 'value': dict(
-                    acc_number = iban_acc.localized_BBAN,
-                    iban = unicode(iban_acc),
+                    acc_number_domestic = iban_acc.localized_BBAN,
+                    acc_number = unicode(iban_acc),
                     country = country_id or False,
                     bank = bank_id or False,
                 )
@@ -1383,7 +1410,7 @@
                       )
 
     _constraints = [
-        (check_iban, _("The IBAN number doesn't seem to be correct"), ["iban"])
+        (check_iban, _("The IBAN number doesn't seem to be correct"), ["acc_number"])
     ]
 
 res_partner_bank()

=== modified file 'account_banking/account_banking_view.xml'
--- account_banking/account_banking_view.xml	2012-02-17 23:36:43 +0000
+++ account_banking/account_banking_view.xml	2012-02-19 21:14:20 +0000
@@ -371,13 +371,16 @@
             <field name="model">res.partner.bank</field>
             <field name="inherit_id" ref="base.view_partner_bank_form"/>
             <field name="type">form</field>
+            <field name="priority" eval="24"/>
             <field name="arch" type="xml">
-                <field name="acc_number" position="replace">
-                    <field name="acc_number" on_change="onchange_acc_number(acc_number, partner_id, country_id)"/>
-                    <newline />
-                    <field name="iban" on_change="onchange_iban(iban)" />
-                    <newline />
-                </field>
+                <data>
+                    <field name="acc_number" position="attributes">
+                        <attribute name="on_change">onchange_acc_number(acc_number, acc_number_domestic, state, partner_id, country_id)</attribute>
+                    </field>
+                    <field name="acc_number_domestic" position="attributes">
+                        <attribute name="on_change">onchange_domestic(acc_number_domestic, partner_id, country_id)</attribute>
+                    </field>
+                </data>
             </field>
         </record>
 
@@ -397,26 +400,34 @@
             <field name="name">res.partner.form.banking-2</field>
             <field name="model">res.partner</field>
             <field name="inherit_id" ref="account.view_partner_property_form"/>
+            <field name="priority" eval="24"/>
             <field name="type">form</field>
             <field name="arch" type="xml">
-                <xpath expr="/form/notebook/page/field[@name='bank_ids']/form/field[@name='acc_number']" position="replace">
-                    <field name="acc_number" on_change="onchange_acc_number(acc_number, parent.id, country_id)" />
-                    <newline />
-                    <field name="iban" on_change="onchange_iban(iban)" />
-                    <newline />
-               </xpath>
+                <data>
+                    <field name="acc_number" position="attributes">
+                        <attribute name="on_change">onchange_acc_number(acc_number, acc_number_domestic, state, partner_id, country_id)</attribute>
+                    </field>
+                    <field name="acc_number_domestic" position="attributes">
+                        <attribute name="on_change">onchange_domestic(acc_number_domestic, partner_id, country_id)</attribute>
+                    </field>
+                </data>
             </field>
         </record>
         <record id="view_partner_account_banking_form_3" model="ir.ui.view">
             <field name="name">res.partner.form.banking-3</field>
             <field name="model">res.partner</field>
             <field name="inherit_id" ref="account.view_partner_property_form"/>
+            <field name="priority" eval="24"/>
             <field name="type">form</field>
             <field name="arch" type="xml">
-                <xpath expr="/form/notebook/page/field[@name='bank_ids']/tree/field[@name='acc_number']" position="replace">
-                    <field name="acc_number" on_change="onchange_acc_number(acc_number, parent.id, country_id)" select="1" />
-                    <field name="iban" on_change="onchange_iban(iban)" />
-                </xpath>
+                <data>
+                    <field name="acc_number" position="attributes">
+                        <attribute name="on_change">onchange_acc_number(acc_number, acc_number_domestic, state, partner_id, country_id)</attribute>
+                    </field>
+                    <field name="acc_number_domestic" position="attributes">
+                        <attribute name="on_change">onchange_domestic(acc_number_domestic, partner_id, country_id)</attribute>
+                    </field>
+                </data>
             </field>
         </record>
         

=== modified file 'account_banking/banking_import_transaction.py'
--- account_banking/banking_import_transaction.py	2012-02-17 23:36:43 +0000
+++ account_banking/banking_import_transaction.py	2012-02-19 21:14:20 +0000
@@ -905,7 +905,7 @@
                       if x.communication == trans.reference 
                       and round(x.amount, digits) == -round(trans.transferred_amount, digits)
                       and trans.remote_account in (x.bank_id.acc_number,
-                                                   x.bank_id.iban)
+                                                   x.bank_id.acc_number_domestic)
                      ]
         if len(candidates) == 1:
             candidate = candidates[0]

=== modified file 'account_banking/data/account_banking_data.xml'
--- account_banking/data/account_banking_data.xml	2012-02-17 23:36:43 +0000
+++ account_banking/data/account_banking_data.xml	2012-02-19 21:14:20 +0000
@@ -1,24 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <openerp>
     <data>
-        <!-- Re-introduce changes that were removed in 6.1 -->
-        <record id="bank_iban_field" model="res.partner.bank.type.field">
-            <field name="name">iban</field>
-            <field name="bank_type_id" ref="base_iban.bank_iban"/>
-            <field eval="True" name="required"/>
-            <field eval="False" name="readonly"/>
-        </record>
-
-        <!-- Unset readonly state of acc_number for IBAN accounts.
-             Leaving it will make it impossible to deduce BBAN's from any
-             client.
-        -->
-        <record id="bank_acc_number_field" model="res.partner.bank.type.field">
-            <field name="name">acc_number</field>
-            <field name="bank_type_id" ref="base_iban.bank_iban"/>
-            <field eval="False" name="required"/>
-            <field eval="False" name="readonly"/>
-        </record>
         <!-- Unset readonly state of country_id for ordinary account.
              Leaving it will make it impossible to use bank accounts with
              addresses outside the companies country.

=== modified file 'account_banking/wizard/banktools.py'
--- account_banking/wizard/banktools.py	2012-02-17 23:36:43 +0000
+++ account_banking/wizard/banktools.py	2012-02-19 21:14:20 +0000
@@ -98,8 +98,10 @@
         ('acc_number', '=', account_number)
     ])
     if not bank_account_ids:
+        # SR 2012-02-19 does the search() override in res_partner_bank
+        # provides this result on the previous query?
         bank_account_ids = partner_bank_obj.search(cursor, uid, [
-            ('iban', '=', account_number)
+            ('acc_number_domestic', '=', account_number)
         ])
     if not bank_account_ids:
         if not fail:
@@ -331,8 +333,8 @@
     if iban.valid:
         # Take as much info as possible from IBAN
         values.state = 'iban'
-        values.iban = str(iban)
-        values.acc_number = iban.BBAN
+        values.acc_number = str(iban)
+        values.acc_number_domestic = iban.BBAN
         bankcode = iban.bankcode + iban.countrycode
         country_code = iban.countrycode
 
@@ -356,13 +358,13 @@
     if not iban.valid:
         # No, try to convert to IBAN
         values.state = 'bank'
-        values.acc_number = account_number
+        values.acc_number = values.acc_number_domestic = account_number
         if country_code in sepa.IBAN.countries:
             account_info = sepa.online.account_info(country_code,
                                                     values.acc_number
                                                    )
             if account_info:
-                values.iban = iban = account_info.iban
+                values.acc_number = iban = account_info.iban
                 values.state = 'iban'
                 bankcode = account_info.code
                 bic = account_info.bic

=== added directory 'account_iban_preserve_domestic'
=== added file 'account_iban_preserve_domestic/__init__.py'
--- account_iban_preserve_domestic/__init__.py	1970-01-01 00:00:00 +0000
+++ account_iban_preserve_domestic/__init__.py	2012-02-19 21:14:20 +0000
@@ -0,0 +1,1 @@
+import res_partner_bank

=== added file 'account_iban_preserve_domestic/__openerp__.py'
--- account_iban_preserve_domestic/__openerp__.py	1970-01-01 00:00:00 +0000
+++ account_iban_preserve_domestic/__openerp__.py	2012-02-19 21:14:20 +0000
@@ -0,0 +1,61 @@
+##############################################################################
+#
+#    Copyright (C) 2012 Therp BV (<http://therp.nl>).
+#            
+#    All other contributions are (C) by their respective contributors
+#
+#    All Rights Reserved
+#
+#    WARNING: This program as such is intended to be used by professional
+#    programmers who take the whole responsability of assessing all potential
+#    consequences resulting from its eventual inadequacies and bugs
+#    End users who are looking for a ready-to-use solution with commercial
+#    garantees and support are strongly adviced to contract EduSense BV
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License as published by
+#    the Free Software Foundation, either version 3 of the License, or
+#    (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+##############################################################################
+{
+    'name': 'Domestic bank account number',
+    'version': '0.1.108',
+    'license': 'AGPL',
+    'author': 'Therp BV',
+    'website': 'https://launchpad.net/banking-addons',
+    'category': 'Banking addons',
+    'depends': ['base_iban','account'],
+    'init_xml': [],
+    'update_xml': [
+        'res_partner_bank_view.xml'
+        ],
+    'demo_xml': [],
+    'description': '''
+This module is compatible with OpenERP 6.1.
+
+The IBAN module in OpenERP 6.1 registers the IBAN
+on the same field as the domestic account number, 
+instead of keeping both on separate fields as is the
+case in 6.0.
+
+This module adds a field to register the domestic account
+number on IBANs, while the domestic account number is
+still widely in use in certain regions.
+
+Note that an upgrade to OpenERP 6.1 makes you lose the
+domestic account numbers on IBANs that were already in 
+your system, unless you installed the 6.0 version of this
+module prior to the upgrade to OpenERP 6.1. 
+    ''',
+    'active': False,
+    'installable': True,
+}

=== added file 'account_iban_preserve_domestic/res_partner_bank.py'
--- account_iban_preserve_domestic/res_partner_bank.py	1970-01-01 00:00:00 +0000
+++ account_iban_preserve_domestic/res_partner_bank.py	2012-02-19 21:14:20 +0000
@@ -0,0 +1,12 @@
+from osv import fields,osv
+class res_partner_bank(osv.osv):
+    ''' Adds a field for domestic account numbers '''
+    _inherit = "res.partner.bank"
+
+    _columns = {
+        'acc_number_domestic': fields.char(
+            'Domestic Account Number', size=64)
+        }
+
+res_partner_bank()
+

=== added file 'account_iban_preserve_domestic/res_partner_bank_view.xml'
--- account_iban_preserve_domestic/res_partner_bank_view.xml	1970-01-01 00:00:00 +0000
+++ account_iban_preserve_domestic/res_partner_bank_view.xml	2012-02-19 21:14:20 +0000
@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="utf-8"?>
+<openerp>
+    <data>
+
+        <!-- add the field to the partner bank form, as defined in 
+        the base module -->
+        <record id="view_partner_bank_form" model="ir.ui.view">
+            <field name="name">res.partner.bank.form</field>
+            <field name="model">res.partner.bank</field>
+            <field name="inherit_id" ref="base.view_partner_bank_form"/>
+            <field name="arch" type="xml">
+                <field name="acc_number" position="after">
+                    <newline/>
+                    <field name="acc_number_domestic"
+                           attrs="{'invisible': [('state', '!=', 'iban')]}"
+                           />
+                </field>
+            </field>
+        </record>
+
+        <!-- add the field to the partner form, as defined in 
+        the account module -->
+        <record id="view_partner_account_form" model="ir.ui.view">
+            <field name="name">res.partner.account.form</field>
+            <field name="model">res.partner</field>
+            <field name="inherit_id" ref="account.view_partner_property_form"/>
+            <field name="arch" type="xml">
+                <field name="acc_number" position="after">
+                    <newline/>
+                    <field name="acc_number_domestic"
+                           attrs="{'invisible': [('state', '!=', 'iban')]}"
+                           />
+                </field>
+            </field>
+        </record>
+    </data>
+</openerp>