[17.0][MIG] report_csv

report_csv/README.rst

@@ -0,0 +1,146 @@
+===============
+Base report csv
+===============
+
+.. 
+ !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+ !! This file is generated by oca-gen-addon-readme !!
+ !! changes will be overwritten. !!
+ !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+ !! source digest: sha256:3d970690227b2dd444c5359798ce3ea5be684d6fbc82504e90694e193e738938
+ !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |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-AGPL--3-blue.png
+ :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
+ :alt: License: AGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github
+ :target: https://github.com/OCA/reporting-engine/tree/17.0/report_csv
+ :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-17-0/reporting-engine-17-0-report_csv
+ :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=17.0
+ :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+This module provides a basic report class to generate csv report.
+
+**Table of contents**
+
+.. contents::
+ :local:
+
+Configuration
+=============
+
+In case the exported CSV report should be encoded in another system than
+UTF-8, following fields of the report record (*Settings > Technical >
+Reports*) should be populated accordingly.
+
+- Encoding: set an encoding system (such as cp932)
+- 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.
+
+Usage
+=====
+
+An example of CSV report for partners on a module called
+\`module_name\`:
+
+A python class :
+
+::
+
+ from odoo import models
+
+ class PartnerCSV(models.AbstractModel):
+ _name = 'report.report_csv.partner_csv'
+ _inherit = 'report.report_csv.abstract'
+
+ def generate_csv_report(self, writer, data, partners):
+ writer.writeheader()
+ for obj in partners:
+ writer.writerow({
+ 'name': obj.name,
+ 'email': obj.email,
+ })
+
+ def csv_report_options(self):
+ res = super().csv_report_options()
+ res['fieldnames'].append('name')
+ res['fieldnames'].append('email')
+ res['delimiter'] = ';'
+ res['quoting'] = csv.QUOTE_ALL
+ return res
+
+A report XML record :
+
+::
+
+ <report
+ id="partner_csv"
+ model="res.partner"
+ string="Print to CSV"
+ report_type="csv"
+ name="module_name.report_name"
+ file="res_partner"
+ attachment_use="False"
+ />
+
+Update encoding with an appropriate value (e.g. cp932) as necessary.
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/reporting-engine/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 <https://github.com/OCA/reporting-engine/issues/new?body=module:%20report_csv%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+
+Do not contact contributors directly about support or help with technical issues.
+
+Credits
+=======
+
+Authors
+-------
+
+* Creu Blanca
+
+Contributors
+------------
+
+- Enric Tobella <etobella@creublanca.es>
+- Jaime Arroyo <jaime.arroyo@creublanca.es>
+- Rattapong Chokmasermkul <rattapongc@ecosoft.co.th>
+- `Quartile <https://www.quartile.co>`__:
+
+ - Aung Ko Ko Lin
+
+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 <https://github.com/OCA/reporting-engine/tree/17.0/report_csv>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

report_csv/__init__.py

@@ -0,0 +1,3 @@
+from . import controllers
+from . import models
+from . import report

report_csv/__manifest__.py

@@ -0,0 +1,20 @@
+# Copyright 2019 Creu Blanca
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html).
+{
+ "name": "Base report csv",
+ "summary": "Base module to create csv report",
+ "author": "Creu Blanca, Odoo Community Association (OCA)",
+ "website": "https://github.com/OCA/reporting-engine",
+ "category": "Reporting",
+ "version": "17.0.1.0.0",
+ "license": "AGPL-3",
+ "depends": ["base", "web"],
+ "demo": ["demo/report.xml"],
+ "data": ["views/ir_actions_views.xml"],
+ "assets": {
+ "web.assets_backend": [
+ "report_csv/static/src/js/report/qwebactionmanager.esm.js"
+ ]
+ },
+ "installable": True,
+}

report_csv/controllers/__init__.py

@@ -0,0 +1 @@
+from . import main

report_csv/controllers/main.py

