bank-statement-import/account_bank_statement_import_ofx/account_bank_statement_import_ofx.py

# -*- coding: utf-8 -*-

import logging
import StringIO

from openerp import api, models
from openerp.tools.translate import _
from openerp.exceptions import Warning as UserError

_logger = logging.getLogger(__name__)

try:
    from ofxparse import OfxParser as ofxparser
except ImportError:
    _logger.warn("ofxparse not found, OFX parsing disabled.")
    ofxparser = None


class AccountBankStatementImport(models.TransientModel):
    _inherit = 'account.bank.statement.import'

    @api.model
    def _check_ofx(self, data_file):
        if ofxparser is None:
            return False
        try:
            ofx = ofxparser.parse(StringIO.StringIO(data_file))
        except:
            return False
        return ofx

    @api.model
    def _parse_file(self, data_file):
        ofx = self._check_ofx(data_file)
        if not ofx:
            return super(AccountBankStatementImport, self)._parse_file(
                data_file)

        transactions = []
        total_amt = 0.00
        try:
            for transaction in ofx.account.statement.transactions:
                # Since ofxparse doesn't provide account numbers, we'll have
                # to find res.partner and res.partner.bank here
                # (normal behavious is to provide 'account_number', which the
                # generic module uses to find partner/bank)
                bank_account_id = partner_id = False
                if transaction.payee:
                    banks = self.env['res.partner.bank'].search(
                        [('owner_name', '=', transaction.payee)], limit=1)
                    if banks:
                        bank_account = banks[0]
                        bank_account_id = bank_account.id
                        partner_id = bank_account.partner_id.id
                vals_line = {
                    'date': transaction.date,
                    'name': transaction.payee + (
                        transaction.memo and ': ' + transaction.memo or ''),
                    'ref': transaction.id,
                    'amount': transaction.amount,
                    'unique_import_id': '%s-%s-%s' % (
                        transaction.id, transaction.payee, transaction.memo),
                    'bank_account_id': bank_account_id,
                    'partner_id': partner_id,
                }
                # Memo (<NAME>) and payee (<PAYEE>) are not required
                # field in OFX statement, cf section 11.4.3 Statement
                # Transaction <STMTTRN> of the OFX specs: the required
                # elements are in bold, cf 1.5 Conventions and these 2
                # fields are not in bold.
                # But the 'name' field of account.bank.statement.line is
                # required=True, so we must always have a value !
                # The field TRNTYPE is a required field in OFX
                if not vals_line['name']:
                    vals_line['name'] = transaction.type.capitalize()
                    if transaction.checknum:
                        vals_line['name'] += ' %s' % transaction.checknum
                total_amt += float(transaction.amount)
                transactions.append(vals_line)
        except Exception, e:
            raise UserError(_(
                "The following problem occurred during import. "
                "The file might not be valid.\n\n %s" % e.message
            ))

        balance = float(ofx.account.statement.balance)
        vals_bank_statement = {
            'name': ofx.account.number,
            'transactions': transactions,
            'balance_start': balance - total_amt,
            'balance_end_real': balance,
        }
        return ofx.account.statement.currency, ofx.account.number, [
            vals_bank_statement]