feat: add support for OpenDocument format in report export #363 (#478)

Signed-off-by: tdruez <tdruez@aboutcode.org>

Author: tdruez

dje/views.py

@@ -1880,6 +1880,7 @@ class DownloadableMixin:
         "doc": "application/msword",
         "html": "text/html",
         "json": "application/json",
+        "ods": "application/vnd.oasis.opendocument.spreadsheet",
         "xls": "application/vnd.ms-excel",
         "xlsx": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
         "yaml": "application/x-yaml",

docs/images/tutorial-6-vuln-report/export-report-to-xlsx.png

@@ -154,7 +154,10 @@ dependencies = [
     "annotated-types==0.7.0",
     "semantic-version==2.10.0",
     # OpenVEX
-    "msgspec==0.20.0"
+    "msgspec==0.20.0",
+    # OpenDocument Format
+    "odfdo==3.20.2",
+    "lxml==6.0.2",
 ]
 
 [project.optional-dependencies]

pyproject.toml

@@ -52,12 +52,13 @@ <h1 class="header-title">
           </div>
           <div class="col-auto">
             <select id="id_format" class="form-select form-select-sm" name="format">
-              <option value="doc">doc</option>
-              <option value="html">html</option>
-              <option value="json">json</option>
-              <option value="xls">xls</option>
-              <option value="xlsx" selected="selected">xlsx</option>
-              <option value="yaml">yaml</option>
+              <option value="html">Web Page (.html)</option>
+              <option value="json">JSON (.json)</option>
+              <option value="ods">OpenDocument (.ods)</option>
+              <option value="doc">Microsoft Word (.doc)</option>
+              <option value="xls">Microsoft Excel 97-2003 (.xls)</option>
+              <option value="xlsx" selected="selected">Microsoft Excel (.xlsx)</option>
+              <option value="yaml">YAML (.yaml)</option>
             </select>
           </div>
           <div class="col-auto">

reporting/templates/reporting/report_run.html

@@ -429,7 +429,7 @@ def test_report_view_get_json_response(self):
             [0, 1, 2], list(self.column_template.fields.all().values_list("seq", flat=True))
         )
 
-        # In case of a change: print repr(response.content)
+        # In case of a change: print(repr(response.content))
         expected = (
             "{\n    "
             '"key": "license_126",\n    '
@@ -448,10 +448,19 @@ def test_report_view_get_yaml_response(self):
         )
         self.assertEqual(response["Content-Type"], "application/x-yaml")
 
-        # In case of a change: >>> print repr(response.content)
+        # In case of a change: >>> print(repr(response.content))
         expected = "- key: license_138\n  short_name: license_138\n  name: license_138\n"
         self.assertContains(response, expected)
 
+    def test_report_view_get_ods_response(self):
+        self.client.login(username="test", password="t3st")
+        url = self.report.get_absolute_url() + "?format=ods"
+        response = self.client.get(url)
+        self.assertEqual(
+            response["Content-Disposition"], 'attachment; filename="license-list-for-analysis.ods"'
+        )
+        self.assertEqual(response["Content-Type"], "application/vnd.oasis.opendocument.spreadsheet")
+
     def test_run_report_view_runtime_parameters_value_fields(self):
         self.client.login(username="test", password="t3st")
 

reporting/tests/test_views.py

@@ -24,6 +24,7 @@
 from django.views.generic.detail import SingleObjectMixin
 from django.views.generic.list import MultipleObjectMixin
 
+import odfdo
 import saneyaml
 import xlsxwriter
 
@@ -232,6 +233,28 @@ def get_yaml_response(self, **response_kwargs):
         dump = self.get_dump(saneyaml.dump)
         return HttpResponse(dump, **response_kwargs)
 
+    def get_ods_response(self, **response_kwargs):
+        """Return the results as ods format."""
+        context = self.get_context_data(**self.kwargs)
+        report_data = [context["headers"]] + context["output"]
+
+        document = odfdo.Document("spreadsheet")
+        table = odfdo.Table("Report")
+
+        for row_data in report_data:
+            row = odfdo.Row()
+            for cell_value in row_data:
+                row.append(odfdo.Cell(normalize_newlines(cell_value), cell_type="string"))
+            table.append(row)
+
+        document.body.clear()
+        document.body.append(table)
+
+        file_output = io.BytesIO()
+        document.save(file_output)
+
+        return HttpResponse(file_output.getvalue(), **response_kwargs)
+
     def get_xlsx_response(self, **response_kwargs):
         """Return the results as `xlsx` format."""
         context = self.get_context_data(**self.kwargs)

reporting/views.py

@@ -0,0 +1,63 @@
+about_resource: lxml-6.0.2.tar.gz
+name: lxml
+version: 6.0.2
+download_url: https://files.pythonhosted.org/packages/aa/88/262177de60548e5a2bfc46ad28232c9e9cbde697bd94132aeb80364675cb/lxml-6.0.2.tar.gz
+description: |
+  Powerful and Pythonic XML processing library combining libxml2/libxslt with the ElementTree API.
+  lxml is a Pythonic, mature binding for the libxml2 and libxslt libraries.
+  It provides safe and convenient access to these libraries using the
+  ElementTree API.
+
+  It extends the ElementTree API significantly to offer support for XPath,
+  RelaxNG, XML Schema, XSLT, C14N and much more.
+
+  To contact the project, go to the `project home page <https://lxml.de/>`_
+  or see our bug tracker at https://launchpad.net/lxml
+
+  In case you want to use the current in-development version of lxml,
+  you can get it from the github repository at
+  https://github.com/lxml/lxml .  Note that this requires Cython to
+  build the sources, see the build instructions on the project home page.
+
+
+  After an official release of a new stable series, bug fixes may become available at
+  https://github.com/lxml/lxml/tree/lxml-6.0 .
+  Running ``pip install https://github.com/lxml/lxml/archive/refs/heads/lxml-6.0.tar.gz``
+  will install the unreleased branch state as soon as a maintenance branch has been established.
+  Note that this requires Cython to be installed at an appropriate version for the build.
+
+  6.0.2 (2025-09-21)
+  ==================
+
+  Bugs fixed
+  ----------
+
+  * LP#2125278: Compilation with libxml2 2.15.0 failed.
+    Original patch by Xi Ruoyao.
+
+  * Setting ``decompress=True`` in the parser had no effect in libxml2 2.15.
+
+  * Binary wheels on Linux and macOS use the library version libxml2 2.14.6.
+    See https://gitlab.gnome.org/GNOME/libxml2/-/releases/v2.14.6
+
+  * Test failures in libxml2 2.15.0 were fixed.
+
+  Other changes
+  -------------
+
+  * Binary wheels for Py3.9-3.11 on the ``riscv64`` architecture were added.
+
+  * Error constants were updated to match libxml2 2.15.0.
+
+  * Built using Cython 3.1.4.
+homepage_url: https://lxml.de/
+package_url: pkg:pypi/lxml@6.0.2
+license_expression: bsd-new
+copyright: Copyright Rick Jelliffe and Academia Sinica Computing Center
+attribute: yes
+checksum_md5: ac9a945976227fd854d3e9e034e52ca1
+checksum_sha1: 2b37a3d8ad8afe74b7ec616dc695ccc25a73bd97
+licenses:
+  - key: bsd-new
+    name: BSD-3-Clause
+    file: bsd-new.LICENSE