[16.0][IMP] sign_oca: enable signing from portal

Author: kobros-tech

sign_oca/README.rst

@@ -1,7 +1,3 @@
-.. image:: https://odoo-community.org/readme-banner-image
-   :target: https://odoo-community.org/get-involved?utm_source=readme
-   :alt: Odoo Community Association
-
 ========
 Sign Oca
 ========
@@ -17,7 +13,7 @@ Sign Oca
 .. |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/license-AGPL--3-blue.png
+.. |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
@@ -115,6 +111,12 @@ Sign from template
 - Some extra modules (e.g. maintenance_sign_oca) will automatically set
   the signers for each request.
 
+Sign from portal
+----------------
+
+- customers who are using portal can sign their documents from portal
+  directly in addition to being able to sign them from emails.
+
 Known issues / Roadmap
 ======================
 

sign_oca/__manifest__.py

@@ -13,6 +13,8 @@
     "data": [
         "security/security.xml",
         "views/menu.xml",
+        "views/sign_portal_oca_templates.xml",
+        "views/portal_templates.xml",
         "data/data.xml",
         "wizards/res_config_settings_views.xml",
         "data/ir_sequence_data.xml",
@@ -66,6 +68,9 @@
             "sign_oca/static/src/scss/sign.scss",
             "web/static/src/libs/fontawesome/css/font-awesome.css",
         ],
+        "web.assets_tests": [
+            "sign_oca/static/src/tests/sign_tour.esm.js",
+        ],
     },
     "maintainers": ["etobella"],
 }

sign_oca/controllers/main.py

@@ -1,9 +1,13 @@
-from odoo import http
+from collections import OrderedDict
+from urllib import parse
+
+from odoo import _, http
 from odoo.exceptions import AccessError, MissingError
 from odoo.http import request
+from odoo.osv import expression
 
 from odoo.addons.base.models.assetsbundle import AssetsBundle
-from odoo.addons.portal.controllers.portal import CustomerPortal
+from odoo.addons.portal.controllers.portal import CustomerPortal, pager as portal_pager
 
 
 class SignController(http.Controller):
