diff --git a/report_text_format_option/README.rst b/report_text_format_option/README.rst new file mode 100644 index 0000000000..a000071d01 --- /dev/null +++ b/report_text_format_option/README.rst @@ -0,0 +1,117 @@ +========================= +Report Text Format Option +========================= + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:fd45d700b6b4a6ecf0ec20d05ceb159dca5c9671a5d495b07e028dbeacd79a1e + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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/18.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-18-0/reporting-engine-18-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=18.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 + +Contributors +------------ + +- Quartile + + - Aung Ko Ko Lin + - Yoshi Tashiro + +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. + +.. |maintainer-yostashiro| image:: https://github.com/yostashiro.png?size=40px + :target: https://github.com/yostashiro + :alt: yostashiro +.. |maintainer-aungkokolin1997| image:: https://github.com/aungkokolin1997.png?size=40px + :target: https://github.com/aungkokolin1997 + :alt: aungkokolin1997 + +Current `maintainers `__: + +|maintainer-yostashiro| |maintainer-aungkokolin1997| + +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 0000000000..0650744f6b --- /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 0000000000..21eab39b8f --- /dev/null +++ b/report_text_format_option/__manifest__.py @@ -0,0 +1,15 @@ +# Copyright 2024 Quartile (https://www.quartile.co) +# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl.html). +{ + "name": "Report Text Format Option", + "author": "Quartile, Odoo Community Association (OCA)", + "website": "https://github.com/OCA/reporting-engine", + "category": "Reporting", + "version": "18.0.1.0.0", + "license": "LGPL-3", + "depends": ["base"], + "data": ["views/ir_actions_report_views.xml"], + "maintainers": ["yostashiro", "aungkokolin1997"], + "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 0000000000..7fd6945283 --- /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/i18n/it.po b/report_text_format_option/i18n/it.po new file mode 100644 index 0000000000..80b9c0de38 --- /dev/null +++ b/report_text_format_option/i18n/it.po @@ -0,0 +1,93 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * report_text_format_option +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 16.0\n" +"Report-Msgid-Bugs-To: \n" +"PO-Revision-Date: 2024-06-07 12:34+0000\n" +"Last-Translator: mymage \n" +"Language-Team: none\n" +"Language: it\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: nplurals=2; plural=n != 1;\n" +"X-Generator: Weblate 4.17\n" + +#. module: report_text_format_option +#: model:ir.model.fields.selection,name:report_text_format_option.selection__ir_actions_report__line_ending__cr +msgid "CR (\\r)" +msgstr "CR (\\r)" + +#. module: report_text_format_option +#: model:ir.model.fields.selection,name:report_text_format_option.selection__ir_actions_report__line_ending__crlf +msgid "CRLF (\\r\\n)" +msgstr "" +"CRLF (\\r\\n" +")" + +#. module: report_text_format_option +#: model:ir.actions.report,name:report_text_format_option.action_report_demo +msgid "Demo Text Report" +msgstr "Resoconto testo demo" + +#. module: report_text_format_option +#: model:ir.model.fields,help:report_text_format_option.field_ir_actions_report__text_encoding +msgid "Encoding to be applied to the generated Text file. e.g. cp932" +msgstr "Codifica da applicare al file testo generato. Es. cp932" + +#. module: report_text_format_option +#: model_terms:ir.ui.view,arch_db:report_text_format_option.demo_report_template +msgid "Hello," +msgstr "Salve," + +#. module: report_text_format_option +#: model:ir.model.fields,help:report_text_format_option.field_ir_actions_report__text_encode_error_handling +msgid "" +"If nothing is selected, text export will fail with an error message when " +"there is a character that fail to be encoded." +msgstr "" +"Se non viene selezionato nulla, l'esportazione del testo fallirà con un " +"messaggio di errore quando è presente un carattere che non può essere " +"codificato." + +#. module: report_text_format_option +#: model:ir.model.fields.selection,name:report_text_format_option.selection__ir_actions_report__text_encode_error_handling__ignore +msgid "Ignore" +msgstr "Ignora" + +#. module: report_text_format_option +#: model:ir.model.fields,field_description:report_text_format_option.field_ir_actions_report__line_ending +msgid "Line Ending" +msgstr "Fine riga" + +#. module: report_text_format_option +#: model:ir.model.fields.selection,name:report_text_format_option.selection__ir_actions_report__text_encode_error_handling__replace +msgid "Replace" +msgstr "Sostituisce" + +#. module: report_text_format_option +#: model:ir.model,name:report_text_format_option.model_ir_actions_report +msgid "Report Action" +msgstr "Azione resoconto" + +#. module: report_text_format_option +#: model:ir.model.fields,help:report_text_format_option.field_ir_actions_report__line_ending +msgid "" +"Select the type of line ending in case the report needs to be output with " +"other line ending than 'LF'." +msgstr "" +"Selezionare il tipo di fine riga nel caso il resoconto richieda di essere " +"emesso con fine riga diverso da 'LF'." + +#. module: report_text_format_option +#: model:ir.model.fields,field_description:report_text_format_option.field_ir_actions_report__text_encode_error_handling +msgid "Text Encode Error Handling" +msgstr "Gestione errore codifica testo" + +#. module: report_text_format_option +#: model:ir.model.fields,field_description:report_text_format_option.field_ir_actions_report__text_encoding +msgid "Text Encoding" +msgstr "Codifica testo" diff --git a/report_text_format_option/i18n/report_text_format_option.pot b/report_text_format_option/i18n/report_text_format_option.pot new file mode 100644 index 0000000000..d51b8fd125 --- /dev/null +++ b/report_text_format_option/i18n/report_text_format_option.pot @@ -0,0 +1,83 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * report_text_format_option +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 17.0\n" +"Report-Msgid-Bugs-To: \n" +"Last-Translator: \n" +"Language-Team: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: \n" + +#. module: report_text_format_option +#: model:ir.model.fields.selection,name:report_text_format_option.selection__ir_actions_report__line_ending__cr +msgid "CR (\\r)" +msgstr "" + +#. module: report_text_format_option +#: model:ir.model.fields.selection,name:report_text_format_option.selection__ir_actions_report__line_ending__crlf +msgid "CRLF (\\r\\n)" +msgstr "" + +#. module: report_text_format_option +#: model:ir.actions.report,name:report_text_format_option.action_report_demo +msgid "Demo Text Report" +msgstr "" + +#. module: report_text_format_option +#: model:ir.model.fields,help:report_text_format_option.field_ir_actions_report__text_encoding +msgid "Encoding to be applied to the generated Text file. e.g. cp932" +msgstr "" + +#. module: report_text_format_option +#: model_terms:ir.ui.view,arch_db:report_text_format_option.demo_report_template +msgid "Hello," +msgstr "" + +#. module: report_text_format_option +#: model:ir.model.fields,help:report_text_format_option.field_ir_actions_report__text_encode_error_handling +msgid "" +"If nothing is selected, text export will fail with an error message when " +"there is a character that fail to be encoded." +msgstr "" + +#. module: report_text_format_option +#: model:ir.model.fields.selection,name:report_text_format_option.selection__ir_actions_report__text_encode_error_handling__ignore +msgid "Ignore" +msgstr "" + +#. module: report_text_format_option +#: model:ir.model.fields,field_description:report_text_format_option.field_ir_actions_report__line_ending +msgid "Line Ending" +msgstr "" + +#. module: report_text_format_option +#: model:ir.model.fields.selection,name:report_text_format_option.selection__ir_actions_report__text_encode_error_handling__replace +msgid "Replace" +msgstr "" + +#. module: report_text_format_option +#: model:ir.model,name:report_text_format_option.model_ir_actions_report +msgid "Report Action" +msgstr "" + +#. module: report_text_format_option +#: model:ir.model.fields,help:report_text_format_option.field_ir_actions_report__line_ending +msgid "" +"Select the type of line ending in case the report needs to be output with " +"other line ending than 'LF'." +msgstr "" + +#. module: report_text_format_option +#: model:ir.model.fields,field_description:report_text_format_option.field_ir_actions_report__text_encode_error_handling +msgid "Text Encode Error Handling" +msgstr "" + +#. module: report_text_format_option +#: model:ir.model.fields,field_description:report_text_format_option.field_ir_actions_report__text_encoding +msgid "Text Encoding" +msgstr "" diff --git a/report_text_format_option/models/__init__.py b/report_text_format_option/models/__init__.py new file mode 100644 index 0000000000..a248cf2162 --- /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 0000000000..a4a9fe91fc --- /dev/null +++ b/report_text_format_option/models/ir_actions_report.py @@ -0,0 +1,42 @@ +# Copyright 2024 Quartile (https://www.quartile.co) +# 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/pyproject.toml b/report_text_format_option/pyproject.toml new file mode 100644 index 0000000000..4231d0cccb --- /dev/null +++ b/report_text_format_option/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/report_text_format_option/readme/CONFIGURE.md b/report_text_format_option/readme/CONFIGURE.md new file mode 100644 index 0000000000..53a26fe27e --- /dev/null +++ b/report_text_format_option/readme/CONFIGURE.md @@ -0,0 +1,18 @@ +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/CONTRIBUTORS.md b/report_text_format_option/readme/CONTRIBUTORS.md new file mode 100644 index 0000000000..f6444ad9ec --- /dev/null +++ b/report_text_format_option/readme/CONTRIBUTORS.md @@ -0,0 +1,3 @@ +- Quartile \<\> + - Aung Ko Ko Lin + - Yoshi Tashiro diff --git a/report_text_format_option/readme/DESCRIPTION.md b/report_text_format_option/readme/DESCRIPTION.md new file mode 100644 index 0000000000..b85c101397 --- /dev/null +++ b/report_text_format_option/readme/DESCRIPTION.md @@ -0,0 +1,2 @@ +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/icon.png b/report_text_format_option/static/description/icon.png new file mode 100644 index 0000000000..3a0328b516 Binary files /dev/null and b/report_text_format_option/static/description/icon.png differ 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 0000000000..4807800616 --- /dev/null +++ b/report_text_format_option/static/description/index.html @@ -0,0 +1,458 @@ + + + + + +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
    • +
+
+
+

Contributors

+ +
+
+

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.

+

Current maintainers:

+

yostashiro aungkokolin1997

+

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 0000000000..623710424b --- /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 0000000000..ccc910c7ac --- /dev/null +++ b/report_text_format_option/tests/test_report_format_option.py @@ -0,0 +1,54 @@ +# Copyright 2024 Quartile (https://www.quartile.co) +# 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().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 0000000000..91ad619b49 --- /dev/null +++ b/report_text_format_option/views/ir_actions_report_views.xml @@ -0,0 +1,18 @@ + + + + ir.actions.report + ir.actions.report + + + + + + + + + +