Added SessionAnnotationInfoView WIP

chris-adam · chris-adam · commit de5ca033963e · 2026-03-09T11:27:56.000+01:00
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -29,6 +29,8 @@ Changelog
   [chris-adam]
 - Added external watchers for esign sessions.
   [chris-adam, sgeulette]
+- Added SessionAnnotationInfoView.
+  [chris-adam]
 
 1.0a2 (2026-02-06)
 ------------------
diff --git a/src/imio/esign/browser/actions.py b/src/imio/esign/browser/actions.py
@@ -1,13 +1,22 @@
 # -*- coding: utf-8 -*-
+from AccessControl import Unauthorized
+from html import escape
+from imio.dms.mail.utils import persistent_to_native
 from imio.esign import _
 from imio.esign.adapters import ISignable
 from imio.esign.utils import add_files_to_session
 from imio.esign.utils import get_session_annotation
 from imio.esign.utils import remove_context_from_session
 from imio.esign.utils import remove_files_from_session
+from imio.helpers.content import uuidToObject
+from imio.helpers.security import check_zope_admin
 from plone import api
+from Products.CMFPlone.utils import safe_unicode
 from Products.Five import BrowserView
 
+import pprint
+import re
+
 
 class AddToSessionView(BrowserView):
     """View to add an element to an esign session."""
@@ -121,3 +130,65 @@ def available(self):
         """Defines if the action is available or not."""
         annot = get_session_annotation()
         return self.context.UID() in annot.get("uids", {})
+
+
+class SessionAnnotationInfoView(BrowserView):
+    """Admin-only view displaying imio.esign session annotations for a specific context item."""
+
+    def __call__(self):
+        if not check_zope_admin():
+            raise Unauthorized
+        return self.index()
+
+    def _uid_to_link(self, uid):
+        """Return an HTML link for an object UID, or the UID if not found."""
+        obj = uuidToObject(uid, unrestricted=True)
+        if obj is None:
+            return u"<span title='not found'>{}</span>".format(safe_unicode(uid))
+        url = escape(obj.absolute_url(), quote=True)
+        path = escape(u"/".join(obj.getPhysicalPath()))
+        title = escape(safe_unicode(getattr(obj, "title", "") or path))
+        return u"<a href='{}' title='{}'>{}</a>".format(url, path, title)
+
+    def _render_value(self, value, indent=u""):
+        """Render a value, replacing UIDs with links where possible."""
+        inner = indent + u"  "
+        if isinstance(value, dict):
+            if not value:
+                return u"{}"
+            lines = [u"{"]
+            for k, v in sorted(value.items()):
+                key = escape(safe_unicode(pprint.pformat(k)))
+                lines.append(u"{}{}: {},".format(inner, key, self._render_value(v, inner)))
+            lines.append(u"{}}}".format(indent))
+            return u"\n".join(lines)
+        elif isinstance(value, (list, tuple)):
+            if not value:
+                return u"[]"
+            lines = [u"["]
+            for item in value:
+                lines.append(u"{}{},".format(inner, self._render_value(item, inner)))
+            lines.append(u"{}]".format(indent))
+            return u"\n".join(lines)
+        elif isinstance(value, basestring) and re.match(r"^[0-9a-f]{32}$", value):
+            # Looks like a UUID
+            return self._uid_to_link(value)
+        else:
+            return escape(safe_unicode(pprint.pformat(value)))
+
+    @property
+    def esign_sessions(self):
+        """Return list of (session_id, session_data) for all sessions."""
+        annot = get_session_annotation()
+        c_uid = self.context.UID()
+        result = []
+        for session_id in annot['sessions']:
+            session = annot.get("sessions", {}).get(session_id)
+            # If any file in this session is in this context
+            if any(f['context_uid'] == c_uid for f in session['files']):
+                result.append((session_id, persistent_to_native(session)))
+        return sorted(result)
+
+    def esign_session_html(self, session_data):
+        """Renders esign session annot in HTML"""
+        return self._render_value(session_data)
diff --git a/src/imio/esign/browser/configure.zcml b/src/imio/esign/browser/configure.zcml
@@ -112,6 +112,14 @@
             allowed_attributes="available"
     />
 
+    <browser:page
+        for="*"
+        name="session-annotation-info"
+        class=".actions.SessionAnnotationInfoView"
+        permission="cmf.ManagePortal"
+        template="templates/session_annotation_info.pt"
+        />
+
     <browser:page
             name="signing-users-csv"
             for="Products.CMFPlone.interfaces.IPloneSiteRoot"
