[10.0][MIG] report_qweb_signer

report_qweb_signer/README.rst

@@ -0,0 +1,117 @@
+.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
+    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
+    :alt: License: AGPL-3
+
+=======================
+Qweb PDF reports signer
+=======================
+
+This module extends the functionality of report module to sign
+PDFs using a PKCS#12 certificate.
+
+
+Installation
+============
+
+To install this module, you need to install Java JDK::
+
+  apt-get install openjdk-7-jre-headless
+
+
+Configuration
+=============
+
+In order to start signing PDF documents you need to configure certificate(s)
+to use in your company.
+
+* Go to ``Settings > Companies > Companies > Your company``
+* Go to ``Report configuration`` tab
+* Click ``Edit``
+* Add a new item in ``PDF report certificates`` list
+* Click ``Create``
+* Set name, certificate file, password file and model
+* Optionally you can set a domain and filename pattern for saving as attachment
+
+For example, if you want to sign only customer invoices in open or paid state:
+
+* Model: ``account.invoice``
+* Domain: ``[('type','=','out_invoice'), ('state', 'in', ('open', 'paid'))]``
+* Save as attachment: ``(object.number or '').replace('/','_') + '.signed.pdf'``
+
+**Note**: Linux user that executes Odoo server process must have
+read access to certificate file and password file
+
+
+Usage
+=====
+
+User just prints PDF documents (only Qweb PDF reports supported) as usual,
+but signed PDF is automatically downloaded if this document model is configured
+as indicated above.
+
+If 'Save as attachment' is configured, signed PDF is saved as attachment and
+next time saved one is downloaded without signing again. This is appropiate
+when signing date is important, for example, when signing customer invoices.
+
+You can try the signing with the demo report that is included for customers
+called "Test PDF certificate".
+
+.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
+   :alt: Try me on Runbot
+   :target: https://runbot.odoo-community.org/runbot/143/10.0
+
+Known issues / Roadmap
+======================
+
+* When signing multiple documents (if 'Allow only one document' is disable)
+  then 'Save as attachment' is not applied and signed result is not
+  saved as attachment.
+* To have a visible signature through an image embedded in the resulting PDF.
+* Add tests.
+
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/reporting-engine/issues>`_.
+In case of trouble, please check there if your issue has already been reported.
+If you spotted it first, help us smashing it by providing a detailed and
+welcomed feedback `here <https://github.com/OCA/reporting-engine/issues/new>`_.
+
+
+Credits
+=======
+
+External utilities
+------------------
+
+* iText v1.4.8: © 2000-2006, Paulo Soares, Bruno Lowagie and others - License `MPL <http://www.mozilla.org/MPL>`_ or `LGPL2 <http://www.gnu.org/licenses/old-licenses/lgpl-2.0.html>`_ - http://sourceforge.net/projects/itext
+* jPdfSign: © 2006 Jan Peter Stotz - License `MPL <http://www.mozilla.org/MPL>`_ or `LGPL2 <http://www.gnu.org/licenses/old-licenses/lgpl-2.0.html>`_ (inherited from iText) - http://private.sit.fraunhofer.de/~stotz/software/jpdfsign
+* Modified jPdfSign: © 2015 Antonio Espinosa - License `MPL <http://www.mozilla.org/MPL>`_ or `LGPL2 <http://www.gnu.org/licenses/old-licenses/lgpl-2.0.html>`_ (inherited from iText) - static/src/java/JPdfSign.java
+
+Icon
+----
+
+`Created by Anton Noskov from the Noun Project <https://thenounproject.com/search/?q=signed+contract&i=65694>`_
+
+Contributors
+------------
+
+* Rafael Blasco <rafael.blasco@tecnativa.com>
+* Antonio Espinosa <antonio.espinosa@tecnativa.com>
+* Pedro M. Baeza <pedro.baeza@tecnativa.com>
+
+Maintainer
+----------
+
+.. image:: https://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: https://odoo-community.org
+
+This module is maintained by the OCA.
+
+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.
+
+To contribute to this module, please visit https://odoo-community.org.

report_qweb_signer/__init__.py

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
+
+from . import models

report_qweb_signer/__manifest__.py

@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+# Copyright 2015 Tecnativa - Antonio Espinosa
+# Copyright 2017 Tecnativa - Pedro M. Baeza
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
+
+{
+    "name": "Qweb PDF reports signer",
+    "summary": "Sign Qweb PDFs usign a PKCS#12 certificate",
+    "version": "10.0.1.0.0",
+    "category": "Reporting",
+    "website": "https://www.tecnativa.com",
+    "author": "Tecnativa, "
+              "Odoo Community Association (OCA)",
+    "license": "AGPL-3",
+    "installable": True,
+    "depends": [
+        "report",
+    ],
+    "external_dependencies": {
+        "bin": ['/usr/bin/java'],
+    },
+    "data": [
+        "security/ir.model.access.csv",
+        "views/report_certificate_view.xml",
+        "views/res_company_view.xml",
+    ],
+    "demo": [
+        "demo/report_partner_demo.xml",
+        "demo/report_certificate_demo.xml",
+    ],
+}

report_qweb_signer/demo/report_certificate_demo.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+Copyright 2015 Tecnativa - Antonio Espinosa
+Copyright 2017 Tecnativa - Pedro M. Baeza
+License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
+-->
+<odoo noupdate="1">
+
+    <record id="demo_certificate_test" model="report.certificate">
+        <field name="company_id" ref="base.main_company"/>
+        <field name="name">Test OCA certificate</field>
+        <field name="path">test.p12</field>
+        <field name="password_file">test.passwd</field>
+        <field name="model_id" ref="base.model_res_partner"/>
+        <field name="domain">[('customer', '=', True)]</field>
+        <field name="allow_only_one" eval="True"/>
+        <field name="attachment">'test_' + (object.name or '').replace(' ', '_').lower() + '.signed.pdf'</field>
+    </record>
+
+</odoo>

report_qweb_signer/demo/report_partner_demo.xml

@@ -0,0 +1,45 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+Copyright 2015 Tecnativa - Antonio Espinosa
+Copyright 2017 Tecnativa - Pedro M. Baeza
+License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
+-->
+<odoo>
+
+    <template id="report_partner_demo_document">
+        <t t-call="report.external_layout">
+            <div class="page">
+                <div class="row">
+                    <div class="col-md-12">
+                        <span>This is a sample report for testing PDF certificates.</span>
+                    </div>
+                </div>
+                <div class="row">
+                    <div class="col-md-12">
+                        <strong>Partner:</strong> <span t-field="o.name"/>
+                    </div>
+                </div>
+            </div>
+        </t>
+    </template>
+
+    <template id="report_partner_demo">
+        <t t-call="report.html_container">
+            <t t-foreach="docs" t-as="o">
+                <t t-call="report_qweb_signer.report_partner_demo_document" t-lang="o.lang"/>
+            </t>
+        </t>
+    </template>
+
+    <report
+            id="partner_demo_report"
+            model="res.partner"
+            string="Test PDF certificate"
+            report_type="qweb-pdf"
+            name="report_qweb_signer.report_partner_demo"
+            file="report_qweb_signer.report_partner_demo"
+            attachment_use="True"
+            attachment="'test_' + (object.name or '').replace(' ', '_').lower() + '.pdf'"
+    />
+
+</odoo>