@@ -0,0 +1,108 @@
+# Copyright (C) 2019 Creu Blanca
+# License AGPL-3.0 or later (https://www.gnuorg/licenses/agpl.html).
+
+import json
+import logging
+
+from werkzeug.exceptions import InternalServerError
+from werkzeug.urls import url_decode
+
+from odoo.http import (
+ content_disposition,
+ request,
+ route,
+)
+from odoo.http import (
+ serialize_exception as _serialize_exception,
+)
+from odoo.tools import html_escape
+from odoo.tools.safe_eval import safe_eval, time
+
+from odoo.addons.web.controllers import report
+
+_logger = logging.getLogger(__name__)
+
+
+class ReportController(report.ReportController):
+ @route()
+ def report_routes(self, reportname, docids=None, converter=None, **data):
+ if converter == "csv":
+ report = request.env["ir.actions.report"]._get_report_from_name(reportname)
+ context = dict(request.env.context)
+ if docids:
+ docids = [int(i) for i in docids.split(",")]
+ if data.get("options"):
+ data.update(json.loads(data.pop("options")))
+ if data.get("context"):
+ # Ignore 'lang' here, because the context in data is the one
+ # from the webclient *but* if the user explicitely wants to
+ # change the lang, this mechanism overwrites it.
+ data["context"] = json.loads(data["context"])
+ if data["context"].get("lang"):
+ del data["context"]["lang"]
+ context.update(data["context"])
+ csv = report.with_context(**context)._render_csv(
+ reportname, docids, data=data
+ )[0]
+ csvhttpheaders = [
+ ("Content-Type", "text/csv"),
+ ("Content-Length", len(csv)),
+ ]
+ return request.make_response(csv, headers=csvhttpheaders)
+ return super().report_routes(reportname, docids, converter, **data)
+
+ @route()
+ def report_download(self, data, context=None):
+ requestcontent = json.loads(data)
+ url, report_type = requestcontent[0], requestcontent[1]
+ reportname = ""
+ try:
+ if report_type == "csv":
+ reportname = url.split("/report/csv/")[1].split("?")[0]
+ docids = None
+ if "/" in reportname:
+ reportname, docids = reportname.split("/")
+ if docids:
+ # Generic report:
+ response = self.report_routes(
+ reportname, docids=docids, converter="csv", context=context
+ )
+ else:
+ # Particular report:
+ data = dict(
+ url_decode(url.split("?")[1]).items()
+ ) # decoding the args represented in JSON
+ if "context" in data:
+ context, data_context = (
+ json.loads(context or "{}"),
+ json.loads(data.pop("context")),
+ )
+ context = json.dumps({**context, **data_context})
+ response = self.report_routes(
+ reportname, converter="csv", context=context, **data
+ )
+
+ report = request.env["ir.actions.report"]._get_report_from_name(
+ reportname
+ )
+ filename = f"{report.name}.{report_type}"
+ if docids:
+ ids = [int(x) for x in docids.split(",")]
+ obj = request.env[report.model].browse(ids)
+ if report.print_report_name and not len(obj) > 1:
+ report_name = safe_eval(
+ report.print_report_name, {"object": obj, "time": time}
+ )
+ filename = f"{report_name}.{report_type}"
+ response.headers.add(
+ "Content-Disposition", content_disposition(filename)
+ )
+ return response
+ else:
+ return super().report_download(data, context)
+ except Exception as e:
+ _logger.exception("Error while generating report %s", reportname)
+ se = _serialize_exception(e)
+ error = {"code": 200, "message": "Odoo Server Error", "data": se}
+ res = request.make_response(html_escape(json.dumps(error)))
+ raise InternalServerError(response=res) from e

