[17.0][MIG] sign_oca: Migration to 17.0

sign_oca/README.rst

@@ -0,0 +1,174 @@
+========
+Sign Oca
+========
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:4cd44f4785da01198064822b367bcbe928fe915080976d5b1f5f2d8671812e51
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |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%2Fsign-lightgray.png?logo=github
+    :target: https://github.com/OCA/sign/tree/17.0/sign_oca
+    :alt: OCA/sign
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/sign-17-0/sign-17-0-sign_oca
+    :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/sign&target_branch=17.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+This module allows to create documents for signature inside Odoo using
+OWL.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Configuration
+=============
+
+There is a wizard (sign.oca.template.generate.multi) that can be used
+for any model needed. If there is a template without a linked model or
+linked to a model (res.partner for example) an action will be
+automatically displayed in the tree and form view (only for users with
+Sign permissions).
+
+Usage
+=====
+
+Creation of templates
+---------------------
+
+-  Access Sign / Templates
+-  Create a new template
+-  Add a PDF File
+-  Access the configuration menu
+-  You can add a field by doing a right click inside a page
+-  Click on the field in order to delete or edit some configuration of
+   it
+-  The template is autosaved
+
+Sign role
+---------
+
+-  Access Sign / Settings / Roles
+-  Create a new role (Equipment employee for example)
+-  You can set the Partner type you need (empty, default or expression).
+-  With the expression option you can set: ${object.field_name.id}
+-  If you create a sign request from template signer will be auto-create
+   according to roles
+
+Sign a document from template
+-----------------------------
+
+-  Access Sign / Templates
+-  Press the Sign button from a template
+-  Fill all the possible partners that will sign the document
+-  You can link the template to a model (maintenance.equipment for
+   example)
+-  The signature action will be opened.
+-  There, you can fill all the data you need.
+-  Once you finish, press the sign button on the top
+-  When the last signer signs it, the final file will be generated as a
+   PDF
+
+Sign a pending document
+-----------------------
+
+-  Go to the pencil icon in the upper right corner (systray) of the sign
+   request to access the pending signatures.
+-  Press the Sign button from signer request
+-  The signature action will be opened.
+-  There, you can fill all the data you need.
+-  Once you finish, press the sign button on the top
+-  When the last signer signs it, the final file will be generated as a
+   PDF
+
+Sign from template
+------------------
+
+-  Go to any list view or form view (except sign.oca models), e.g.:
+   Contacts
+-  Select multiple records (3 for example).
+-  The "Sign from template" action will be available if there are any
+   sign templates created that are not linked to any model and/or any
+   linked to the corresponding model.
+-  Select a template.
+-  Click on the "Generate" button.
+-  3 requests will be created (each linked to each selected record) BUT
+   no signer will be set.
+-  Some extra modules (e.g. maintenance_sign_oca) will automatically set
+   the signers for each request.
+
+Known issues / Roadmap
+======================
+
+Tasks
+-----
+
+-  Ensure that the signature is inalterable. Maybe we might need to use
+   some tools like endevise or pyHanko with a certificate. Signer can be
+   authenticated using OTP.
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/sign/issues>`_.
+In case of trouble, please check there if your issue has already been reported.
+If you spotted it first, help us to smash it by providing a detailed and welcomed
+`feedback <https://github.com/OCA/sign/issues/new?body=module:%20sign_oca%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+
+Do not contact contributors directly about support or help with technical issues.
+
+Credits
+=======
+
+Authors
+-------
+
+* Dixmit
+
+Contributors
+------------
+
+-  Enric Tobella (`www.dixmit.com <http://www.dixmit.com>`__)
+-  `Tecnativa <https://www.tecnativa.com>`__:
+
+   -  Víctor Martínez
+
+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.
+
+.. |maintainer-etobella| image:: https://github.com/etobella.png?size=40px
+    :target: https://github.com/etobella
+    :alt: etobella
+
+Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
+
+|maintainer-etobella| 
+
+This module is part of the `OCA/sign <https://github.com/OCA/sign/tree/17.0/sign_oca>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

sign_oca/__init__.py

@@ -0,0 +1,3 @@
+from . import controllers
+from . import models
+from . import wizards

sign_oca/__manifest__.py

@@ -0,0 +1,71 @@
+# Copyright 2023 Dixmit
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+
+{
+    "name": "Sign Oca",
+    "summary": """
+        Allow to sign documents inside Odoo CE""",
+    "version": "17.0.1.0.0",
+    "license": "AGPL-3",
+    "author": "Dixmit,Odoo Community Association (OCA)",
+    "website": "https://github.com/OCA/sign",
+    "depends": ["web_editor", "portal", "base_sparse_field"],
+    "data": [
+        "security/security.xml",
+        "views/menu.xml",
+        "data/data.xml",
+        "wizards/res_config_settings_views.xml",
+        "data/ir_sequence_data.xml",
+        "wizards/sign_oca_template_generate.xml",
+        "wizards/sign_oca_template_generate_multi.xml",
+        "views/res_partner_views.xml",
+        "views/sign_oca_request_log.xml",
+        "views/sign_oca_request.xml",
+        "security/ir.model.access.csv",
+        "views/sign_oca_field.xml",
+        "views/sign_oca_role.xml",
+        "views/sign_oca_template.xml",
+        "templates/assets.xml",
+    ],
+    "demo": [
+        "demo/sign_oca_template.xml",
+    ],
+    "assets": {
+        "web.assets_backend": [
+            "sign_oca/static/src/components/sign_oca_pdf_common/sign_oca_pdf_common.xml",
+            "sign_oca/static/src/components/sign_oca_configure/sign_oca_configure.xml",
+            "sign_oca/static/src/components/sign_oca_pdf/sign_oca_pdf.xml",
+            "sign_oca/static/src/elements/elements.xml",
+            "sign_oca/static/src/scss/sign_oca.scss",
+            "sign_oca/static/src/components/sign_oca_pdf_common/sign_oca_pdf_common.esm.js",
+            "sign_oca/static/src/components/sign_oca_configure/sign_oca_configure.esm.js",
+            "sign_oca/static/src/elements/text.esm.js",
+            "sign_oca/static/src/elements/signature.esm.js",
+            "sign_oca/static/src/elements/check.esm.js",
+            "sign_oca/static/src/components/sign_oca_pdf/sign_oca_pdf.esm.js",
+            "sign_oca/static/src/components/" "sign_oca/static/src/js/*.js",
+            "sign_oca/static/src/xml/*.xml",
+        ],
+        "web.assets_frontend": [
+            "sign_oca/static/src/components/sign_oca_pdf_common/sign_oca_pdf_common.xml",
+            "sign_oca/static/src/components/sign_oca_configure/sign_oca_configure.xml",
+            "sign_oca/static/src/components/sign_oca_pdf/sign_oca_pdf.xml",
+            "sign_oca/static/src/elements/elements.xml",
+            "sign_oca/static/src/scss/sign_oca.scss",
+            "sign_oca/static/src/components/sign_oca_pdf_common/sign_oca_pdf_common.esm.js",
+            "sign_oca/static/src/elements/text.esm.js",
+            "sign_oca/static/src/elements/signature.esm.js",
+            "sign_oca/static/src/elements/check.esm.js",
+            "sign_oca/static/src/components/sign_oca_pdf/sign_oca_pdf.esm.js",
+            "sign_oca/static/src/components/sign_oca_pdf_portal/sign_oca_pdf_portal.esm.js",
+            "sign_oca/static/src/components/sign_oca_pdf_portal/sign_oca_pdf_portal.xml",
+            "sign_oca/static/src/scss/portal.scss",
+            "sign_oca/static/src/xml/*.xml",
+        ],
+        "sign_oca.sign_assets": [
+            "sign_oca/static/src/scss/sign.scss",
+            "web/static/src/libs/fontawesome/css/font-awesome.css",
+        ],
+    },
+    "maintainers": ["etobella"],
+}

sign_oca/controllers/__init__.py

@@ -0,0 +1 @@
+from . import main

sign_oca/controllers/main.py

@@ -0,0 +1,111 @@
+from odoo import http
+from odoo.exceptions import AccessError, MissingError
+from odoo.http import request
+
+from odoo.addons.base.models.assetsbundle import AssetsBundle
+from odoo.addons.portal.controllers.portal import CustomerPortal
+
+
+class SignController(http.Controller):
+    @http.route("/sign_oca/get_assets.<any(css,js):ext>", type="http", auth="public")
+    def get_sign_resources(self, ext):
+        bundle = "sign_oca.sign_assets"
+        files, _ = request.env["ir.qweb"]._get_asset_content(bundle)
+        asset = AssetsBundle(bundle, files)
+        mock_attachment = getattr(asset, ext)()
+        if isinstance(
+            mock_attachment, list
+        ):  # suppose that CSS asset will not required to be split in pages
+            mock_attachment = mock_attachment[0]
+        stream = request.env["ir.binary"]._get_stream_from(mock_attachment)
+        response = stream.get_response()
+        return response
+
+
+class PortalSign(CustomerPortal):
+    @http.route(
+        ["/sign_oca/document/<int:signer_id>/<string:access_token>"],
+        type="http",
+        auth="public",
+        website=True,
+    )
+    def get_sign_oca_access(self, signer_id, access_token, **kwargs):
+        try:
+            signer_sudo = self._document_check_access(
+                "sign.oca.request.signer", signer_id, access_token
+            )
+        except (AccessError, MissingError):
+            return request.redirect("/my")
+        if signer_sudo.signed_on:
+            return request.render(
+                "sign_oca.portal_sign_document_signed",
+                {
+                    "signer": signer_sudo,
+                    "company": signer_sudo.request_id.company_id,
+                },
+            )
+        return request.render(
+            "sign_oca.portal_sign_document",
+            {
+                "doc": signer_sudo.request_id,
+                "partner": signer_sudo.partner_id,
+                "signer": signer_sudo,
+                "access_token": access_token,
+                "sign_oca_backend_info": {
+                    "access_token": access_token,
+                    "signer_id": signer_sudo.id,
+                    "lang": signer_sudo.partner_id.lang,
+                },
+            },
+        )
+
+    @http.route(
+        ["/sign_oca/content/<int:signer_id>/<string:access_token>"],
+        type="http",
+        auth="public",
+        website=True,
+    )
+    def get_sign_oca_content_access(self, signer_id, access_token):
+        try:
+            signer_sudo = self._document_check_access(
+                "sign.oca.request.signer", signer_id, access_token
+            )
+        except (AccessError, MissingError):
+            return request.redirect("/my")
+        return http.Stream.from_binary_field(
+            signer_sudo.request_id, "data"
+        ).get_response(mimetype="application/pdf")
+
+    @http.route(
+        ["/sign_oca/info/<int:signer_id>/<string:access_token>"],
+        type="json",
+        auth="public",
+        website=True,
+    )
+    def get_sign_oca_info_access(self, signer_id, access_token):
+        try:
+            signer_sudo = self._document_check_access(
+                "sign.oca.request.signer", signer_id, access_token
+            )
+        except (AccessError, MissingError):
+            return request.redirect("/my")
+        return signer_sudo.get_info(access_token=access_token)
+
+    @http.route(
+        ["/sign_oca/sign/<int:signer_id>/<string:access_token>"],
+        type="json",
+        auth="public",
+        website=True,
+    )
+    def get_sign_oca_sign_access(
+        self, signer_id, access_token, items, latitude=False, longitude=False
+    ):
+        try:
+            signer_sudo = self._document_check_access(
+                "sign.oca.request.signer", signer_id, access_token
+            )
+        except (AccessError, MissingError):
+            return request.redirect("/my")
+        return signer_sudo.action_sign(
+            items, access_token=access_token, latitude=latitude, longitude=longitude
+        )