diff --git a/src/imio/esign/browser/templates/session_annotation_info.pt b/src/imio/esign/browser/templates/session_annotation_info.pt
@@ -0,0 +1,16 @@
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
+    xmlns:tal="http://xml.zope.org/namespaces/tal"
+    xmlns:metal="http://xml.zope.org/namespaces/metal"
+    xmlns:i18n="http://xml.zope.org/namespaces/i18n"
+    metal:use-macro="context/main_template/macros/master"
+    i18n:domain="imio.esign">
+    <body>
+      <metal:bodytext fill-slot="content-core">
+          <tal:esign tal:repeat="session view/esign_sessions">
+            <h2 tal:content="python:'imio.esign session (id: {})'.format(session[0])"></h2>
+            <pre style="background: #f5f5f5; color: #333; padding: 1em; overflow: auto;"
+                 tal:content="structure python:view.esign_session_html(session[1])" />
+          </tal:esign>
+      </metal:bodytext>
+    </body>
+</html>
diff --git a/src/imio/esign/tests/test_actions.py b/src/imio/esign/tests/test_actions.py
@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 """actions tests for this package."""
 from collective.iconifiedcategory.utils import calculate_category_id
+from imio.esign.browser.actions import SessionAnnotationInfoView
 from imio.esign.testing import IMIO_ESIGN_INTEGRATION_TESTING
 from imio.esign.utils import add_files_to_session
 from imio.esign.utils import get_session_annotation
@@ -124,3 +125,208 @@ def test_finished_shows_message_and_redirects(self):
         self.assertEqual(len(messages), 1)
         self.assertIn("removed from session", messages[0].message)
         self.assertEqual(self.request.RESPONSE.getHeader("location"), self.annexes[0].absolute_url())
