Moved base SessionAnnotationInfoView to imio.esign

chris-adam · chris-adam · commit 2dda9ca7ee9d · 2026-03-09T12:41:47.000+01:00
diff --git a/imio/dms/mail/Extensions/demo.py b/imio/dms/mail/Extensions/demo.py
@@ -18,7 +18,7 @@
 from imio.dms.mail.interfaces import IOMApproval
 from imio.dms.mail.utils import create_period_folder
 from imio.dms.mail.utils import DummyView
-from imio.dms.mail.utils import persistent_to_native
+from imio.esign.utils import persistent_to_native
 from imio.helpers.content import find
 from imio.helpers.security import check_zope_admin
 from imio.helpers.workflow import do_transitions
diff --git a/imio/dms/mail/browser/actionspanel.py b/imio/dms/mail/browser/actionspanel.py
@@ -3,7 +3,6 @@
 from imio.actionspanel.browser.views import ActionsPanelView
 from imio.dms.mail.dmsmail import filter_dmsincomingmail_assigned_users
 from imio.helpers.cache import get_plone_groups_for_user
-from imio.helpers.security import check_zope_admin
 from plone import api
 from plone.memoize import ram
 from Products.CMFPlone.interfaces import IHideFromBreadcrumbs
@@ -166,8 +165,7 @@ class SigningFieldsetActionsPanelView(ActionsPanelView):
 
     def __init__(self, context, request):
         super(SigningFieldsetActionsPanelView, self).__init__(context, request)
-        self.ACCEPTABLE_ACTIONS = ["edit", "approvals"]
-        self.SECTIONS_TO_RENDER += ("renderSigningAnnotationInfo",)
+        self.ACCEPTABLE_ACTIONS = ["edit", "approvals", "session-annotation-info"]
 
     @property
     def fieldset(self):
@@ -178,11 +176,6 @@ def renderEdit(self):
             return ViewPageTemplateFile("templates/fieldset_actions_panel_edit.pt")(self)
         return ""
 
