Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[16.0][MIG] report_py3o_signer #987

Open
wants to merge 4 commits into
base: 16.0
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 84 additions & 0 deletions report_py3o_signer/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
=======================
Py3o PDF reports signer
=======================

..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:e2bb49beb72cd72d59f2da5666c462a06d7c24c1cb22e25ca6647c18b8ea4f6b
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |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/16.0/report_py3o_signer
: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_py3o_signer
: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 module extends the functionality of report module to sign
PDFs using a PKCS#12 certificate.

This module extends the functionality the pdf report signing to py3o reports.
Please refer to the documentation of `report_py3o` for how to configure such reports.
Please refer to the documentation of `report_qweb_signer` for how to configure certificates for signing; such certificate will be used for any py3o report if its output is configured to be in pdf.

**Table of contents**

.. contents::
:local:

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_py3o_signer%0Aversion:%2016.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
~~~~~~~

* Lambdao

Contributors
~~~~~~~~~~~~

* `Lambdao <https://lambdao.dev>`_:

* Fanny He
* Nans Lefebvre

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/16.0/report_py3o_signer>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
1 change: 1 addition & 0 deletions report_py3o_signer/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from . import models
15 changes: 15 additions & 0 deletions report_py3o_signer/__manifest__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Copyright 2023 fah-mili/Lambdao
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).

{
"name": "Py3o PDF reports signer",
"summary": "Sign Py3o PDFs using a PKCS#12 certificate",
"version": "16.0.1.0.0",
"category": "Reporting",
"license": "AGPL-3",
"author": "Lambdao, Odoo Community Association (OCA)",
"website": "https://github.com/OCA/reporting-engine",
"depends": ["report_py3o", "report_qweb_signer"],
"data": [],
"installable": True,
}
1 change: 1 addition & 0 deletions report_py3o_signer/models/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from . import ir_actions_report
32 changes: 32 additions & 0 deletions report_py3o_signer/models/ir_actions_report.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Copyright 2023 fah-mili/Lambdao
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).

import logging

from odoo import models

_logger = logging.getLogger(__name__)


class IrActionsReport(models.Model):

_inherit = "ir.actions.report"

def _is_report_type_signable(self):
res = super()._is_report_type_signable()
return res or (self.report_type == "py3o" and self.py3o_filetype == "pdf")

def _render_py3o(self, report_ref, res_ids, data=None):
report = self._get_report(report_ref)
certificate = self._certificate_get(report, res_ids)
signed_content, ext = self._read_attached_signed_content(
report, res_ids, certificate
)
if signed_content:
return signed_content, "pdf"
content, ext = super(IrActionsReport, self)._render_py3o(
report_ref, res_ids, data
)
if certificate:
content = self._sign_pdf_and_attach(res_ids, certificate, content)
return content, ext
4 changes: 4 additions & 0 deletions report_py3o_signer/readme/CONTRIBUTORS.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
* `Lambdao <https://lambdao.dev>`_:

* Fanny He
* Nans Lefebvre
6 changes: 6 additions & 0 deletions report_py3o_signer/readme/DESCRIPTION.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
This module extends the functionality of report module to sign
PDFs using a PKCS#12 certificate.

This module extends the functionality the pdf report signing to py3o reports.
Please refer to the documentation of `report_py3o` for how to configure such reports.
Please refer to the documentation of `report_qweb_signer` for how to configure certificates for signing; such certificate will be used for any py3o report if its output is configured to be in pdf.
Loading