From 16a1b2836082cf89b6a5222d98ca6d0d3040eee4 Mon Sep 17 00:00:00 2001 From: Aungkokolin1997 Date: Tue, 28 May 2024 01:48:15 +0000 Subject: [PATCH] [ADD] report_text_format_option --- report_text_format_option/README.rst | 87 ++++ report_text_format_option/__init__.py | 1 + report_text_format_option/__manifest__.py | 14 + .../demo/report_demo.xml | 18 + report_text_format_option/models/__init__.py | 1 + .../models/ir_actions_report.py | 41 ++ .../readme/CONFIGURE.rst | 12 + .../readme/DESCRIPTION.rst | 1 + .../static/description/index.html | 430 ++++++++++++++++++ report_text_format_option/tests/__init__.py | 1 + .../tests/test_report_format_option.py | 54 +++ .../views/ir_actions_report_views.xml | 24 + .../odoo/addons/report_text_format_option | 1 + setup/report_text_format_option/setup.py | 6 + 14 files changed, 691 insertions(+) create mode 100644 report_text_format_option/README.rst create mode 100644 report_text_format_option/__init__.py create mode 100644 report_text_format_option/__manifest__.py create mode 100644 report_text_format_option/demo/report_demo.xml create mode 100644 report_text_format_option/models/__init__.py create mode 100644 report_text_format_option/models/ir_actions_report.py create mode 100644 report_text_format_option/readme/CONFIGURE.rst create mode 100644 report_text_format_option/readme/DESCRIPTION.rst create mode 100644 report_text_format_option/static/description/index.html create mode 100644 report_text_format_option/tests/__init__.py create mode 100644 report_text_format_option/tests/test_report_format_option.py create mode 100644 report_text_format_option/views/ir_actions_report_views.xml create mode 120000 setup/report_text_format_option/odoo/addons/report_text_format_option create mode 100644 setup/report_text_format_option/setup.py diff --git a/report_text_format_option/README.rst b/report_text_format_option/README.rst new file mode 100644 index 000000000..df94040d0 --- /dev/null +++ b/report_text_format_option/README.rst @@ -0,0 +1,87 @@ +========================= +Report Text Format Option +========================= + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:e3b9cc2a66291d03027c6100d82df8a6a0934f1802a392fe2ff1cad39557fe0d + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png + :target: https://odoo-community.org/page/development-status + :alt: Beta +.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png + :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html + :alt: License: LGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github + :target: https://github.com/OCA/reporting-engine/tree/16.0/report_text_format_option + :alt: OCA/reporting-engine +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/reporting-engine-16-0/reporting-engine-16-0-report_text_format_option + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png + :target: https://runboat.odoo-community.org/builds?repo=OCA/reporting-engine&target_branch=16.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This is a technical module designed to add encoding fields to the ir.actions.report model and is applied to Text type reports. + +**Table of contents** + +.. contents:: + :local: + +Configuration +============= + +In case the exported report should be encoded in another system than UTF-8, following +fields of the report record (*Settings > Technical > Reports*) should be populated accordingly. + +* Text Encoding: set an encoding system (such as cp932) +* Text Encode Error Handling: select 'Ignore' or 'Replace' as necessary. + * 'Ignore': in case of an encoding error, the problematic character will be removed from the exported file. + * 'Replace': in case of an encoding error, the problematic character will be replaced with '?' symbol. + * Leaving the field blank: in case of an encoding error, the report generation fails with an error message. +* Line Ending: Select the type of line ending, 'CRLF' or 'CR', as necessary. + * 'CRLF': 'Carriage Return' + 'Line Feed' (Windows) + * 'CR': 'Carriage Return' (classic Mac OS) + * Leaving this field blank defaults to using 'LF' (Line Feed), the default behavior of Odoo. + +Bug Tracker +=========== + +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us to smash it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* Quartile Limited + +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use. + +This module is part of the `OCA/reporting-engine `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/report_text_format_option/__init__.py b/report_text_format_option/__init__.py new file mode 100644 index 000000000..0650744f6 --- /dev/null +++ b/report_text_format_option/__init__.py @@ -0,0 +1 @@ +from . import models diff --git a/report_text_format_option/__manifest__.py b/report_text_format_option/__manifest__.py new file mode 100644 index 000000000..e72d4a85f --- /dev/null +++ b/report_text_format_option/__manifest__.py @@ -0,0 +1,14 @@ +# Copyright 2024 Quartile Limited +# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl.html). +{ + "name": "Report Text Format Option", + "author": "Quartile Limited, Odoo Community Association (OCA)", + "website": "https://github.com/OCA/reporting-engine", + "category": "Reporting", + "version": "16.0.1.0.0", + "license": "LGPL-3", + "depends": ["base"], + "data": ["views/ir_actions_report_views.xml"], + "demo": ["demo/report_demo.xml"], + "installable": True, +} diff --git a/report_text_format_option/demo/report_demo.xml b/report_text_format_option/demo/report_demo.xml new file mode 100644 index 000000000..7fd694528 --- /dev/null +++ b/report_text_format_option/demo/report_demo.xml @@ -0,0 +1,18 @@ + + + + Demo Text Report + res.partner + qweb-text + report_text_format_option.demo_report_template + report_text_format_option.demo_report_template + + + + + + diff --git a/report_text_format_option/models/__init__.py b/report_text_format_option/models/__init__.py new file mode 100644 index 000000000..a248cf216 --- /dev/null +++ b/report_text_format_option/models/__init__.py @@ -0,0 +1 @@ +from . import ir_actions_report diff --git a/report_text_format_option/models/ir_actions_report.py b/report_text_format_option/models/ir_actions_report.py new file mode 100644 index 000000000..1350f57cb --- /dev/null +++ b/report_text_format_option/models/ir_actions_report.py @@ -0,0 +1,41 @@ +# Copyright 2024 Quartile Limited +# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl). + +from odoo import api, fields, models + + +class IrActionReport(models.Model): + _inherit = "ir.actions.report" + + text_encoding = fields.Char( + help="Encoding to be applied to the generated Text file. e.g. cp932" + ) + text_encode_error_handling = fields.Selection( + selection=[("ignore", "Ignore"), ("replace", "Replace")], + help="If nothing is selected, text export will fail with an error message when " + "there is a character that fail to be encoded.", + ) + line_ending = fields.Selection( + [("crlf", "CRLF (\\r\\n)"), ("cr", "CR (\\r)")], + help="Select the type of line ending in case the report needs " + "to be output with other line ending than 'LF'.", + ) + + @api.model + def _render_qweb_text(self, report_ref, docids, data=None): + content, content_type = super()._render_qweb_text(report_ref, docids, data) + report = self._get_report(report_ref) + if not report.text_encoding and not report.line_ending: + return content, content_type + content_str = content.decode("utf-8") + if report.line_ending == "crlf": + content_str = content_str.replace("\n", "\r\n") + elif report.line_ending == "cr": + content_str = content_str.replace("\n", "\r") + # If specific encoding is set on the report, use it; otherwise, fallback to utf-8 + encoding = report.text_encoding or "utf-8" + encode_options = {} + if report.text_encode_error_handling: + encode_options["errors"] = report.text_encode_error_handling + content = content_str.encode(encoding, **encode_options) + return content, content_type diff --git a/report_text_format_option/readme/CONFIGURE.rst b/report_text_format_option/readme/CONFIGURE.rst new file mode 100644 index 000000000..40df85306 --- /dev/null +++ b/report_text_format_option/readme/CONFIGURE.rst @@ -0,0 +1,12 @@ +In case the exported report should be encoded in another system than UTF-8, following +fields of the report record (*Settings > Technical > Reports*) should be populated accordingly. + +* Text Encoding: set an encoding system (such as cp932) +* Text Encode Error Handling: select 'Ignore' or 'Replace' as necessary. + * 'Ignore': in case of an encoding error, the problematic character will be removed from the exported file. + * 'Replace': in case of an encoding error, the problematic character will be replaced with '?' symbol. + * Leaving the field blank: in case of an encoding error, the report generation fails with an error message. +* Line Ending: Select the type of line ending, 'CRLF' or 'CR', as necessary. + * 'CRLF': 'Carriage Return' + 'Line Feed' (Windows) + * 'CR': 'Carriage Return' (classic Mac OS) + * Leaving this field blank defaults to using 'LF' (Line Feed), the default behavior of Odoo. diff --git a/report_text_format_option/readme/DESCRIPTION.rst b/report_text_format_option/readme/DESCRIPTION.rst new file mode 100644 index 000000000..3bc8739d6 --- /dev/null +++ b/report_text_format_option/readme/DESCRIPTION.rst @@ -0,0 +1 @@ +This is a technical module designed to add encoding fields to the ir.actions.report model and is applied to Text type reports. diff --git a/report_text_format_option/static/description/index.html b/report_text_format_option/static/description/index.html new file mode 100644 index 000000000..8d30575aa --- /dev/null +++ b/report_text_format_option/static/description/index.html @@ -0,0 +1,430 @@ + + + + + +Report Text Format Option + + + +
+

