Added download QR code page to docx and pdf files to be signed

Author: chris-adam

CHANGES.rst

@@ -48,6 +48,8 @@ Changelog
   [chris-adam]
 - Replaced default actions bar by actionspanel for iconified categories.
   [chris-adam]
+- Added download QR code page to docx and pdf files to be signed.
+  [chris-adam]
 
 3.0 (2021-09-30)
 ----------------

imio/dms/mail/adapters.py

@@ -16,9 +16,11 @@
 from collective.dms.scanbehavior.behaviors.behaviors import IScanFields
 from collective.documentgenerator import _ as _dg
 from collective.documentgenerator.utils import convert_and_save_file
+from collective.documentgenerator.utils import convert_odt
 from collective.documentgenerator.utils import get_original_template
 from collective.documentgenerator.utils import odfsplit
 from collective.documentgenerator.utils import update_dict_with_validation
+from collective.documentviewer.convert import Converter
 from collective.iconifiedcategory.adapter import CategorizedObjectInfoAdapter
 from collective.iconifiedcategory.utils import get_category_object
 from collective.iconifiedcategory.utils import update_categorized_elements
@@ -50,6 +52,7 @@
 from imio.helpers.content import uuidToCatalogBrain
 from imio.helpers.content import uuidToObject
 from imio.helpers.emailer import validate_email_address
+from imio.helpers.pdf import merge_pdf
 from imio.helpers.workflow import do_transitions
 from imio.pm.wsclient.interfaces import ISendableAnnexesToPM
 from imio.prettylink.adapters import PrettyLinkAdapter
@@ -61,6 +64,7 @@
 from plone.app.contentmenu.menu import FactoriesSubMenuItem as OrigFactoriesSubMenuItem
 from plone.app.contentmenu.menu import WorkflowMenu as OrigWorkflowMenu
 from plone.app.contenttypes.indexers import _unicode_save_string_concat
+from plone.dexterity.utils import createContentInContainer
 from plone.indexer import indexer
 from plone.namedfile.file import NamedBlobFile
 from plone.registry.interfaces import IRegistry
@@ -1617,8 +1621,11 @@ def approve_file(self, afile, userid, values=None, transition=None, c_a=None):
                 message=_(
                     u"The file '${file}' has been approved by ${user}. However, there is/are yet ${nb} files "
                     u"to approve on this mail.",
-                    mapping={"file": safe_unicode(afile.Title()), "user": safe_unicode(fullname),
-                             "nb": len(yet_to_approve)},
+                    mapping={
+                        "file": safe_unicode(afile.Title()),
+                        "user": safe_unicode(fullname),
+                        "nb": len(yet_to_approve),
+                    },
                 ),
                 request=request,
                 type="info",
@@ -1635,8 +1642,10 @@ def approve_file(self, afile, userid, values=None, transition=None, c_a=None):
             self.context.reindexObjectSecurity()  # to update local roles from adapter
             message += u"Next approval number is ${nb}."
             api.portal.show_message(
-                message=_(message, mapping={"file": safe_unicode(afile.Title()), "user": safe_unicode(fullname),
-                                            "nb": c_a + 1}),
+                message=_(
+                    message,
+                    mapping={"file": safe_unicode(afile.Title()), "user": safe_unicode(fullname), "nb": c_a + 1},
+                ),
                 request=request,
                 type="info",
             )
@@ -1714,6 +1723,37 @@ def unapprove_file(self, afile, signer_userid):
 
         self.start_approval_process()
 
