From 7877977c5e0fc34fedb6d3b6a24d18c50e2cd797 Mon Sep 17 00:00:00 2001 From: Benoit Aimont Date: Mon, 3 Aug 2026 16:01:59 +0200 Subject: [PATCH] [ADD] attachment_pdfa --- .github/workflows/test.yml | 2 + attachment_pdfa/README.rst | 152 +++++ attachment_pdfa/__init__.py | 1 + attachment_pdfa/__manifest__.py | 27 + attachment_pdfa/data/config_parameter.xml | 13 + .../data/iccprofiles_default_rgb.icc | Bin 0 -> 2576 bytes attachment_pdfa/data/ir_cron.xml | 13 + attachment_pdfa/data/pdfa3_metadata.xml | 46 ++ attachment_pdfa/data/pdfa_def.ps | Bin 0 -> 3091 bytes attachment_pdfa/models/__init__.py | 3 + .../models/attachment_pdfa_mixin.py | 16 + attachment_pdfa/models/ir_attachment.py | 336 +++++++++++ attachment_pdfa/models/res_config_settings.py | 31 + attachment_pdfa/pyproject.toml | 3 + attachment_pdfa/readme/CONFIGURE.md | 13 + attachment_pdfa/readme/CONTEXT.md | 1 + attachment_pdfa/readme/CONTRIBUTORS.md | 3 + attachment_pdfa/readme/DESCRIPTION.md | 8 + attachment_pdfa/readme/INSTALL.md | 4 + attachment_pdfa/readme/USAGE.md | 5 + attachment_pdfa/static/description/icon.png | Bin 0 -> 9455 bytes attachment_pdfa/static/description/index.html | 503 ++++++++++++++++ attachment_pdfa/tests/__init__.py | 1 + attachment_pdfa/tests/dummy.pdf | Bin 0 -> 13264 bytes attachment_pdfa/tests/fake_mail_message.py | 12 + attachment_pdfa/tests/pdfa_test_model.py | 15 + attachment_pdfa/tests/test_attachment_pdfa.py | 564 ++++++++++++++++++ attachment_pdfa/views/res_config_settings.xml | 31 + 28 files changed, 1803 insertions(+) create mode 100644 attachment_pdfa/README.rst create mode 100644 attachment_pdfa/__init__.py create mode 100644 attachment_pdfa/__manifest__.py create mode 100644 attachment_pdfa/data/config_parameter.xml create mode 100644 attachment_pdfa/data/iccprofiles_default_rgb.icc create mode 100644 attachment_pdfa/data/ir_cron.xml create mode 100644 attachment_pdfa/data/pdfa3_metadata.xml create mode 100644 attachment_pdfa/data/pdfa_def.ps create mode 100644 attachment_pdfa/models/__init__.py create mode 100644 attachment_pdfa/models/attachment_pdfa_mixin.py create mode 100644 attachment_pdfa/models/ir_attachment.py create mode 100644 attachment_pdfa/models/res_config_settings.py create mode 100644 attachment_pdfa/pyproject.toml create mode 100644 attachment_pdfa/readme/CONFIGURE.md create mode 100644 attachment_pdfa/readme/CONTEXT.md create mode 100644 attachment_pdfa/readme/CONTRIBUTORS.md create mode 100644 attachment_pdfa/readme/DESCRIPTION.md create mode 100644 attachment_pdfa/readme/INSTALL.md create mode 100644 attachment_pdfa/readme/USAGE.md create mode 100644 attachment_pdfa/static/description/icon.png create mode 100644 attachment_pdfa/static/description/index.html create mode 100644 attachment_pdfa/tests/__init__.py create mode 100644 attachment_pdfa/tests/dummy.pdf create mode 100644 attachment_pdfa/tests/fake_mail_message.py create mode 100644 attachment_pdfa/tests/pdfa_test_model.py create mode 100644 attachment_pdfa/tests/test_attachment_pdfa.py create mode 100644 attachment_pdfa/views/res_config_settings.xml diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index a06488079f..256706ebdf 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -55,6 +55,8 @@ jobs: - uses: actions/checkout@v4 with: persist-credentials: false + - name: Install Ghostscript + run: apt-get update && apt-get install -y ghostscript - name: Install addons and dependencies run: oca_install_addons - name: Check licenses diff --git a/attachment_pdfa/README.rst b/attachment_pdfa/README.rst new file mode 100644 index 0000000000..d444816235 --- /dev/null +++ b/attachment_pdfa/README.rst @@ -0,0 +1,152 @@ +================ +Attachment PDF/A +================ + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:607a7dc56a5708440b64968c78229b78bc02b715336989ba87460c94bd98e2fb + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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-LGPL--3-blue.png + :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html + :alt: License: LGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fstorage-lightgray.png?logo=github + :target: https://github.com/OCA/storage/tree/18.0/attachment_pdfa + :alt: OCA/storage +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/storage-18-0/storage-18-0-attachment_pdfa + :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/storage&target_branch=18.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module extends Odoo's attachment system to support background +conversion of PDF files to the **PDF/A-3** format. + +This module provides a flexible framework to automate PDF to PDF/A-3 +conversion via an asynchronous background cron: + +- **Opt-in via Mixin**: Rather than blindly converting all system PDFs, + models must opt-in by inheriting ``attachment.pdfa.mixin`` and + implementing conditional rules via + ``_attachment_must_be_pdfa(attachment)``. +- **Cron**: Attachments requiring conversion are flagged via the + ``is_pdfa_needed`` field on ``ir.attachment`` and processed by a + background cron. +- **Flexible Storage Strategy**: Configurable options allow converted + PDF/A files to either replace the original attachments or be saved + alongside them as new attachments. +- **Pluggable Engine**: Offers conversion via **Ghostscript** or native + **Odoo** PDF writer. + +**Table of contents** + +.. contents:: + :local: + +Use Cases / Context +=================== + +In many legal frameworks and corporate archiving policies, business +documents must be stored in a compliant, long-term preservation format +like **PDF/A-3**. + +Installation +============ + +To install and use Ghostscript conversion (default engine): + +1. Ensure Ghostscript is installed on your Odoo server host system. +2. Ensure the ``gs`` binary is available in the system execution PATH of + the user running Odoo. + +Configuration +============= + +To configure this module: + +1. Go to **Settings** > **General Settings**. +2. Scroll down to the **PDF/A Conversion** section under *Document + Settings*. +3. Configure your options: + + - **PDF to PDF/A Conversion Method**: + + - **Ghostscript** (default). + - **Odoo**. + - **Disable**: Disables automatic conversion globally. + + - **PDF/A Storage Strategy**: + + - **Replace Original File** (default): Overwrites the original PDF + attachment with the PDF/A binary. + - **Store Beside Original File**: Preserves the original file and + creates a new attachment named ``_PDFA.pdf`` alongside + it. + +4. Click **Save**. + +Usage +===== + +To use this module: + +1. Create or generate a PDF attachment on a record whose model + implements ``attachment.pdfa.mixin`` (and where + ``_attachment_must_be_pdfa(attachment)`` evaluates to ``True``). +2. The attachment automatically flags ``is_pdfa_needed = True``. +3. The scheduled cron processes pending attachments in the background, + updating or creating attachments according to your configured storage + strategy. + +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 +------- + +* ACSONE SA/NV + +Contributors +------------ + +- Zina Rasoamanana zina.rasoamanana@acsone.eu + (`Acsone `__) +- Benoit Aimont benoit.aimont@acsone.eu (`Acsone `__) +- Stéphane Bidoul stephane.bidoul@acsone.eu + (`Acsone `__) + +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/storage `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/attachment_pdfa/__init__.py b/attachment_pdfa/__init__.py new file mode 100644 index 0000000000..0650744f6b --- /dev/null +++ b/attachment_pdfa/__init__.py @@ -0,0 +1 @@ +from . import models diff --git a/attachment_pdfa/__manifest__.py b/attachment_pdfa/__manifest__.py new file mode 100644 index 0000000000..1a3094947c --- /dev/null +++ b/attachment_pdfa/__manifest__.py @@ -0,0 +1,27 @@ +# Copyright 2026 ACSONE SA/NV +# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl). + +{ + "name": "Attachment PDF/A", + "summary": """Convert PDF attachments to PDF/A""", + "version": "18.0.1.0.0", + "category": "Storage", + "license": "LGPL-3", + "author": "ACSONE SA/NV, Odoo Community Association (OCA)", + "website": "https://github.com/OCA/storage", + "depends": [ + "base_setup", + ], + "data": [ + "data/ir_cron.xml", + "data/config_parameter.xml", + "data/pdfa3_metadata.xml", + "views/res_config_settings.xml", + ], + "external_dependencies": { + "bin": [ + "gs", + ], + }, + "installable": True, +} diff --git a/attachment_pdfa/data/config_parameter.xml b/attachment_pdfa/data/config_parameter.xml new file mode 100644 index 0000000000..716a3aa653 --- /dev/null +++ b/attachment_pdfa/data/config_parameter.xml @@ -0,0 +1,13 @@ + + + + + attachment_pdfa.method + ghostscript + + + attachment_pdfa.mode + replace + + diff --git a/attachment_pdfa/data/iccprofiles_default_rgb.icc b/attachment_pdfa/data/iccprofiles_default_rgb.icc new file mode 100644 index 0000000000000000000000000000000000000000..055997234ccb99efe28d61a99f92459a4da3f77d GIT binary patch literal 2576 zcmb7_XH=BO8pr2--|dBk-DT;p^d?ox0#cTxEk$}26ZcZBoOQ`uf#?tl0H-M$+I(29Cb@84tpQz1k~rSn9tB~i)arSdZXfO15v zm7S5g!be3+k4X5!XIGdnI-p3uvBEK5dHjp#D+|AP{Cqf~TcH5Jkz)SA5&z)7_7&NI z3Y(u17af(u^i7G*$PVX6G1FHv!R2t6Ui_5kxWuRx*I)5}ng5>jUu{NIj_7Uxa8gn? z@#A7*GnoH6fw7^H5%~5NZ@j)B|MJ+ zgorQ@Wke5QAsoaL2|=O}KC%@lLMo63qz&mo`jLBx0GUHRpfD&Jiiy%gS)p7|{wN+Q z4Yd_jf~rQHKy{+}Q1?(1C?V=Inv9l5>!K~uTyzjR2Az#AL|34j&>iS&=n?c3`W*&? zVPG^d<`@@DFeVBejA_SQ#tdO5G4og~RtBq!wZ?j4!?79ILTnZGB=!<^7(0c1 zk0augaK<<%TnH{1myfH!wcsw|hH=xlMZ7p(9dC*E#7E*c;Y;z2_#XTn{1kqXAVJV1 zSQGpR@q`_ON5w?2P*NsoFX=ex zGU*}d4Vg^VAls2c$Qk6lBAAF`AgZ7*{M(Y@1k(Sf|*q*eeR2qE2B`Hc)aY z6_hiSJCr$bytsxqM?747t9Xt0Iq@;^c?p_?k%Xs2l0=C_i^NTd87h{lL3N}?QVXcZ zs8^|zG=!!~UHQE#%L)WBp>GAYp`j7NMx=@lTX(AaQnIl;vc|lUZKo}Yf zE+dgq$~es!Wqg!UkYYS^k*(fc(6IqJpzRszQ~*RfRc4 zhN7KfykfcHMa5Yqnv#uDoKm^cC8ZZkNhX__$gE`cF@?(V$}Y;8%Js^F%8M$RD*h_@ zD(xyyR0*mq)o9gn)m~Mhnv$A_TAo^~+9P$mI!irP{g8UU`hte0Mxe%SjV_HDO=(T8 zX0B$d=C~GF%T_B*t3m6&Hb$GJouGYK`>qbGW2zIYQ=@Z77uGe?jnh4>JG2VD%3@XW zs)ki#dL%uzUY1^~-h@6w-(5dnzf1p>fto>x!G42&gU^PhhKYuahL4S?My^KrMmw0T} z4bvvf=BSOpR@pY(w!!w9ovK}=U6b83TbmuvKFNM%Z)nfA@33FsSaP;-E;}F&&JINm zgN{^3f5&Rar%ozPF;1;cLT6Lw&CZuy&@OH+`(4Jk3S1tynJaWPcirOJ=SFh#b*pxJ z=C0$;ckl6lJzPBwc#N-AUz@zP%M*BVJr8(3@zV54^ZMBv>gk+V_OQDsrn(bmyr(K9jDF$ZF1V{KzAV&~#Gan*6J<6YwG;ujJ;6OJb= zCk7_AC*hL9lFlVllM|BrQWR5iQif7>QwviCX_jdR(}a9Cep5P>zCOJ>gD(0M2QsxX zcV$jw*<{sZz0VHFK9eJnlbkcKNoUiZP1Ctfxj$@1ZRTz6%~Q_XkvFl0y`_FDv^8RD z?>5zK1>2^!J8wU+gRmoE$1nMY`DOWUcLwh4DNrcbUNE`Kc~@(pSRub~Y`4|!y6;fm z#eFxpXZ4<{J)esri*6Mg7FQH6mGDY#eQ)%A<@d{bqxTM$nw1{ehuN3BZ*;%y{u5;q zWw~XO2RsgRmNUzX%HJN`c<^S0Nk!cu!lBGVf=c(w?kcsaeN{`YeL58#Ed!j$w{v9edsw(AfV2>xbqh*{0&APsfvw z3r_f)=xa7_Zf=opDQ$&YGh1g*hMv6pqr;EgZF+6>?Tq%~Q{YtQsTV(m{WN;o?R4)M z)|s}m>St>^XdOkJQ0JyjVOMOIpgXvG=$z}h-X5!-j-T~^K7L;Le9Z;P3#Atc7Yi;f zU&_5Se>wH?+?ALslf4^zA72f+dcV)RZ}6JiwHw!+u3znE_g}hUedGL1%bVwJv2JzU zHoM(9U^>w8i|H>NgJy%Bcg*i}-?g~gGqh&t;;`-Tm3t2NuHWb0zdf>cWN6fX^ubu@ znBYO=gPDhk4_`mZdbId>`#5^M=!y7~il_2V8-CUPwOwE)xG>=`G4Ray+2cvx + + + + Convert Attachments to PDF/A + + code + model._cron_convert_pdfa() + 1 + days + + diff --git a/attachment_pdfa/data/pdfa3_metadata.xml b/attachment_pdfa/data/pdfa3_metadata.xml new file mode 100644 index 0000000000..98c4f46e6c --- /dev/null +++ b/attachment_pdfa/data/pdfa3_metadata.xml @@ -0,0 +1,46 @@ + + + + diff --git a/attachment_pdfa/data/pdfa_def.ps b/attachment_pdfa/data/pdfa_def.ps new file mode 100644 index 0000000000000000000000000000000000000000..bde6414c2675e38e988bf580e29ed181119eaa0d GIT binary patch literal 3091 zcmb_eTTkOg6n@XII9&-Tks#jH?n8xGBsP>4t+=R!hYBh*v5&(Pd&WC622zy&-tUZ^ z;9Tf#r6L5jXU^?A-?{Ak)Z3x)z4nA(MP8Lv!BjcU^)uxf&$)G!I#xlODQ;XIpCm_= z*|aX%gdwD_Jv&eS-quA%rOk9cBOE!+o=W8&IHM;W?&;mA_Q96=Z+<6Y(WvqsdSKbm z>1YJIHrjOTb%xK{P`HN+;z!@R>13$Wbg&EQ_9U&HgDuLm<1|<|quLbgeH5$VSmThm zB8pOr>%OuklVA#Mm?m7% zj7f#SWfg##CC?#3mz-1I)a3+_+8jWZKoL;+0X^_6l0*O&AW~b{+L5nR%1AU612+pL zLb5>VJ*N*%I!3tZM%FxnKtS~>I2Cw0BQQ>sW&Eg9Ccu&+rSb9^+$%`uqV_Fmm@zhp zeS`{MZBa{Jr3i%YVm-140B{DUqw~sS5UvWuCH5Oa z0WK(cVs5Cqx3~B60scgC`G)u?D;>)!&h_*>t`Mm zl4_yktvo##`()?^w}0&Z6iiGX4P|vj$ycY)WxloI6e|TdexO`Q0f^3dqna9l-@kt8 z-d{?5>_~KEkd@KdAHS`N#8iD+5m*r+>feU9!WI6h1*c#8a= zK6W%ncgFaV`8{k_2&oKIMTUkMEb0MEgf>DC;7+nwXcNaiT9ND#MwRHS4yBmGV(mnV zRF=hFIcl{#Go*=D8=lh!b2ah5J4 z6B8RcMbXUGRANmcen#jiwu>1-2R0lGq3EBNNhv;KqQoy}g#yU$9646;kE@C%3jrUf!l4e$P zcM=G`Y`Kp?B~_J-<1*8|AfG!wJ9H*Uf*amaU)=No7%L}J{9BEU(GP}=t}6_b@l|x_ zLr25wWa+BwbKE-Ox4||6EtHY{mZo!uiE0 literal 0 HcmV?d00001 diff --git a/attachment_pdfa/models/__init__.py b/attachment_pdfa/models/__init__.py new file mode 100644 index 0000000000..a68e01fa2b --- /dev/null +++ b/attachment_pdfa/models/__init__.py @@ -0,0 +1,3 @@ +from . import attachment_pdfa_mixin +from . import res_config_settings +from . import ir_attachment diff --git a/attachment_pdfa/models/attachment_pdfa_mixin.py b/attachment_pdfa/models/attachment_pdfa_mixin.py new file mode 100644 index 0000000000..a7a6ef6dca --- /dev/null +++ b/attachment_pdfa/models/attachment_pdfa_mixin.py @@ -0,0 +1,16 @@ +# Copyright 2026 ACSONE SA/NV +# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl). + +from odoo import models + + +class AttachmentPdfaMixin(models.AbstractModel): + _name = "attachment.pdfa.mixin" + _description = "Attachment PDF/A Mixin" + + def _attachment_must_be_pdfa(self, attachment): + """Determine whether an attachment requires PDF/A conversion. + + :param attachment: ir.attachment record + """ + return False diff --git a/attachment_pdfa/models/ir_attachment.py b/attachment_pdfa/models/ir_attachment.py new file mode 100644 index 0000000000..14faa64ab1 --- /dev/null +++ b/attachment_pdfa/models/ir_attachment.py @@ -0,0 +1,336 @@ +# Copyright 2026 ACSONE SA/NV +# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl). + +import base64 +import io +import logging +import re +import subprocess +import tempfile +from pathlib import Path + +from odoo import _, api, fields, models, modules, tools +from odoo.exceptions import UserError +from odoo.tools.pdf import ( + DictionaryObject, + NameObject, + NumberObject, + OdooPdfFileReader, + OdooPdfFileWriter, +) + +_logger = logging.getLogger(__name__) + +TIMEOUT_CONVERSION = 60 + +_PDFA_TARGET_PART = "3" +_PDFA_PART_RE = re.compile(rb'pdfaid:part\s*(?:=\s*["\x27]|>)\s*(\d+)') + +DATA_DIR = (Path(__file__).parent.parent / "data").resolve() +ICC_PROFILE_PS = DATA_DIR / "pdfa_def.ps" +RGB_PROFILE = DATA_DIR / "iccprofiles_default_rgb.icc" + +_MISSING_PROFILE_MSG = "Ghostscript ICC Profile or PDF/A definition file not found." + +_PDFA_ABORT_MARKERS = ( + "PDF/A processing aborted", + "Failed to open the supplied ICCProfile", +) + +if not ICC_PROFILE_PS.is_file() or not RGB_PROFILE.is_file(): + _logger.error(_MISSING_PROFILE_MSG) + _PROFILES_AVAILABLE = False +else: + _PROFILES_AVAILABLE = True + + +class IrAttachment(models.Model): + _inherit = "ir.attachment" + + is_pdfa_needed = fields.Boolean( + string="Needs PDF/A Conversion", + compute="_compute_is_pdfa_needed", + store=True, + readonly=False, + precompute=True, + ) + + @api.depends("mimetype", "name", "res_model", "res_id") + def _compute_is_pdfa_needed(self): + for attachment in self: + attachment.is_pdfa_needed = attachment._check_should_be_pdfa() + + def _is_already_pdfa3(self, raw_data=None): + """Return True only if the content already declares PDF/A-3 conformance. + + Content already tagged PDF/A-1 or PDF/A-2 must still be (re-)converted, + since this module's conversion target is specifically PDF/A-3 -- the + presence of *a* pdfaid marker isn't enough to skip it. + """ + if raw_data is None: + raw_data = self._get_clean_raw_pdf() + match = _PDFA_PART_RE.search(raw_data) + if not match: + return False + return match.group(1).decode() == _PDFA_TARGET_PART + + def _get_clean_raw_pdf(self): + """Retrieve raw binary bytes, un-encoding base64 data if necessary.""" + self.ensure_one() + raw_data = self.raw + if not raw_data and self.datas: + try: + raw_data = base64.b64decode(self.datas) + except Exception: + raw_data = b"" + if raw_data and not raw_data.startswith(b"%PDF"): + try: + decoded = base64.b64decode(raw_data) + if decoded.startswith(b"%PDF"): + raw_data = decoded + except Exception as e: + _logger.debug("Failed to base64-decode attachment PDF raw data: %s", e) + return raw_data or b"" + + def _get_target_record(self): + """Retrieve the target record linked to this attachment.""" + self.ensure_one() + if not (self.res_model and self.res_id): + return False + res_model = self.res_model + res_id = self.res_id + # Target record may be linked to a mail.message (soft dependency: only + # resolved if the "mail" module happens to be installed) + message_model = self.env.get("mail.message") + if res_model == "mail.message" and message_model is not None: + message = message_model.browse(res_id) + if message.exists() and message.model and message.res_id: + res_model = message.model + res_id = message.res_id + model_obj = self.env.get(res_model) + if model_obj is None: + return False + record = model_obj.browse(res_id) + return record if record.exists() else False + + def _check_should_be_pdfa(self): + self.ensure_one() + is_pdf_mimetype = self.mimetype == "application/pdf" + is_pdf_extension = (self.name or "").lower().endswith(".pdf") + if not (is_pdf_mimetype or is_pdf_extension): + return False + raw_data = self._get_clean_raw_pdf() + if not raw_data.startswith(b"%PDF") or self._is_already_pdfa3(raw_data): + return False + record = self._get_target_record() + if not record or not hasattr(record, "_attachment_must_be_pdfa"): + return False + return record._attachment_must_be_pdfa(self) + + @api.model + def _gs_convert_pdf_to_pdfa(self, raw_content): + """Convert PDF raw bytes using Ghostscript.""" + if not _PROFILES_AVAILABLE: + return raw_content, False, _MISSING_PROFILE_MSG + temp_in = tempfile.NamedTemporaryFile(suffix=".pdf", delete=False) + temp_out = tempfile.NamedTemporaryFile(suffix=".pdf", delete=False) + try: + temp_in.write(raw_content) + temp_in.close() + temp_out.close() + args = [ + "gs", + f"--permit-file-read={RGB_PROFILE}", + "-dPDFACompatibilityPolicy=1", + "-sDEVICE=pdfwrite", + "-dPDFA=3", + "-sColorConversionStrategy=RGB", + "-o", + temp_out.name, + "-c", + f"/ICCProfile ({RGB_PROFILE}) def", + "-f", + str(ICC_PROFILE_PS), + str(temp_in.name), + ] + result = subprocess.run( + args, + capture_output=True, + text=True, + errors="replace", + timeout=TIMEOUT_CONVERSION, + check=False, + ) + log_output = (result.stdout or "") + "\n" + (result.stderr or "") + content = Path(temp_out.name).read_bytes() + pdfa_aborted = any(marker in log_output for marker in _PDFA_ABORT_MARKERS) + if result.returncode == 0 and content and not pdfa_aborted: + return content, True, log_output + if pdfa_aborted: + log_output = ( + "Ghostscript reported PDF/A processing was aborted " + "(output would not be PDF/A compliant):\n" + log_output + ) + return raw_content, False, log_output + except Exception as e: + msg = f"Ghostscript conversion exception: {e}" + _logger.exception(msg) + return raw_content, False, msg + finally: + Path(temp_in.name).unlink(missing_ok=True) + Path(temp_out.name).unlink(missing_ok=True) + + @staticmethod + def _ensure_pdf_outlines(writer): + """Odoo's convert_to_pdfa() assumes the root has /Outlines. + PDFs without bookmarks don't, so add an empty outline tree to avoid a KeyError. + """ + root = writer._root_object + if "/Outlines" not in root: + outlines = DictionaryObject( + { + NameObject("/Type"): NameObject("/Outlines"), + NameObject("/Count"): NumberObject(0), + } + ) + root[NameObject("/Outlines")] = writer._addObject(outlines) + + @api.model + def _odoo_convert_pdf_to_pdfa(self, raw_content, title): + """Convert PDF raw bytes using Odoo native PyPDF writer.""" + try: + reader = OdooPdfFileReader(io.BytesIO(raw_content), strict=False) + writer = OdooPdfFileWriter() + writer.cloneReaderDocumentRoot(reader) + self._ensure_pdf_outlines(writer) + writer.convert_to_pdfa() + metadata_template = self.env.ref( + "attachment_pdfa.pdfa3_metadata", raise_if_not_found=False + ) + if metadata_template: + content = self.env["ir.qweb"]._render( + "attachment_pdfa.pdfa3_metadata", + { + "title": title or "Document", + "date": fields.Date.context_today(self), + }, + ) + writer.add_file_metadata(content.encode("utf-8")) + new_pdf_stream = io.BytesIO() + writer.write(new_pdf_stream) + return new_pdf_stream.getvalue(), True, "Odoo conversion successful." + except Exception as e: + msg = f"Odoo PDF/A conversion failed: {str(e)}" + _logger.exception(msg) + return raw_content, False, msg + + def _process_one_pdfa_conversion(self, method): + """Process PDF/A conversion for a single attachment.""" + self.ensure_one() + raw_data = self._get_clean_raw_pdf() + if not raw_data or not raw_data.startswith(b"%PDF"): + self.write({"is_pdfa_needed": False}) + return + filename = self.name or "Document.pdf" + + if method == "odoo": + new_raw, success, log_msg = self._odoo_convert_pdf_to_pdfa( + raw_data, filename + ) + elif method == "ghostscript": + new_raw, success, log_msg = self._gs_convert_pdf_to_pdfa(raw_data) + else: + self.write({"is_pdfa_needed": False}) + return + if success: + mode = ( + self.env["ir.config_parameter"] + .sudo() + .get_param("attachment_pdfa.mode", "replace") + ) + if mode == "beside": + self.write({"is_pdfa_needed": False}) + base_name = Path(filename).stem + new_name = f"{base_name}_PDFA.pdf" + self.create( + { + "name": new_name, + "raw": new_raw, + "mimetype": "application/pdf", + "res_model": self.res_model, + "res_id": self.res_id, + "is_pdfa_needed": False, + } + ) + else: + self.write( + { + "raw": new_raw, + "mimetype": "application/pdf", + "is_pdfa_needed": False, + } + ) + else: + raise UserError( + _("PDF/A conversion failed for attachment %(name)s: %(msg)s") + % {"name": filename, "msg": log_msg} + ) + + @staticmethod + def _can_commit(): + """Helper to know if we can commit the current transaction or not. + + :returns: True if commit is acceptable, False otherwise. + """ + return not tools.config["test_enable"] and not modules.module.current_test + + @api.model + def _cron_convert_pdfa(self, batch_size=100): + """Cron entrypoint to convert attachments.""" + method = ( + self.env["ir.config_parameter"] + .sudo() + .get_param("attachment_pdfa.method", "ghostscript") + ) + if method == "disable": + return + # Use skip_res_field_check=True to include field-backed attachments + attachments = ( + self.sudo() + .with_context(skip_res_field_check=True) + .search([("is_pdfa_needed", "=", True)], limit=batch_size) + ) + if not attachments: + return + errors = [] + for attachment in attachments: + try: + with self.env.cr.savepoint(): + attachment._process_one_pdfa_conversion(method) + except Exception as e: + attachment.write({"is_pdfa_needed": False}) + errors.append(str(e)) + # Persist changes per attachment + if self._can_commit(): + self.env.cr.commit() # pylint: disable=invalid-commit + remaining_count = ( + self.sudo() + .with_context(skip_res_field_check=True) + .search_count([("is_pdfa_needed", "=", True)]) + ) + if len(attachments) == batch_size and remaining_count: + cron = self.env.ref( + "attachment_pdfa.ir_cron_convert_pdfa", raise_if_not_found=False + ) + if cron: + cron._trigger() + # If any conversions failed, raise the combined errors after treating all + # attachments + if errors: + raise UserError( + _( + "PDF/A conversion failed for %(count)s attachment(s):\n\n" + "%(errors)s" + ) + % {"count": len(errors), "errors": "\n\n".join(errors)} + ) diff --git a/attachment_pdfa/models/res_config_settings.py b/attachment_pdfa/models/res_config_settings.py new file mode 100644 index 0000000000..72c80ff8be --- /dev/null +++ b/attachment_pdfa/models/res_config_settings.py @@ -0,0 +1,31 @@ +# Copyright 2026 ACSONE SA/NV +# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl). + +from odoo import fields, models + + +class ResConfigSettings(models.TransientModel): + _inherit = "res.config.settings" + + attachment_pdfa_method = fields.Selection( + selection=[ + ("ghostscript", "Ghostscript"), + ("odoo", "Odoo"), + ("disable", "Disable"), + ], + string="PDF to PDF/A Conversion Method", + config_parameter="attachment_pdfa.method", + default="ghostscript", + help="Choose the underlying engine to convert PDF to PDF/A.", + ) + attachment_pdfa_mode = fields.Selection( + selection=[ + ("replace", "Replace Original File"), + ("beside", "Store Beside Original File"), + ], + string="PDF/A Storage Strategy", + config_parameter="attachment_pdfa.mode", + default="replace", + help="Choose whether to replace the original PDF attachment or create a new " + "attachment beside it.", + ) diff --git a/attachment_pdfa/pyproject.toml b/attachment_pdfa/pyproject.toml new file mode 100644 index 0000000000..4231d0cccb --- /dev/null +++ b/attachment_pdfa/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/attachment_pdfa/readme/CONFIGURE.md b/attachment_pdfa/readme/CONFIGURE.md new file mode 100644 index 0000000000..9d9e959013 --- /dev/null +++ b/attachment_pdfa/readme/CONFIGURE.md @@ -0,0 +1,13 @@ +To configure this module: + +1. Go to **Settings** > **General Settings**. +2. Scroll down to the **PDF/A Conversion** section under *Document Settings*. +3. Configure your options: + * **PDF to PDF/A Conversion Method**: + * **Ghostscript** (default). + * **Odoo**. + * **Disable**: Disables automatic conversion globally. + * **PDF/A Storage Strategy**: + * **Replace Original File** (default): Overwrites the original PDF attachment with the PDF/A binary. + * **Store Beside Original File**: Preserves the original file and creates a new attachment named `_PDFA.pdf` alongside it. +4. Click **Save**. diff --git a/attachment_pdfa/readme/CONTEXT.md b/attachment_pdfa/readme/CONTEXT.md new file mode 100644 index 0000000000..1abe61c9a7 --- /dev/null +++ b/attachment_pdfa/readme/CONTEXT.md @@ -0,0 +1 @@ +In many legal frameworks and corporate archiving policies, business documents must be stored in a compliant, long-term preservation format like **PDF/A-3**. diff --git a/attachment_pdfa/readme/CONTRIBUTORS.md b/attachment_pdfa/readme/CONTRIBUTORS.md new file mode 100644 index 0000000000..385e280022 --- /dev/null +++ b/attachment_pdfa/readme/CONTRIBUTORS.md @@ -0,0 +1,3 @@ +- Zina Rasoamanana ([Acsone](https://acsone.eu)) +- Benoit Aimont ([Acsone](https://acsone.eu)) +- Stéphane Bidoul ([Acsone](https://acsone.eu)) diff --git a/attachment_pdfa/readme/DESCRIPTION.md b/attachment_pdfa/readme/DESCRIPTION.md new file mode 100644 index 0000000000..ab5ff9f19d --- /dev/null +++ b/attachment_pdfa/readme/DESCRIPTION.md @@ -0,0 +1,8 @@ +This module extends Odoo's attachment system to support background conversion of PDF files to the **PDF/A-3** format. + +This module provides a flexible framework to automate PDF to PDF/A-3 conversion via an asynchronous background cron: + +* **Opt-in via Mixin**: Rather than blindly converting all system PDFs, models must opt-in by inheriting `attachment.pdfa.mixin` and implementing conditional rules via `_attachment_must_be_pdfa(attachment)`. +* **Cron**: Attachments requiring conversion are flagged via the `is_pdfa_needed` field on `ir.attachment` and processed by a background cron. +* **Flexible Storage Strategy**: Configurable options allow converted PDF/A files to either replace the original attachments or be saved alongside them as new attachments. +* **Pluggable Engine**: Offers conversion via **Ghostscript** or native **Odoo** PDF writer. diff --git a/attachment_pdfa/readme/INSTALL.md b/attachment_pdfa/readme/INSTALL.md new file mode 100644 index 0000000000..b205a51238 --- /dev/null +++ b/attachment_pdfa/readme/INSTALL.md @@ -0,0 +1,4 @@ +To install and use Ghostscript conversion (default engine): + +1. Ensure Ghostscript is installed on your Odoo server host system. +2. Ensure the ``gs`` binary is available in the system execution PATH of the user running Odoo. diff --git a/attachment_pdfa/readme/USAGE.md b/attachment_pdfa/readme/USAGE.md new file mode 100644 index 0000000000..f20e97cf2c --- /dev/null +++ b/attachment_pdfa/readme/USAGE.md @@ -0,0 +1,5 @@ +To use this module: + +1. Create or generate a PDF attachment on a record whose model implements `attachment.pdfa.mixin` (and where `_attachment_must_be_pdfa(attachment)` evaluates to `True`). +2. The attachment automatically flags `is_pdfa_needed = True`. +3. The scheduled cron processes pending attachments in the background, updating or creating attachments according to your configured storage strategy. diff --git a/attachment_pdfa/static/description/icon.png b/attachment_pdfa/static/description/icon.png new file mode 100644 index 0000000000000000000000000000000000000000..3a0328b516c4980e8e44cdb63fd945757ddd132d GIT binary patch literal 9455 zcmW++2RxMjAAjx~&dlBk9S+%}OXg)AGE&Cb*&}d0jUxM@u(PQx^-s)697TX`ehR4?GS^qbkof1cslKgkU)h65qZ9Oc=ml_0temigYLJfnz{IDzUf>bGs4N!v3=Z3jMq&A#7%rM5eQ#dc?k~! zVpnB`o+K7|Al`Q_U;eD$B zfJtP*jH`siUq~{KE)`jP2|#TUEFGRryE2`i0**z#*^6~AI|YzIWy$Cu#CSLW3q=GA z6`?GZymC;dCPk~rBS%eCb`5OLr;RUZ;D`}um=H)BfVIq%7VhiMr)_#G0N#zrNH|__ zc+blN2UAB0=617@>_u;MPHN;P;N#YoE=)R#i$k_`UAA>WWCcEVMh~L_ zj--gtp&|K1#58Yz*AHCTMziU1Jzt_jG0I@qAOHsk$2}yTmVkBp_eHuY$A9)>P6o~I z%aQ?!(GqeQ-Y+b0I(m9pwgi(IIZZzsbMv+9w{PFtd_<_(LA~0H(xz{=FhLB@(1&qHA5EJw1>>=%q2f&^X>IQ{!GJ4e9U z&KlB)z(84HmNgm2hg2C0>WM{E(DdPr+EeU_N@57;PC2&DmGFW_9kP&%?X4}+xWi)( z;)z%wI5>D4a*5XwD)P--sPkoY(a~WBw;E~AW`Yue4kFa^LM3X`8x|}ZUeMnqr}>kH zG%WWW>3ml$Yez?i%)2pbKPI7?5o?hydokgQyZsNEr{a|mLdt;X2TX(#B1j35xPnPW z*bMSSOauW>o;*=kO8ojw91VX!qoOQb)zHJ!odWB}d+*K?#sY_jqPdg{Sm2HdYzdEx zOGVPhVRTGPtv0o}RfVP;Nd(|CB)I;*t&QO8h zFfekr30S!-LHmV_Su-W+rEwYXJ^;6&3|L$mMC8*bQptyOo9;>Qb9Q9`ySe3%V$A*9 zeKEe+b0{#KWGp$F+tga)0RtI)nhMa-K@JS}2krK~n8vJ=Ngm?R!9G<~RyuU0d?nz# z-5EK$o(!F?hmX*2Yt6+coY`6jGbb7tF#6nHA zuKk=GGJ;ZwON1iAfG$E#Y7MnZVmrY|j0eVI(DN_MNFJmyZ|;w4tf@=CCDZ#5N_0K= z$;R~bbk?}TpfDjfB&aiQ$VA}s?P}xPERJG{kxk5~R`iRS(SK5d+Xs9swCozZISbnS zk!)I0>t=A<-^z(cmSFz3=jZ23u13X><0b)P)^1T_))Kr`e!-pb#q&J*Q`p+B6la%C zuVl&0duN<;uOsB3%T9Fp8t{ED108<+W(nOZd?gDnfNBC3>M8WE61$So|P zVvqH0SNtDTcsUdzaMDpT=Ty0pDHHNL@Z0w$Y`XO z2M-_r1S+GaH%pz#Uy0*w$Vdl=X=rQXEzO}d6J^R6zjM1u&c9vYLvLp?W7w(?np9x1 zE_0JSAJCPB%i7p*Wvg)pn5T`8k3-uR?*NT|J`eS#_#54p>!p(mLDvmc-3o0mX*mp_ zN*AeS<>#^-{S%W<*mz^!X$w_2dHWpcJ6^j64qFBft-o}o_Vx80o0>}Du;>kLts;$8 zC`7q$QI(dKYG`Wa8#wl@V4jVWBRGQ@1dr-hstpQL)Tl+aqVpGpbSfN>5i&QMXfiZ> zaA?T1VGe?rpQ@;+pkrVdd{klI&jVS@I5_iz!=UMpTsa~mBga?1r}aRBm1WS;TT*s0f0lY=JBl66Upy)-k4J}lh=P^8(SXk~0xW=T9v*B|gzIhN z>qsO7dFd~mgxAy4V?&)=5ieYq?zi?ZEoj)&2o)RLy=@hbCRcfT5jigwtQGE{L*8<@Yd{zg;CsL5mvzfDY}P-wos_6PfprFVaeqNE%h zKZhLtcQld;ZD+>=nqN~>GvROfueSzJD&BE*}XfU|H&(FssBqY=hPCt`d zH?@s2>I(|;fcW&YM6#V#!kUIP8$Nkdh0A(bEVj``-AAyYgwY~jB zT|I7Bf@%;7aL7Wf4dZ%VqF$eiaC38OV6oy3Z#TER2G+fOCd9Iaoy6aLYbPTN{XRPz z;U!V|vBf%H!}52L2gH_+j;`bTcQRXB+y9onc^wLm5wi3-Be}U>k_u>2Eg$=k!(l@I zcCg+flakT2Nej3i0yn+g+}%NYb?ta;R?(g5SnwsQ49U8Wng8d|{B+lyRcEDvR3+`O{zfmrmvFrL6acVP%yG98X zo&+VBg@px@i)%o?dG(`T;n*$S5*rnyiR#=wW}}GsAcfyQpE|>a{=$Hjg=-*_K;UtD z#z-)AXwSRY?OPefw^iI+ z)AXz#PfEjlwTes|_{sB?4(O@fg0AJ^g8gP}ex9Ucf*@_^J(s_5jJV}c)s$`Myn|Kd z$6>}#q^n{4vN@+Os$m7KV+`}c%4)4pv@06af4-x5#wj!KKb%caK{A&Y#Rfs z-po?Dcb1({W=6FKIUirH&(yg=*6aLCekcKwyfK^JN5{wcA3nhO(o}SK#!CINhI`-I z1)6&n7O&ZmyFMuNwvEic#IiOAwNkR=u5it{B9n2sAJV5pNhar=j5`*N!Na;c7g!l$ z3aYBqUkqqTJ=Re-;)s!EOeij=7SQZ3Hq}ZRds%IM*PtM$wV z@;rlc*NRK7i3y5BETSKuumEN`Xu_8GP1Ri=OKQ$@I^ko8>H6)4rjiG5{VBM>B|%`&&s^)jS|-_95&yc=GqjNo{zFkw%%HHhS~e=s zD#sfS+-?*t|J!+ozP6KvtOl!R)@@-z24}`9{QaVLD^9VCSR2b`b!KC#o;Ki<+wXB6 zx3&O0LOWcg4&rv4QG0)4yb}7BFSEg~=IR5#ZRj8kg}dS7_V&^%#Do==#`u zpy6{ox?jWuR(;pg+f@mT>#HGWHAJRRDDDv~@(IDw&R>9643kK#HN`!1vBJHnC+RM&yIh8{gG2q zA%e*U3|N0XSRa~oX-3EAneep)@{h2vvd3Xvy$7og(sayr@95+e6~Xvi1tUqnIxoIH zVWo*OwYElb#uyW{Imam6f2rGbjR!Y3`#gPqkv57dB6K^wRGxc9B(t|aYDGS=m$&S!NmCtrMMaUg(c zc2qC=2Z`EEFMW-me5B)24AqF*bV5Dr-M5ig(l-WPS%CgaPzs6p_gnCIvTJ=Y<6!gT zVt@AfYCzjjsMEGi=rDQHo0yc;HqoRNnNFeWZgcm?f;cp(6CNylj36DoL(?TS7eU#+ z7&mfr#y))+CJOXQKUMZ7QIdS9@#-}7y2K1{8)cCt0~-X0O!O?Qx#E4Og+;A2SjalQ zs7r?qn0H044=sDN$SRG$arw~n=+T_DNdSrarmu)V6@|?1-ZB#hRn`uilTGPJ@fqEy zGt(f0B+^JDP&f=r{#Y_wi#AVDf-y!RIXU^0jXsFpf>=Ji*TeqSY!H~AMbJdCGLhC) zn7Rx+sXw6uYj;WRYrLd^5IZq@6JI1C^YkgnedZEYy<&4(z%Q$5yv#Boo{AH8n$a zhb4Y3PWdr269&?V%uI$xMcUrMzl=;w<_nm*qr=c3Rl@i5wWB;e-`t7D&c-mcQl7x! zZWB`UGcw=Y2=}~wzrfLx=uet<;m3~=8I~ZRuzvMQUQdr+yTV|ATf1Uuomr__nDf=X zZ3WYJtHp_ri(}SQAPjv+Y+0=fH4krOP@S&=zZ-t1jW1o@}z;xk8 z(Nz1co&El^HK^NrhVHa-_;&88vTU>_J33=%{if;BEY*J#1n59=07jrGQ#IP>@u#3A z;!q+E1Rj3ZJ+!4bq9F8PXJ@yMgZL;>&gYA0%_Kbi8?S=XGM~dnQZQ!yBSgcZhY96H zrWnU;k)qy`rX&&xlDyA%(a1Hhi5CWkmg(`Gb%m(HKi-7Z!LKGRP_B8@`7&hdDy5n= z`OIxqxiVfX@OX1p(mQu>0Ai*v_cTMiw4qRt3~NBvr9oBy0)r>w3p~V0SCm=An6@3n)>@z!|o-$HvDK z|3D2ZMJkLE5loMKl6R^ez@Zz%S$&mbeoqH5`Bb){Ei21q&VP)hWS2tjShfFtGE+$z zzCR$P#uktu+#!w)cX!lWN1XU%K-r=s{|j?)Akf@q#3b#{6cZCuJ~gCxuMXRmI$nGtnH+-h z+GEi!*X=AP<|fG`1>MBdTb?28JYc=fGvAi2I<$B(rs$;eoJCyR6_bc~p!XR@O-+sD z=eH`-ye})I5ic1eL~TDmtfJ|8`0VJ*Yr=hNCd)G1p2MMz4C3^Mj?7;!w|Ly%JqmuW zlIEW^Ft%z?*|fpXda>Jr^1noFZEwFgVV%|*XhH@acv8rdGxeEX{M$(vG{Zw+x(ei@ zmfXb22}8-?Fi`vo-YVrTH*C?a8%M=Hv9MqVH7H^J$KsD?>!SFZ;ZsvnHr_gn=7acz z#W?0eCdVhVMWN12VV^$>WlQ?f;P^{(&pYTops|btm6aj>_Uz+hqpGwB)vWp0Cf5y< zft8-je~nn?W11plq}N)4A{l8I7$!ks_x$PXW-2XaRFswX_BnF{R#6YIwMhAgd5F9X zGmwdadS6(a^fjHtXg8=l?Rc0Sm%hk6E9!5cLVloEy4eh(=FwgP`)~I^5~pBEWo+F6 zSf2ncyMurJN91#cJTy_u8Y}@%!bq1RkGC~-bV@SXRd4F{R-*V`bS+6;W5vZ(&+I<9$;-V|eNfLa5n-6% z2(}&uGRF;p92eS*sE*oR$@pexaqr*meB)VhmIg@h{uzkk$9~qh#cHhw#>O%)b@+(| z^IQgqzuj~Sk(J;swEM-3TrJAPCq9k^^^`q{IItKBRXYe}e0Tdr=Huf7da3$l4PdpwWDop%^}n;dD#K4s#DYA8SHZ z&1!riV4W4R7R#C))JH1~axJ)RYnM$$lIR%6fIVA@zV{XVyx}C+a-Dt8Y9M)^KU0+H zR4IUb2CJ{Hg>CuaXtD50jB(_Tcx=Z$^WYu2u5kubqmwp%drJ6 z?Fo40g!Qd<-l=TQxqHEOuPX0;^z7iX?Ke^a%XT<13TA^5`4Xcw6D@Ur&VT&CUe0d} z1GjOVF1^L@>O)l@?bD~$wzgf(nxX1OGD8fEV?TdJcZc2KoUe|oP1#=$$7ee|xbY)A zDZq+cuTpc(fFdj^=!;{k03C69lMQ(|>uhRfRu%+!k&YOi-3|1QKB z z?n?eq1XP>p-IM$Z^C;2L3itnbJZAip*Zo0aw2bs8@(s^~*8T9go!%dHcAz2lM;`yp zD=7&xjFV$S&5uDaiScyD?B-i1ze`+CoRtz`Wn+Zl&#s4&}MO{@N!ufrzjG$B79)Y2d3tBk&)TxUTw@QS0TEL_?njX|@vq?Uz(nBFK5Pq7*xj#u*R&i|?7+6# z+|r_n#SW&LXhtheZdah{ZVoqwyT{D>MC3nkFF#N)xLi{p7J1jXlmVeb;cP5?e(=f# zuT7fvjSbjS781v?7{)-X3*?>tq?)Yd)~|1{BDS(pqC zC}~H#WXlkUW*H5CDOo<)#x7%RY)A;ShGhI5s*#cRDA8YgqG(HeKDx+#(ZQ?386dv! zlXCO)w91~Vw4AmOcATuV653fa9R$fyK8ul%rG z-wfS zihugoZyr38Im?Zuh6@RcF~t1anQu7>#lPpb#}4cOA!EM11`%f*07RqOVkmX{p~KJ9 z^zP;K#|)$`^Rb{rnHGH{~>1(fawV0*Z#)}M`m8-?ZJV<+e}s9wE# z)l&az?w^5{)`S(%MRzxdNqrs1n*-=jS^_jqE*5XDrA0+VE`5^*p3CuM<&dZEeCjoz zR;uu_H9ZPZV|fQq`Cyw4nscrVwi!fE6ciMmX$!_hN7uF;jjKG)d2@aC4ropY)8etW=xJvni)8eHi`H$%#zn^WJ5NLc-rqk|u&&4Z6fD_m&JfSI1Bvb?b<*n&sfl0^t z=HnmRl`XrFvMKB%9}>PaA`m-fK6a0(8=qPkWS5bb4=v?XcWi&hRY?O5HdulRi4?fN zlsJ*N-0Qw+Yic@s0(2uy%F@ib;GjXt01Fmx5XbRo6+n|pP(&nodMoap^z{~q ziEeaUT@Mxe3vJSfI6?uLND(CNr=#^W<1b}jzW58bIfyWTDle$mmS(|x-0|2UlX+9k zQ^EX7Nw}?EzVoBfT(-LT|=9N@^hcn-_p&sqG z&*oVs2JSU+N4ZD`FhCAWaS;>|wH2G*Id|?pa#@>tyxX`+4HyIArWDvVrX)2WAOQff z0qyHu&-S@i^MS-+j--!pr4fPBj~_8({~e1bfcl0wI1kaoN>mJL6KUPQm5N7lB(ui1 zE-o%kq)&djzWJ}ob<-GfDlkB;F31j-VHKvQUGQ3sp`CwyGJk_i!y^sD0fqC@$9|jO zOqN!r!8-p==F@ZVP=U$qSpY(gQ0)59P1&t@y?5rvg<}E+GB}26NYPp4f2YFQrQtot5mn3wu_qprZ=>Ig-$ zbW26Ws~IgY>}^5w`vTB(G`PTZaDiGBo5o(tp)qli|NeV( z@H_=R8V39rt5J5YB2Ky?4eJJ#b`_iBe2ot~6%7mLt5t8Vwi^Jy7|jWXqa3amOIoRb zOr}WVFP--DsS`1WpN%~)t3R!arKF^Q$e12KEqU36AWwnCBICpH4XCsfnyrHr>$I$4 z!DpKX$OKLWarN7nv@!uIA+~RNO)l$$w}p(;b>mx8pwYvu;dD_unryX_NhT8*Tj>BTrTTL&!?O+%Rv;b?B??gSzdp?6Uug9{ zd@V08Z$BdI?fpoCS$)t4mg4rT8Q_I}h`0d-vYZ^|dOB*Q^S|xqTV*vIg?@fVFSmMpaw0qtTRbx} z({Pg?#{2`sc9)M5N$*N|4;^t$+QP?#mov zGVC@I*lBVrOU-%2y!7%)fAKjpEFsgQc4{amtiHb95KQEwvf<(3T<9-Zm$xIew#P22 zc2Ix|App^>v6(3L_MCU0d3W##AB0M~3D00EWoKZqsJYT(#@w$Y_H7G22M~ApVFTRHMI_3be)Lkn#0F*V8Pq zc}`Cjy$bE;FJ6H7p=0y#R>`}-m4(0F>%@P|?7fx{=R^uFdISRnZ2W_xQhD{YuR3t< z{6yxu=4~JkeA;|(J6_nv#>Nvs&FuLA&PW^he@t(UwFFE8)|a!R{`E`K`i^ZnyE4$k z;(749Ix|oi$c3QbEJ3b~D_kQsPz~fIUKym($a_7dJ?o+40*OLl^{=&oq$<#Q(yyrp z{J-FAniyAw9tPbe&IhQ|a`DqFTVQGQ&Gq3!C2==4x{6EJwiPZ8zub-iXoUtkJiG{} zPaR&}_fn8_z~(=;5lD-aPWD3z8PZS@AaUiomF!G8I}Mf>e~0g#BelA-5#`cj;O5>N Xviia!U7SGha1wx#SCgwmn*{w2TRX*I literal 0 HcmV?d00001 diff --git a/attachment_pdfa/static/description/index.html b/attachment_pdfa/static/description/index.html new file mode 100644 index 0000000000..0aec36ca8d --- /dev/null +++ b/attachment_pdfa/static/description/index.html @@ -0,0 +1,503 @@ + + + + + +Attachment PDF/A + + + +
+