Report Text Format Option

+ + +

Beta License: LGPL-3 OCA/reporting-engine Translate me on Weblate Try me on Runboat

+

This is a technical module designed to add encoding fields to the ir.actions.report model and is applied to Text type reports.

+

Table of contents

+ +
+

Configuration

+

In case the exported report should be encoded in another system than UTF-8, following +fields of the report record (Settings > Technical > Reports) should be populated accordingly.

+
    +
  • Text Encoding: set an encoding system (such as cp932)
    • +
  • Text Encode Error Handling: select ‘Ignore’ or ‘Replace’ as necessary. +* ‘Ignore’: in case of an encoding error, the problematic character will be removed from the exported file. +* ‘Replace’: in case of an encoding error, the problematic character will be replaced with ‘?’ symbol. +* Leaving the field blank: in case of an encoding error, the report generation fails with an error message.
    • +
  • Line Ending: Select the type of line ending, ‘CRLF’ or ‘CR’, as necessary. +* ‘CRLF’: ‘Carriage Return’ + ‘Line Feed’ (Windows) +* ‘CR’: ‘Carriage Return’ (classic Mac OS) +* Leaving this field blank defaults to using ‘LF’ (Line Feed), the default behavior of Odoo.
    • +
+
+
+

Bug Tracker

+

