From 9cfb437eb283fe7af6ad7e9edd2ea7f271a528e9 Mon Sep 17 00:00:00 2001 From: LauraCForgeFlow Date: Tue, 27 Aug 2024 10:22:02 +0200 Subject: [PATCH] [ADD] report_qweb_pdf_cover --- report_qweb_pdf_cover/README.rst | 102 ++++ report_qweb_pdf_cover/__init__.py | 4 + report_qweb_pdf_cover/__manifest__.py | 16 + report_qweb_pdf_cover/i18n/es.po | 157 +++++++ .../i18n/report_qweb_pdf_cover.pot | 147 ++++++ report_qweb_pdf_cover/models/__init__.py | 4 + .../models/ir_actions_report.py | 216 +++++++++ report_qweb_pdf_cover/readme/CONTRIBUTORS.rst | 1 + report_qweb_pdf_cover/readme/DESCRIPTION.rst | 5 + report_qweb_pdf_cover/readme/USAGE.rst | 18 + .../static/description/index.html | 443 ++++++++++++++++++ .../views/ir_actions_views.xml | 38 ++ .../odoo/addons/report_qweb_pdf_cover | 1 + setup/report_qweb_pdf_cover/setup.py | 6 + 14 files changed, 1158 insertions(+) create mode 100644 report_qweb_pdf_cover/README.rst create mode 100644 report_qweb_pdf_cover/__init__.py create mode 100644 report_qweb_pdf_cover/__manifest__.py create mode 100644 report_qweb_pdf_cover/i18n/es.po create mode 100644 report_qweb_pdf_cover/i18n/report_qweb_pdf_cover.pot create mode 100644 report_qweb_pdf_cover/models/__init__.py create mode 100644 report_qweb_pdf_cover/models/ir_actions_report.py create mode 100644 report_qweb_pdf_cover/readme/CONTRIBUTORS.rst create mode 100644 report_qweb_pdf_cover/readme/DESCRIPTION.rst create mode 100644 report_qweb_pdf_cover/readme/USAGE.rst create mode 100644 report_qweb_pdf_cover/static/description/index.html create mode 100644 report_qweb_pdf_cover/views/ir_actions_views.xml create mode 120000 setup/report_qweb_pdf_cover/odoo/addons/report_qweb_pdf_cover create mode 100644 setup/report_qweb_pdf_cover/setup.py diff --git a/report_qweb_pdf_cover/README.rst b/report_qweb_pdf_cover/README.rst new file mode 100644 index 000000000..989b5165c --- /dev/null +++ b/report_qweb_pdf_cover/README.rst @@ -0,0 +1,102 @@ +===================== +Report QWeb PDF Cover +===================== + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:1287ee62d703ed048f33bb706f289cf01e5c99bead22b8b612d69e88071a4d67 + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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_qweb_pdf_cover + :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_qweb_pdf_cover + :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 allows for front and back covers to be added to the generated PDF +reports. They can be added as a separate page, at the beginning or the end of +the report, but they can also overlap the first and last page of the actual +report, respectively. + + +**Table of contents** + +.. contents:: + :local: + +Usage +===== + +To add a cover to a report, you need to access to the report's configuration, +more specifically to the `Advanced Properties` tab. There, you will find two +checkboxes, one for the front cover and another for the back cover. +They both work the same, so let's focus on the front cover with an example. + +* You must check the `Use Front Cover` checkbox to enable the front cover. You + will see that a new checkbox and a PDF file widget appear. + +* If you want the front cover to overlap with the first page of the PDF report, + you should also check the `Overlap Front Cover` checkbox. Leave it unchecked + if you don't want the front cover to overlap with the first page. + +* The last step would be to upload the PDF file that will be used as the front + cover. You can do this by clicking on the PDF file widget and selecting the + file. + +* Important! The file must be a PDF file, and it should have only one page. If + it has more pages, only the first one will be used. + +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 +~~~~~~~ + +* ForgeFlow + +Contributors +~~~~~~~~~~~~ + +* Laura Cazorla + +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 `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/report_qweb_pdf_cover/__init__.py b/report_qweb_pdf_cover/__init__.py new file mode 100644 index 000000000..753b6a792 --- /dev/null +++ b/report_qweb_pdf_cover/__init__.py @@ -0,0 +1,4 @@ +# Copyright 2024 ForgeFlow S.L. (https://www.forgeflow.com) +# Part of ForgeFlow. See LICENSE file for full copyright and licensing details. + +from . import models diff --git a/report_qweb_pdf_cover/__manifest__.py b/report_qweb_pdf_cover/__manifest__.py new file mode 100644 index 000000000..b0234148f --- /dev/null +++ b/report_qweb_pdf_cover/__manifest__.py @@ -0,0 +1,16 @@ +# Copyright 2024 ForgeFlow S.L. (https://www.forgeflow.com) +# Part of ForgeFlow. See LICENSE file for full copyright and licensing details. + +{ + "name": "Report QWeb PDF Cover", + "summary": "Add front and back covers to your QWeb PDF reports", + "author": "ForgeFlow, Odoo Community Association (OCA)", + "website": "https://github.com/OCA/reporting-engine", + "category": "Reporting", + "version": "16.0.1.0.0", + "license": "AGPL-3", + "depends": ["web"], + "data": ["views/ir_actions_views.xml"], + "installable": True, + "application": False, +} diff --git a/report_qweb_pdf_cover/i18n/es.po b/report_qweb_pdf_cover/i18n/es.po new file mode 100644 index 000000000..03b8c28b8 --- /dev/null +++ b/report_qweb_pdf_cover/i18n/es.po @@ -0,0 +1,157 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * report_qweb_pdf_cover +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 16.0+e\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2024-08-27 08:09+0000\n" +"PO-Revision-Date: 2024-08-27 08:09+0000\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_qweb_pdf_cover +#: model:ir.model.fields,field_description:report_qweb_pdf_cover.field_ir_actions_report__back_cover_pdf +msgid "Back Cover PDF" +msgstr "Contraportada PDF" + +#. module: report_qweb_pdf_cover +#. odoo-python +#: code:addons/report_qweb_pdf_cover/models/ir_actions_report.py:0 +#, python-format +msgid "Failed to load back cover: %s" +msgstr "Error al cargar la contraportada: %s" + +#. module: report_qweb_pdf_cover +#. odoo-python +#: code:addons/report_qweb_pdf_cover/models/ir_actions_report.py:0 +#, python-format +msgid "Failed to load front cover: %s" +msgstr "Error al cargar la portada: %s" + +#. module: report_qweb_pdf_cover +#: model:ir.model.fields,field_description:report_qweb_pdf_cover.field_ir_actions_report__front_cover_pdf +msgid "Front Cover PDF" +msgstr "Portada PDF" + +#. module: report_qweb_pdf_cover +#. odoo-python +#: code:addons/report_qweb_pdf_cover/models/ir_actions_report.py:0 +#, python-format +msgid "No usable back cover found." +msgstr "No se encontró ninguna contraportada usable." + +#. module: report_qweb_pdf_cover +#. odoo-python +#: code:addons/report_qweb_pdf_cover/models/ir_actions_report.py:0 +#, python-format +msgid "No usable front cover found." +msgstr "No se encontró ninguna portada usable." + +#. module: report_qweb_pdf_cover +#: model:ir.model.fields,field_description:report_qweb_pdf_cover.field_ir_actions_report__back_cover_overlap +msgid "Overlap Back Cover" +msgstr "Superponer Contraportada" + +#. module: report_qweb_pdf_cover +#: model:ir.model.fields,field_description:report_qweb_pdf_cover.field_ir_actions_report__front_cover_overlap +msgid "Overlap Front Cover" +msgstr "Superponer Portada" + +#. module: report_qweb_pdf_cover +#: model:ir.model,name:report_qweb_pdf_cover.model_ir_actions_report +msgid "Report Action" +msgstr "Acción de Informe" + +#. module: report_qweb_pdf_cover +#: model:ir.model.fields,help:report_qweb_pdf_cover.field_ir_actions_report__back_cover_pdf +msgid "Upload an PDF file to use as a back cover on this report." +msgstr "Suba un archivo PDF para usar como contraportada en este informe." + +#. module: report_qweb_pdf_cover +#: model:ir.model.fields,help:report_qweb_pdf_cover.field_ir_actions_report__front_cover_pdf +msgid "Upload an PDF file to use as a front cover on this report." +msgstr "Suba un archivo PDF para usar como portada en este informe." + +#. module: report_qweb_pdf_cover +#: model:ir.model.fields,field_description:report_qweb_pdf_cover.field_ir_actions_report__use_back_cover +msgid "Use Back Cover" +msgstr "Usar Contraportada" + +#. module: report_qweb_pdf_cover +#: model:ir.model.fields,field_description:report_qweb_pdf_cover.field_ir_actions_report__use_front_cover +msgid "Use Front Cover" +msgstr "Usar Portada" + +#. module: report_qweb_pdf_cover +#: model:ir.model.fields,help:report_qweb_pdf_cover.field_ir_actions_report__use_back_cover +msgid "Use a back cover when rendering the PDF report." +msgstr "Usar una contraportada al renderizar el informe PDF." + +#. module: report_qweb_pdf_cover +#: model:ir.model.fields,help:report_qweb_pdf_cover.field_ir_actions_report__use_front_cover +msgid "Use a front cover when rendering the PDF report." +msgstr "Usar una portada al renderizar el informe PDF." + +#. module: report_qweb_pdf_cover +#: model:ir.model.fields,help:report_qweb_pdf_cover.field_ir_actions_report__back_cover_overlap +msgid "" +"When set, the back cover of the report will overlap with the contents of the" +" last page of the report. This is useful to include some information of the" +" report in the back cover." +msgstr "" +"Cuando se establece, la contraportada del informe se superpondrá con el " +"contenido de la última página del informe. Esto es útil para incluir alguna " +"información del informe en la contraportada." + +#. module: report_qweb_pdf_cover +#: model:ir.model.fields,help:report_qweb_pdf_cover.field_ir_actions_report__front_cover_overlap +msgid "" +"When set, the front cover of the report will overlap with the contents of " +"the first page of the report. This is useful to include some information of " +"the report in the front cover." +msgstr "" +"Cuando se establece, la portada del informe se superpondrá con el contenido " +"de la primera página del informe. Esto es útil para incluir alguna " +"información del informe en la portada." + +#. module: report_qweb_pdf_cover +#. odoo-python +#: code:addons/report_qweb_pdf_cover/models/ir_actions_report.py:0 +#, python-format +msgid "" +"Your back cover PDF contains more than one page, all but the first one will " +"be ignored." +msgstr "" +"Su contraportada PDF contiene más de una página, todas menos la primera se " +"ignorarán." + +#. module: report_qweb_pdf_cover +#. odoo-python +#: code:addons/report_qweb_pdf_cover/models/ir_actions_report.py:0 +#, python-format +msgid "Your back cover PDF does not contain any pages." +msgstr "Su contraportada PDF no contiene ninguna página." + +#. module: report_qweb_pdf_cover +#. odoo-python +#: code:addons/report_qweb_pdf_cover/models/ir_actions_report.py:0 +#, python-format +msgid "" +"Your front cover PDF contains more than one page, all but the first one will" +" be ignored." +msgstr "" +"Su portada PDF contiene más de una página, todas menos la primera se " +"ignorarán." + +#. module: report_qweb_pdf_cover +#. odoo-python +#: code:addons/report_qweb_pdf_cover/models/ir_actions_report.py:0 +#, python-format +msgid "Your front cover PDF does not contain any pages." +msgstr "Su portada PDF no contiene ninguna página" diff --git a/report_qweb_pdf_cover/i18n/report_qweb_pdf_cover.pot b/report_qweb_pdf_cover/i18n/report_qweb_pdf_cover.pot new file mode 100644 index 000000000..109284fdf --- /dev/null +++ b/report_qweb_pdf_cover/i18n/report_qweb_pdf_cover.pot @@ -0,0 +1,147 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * report_qweb_pdf_cover +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 16.0+e\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2024-08-27 08:08+0000\n" +"PO-Revision-Date: 2024-08-27 08:08+0000\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_qweb_pdf_cover +#: model:ir.model.fields,field_description:report_qweb_pdf_cover.field_ir_actions_report__back_cover_pdf +msgid "Back Cover PDF" +msgstr "" + +#. module: report_qweb_pdf_cover +#. odoo-python +#: code:addons/report_qweb_pdf_cover/models/ir_actions_report.py:0 +#, python-format +msgid "Failed to load back cover: %s" +msgstr "" + +#. module: report_qweb_pdf_cover +#. odoo-python +#: code:addons/report_qweb_pdf_cover/models/ir_actions_report.py:0 +#, python-format +msgid "Failed to load front cover: %s" +msgstr "" + +#. module: report_qweb_pdf_cover +#: model:ir.model.fields,field_description:report_qweb_pdf_cover.field_ir_actions_report__front_cover_pdf +msgid "Front Cover PDF" +msgstr "" + +#. module: report_qweb_pdf_cover +#. odoo-python +#: code:addons/report_qweb_pdf_cover/models/ir_actions_report.py:0 +#, python-format +msgid "No usable back cover found." +msgstr "" + +#. module: report_qweb_pdf_cover +#. odoo-python +#: code:addons/report_qweb_pdf_cover/models/ir_actions_report.py:0 +#, python-format +msgid "No usable front cover found." +msgstr "" + +#. module: report_qweb_pdf_cover +#: model:ir.model.fields,field_description:report_qweb_pdf_cover.field_ir_actions_report__back_cover_overlap +msgid "Overlap Back Cover" +msgstr "" + +#. module: report_qweb_pdf_cover +#: model:ir.model.fields,field_description:report_qweb_pdf_cover.field_ir_actions_report__front_cover_overlap +msgid "Overlap Front Cover" +msgstr "" + +#. module: report_qweb_pdf_cover +#: model:ir.model,name:report_qweb_pdf_cover.model_ir_actions_report +msgid "Report Action" +msgstr "" + +#. module: report_qweb_pdf_cover +#: model:ir.model.fields,help:report_qweb_pdf_cover.field_ir_actions_report__back_cover_pdf +msgid "Upload an PDF file to use as a back cover on this report." +msgstr "" + +#. module: report_qweb_pdf_cover +#: model:ir.model.fields,help:report_qweb_pdf_cover.field_ir_actions_report__front_cover_pdf +msgid "Upload an PDF file to use as a front cover on this report." +msgstr "" + +#. module: report_qweb_pdf_cover +#: model:ir.model.fields,field_description:report_qweb_pdf_cover.field_ir_actions_report__use_back_cover +msgid "Use Back Cover" +msgstr "" + +#. module: report_qweb_pdf_cover +#: model:ir.model.fields,field_description:report_qweb_pdf_cover.field_ir_actions_report__use_front_cover +msgid "Use Front Cover" +msgstr "" + +#. module: report_qweb_pdf_cover +#: model:ir.model.fields,help:report_qweb_pdf_cover.field_ir_actions_report__use_back_cover +msgid "Use a back cover when rendering the PDF report." +msgstr "" + +#. module: report_qweb_pdf_cover +#: model:ir.model.fields,help:report_qweb_pdf_cover.field_ir_actions_report__use_front_cover +msgid "Use a front cover when rendering the PDF report." +msgstr "" + +#. module: report_qweb_pdf_cover +#: model:ir.model.fields,help:report_qweb_pdf_cover.field_ir_actions_report__back_cover_overlap +msgid "" +"When set, the back cover of the report will overlap with the contents of the" +" last page of the report. This is useful to include some information of the" +" report in the back cover." +msgstr "" + +#. module: report_qweb_pdf_cover +#: model:ir.model.fields,help:report_qweb_pdf_cover.field_ir_actions_report__front_cover_overlap +msgid "" +"When set, the front cover of the report will overlap with the contents of " +"the first page of the report. This is useful to include some information of " +"the report in the front cover." +msgstr "" + +#. module: report_qweb_pdf_cover +#. odoo-python +#: code:addons/report_qweb_pdf_cover/models/ir_actions_report.py:0 +#, python-format +msgid "" +"Your back cover PDF contains more than one page, all but the first one will " +"be ignored." +msgstr "" + +#. module: report_qweb_pdf_cover +#. odoo-python +#: code:addons/report_qweb_pdf_cover/models/ir_actions_report.py:0 +#, python-format +msgid "Your back cover PDF does not contain any pages." +msgstr "" + +#. module: report_qweb_pdf_cover +#. odoo-python +#: code:addons/report_qweb_pdf_cover/models/ir_actions_report.py:0 +#, python-format +msgid "" +"Your front cover PDF contains more than one page, all but the first one will" +" be ignored." +msgstr "" + +#. module: report_qweb_pdf_cover +#. odoo-python +#: code:addons/report_qweb_pdf_cover/models/ir_actions_report.py:0 +#, python-format +msgid "Your front cover PDF does not contain any pages." +msgstr "" diff --git a/report_qweb_pdf_cover/models/__init__.py b/report_qweb_pdf_cover/models/__init__.py new file mode 100644 index 000000000..ac9b7989c --- /dev/null +++ b/report_qweb_pdf_cover/models/__init__.py @@ -0,0 +1,4 @@ +# Copyright 2024 ForgeFlow S.L. (https://www.forgeflow.com) +# Part of ForgeFlow. See LICENSE file for full copyright and licensing details. + +from . import ir_actions_report diff --git a/report_qweb_pdf_cover/models/ir_actions_report.py b/report_qweb_pdf_cover/models/ir_actions_report.py new file mode 100644 index 000000000..d06d502b2 --- /dev/null +++ b/report_qweb_pdf_cover/models/ir_actions_report.py @@ -0,0 +1,216 @@ +# Copyright 2024 ForgeFlow S.L. (https://www.forgeflow.com) +# Part of ForgeFlow. See LICENSE file for full copyright and licensing details. + +from base64 import b64decode +from io import BytesIO +from logging import getLogger + +from PyPDF2 import PdfFileReader, PdfFileWriter + +from odoo import _, api, fields, models + +logger = getLogger(__name__) + + +class Report(models.Model): + _inherit = "ir.actions.report" + + use_front_cover = fields.Boolean( + default=False, help="Use a front cover when rendering the PDF report." + ) + use_back_cover = fields.Boolean( + default=False, help="Use a back cover when rendering the PDF report." + ) + + front_cover_overlap = fields.Boolean( + default=False, + string="Overlap Front Cover", + help="When set, the front cover of the report will overlap with the " + "contents of the first page of the report. This is useful to include " + "some information of the report in the front cover.", + ) + back_cover_overlap = fields.Boolean( + default=False, + string="Overlap Back Cover", + help="When set, the back cover of the report will overlap with the " + "contents of the last page of the report. This is useful to include " + "some information of the report in the back cover.", + ) + + front_cover_pdf = fields.Binary( + string="Front Cover PDF", + help="Upload an PDF file to use as a front cover on this report.", + ) + back_cover_pdf = fields.Binary( + string="Back Cover PDF", + help="Upload an PDF file to use as a back cover on this report.", + ) + + @api.model + def pdf_check_pages(self, num_pages, front=True): + if num_pages < 1: + if front: + logger.error(_("Your front cover PDF does not contain any pages.")) + else: + logger.error(_("Your back cover PDF does not contain any pages.")) + return False + elif num_pages > 1: + if front: + logger.info( + _( + "Your front cover PDF contains more than one page, " + "all but the first one will be ignored." + ) + ) + else: + logger.info( + _( + "Your back cover PDF contains more than one page, " + "all but the first one will be ignored." + ) + ) + return True + + def load_covers( + self, report_sudo, front_cover, back_cover, use_front_cover, use_back_cover + ): + if use_front_cover: + front_cover_pdf = self.front_cover_pdf or report_sudo.front_cover_pdf + if front_cover_pdf: + front_cover = b64decode(front_cover_pdf) + if use_back_cover: + back_cover_pdf = self.back_cover_pdf or report_sudo.back_cover_pdf + if back_cover_pdf: + back_cover = b64decode(back_cover_pdf) + return front_cover, back_cover + + @api.model + def load_cover_pdfs(self, front_cover, back_cover, use_front_cover, use_back_cover): + pdf_front_cover = False + pdf_back_cover = False + if use_front_cover: + try: + pdf_front_cover = PdfFileReader(BytesIO(front_cover)) + if not pdf_front_cover: + use_front_cover = False + logger.error(_("No usable front cover found.")) + except Exception as e: + use_front_cover = False + logger.exception(_("Failed to load front cover: %s", e)) + if use_back_cover: + try: + pdf_back_cover = PdfFileReader(BytesIO(back_cover)) + if not pdf_back_cover: + use_back_cover = False + logger.error(_("No usable back cover found.")) + except Exception as e: + use_back_cover = False + logger.exception(_("Failed to load back cover: %s", e)) + return use_front_cover, pdf_front_cover, use_back_cover, pdf_back_cover + + @api.model + def insert_cover_pages( + self, + pdf, + pages, + pdf_front_cover, + pdf_back_cover, + use_front_cover, + use_back_cover, + front_cover_overlap, + back_cover_overlap, + ): + for index, page in enumerate(pages): + report_page = pdf.addBlankPage( + page.mediaBox.getWidth(), page.mediaBox.getHeight() + ) + if index == 0 and use_front_cover: + if not front_cover_overlap: + front_cover_page = report_page + front_cover_page.mergePage(pdf_front_cover.getPage(0)) + report_page = pdf.addBlankPage( + page.mediaBox.getWidth(), page.mediaBox.getHeight() + ) + else: + report_page.mergePage(pdf_front_cover.getPage(0)) + if index == len(pages) - 1 and use_back_cover: + if not back_cover_overlap: + back_cover_page = pdf.addBlankPage( + page.mediaBox.getWidth(), page.mediaBox.getHeight() + ) + back_cover_page.mergePage(pdf_back_cover.getPage(0)) + else: + report_page.mergePage(pdf_back_cover.getPage(0)) + report_page.mergePage(page) + + @api.model + def _run_wkhtmltopdf( + self, + bodies, + report_ref=False, + header=None, + footer=None, + landscape=False, + specific_paperformat_args=None, + set_viewport_size=False, + ): + result = super()._run_wkhtmltopdf( + bodies, + report_ref=report_ref, + header=header, + footer=footer, + landscape=landscape, + specific_paperformat_args=specific_paperformat_args, + set_viewport_size=set_viewport_size, + ) + + report_sudo = self._get_report(report_ref) + front_cover = False + back_cover = False + use_front_cover = self.use_front_cover or report_sudo.use_front_cover + use_back_cover = self.use_back_cover or report_sudo.use_back_cover + front_cover_overlap = ( + self.front_cover_overlap or report_sudo.front_cover_overlap + ) + back_cover_overlap = self.back_cover_overlap or report_sudo.back_cover_overlap + if not use_front_cover and not use_back_cover: + return result + + front_cover, back_cover = self.load_covers( + report_sudo, front_cover, back_cover, use_front_cover, use_back_cover + ) + if not front_cover and not back_cover: + return result + + pdf = PdfFileWriter() + ( + use_front_cover, + pdf_front_cover, + use_back_cover, + pdf_back_cover, + ) = self.load_cover_pdfs( + front_cover, back_cover, use_front_cover, use_back_cover + ) + if use_front_cover and not self.pdf_check_pages( + pdf_front_cover.numPages, front=True + ): + use_front_cover = False + if use_back_cover and not self.pdf_check_pages( + pdf_back_cover.numPages, front=False + ): + use_back_cover = False + + pages = PdfFileReader(BytesIO(result)).pages + self.insert_cover_pages( + pdf, + pages, + pdf_front_cover, + pdf_back_cover, + use_front_cover, + use_back_cover, + front_cover_overlap, + back_cover_overlap, + ) + pdf_content = BytesIO() + pdf.write(pdf_content) + return pdf_content.getvalue() diff --git a/report_qweb_pdf_cover/readme/CONTRIBUTORS.rst b/report_qweb_pdf_cover/readme/CONTRIBUTORS.rst new file mode 100644 index 000000000..6d1dbddb9 --- /dev/null +++ b/report_qweb_pdf_cover/readme/CONTRIBUTORS.rst @@ -0,0 +1 @@ +* Laura Cazorla diff --git a/report_qweb_pdf_cover/readme/DESCRIPTION.rst b/report_qweb_pdf_cover/readme/DESCRIPTION.rst new file mode 100644 index 000000000..ca7792148 --- /dev/null +++ b/report_qweb_pdf_cover/readme/DESCRIPTION.rst @@ -0,0 +1,5 @@ +This module allows for front and back covers to be added to the generated PDF +reports. They can be added as a separate page, at the beginning or the end of +the report, but they can also overlap the first and last page of the actual +report, respectively. + diff --git a/report_qweb_pdf_cover/readme/USAGE.rst b/report_qweb_pdf_cover/readme/USAGE.rst new file mode 100644 index 000000000..812807b36 --- /dev/null +++ b/report_qweb_pdf_cover/readme/USAGE.rst @@ -0,0 +1,18 @@ +To add a cover to a report, you need to access to the report's configuration, +more specifically to the `Advanced Properties` tab. There, you will find two +checkboxes, one for the front cover and another for the back cover. +They both work the same, so let's focus on the front cover with an example. + +* You must check the `Use Front Cover` checkbox to enable the front cover. You + will see that a new checkbox and a PDF file widget appear. + +* If you want the front cover to overlap with the first page of the PDF report, + you should also check the `Overlap Front Cover` checkbox. Leave it unchecked + if you don't want the front cover to overlap with the first page. + +* The last step would be to upload the PDF file that will be used as the front + cover. You can do this by clicking on the PDF file widget and selecting the + file. + +* Important! The file must be a PDF file, and it should have only one page. If + it has more pages, only the first one will be used. diff --git a/report_qweb_pdf_cover/static/description/index.html b/report_qweb_pdf_cover/static/description/index.html new file mode 100644 index 000000000..2f6499217 --- /dev/null +++ b/report_qweb_pdf_cover/static/description/index.html @@ -0,0 +1,443 @@ + + + + + +Report QWeb PDF Cover + + + +
+