-    def renderSigningAnnotationInfo(self):
-        if check_zope_admin():
-            return ViewPageTemplateFile("templates/fieldset_actions_panel_signing_annotation_info.pt")(self)
-        return ""
-
     @ram.cache(actionspanelview_cachekey)
     def SigningFieldsetActionsPanelView__call__(
         self,
diff --git a/imio/dms/mail/browser/configure.zcml b/imio/dms/mail/browser/configure.zcml
@@ -57,9 +57,10 @@
 
     <browser:page
         for="imio.dms.mail.dmsmail.IImioDmsOutgoingMail"
-        name="signing-annotation-info"
-        class=".views.SigningAnnotationInfoView"
+        name="session-annotation-info"
+        class=".views.OMSessionAnnotationInfoView"
         permission="cmf.ManagePortal"
+        template="templates/session_annotation_info.pt"
         />
 
     <browser:page
diff --git a/imio/dms/mail/browser/templates/fieldset_actions_panel_edit.pt b/imio/dms/mail/browser/templates/fieldset_actions_panel_edit.pt
@@ -6,8 +6,7 @@
   <a tal:condition="useIcons"
      tal:attributes="href string:${context/absolute_url}/edit${view/fieldset};
                      class python: view.kwargs.get('edit_action_class', '');
-                     target python: view.kwargs.get('edit_action_target', '_parent');"
-     target="_parent">
+                     target python: view.kwargs.get('edit_action_target', '_parent');">
     <img src="edit.gif" tal:attributes="src string:${view/portal_url}/edit.png" title="Edit" i18n:attributes="title" />
   </a>
   <tal:comment replace="nothing">Button</tal:comment>
diff --git a/imio/dms/mail/browser/templates/fieldset_actions_panel_signing_annotation_info.pt b/imio/dms/mail/browser/templates/fieldset_actions_panel_signing_annotation_info.pt
diff --git a/imio/dms/mail/browser/templates/session_annotation_info.pt b/imio/dms/mail/browser/templates/session_annotation_info.pt
@@ -3,7 +3,7 @@
     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.dms.mail">
+    i18n:domain="imio.esign">
     <body>
       <metal:bodytext fill-slot="content-core">
           <h2>idm.approval annotation</h2>
diff --git a/imio/dms/mail/browser/views.py b/imio/dms/mail/browser/views.py
@@ -1,11 +1,9 @@
 # -*- coding: utf-8 -*-
 from AccessControl import getSecurityManager
-from AccessControl import Unauthorized
 from Acquisition import aq_inner
 from collective.ckeditortemplates.cktemplate import ICKTemplate
 from datetime import datetime
 from eea.faceted.vocabularies.autocomplete import IAutocompleteSuggest
-from html import escape
 from imio.dms.mail import _
 from imio.dms.mail import _tr
 from imio.dms.mail import PMH_ENABLED
@@ -17,13 +15,13 @@
 from imio.dms.mail.interfaces import IPersonnelContact
 from imio.dms.mail.utils import current_user_groups_ids
 from imio.dms.mail.utils import get_dms_config
-from imio.dms.mail.utils import persistent_to_native
 from imio.esign import manage_session_perm
 from imio.esign.browser.actions import RemoveItemFromSessionView
+from imio.esign.browser.actions import SessionAnnotationInfoView
 from imio.esign.browser.views import ExternalSessionCreateView
 from imio.esign.browser.views import SessionsListingView
 from imio.esign.config import get_registry_enabled
-from imio.esign.utils import get_session_annotation
+from imio.esign.utils import persistent_to_native
 from imio.esign.utils import remove_files_from_session
 from imio.helpers.content import richtextval
 from imio.helpers.content import uuidToObject
@@ -32,7 +30,6 @@
 from imio.helpers.emailer import get_mail_host
 from imio.helpers.emailer import send_email
 from imio.helpers.fancytree.views import BaseRenderFancyTree
-from imio.helpers.security import check_zope_admin
 from imio.helpers.workflow import do_transitions
 from imio.helpers.xhtml import object_link
 from plone import api
@@ -55,8 +52,6 @@
 from zope.pagetemplate.pagetemplate import PageTemplate
 
 import json
-import pprint
-import re
 
 
 class CreateFromTemplateForm(BaseRenderFancyTree):
@@ -677,74 +672,12 @@ def get_link_url(item):
         return result
 
 
-class SigningAnnotationInfoView(BrowserView):
+class OMSessionAnnotationInfoView(SessionAnnotationInfoView):
     """Admin-only view displaying idm.approval and imio.esign session annotations for an outgoing mail."""
 
-    index = ViewPageTemplateFile("templates/signing_annotation_info.pt")
-
-    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 approval_annot_html(self):
         """Renders approval annot in HTML"""
         approval = IOMApproval(self.context)
         native = persistent_to_native(approval.annot)
         return self._render_value(native)
-
-    @property
-    def esign_sessions(self):
-        """Return list of (session_id, session_data) for all sessions."""
-        approval = IOMApproval(self.context)
-        session_ids = approval.annot.get("session_ids", [])
-        if not session_ids:
-            return []
-        annot = get_session_annotation()
-        result = []
-        for session_id in session_ids:
-            session = annot.get("sessions", {}).get(session_id)
-            if session is not None:
-                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/imio/dms/mail/profiles/default/types/dmsoutgoingmail.xml b/imio/dms/mail/profiles/default/types/dmsoutgoingmail.xml
@@ -22,4 +22,9 @@
   <element value="task"/>
  </property>
  <alias from="edit" to="@@dmsdocument-edit"/>
+ <action title="Annotation info" action_id="session-annotation-info" category="object_buttons" condition_expr=""
+    description="" icon_expr="string:${portal_url}/info.png" link_target="_blank"
+    url_expr="string:${object/absolute_url}/@@session-annotation-info" visible="True">
+  <permission value="cmf.ManagePortal"/>
+ </action>
 </object>
diff --git a/imio/dms/mail/tests/test_views.py b/imio/dms/mail/tests/test_views.py
@@ -1,16 +1,15 @@
 # -*- coding: utf-8 -*-
 """Test views."""
 
-from AccessControl import Unauthorized
 from collective.dms.mailcontent.dmsmail import internalReferenceOutgoingMailDefaultValue
 from collective.iconifiedcategory.utils import calculate_category_id
 from collective.MockMailHost.MockMailHost import MockMailHost
 from datetime import datetime
 from HTMLParser import HTMLParser
 from imio.dms.mail import PERIODS
 from imio.dms.mail import PRODUCT_DIR
+from imio.dms.mail.browser.views import OMSessionAnnotationInfoView
 from imio.dms.mail.browser.views import parse_query
-from imio.dms.mail.browser.views import SigningAnnotationInfoView
 from imio.dms.mail.interfaces import IOMApproval
 from imio.dms.mail.testing import change_user
 from imio.dms.mail.testing import DMSMAIL_INTEGRATION_TESTING
@@ -26,7 +25,6 @@
 from plone.app.testing import login
 from plone.dexterity.utils import createContentInContainer
 from plone.namedfile.file import NamedBlobFile
-from Products.CMFPlone.utils import safe_unicode
 from z3c.relationfield import RelationValue
 from zope.component import getUtility
 from zope.i18n import translate
@@ -318,16 +316,16 @@ def test_call(self):
         self.assertIn(u">5032 Isnes<", rendered)
 
 
-class TestSigningAnnotationInfoView(unittest.TestCase, ImioTestHelpers):
-    """Test SigningAnnotationInfoView"""
+class TestOMSessionAnnotationInfoView(unittest.TestCase, ImioTestHelpers):
+    """Test OMSessionAnnotationInfoView"""
 
     layer = DMSMAIL_INTEGRATION_TESTING
 
     def setUp(self):
         self.portal = self.layer["portal"]
         change_user(self.portal)
         self.om1 = get_object(oid="reponse1", ptype="dmsoutgoingmail")
-        self.view = SigningAnnotationInfoView(self.om1, self.portal.REQUEST)
+        self.view = OMSessionAnnotationInfoView(self.om1, self.portal.REQUEST)
         self.pf = self.portal["contacts"]["personnel-folder"]
         self.pgof = self.portal["contacts"]["plonegroup-organization"]
 
@@ -394,68 +392,12 @@ def _approve_all_files(self, omail, files, approval):
         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_approval_and_esign_sessions(self):
-        """Test approval_annot_html and esign_session_html after a true approval process."""
+    def test_annot_html(self):
+        """Test approval_annot_html and esign_session_html."""
         omail, files, approval = self._setup_esign_omail()
         self._approve_all_files(omail, files, approval)
 
-        view = SigningAnnotationInfoView(omail, self.portal.REQUEST)
+        view = OMSessionAnnotationInfoView(omail, self.portal.REQUEST)
 
         # approval annot html
         self.assertEqual(
@@ -501,15 +443,15 @@ def test_approval_and_esign_sessions(self):
     False,
   ],
   'files': [
-    <a href='http://nohost/plone/outgoing-mail/202608/om-esign/file0' title='/plone/outgoing-mail/202608/om-esign/file0'>Réponse salle.odt</a>,
-    <a href='http://nohost/plone/outgoing-mail/202608/om-esign/file1' title='/plone/outgoing-mail/202608/om-esign/file1'>Réponse salle.odt</a>,
+    <a href='http://nohost/plone/outgoing-mail/{folder_name}/om-esign/file0/view' title='/plone/outgoing-mail/{folder_name}/om-esign/file0'>Réponse salle.odt</a>,
+    <a href='http://nohost/plone/outgoing-mail/{folder_name}/om-esign/file1/view' title='/plone/outgoing-mail/{folder_name}/om-esign/file1'>Réponse salle.odt</a>,
   ],
   'pdf_files': [
     [
-      <a href='http://nohost/plone/outgoing-mail/202608/om-esign/reponse-salle.pdf' title='/plone/outgoing-mail/202608/om-esign/reponse-salle.pdf'>Réponse salle.pdf</a>,
+      <a href='http://nohost/plone/outgoing-mail/{folder_name}/om-esign/reponse-salle.pdf/view' title='/plone/outgoing-mail/{folder_name}/om-esign/reponse-salle.pdf'>Réponse salle.pdf</a>,
     ],
     [
-      <a href='http://nohost/plone/outgoing-mail/202608/om-esign/reponse-salle-1.pdf' title='/plone/outgoing-mail/202608/om-esign/reponse-salle-1.pdf'>Réponse salle.pdf</a>,
+      <a href='http://nohost/plone/outgoing-mail/{folder_name}/om-esign/reponse-salle-1.pdf/view' title='/plone/outgoing-mail/{folder_name}/om-esign/reponse-salle-1.pdf'>Réponse salle.pdf</a>,
     ],
   ],
   'session_ids': [
@@ -532,6 +474,7 @@ def test_approval_and_esign_sessions(self):
                 repr(approval.annot["approval"][0][1]["approved_on"]),
                 repr(approval.annot["approval"][1][0]["approved_on"]),
                 repr(approval.annot["approval"][1][1]["approved_on"]),
+                folder_name=omail.__parent__.__name__,
             ),
         )
 
@@ -551,20 +494,20 @@ def test_approval_and_esign_sessions(self):
   '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>,
+      'context_uid': <a href='http://nohost/plone/outgoing-mail/{folder_name}/om-esign/view' 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>,
+      'uid': <a href='http://nohost/plone/outgoing-mail/{folder_name}/om-esign/reponse-salle.pdf/view' 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>,
+      'context_uid': <a href='http://nohost/plone/outgoing-mail/{folder_name}/om-esign/view' 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>,
+      'uid': <a href='http://nohost/plone/outgoing-mail/{folder_name}/om-esign/reponse-salle-1.pdf/view' title='/plone/outgoing-mail/{folder_name}/om-esign/reponse-salle-1.pdf'>Réponse salle.pdf</a>,
     }},
   ],
   'last_update': {last_update},
diff --git a/imio/dms/mail/utils.py b/imio/dms/mail/utils.py
