Handled multiple sessions for one context

Author: chris-adam

imio/dms/mail/adapters.py

@@ -1141,8 +1141,8 @@ class OMApprovalAdapter(object):
     Annotation structure: metadata + 2D matrix with n signers and m files
 
     ### Metadata
-    self.annot["session_id"] = str
-        The unique id of the internal approval session
+    self.annot["session_ids"] = list[session_id]
+        The list of esign session ids
     self.annot["signers"] = list[n] (userid, name, label)
         The list of signers for the approval process
     self.annot["approvers"] = list[n] tuple(userids)
@@ -1170,7 +1170,7 @@ def __init__(self, context):
                 {
                     # Metadata
                     "current_nb": None,
-                    "session_id": None,
+                    "session_ids": PersistentList(),
                     "signers": PersistentList(),
                     "editors": PersistentList(),
                     "approvers": PersistentList(),
@@ -1186,7 +1186,7 @@ def reset(self):
         """Reset approval annotation."""
         # Metadata
         self.annot["current_nb"] = None
-        self.annot["session_id"] = None
+        self.annot["session_ids"] = PersistentList()
         self.annot["signers"] = PersistentList()
         self.annot["editors"] = PersistentList()
         self.annot["approvers"] = PersistentList()
@@ -1196,9 +1196,9 @@ def reset(self):
         self.annot["approval"] = PersistentList()
 
     @property
-    def session_id(self):
-        """Return the unique session id of the approval process."""
-        return self.annot["session_id"]
+    def session_ids(self):
+        """Return all session ids for this approval."""
+        return self.annot.get("session_ids", PersistentList())
 
     @property
     def files_uids(self):
@@ -1856,17 +1856,27 @@ 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)
-        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})
+        # Add one file at a time so max_session_size discrimination splits sessions naturally
+        new_session_ids = []
+        for pdf_uid in session_file_uids:
+            sid, _session = add_files_to_session(signers, [pdf_uid], bool(self.context.seal),
+                                                 title=_("[ia.docs] Session {sign_id}"),
+                                                 watchers=watcher_emails)
+            if sid not in new_session_ids:
+                new_session_ids.append(sid)
+        if new_session_ids:
+            session_ids = set(self.session_ids).union(set(new_session_ids))
+            self.annot["session_ids"] = PersistentList(list(session_ids))
         else:
-            return True, _("${count} file added to session number ${session_id}",
-                           mapping={"count": session_len, "session_id": session_id})
+            # All PDFs already existed — reuse the previously stored session ids
+            new_session_ids = list(self.session_ids)
+        session_len = sum(len(p) for p in self.pdf_files_uids)
+        n_sessions = len(new_session_ids)
+        if n_sessions == 1:
+            return True, _("${count} file(s) added to session number ${session_id}",
+                           mapping={"count": session_len, "session_id": new_session_ids[0]})
+        return True, _("${count} file(s) added to ${n} sessions",
+                       mapping={"count": session_len, "n": n_sessions})
 
 
 class DmsCategorizedObjectInfoAdapter(CategorizedObjectInfoAdapter):

imio/dms/mail/locales/en/LC_MESSAGES/imio.dms.mail.po

@@ -16,7 +16,7 @@ msgstr ""
 "X-is-fallback-for: en-au en-ca en-gb en-us\n"
 
 #: ./adapters.py:1877
-msgid "${count} file added to session number ${session_id}"
+msgid "${count} file(s) added to session number ${session_id}"
 msgstr ""
 
 #: ./adapters.py:1874

imio/dms/mail/locales/fr/LC_MESSAGES/imio.dms.mail.po

@@ -18,7 +18,7 @@ msgstr ""
 "X-Generator: Poedit 1.8.4\n"
 
 #: ./adapters.py:1877
-msgid "${count} file added to session number ${session_id}"
+msgid "${count} file(s) added to session number ${session_id}"
 msgstr "${count} fichier a été ajouté à la session numéro ${session_id}"
 
 #: ./adapters.py:1874

imio/dms/mail/locales/generated.pot

@@ -18,7 +18,7 @@ msgstr ""
 "Domain: imio.dms.mail\n"
 
 #: ./adapters.py:1877
-msgid "${count} file added to session number ${session_id}"
+msgid "${count} file(s) added to session number ${session_id}"
 msgstr ""
 
 #: ./adapters.py:1874

imio/dms/mail/locales/imio.dms.mail.pot