+
+
+class TestSessionAnnotationInfoView(unittest.TestCase):
+    """Test SessionAnnotationInfoView"""
+
+    layer = IMIO_ESIGN_INTEGRATION_TESTING
+
+    def setUp(self):
+        self.portal = self.layer["portal"]
+        change_user(self.portal)
+        self.om1 = get_object(oid="reponse1", ptype="dmsoutgoingmail")
+        self.view = SessionAnnotationInfoView(self.om1, self.portal.REQUEST)
+        self.pf = self.portal["contacts"]["personnel-folder"]
+        self.pgof = self.portal["contacts"]["plonegroup-organization"]
+
+    def _setup_esign_omail(self):
+        """Create a new outgoing mail with esign enabled and two files."""
+        login(self.layer["app"], "admin")
+        self.portal.portal_setup.runImportStepFromProfile(
+            "profile-imio.dms.mail:singles", "imiodmsmail-activate-esigning", run_dependencies=False
+        )
+        set_registry_file_url("https://downloads.files.com")
+        intids = getUtility(IIntIds)
+        params = {
+            "title": u"Courrier test esign",
+            "internal_reference_no": internalReferenceOutgoingMailDefaultValue(
+                DummyView(self.portal, self.portal.REQUEST)
+            ),
+            "mail_type": "courrier",
+            "treating_groups": self.pgof["direction-generale"]["grh"].UID(),
+            "recipients": [RelationValue(intids.getId(self.portal["contacts"]["jeancourant"]))],
+            "assigned_user": "agent",
+            "sender": self.portal["contacts"]["jeancourant"]["agent-electrabel"].UID(),
+            "send_modes": u"post",
+            "signers": [
+                {
+                    "number": 1,
+                    "signer": self.pf["dirg"]["directeur-general"].UID(),
+                    "approvings": [u"_themself_"],
+                    "editor": True,
+                },
+                {
+                    "number": 2,
+                    "signer": self.pf["bourgmestre"]["bourgmestre"].UID(),
+                    "approvings": [u"_themself_"],
+                    "editor": False,
+                },
+            ],
+            "esign": True,
+        }
+        omail = sub_create(self.portal["outgoing-mail"], "dmsoutgoingmail", datetime.now(), "om-esign", **params)
+        filename = u"Réponse salle.odt"
+        ct = self.portal["annexes_types"]["outgoing_dms_files"]["outgoing-dms-file"]
+        files = []
+        for i in range(2):
+            with open("%s/batchimport/toprocess/outgoing-mail/%s" % (PRODUCT_DIR, filename), "rb") as fo:
+                file_object = NamedBlobFile(fo.read(), filename=filename)
+                files.append(
+                    createContentInContainer(
+                        omail,
+                        "dmsommainfile",
+                        id="file%s" % i,
+                        scan_id="012999900000601",
+                        file=file_object,
+                        content_category=calculate_category_id(ct),
+                    )
+                )
+        return omail, files, IOMApproval(omail)
+
+    def _approve_all_files(self, omail, files, approval):
+        """Approve all files through the full two-signer approval process."""
+        pw = self.portal.portal_workflow
+        pw.doActionFor(omail, "propose_to_approve")
+        approval.approve_file(files[0], "dirg", transition="propose_to_be_signed")
+        approval.approve_file(files[1], "dirg", transition="propose_to_be_signed")
+        approval.approve_file(files[1], "bourgmestre", transition="propose_to_be_signed")
+        approval.approve_file(files[0], "bourgmestre", transition="propose_to_be_signed")
+
+    def test_call(self):
+        with self.assertRaises(Unauthorized):
+            self.view()
+        login(self.portal.aq_parent, "admin")
+        self.assertIsInstance(self.view(), basestring)
+
+    def test_render_value(self):
+        # Dict
+        self.assertEqual(self.view._render_value({}), u"{}")
+        self.assertEqual(
+            self.view._render_value({"key": "val"}),
+            u"{\n  &#x27;key&#x27;: &#x27;val&#x27;,\n}",
+        )
+
+        # Indentation: nested value increases indent level
+        self.assertEqual(
+            self.view._render_value({"key": ["a"]}),
+            u"{\n  &#x27;key&#x27;: [\n    &#x27;a&#x27;,\n  ],\n}",
+        )
+
+        # List
+        self.assertEqual(self.view._render_value([]), u"[]")
+        self.assertEqual(
+            self.view._render_value(["a", "b"]),
+            u"[\n  &#x27;a&#x27;,\n  &#x27;b&#x27;,\n]",
+        )
+
+        # Tuple
+        self.assertEqual(self.view._render_value(()), u"[]")
+
+        # String
+        self.assertEqual(self.view._render_value(u"hello"), u"u&#x27;hello&#x27;")
+
+        # UID not found
+        fake_uid = u"a" * 32
+        self.assertEqual(
+            self.view._render_value(fake_uid),
+            u"<span title='not found'>aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa</span>",
+        )
+
+        # UID found
+        self.assertEqual(
+            self.view._render_value(self.om1.UID()),
+            u"<a href='http://nohost/plone/outgoing-mail/202608/reponse1' title='/plone/outgoing-mail/202608/reponse1'>R\xe9ponse 1</a>",
+        )
+
+    def test_uid_to_link(self):
+        uid = self.om1.UID()
+        result = self.view._uid_to_link(uid)
+        self.assertIn(u"<a href=", result)
+        self.assertIn(self.om1.absolute_url(), result)
+
+        result = self.view._uid_to_link(u"a" * 32)
+        self.assertIn(u"<span", result)
+        self.assertIn(u"not found", result)
+
+    def test_esign_sessions(self):
+        """Test approval_annot_html and esign_session_html after a true approval process."""
+        omail, files, approval = self._setup_esign_omail()
+        self._approve_all_files(omail, files, approval)
+
+        view = SessionAnnotationInfoView(omail, self.portal.REQUEST)
+
+        # esign essions property
+        esign_sessions = view.esign_sessions
+        self.assertEqual(len(esign_sessions), 1)
+        esign_session = esign_sessions[0]
+        self.assertIsInstance(esign_session, tuple)
+        self.assertEqual(esign_session[0], 0)
+
+        # esign session html
+        self.assertEqual(
+            HTMLParser().unescape(view.esign_session_html(esign_session[1])),
+            u"""{{
+  'acroform': True,
+  'client_id': '0129999',
+  'discriminators': [],
+  'files': [
+    {{
+      'context_uid': <a href='http://nohost/plone/outgoing-mail/{folder_name}/om-esign' title='/plone/outgoing-mail/{folder_name}/om-esign'>Courrier test esign</a>,
+      'filename': u'R\\xe9ponse salle__{pdf1_uid}.pdf',
+      'scan_id': '012999900000601',
+      'status': '',
+      'title': u'R\\xe9ponse salle.pdf',
+      'uid': <a href='http://nohost/plone/outgoing-mail/{folder_name}/om-esign/reponse-salle.pdf' title='/plone/outgoing-mail/{folder_name}/om-esign/reponse-salle.pdf'>Réponse salle.pdf</a>,
+    }},
+    {{
+      'context_uid': <a href='http://nohost/plone/outgoing-mail/{folder_name}/om-esign' title='/plone/outgoing-mail/{folder_name}/om-esign'>Courrier test esign</a>,
+      'filename': u'R\\xe9ponse salle__{pdf2_uid}.pdf',
+      'scan_id': '012999900000601',
+      'status': '',
+      'title': u'R\\xe9ponse salle.pdf',
+      'uid': <a href='http://nohost/plone/outgoing-mail/{folder_name}/om-esign/reponse-salle-1.pdf' title='/plone/outgoing-mail/{folder_name}/om-esign/reponse-salle-1.pdf'>Réponse salle.pdf</a>,
+    }},
+  ],
+  'last_update': {last_update},
+  'returns': [],
+  'seal': False,
+  'sign_id': '012999900000',
+  'sign_url': None,
+  'signers': [
+    {{
+      'email': 'dirg@macommune.be',
+      'fullname': u'Maxime DG',
+      'position': u'Directeur G\\xe9n\\xe9ral',
+      'status': '',
+      'userid': 'dirg',
+    }},
+    {{
+      'email': 'bourgmestre@macommune.be',
+      'fullname': u'Paul BM',
+      'position': u'Bourgmestre',
+      'status': '',
+      'userid': 'bourgmestre',
+    }},
+  ],
+  'size': 54660,
+  'state': 'draft',
+  'title': u'[ia.docs] Session 012999900000',
+  'watchers': [],
+}}""".format(
+                pdf1_uid=api.content.get(omail.absolute_url_path() + "/reponse-salle.pdf").UID(),
+                pdf2_uid=api.content.get(omail.absolute_url_path() + "/reponse-salle-1.pdf").UID(),
+                folder_name=omail.__parent__.__name__,
+                last_update=repr(get_session_annotation()["sessions"][0]["last_update"]),
+            ),
+        )
