currency_rate_date_check.py

# -*- encoding: utf-8 -*-
##############################################################################
#
#    Currency rate date check module for OpenERP
#    Copyright (C) 2012-2013 Akretion (http://www.akretion.com)
#    @author Alexis de Lattre <alexis.delattre@akretion.com>
#
#    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 openerp import models, fields, _
from openerp.exceptions import Warning

# Here are some explainations about the design of this module.
# In odoo/openerp/addons/base/res/res_currency.py :
# compute() -> _get_conversion_rate()
# -> _current_rate() -> _get_current_rate()
# The date used for the rate is the one in the context

# Which one of the 3 functions should we inherit ? Good question...
# It's probably better to inherit the lowest level function,
# i.e. _get_current_rate()
# Advantage : by inheriting the lowest level function,
# we can be sure that the check
# always apply, even for scenarios where we
# read the field "rate" of the obj currency
# => that's the solution I implement in the code below


class ResCurrency(models.Model):
    _inherit = 'res.currency'

    def _get_current_rate(
            self, cr, uid, ids, raise_on_no_rate=True, context=None):
        if context is None:
            context = {}
        # We don't check if we don't have 'date' in context, which is
        # a pb because it means Odoo can do a rate conversion
        # on today's date with an old rate, but otherwize it would raise
        # too often, for example it would raise entering the
        # Currencies menu entry !
        if context.get('date') and not context.get('disable_rate_date_check'):
            date = context.get('date')
            for currency_id in ids:
                # We could get the company from the currency, but it's not a
                # 'required' field, so we should probably continue to get it
                # from the user, shouldn't we ?
                user = self.pool['res.users'].browse(cr, uid, uid,
                                                     context=context)
                # if it's the company currency, don't do anything
                # (there is just one old rate at 1.0)
                if user.company_id.currency_id.id == currency_id:
                    continue
                else:
                    # now we do the real work !
                    cr.execute(
                        'SELECT rate, name FROM res_currency_rate '
                        'WHERE currency_id = %s '
                        'AND name <= %s '
                        'ORDER BY name desc LIMIT 1',
                        (currency_id, date))
                    if cr.rowcount:
                        rate_date = cr.fetchone()[1]
                        rate_date_dt = fields.Datetime.from_string(rate_date)
                        date_dt = fields.Datetime.from_string(date)
                        max_delta = user.company_id.currency_rate_max_delta
                        if (date_dt - rate_date_dt).days > max_delta:
                            currency = self.browse(
                                cr, uid, currency_id, context=context)
                            raise Warning(
                                _('You are requesting a rate conversion on %s '
                                  'for currency %s but the nearest '
                                  'rate before that date is '
                                  'dated %s and the maximum currency '
                                  'rate time delta for '
                                  'your company is %s days')
                                % (date, currency.name, rate_date, max_delta))
        # Now we call the regular function from the "base" module
        return super(ResCurrency, self)._get_current_rate(
            cr, uid, ids, raise_on_no_rate=raise_on_no_rate, context=context)