+    def _render_download_template_to_pdf(self, uid):
+        """Render the download subtemplate (QR code page) to PDF bytes.
+
+        :param download_template: the POD template object to render
+        :param download_url: the URL to encode in the QR/barcode
+        :return: PDF bytes, or empty string on failure
+        """
+        try:
+            download_template = api.portal.get().templates.om.get("download_barcode")
+            download_url, _short_uid = get_file_download_url(uid, short_uid=get_suid_from_uuid(uid))
+            helper_view = getMultiAdapter(
+                (self.context, self.context.REQUEST),
+                name="document_generation_helper_view",
+            )
+            helper_view.pod_template = download_template.UID()
+            helper_view.output_format = "pdf"
+            gen_context = {
+                "context": self.context,
+                "portal": api.portal.get(),
+                "view": helper_view,
+                "download_barcode": generate_barcode(download_url).read(),
+                "download_url": download_url,
+                "max_download_date": get_max_download_date(None, adate=datetime.date.today()),
+                "render_download_barcode": True,
+            }
+            template_file = NamedBlobFile(download_template.get_file().data, filename=u"download_template.odt")
+            return convert_odt(template_file, fmt="pdf", gen_context=gen_context)
+        except Exception as e:
+            logger.exception("Could not render download template to PDF")
+            return ""
+
     def _create_pdf_file(self, orig_fobj, nbf, f_title, f_uid, file_index, session_file_uids):
         """Create a pdf version file.
 
@@ -1725,33 +1765,75 @@ def _create_pdf_file(self, orig_fobj, nbf, f_title, f_uid, file_index, session_f
         :param session_file_uids: list to append created pdf file uids
         :return: created pdf file object
         """
-        new_filename = u"{}.pdf".format(f_title)
+
+        def update_esign_attributes(pdf_file, orig_fobj):
+            """Set required attributes on a newly created PDF file object."""
+            pdf_file.to_sign = True
+            pdf_file.to_approve = False
+            pdf_file.approved = orig_fobj.approved
+            update_categorized_elements(
+                self.context,
+                pdf_file,
+                get_category_object(self.context, pdf_file.content_category),
+                limited=True,
+                sort=False,
+                logging=True,
+            )
+
+        new_filename = "{}.pdf".format(f_title)
         if nbf.contentType == "application/pdf":
             pdf_file = orig_fobj
+            new_uid = uuid.uuid4().hex
+            download_page = self._render_download_template_to_pdf(new_uid)
+            if download_page:
+                merged = merge_pdf(nbf.data, download_page)
+                file_object = NamedBlobFile(merged, filename=safe_unicode(new_filename))
+                pdf_file = createContentInContainer(
+                    self.context,
+                    orig_fobj.portal_type,
+                    title=safe_unicode(new_filename),
+                    file=file_object,
+                    content_category=orig_fobj.content_category,
+                    scan_id=orig_fobj.scan_id,
+                    conv_from_uid=f_uid,
+                    **{"_plone.uuid": new_uid}
+                )
+                annot = IAnnotations(pdf_file)
+                annot["documentgenerator"] = {"conv_from_uid": f_uid}
+                update_esign_attributes(pdf_file, orig_fobj)
         elif nbf.contentType in get_allowed_omf_content_types(esign=True):
             gen_context = {}
             new_uid = uuid.uuid4().hex
-            download_url, s_uid = get_file_download_url(new_uid, short_uid=get_suid_from_uuid(new_uid))
+            download_url, _s_uid = get_file_download_url(new_uid, short_uid=get_suid_from_uuid(new_uid))
             orig_template = get_original_template(orig_fobj)
+            doc_cb_download_added = False
             if orig_template and nbf.contentType == "application/vnd.oasis.opendocument.text":  # own document
-                helper_view = getMultiAdapter((self.context, self.context.REQUEST),
-                                              name='document_generation_helper_view')
+                helper_view = getMultiAdapter(
+                    (self.context, self.context.REQUEST), name="document_generation_helper_view"
+                )
                 helper_view.pod_template = orig_template.UID()
                 helper_view.output_format = "pdf"
                 gen_context = {"context": self.context, "portal": api.portal.get(), "view": helper_view}
                 # update_dict_with_validation(gen_context, self._get_context_variables(pod_template),
                 #                                   _("Error when merging context_variables in generation context"))
-                merge_templates = [dic["template"] for dic in orig_template.merge_templates
-                                   if dic["pod_context_name"] == "doc_cb_download"]
+                merge_templates = [
+                    dic["template"]
+                    for dic in orig_template.merge_templates
+                    if dic["pod_context_name"] == "doc_cb_download"
+                ]
                 if merge_templates:
                     download_template = uuidToObject(merge_templates[0])
                     if download_template:
                         gen_context["doc_cb_download"] = download_template
