intrastat-extrastat/intrastat_base/intrastat_common.py

# -*- encoding: utf-8 -*-
##############################################################################
#
#    Report intrastat base module for OpenERP
#    Copyright (C) 2010-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.osv import orm
from openerp.tools.translate import _
from openerp import tools
from datetime import datetime
from dateutil.relativedelta import relativedelta
import logging

logger = logging.getLogger(__name__)


class report_intrastat_common(orm.TransientModel):
    _name = "report.intrastat.common"
    _description = "Common functions for intrastat reports for products "
    "and services"

    def _compute_numbers(self, cr, uid, ids, object, context=None):
        result = {}
        for intrastat in object.browse(cr, uid, ids, context=context):
            total_amount = 0.0
            num_lines = 0
            for line in intrastat.intrastat_line_ids:
                total_amount += line.amount_company_currency
                num_lines += 1
            result[intrastat.id] = {
                'num_lines': num_lines,
                'total_amount': total_amount,
                }
        return result

    def _compute_dates(self, cr, uid, ids, object, context=None):
        result = {}
        for intrastat in object.browse(cr, uid, ids, context=context):
            start_date_datetime = datetime.strptime(
                intrastat.start_date, '%Y-%m-%d')
            end_date_str = datetime.strftime(
                start_date_datetime + relativedelta(day=31), '%Y-%m-%d')
            result[intrastat.id] = {
                'end_date': end_date_str,
                'year_month': start_date_datetime.strftime('%Y-%m'),
                }
        return result

    def _check_start_date(self, cr, uid, ids, object, context=None):
        '''Check that the start date is the first day of the month'''
        for date_to_check in object.read(
                cr, uid, ids, ['start_date'], context=context):
            datetime_to_check = datetime.strptime(
                date_to_check['start_date'], '%Y-%m-%d')
            if datetime_to_check.day != 1:
                return False
        return True

    def check_generate_lines(self, cr, uid, intrastat, context=None):
        """Check wether all requirements are met for generating lines."""
        if not intrastat.company_id:
            # Should not be possible, but just in case:
            raise orm.except_orm(
                _('Error :'),
                _("Company not yet set on intrastat report.")
            )
        company_obj = intrastat.company_id  # Simplify references
        if not company_obj.country_id:
            raise orm.except_orm(
                _('Error :'),
                _("The country is not set on the company '%s'.")
                % company_obj.name
            )
        if not company_obj.currency_id.name == 'EUR':
            raise orm.except_orm(
                _('Error :'),
                _("The company currency must be 'EUR', but is currently '%s'.")
                % company_obj.currency_id.name
            )
        return True

    def _check_generate_xml(self, cr, uid, intrastat, context=None):
        if not intrastat.company_id.partner_id.vat:
            raise orm.except_orm(
                _('Error :'),
                _("The VAT number is not set for the partner '%s'.")
                % intrastat.company_id.partner_id.name)
        return True

    def _check_xml_schema(
            self, cr, uid, xml_root, xml_string, xsd_file, context=None):
        '''Validate the XML file against the XSD'''
        from lxml import etree
        xsd_etree_obj = etree.parse(
            tools.file_open(xsd_file))
        official_schema = etree.XMLSchema(xsd_etree_obj)
        try:
            official_schema.assertValid(xml_root)
        except Exception, e:
            # if the validation of the XSD fails, we arrive here
            _logger = logging.getLogger(__name__)
            _logger.warning(
                "The XML file is invalid against the XML Schema Definition")
            _logger.warning(xml_string)
            _logger.warning(e)
            raise orm.except_orm(
                _('Error :'),
                _("The generated XML file is not valid against the official "
                    "XML Schema Definition. The generated XML file and the "
                    "full error have been written in the server logs. "
                    "Here is the error, which may give you an idea on the "
                    "cause of the problem : %s.")
                % str(e))
        return True

    def _attach_xml_file(
            self, cr, uid, ids, object, xml_string, start_date_datetime,
            declaration_name, context=None):
        '''Attach the XML file to the report_intrastat_product/service '''
        '''object'''
        import base64
        assert len(ids) == 1, "Only one ID accepted"
        filename = '%s_%s.xml' % (
            datetime.strftime(start_date_datetime, '%Y-%m'),
            declaration_name)
        if not context:
            context = {}
        context.update({
            'default_res_id': ids[0],
            'default_res_model': object._name
            })
        attach_id = self.pool['ir.attachment'].create(
            cr, uid, {
                'name': filename,
                'datas': base64.encodestring(xml_string),
                'datas_fname': filename},
            context=context)
        return attach_id

    def _open_attach_view(
            self, cr, uid, attach_id, title='XML file', context=None):
        '''Returns an action which opens the form view of the '''
        '''corresponding attachement'''
        action = {
            'name': title,
            'view_type': 'form',
            'view_mode': 'form,tree',
            'view_id': False,
            'res_model': 'ir.attachment',
            'type': 'ir.actions.act_window',
            'nodestroy': True,
            'target': 'current',
            'res_id': attach_id,
            }
        return action

    def partner_on_change(self, cr, uid, ids, partner_id=False, context=None):
        result = {}
        result['value'] = {}
        if partner_id:
            company = self.pool['res.partner'].read(
                cr, uid, partner_id, ['vat'], context=context)
            result['value']['partner_vat'] = company['vat']
        return result

    def send_reminder_email(
            self, cr, uid, company, module_name, template_xmlid,
            intrastat_id, context=None):
        template_model, template_id =\
            self.pool['ir.model.data'].get_object_reference(
                cr, uid, module_name, template_xmlid)
        assert template_model == 'email.template', 'Wrong model'
        if company.intrastat_remind_user_ids:
            self.pool['email.template'].send_mail(
                cr, uid, template_id, intrastat_id, context=context)
            logger.info(
                'Intrastat Reminder email has been sent (XMLID: %s).'
                % template_xmlid)
        else:
            logger.warning(
                'The list of users receiving the Intrastat Reminder is empty '
                'on company %s' % company.name)
        return True