@@ -18,7 +18,7 @@ msgstr ""
 "Domain: imio.dms.mail\n"
 
 #: ./adapters.py:1877
-msgid "${count} file added to session number ${session_id}"
+msgid "${count} file(s) added to session number ${session_id}"
 msgstr ""
 
 #: ./adapters.py:1874

imio/dms/mail/skins/imio_dms_mail/imiodmsmail.css.dtml

@@ -1064,11 +1064,11 @@ div.faceted-session-info {
     padding-bottom: 0px;
 }
 
-#content table#context_viewlet_signers_table {
+#content table.context_viewlet_signers_table {
     margin-bottom: 0px;
 }
 
-#context_viewlet_signers_table td {
+.context_viewlet_signers_table td {
     padding-right: 10px;
 }
 

imio/dms/mail/subscribers.py

@@ -32,6 +32,7 @@
 from imio.dms.mail import IM_EDITOR_SERVICE_FUNCTIONS
 from imio.dms.mail import IM_READER_SERVICE_FUNCTIONS
 from imio.dms.mail.adapters import OMApprovalAdapter
+
 # from imio.dms.mail import MAIN_FOLDERS
 from imio.dms.mail.browser.settings import default_creating_group
 from imio.dms.mail.browser.settings import IImioDmsMailConfig
@@ -41,6 +42,7 @@
 from imio.dms.mail.interfaces import IPersonnelContact
 from imio.dms.mail.interfaces import IProtectedItem
 from imio.dms.mail.setuphandlers import blacklistPortletCategory
+
 # from imio.dms.mail.utils import separate_fullname
 from imio.dms.mail.utils import create_personnel_content
 from imio.dms.mail.utils import create_read_label_cron_task
@@ -60,6 +62,7 @@
 from imio.esign.utils import remove_files_from_session
 from imio.helpers.cache import invalidate_cachekey_volatile_for
 from imio.helpers.cache import setup_ram_cache
+
 # from imio.helpers.content import get_vocab_values
 from imio.helpers.content import object_values
 from imio.helpers.content import uuidToObject
@@ -89,6 +92,7 @@
 from z3c.relationfield.relation import RelationValue
 from zc.relation.interfaces import ICatalog  # noqa
 from zExceptions import Redirect
+
 # from zope.component.interfaces import ComponentLookupError
 from zope.annotation import IAnnotations
 from zope.component import getAdapter
@@ -130,6 +134,7 @@
     class IReferenceable(Interface):
         pass
 
+
 logger = logging.getLogger("imio.dms.mail: events")
 
 
@@ -421,19 +426,26 @@ def dmsoutgoingmail_transition(mail, event):
         approval.start_approval_process()
     if not mail.esign:
         # if not mail.seal, we render odt to remove download subdocument comment
-        if (not mail.seal and event.transition
-                and event.transition.id in ("set_validated", "set_to_print", "propose_to_be_signed", "mark_as_sent")):
-            for afile in object_values(mail, ("ImioDmsFile", )):
+        if (
+            not mail.seal
+            and event.transition
+            and event.transition.id in ("set_validated", "set_to_print", "propose_to_be_signed", "mark_as_sent")
+        ):
+            for afile in object_values(mail, ("ImioDmsFile",)):
                 doc_annot = IAnnotations(afile).get("documentgenerator", {})
                 # if not a generated odt (or needing mailing) or already done, we pass
                 if doc_annot.get("need_mailing", True) is True or doc_annot.get("cleaned_download") is True:
                     continue
-                helper_view = getMultiAdapter((mail, mail.REQUEST), name='document_generation_helper_view')
+                helper_view = getMultiAdapter((mail, mail.REQUEST), name="document_generation_helper_view")
                 helper_view.pod_template = doc_annot.get("template_uid")
                 helper_view.output_format = "odt"
-                gen_context = {"context": mail, "portal": api.portal.get(), "view": helper_view,
-                               "render_download_barcode": True}
-                new_file_content = convert_odt(afile.file, fmt='odt', gen_context=gen_context)
+                gen_context = {
+                    "context": mail,
+                    "portal": api.portal.get(),
+                    "view": helper_view,
+                    "render_download_barcode": True,
+                }
+                new_file_content = convert_odt(afile.file, fmt="odt", gen_context=gen_context)
                 afile.file = NamedBlobFile(new_file_content, filename=afile.file.filename)
                 modified(afile, Attributes(ImioDmsFile, "file"))
                 doc_annot["cleaned_download"] = True