+                        doc_cb_download_added = True
                 update_dict_with_validation(
                     gen_context,
-                    {"download_barcode": generate_barcode(download_url).read(), "download_url": download_url,
-                     "max_download_date": get_max_download_date(None, adate=datetime.date.today()),
-                     "render_download_barcode": True},
+                    {
+                        "download_barcode": generate_barcode(download_url).read(),
+                        "download_url": download_url,
+                        "max_download_date": get_max_download_date(None, adate=datetime.date.today()),
+                        "render_download_barcode": True,
+                    },
                     _dg("Error when merging 'download_barcode' in generation context"),
                 )
 
@@ -1772,25 +1854,22 @@ def _create_pdf_file(self, orig_fobj, nbf, f_title, f_uid, file_index, session_f
                 gen_context=gen_context,
             )
             # we must set attribute after creation
-            pdf_file.to_sign = True
-            pdf_file.to_approve = False
-            pdf_file.approved = orig_fobj.approved
-            update_categorized_elements(
-                self.context,
-                pdf_file,
-                get_category_object(self.context, pdf_file.content_category),
-                limited=True,
-                sort=False,
-                logging=True,
-            )
+            update_esign_attributes(pdf_file, orig_fobj)
+
+            # For non-ODT files (e.g. DOC, DOCX), the subtemplate cannot be merged during conversion.
+            # Render it to PDF separately and append it to the converted PDF.
+            if not doc_cb_download_added:
+                download_page = self._render_download_template_to_pdf(new_uid)
+                if download_page:
+                    merged = merge_pdf(pdf_file.file.data, download_page)
+                    pdf_file.file = NamedBlobFile(merged, filename=pdf_file.file.filename)
+                    Converter(pdf_file)()  # Refresh pdf preview
         else:
-            raise NotImplementedError(
-                "Cannot convert file of type '{}' to pdf for signing.".format(nbf.contentType)
-            )
+            raise NotImplementedError("Cannot convert file of type '{}' to pdf for signing.".format(nbf.contentType))
         pdf_uid = pdf_file.UID()
         self.pdf_files_uids[file_index].append(pdf_uid)
         # we rename the pdf filename to include pdf uid. So after the file is later consumed, we can retrieve object
-        pdf_file.file.filename = u"{}__{}.pdf".format(f_title, pdf_uid)
+        pdf_file.file.filename = "{}__{}.pdf".format(f_title, pdf_uid)
         session_file_uids.append(pdf_uid)
 
     def add_mail_files_to_session(self):
@@ -1856,21 +1935,28 @@ def add_mail_files_to_session(self):
             signers.append((signer, email, name, label))
         watcher_users = api.user.get_users(groupname="esign_watchers")
         watcher_emails = [user.getProperty("email") for user in watcher_users]
-        session_id, session = add_files_to_session(signers, session_file_uids, bool(self.context.seal),
-                                                   title=_("[ia.docs] Session {sign_id}"),
-                                                   watchers=watcher_emails)
+        session_id, _session = add_files_to_session(
+            signers,
+            session_file_uids,
+            bool(self.context.seal),
+            title=_("[ia.docs] Session {sign_id}"),
+            watchers=watcher_emails,
+        )
         self.annot["session_id"] = session_id
         session_len = len(session_file_uids)
         if session_len > 1:
-            return True, _("${count} files added to session number ${session_id}",
-                           mapping={"count": session_len, "session_id": session_id})
+            return True, _(
+                "${count} files added to session number ${session_id}",
+                mapping={"count": session_len, "session_id": session_id},
+            )
         else:
-            return True, _("${count} file added to session number ${session_id}",
-                           mapping={"count": session_len, "session_id": session_id})
+            return True, _(
+                "${count} file added to session number ${session_id}",
+                mapping={"count": session_len, "session_id": session_id},
+            )
 
 
 class DmsCategorizedObjectInfoAdapter(CategorizedObjectInfoAdapter):
-
     def get_infos(self, category, limited=False):
         base_infos = super(DmsCategorizedObjectInfoAdapter, self).get_infos(category, limited=limited)
         base_infos["scan_id"] = getattr(self.obj, "scan_id", None)