Merge lp:~camptocamp/account-financial-report/7.0-sync-afr_webkit-with-report_webkit into lp:~account-report-core-editor/account-financial-report/7.0

[Yannick Vaucher @ Camptocamp]

Adapt account_financial_report_webkit to fixes in addons

https://github.com/odoo/odoo/pull/55
https://github.com/odoo/odoo/pull/56

Plus few improvement following pep8 to remove useless variable and import

[Nicolas Bessi - Camptocamp (nbessi-c2c-deactivatedaccount)]

LGTM, taking in account that previous comment on source MP are still valid.

review: Approve

[Pedro Manuel Baeza (pedro.baeza)]

LGTM.

Regards.

review: Approve (code review)

[Guewen Baconnier @ Camptocamp (gbaconnier-c2c)]

Thanks

review: Approve (tested)

[Stéphane Bidoul (Acsone) (sbi)]

Hi,

Is it just me or this MP broke afr with ocb 7.0?

Traceback (most recent call last):
File "/home/openerp/instance/account-financial-report/account_financial_report_webkit/report/webkit_parser_header_fix.py", line 228, in create_single_pdf
**parser_instance.localcontext)
File "/home/openerp/instance/eggs/Mako-1.0.0-py2.7.egg/mako/template.py", line 443, in render
return runtime._render(self, self.callable_, args, data)
File "/home/openerp/instance/eggs/Mako-1.0.0-py2.7.egg/mako/runtime.py", line 803, in _render
**_kwargs_for_callable(callable_, data))
File "/home/openerp/instance/eggs/Mako-1.0.0-py2.7.egg/mako/runtime.py", line 835, in _render_context
_exec_template(inherit, lclcontext, args=args, kwargs=kwargs)
File "/home/openerp/instance/eggs/Mako-1.0.0-py2.7.egg/mako/runtime.py", line 860, in _exec_template
callable_(context, *args, **kwargs)
File "memory:0x5184dd0", line 22, in render_body
<%
TypeError: translate_call() takes exactly 2 arguments (3 given)

review: Needs Fixing (test)

[Stéphane Bidoul (Acsone) (sbi)]

reverting to rev 91 works

[Stéphane Bidoul (Acsone) (sbi)]

I'm using rev 5343 of ocb-server/7.0, which the latest on launchpad

Not sure what's going on. Unfortunately I can't dig deeper right now.

[Guewen Baconnier @ Camptocamp (gbaconnier-c2c)]

On 06/17/2014 09:29 PM, Stéphane Bidoul (Acsone) wrote:
> Review: Needs Fixing test
>
> Hi,
>
> Is it just me or this MP broke afr with ocb 7.0?
>
> Traceback (most recent call last):
> File "/home/openerp/instance/account-financial-report/account_financial_report_webkit/report/webkit_parser_header_fix.py", line 228, in create_single_pdf
> **parser_instance.localcontext)
> File "/home/openerp/instance/eggs/Mako-1.0.0-py2.7.egg/mako/template.py", line 443, in render
> return runtime._render(self, self.callable_, args, data)
> File "/home/openerp/instance/eggs/Mako-1.0.0-py2.7.egg/mako/runtime.py", line 803, in _render
> **_kwargs_for_callable(callable_, data))
> File "/home/openerp/instance/eggs/Mako-1.0.0-py2.7.egg/mako/runtime.py", line 835, in _render_context
> _exec_template(inherit, lclcontext, args=args, kwargs=kwargs)
> File "/home/openerp/instance/eggs/Mako-1.0.0-py2.7.egg/mako/runtime.py", line 860, in _exec_template
> callable_(context, *args, **kwargs)
> File "memory:0x5184dd0", line 22, in render_body
> <%
> TypeError: translate_call() takes exactly 2 arguments (3 given)
>
>

It is necessary to be compatible with this change:
https://github.com/odoo/odoo/pull/56
That has been merged in official branches.

I didn't noticed that it was not working in ocb because in my local OCB
branch (which is a bit out of date), the patch was there:

revno: 10194 [merge]
author: <email address hidden>
committer: Leonardo Pistone <email address hidden>
branch nick: 7.0-ocb
timestamp: Wed 2014-05-21 10:58:28 +0200
message:
  Transmit parser_instance using partial function for mako translation
callback.

  This to remove parser_instance from attribute as it can cause race
condition
  on cursors.

But it is no longer there when I look in the current ocb-addons tree.

I guess we should propose the MP again on OCB

--
Guewen Baconnier
Business Solutions Software Developer

Camptocamp SA
PSE A, CH-1015 Lausanne
Phone: [phone]
Office: [phone]
http://www.camptocamp.com/

[Yannick Vaucher @ Camptocamp (yvaucher-c2c)]