Attachment PDF/A

+ + +

Beta License: LGPL-3 OCA/storage Translate me on Weblate Try me on Runboat

+

This module extends Odoo’s attachment system to support background +conversion of PDF files to the PDF/A-3 format.

+

This module provides a flexible framework to automate PDF to PDF/A-3 +conversion via an asynchronous background cron:

+
    +
  • Opt-in via Mixin: Rather than blindly converting all system PDFs, +models must opt-in by inheriting attachment.pdfa.mixin and +implementing conditional rules via +_attachment_must_be_pdfa(attachment).
    • +
  • Cron: Attachments requiring conversion are flagged via the +is_pdfa_needed field on ir.attachment and processed by a +background cron.
    • +
  • Flexible Storage Strategy: Configurable options allow converted +PDF/A files to either replace the original attachments or be saved +alongside them as new attachments.
    • +
  • Pluggable Engine: Offers conversion via Ghostscript or native +Odoo PDF writer.
    • +
+

Table of contents

+ +
+

Use Cases / Context

+

In many legal frameworks and corporate archiving policies, business +documents must be stored in a compliant, long-term preservation format +like PDF/A-3.

+
+
+

Installation

+

To install and use Ghostscript conversion (default engine):

+
    +
  1. Ensure Ghostscript is installed on your Odoo server host system.
    2. +
  2. Ensure the gs binary is available in the system execution PATH of +the user running Odoo.
    3. +