Bugs are tracked on GitHub Issues. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us to smash it by providing a detailed and welcomed +feedback.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • Quartile Limited
    • +
+
+
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use.

+

This module is part of the OCA/reporting-engine project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ + diff --git a/report_text_format_option/tests/__init__.py b/report_text_format_option/tests/__init__.py new file mode 100644 index 000000000..623710424 --- /dev/null +++ b/report_text_format_option/tests/__init__.py @@ -0,0 +1 @@ +from . import test_report_format_option diff --git a/report_text_format_option/tests/test_report_format_option.py b/report_text_format_option/tests/test_report_format_option.py new file mode 100644 index 000000000..e57a3a4e5 --- /dev/null +++ b/report_text_format_option/tests/test_report_format_option.py @@ -0,0 +1,54 @@ +# Copyright 2024 Quartile Limited +# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl). + + +from odoo.tests.common import TransactionCase + + +class TestReportFormatOption(TransactionCase): + @classmethod + def setUpClass(cls): + super(TestReportFormatOption, cls).setUpClass() + cls.demo_report = cls.env.ref( + "report_text_format_option.action_report_demo" + ).with_context(lang="en_US") + cls.partner = cls.env["res.partner"].create({"name": "Odoo Test Partner"}) + + def test_report_default_encoding(self): + content, content_type = self.demo_report._render_qweb_text( + self.demo_report.id, [self.partner.id] + ) + self.assertTrue(content, "Report content should not be empty") + + def test_report_encoding_crlf(self): + # Set line ending to CRLF + self.demo_report.line_ending = "crlf" + content, content_type = self.demo_report._render_qweb_text( + self.demo_report.id, [self.partner.id] + ) + content_str = content.decode("utf-8") + self.assertIn("\r\n", content_str, "Line endings should be CRLF") + + def test_report_encoding_cr(self): + # Set line ending to CR + self.demo_report.line_ending = "cr" + content, content_type = self.demo_report._render_qweb_text( + self.demo_report.id, [self.partner.id] + ) + content_str = content.decode("utf-8") + self.assertIn("\r", content_str, "Line endings should be CR and not contain LF") + + def test_report_encoding_shiftjis(self): + # Example: Testing with Shift-JIS encoding for Japanese characters + self.demo_report.text_encoding = "shift_jis" + self.partner.name = "テストパートナー" + content, content_type = self.demo_report._render_qweb_text( + self.demo_report.id, [self.partner.id] + ) + # Decode content to verify Japanese characters are correctly handled + content_str = content.decode("shift_jis") + self.assertIn( + "テストパートナー", + content_str, + "Japanese characters should be correctly encoded in Shift-JIS", + ) diff --git a/report_text_format_option/views/ir_actions_report_views.xml b/report_text_format_option/views/ir_actions_report_views.xml new file mode 100644 index 000000000..9c8b216fd --- /dev/null +++ b/report_text_format_option/views/ir_actions_report_views.xml @@ -0,0 +1,24 @@ + + + + ir.actions.report + ir.actions.report + + + + + + + + + + diff --git a/setup/report_text_format_option/odoo/addons/report_text_format_option b/setup/report_text_format_option/odoo/addons/report_text_format_option new file mode 120000 index 000000000..5648cd24f --- /dev/null +++ b/setup/report_text_format_option/odoo/addons/report_text_format_option @@ -0,0 +1 @@ +../../../../report_text_format_option \ No newline at end of file diff --git a/setup/report_text_format_option/setup.py b/setup/report_text_format_option/setup.py new file mode 100644 index 000000000..28c57bb64 --- /dev/null +++ b/setup/report_text_format_option/setup.py @@ -0,0 +1,6 @@ +import setuptools + +setuptools.setup( + setup_requires=['setuptools-odoo'], + odoo_addon=True, +)