This has been fixed by Pedro, some revision were overwritten last week and are now back in OCB.

Thanks for noticing it Stéphane

[Stéphane Bidoul (Acsone) (sbi)]

Tested again with ocb-addons/7.0 HEAD.

Situation is recovered. Thanks!

review: Approve

=== modified file 'account_financial_report_webkit/report/webkit_parser_header_fix.py'
--- account_financial_report_webkit/report/webkit_parser_header_fix.py	2014-03-18 14:55:32 +0000
+++ account_financial_report_webkit/report/webkit_parser_header_fix.py	2014-06-13 12:07:01 +0000
@@ -30,8 +30,8 @@
 import os
 import subprocess
 import tempfile
-import time
 import logging
+from functools import partial
 
 
 from mako import exceptions
@@ -48,11 +48,12 @@
 # Class used only as a workaround to bug:
 # http://code.google.com/p/wkhtmltopdf/issues/detail?id=656
 
-# html headers and footers do not work on big files (hundreds of pages) so we replace them by
-# text headers and footers passed as arguments to wkhtmltopdf
+# html headers and footers do not work on big files (hundreds of pages) so we
+# replace them by text headers and footers passed as arguments to wkhtmltopdf
 # this class has to be removed once the bug is fixed
 
-# in your report class, to print headers and footers as text, you have to add them in the localcontext with a key 'additional_args'
+# in your report class, to print headers and footers as text, you have to add
+# them in the localcontext with a key 'additional_args'
 # for instance:
 #        header_report_name = _('PARTNER LEDGER')
 #        footer_date_time = self.formatLang(str(datetime.today()), date_time=True)
@@ -75,23 +76,25 @@
 from mako.template import Template
 from mako.lookup import TemplateLookup
 
+
 def mako_template(text):
     """Build a Mako template.
 
     This template uses UTF-8 encoding
     """
-    tmp_lookup  = TemplateLookup() #we need it in order to allow inclusion and inheritance
+    tmp_lookup = TemplateLookup()  # we need it in order to allow inclusion and inheritance
     return Template(text, input_encoding='utf-8', output_encoding='utf-8', lookup=tmp_lookup)
 
 
 class HeaderFooterTextWebKitParser(webkit_report.WebKitParser):
 
-    def generate_pdf(self, comm_path, report_xml, header, footer, html_list, webkit_header=False):
+    def generate_pdf(self, comm_path, report_xml, header, footer, html_list,
+                     webkit_header=False, parser_instance=False):
         """Call webkit in order to generate pdf"""
         if not webkit_header:
             webkit_header = report_xml.webkit_header
-        tmp_dir = tempfile.gettempdir()
-        out_filename = tempfile.mktemp(suffix=".pdf", prefix="webkit.tmp.")
+        fd, out_filename = tempfile.mkstemp(suffix=".pdf",
+                                            prefix="webkit.tmp.")
         file_to_del = [out_filename]
         if comm_path:
             command = [comm_path]
@@ -115,16 +118,16 @@
         if webkit_header.format:
             command.extend(['--page-size', str(webkit_header.format).replace(',', '.')])
 
-        if self.parser_instance.localcontext.get('additional_args', False):
-            for arg in self.parser_instance.localcontext['additional_args']:
+        if parser_instance.localcontext.get('additional_args', False):
+            for arg in parser_instance.localcontext['additional_args']:
                 command.extend(arg)
 
         count = 0
         for html in html_list:
-            html_file = file(os.path.join(tmp_dir, str(time.time()) + str(count) +'.body.html'), 'w')
-            count += 1
-            html_file.write(html)
-            html_file.close()
+            with tempfile.NamedTemporaryFile(suffix="%d.body.html" % count,
+                                             delete=False) as html_file:
+                count += 1
+                html_file.write(self._sanitize_html(html))
             file_to_del.append(html_file.name)
             command.append(html_file.name)
         command.append(out_filename)
@@ -132,8 +135,8 @@
         file_to_del.append(stderr_path)
         try:
             status = subprocess.call(command, stderr=stderr_fd)
-            os.close(stderr_fd) # ensure flush before reading
-            stderr_fd = None # avoid closing again in finally block
+            os.close(stderr_fd)  # ensure flush before reading
+            stderr_fd = None  # avoid closing again in finally block
             fobj = open(stderr_path, 'r')
             error_message = fobj.read()
             fobj.close()
@@ -142,11 +145,11 @@
             else:
                 error_message = _('The following diagnosis message was provided:\n') + error_message
             if status:
-                raise except_osv(_('Webkit error' ),
+                raise except_osv(_('Webkit error'),
                                  _("The command 'wkhtmltopdf' failed with error code = %s. Message: %s") % (status, error_message))
-            pdf_file = open(out_filename, 'rb')
-            pdf = pdf_file.read()
-            pdf_file.close()
+            with open(out_filename, 'rb') as pdf_file:
+                pdf = pdf_file.read()
+            os.close(fd)
         finally:
             if stderr_fd is not None:
                 os.close(stderr_fd)
@@ -160,57 +163,60 @@
     # override needed to keep the attachments' storing procedure
     def create_single_pdf(self, cursor, uid, ids, data, report_xml, context=None):
         """generate the PDF"""
+
         if context is None:
-            context={}
+            context = {}
         htmls = []
         if report_xml.report_type != 'webkit':
-            return super(HeaderFooterTextWebKitParser,self).create_single_pdf(cursor, uid, ids, data, report_xml, context=context)
+            return super(HeaderFooterTextWebKitParser, self
+                         ).create_single_pdf(cursor, uid, ids, data,
+                                             report_xml, context=context)
 
-        self.parser_instance = self.parser(cursor,
-                                           uid,
-                                           self.name2,
-                                           context=context)
+        parser_instance = self.parser(cursor,
+                                      uid,
+                                      self.name2,
+                                      context=context)
 
         self.pool = pooler.get_pool(cursor.dbname)
         objs = self.getObjects(cursor, uid, ids, context)
-        self.parser_instance.set_context(objs, data, ids, report_xml.report_type)
+        parser_instance.set_context(objs, data, ids, report_xml.report_type)
 
-        template =  False
+        template = False
 
         if report_xml.report_file:
             path = addons.get_module_resource(*report_xml.report_file.split(os.path.sep))
             if os.path.exists(path):
                 template = file(path).read()
         if not template and report_xml.report_webkit_data:
-            template =  report_xml.report_webkit_data
+            template = report_xml.report_webkit_data
         if not template:
             raise except_osv(_('Error!'), _('Webkit Report template not found !'))
         header = report_xml.webkit_header.html
-        footer = report_xml.webkit_header.footer_html
+
         if not header and report_xml.header:
             raise except_osv(
                   _('No header defined for this Webkit report!'),
-                  _('Please set a header in company settings')
+                  _('Please set a header in company settings.')
               )
 
         css = report_xml.webkit_header.css
         if not css:
             css = ''
-        user = self.pool.get('res.users').browse(cursor, uid, uid)
 
+        translate_call = partial(self.translate_call, parser_instance)
         #default_filters=['unicode', 'entity'] can be used to set global filter
         body_mako_tpl = mako_template(template)
         helper = WebKitHelper(cursor, uid, report_xml.id, context)
         if report_xml.precise_mode:
             for obj in objs:
-                self.parser_instance.localcontext['objects'] = [obj]
+                parser_instance.localcontext['objects'] = [obj]
                 try:
                     html = body_mako_tpl.render(helper=helper,
                                                 css=css,
-                                                _=self.translate_call,
-                                                **self.parser_instance.localcontext)
+                                                _=translate_call,
+                                                **parser_instance.localcontext)
                     htmls.append(html)
-                except Exception, e:
+                except Exception:
                     msg = exceptions.text_error_template().render()
                     _logger.error(msg)
                     raise except_osv(_('Webkit render'), msg)
@@ -218,15 +224,16 @@
             try:
                 html = body_mako_tpl.render(helper=helper,
                                             css=css,
-                                            _=self.translate_call,
-                                            **self.parser_instance.localcontext)
+                                            _=translate_call,
+                                            **parser_instance.localcontext)
                 htmls.append(html)
-            except Exception, e:
+            except Exception:
                 msg = exceptions.text_error_template().render()
                 _logger.error(msg)
                 raise except_osv(_('Webkit render'), msg)
 
-        # NO html footer and header because we write them as text with wkhtmltopdf
+        # NO html footer and header because we write them as text with
+        # wkhtmltopdf
         head = foot = False
 
         if report_xml.webkit_debug:
@@ -234,13 +241,14 @@
                 deb = body_mako_tpl.render(helper=helper,
                                            css=css,
                                            _debug=tools.ustr("\n".join(htmls)),
-                                           _=self.translate_call,
-                                           **self.parser_instance.localcontext)
-            except Exception, e:
+                                           _=translate_call,
+                                           **parser_instance.localcontext)
+            except Exception:
                 msg = exceptions.text_error_template().render()
                 _logger.error(msg)
                 raise except_osv(_('Webkit render'), msg)
             return (deb, 'html')
         bin = self.get_lib(cursor, uid)
-        pdf = self.generate_pdf(bin, report_xml, head, foot, htmls)
+        pdf = self.generate_pdf(bin, report_xml, head, foot, htmls,
+                                parser_instance=parser_instance)
         return (pdf, 'pdf')