Report QWeb PDF Cover

+ + +

Beta License: AGPL-3 OCA/reporting-engine Translate me on Weblate Try me on Runboat

+

This module allows for front and back covers to be added to the generated PDF +reports. They can be added as a separate page, at the beginning or the end of +the report, but they can also overlap the first and last page of the actual +report, respectively.

+

Table of contents

+ +
+

Usage

+

To add a cover to a report, you need to access to the report’s configuration, +more specifically to the Advanced Properties tab. There, you will find two +checkboxes, one for the front cover and another for the back cover. +They both work the same, so let’s focus on the front cover with an example.

+
    +
  • You must check the Use Front Cover checkbox to enable the front cover. You +will see that a new checkbox and a PDF file widget appear.
    • +
  • If you want the front cover to overlap with the first page of the PDF report, +you should also check the Overlap Front Cover checkbox. Leave it unchecked +if you don’t want the front cover to overlap with the first page.
    • +
  • The last step would be to upload the PDF file that will be used as the front +cover. You can do this by clicking on the PDF file widget and selecting the +file.
    • +
  • Important! The file must be a PDF file, and it should have only one page. If +it has more pages, only the first one will be used.
    • +
+
+
+

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

+
    +
  • ForgeFlow
    • +
+
+
+

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.

+

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_qweb_pdf_cover/views/ir_actions_views.xml b/report_qweb_pdf_cover/views/ir_actions_views.xml new file mode 100644 index 000000000..f03704330 --- /dev/null +++ b/report_qweb_pdf_cover/views/ir_actions_views.xml @@ -0,0 +1,38 @@ + + + + ir.actions.report + + + + + + + + + + + + + + diff --git a/setup/report_qweb_pdf_cover/odoo/addons/report_qweb_pdf_cover b/setup/report_qweb_pdf_cover/odoo/addons/report_qweb_pdf_cover new file mode 120000 index 000000000..ddfe45659 --- /dev/null +++ b/setup/report_qweb_pdf_cover/odoo/addons/report_qweb_pdf_cover @@ -0,0 +1 @@ +../../../../report_qweb_pdf_cover \ No newline at end of file diff --git a/setup/report_qweb_pdf_cover/setup.py b/setup/report_qweb_pdf_cover/setup.py new file mode 100644 index 000000000..28c57bb64 --- /dev/null +++ b/setup/report_qweb_pdf_cover/setup.py @@ -0,0 +1,6 @@ +import setuptools + +setuptools.setup( + setup_requires=['setuptools-odoo'], + odoo_addon=True, +)