@@ -466,7 +478,8 @@ def dmsoutgoingmail_transition(mail, event):
                         type="error",
                     )
                 if seal_code and seal_email:
-                    ExternalSessionCreateView(mail, mail.REQUEST)(session_id=approval.session_id)
+                    for sid in approval.session_ids:
+                        ExternalSessionCreateView(mail, mail.REQUEST)(session_id=sid)
     else:
         # TODO check if to_sign and approved files have a pdf version
         pass
@@ -639,7 +652,7 @@ def task_transition(task, event):
 
 
 def _correct_to_sign(file_obj):
-    """"Correct to_sign value following mimetype.
+    """ "Correct to_sign value following mimetype.
 
     :param file_obj: dmsommainfile or dmsappendixfile
     :return: True if to_sign has been changed
@@ -652,12 +665,7 @@ def _correct_to_sign(file_obj):
         file_obj.to_approve = False
         category_object = get_category_object(file_obj, file_obj.content_category)
         update_categorized_elements(
-            file_obj.__parent__,
-            file_obj,
-            category_object,
-            limited=True,
-            sort=False,
-            logging=True
+            file_obj.__parent__, file_obj, category_object, limited=True, sort=False, logging=True
         )
         api.portal.show_message(
             message=_(
@@ -686,22 +694,19 @@ def _correct_to_approve(file_obj):
     new_value = False
     om_obj = file_obj.__parent__
     approval = OMApprovalAdapter(om_obj)
-    if (orig_value and getattr(file_obj, "to_sign", False) and approval.approvers
-            and not base_hasattr(file_obj, "conv_from_uid")
-            and not getattr(file_obj, "need_mailing", False)):
+    if (
+        orig_value
+        and getattr(file_obj, "to_sign", False)
+        and approval.approvers
+        and not base_hasattr(file_obj, "conv_from_uid")
+        and not getattr(file_obj, "need_mailing", False)
+    ):
         new_value = True
         approval.add_file_to_approval(file_obj.UID())
     if orig_value != new_value:  # only when passing from True to False normally
         file_obj.to_approve = new_value
         category_object = get_category_object(file_obj, file_obj.content_category)
-        update_categorized_elements(
-            om_obj,
-            file_obj,
-            category_object,
-            limited=True,
-            sort=False,
-            logging=True
-        )
+        update_categorized_elements(om_obj, file_obj, category_object, limited=True, sort=False, logging=True)
 
 
 def i_annex_added(obj, event):
@@ -862,7 +867,7 @@ def imiodmsfile_added(obj, event):
 
 def imiodmsfile_iconified_attr_changed(obj, event):
     """When an iconified attribute is changed. Not used for the moment."""
-    if event.attr_name == 'approved':
+    if event.attr_name == "approved":
         if event.is_created:
             return
         fil = event.object  # noqa F841
@@ -1344,10 +1349,13 @@ def organization_modified(obj, event):
 
 def held_position_modified(obj, event):
     if IPersonnelContact.providedBy(obj):
-        invalidate_cachekey_volatile_for('imio.dms.mail.vocabularies.OMSignersVocabulary')
+        invalidate_cachekey_volatile_for("imio.dms.mail.vocabularies.OMSignersVocabulary")
         invalidate_cachekey_volatile_for("imio.dms.mail.vocabularies.SigningApprovingsVocabulary")
-        mod_attr = [at for at in getattr(event, "descriptions", []) if base_hasattr(at, "attributes")
-                    and "IUsagesBehavior.usages" in at.attributes]
+        mod_attr = [
+            at
+            for at in getattr(event, "descriptions", [])
+            if base_hasattr(at, "attributes") and "IUsagesBehavior.usages" in at.attributes
+        ]
         if mod_attr:
             update_approvers_settings()
 
@@ -1357,7 +1365,7 @@ def held_position_removed(obj, event):
         # at site removal
         if event.object.portal_type == "Plone Site":
             return
-        invalidate_cachekey_volatile_for('imio.dms.mail.vocabularies.OMSignersVocabulary')
+        invalidate_cachekey_volatile_for("imio.dms.mail.vocabularies.OMSignersVocabulary")
         invalidate_cachekey_volatile_for("imio.dms.mail.vocabularies.SigningApprovingsVocabulary")