+
+
+

Configuration

+

To configure this module:

+
    +
  1. Go to Settings > General Settings.
    2. +
  2. Scroll down to the PDF/A Conversion section under Document +Settings.
    3. +
  3. Configure your options:
      +
    • PDF to PDF/A Conversion Method:
        +
      • Ghostscript (default).
        • +
      • Odoo.
        • +
      • Disable: Disables automatic conversion globally.
        • +
      +
      • +
    • PDF/A Storage Strategy:
        +
      • Replace Original File (default): Overwrites the original PDF +attachment with the PDF/A binary.
        • +
      • Store Beside Original File: Preserves the original file and +creates a new attachment named <Filename>_PDFA.pdf alongside +it.
        • +
      +
      • +
    +
    4. +
  4. Click Save.
    5. +
+
+
+

Usage

+

To use this module:

+
    +
  1. Create or generate a PDF attachment on a record whose model +implements attachment.pdfa.mixin (and where +_attachment_must_be_pdfa(attachment) evaluates to True).
    2. +
  2. The attachment automatically flags is_pdfa_needed = True.
    3. +
  3. The scheduled cron processes pending attachments in the background, +updating or creating attachments according to your configured storage +strategy.
    4. +
+
+
+

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

+
    +
  • ACSONE SA/NV
    • +