report_csv/demo/report.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<odoo>
+ <!--
+ Copyright 2019 Creu Blanca
+ License AGPL-3.0 or later (https://www.gnuorg/licenses/agpl.html).
+ -->
+ <record id="partner_csv" model="ir.actions.report">
+ <field name="name">Print to CSV</field>
+ <field name="model">res.partner</field>
+ <field name="report_type">csv</field>
+ <field name="report_name">report_csv.partner_csv</field>
+ <field name="report_file">res_partner</field>
+ </record>
+</odoo>

report_csv/i18n/it.po

@@ -0,0 +1,101 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+# * report_csv
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 16.0\n"
+"Report-Msgid-Bugs-To: \n"
+"PO-Revision-Date: 2024-01-18 09:34+0000\n"
+"Last-Translator: mymage <stefano.consolaro@mymage.it>\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_csv
+#: model:ir.model,name:report_csv.model_report_report_csv_abstract
+msgid "Abstract Model for CSV reports"
+msgstr "Modello astratto per resoconto CSV"
+
+#. module: report_csv
+#: model:ir.model.fields,field_description:report_csv.field_ir_actions_report__encode_error_handling
+msgid "Encode Error Handling"
+msgstr "Gestione errore codifica"
+
+#. module: report_csv
+#: model:ir.model.fields,field_description:report_csv.field_ir_actions_report__encoding
+msgid "Encoding"
+msgstr "Codifica"
+
+#. module: report_csv
+#: model:ir.model.fields,help:report_csv.field_ir_actions_report__encoding
+msgid "Encoding to be applied to the generated CSV file. e.g. cp932"
+msgstr "Codifica da applicare al file CSV generato. Es. cp932"
+
+#. module: report_csv
+#. odoo-python
+#: code:addons/report_csv/report/report_csv.py:0
+#, python-format
+msgid "Failed to encode the data with the encoding set in the report."
+msgstr "Codifica dati fallita con la codifica impostata nel resoconto."
+
+#. module: report_csv
+#: model:ir.model.fields,help:report_csv.field_ir_actions_report__encode_error_handling
+msgid ""
+"If nothing is selected, CSV export will fail with an error message when "
+"there is a character that fail to be encoded."
+msgstr ""
+"Se non è selezionato nulla, l'esportazione del CSV fallirà con un messaggio "
+"di errore qando c'è un carattere che non può essere codificato."
+
+#. module: report_csv
+#: model:ir.model.fields.selection,name:report_csv.selection__ir_actions_report__encode_error_handling__ignore
+msgid "Ignore"
+msgstr "Ignora"
+
+#. module: report_csv
+#: model:ir.actions.report,name:report_csv.partner_csv
+msgid "Print to CSV"
+msgstr "Stampa su CSV"
+
+#. module: report_csv
+#: model:ir.model.fields.selection,name:report_csv.selection__ir_actions_report__encode_error_handling__replace
+msgid "Replace"
+msgstr "Sostituzione"
+
+#. module: report_csv
+#: model:ir.model,name:report_csv.model_ir_actions_report
+msgid "Report Action"
+msgstr "Azione resoconto"
+
+#. module: report_csv
+#: model:ir.model,name:report_csv.model_report_report_csv_partner_csv
+msgid "Report Partner to CSV"
+msgstr "Indica il partner al CSV"
+
+#. module: report_csv
+#: model:ir.model.fields,field_description:report_csv.field_ir_actions_report__report_type
+msgid "Report Type"
+msgstr "Tipo resoconto"
+
+#. module: report_csv
+#: model:ir.model.fields,help:report_csv.field_ir_actions_report__report_type
+msgid ""
+"The type of the report that will be rendered, each one having its own "
+"rendering method. HTML means the report will be opened directly in your "
+"browser PDF means the report will be rendered using Wkhtmltopdf and "
+"downloaded by the user."
+msgstr ""
+"Il tipo di resoconto che verrà generato, ognuno avente il suo metodo di "
+"generazione. HTML vuol dire che il resoconto sarà aperto direttamente nel "
+"tuo browser mentre PDF vuol dire che il resoconto sarà generato usando "
+"Wkhtmltopdf e scaricato dall'utente."
+
+#. module: report_csv
+#: model:ir.model.fields.selection,name:report_csv.selection__ir_actions_report__report_type__csv
+msgid "csv"
+msgstr "csv"