[MIG] report_py3o: Migration to 19.0

Author: kopeyev

report_py3o/__manifest__.py

@@ -4,7 +4,7 @@
     "name": "Py3o Report Engine",
     "summary": "Reporting engine based on Libreoffice (ODT -> ODT, "
     "ODT -> PDF, ODT -> DOC, ODT -> DOCX, ODS -> ODS, etc.)",
-    "version": "18.0.1.0.2",
+    "version": "19.0.1.0.0",
     "category": "Reporting",
     "license": "AGPL-3",
     "author": "XCG Consulting, ACSONE SA/NV, Odoo Community Association (OCA)",

report_py3o/static/src/js/py3oactionservice.esm.js

@@ -1,5 +1,3 @@
-/** @odoo-module **/
-
 import {download} from "@web/core/network/download";
 import {registry} from "@web/core/registry";
 

report_py3o/tests/test_report_py3o.py

@@ -26,9 +26,9 @@
 
 from odoo.addons.base.tests.test_mimetypes import PNG
 
-from ..models._py3o_parser_context import format_multiline_value
 from ..models.ir_actions_report import PY3O_CONVERSION_COMMAND_PARAMETER
-from ..models.py3o_report import TemplateNotFound
+from ..wizard._py3o_parser_context import format_multiline_value
+from ..wizard.py3o_report import TemplateNotFound
 
 logger = logging.getLogger(__name__)
 
@@ -91,8 +91,17 @@ def test_reports(self):
 
     def test_reports_merge_zip(self):
         self.report.py3o_filetype = "odt"
-        users = self.env["res.users"].search([])
-        self.assertTrue(len(users) > 0)
+        users = self.env["res.users"].search([], limit=2)
+        if len(users) < 2:
+            users |= self.env["res.users"].create(
+                {
+                    "name": "Test User 2",
+                    "login": f"test_user_2_{self.env.cr.dbname}",
+                    "email": f"test_user_2_{self.env.cr.dbname}@example.com",
+                }
+            )
+        self.assertGreaterEqual(len(users), 2)
+        users.write({"image_1920": PNG})
         py3o_report = self.env["py3o.report"]
         _zip_results = self.py3o_report._zip_results
         with mock.patch.object(
@@ -147,7 +156,7 @@ def test_report_post_process(self):
         self.assertEqual(self.env.user.id, attachements.res_id)
         self.assertEqual(b"test result", b64decode(attachements.datas))
 
-    @tools.misc.mute_logger("odoo.addons.report_py3o.models.py3o_report")
+    @tools.misc.mute_logger("odoo.addons.report_py3o.wizard.py3o_report")
     def test_report_template_configs(self):
         # the demo template is specified with a relative path in in the module
         # path
@@ -169,9 +178,9 @@ def test_report_template_configs(self):
             self.report._render(self.report.id, self.env.user.ids)
         with temporary_copy(flbk_filename) as tmp_filename:
             self.report.py3o_template_fallback = tmp_filename
-            tools.config.misc["report_py3o"] = {
-                "root_tmpl_path": os.path.realpath(os.path.dirname(tmp_filename))
-            }
+            tools.config["root_tmpl_path"] = os.path.realpath(
+                os.path.dirname(tmp_filename)
+            )
             res = self.report._render(self.report.id, self.env.user.ids)
             self.assertTrue(res)
 
@@ -192,7 +201,7 @@ def test_report_template_configs(self):
         res = self.report._render(self.report.id, self.env.user.ids)
         self.assertTrue(res)
 
-    @tools.misc.mute_logger("odoo.addons.report_py3o.models.py3o_report")
+    @tools.misc.mute_logger("odoo.addons.report_py3o.wizard.py3o_report")
     def test_report_template_fallback_validity(self):
         tmpl_name = self.report.py3o_template_fallback
         with as_file(files(f"odoo.addons.{self.report.module}")) as _asf:

report_py3o/views/py3o_template.xml

@@ -7,13 +7,11 @@
             <search>
                 <field name="name" />
                 <field name="filetype" />
-                <group string="Group By" name="groupby">
-                    <filter
-                        name="filetype_groupby"
-                        string="File Type"
-                        context="{'group_by': 'filetype'}"
-                    />
-                </group>
+                <filter
+                    name="filetype_groupby"
+                    string="File Type"
+                    context="{'group_by': 'filetype'}"
+                />
             </search>
         </field>
     </record>

report_py3o/wizard/py3o_report.py

@@ -9,19 +9,40 @@
 import tempfile
 import warnings
 from base64 import b64decode
+from configparser import ConfigParser
 from contextlib import closing
 from importlib.resources import files
 from io import BytesIO
 from zipfile import ZIP_DEFLATED, ZipFile
 
-from odoo import api, fields, models, tools
+from odoo import api, fields, models
 from odoo.exceptions import AccessError
+from odoo.tools import config
 from odoo.tools.safe_eval import safe_eval, time
 
 from ._py3o_parser_context import Py3oParserContext
 
 logger = logging.getLogger(__name__)
 
+try:
+    # Preferred source when available: structured [report_py3o] section provided
+    # by OCA's server_environment addon.
+    from odoo.addons.server_environment import serv_config
+
+    if serv_config.has_section("report_py3o"):
+        report_py3o_config = serv_config["report_py3o"]
+    else:
+        report_py3o_config = {}
+except ImportError:
+    # No server_environment: try to read a [report_py3o] section from odoo.conf
+    report_py3o_config = {}
+    cfg_path = config.get("config")
+    if cfg_path:
+        cp = ConfigParser(interpolation=None)
+        cp.read(cfg_path)
+        if cp.has_section("report_py3o"):
+            report_py3o_config = dict(cp["report_py3o"])
+
 try:
     # workaround for https://github.com/edgewall/genshi/issues/15
     # that makes runbot build red because of the DeprecationWarning
@@ -86,7 +107,11 @@ class Py3oReport(models.TransientModel):
     def _is_valid_template_path(self, path):
         """Check if the path is a trusted path for py3o templates."""
         real_path = os.path.realpath(path)
-        root_path = tools.config.get_misc("report_py3o", "root_tmpl_path")
+        root_path = report_py3o_config.get("root_tmpl_path") or config.get(
+            "root_tmpl_path"
+        )
+        if root_path:
+            root_path = os.path.realpath(root_path.strip()).rstrip(os.path.sep)
         if not root_path:
             logger.warning(
                 "You must provide a root template path into odoo.cfg to be "
@@ -95,7 +120,10 @@ def _is_valid_template_path(self, path):
                 real_path,
             )
             return False
-        is_valid = real_path.startswith(root_path + os.path.sep)
+        try:
+            is_valid = os.path.commonpath([root_path, real_path]) == root_path
+        except ValueError:
+            is_valid = False
         if not is_valid:
             logger.warning(
                 "Py3o template path is not valid. %s is not a child of root path %s",