mirror of
https://github.com/OCA/reporting-engine.git
synced 2025-02-16 16:30:38 +02:00
[IMP] Replace old style parser by TransientModel
The goal is to improve the modularity by making the parser a true inheritable odoo model and share part of the code with the 'report' model Conflicts: report_py3o/models/ir_actions_report_xml.py report_py3o/models/py3o_report.py report_py3o/tests/test_report_py3o.py
This commit is contained in:
Laurent Mignon
committed by
Elmeri Niemelä
Elmeri Niemelä
parent
1e01df761f
commit
1871d9829d
293
report_py3o/models/py3o_report.py
Normal file
293
report_py3o/models/py3o_report.py
Normal file
@@ -0,0 +1,293 @@
|
||||
# -*- coding: utf-8 -*-
|
||||
# Copyright 2013 XCG Consulting (http://odoo.consulting)
|
||||
# Copyright 2016 ACSONE SA/NV
|
||||
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl)
|
||||
import base64
|
||||
from base64 import b64decode
|
||||
from cStringIO import StringIO
|
||||
import json
|
||||
import logging
|
||||
import os
|
||||
import pkg_resources
|
||||
import requests
|
||||
import sys
|
||||
from tempfile import NamedTemporaryFile
|
||||
from odoo import exceptions
|
||||
from odoo.report.report_sxw import report_sxw
|
||||
import logging
|
||||
from zipfile import ZipFile, ZIP_DEFLATED
|
||||
from openerp import api, fields, models, _
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
try:
|
||||
from py3o.template.helpers import Py3oConvertor
|
||||
from py3o.template import Template
|
||||
from py3o import formats
|
||||
except ImportError:
|
||||
logger.debug('Cannot import py3o.template')
|
||||
try:
|
||||
from py3o.formats import Formats
|
||||
except ImportError:
|
||||
logger.debug('Cannot import py3o.formats')
|
||||
|
||||
|
||||
_extender_functions = {}
|
||||
|
||||
|
||||
class TemplateNotFound(Exception):
|
||||
pass
|
||||
|
||||
|
||||
def py3o_report_extender(report_xml_id=None):
|
||||
"""
|
||||
A decorator to define function to extend the context sent to a template.
|
||||
This will be called at the creation of the report.
|
||||
The following arguments will be passed to it:
|
||||
- ir_report: report instance
|
||||
- localcontext: The context that will be passed to the report engine
|
||||
If no report_xml_id is given the extender is registered for all py3o
|
||||
reports
|
||||
Idea copied from CampToCamp report_webkit module.
|
||||
|
||||
:param report_xml_id: xml id of the report
|
||||
:return: a decorated class
|
||||
"""
|
||||
global _extender_functions
|
||||
|
||||
def fct1(fct):
|
||||
_extender_functions.setdefault(report_xml_id, []).append(fct)
|
||||
return fct
|
||||
return fct1
|
||||
|
||||
|
||||
@py3o_report_extender()
|
||||
def defautl_extend(report_xml, localcontext):
|
||||
# add the base64decode function to be able do decode binary fields into
|
||||
# the template
|
||||
localcontext['b64decode'] = b64decode
|
||||
localcontext['report_xml'] = report_xml
|
||||
|
||||
|
||||
class Py3oReport(models.TransientModel):
|
||||
_name = "py3o.report"
|
||||
_inherit = 'report'
|
||||
_description = "Report Py30"
|
||||
|
||||
ir_actions_report_xml_id = fields.Many2one(
|
||||
comodel_name="ir.actions.report.xml",
|
||||
required=True
|
||||
)
|
||||
|
||||
@api.multi
|
||||
def get_template(self):
|
||||
"""private helper to fetch the template data either from the database
|
||||
or from the default template file provided by the implementer.
|
||||
|
||||
ATM this method takes a report definition recordset
|
||||
to try and fetch the report template from database. If not found it
|
||||
will fallback to the template file referenced in the report definition.
|
||||
|
||||
@returns: string or buffer containing the template data
|
||||
|
||||
@raises: TemplateNotFound which is a subclass of
|
||||
odoo.exceptions.DeferredException
|
||||
"""
|
||||
self.ensure_one()
|
||||
tmpl_data = None
|
||||
report_xml = self.ir_actions_report_xml_id
|
||||
if report_xml.py3o_template_id and report_xml.py3o_template_id.id:
|
||||
# if a user gave a report template
|
||||
tmpl_data = b64decode(
|
||||
report_xml.py3o_template_id.py3o_template_data
|
||||
)
|
||||
|
||||
elif report_xml.py3o_template_fallback:
|
||||
tmpl_name = report_xml.py3o_template_fallback
|
||||
flbk_filename = None
|
||||
if report_xml.module:
|
||||
# if the default is defined
|
||||
flbk_filename = pkg_resources.resource_filename(
|
||||
"odoo.addons.%s" % report_xml.module,
|
||||
tmpl_name,
|
||||
)
|
||||
elif os.path.isabs(tmpl_name):
|
||||
# It is an absolute path
|
||||
flbk_filename = os.path.normcase(os.path.normpath(tmpl_name))
|
||||
if flbk_filename and os.path.exists(flbk_filename):
|
||||
# and it exists on the fileystem
|
||||
with open(flbk_filename, 'r') as tmpl:
|
||||
tmpl_data = tmpl.read()
|
||||
|
||||
if tmpl_data is None:
|
||||
# if for any reason the template is not found
|
||||
raise TemplateNotFound(
|
||||
_(u'No template found. Aborting.'),
|
||||
sys.exc_info(),
|
||||
)
|
||||
|
||||
return tmpl_data
|
||||
|
||||
@api.multi
|
||||
def _extend_parser_context(self, context_instance, report_xml):
|
||||
# add default extenders
|
||||
for fct in _extender_functions.get(None, []):
|
||||
fct(report_xml, context_instance.localcontext)
|
||||
# add extenders for registered on the template
|
||||
xml_id = report_xml.get_external_id().get(report_xml.id)
|
||||
if xml_id in _extender_functions:
|
||||
for fct in _extender_functions[xml_id]:
|
||||
fct(report_xml, context_instance.localcontext)
|
||||
|
||||
@api.multi
|
||||
def _get_parser_context(self, model_instance, data):
|
||||
report_xml = self.ir_actions_report_xml_id
|
||||
context_instance = rml_parse(self.env.cr, self.env.uid,
|
||||
report_xml.name,
|
||||
context=self.env.context)
|
||||
context_instance.set_context(model_instance, data, model_instance.ids,
|
||||
report_xml.report_type)
|
||||
self._extend_parser_context(context_instance, report_xml)
|
||||
return context_instance.localcontext
|
||||
|
||||
@api.multi
|
||||
def _postprocess_report(self, content, res_id, save_in_attachment):
|
||||
if save_in_attachment.get(res_id):
|
||||
attachment = {
|
||||
'name': save_in_attachment.get(res_id),
|
||||
'datas': base64.encodestring(content),
|
||||
'datas_fname': save_in_attachment.get(res_id),
|
||||
'res_model': save_in_attachment.get('model'),
|
||||
'res_id': res_id,
|
||||
}
|
||||
return self.env['ir.attachment'].create(attachment)
|
||||
return False
|
||||
|
||||
@api.multi
|
||||
def _create_single_report(self, model_instance, data, save_in_attachment):
|
||||
""" This function to generate our py3o report
|
||||
"""
|
||||
self.ensure_one()
|
||||
report_xml = self.ir_actions_report_xml_id
|
||||
|
||||
tmpl_data = self.get_template()
|
||||
|
||||
in_stream = StringIO(tmpl_data)
|
||||
out_stream = StringIO()
|
||||
template = Template(in_stream, out_stream, escape_false=True)
|
||||
localcontext = self._get_parser_context(model_instance, data)
|
||||
if report_xml.py3o_is_local_fusion:
|
||||
template.render(localcontext)
|
||||
in_stream = out_stream
|
||||
datadict = {}
|
||||
else:
|
||||
expressions = template.get_all_user_python_expression()
|
||||
py_expression = template.convert_py3o_to_python_ast(expressions)
|
||||
convertor = Py3oConvertor()
|
||||
data_struct = convertor(py_expression)
|
||||
datadict = data_struct.render(localcontext)
|
||||
|
||||
filetype = report_xml.py3o_filetype
|
||||
is_native = Formats().get_format(filetype).native
|
||||
if is_native:
|
||||
res = out_stream.getvalue()
|
||||
else: # Call py3o.server to render the template in the desired format
|
||||
in_stream.seek(0)
|
||||
files = {
|
||||
'tmpl_file': in_stream,
|
||||
}
|
||||
fields = {
|
||||
"targetformat": filetype,
|
||||
"datadict": json.dumps(datadict),
|
||||
"image_mapping": "{}",
|
||||
}
|
||||
if report_xml.py3o_is_local_fusion:
|
||||
fields['skipfusion'] = '1'
|
||||
r = requests.post(
|
||||
report_xml.py3o_server_id.url, data=fields, files=files)
|
||||
if r.status_code != 200:
|
||||
# server says we have an issue... let's tell that to enduser
|
||||
raise UserError(
|
||||
_('Fusion server error %s') % r.text,
|
||||
)
|
||||
|
||||
# Here is a little joke about Odoo
|
||||
# we do nice chunked reading from the network...
|
||||
chunk_size = 1024
|
||||
with NamedTemporaryFile(
|
||||
suffix=filetype,
|
||||
prefix='py3o-template-'
|
||||
) as fd:
|
||||
for chunk in r.iter_content(chunk_size):
|
||||
fd.write(chunk)
|
||||
fd.seek(0)
|
||||
# ... but odoo wants the whole data in memory anyways :)
|
||||
res = fd.read()
|
||||
self._postprocess_report(
|
||||
res, model_instance.id, save_in_attachment)
|
||||
return res, "." + self.ir_actions_report_xml_id.py3o_filetype
|
||||
|
||||
@api.multi
|
||||
def _get_or_create_single_report(self, model_instance, data,
|
||||
save_in_attachment):
|
||||
self.ensure_one()
|
||||
if save_in_attachment and save_in_attachment[
|
||||
'loaded_documents'].get(model_instance.id):
|
||||
d = save_in_attachment[
|
||||
'loaded_documents'].get(model_instance.id)
|
||||
return d, self.ir_actions_report_xml_id.py3o_filetype
|
||||
return self._create_single_report(
|
||||
model_instance, data, save_in_attachment)
|
||||
|
||||
@api.multi
|
||||
def _zip_results(self, results):
|
||||
self.ensure_one()
|
||||
zfname_prefix = self.ir_actions_report_xml_id.name
|
||||
with NamedTemporaryFile(suffix="zip", prefix='py3o-zip-result') as fd:
|
||||
with ZipFile(fd, 'w', ZIP_DEFLATED) as zf:
|
||||
cpt = 0
|
||||
for r, ext in results:
|
||||
fname = "%s_%d.%s" % (zfname_prefix, cpt, ext)
|
||||
zf.writestr(fname, r)
|
||||
cpt += 1
|
||||
fd.seek(0)
|
||||
return fd.read(), 'zip'
|
||||
|
||||
@api.multi
|
||||
def _merge_pdfs(self, results):
|
||||
from pyPdf import PdfFileWriter, PdfFileReader
|
||||
output = PdfFileWriter()
|
||||
for r in results:
|
||||
reader = PdfFileReader(StringIO(r[0]))
|
||||
for page in range(reader.getNumPages()):
|
||||
output.addPage(reader.getPage(page))
|
||||
s = StringIO()
|
||||
output.write(s)
|
||||
return s.getvalue(), formats.FORMAT_PDF
|
||||
|
||||
@api.multi
|
||||
def _merge_results(self, results):
|
||||
self.ensure_one()
|
||||
if not results:
|
||||
return False, False
|
||||
if len(results) == 1:
|
||||
return results[0]
|
||||
filetype = self.ir_actions_report_xml_id.py3o_filetype
|
||||
if filetype == formats.FORMAT_PDF:
|
||||
return self._merge_pdfs(results)
|
||||
else:
|
||||
return self._zip_results(results)
|
||||
|
||||
@api.multi
|
||||
def create_report(self, res_ids, data):
|
||||
""" Override this function to handle our py3o report
|
||||
"""
|
||||
model_instances = self.env[self.ir_actions_report_xml_id.model].browse(
|
||||
res_ids)
|
||||
save_in_attachment = self._check_attachment_use(
|
||||
model_instances, self.ir_actions_report_xml_id) or {}
|
||||
results = []
|
||||
for model_instance in model_instances:
|
||||
results.append(self._get_or_create_single_report(
|
||||
model_instance, data, save_in_attachment))
|
||||
return self._merge_results(results)
|
||||
Reference in New Issue
Block a user