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,31 @@ def unapprove_file(self, afile, signer_userid):
 
         self.start_approval_process()
 
+    def _render_download_template_to_pdf(self, download_template, download_url):
+        """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
+        """
+        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)
+
     def _create_pdf_file(self, orig_fobj, nbf, f_title, f_uid, file_index, session_file_uids):
         """Create a pdf version file.
 
@@ -1728,32 +1762,72 @@ def _create_pdf_file(self, orig_fobj, nbf, f_title, f_uid, file_index, session_f
         new_filename = u"{}.pdf".format(f_title)
         if nbf.contentType == "application/pdf":
             pdf_file = orig_fobj
+            download_template = api.portal.get().templates.om.get("download_barcode")
+            if download_template:
+                new_uid = uuid.uuid4().hex
+                dl_url, _ = get_file_download_url(new_uid, short_uid=get_suid_from_uuid(new_uid))
+                sub_pdf_data = self._render_download_template_to_pdf(download_template, dl_url)
+                if sub_pdf_data:
+                    merged = merge_pdf(nbf.data, sub_pdf_data)
+                    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}
+                    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,
+                    )
         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))
             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
                 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"),
                 )
+                doc_cb_download_added = True
 
             # TODO which pdf format to choose ?
             pdf_file = convert_and_save_file(
@@ -1783,10 +1857,19 @@ def _create_pdf_file(self, orig_fobj, nbf, f_title, f_uid, file_index, session_f
                 sort=False,
                 logging=True,
             )
+
+            # 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_template = api.portal.get().templates.om.get("download_barcode")
+                if download_template:
+                    sub_pdf_data = self._render_download_template_to_pdf(download_template, download_url)
+                    if sub_pdf_data:
+                        merged = merge_pdf(pdf_file.file.data, sub_pdf_data)
+                        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
@@ -1856,21 +1939,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)

imio/dms/mail/tests/test_adapters.py

@@ -34,10 +34,13 @@
 from imio.esign.config import set_registry_file_url
 from imio.esign.utils import get_session_annotation
 from imio.helpers.test_helpers import ImioTestHelpers
+from mock import Mock
+from mock import patch
 from plone import api
 from plone.dexterity.utils import createContentInContainer
 from plone.namedfile.file import NamedBlobFile
 from plone.registry.interfaces import IRegistry
+from Products.CMFCore.utils import getToolByName
 from z3c.relationfield.relation import RelationValue
 from zope.component import getUtility
 from zope.intid.interfaces import IIntIds
@@ -1506,3 +1509,139 @@ def test_add_mail_files_to_session(self):
                 "c_uids": {self.omail.UID(): [pdf_file.UID()]},
             },
         )
+
+    def test_render_download_template_to_pdf(self):
+        """_render_download_template_to_pdf builds the gen_context and delegates to convert_odt."""
+        fake_pdf_bytes = b"%PDF-1.4 fake"
+        mock_template = Mock()
+        mock_template.UID.return_value = "template-uid"
+        mock_template.get_file.return_value = Mock(data=b"odt content")
+
+        with patch("imio.dms.mail.adapters.convert_odt", return_value=fake_pdf_bytes) as mock_conv:
+            with patch("imio.dms.mail.adapters.generate_barcode") as mock_barcode:
+                mock_barcode.return_value = Mock(**{"read.return_value": b"barcode-bytes"})
+                with patch("imio.dms.mail.adapters.getMultiAdapter") as mock_adapt:
+                    mock_adapt.return_value = Mock()
+                    result = self.approval._render_download_template_to_pdf(
+                        mock_template, "https://downloads.files.com/abc"
+                    )
+
+        self.assertEqual(result, fake_pdf_bytes)
+        call_args = mock_conv.call_args
+        self.assertEqual(call_args[1]["fmt"], "pdf")
+        gen_context = call_args[1]["gen_context"]
+        self.assertEqual(gen_context["context"], self.omail)
+        self.assertEqual(gen_context["download_barcode"], b"barcode-bytes")
+        self.assertEqual(gen_context["download_url"], "https://downloads.files.com/abc")
+        self.assertTrue(gen_context["render_download_barcode"])
+
+    def test_create_pdf_file_from_pdf(self):
+        """TODO"""
+
+    def test_create_pdf_file_from_odt(self):
+        """When input is a PDF and download_barcode template exists, a new file with the QR page is created."""
+        fake_sub_pdf = b"%PDF-1.4 sub"
+        fake_merged = b"%PDF-1.4 merged"
+
+        ct = self.portal["annexes_types"]["outgoing_dms_files"]["outgoing-dms-file"]
+        with open("%s/tests/files/example.pdf" % PRODUCT_DIR, "rb") as fo:
+            pdf_data = fo.read()
+        pdf_blob = NamedBlobFile(pdf_data, filename=u"test.pdf")
+        pdf_fobj = createContentInContainer(
+            self.omail,
+            "dmsommainfile",
+            id="pdffile2",
+            scan_id="012999900000601",
+            file=pdf_blob,
+            content_category=calculate_category_id(ct),
+        )
+
+        mock_template = Mock()
+        mock_template.UID.return_value = "dl-barcode-uid"
+        mock_template.get_file.return_value = Mock(data=b"odt content")
+
+        session_file_uids = []
+        with patch.object(self.portal.templates.om, "get", return_value=mock_template):
+            with patch.object(self.approval, "_render_download_template_to_pdf", return_value=fake_sub_pdf):
+                with patch("imio.dms.mail.adapters.merge_pdf", return_value=fake_merged):
+                    self.approval._create_pdf_file(
+                        pdf_fobj, pdf_fobj.file, u"test", pdf_fobj.UID(), 0, session_file_uids
+                    )
+
+        self.assertEqual(len(self.omail.objectIds()), 4)
+        self.assertEqual(len(session_file_uids), 1)
+        new_uid = session_file_uids[0]
+        self.assertNotEqual(new_uid, pdf_fobj.UID())
+        catalog = getToolByName(self.portal, "portal_catalog")
+        brains = catalog(UID=new_uid)
+        self.assertEqual(len(brains), 1)
+        new_fobj = brains[0].getObject()
+        self.assertTrue(new_fobj.to_sign)
+        self.assertFalse(new_fobj.to_approve)
+
+    def test_create_pdf_file_from_docx(self):
+        """For non-ODT files (DOCX), the QR page is appended after conversion."""
+        fake_sub_pdf = b"%PDF-1.4 sub"
+        fake_merged = b"%PDF-1.4 merged"
+
+        api.portal.set_registry_record(
+            "imio.dms.mail.browser.settings.IImioDmsMailConfig.omail_esign_formats",
+            ["odt", "pdf", "doc"],
+        )
+
+        ct = self.portal["annexes_types"]["outgoing_dms_files"]["outgoing-dms-file"]
+        docx_blob = NamedBlobFile(
+            b"PK fake docx content",
+            contentType="application/vnd.openxmlformats-officedocument.wordprocessingml.document",
+            filename=u"test.docx",
+        )
+        docx_fobj = createContentInContainer(
+            self.omail,
+            "dmsommainfile",
+            id="docxfile",
+            scan_id="012999900000601",
+            file=docx_blob,
+            content_category=calculate_category_id(ct),
+        )
+
+        mock_template = Mock()
+        mock_template.UID.return_value = "dl-barcode-uid"
+        mock_template.get_file.return_value = Mock(data=b"odt content")
+
+        mock_pdf_file = Mock()
+        mock_pdf_file.UID.return_value = "new-pdf-uid"
+        mock_pdf_file.file = Mock()
+        mock_pdf_file.file.data = b"%PDF-1.4 converted"
+        mock_pdf_file.file.filename = u"test.pdf"
+
+        session_file_uids = []
+        try:
+            with patch("imio.dms.mail.adapters.convert_and_save_file", return_value=mock_pdf_file):
+                with patch("imio.dms.mail.adapters.get_original_template", return_value=None):
+                    with patch("imio.dms.mail.adapters.update_categorized_elements"):
+                        with patch("imio.dms.mail.adapters.get_category_object", return_value=Mock()):
+                            with patch.object(self.portal.templates.om, "get", return_value=mock_template):
+                                with patch.object(
+                                    self.approval, "_render_download_template_to_pdf", return_value=fake_sub_pdf
+                                ):
+                                    with patch("imio.dms.mail.adapters.merge_pdf", return_value=fake_merged):
+                                        with patch("imio.dms.mail.adapters.Converter") as mock_converter_cls:
+                                            mock_converter_cls.return_value = Mock()
+                                            self.approval._create_pdf_file(
+                                                docx_fobj,
+                                                docx_fobj.file,
+                                                u"test",
+                                                docx_fobj.UID(),
+                                                0,
+                                                session_file_uids,
+                                            )
+        finally:
+            api.portal.set_registry_record(
+                "imio.dms.mail.browser.settings.IImioDmsMailConfig.omail_esign_formats",
+                ["odt", "pdf"],
+            )
+
+        self.assertEqual(mock_pdf_file.file.data, fake_merged)
+        mock_converter_cls.assert_called_once_with(mock_pdf_file)
+        mock_converter_cls.return_value.assert_called_once()
+        self.assertEqual(session_file_uids, ["new-pdf-uid"])