account-reconcile/account_statement_base_completion/statement.py

# -*- coding: utf-8 -*-
##############################################################################
#
#    Author: Nicolas Bessi, Joel Grand-Guillaume
#    Copyright 2011-2012 Camptocamp SA
#
#    This program is free software: you can redistribute it and/or modify
#    it under the terms of the GNU Affero 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 Affero General Public License for more details.
#
#    You should have received a copy of the GNU Affero General Public License
#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
#
##############################################################################
from tools.translate import _
import netsvc
logger = netsvc.Logger()
from openerp.osv.orm import Model, fields
from openerp.osv import fields, osv
from operator import itemgetter, attrgetter

class ErrorTooManyPartner(Exception):
    """
    New Exception definition that is raised when more than one partner is matched by
    the completion rule.
    """
    def __init__(self, value):
        self.value = value
    def __str__(self):
        return repr(self.value)


class AccountStatementProfil(Model):
    """
    Extend the class to add rules per profil that will match at least the partner,
    but it could also be used to match other values as well.
    """
    
    _inherit = "account.statement.profil"
    
    _columns={
        # @Akretion : For now, we don't implement this features, but this would probably be there:
        # 'auto_completion': fields.text('Auto Completion'),
        # 'transferts_account_id':fields.many2one('account.account', 'Transferts Account'),
        # => You can implement it in a module easily, we design it with your needs in mind 
        # as well !
        
        'rule_ids':fields.many2many('account.statement.completion.rule', 
            string='Related statement profiles',
            rel='as_rul_st_prof_rel', 
            ),
    }
    
    def find_values_from_rules(self, cr, uid, id, line_id, context=None):
        """
        This method will execute all related rules, in their sequence order, 
        to retrieve all the values returned by the first rules that will match.
        
        :param int/long line_id: id of the concerned account.bank.statement.line
        :return:
            A dict of value that can be passed directly to the write method of
            the statement line or {}
           {'partner_id': value,
            'account_id' : value,
            
            ...}
        """
        if not context:
            context={}
        res = {}
        rule_obj = self.pool.get('account.statement.completion.rule')
        profile = self.browse(cr, uid, id, context=context)
        # We need to respect the sequence order
        sorted_array = sorted(profile.rule_ids, key=attrgetter('sequence'))
        for rule in sorted_array:
            method_to_call = getattr(rule_obj, rule.function_to_call)
            result = method_to_call(cr,uid,line_id,context)
            if result:
                return result
        return res
        

