Files
account-reconcile/account_easy_reconcile/easy_reconcile.py
2015-09-04 08:47:31 +02:00

380 lines
15 KiB
Python

# -*- coding: utf-8 -*-
##############################################################################
#
# Copyright 2012-2013, 2015 Camptocamp SA (Guewen Baconnier, Damien Crier)
# Copyright (C) 2010 Sébastien Beau
#
# 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 datetime import datetime
from openerp import models, api, fields, _
from openerp.exceptions import Warning
from openerp import sql_db
import logging
_logger = logging.getLogger(__name__)
class EasyReconcileOptions(models.AbstractModel):
"""Options of a reconciliation profile
Columns shared by the configuration of methods
and by the reconciliation wizards.
This allows decoupling of the methods and the
wizards and allows to launch the wizards alone
"""
_name = 'easy.reconcile.options'
@api.model
def _get_rec_base_date(self):
return [
('end_period_last_credit', 'End of period of most recent credit'),
('newest', 'Most recent move line'),
('actual', 'Today'),
('end_period', 'End of period of most recent move line'),
('newest_credit', 'Date of most recent credit'),
('newest_debit', 'Date of most recent debit')
]
write_off = fields.Float('Write off allowed', default=0.)
account_lost_id = fields.Many2one('account.account',
string="Account Lost")
account_profit_id = fields.Many2one('account.account',
string="Account Profit")
journal_id = fields.Many2one('account.journal',
string="Journal")
date_base_on = fields.Selection('_get_rec_base_date',
required=True,
string='Date of reconciliation',
default='end_period_last_credit')
filter = fields.Char(string='Filter')
analytic_account_id = fields.Many2one('account.analytic.account',
string='Analytic_account',
help="Analytic account "
"for the write-off")
income_exchange_account_id = fields.Many2one('account.account',
string='Gain Exchange '
'Rate Account')
expense_exchange_account_id = fields.Many2one('account.account',
string='Loss Exchange '
'Rate Account')
class AccountEasyReconcileMethod(models.Model):
_name = 'account.easy.reconcile.method'
_description = 'reconcile method for account_easy_reconcile'
_inherit = 'easy.reconcile.options'
_order = 'sequence'
@api.model
def _get_all_rec_method(self):
return [
('easy.reconcile.simple.name', 'Simple. Amount and Name'),
('easy.reconcile.simple.partner', 'Simple. Amount and Partner'),
('easy.reconcile.simple.reference',
'Simple. Amount and Reference'),
]
@api.model
def _get_rec_method(self):
return self._get_all_rec_method()
name = fields.Selection('_get_rec_method', string='Type', required=True)
sequence = fields.Integer(string='Sequence',
default=1,
required=True,
help="The sequence field is used to order "
"the reconcile method"
)
task_id = fields.Many2one('account.easy.reconcile',
string='Task',
required=True,
ondelete='cascade'
)
company_id = fields.Many2one('res.company',
string='Company',
related="task_id.company_id",
store=True,
readonly=True
)
class AccountEasyReconcile(models.Model):
_name = 'account.easy.reconcile'
_inherit = ['mail.thread']
_description = 'account easy reconcile'
@api.one
@api.depends('account')
def _get_total_unrec(self):
obj_move_line = self.env['account.move.line']
self.unreconciled_count = obj_move_line.search_count(
[('account_id', '=', self.account.id),
('reconcile_id', '=', False),
('reconcile_partial_id', '=', False)],
)
@api.one
@api.depends('account')
def _get_partial_rec(self):
obj_move_line = self.env['account.move.line']
self.reconciled_partial_count = obj_move_line.search_count(
[('account_id', '=', self.account.id),
('reconcile_id', '=', False),
('reconcile_partial_id', '!=', False)],
)
@api.one
@api.depends('history_ids')
def _last_history(self):
# do a search() for retrieving the latest history line,
# as a read() will badly split the list of ids with 'date desc'
# and return the wrong result.
history_obj = self.env['easy.reconcile.history']
last_history_rs = history_obj.search(
[('easy_reconcile_id', '=', self.id)],
limit=1, order='date desc'
)
self.last_history = last_history_rs or False
name = fields.Char(string='Name', required=True)
account = fields.Many2one('account.account',
string='Account',
required=True,
)
reconcile_method = fields.One2many('account.easy.reconcile.method',
'task_id',
string='Method'
)
unreconciled_count = fields.Integer(string='Unreconciled Items',
compute='_get_total_unrec'
)
reconciled_partial_count = fields.Integer(
string='Partially Reconciled Items',
compute='_get_partial_rec'
)
history_ids = fields.One2many('easy.reconcile.history',
'easy_reconcile_id',
string='History',
readonly=True
)
last_history = fields.Many2one('easy.reconcile.history',
string='Last history', readonly=True,
compute='_last_history',
)
company_id = fields.Many2one('res.company', string='Company')
@api.model
def _prepare_run_transient(self, rec_method):
return {'account_id': rec_method.task_id.account.id,
'write_off': rec_method.write_off,
'account_lost_id': (rec_method.account_lost_id.id),
'account_profit_id': (rec_method.account_profit_id.id),
'analytic_account_id': (rec_method.analytic_account_id.id),
'income_exchange_account_id':
(rec_method.income_exchange_account_id.id),
'expense_exchange_account_id':
(rec_method.income_exchange_account_id.id),
'journal_id': (rec_method.journal_id.id),
'date_base_on': rec_method.date_base_on,
'filter': rec_method.filter}
@api.multi
def run_reconcile(self):
def find_reconcile_ids(fieldname, move_line_ids):
if not move_line_ids:
return []
sql = ("SELECT DISTINCT " + fieldname +
" FROM account_move_line "
" WHERE id in %s "
" AND " + fieldname + " IS NOT NULL")
self.env.cr.execute(sql, (tuple(move_line_ids),))
res = self.env.cr.fetchall()
return [row[0] for row in res]
# we use a new cursor to be able to commit the reconciliation
# often. We have to create it here and not later to avoid problems
# where the new cursor sees the lines as reconciles but the old one
# does not.
for rec in self:
ctx = self.env.context.copy()
ctx['commit_every'] = (
rec.account.company_id.reconciliation_commit_every
)
if ctx['commit_every']:
new_cr = sql_db.db_connect(self.env.cr.dbname).cursor()
else:
new_cr = self.env.cr
try:
all_ml_rec_ids = []
all_ml_partial_ids = []
for method in rec.reconcile_method:
rec_model = self.env[method.name]
auto_rec_id = rec_model.create(
self._prepare_run_transient(method)
)
ml_rec_ids, ml_partial_ids = (
auto_rec_id.automatic_reconcile()
)
all_ml_rec_ids += ml_rec_ids
all_ml_partial_ids += ml_partial_ids
reconcile_ids = find_reconcile_ids(
'reconcile_id',
all_ml_rec_ids
)
partial_ids = find_reconcile_ids(
'reconcile_partial_id',
all_ml_partial_ids
)
self.env['easy.reconcile.history'].create(
{
'easy_reconcile_id': rec.id,
'date': fields.Datetime.now(),
'reconcile_ids': [
(4, rid) for rid in reconcile_ids
],
'reconcile_partial_ids': [
(4, rid) for rid in partial_ids
],
})
except Exception as e:
# In case of error, we log it in the mail thread, log the
# stack trace and create an empty history line; otherwise,
# the cron will just loop on this reconcile task.
_logger.exception(
"The reconcile task %s had an exception: %s",
rec.name, e.message
)
message = _("There was an error during reconciliation : %s") \
% e.message
rec.message_post(body=message)
self.env['easy.reconcile.history'].create(
{
'easy_reconcile_id': rec.id,
'date': fields.Datetime.now(),
'reconcile_ids': [],
'reconcile_partial_ids': [],
}
)
finally:
if ctx['commit_every']:
new_cr.commit()
new_cr.close()
return True
@api.multi
def _no_history(self):
""" Raise an `orm.except_orm` error, supposed to
be called when there is no history on the reconciliation
task.
"""
raise Warning(
_('There is no history of reconciled '
'items on the task: %s.') % self.name
)
@api.model
def _open_move_line_list(self, move_line_ids, name):
return {
'name': name,
'view_mode': 'tree,form',
'view_id': False,
'view_type': 'form',
'res_model': 'account.move.line',
'type': 'ir.actions.act_window',
'nodestroy': True,
'target': 'current',
'domain': unicode([('id', 'in', move_line_ids)]),
}
@api.multi
def open_unreconcile(self):
""" Open the view of move line with the unreconciled move lines"""
self.ensure_one()
obj_move_line = self.env['account.move.line']
lines = obj_move_line.search(
[('account_id', '=', self.account.id),
('reconcile_id', '=', False),
('reconcile_partial_id', '=', False)])
name = _('Unreconciled items')
return self._open_move_line_list(lines.ids or [], name)
@api.multi
def open_partial_reconcile(self):
""" Open the view of move line with the partially
reconciled move lines"""
self.ensure_one()
obj_move_line = self.env['account.move.line']
lines = obj_move_line.search(
[('account_id', '=', self.account.id),
('reconcile_id', '=', False),
('reconcile_partial_id', '!=', False)])
name = _('Partial reconciled items')
return self._open_move_line_list(lines.ids or [], name)
@api.multi
def last_history_reconcile(self):
""" Get the last history record for this reconciliation profile
and return the action which opens move lines reconciled
"""
if not self.last_history:
self._no_history()
return self.last_history.open_reconcile()
@api.multi
def last_history_partial(self):
""" Get the last history record for this reconciliation profile
and return the action which opens move lines reconciled
"""
if not self.last_history:
self._no_history()
return self.last_history.open_partial()
@api.model
def run_scheduler(self, run_all=None):
""" Launch the reconcile with the oldest run
This function is mostly here to be used with cron task
:param run_all: if set it will ingore lookup and launch
all reconciliation
:returns: True in case of success or raises an exception
"""
def _get_date(reconcile):
if reconcile.last_history.date:
return fields.Datetime.from_string(reconcile.last_history.date)
else:
return datetime.min
reconciles = self.search([])
assert reconciles.ids, "No easy reconcile available"
if run_all:
reconciles.run_reconcile()
return True
reconciles.sorted(key=_get_date)
older = reconciles[0]
older.run_reconcile()
return True