+
+
+

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/storage project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ + diff --git a/attachment_pdfa/tests/__init__.py b/attachment_pdfa/tests/__init__.py new file mode 100644 index 0000000000..0ad1d8a437 --- /dev/null +++ b/attachment_pdfa/tests/__init__.py @@ -0,0 +1 @@ +from . import test_attachment_pdfa diff --git a/attachment_pdfa/tests/dummy.pdf b/attachment_pdfa/tests/dummy.pdf new file mode 100644 index 0000000000000000000000000000000000000000..774c2ea70c55104973794121eae56bcad918da97 GIT binary patch literal 13264 zcmaibWmsIxvUW%|5FkJZ7A&~y%m9Oj;I6>~WPrgfxD$eVfZ*=#?hsspJHa(bATYRn zGueBev(G*EKHr+BrK+pDs^6;aH9u<6Dv3$30@ygwX}fZ|TDt1G($Rqw927PN=I8~c_R69-cY5S*jJE@5Wr0JUS6u!J~3#h`{ZMo=LkbbALoD8vfgB}Fh|2>mhOnfS$3 zNV5}8Ox=$fj;C0=UKy*{myZZPRVS|0mqr-HxZAy;()@wxQ}MN`QWAZTXb3Z&Om9W2 zbnA^OWoQbAW|3W^fw#J;YzDato8*`rHQs+@W70D&SyT{wb`SN*3nI z5G%$wJlq932=n{60Eii*9H8dFih2ks?QY=>nAFL=5g^P@#b{YUEHt0S$D7WbX zx%TzvzIK%zpvzLEd9LNr0ch#LFf_(9 zEGt0C9v~%b54vynAc{~;v&2?S(-sTTft@9CABMNFZHtY1W0-99CEbUNfp_yu{LDBz z@8z^$LPN$wX4Hi+dZQs6K3QiKKF0}Nme@EII;;F}IplC(YvT*C3-Oh#(A}e5pIz01 zyR}D2|ftBF0T=1moHZy}$wS*PSCmSzHQ%x z2tCQQCx4jt7w1cuhY69~eH`31KC4)ZZJ^)f=IabocAkBPa zEeg25yPX&9-i_N(Qiq!I3RDrfx&0t^i)&MSQ1D(w%|%#LTNr>1cPiltAYO;6kBn(B?r11c^Bz~#)z5~~V+*`U)lDFtKbZ|;? z&4wTUtK=KE&uQIWUQv1mDE;LIhXXgx44PMa@%Z<7a& zx45^oYSnei^~%}`?!O-+cgfSmn_c?`=Gmm*Z^I(96ve&$zDs|)r84)IEEiE1kfQ$q zm3km*m1)PjdU9nkk9BTlidI1~M|O~WfP7AUu2T}d>5is9l$<%;7r2&Re06w>W$KM~ zqITBTd=Ln>^crw`_N?{ z;2d_=E0n!*NisQ|XYuX9q3+UcqdA(MC45|>2tz^c6HdZOmXTB?X2Elx@_0f)1z&-gS;UxN`>Ll-kWb0X0 zTrQis=w9sJ(q7k|@|k3SA~DJ@uMXP@4(Mgn+LJC+3F~3NHW71pIzY(aHg~{O+squi zWO_|F>78)L5*gcRXXRD9IzQ(ddSxh}E7(8sC~EYrOz$9BkSMBCkGGO9FuZ{#*mW+h zvwE7d)6Ag=a*R5URs>}qdqb_E6g)kN2Wel;pWe9=hZ)XvRZR!RQg&gxAPGj8J0!gR zrdV<2@MZQ?_Ocbd5@0zI?t>$z3eD80_h^{DI)H5lk`T4lbn8kteH3%fOBH^g26#lLN2&P^s zr&d05GDs)u_8OKzCgNxllk5pLC<2wKmghL{zW%}5^}%S$?d=3OzjaSzT3>uWYikZN z2ZcR7*L|%UMs|u)wMi7#vkN?cxlBcyAM80Tyzzv&zHMF1TH9?Mx5&E57P^)^zE5N| z^foq}!--if$Uj=U6Tc>EM!Pv)e^_SZSdvtQ=@>)(ONejQ!XW8u6>ESl<*s^6cH;Q1 z#n}nL{#|{l}}@td^zNSA;R{`3A&Jjr8L9(3^2FSyZ1W9$%;!XP#N2 z-SAzyRfxtgq^py7_3*GJFO%x_v<`xJ46`~S*IukgQDKfLxzFnS&GYL!1LA{I z!c#{A90{k(b*tUfbgjOH>}{#V;%^O+LUU<*#QkLtWzjho*Kb?Cr&wC38%wxpn}^Wy zG6EpV9x3xioCWA6H6=aE3)%jmZePu#Ji7wy0CmkDZNG`a{J1i-2`Bt&UrFb&<~V$^ zy9i`R1<35M&{mtCz144%v#7LKBTPPApjoV}#W-gDc5cn;A@Mbt#zXUK@J9^vj*ME( zo8(%K{c-KDr8n1-I&Mjn)*i|pF|7l*`fXvo8-z&j{$NOfUPM-xILbX1D29IHp|__B zL*JQ8*7-VrZVY*&$!PiE%zv@osg`qx0M8+w9iy7Az7;HYezs;5NRvrdNM~t@o}5Gc zjagk3Y_>6!Ct;ITqhu3FojJO^(^SG-($M4|frkp?4y-QoSmFcw9Z%(z?eC0kGi9@? zm(vAgXU|%!6_)CrnqYL-Hj@B5hA?#8C3G^cjd?0dMSZ!wbe%O4bWvlIG=nwOEInVj zhjzd`Bry8sXBTfIUr+juZH5JyE#7~UQiwR!gmG@wm}aNyo`13xEo)tzP64MWWG|j8 z8u8a2_=C2FdRZ9(eG&Au`@$mY9vvWldP-@wj5@38H0W2V8wnaQO?!)qoS_J=(ieoI zOvH}mkBRh_p1oTW66+?3u-GH2Ex~c=BQiwpJ zJlF7O2PBaCojRRL_mp44*Iq}vcRFpBD>V9M7do5{w&b;4^<_V~Vr{+O_&hz9k5Sm` zq3|%Z(6B5~wz2k0iH-QlafAa>1%ZebdxkR;6SdA?@dK|4Jf8PIO%64Fpw$6RYG2R# zX>Iq(xf`5Xk)79-@;BAQjlWu|w@Ss3sJv3Ew&%lBu-H?vYsC8XPJD!lkv*A~z_-k= zLOaM?B5}$Sf-KF5BWHoB51WFA{GlweQna618{*tqVn)YKUVq?khU_=QER9uW?N17xgAponbjg0W`=>f;sulH3?st)Y_@k$We2-__a>^{E78lUiI13qq!3# zwxMEl75MK1q`~J>ST#?`mUx#vr%-jwpZ+DV;W!0KNkZmO#sK)zt)H@`EQl6RRWhwb z0&E7|fG~@z)wlK1-RsxN#8Gr)D5=xpv=b}=CWPbwz@(9bIhD0Crd-Q>qEo>~Gh{X7 z77AK5>TfF0wK!?7Nx!<5uDy?D{Qg$SEc_R3J9EuH!Z@qmEJ*QRRHd3BPirM6783nv zAnab$>rhdDJ6pO@%Ox(}BYw{Ba<3|=A%Fg5_Hfxj{%CfzZCFO{?%h&=?%CNBvi&p; z(otqN>+5giLLa^*G?xzN30=IgQrV+r7dW4bX;zKtuD)O$UnwAKC?CpkPt{77nUArH ze-jKcCfRrOlp(Q^b&W}mrgt4n%wikNxeSBBE_n>K-IOIzi6!<)xGRYA)wGgqp^s@d46N#krDHPc#9SOgXhI7Vbj?B z%c6@8dCOGPYBoNE#3N7HD^ihbC9*xGm6chu;?fcuv)s01keHHZ1vXl5D;29O7wZBr zyPzyLZHKMtUI%PK+*X2zTFtaDzU1qn(H=hRRj-SoJw7I5i%4b0u=&InEAKgoae-lp zXk0SkjlJ52HruS*1QykTZ&aCN`PbcKuw$1st{peJ@&aF^aR@~{XA@L&YvK%+VU}G4 ze5iuesu&i6=*#nvHbm_v-ZLr5^Ij#|YSAper4XpsH;0x(2h1-tIobIy;0~2a( z!G($SB!iu#P;;hGeI~C`O=-3|d~zoB0!`*JrU-)Ko_X5#kSpy5o^z49RG;{j#l~45 zF?X9Ih4IdviT(8@+q|`BveLTprbESZ6^2I&ew|V3pDXRe9gSyXT)zzqKQ;gCD;p+( zM)2(;YJ%P5)X(N3ZSn>dn6UIcEcvQOXZBn}uD!7V0yXr$f+d@eTSYoquPit2S8cPW zA8t3dX)Cv{0cKF`@e|PP(xS0|z2_R0(P6)#+kC$0^5- z$7Hs|bOQanE z1oJ;uh(dYiDt}mVmtC3&HaGT6-dY429v#ySHJ7V)C8ow=PSmnEI)=b3_RJsU(S*+J zV$p3>RkK?DFvTc;(-T=h!1u~CP!pE=0eSSu#c@N7S0Z57CPg}!5z{QL#`2v?DJDt^ zCGN{0p-&&=)Sb28Xlo;ZXc^CGdwL9prf30uu$y5aPeWD6WIk4%%~DEhTiwOvy!rS% z&3z#DWo2qBA*=M2xIu=_R0sbrmP;Y?_rRa^k}3WYU6n9H^(})Zi-woMKKXfgbab@J zWx3DUr0MLpdDYk_LO8As}d*Z=x^K+uIv#T&SnY6&C$9 zBn1u`G#TBt+n5b%a;Cr0h^sm5Fl^OdxJ^8IebW);DWATq#Ba=#rggj*wNKy5NMzz& zBm`bk9bcSVPJbC`dHrI>o^=LSvTFpT`VAK`x_naOpvS~*l2$1vIk$avBA!|aeZ+7c z$_9Zzh>fc4$uX&w@-$VORCscG(B)OA@SPj>BNY3gxkkcPgNi9bE=?&3A4`3ekrdsb zn~`M;p8I>4?@@ZI{9Afv(tC@pp@Oe5BYUw-%&J_WaTBGls)&d8q?t$i<<@=_CNfH! z4H!ww7#gkp_^`bxZaJI9@C+A9x7@E1ZRoG5PL?w3GDi>`8Qq%I+0ygfT78%{Zt#mP zqX0CzaHKn@hAOQsv=^8UbfpuyFnT8Ht++Vmmx$~09!e{5t8fMkEjr~tfIxMlIpr4zGwvEIWKC2`Q#C)c7QF9wet?hE zLKoU?t@nqm=iBc` z8_((*(i(g}7z)3{%SJ!uya{?Ir-2^Fiap*VC4pF@N zpL5F*DG+(taLhdu4DbyAP(0&60n@%?G~hHugBI^-X6@_YOu}8UqwbQ8V`2vwDRLMz z)aRFo+r1f?5idT9xRF`cjgx$a-IpH3AH|bs$emw}d23*3aU0hYNh4(D0o-Z+wIX{d zeann?lzjgsAt62`er@<$`G755?i7tl%CHNgXp}#j>j&S1n5wZ;ofNbI>B2*4L1}@3 zq(LzPqn()w{KBsX!5*a&=dv<}t=R%II;TcQatbnKM7S4Q1PQIoT=^$#=>Y(m{mBYtl5W z6}|l4kxikOcJ`C3o{TSxIi?8|N6sH7Lkhq5qttl@uBTA|-cBluU$hU0&xYKvNidrL z4q>|j76}G1Db23Fa|XlFm%W&jW0h#7B$_FD-ZhqJ5#7i!0ZmCrereX z|Jlf`<1zR2akFe|boWv-r=}kM03o|%$mZA7Of2T99u~e56~6sh$P=yk9f!H6msn)n zvFOLF?W?iqi6fK9C)a42Sgt0kz4#M6 z-UY6451Er~=V;ITs1O-q*>}{;bs74MMZ(Z&=Z{5#q+i@cw^vI#0|Dh~-Dh-tn2I(S zTXXp-bLEG{p0#BbIqIcTM|DWZmr`&br8u)jQ`CR*^+g_fIX%=K+)x}F%Oak-Uh$6nIHUavnNV5M7YffU80QPRD%y>T{bIzn<6Rsy zb6cW6`?0EwSn;uJddPn@`?^Cry2s(6ccP1ykKr!kmDg2~zbTJq@+e(z5N>ZNr|8$j zPi-~ofp7E|Xx1#H+f@UR@AS}iLP!}}dRwf{u!avAq-_hNw#uaoOD{2jo*eRn8$~bDK`h1&ssOC6ekGV38+hU!KR z+kpnSzT;y#o|V2h|F?SY4-z1MFxz0;)@Lk`H>Cj zSl@fR%*@F79;HJcsX%L8_d!%TwmQyi$|n&C{oBMJ9~Xm!@@#lZdz(WB9SgJ#NIC%@ zy+~ZnI|4E`7f@W0Y9I@N7UTs1fTPD-ZiU%Lr2MnP+2h8AGh?(WGVf>h@W-_M>jRkD z(KNxvo(UJ7)o+*t%fCcM10;2XM$1NAFKwhp(c917^io_ynn-yv58IFIF*UJUw*2Ma zm?a-a1yp9B?WxpLzap-c^$HKkX_IfT_W8Lqaltl*A%vZSZWAe`Kv}vjz}>Tc;Hw9T zA+Nc49X&{WDmxY~ReV0YceXdL!$9mTL$Q@_vXIW6I{G=`$KR7jFcE&IsHwnKX;KldV#YL z(xwKAB5cFiz+r6m*5iJvo&E)XQqVWjmA}BfyVS&dm9&Y%$Sp^sW!JE3iI0v(kQHdo zmhWk|gC!e@CFKPv4BE*U;mYo0y}J0J-Fhu!c%v+paQf9+3Ed2EkfPt(D7|Ok#t)^PGr3Y)RGfvO=k;@Xry=Cf3fLCQ# zi`%oCt+vyB-t{iEgI&+2dczmnMXj>EOmSpMuuL8Ob`1$D;fc$wM6j2HH4Q$ zqaoj&M$2sLhpptdJMbs!krJId=iOd}HdP4Lt@yf42OZ{pOoQ4_gShz_sMoWYX}yQd zDQ8(tc7UvTt%`0#?9K!C^J>GpucEnBhnsWg102Z=uzOlwez^q^j7nV$krID#wC}A$ zcRfc2)T5Y~({6@1`{yL-Lzs;miT@C9|1SIFBMK7cz*E;v2H|EStZphjfb5mGMpw{q z!pl;Vw772tuvDH4o$;j4u8)@=m+&BIf4Ix(u75P?Q{4Y8^uvpq)mCW(enuQc)hx$B zOY{`_*%~bm%k*x6y;)D8_-yYbMsC8y#1H}89X;M=a#*HT>d*NFf}x$pQ&X?nFtvzA zKH|l8y;frsm|&}<%&*}Yu}Yn0M=Jy8qe%<1qXRR%Nut}Aqr+1pQS*D7Cp`+8Y`RO02p14DyVOmSYlEzZ;9&JzYhtybMZ%e4s zlks=V(+aJ!LK-()3ox`%9c)lx#3#y4{ulL6KpG|&>9`n?Uh#m3G-mZy-3h98Scyja zH^3Pb7?P z+2hAkyvg}g$#)n$Gs2fL19JNOZ|~>Nx(|}lmwesC!>?Y~72mpf4XZ8t^TIwbCk;i0 z+a2ymSZ^=OrtrSH!(y#Vn!8KWk#O7<1-!if+`dDDy18U7wS3k$lIeM}Z0fhYqI)+x zo*o4*S$S|hGf6vL>PaQ(OQ_%eskx-G-FV|dXHbTH<#w@RbeIx9I$d$xqHh`{*&d3y zevlYNk)}w@cuu4A$^DYJsOvO7VBaom@Rx@gb$V5IKJ{Xue16H-1H0j=U0brW-aVRG znWCQRkESBmD^4?a7mB@!jf2>(Hs=Bd-;XX1oEilevb9axB^NhIPLO>jl03S+Rw|fx z&oIsIk(~W!4$zzKF|uSR<@S#;{r;fKup)iDaxz_9JouroY>XHcrN(Mm@UHV?-8bCh zXGfY~7U`rCasv(h-R*ava)^ zF1`BMT*n3xQBTdM?`n&h2Ecf*XXuLo7Zyl_El(v~oh>}mK01$%0a@#uzyiX_g>Bav2XWwH%YekAxU%pBT!p*?%cS#zA zv;^eDC#KZP@7o=^GDc_V8<3w>`*L(+=A#(fcH)dGjqM}Vk_el+c>B`{9xm<>IZ-Zm zLL!-Yf*3nju_(8ZGUd9*K`iofWW+BYFnZF&+a|=yxqV?oUOcG#ulnSR$DMs|e5Tph%WW zVjzE3nMh7+rG!}av)+~;o$#+EHyPX zzOUO?^#)Jh*t^b7pTW+I%f;xy&JMPCO&5RR``BmHX-Mw{qoJp9BjKea$;A9%>-iEZ zvuUBm%0j5UWax~`ue!K6dDdip+zs3f{+qQKqH;9C(1Z@95()-Ew=`BdLh2VS3zI8qYGH&&7m9+vpUc+x8l!i-ATXKhw34XL2;ya_VIQz!OL^)8mtqnb?q=~&^h-$;Zn^HRZ2p(gH z39An;`AWT=i&VP0u&CUe7OYW51Icv=q%Vc7%Zm z_uAp9n}osEUdk2*pV)*i`WRSa-FWtCwGqS-75@K#V0)r;+0(0XVp9vnb7lWiMj!q= z>Zf(ioa@gSwA55Jil$lh)%4U<)$j@HTQU2KwuUUsZA*2O^QTKobak8g0Qb~ROMTW7 zfTF2yF*na6i(lQ*Nq^rPen^0>$$b`K!Kp{FVa-VF`kCiXZg0Vtr}i*rcpny_YOR!} z+?Jiv?dWlT`}o$s9Fxt%%684d7ek-q-Q~jS*I5+8HtvSw+Rp!D=+gVr!gqcYy9K74 z&eClx6f6{1Din;ynjz?XZlJ~W7^A@0wiHIt8$aou;f>MYpU%gUlDwAK*nX0#vHtyl z_C=B+ZkOffY|oR^2>(+IlZCTMFirZMhn>bqzR=38hvJpcM4-@gUYY7_k^G*FW9;5r zc9q4c>C?hd{uS3{MThN*(w!3e05e?bI#SNlo$U&%>((Dz0_JeqbG|}!wI$& z%q2JQ)Vas;i0RYqNXW!CC~QK%u$K$beGI zT2KuzMjus26(zmofK;m2gY%d*o~sHBKA#`RBNc9c*-GLmbgh?*9V;^TBSot2E%~Q5 zl+R!WA_h_JT;+irbJ#Z-tSy-;B^t&&dOSwPV(T!CB)no8Y4sP%k(MD^0P!NL1vK&7 z`3luW2$gkI#Zf>IZT2=m4R&e@d zeo#B=Q|9`w8}%|)f%GBjYO01&Dk5qjm$+#1yia#CE=Sh~88Vdp%|VU}0a6mF@JkhUY&~W3f#rHK-1Qdo z>0*z5?#-hQUY}k^X7~1bkI?($-~3#c3mF4Cl@2%|0@1=ARZ z^qlNaN63&>;O_~mmto}?tAhznb}p;GpyIq1Z^yf<_6Ui~cpbbP;uV7W!+ke>wYG-f zPPz2~%UgSs(>vsKFle%uo=WIDYz;BR!doAy)aQ0QCpE_Wz1XK+3Kpr=V_H8w zqzaizn9ALx#?fo-N)_CtENYH*1|ID|x=xa9d#;9~1Wgrcx^8=evrfky*Xj`269~A;kh^O|ewZnM}=SmM7NX=?h#jjLh&1kIT+A z)If4luYo@s+e_L&eRJ$gw1`)>u#efOq=M0iYIPS$GII0z`T56eNxK@~Y%*^~Q&w$1b)jM9Z~kuRc~YX`6r#ySCskW5cq|#a39s;ZiaL~OdEpgu z1k*sKkLZ&?6fAi=)77yKI1xii%)@DG8r}663xkJcwLTj?s`h{GP@_2}`A|;w7zrzk4QOQ*O$(e|M^<`vLD*1^i>Nr*= z+A`y@f{!zLi)ys9OrFM5`Qw0292Ciyq>zC>8(TkG1O;#UUh?#I08kuwpS_vhufJ0v&p^Yr`=^WG7!qVG(8n9u7=J64fr zQq7B|9rzl7s)I_|8UeVp?=cqGILQ}0O(n+^vJz=vFBU9JmG$=DWzi+qCHw@D0a7`M zA`%pmU8+8W{u0{2*^tg&3;I&i`4`{YJe_n8 z{viTJZL?$}#l9w${3mydrW>Z%nY!WXf$HJv5$Zw4F%7^mXWsZ-s&olv31;C*KlH)j z?j?Eika^cI`l>)WJ*ga?%>0HwJm{%<)OP8pdvwMG@fm;Ca`jfy7ixY-sic42*f&ld zJg3(O0~;=Zsp@cdUj@&Zj~#~LX=F5Ws@!Ik0-~(wlbJO6&)S~s6WrAW9lrQ%6+S03 z&P&xJ{;BC%2s%J#uxZy3=Fc}fkwE9(T}QAK9b{FT!L3^PQ~;#X$T|9v&JFq)ru$h|ls zvPxYyWT}V&Dol3#)t6pVE4nIClEq=r++eGcG-tkOW4{n$Ra~3z?`@_gXRUiR`SrhY4K z#>C+t>pNtm>!Zw*;p^qI0|g<)Ob`r0jaN6asw2ZGLT}bMbHnQ$OH8cR7{Rq?=4%&x z2Qe&O`w$~b%fuo>fkgT`PVx=uto@&SdDpIXL)<da|A*x(b?o zdUj^iN+B9%;2{1URo7=%m@r*RJi3fQNO_`AZY;b#tClm;A}NQF#!Y;pMMdh=^fO@9 z>J>Xv^joKJM>M7x=xh!oSLO3JlxVwTn$DPHdGsnkAvB)9d)IE6ZHgd1vd+Z;W1d682CBy4zti z&6;T6!rzSKIy&zKKfAx9J%7q-=Mac{u-_GIYEaZt*`h25Ne?ch`E_c2{pGA<;nVkx z102u6#||N$g5MhA{!rFwaI(;8$S{1DePGc^L~j6?Q$2QMIO09 zPdma#_kX(|;oOau(pX877ac9V4O8x3g{Mdbr6oS)7 zN0v#H_j!bhUNl;q>GrkeA~){;lCg@&Mg5(z%E1HV`d7{>_}@9JZ(VJn>=HKC4q{My zLpw8D2OD@&E}T?=SV7rE-XI?4H+E(aOI8sZOC$NW=!leE6MG6ycn2;fB4XpB!^#Z= zQ?P=-+!R0#4h{+c2LPbUF6{uZG&6i-ZDI+f;6P`8V{ZtxcA((p;6i6ds6r4x005m` z6k;m{H8U}FK+J;+syaZe)G2u2J;eI(G+`)^0+C~@0#BIzJLi_?-}e8NR15?I|34|k zx>2LneiYApj|7nW4k1sp9h-vz^G);Jq7ONB*clw!(IJ2QT3sYWS)>yb_Ual2Um3r5 zw706UJD48HLY73$&Gm=sl|EYND&Uk>VT!eN_p49f6HS<{TU>u{4&#WYh1dwy^E8il ziH`_=$2m8k)y$Q2yDZQluP+AZbND!Yi7Co@fwHnw2pV1bo*=wGx2n7Urt$y1@imz1&#&nK47Nw zT-dLY@^1NHY?5B#-Qf9?`lA_={@NnLpmwJGQG7&oU}0>) ziZ`GdjY(jIKi2Q?e+d=de}nq3pkP;ZG;lyf$Xh!{=x?qF#2$)p%>NM^W_I=tqNWf# zgv;e1fAtY=)-W@2FtyhKb8%3Bfj|mw00#vR4=)857d&XdU z(4fLD4>dA_AWjHkeJ)-u3LZ|NF1w_ijiW6*A6^xXD#Y5}7O{k(E4!#F{9rhl8A4Sg zMcAb&9N>rx39*a9v4(4~r$8jq|MLt0{*hTPYU2nu0sub&aQG~$!9>qU@%LGVw1{ZAdD5crj3WAdl2KV62-uIT7sX=aUZ*>8aV1F3(c z_P=p-FtxG!8!9*^U<3>RcoByeFaipAK|lhB5)AqaI)n^@hmeEwxOw0OKK@%C0pZ{C z5o^F{FbEE(DEt!$_$B<8DlYiaV7ME855ql#Py+_S#o(c8`L;d6lqRR~$cn(zq-4};(pf)4`xt=`PWS`7YO27?$MdgtpDP{`vCa4 z{2x3Z5bm@8-~oUj5Zv+q!Gl}N`CoDX0N4M*gTIpgb1nb?;)Y)s|FIqb0Ot6gw!m#h zTnhg~j+YZ2)c?r?0yzIm4hZ1=FTFrc;D6}=a`OJeW(PY6{AFi{I1;L6ZcsR+>?$@k z@FNVDLEL!K*2XpzfZwk|I3Y%%Lm?mm76XGtKw?0k2(JV$kO#;s#>p!o!6gRf5#f;l j@(7{-|3%=32kuUL2Z)`+Z(jm{U>-0!Ev>ks1p5C2Hj`#V literal 0 HcmV?d00001 diff --git a/attachment_pdfa/tests/fake_mail_message.py b/attachment_pdfa/tests/fake_mail_message.py new file mode 100644 index 0000000000..5b6ee19e82 --- /dev/null +++ b/attachment_pdfa/tests/fake_mail_message.py @@ -0,0 +1,12 @@ +# Copyright 2026 ACSONE SA/NV +# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl). + +from odoo import fields, models + + +class FakeMailMessage(models.Model): + _name = "mail.message" + _description = "Fake Mail Message for PDF/A Tests" + + model = fields.Char() + res_id = fields.Integer() diff --git a/attachment_pdfa/tests/pdfa_test_model.py b/attachment_pdfa/tests/pdfa_test_model.py new file mode 100644 index 0000000000..0dd10bae72 --- /dev/null +++ b/attachment_pdfa/tests/pdfa_test_model.py @@ -0,0 +1,15 @@ +# Copyright 2026 ACSONE SA/NV +# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl). + +from odoo import fields, models + + +class PdfaTestModel(models.Model): + _name = "pdfa.test.model" + _description = "PDF/A Test Model" + _inherit = ["attachment.pdfa.mixin"] + + must_convert = fields.Boolean(default=True) + + def _attachment_must_be_pdfa(self, attachment): + return self.must_convert diff --git a/attachment_pdfa/tests/test_attachment_pdfa.py b/attachment_pdfa/tests/test_attachment_pdfa.py new file mode 100644 index 0000000000..13ea05411f --- /dev/null +++ b/attachment_pdfa/tests/test_attachment_pdfa.py @@ -0,0 +1,564 @@ +# Copyright 2026 ACSONE SA/NV +# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl). + +import base64 +import io +import os + +from odoo_test_helper import FakeModelLoader + +from odoo.exceptions import UserError +from odoo.tests.common import TransactionCase +from odoo.tools import mute_logger +from odoo.tools.pdf import OdooPdfFileReader, OdooPdfFileWriter + +from odoo.addons.attachment_pdfa.models import ir_attachment + + +class TestIrAttachmentPdfa(TransactionCase): + def setUp(self): + super().setUp() + self.loader = FakeModelLoader(self.env, self.__module__) + self.loader.backup_registry() + from .fake_mail_message import FakeMailMessage + from .pdfa_test_model import PdfaTestModel + + # Load FakeMailMessage if mail module is not installed in the test env + fake_models = [PdfaTestModel] + if "mail.message" not in self.env: + fake_models.append(FakeMailMessage) + self.loader.update_registry(tuple(fake_models)) + self.test_record = self.env["pdfa.test.model"].create( + { + "must_convert": True, + } + ) + self.dir_path = os.path.dirname(os.path.realpath(__file__)) + self.dummy_pdf_path = os.path.join(self.dir_path, "dummy.pdf") + + def tearDown(self): + self.loader.restore_registry() + super().tearDown() + + def _get_dummy_pdf_without_outlines(self): + """Return dummy.pdf with the /Outlines entry removed.""" + reader = OdooPdfFileReader( + io.BytesIO(self._get_dummy_pdf_bytes()), strict=False + ) + writer = OdooPdfFileWriter() + writer.cloneReaderDocumentRoot(reader) + if "/Outlines" in writer._root_object: + del writer._root_object["/Outlines"] + buffer = io.BytesIO() + writer.write(buffer) + raw_pdf = buffer.getvalue() + # Sanity check: the fixture must really be free of outlines + check_reader = OdooPdfFileReader(io.BytesIO(raw_pdf), strict=False) + self.assertNotIn("/Outlines", check_reader.trailer["/Root"]) + return raw_pdf + + def _get_dummy_pdf_bytes(self): + with open(self.dummy_pdf_path, "rb") as pdf_file: + return pdf_file.read() + + def _set_conversion_method(self, method): + self.env["ir.config_parameter"].sudo().set_param( + "attachment_pdfa.method", method + ) + + def _set_storage_mode(self, mode): + self.env["ir.config_parameter"].sudo().set_param("attachment_pdfa.mode", mode) + + def test_convert_pdf_ghostscript(self): + """Test real conversion using Ghostscript engine via cron in replace mode.""" + self._set_conversion_method("ghostscript") + self._set_storage_mode("replace") + raw_pdf = self._get_dummy_pdf_bytes() + attachment = self.env["ir.attachment"].create( + { + "name": "dummy_gs.pdf", + "raw": raw_pdf, + "mimetype": "application/pdf", + "res_model": "pdfa.test.model", + "res_id": self.test_record.id, + } + ) + self.assertTrue(attachment.is_pdfa_needed) + self.assertEqual(attachment.raw, raw_pdf) + self.env["ir.attachment"]._cron_convert_pdfa() + self.assertFalse(attachment.is_pdfa_needed) + self.assertNotEqual(attachment.raw, raw_pdf) + self.assertTrue( + b"pdfaid" in attachment.raw or b"GTS_PDFA" in attachment.raw, + "Ghostscript output does not contain expected PDF/A metadata", + ) + + def test_mail_message_target_resolution(self): + """Test attachment linked to a mail.message pointing to a pdfa.test.model.""" + self._set_conversion_method("odoo") + message = self.env["mail.message"].create( + { + "model": "pdfa.test.model", + "res_id": self.test_record.id, + } + ) + raw_pdf = self._get_dummy_pdf_bytes() + attachment = self.env["ir.attachment"].create( + { + "name": "mail_document.pdf", + "raw": raw_pdf, + "mimetype": "application/pdf", + "res_model": "mail.message", + "res_id": message.id, + } + ) + self.assertTrue(attachment.is_pdfa_needed) + + @mute_logger("odoo.tools.pdf") + def test_convert_pdf_odoo_native(self): + """Test real conversion using Odoo native engine via cron in replace mode.""" + self._set_conversion_method("odoo") + self._set_storage_mode("replace") + raw_pdf = self._get_dummy_pdf_bytes() + attachment = self.env["ir.attachment"].create( + { + "name": "dummy_odoo.pdf", + "raw": raw_pdf, + "mimetype": "application/pdf", + "res_model": "pdfa.test.model", + "res_id": self.test_record.id, + } + ) + self.assertTrue(attachment.is_pdfa_needed) + self.assertEqual(attachment.raw, raw_pdf) + self.env["ir.attachment"]._cron_convert_pdfa() + self.assertFalse(attachment.is_pdfa_needed) + self.assertNotEqual(attachment.raw, raw_pdf) + self.assertIn( + b"3", + attachment.raw, + "Odoo native output does not contain PDF/A-3 XMP metadata", + ) + + @mute_logger("odoo.tools.pdf") + def test_storage_mode_beside(self): + """Test PDF/A conversion creating a new file beside original.""" + self._set_conversion_method("odoo") + self._set_storage_mode("beside") + raw_pdf = self._get_dummy_pdf_bytes() + attachment = self.env["ir.attachment"].create( + { + "name": "original_doc.pdf", + "raw": raw_pdf, + "mimetype": "application/pdf", + "res_model": "pdfa.test.model", + "res_id": self.test_record.id, + } + ) + self.assertTrue(attachment.is_pdfa_needed) + self.env["ir.attachment"]._cron_convert_pdfa() + # Original attachment remains unchanged and flag is cleared + self.assertFalse(attachment.is_pdfa_needed) + self.assertEqual(attachment.raw, raw_pdf) + # Verify new PDF/A attachment was created beside original + new_attachment = self.env["ir.attachment"].search( + [ + ("res_model", "=", "pdfa.test.model"), + ("res_id", "=", self.test_record.id), + ("id", "!=", attachment.id), + ] + ) + self.assertEqual(len(new_attachment), 1) + self.assertEqual(new_attachment.name, "original_doc_PDFA.pdf") + self.assertNotEqual(new_attachment.raw, raw_pdf) + self.assertIn(b"3", new_attachment.raw) + self.assertFalse(new_attachment.is_pdfa_needed) + + @mute_logger("odoo.tools.pdf") + def test_write_delayed_record_linking(self): + """Test recomputing is_pdfa_needed and converting when linked late via write.""" + self._set_conversion_method("odoo") + self._set_storage_mode("replace") + raw_pdf = self._get_dummy_pdf_bytes() + attachment = self.env["ir.attachment"].create( + { + "name": "unlinked.pdf", + "raw": raw_pdf, + "mimetype": "application/pdf", + } + ) + self.assertFalse(attachment.is_pdfa_needed) + # Link model and record via write + attachment.write( + { + "res_model": "pdfa.test.model", + "res_id": self.test_record.id, + } + ) + self.assertTrue(attachment.is_pdfa_needed) + self.env["ir.attachment"]._cron_convert_pdfa() + self.assertFalse(attachment.is_pdfa_needed) + self.assertNotEqual(attachment.raw, raw_pdf) + self.assertIn(b"3", attachment.raw) + + @mute_logger("odoo.tools.pdf") + def test_write_update_binary_content(self): + """Test manually re-flagging is_pdfa_needed on content update.""" + self._set_conversion_method("odoo") + self._set_storage_mode("replace") + raw_pdf = self._get_dummy_pdf_bytes() + attachment = self.env["ir.attachment"].create( + { + "name": "initial.pdf", + "raw": raw_pdf, + "mimetype": "application/pdf", + "res_model": "pdfa.test.model", + "res_id": self.test_record.id, + } + ) + self.env["ir.attachment"]._cron_convert_pdfa() + self.assertFalse(attachment.is_pdfa_needed) + # Update binary datas and set is_pdfa_needed manually (readonly=False) + encoded_datas = base64.b64encode(raw_pdf).decode("utf-8") + attachment.write({"datas": encoded_datas, "is_pdfa_needed": True}) + self.assertTrue(attachment.is_pdfa_needed) + self.env["ir.attachment"]._cron_convert_pdfa() + self.assertFalse(attachment.is_pdfa_needed) + self.assertIn(b"3", attachment.raw) + + @mute_logger("odoo.addons.attachment_pdfa.models.ir_attachment") + def test_conversion_failure_raises(self): + """Test that failure raises for a PDF that passes the header check + but is structurally corrupt (e.g. truncated), so it gets queued for + conversion and the actual parser fails on it.""" + self._set_conversion_method("odoo") + corrupt_pdf_raw = b"%PDF-1.7\n%\xe2\xe3\xcf\xd3\n1 0 obj\n<< /Type /Catalog" + attachment = self.env["ir.attachment"].create( + { + "name": "corrupt_document.pdf", + "raw": corrupt_pdf_raw, + "mimetype": "application/pdf", + "res_model": "pdfa.test.model", + "res_id": self.test_record.id, + } + ) + self.assertTrue(attachment.is_pdfa_needed) + with self.assertRaises(UserError): + self.env["ir.attachment"]._cron_convert_pdfa() + + def test_conversion_disabled(self): + """Test that method 'disable' leaves attachments untreated in cron.""" + self._set_conversion_method("disable") + raw_pdf = self._get_dummy_pdf_bytes() + attachment = self.env["ir.attachment"].create( + { + "name": "dummy_disabled.pdf", + "raw": raw_pdf, + "mimetype": "application/pdf", + "res_model": "pdfa.test.model", + "res_id": self.test_record.id, + } + ) + self.assertTrue(attachment.is_pdfa_needed) + self.env["ir.attachment"]._cron_convert_pdfa() + self.assertTrue(attachment.is_pdfa_needed) + self.assertEqual(attachment.raw, raw_pdf) + + def test_mixin_condition_false(self): + """Test that is_pdfa_needed computes to False when mixin returns False.""" + self._set_conversion_method("ghostscript") + self.test_record.must_convert = False + raw_pdf = self._get_dummy_pdf_bytes() + attachment = self.env["ir.attachment"].create( + { + "name": "dummy_skipped.pdf", + "raw": raw_pdf, + "mimetype": "application/pdf", + "res_model": "pdfa.test.model", + "res_id": self.test_record.id, + } + ) + self.assertFalse(attachment.is_pdfa_needed) + + def test_unsupported_model_ignored(self): + """Test that models without attachment.pdfa.mixin compute is_pdfa_needed as + False.""" + self._set_conversion_method("ghostscript") + raw_pdf = self._get_dummy_pdf_bytes() + attachment = self.env["ir.attachment"].create( + { + "name": "res_partner.pdf", + "raw": raw_pdf, + "mimetype": "application/pdf", + "res_model": "res.partner", + "res_id": self.env.user.partner_id.id, + } + ) + self.assertFalse(attachment.is_pdfa_needed) + + def test_non_pdf_attachment_ignored(self): + """Test non-PDF attachments compute is_pdfa_needed as False.""" + self._set_conversion_method("ghostscript") + image_raw = b"FAKE_PNG_DATA" + attachment = self.env["ir.attachment"].create( + { + "name": "test_image.png", + "raw": image_raw, + "mimetype": "image/png", + "res_model": "pdfa.test.model", + "res_id": self.test_record.id, + } + ) + self.assertFalse(attachment.is_pdfa_needed) + + def test_base_mixin_default_returns_false(self): + """Test default _attachment_must_be_pdfa implementation on base mixin.""" + attachment = self.env["ir.attachment"].create({"name": "test.pdf"}) + mixin_model = self.env["attachment.pdfa.mixin"] + self.assertFalse(mixin_model._attachment_must_be_pdfa(attachment)) + + def test_res_config_settings_integration(self): + """Test reading and saving conversion settings via res.config.settings.""" + config = self.env["res.config.settings"].create( + { + "attachment_pdfa_method": "odoo", + "attachment_pdfa_mode": "beside", + } + ) + config.execute() + self.assertEqual( + self.env["ir.config_parameter"].sudo().get_param("attachment_pdfa.method"), + "odoo", + ) + self.assertEqual( + self.env["ir.config_parameter"].sudo().get_param("attachment_pdfa.mode"), + "beside", + ) + + def test_already_pdfa3_ignored(self): + """Test that documents already tagged as PDF/A-3 are skipped.""" + self._set_conversion_method("odoo") + pdfa3_raw = b"%PDF-1.7\n3" + attachment = self.env["ir.attachment"].create( + { + "name": "already_pdfa3.pdf", + "raw": pdfa3_raw, + "mimetype": "application/pdf", + "res_model": "pdfa.test.model", + "res_id": self.test_record.id, + } + ) + self.assertFalse(attachment.is_pdfa_needed) + + def test_pdfa1_requires_conversion(self): + """Test that PDF/A-1 tagged files still require conversion to PDF/A-3.""" + self._set_conversion_method("odoo") + pdfa1_raw = b"%PDF-1.7\n1" + attachment = self.env["ir.attachment"].create( + { + "name": "pdfa1.pdf", + "raw": pdfa1_raw, + "mimetype": "application/pdf", + "res_model": "pdfa.test.model", + "res_id": self.test_record.id, + } + ) + self.assertTrue(attachment.is_pdfa_needed) + + def test_pdf_extension_fallback(self): + """Test detection when mimetype is generic but filename ends in .pdf.""" + self._set_conversion_method("odoo") + raw_pdf = self._get_dummy_pdf_bytes() + attachment = self.env["ir.attachment"].create( + { + "name": "document.pdf", + "raw": raw_pdf, + "mimetype": "application/octet-stream", + "res_model": "pdfa.test.model", + "res_id": self.test_record.id, + } + ) + self.assertTrue(attachment.is_pdfa_needed) + + def test_datas_field_fallback_and_decoding(self): + """Test fallback to 'datas' field and base64 cleaning logic.""" + raw_pdf = self._get_dummy_pdf_bytes() + encoded_pdf = base64.b64encode(raw_pdf).decode("utf-8") + attachment = self.env["ir.attachment"].create( + { + "name": "datas_fallback.pdf", + "datas": encoded_pdf, + "mimetype": "application/pdf", + "res_model": "pdfa.test.model", + "res_id": self.test_record.id, + } + ) + self.assertTrue(attachment.is_pdfa_needed) + cleaned_raw = attachment._get_clean_raw_pdf() + self.assertTrue(cleaned_raw.startswith(b"%PDF")) + + def test_invalid_base64_datas_fallback_graceful(self): + """Test graceful error handling when raw content contains invalid base64.""" + attachment = self.env["ir.attachment"].create( + { + "name": "corrupt_b64.pdf", + "raw": b"!!!NOT_BASE64!!!", + "mimetype": "application/pdf", + "res_model": "pdfa.test.model", + "res_id": self.test_record.id, + } + ) + self.assertEqual(attachment._get_clean_raw_pdf(), b"!!!NOT_BASE64!!!") + self.assertFalse(attachment.is_pdfa_needed) + + def test_missing_target_record_ignored(self): + """Test attachment with non-existent res_id computes is_pdfa_needed as False.""" + raw_pdf = self._get_dummy_pdf_bytes() + attachment = self.env["ir.attachment"].create( + { + "name": "non_existent_record.pdf", + "raw": raw_pdf, + "mimetype": "application/pdf", + "res_model": "pdfa.test.model", + "res_id": 999999, + } + ) + self.assertFalse(attachment.is_pdfa_needed) + + def test_mail_message_pointing_to_unsupported_model(self): + """Test mail.message pointing to a model without mixin computes as False.""" + message = self.env["mail.message"].create( + { + "model": "res.partner", + "res_id": self.env.user.partner_id.id, + } + ) + raw_pdf = self._get_dummy_pdf_bytes() + attachment = self.env["ir.attachment"].create( + { + "name": "mail_partner.pdf", + "raw": raw_pdf, + "mimetype": "application/pdf", + "res_model": "mail.message", + "res_id": message.id, + } + ) + self.assertFalse(attachment.is_pdfa_needed) + + def test_ghostscript_missing_profiles_failure(self): + """Test Ghostscript engine error handling when ICC profiles are unavailable.""" + self._set_conversion_method("ghostscript") + raw_pdf = self._get_dummy_pdf_bytes() + self.env["ir.attachment"].create( + { + "name": "dummy_gs_no_profile.pdf", + "raw": raw_pdf, + "mimetype": "application/pdf", + "res_model": "pdfa.test.model", + "res_id": self.test_record.id, + } + ) + orig_val = ir_attachment._PROFILES_AVAILABLE + try: + ir_attachment._PROFILES_AVAILABLE = False + with self.assertRaises(UserError): + self.env["ir.attachment"]._cron_convert_pdfa() + finally: + ir_attachment._PROFILES_AVAILABLE = orig_val + + @mute_logger("odoo.tools.pdf") + def test_cron_batching_and_retrigger(self): + """Test that cron schedules a trigger record when batch limit is reached.""" + self._set_conversion_method("odoo") + raw_pdf = self._get_dummy_pdf_bytes() + for i in range(2): + self.env["ir.attachment"].create( + { + "name": f"batch_{i}.pdf", + "raw": raw_pdf, + "mimetype": "application/pdf", + "res_model": "pdfa.test.model", + "res_id": self.test_record.id, + } + ) + cron = self.env.ref("attachment_pdfa.ir_cron_convert_pdfa") + triggers_before = self.env["ir.cron.trigger"].search_count( + [("cron_id", "=", cron.id)] + ) + self.env["ir.attachment"]._cron_convert_pdfa(batch_size=1) + triggers_after = self.env["ir.cron.trigger"].search_count( + [("cron_id", "=", cron.id)] + ) + self.assertGreater( + triggers_after, + triggers_before, + "Cron trigger record should be created when work remains.", + ) + + def test_can_commit_helper(self): + """Verify _can_commit returns False in test execution context.""" + self.assertFalse(self.env["ir.attachment"]._can_commit()) + + @mute_logger("odoo.tools.pdf") + def test_convert_pdf_odoo_native_without_outlines(self): + """PDF without bookmarks must be converted by the Odoo engine (replace).""" + self._set_conversion_method("odoo") + self._set_storage_mode("replace") + raw_pdf = self._get_dummy_pdf_without_outlines() + attachment = self.env["ir.attachment"].create( + { + "name": "no_outlines.pdf", + "raw": raw_pdf, + "mimetype": "application/pdf", + "res_model": "pdfa.test.model", + "res_id": self.test_record.id, + } + ) + self.assertTrue(attachment.is_pdfa_needed) + self.env["ir.attachment"]._cron_convert_pdfa() + self.assertFalse(attachment.is_pdfa_needed) + self.assertNotEqual(attachment.raw, raw_pdf) + self.assertIn(b"3", attachment.raw) + + @mute_logger("odoo.tools.pdf") + def test_storage_mode_beside_without_outlines(self): + """Same as above in 'beside' mode.""" + self._set_conversion_method("odoo") + self._set_storage_mode("beside") + raw_pdf = self._get_dummy_pdf_without_outlines() + attachment = self.env["ir.attachment"].create( + { + "name": "Bon de commande S00001.pdf", + "raw": raw_pdf, + "mimetype": "application/pdf", + "res_model": "pdfa.test.model", + "res_id": self.test_record.id, + } + ) + self.env["ir.attachment"]._cron_convert_pdfa() + self.assertFalse(attachment.is_pdfa_needed) + self.assertEqual(attachment.raw, raw_pdf) + new_attachment = self.env["ir.attachment"].search( + [ + ("res_model", "=", "pdfa.test.model"), + ("res_id", "=", self.test_record.id), + ("id", "!=", attachment.id), + ] + ) + self.assertEqual(len(new_attachment), 1) + self.assertEqual(new_attachment.name, "Bon de commande S00001_PDFA.pdf") + self.assertIn(b"3", new_attachment.raw) + + def test_ensure_pdf_outlines_is_idempotent(self): + """The helper adds /Outlines only when missing and never replaces it.""" + reader = OdooPdfFileReader( + io.BytesIO(self._get_dummy_pdf_without_outlines()), strict=False + ) + writer = OdooPdfFileWriter() + writer.cloneReaderDocumentRoot(reader) + self.assertNotIn("/Outlines", writer._root_object) + self.env["ir.attachment"]._ensure_pdf_outlines(writer) + self.assertIn("/Outlines", writer._root_object) + first = writer._root_object["/Outlines"] + self.env["ir.attachment"]._ensure_pdf_outlines(writer) + self.assertEqual(writer._root_object["/Outlines"], first) diff --git a/attachment_pdfa/views/res_config_settings.xml b/attachment_pdfa/views/res_config_settings.xml new file mode 100644 index 0000000000..fc657672d1 --- /dev/null +++ b/attachment_pdfa/views/res_config_settings.xml @@ -0,0 +1,31 @@ + + + + + res.config.settings.view.form.inherit.attachment.pdfa + res.config.settings + + + + + + + + + + + + + + +