[16.0][IMP] report_csv: support attachment use

sbejaoui · victoralmau · commit 6e85d0bde7d8 · 2025-02-21T14:23:51.000+01:00
[BOT] post-merge updates
diff --git a/report_csv/README.rst b/report_csv/README.rst
@@ -7,7 +7,7 @@ Base report csv
    !! This file is generated by oca-gen-addon-readme !!
    !! changes will be overwritten.                   !!
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-   !! source digest: sha256:3d970690227b2dd444c5359798ce3ea5be684d6fbc82504e90694e193e738938
+   !! source digest: sha256:a39959a00912416454f8818d70b9a3ffdd305aeb1b1c35ce3ea007f3c41526bd
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 
 .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
diff --git a/report_csv/__manifest__.py b/report_csv/__manifest__.py
@@ -6,7 +6,7 @@
     "author": "Creu Blanca, Odoo Community Association (OCA)",
     "website": "https://github.com/OCA/reporting-engine",
     "category": "Reporting",
-    "version": "16.0.2.0.0",
+    "version": "16.0.2.1.0",
     "license": "AGPL-3",
     "depends": ["base", "web"],
     "demo": ["demo/report.xml"],
diff --git a/report_csv/models/ir_report.py b/report_csv/models/ir_report.py
@@ -1,7 +1,13 @@
 # Copyright 2019 Creu Blanca
 # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html).
 
+import logging
+
 from odoo import api, fields, models
+from odoo.exceptions import AccessError
+from odoo.tools.safe_eval import safe_eval, time
+
+_logger = logging.getLogger(__name__)
 
 
 class ReportAction(models.Model):
@@ -19,18 +25,58 @@ class ReportAction(models.Model):
         "there is a character that fail to be encoded.",
     )
 
+    def _create_csv_attachment(self, record, data):
+        attachment_name = safe_eval(self.attachment, {"object": record, "time": time})
+        # Unable to compute a name for the attachment.
+        if not attachment_name:
+            return
+        if record and data:
+            attachment = {
+                "name": attachment_name,
+                "raw": data,
+                "res_model": self.model,
+                "res_id": record.id,
+                "type": "binary",
+            }
+            try:
+                self.env["ir.attachment"].create(attachment)
+            except AccessError:
+                _logger.info(
+                    "Cannot save csv report %r as attachment", attachment["name"]
+                )
+            else:
+                _logger.info(
+                    "The csv document %s is now saved in the database",
+                    attachment["name"],
+                )
+
     @api.model
     def _render_csv(self, report_ref, docids, data):
         report_sudo = self._get_report(report_ref)
         report_model_name = "report.%s" % report_sudo.report_name
         report_model = self.env[report_model_name]
-        return report_model.with_context(
+        res_id = len(docids) == 1 and docids[0]
+        if not res_id or not report_sudo.attachment or not report_sudo.attachment_use:
+            return report_model.with_context(
+                **{
+                    "active_model": report_sudo.model,
+                    "encoding": self.encoding,
+                    "encode_error_handling": self.encode_error_handling,
+                }
+            ).create_csv_report(docids, data)
+        record = self.env[report_sudo.model].browse(res_id)
+        attachment = report_sudo.retrieve_attachment(record)
+        if attachment:
+            return attachment.raw.decode(), "csv"
+        data, ext = report_model.with_context(
             **{
                 "active_model": report_sudo.model,
                 "encoding": self.encoding,
                 "encode_error_handling": self.encode_error_handling,
             }
         ).create_csv_report(docids, data)
+        report_sudo._create_csv_attachment(record, data)
+        return data, ext
 
     @api.model
     def _get_report_from_name(self, report_name):
diff --git a/report_csv/static/description/index.html b/report_csv/static/description/index.html
@@ -1,4 +1,3 @@
-<?xml version="1.0" encoding="utf-8"?>
 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
@@ -9,10 +8,11 @@
 
 /*
 :Author: David Goodger (goodger@python.org)
-:Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $
+:Id: $Id: html4css1.css 9511 2024-01-13 09:50:07Z milde $
 :Copyright: This stylesheet has been placed in the public domain.
 
 Default cascading style sheet for the HTML output of Docutils.
+Despite the name, some widely supported CSS2 features are used.
 
 See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
 customize this style sheet.
@@ -275,7 +275,7 @@
   margin-left: 2em ;
   margin-right: 2em }
 
-pre.code .ln { color: grey; } /* line numbers */
+pre.code .ln { color: gray; } /* line numbers */
 pre.code, code { background-color: #eeeeee }
 pre.code .comment, code .comment { color: #5C6576 }
 pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
@@ -301,7 +301,7 @@
 span.pre {
   white-space: pre }
 
-span.problematic {
+span.problematic, pre.problematic {
   color: red }
 
 span.section-subtitle {
@@ -367,7 +367,7 @@ <h1 class="title">Base report csv</h1>
 !! This file is generated by oca-gen-addon-readme !!
 !! changes will be overwritten.                   !!
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-!! source digest: sha256:3d970690227b2dd444c5359798ce3ea5be684d6fbc82504e90694e193e738938
+!! source digest: sha256:a39959a00912416454f8818d70b9a3ffdd305aeb1b1c35ce3ea007f3c41526bd
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
 <p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/reporting-engine/tree/16.0/report_csv"><img alt="OCA/reporting-engine" src="https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/reporting-engine-16-0/reporting-engine-16-0-report_csv"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/reporting-engine&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
 <p>This module provides a basic report class to generate csv report.</p>
@@ -471,7 +471,9 @@ <h2><a class="toc-backref" href="#toc-entry-6">Contributors</a></h2>
 <div class="section" id="maintainers">
 <h2><a class="toc-backref" href="#toc-entry-7">Maintainers</a></h2>
 <p>This module is maintained by the OCA.</p>
-<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
+<a class="reference external image-reference" href="https://odoo-community.org">
+<img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" />
+</a>
 <p>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.</p>
diff --git a/report_csv/tests/test_report.py b/report_csv/tests/test_report.py
@@ -47,6 +47,20 @@ def test_report(self):
         dict_report = list(csv.DictReader(str_io, delimiter=";", quoting=csv.QUOTE_ALL))
         self.assertEqual(self.docs.name, dict(dict_report[0])["name"])
 
+    def test_attachment_use(self):
+        self.report.attachment = "object.name+'.csv'"
+        self.report.attachment_use = True
+        rep = self.report_object._render(self.report_name, self.docs.ids, {})
+        attachment = self.env["ir.attachment"].search(
+            [("name", "=", self.docs.name + ".csv")]
+        )
+        self.assertTrue(attachment)
+        self.assertEqual(attachment.raw.decode(), rep[0])
+        rep_from_attachment = self.report_object._render(
+            self.report_name, self.docs.ids, {}
+        )
+        self.assertTupleEqual(rep, rep_from_attachment)
+
     def test_id_retrieval(self):
 
         # Typical call from WebUI with wizard