@@ -104,3 +108,121 @@ def get_sign_oca_sign_access(
         return signer_sudo.action_sign(
             items, access_token=access_token, latitude=latitude, longitude=longitude
         )
+
+    def get_sign_requests_domain(self, request):
+        domain = [
+            ("request_id.state", "in", ("0_sent", "2_signed")),
+            ("partner_id", "child_of", [request.env.user.partner_id.id]),
+        ]
+        return domain
+
+    def _get_my_sign_requests_searchbar_filters(self):
+        searchbar_filters = {
+            "all": {"label": _("All"), "domain": []},
+            "sent": {
+                "label": _("sent"),
+                "domain": [("request_id.state", "=", "0_sent")],
+            },
+            "signed": {
+                "label": _("Signed"),
+                "domain": [("request_id.state", "=", "2_signed")],
+            },
+        }
+        return searchbar_filters
+
+    def _prepare_sign_portal_rendering_values(self, page=1, sign_page=False, **kwargs):
+        # Sorting feature
+        searchbar_sortings = {
+            "state": {"label": _("Sent to Signed"), "order": "request_id"},
+            "reverse_state": {"label": _("Signed to Sent"), "order": "request_id desc"},
+            "date": {"label": _("Newest"), "order": "create_date desc"},
+            "reverse_date": {"label": _("Oldest"), "order": "create_date"},
+        }
+        sortby = kwargs.get("sortby", "state")
+        order = searchbar_sortings[sortby]["order"]
+        # Filtering feature
+        searchbar_filters = self._get_my_sign_requests_searchbar_filters()
+        filterby = kwargs.get("filterby") or "all"
+        domain = searchbar_filters.get(filterby, searchbar_filters["all"])["domain"]
+        domain = expression.AND([domain, self.get_sign_requests_domain(request)])
+        SignRequests = request.env["sign.oca.request.signer"].sudo()
+        pager_values = portal_pager(
+            url="/my/sign_requests",
+            total=SignRequests.search_count(domain),
+            page=page,
+            step=self._items_per_page,
+            url_args={},
+        )
+        sign_requests = SignRequests.search(
+            domain,
+            order=order,
+            limit=self._items_per_page,
+            offset=pager_values["offset"],
+        )
+        values = self._prepare_portal_layout_values()
+        values.update(
+            {
+                "sign_requests": sign_requests.sudo() if sign_page else SignRequests,
+                "page_name": "My Sign Requests",
+                "pager": pager_values,
+                "default_url": "/my/sign_requests",
+                "searchbar_sortings": searchbar_sortings,
+                "searchbar_filters": OrderedDict(sorted(searchbar_filters.items())),
+                "sortby": sortby,
+                "filterby": filterby,
+            }
+        )
+        return values
+
+    def _prepare_home_portal_values(self, counters):
+        values = super()._prepare_home_portal_values(counters)
+        if "sign_oca_count" in counters:
+            domain = self.get_sign_requests_domain(request)
+            SignRequests = request.env["sign.oca.request.signer"].sudo()
+            values["sign_oca_count"] = SignRequests.search_count(domain)
+        return values
+
+    @http.route(
+        ["/my/sign_requests", "/my/sign_requests/page/<int:page>"],
+        type="http",
+        auth="public",
+        website=True,
+    )
+    def sign_requests(self, **kwargs):
+        values = self._prepare_sign_portal_rendering_values(sign_page=True, **kwargs)
+        return request.render(
+            "sign_oca.sign_requests",
+            values,
+        )
+
+    @http.route(
+        ["/my/sign/<int:request_id>/download"], type="http", auth="user", website=True
+    )
+    def portal_download_signed(self, request_id, **kw):
+        sign_request = request.env["sign.oca.request"].sudo().browse(request_id)
+        if not sign_request.exists():
+            return request.not_found()
+        # find the signed document attachment
+        attachment = (
+            request.env["ir.attachment"]
+            .sudo()
+            .search(
+                [
+                    ("res_model", "=", "sign.oca.request"),
+                    ("res_id", "=", sign_request.id),
+                    ("res_field", "=", "data"),
+                ],
+                limit=1,
+            )
+        )
+        if not attachment:
+            return request.not_found()
+        ascii_filename = "document.pdf"
+        filename = sign_request.name or ascii_filename
+        # Ensure .pdf extension
+        if not filename.lower().endswith(".pdf"):
+            filename = f"{filename}.pdf"
+        utf8_filename = parse.quote(filename)
+        return request.redirect(
+            f"/web/content/{attachment.id}?download=true&filename={utf8_filename}"
+        )

sign_oca/readme/USAGE.md

@@ -55,3 +55,7 @@
   no signer will be set.
 - Some extra modules (e.g. maintenance_sign_oca) will automatically set
   the signers for each request.
+
+## Sign from portal
+- customers who are using portal can sign their documents from portal 
+  directly in addition to being able to sign them from emails.

sign_oca/static/description/index.html

@@ -3,7 +3,7 @@
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
 <meta name="generator" content="Docutils: https://docutils.sourceforge.io/" />
-<title>README.rst</title>
+<title>Sign Oca</title>
 <style type="text/css">
 
 /*
@@ -360,21 +360,16 @@
 </style>
 </head>
 <body>
-<div class="document">
+<div class="document" id="sign-oca">
+<h1 class="title">Sign Oca</h1>
 
-
-<a class="reference external image-reference" href="https://odoo-community.org/get-involved?utm_source=readme">
-<img alt="Odoo Community Association" src="https://odoo-community.org/readme-banner-image" />
-</a>
-<div class="section" id="sign-oca">
-<h1>Sign Oca</h1>
 <!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 !! This file is generated by oca-gen-addon-readme !!
 !! changes will be overwritten.                   !!
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 !! source digest: sha256:b17d01dcbe348901b5e778fda1c276bbd58e85a4a1c3f1cdffbb855ad51afe05
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
-<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/license-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/sign/tree/16.0/sign_oca"><img alt="OCA/sign" src="https://img.shields.io/badge/github-OCA%2Fsign-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/sign-16-0/sign-16-0-sign_oca"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/sign&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
+<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/sign/tree/16.0/sign_oca"><img alt="OCA/sign" src="https://img.shields.io/badge/github-OCA%2Fsign-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/sign-16-0/sign-16-0-sign_oca"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/sign&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
 <p>This module allows to create documents for signature inside Odoo using
 OWL.</p>
 <p><strong>Table of contents</strong></p>
@@ -387,33 +382,34 @@ <h1>Sign Oca</h1>
 <li><a class="reference internal" href="#sign-a-document-from-template" id="toc-entry-5">Sign a document from template</a></li>
 <li><a class="reference internal" href="#sign-a-pending-document" id="toc-entry-6">Sign a pending document</a></li>
 <li><a class="reference internal" href="#sign-from-template" id="toc-entry-7">Sign from template</a></li>
+<li><a class="reference internal" href="#sign-from-portal" id="toc-entry-8">Sign from portal</a></li>
 </ul>
 </li>
-<li><a class="reference internal" href="#known-issues-roadmap" id="toc-entry-8">Known issues / Roadmap</a><ul>
-<li><a class="reference internal" href="#tasks" id="toc-entry-9">Tasks</a></li>
+<li><a class="reference internal" href="#known-issues-roadmap" id="toc-entry-9">Known issues / Roadmap</a><ul>
+<li><a class="reference internal" href="#tasks" id="toc-entry-10">Tasks</a></li>
 </ul>
 </li>
-<li><a class="reference internal" href="#bug-tracker" id="toc-entry-10">Bug Tracker</a></li>
-<li><a class="reference internal" href="#credits" id="toc-entry-11">Credits</a><ul>
-<li><a class="reference internal" href="#authors" id="toc-entry-12">Authors</a></li>
-<li><a class="reference internal" href="#contributors" id="toc-entry-13">Contributors</a></li>
-<li><a class="reference internal" href="#maintainers" id="toc-entry-14">Maintainers</a></li>
+<li><a class="reference internal" href="#bug-tracker" id="toc-entry-11">Bug Tracker</a></li>
+<li><a class="reference internal" href="#credits" id="toc-entry-12">Credits</a><ul>
+<li><a class="reference internal" href="#authors" id="toc-entry-13">Authors</a></li>
+<li><a class="reference internal" href="#contributors" id="toc-entry-14">Contributors</a></li>
+<li><a class="reference internal" href="#maintainers" id="toc-entry-15">Maintainers</a></li>
 </ul>
 </li>
 </ul>
 </div>
 <div class="section" id="configuration">
-<h2><a class="toc-backref" href="#toc-entry-1">Configuration</a></h2>
+<h1><a class="toc-backref" href="#toc-entry-1">Configuration</a></h1>
 <p>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).</p>
 </div>
 <div class="section" id="usage">
-<h2><a class="toc-backref" href="#toc-entry-2">Usage</a></h2>
+<h1><a class="toc-backref" href="#toc-entry-2">Usage</a></h1>
 <div class="section" id="creation-of-templates">
-<h3><a class="toc-backref" href="#toc-entry-3">Creation of templates</a></h3>
+<h2><a class="toc-backref" href="#toc-entry-3">Creation of templates</a></h2>
 <ul class="simple">
 <li>Access Sign / Templates</li>
 <li>Create a new template</li>
@@ -425,7 +421,7 @@ <h3><a class="toc-backref" href="#toc-entry-3">Creation of templates</a></h3>
 </ul>
 </div>
 <div class="section" id="sign-role">
-<h3><a class="toc-backref" href="#toc-entry-4">Sign role</a></h3>
+<h2><a class="toc-backref" href="#toc-entry-4">Sign role</a></h2>
 <ul class="simple">
 <li>Access Sign / Settings / Roles</li>
 <li>Create a new role (Equipment employee for example)</li>
@@ -436,7 +432,7 @@ <h3><a class="toc-backref" href="#toc-entry-4">Sign role</a></h3>
 </ul>
 </div>
 <div class="section" id="sign-a-document-from-template">
-<h3><a class="toc-backref" href="#toc-entry-5">Sign a document from template</a></h3>
+<h2><a class="toc-backref" href="#toc-entry-5">Sign a document from template</a></h2>
 <ul class="simple">
 <li>Access Sign / Templates</li>
 <li>Press the Sign button from a template</li>
@@ -451,7 +447,7 @@ <h3><a class="toc-backref" href="#toc-entry-5">Sign a document from template</a>
 </ul>
 </div>
 <div class="section" id="sign-a-pending-document">
-<h3><a class="toc-backref" href="#toc-entry-6">Sign a pending document</a></h3>
+<h2><a class="toc-backref" href="#toc-entry-6">Sign a pending document</a></h2>
 <ul class="simple">
 <li>Go to the pencil icon in the upper right corner (systray) of the sign
 request to access the pending signatures.</li>
@@ -464,7 +460,7 @@ <h3><a class="toc-backref" href="#toc-entry-6">Sign a pending document</a></h3>
 </ul>
 </div>
 <div class="section" id="sign-from-template">
-<h3><a class="toc-backref" href="#toc-entry-7">Sign from template</a></h3>
+<h2><a class="toc-backref" href="#toc-entry-7">Sign from template</a></h2>
 <ul class="simple">
 <li>Go to any list view or form view (except sign.oca models), e.g.:
 Contacts</li>
@@ -480,11 +476,18 @@ <h3><a class="toc-backref" href="#toc-entry-7">Sign from template</a></h3>
 the signers for each request.</li>
 </ul>
 </div>
+<div class="section" id="sign-from-portal">
+<h2><a class="toc-backref" href="#toc-entry-8">Sign from portal</a></h2>
+<ul class="simple">
+<li>customers who are using portal can sign their documents from portal
+directly in addition to being able to sign them from emails.</li>
+</ul>
+</div>
 </div>
 <div class="section" id="known-issues-roadmap">
-<h2><a class="toc-backref" href="#toc-entry-8">Known issues / Roadmap</a></h2>
+<h1><a class="toc-backref" href="#toc-entry-9">Known issues / Roadmap</a></h1>
 <div class="section" id="tasks">
-<h3><a class="toc-backref" href="#toc-entry-9">Tasks</a></h3>
+<h2><a class="toc-backref" href="#toc-entry-10">Tasks</a></h2>
 <ul class="simple">
 <li>Ensure that the signature is inalterable. Maybe we might need to use
 some tools like endevise or pyHanko with a certificate. Signer can be
@@ -493,23 +496,23 @@ <h3><a class="toc-backref" href="#toc-entry-9">Tasks</a></h3>
 </div>
 </div>
 <div class="section" id="bug-tracker">
-<h2><a class="toc-backref" href="#toc-entry-10">Bug Tracker</a></h2>
+<h1><a class="toc-backref" href="#toc-entry-11">Bug Tracker</a></h1>
 <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/sign/issues">GitHub Issues</a>.
 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
 <a class="reference external" href="https://github.com/OCA/sign/issues/new?body=module:%20sign_oca%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
 <p>Do not contact contributors directly about support or help with technical issues.</p>
 </div>
 <div class="section" id="credits">
-<h2><a class="toc-backref" href="#toc-entry-11">Credits</a></h2>
+<h1><a class="toc-backref" href="#toc-entry-12">Credits</a></h1>
 <div class="section" id="authors">
-<h3><a class="toc-backref" href="#toc-entry-12">Authors</a></h3>
+<h2><a class="toc-backref" href="#toc-entry-13">Authors</a></h2>
 <ul class="simple">
 <li>Dixmit</li>
 </ul>
 </div>
 <div class="section" id="contributors">
-<h3><a class="toc-backref" href="#toc-entry-13">Contributors</a></h3>
+<h2><a class="toc-backref" href="#toc-entry-14">Contributors</a></h2>
 <ul class="simple">
 <li>Enric Tobella (<a class="reference external" href="http://www.dixmit.com">www.dixmit.com</a>)</li>
 <li><a class="reference external" href="https://www.tecnativa.com">Tecnativa</a>:<ul>
@@ -523,7 +526,7 @@ <h3><a class="toc-backref" href="#toc-entry-13">Contributors</a></h3>
 </ul>
 </div>
 <div class="section" id="maintainers">
-<h3><a class="toc-backref" href="#toc-entry-14">Maintainers</a></h3>
+<h2><a class="toc-backref" href="#toc-entry-15">Maintainers</a></h2>
 <p>This module is maintained by the OCA.</p>
 <a class="reference external image-reference" href="https://odoo-community.org">
 <img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" />
@@ -538,6 +541,5 @@ <h3><a class="toc-backref" href="#toc-entry-14">Maintainers</a></h3>
 </div>
 </div>
 </div>
-</div>
 </body>
 </html>