class AccountStatementCompletionRule(Model):
    """
    This will represent all the completion method that we can have to
    fullfill the bank statement lines. You'll be able to extend them in you own module
    and choose those to apply for every statement profile.
    The goal of a rule is to fullfill at least the partner of the line, but
    if possible also the reference because we'll use it in the reconciliation 
    process. The reference should contain the invoice number or the SO number
    or any reference that will be matched by the invoice accounting move.
    """
    
    _name = "account.statement.completion.rule"
    _order = "sequence asc"
    
    def _get_functions(self, cr, uid, context=None):
        """
        List of available methods for rules. Override this to add you own.
        """
        return [
            ('get_from_ref_and_invoice', 'From line reference (based on invoice number)'),
            ('get_from_ref_and_so', 'From line reference (based on SO number)'),
            ('get_from_label_and_partner_field', 'From line label (based on partner field)'),
            ('get_from_label_and_partner_name', 'From line label (based on partner name)'),
            ]
    
    _columns={
        'sequence': fields.integer('Sequence', help="Lower means paresed first."),
        'name': fields.char('Name', size=128),
        'profile_ids': fields.many2many('account.statement.profil', 
            rel='as_rul_st_prof_rel', 
            string='Related statement profiles'),
        'function_to_call': fields.selection(_get_functions, 'Method'),
    }
    
    def get_from_ref_and_invoice(self, cursor, uid, line_id, context=None):
        """
        Match the partner based on the invoice number and the reference of the statement 
        line. Then, call the generic get_values_for_line method to complete other values.
        If more than one partner matched, raise the ErrorTooManyPartner error.

        :param int/long line_id: id of the concerned account.bank.statement.line
        :return:
            A dict of value that can be passed directly to the write method of
            the statement line or {}
           {'partner_id': value,
            'account_id' : value,
            
            ...}
        """
        st_obj = self.pool.get('account.bank.statement.line')
        st_line = st_obj.browse(cursor,uid,line_id)
        res = {}
        if st_line:
            inv_obj = self.pool.get('account.invoice')
            inv_id = inv_obj.search(cursor, uid, [('number', '=', st_line.ref)])
            if inv_id:
                if inv_id and len(inv_id) == 1:
                    inv = inv_obj.browse(cursor, uid, inv_id[0])
                    res['partner_id'] = inv.partner_id.id
                elif inv_id and len(inv_id) > 1:
                    raise ErrorTooManyPartner(_('Line named "%s" was matched by more than one partner.')%(st_line.name,st_line.id))
                st_vals = st_obj.get_values_for_line(cursor, uid, profile_id = st_line.statement_id.profile_id.id,
                    partner_id = res.get('partner_id',False), line_type = st_line.type, amount = st_line.amount, context = context)
                res.update(st_vals)
        return res

    def get_from_ref_and_so(self, cursor, uid, line_id, context=None):
        """
        Match the partner based on the SO number and the reference of the statement 
        line. Then, call the generic get_values_for_line method to complete other values. 
        If more than one partner matched, raise the ErrorTooManyPartner error.

        :param int/long line_id: id of the concerned account.bank.statement.line
        :return:
            A dict of value that can be passed directly to the write method of
            the statement line or {}
           {'partner_id': value,
            'account_id' : value,
            
            ...}
        """
        st_obj = self.pool.get('account.bank.statement.line')
        st_line = st_obj.browse(cursor,uid,line_id)
        res = {}
        if st_line:
            so_obj = self.pool.get('sale.order')
            so_id = so_obj.search(cursor, uid, [('name', '=', st_line.ref)])
            if so_id:
                if so_id and len(so_id) == 1:
                    so = so_obj.browse(cursor, uid, so_id[0])
                    res['partner_id'] = so.partner_id.id
                elif so_id and len(so_id) > 1:
                    raise ErrorTooManyPartner(_('Line named "%s" was matched by more than one partner.')%(st_line.name,st_line.id))
                st_vals = st_obj.get_values_for_line(cursor, uid, profile_id = st_line.statement_id.profile_id.id,
                    partner_id = res.get('partner_id',False), line_type = st_line.type, amount = st_line.amount, context = context)
                res.update(st_vals)
        return res
    

    def get_from_label_and_partner_field(self, cursor, uid, line_id, context=None):
        """
        Match the partner based on the label field of the statement line
        and the text defined in the 'bank_statement_label' field of the partner.
        Remember that we can have values separated with ; Then, call the generic 
        get_values_for_line method to complete other values.
        If more than one partner matched, raise the ErrorTooManyPartner error.

        :param int/long line_id: id of the concerned account.bank.statement.line
        :return:
            A dict of value that can be passed directly to the write method of
            the statement line or {}
           {'partner_id': value,
            'account_id' : value,
            
            ...}
            """
        partner_obj = self.pool.get('res.partner')
        st_obj = self.pool.get('account.bank.statement.line')
        st_line = st_obj.browse(cursor,uid,line_id)
        res = {}
        compt = 0
        if st_line:
            ids = partner_obj.search(cursor, uid, [['bank_statement_label', '!=', False]], context=context)
            for partner in self.browse(cursor, uid, ids, context=context):
                for partner_label in partner.bank_statement_label.split(';'):
                    if partner_label in st_line.label:
                        compt += 1
                        res['partner_id'] = partner.id
                        if compt > 1:
                            raise ErrorTooManyPartner(_('Line named "%s" was matched by more than one partner.')%(st_line.name,st_line.id))
            if res:
                st_vals = st_obj.get_values_for_line(cursor, uid, profile_id = st_line.statement_id.profile_id.id,
                    partner_id = res.get('partner_id',False), line_type = st_line.type, amount = st_line.amount, context = context)
                res.update(st_vals)
        return res

    def get_from_label_and_partner_name(self, cursor, uid, line_id, context=None):
        """
        Match the partner based on the label field of the statement line
        and the name of the partner.
        Then, call the generic get_values_for_line method to complete other values.
        If more than one partner matched, raise the ErrorTooManyPartner error.

        :param int/long line_id: id of the concerned account.bank.statement.line
        :return:
            A dict of value that can be passed directly to the write method of
            the statement line or {}
           {'partner_id': value,
            'account_id' : value,
            
            ...}
            """
        # This Method has not been tested yet !
        res = {}
        st_obj = self.pool.get('account.bank.statement.line')
        st_line = st_obj.browse(cursor,uid,line_id)
        if st_line:
            sql = "SELECT id FROM res_partner WHERE name ~* '.*%s.*'"
            cursor.execute(sql, (st_line.label,))
            result = cursor.fetchall()
            if len(result) > 1:
                raise ErrorTooManyPartner(_('Line named "%s" was matched by more than one partner.')%(st_line.name,st_line.id))
            for id in result:
                res['partner_id'] = id
            if res:
                st_vals = st_obj.get_values_for_line(cursor, uid, profile_id = st_line.statement_id.profile_id.id,
                    partner_id = res.get('partner_id',False), line_type = st_line.type, amount = st_line.amount, context = context)
                res.update(st_vals)
        return res
       
    
class AccountStatementLine(Model):
    """
    Add sparse field on the statement line to allow to store all the
    bank infos that are given by a bank/office. You can then add you own in your
    module. The idea here is to store all bank/office infos in the additionnal_bank_fields
    serialized field when importing the file. If many values, add a tab in the bank
    statement line to store your specific one. Have a look in account_statement_base_import
    module to see how we've done it.
    """
    _inherit = "account.bank.statement.line"

    _columns={
        'additionnal_bank_fields' : fields.serialized('Additionnal infos from bank', 
            help="Used by completion and import system. Adds every field that is present in your bank/office \
            statement file"),
        'label': fields.sparse(type='char', string='Label', 
            serialization_field='additionnal_bank_fields', 
            help="Generiy field to store a label given from the bank/office on which we can \
            base the default/standard providen rule."),
        'already_completed': fields.boolean("Auto-Completed",
            help="When this checkbox is ticked, the auto-completion process/button will ignore this line."),
    }
    _defaults = {
        'already_completed': False,
    }
    
    
    def get_line_values_from_rules(self, cr, uid, ids, context=None):
        """
        We'll try to find out the values related to the line based on rules setted on
        the profile.. We will ignore line for which already_completed is ticked.

        :return:
            A dict of value that can be passed directly to the write method of
            the statement line or {}
           {'partner_id': value,
            'account_id' : value,
            
            ...}
        """
        profile_obj = self.pool.get('account.statement.profil')
        st_obj = self.pool.get('account.bank.statement.line')
        res={}
        errors_stack = []
        for line in self.browse(cr,uid, ids, context):
            if not line.already_completed:
                try:
                    # Take the default values
                    res[line.id] = st_obj.get_values_for_line(cr, uid, profile_id = line.statement_id.profile_id.id,
                        line_type = line.type, amount = line.amount, context = context)
                    # Ask the rule
                    vals = profile_obj.find_values_from_rules(cr, uid, line.statement_id.profile_id.id, line.id, context)
                    # Merge the result
                    res[line.id].update(vals)
                except ErrorTooManyPartner, exc:
                    msg = "Line ID %s had following error: %s" % (line.id, str(exc))
                    errors_stack.append(msg)
        if errors_stack:
            msg = u"\n".join(errors_stack)
            raise ErrorTooManyPartner(msg)
        return res
        
class AccountBankSatement(Model):
    """
    We add a basic button and stuff to support the auto-completion
    of the bank statement once line have been imported or manually fullfill.
    """
    _inherit = "account.bank.statement"

    def button_auto_completion(self, cr, uid, ids, context=None):
        """
        Complete line with values given by rules and tic the already_completed
        checkbox so we won't compute them again unless the user untick them !
        """
        # TODO: Test the errors system, we should be able to complete all line that
        # passed, and raise an error for all other at once..
        if not context:
            context={}
        stat_line_obj = self.pool.get('account.bank.statement.line')
        errors_msg=False
        for stat in self.browse(cr, uid, ids, context=context):
            ctx = context.copy()
            line_ids = map(lambda x:x.id, stat.line_ids)
            try:
                res = stat_line_obj.get_line_values_from_rules(cr, uid, line_ids, context=ctx)
            except ErrorTooManyPartner, exc:
                errors_msg = str(exc)
            for id in line_ids:
                vals = res.get(id, False)
                if vals:
                    vals['already_completed'] = True
                    stat_line_obj.write(cr, uid, id, vals, context=ctx)
            # cr.commit()
            # TOTEST: I don't know if this is working...
            if errors_msg:
                # raise osv.except_osv(_('Error'), errors_msg)
                warning = {
                    'title': _('Error!'),
                    'message' : errors_msg,
                }
                return {'warning': warning}
        return True