Added get_sessions_for + Merged session info viewlet into a single collapsible

Author: chris-adam

src/imio/esign/browser/templates/macros.pt

@@ -40,7 +40,7 @@
 <tr metal:define-macro="signers" i18n:domain="imio.esign">
     <td class="table_widget_label"><label i18n:translate="">Signers</label></td>
     <td class="table_widget_value">
-        <table class="no-border no-style-table listing context_viewlet_signers_table"
+        <table class="context_viewlet_signers_table no-border no-style-table listing"
                  tal:define="signers python:session.get('signers', [])">
             <thead>
             <tr>

src/imio/esign/browser/templates/session_info.pt

@@ -4,21 +4,19 @@
       xmlns:i18n="http://xml.zope.org/namespaces/i18n"
       lang="en"
       i18n:domain="imio.esign">
-  <div class="faceted-session-info"
-       tal:condition="python: view.available()"
-       tal:define="session_id python: str(view.session.get('id', ''))">
-    <div tal:attributes="id string:session-info-${session_id};
-                         onclick string:toggleDetails('collapsible-session-info-${session_id}', toggle_parent_active=true);
-                         class python: view.collapsible_css_default()">
+  <div class="faceted-session-info" tal:condition="python: view.available()">
+    <div id="session-info"
+        onclick="toggleDetails('collapsible-session-info', toggle_parent_active=true);"
+        tal:attributes="class python: view.collapsible_css_default()">
       <span i18n:translate="">Session information (<img i18n:name="icon_url" tal:attributes="src string:${view/portal_url}/++resource++imio.esign/parapheo.svg" /> Parapheo)</span>
     </div>
-    <div tal:attributes="id string:collapsible-session-info-${session_id};
-                         class python: view.collapsible_content_css_default()">
+    <div id="collapsible-session-info"
+         tal:attributes="class python: view.collapsible_content_css_default()">
       <div class="collapsible-inner-content session-info-container"
-           tal:define="template python: context.unrestrictedTraverse('@@esign-macros').index;
-                       session python: view.session">
+           tal:repeat="session python:view.sessions"
+           tal:define="template python: context.unrestrictedTraverse('@@esign-macros').index">
         <div class="session-info-column">
-            <table class="no-style-table table-view-widgets">
+            <table tal:attributes="id string:context_viewlet_session_table_${session/id}" class="no-style-table table-view-widgets">
                 <tbody>
                 <tal:block tal:repeat="macro_name python:view.get_table_rows(1)">
                     <metal:render_cell use-macro="python: template.macros[macro_name]" />
@@ -28,16 +26,16 @@
         </div>
 
         <div class="session-info-column">
-            <table class="no-style-table table-view-widgets">
+            <table tal:attributes="id string:context_viewlet_session_signers_${session/id}" class="no-style-table table-view-widgets">
                 <tbody>
                 <tal:block tal:repeat="macro_name python:view.get_table_rows(2)">
                     <metal:render_cell use-macro="python: template.macros[macro_name]" />
                 </tal:block>
                 </tbody>
             </table>
         </div>
-        <script>$('table.context_viewlet_signers_table').each(setoddeven);</script>
-      </div>
+    </div>
+    <script>$('table.context_viewlet_signers_table').each(setoddeven);</script>
     </div>
   </div>
 

src/imio/esign/browser/views.py

@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 
 from AccessControl import Unauthorized
+from copy import deepcopy
 from datetime import datetime
 from datetime import timedelta
 from imio.esign import _
@@ -12,6 +13,7 @@
 from imio.esign.config import get_registry_signing_users_email_content
 from imio.esign.utils import create_external_session
 from imio.esign.utils import get_session_annotation
+from imio.esign.utils import get_sessions_for
 from imio.esign.utils import get_state_description
 from imio.esign.utils import remove_session
 from imio.helpers.content import uuidToObject
@@ -206,23 +208,24 @@ def sessions_collection_uid(self):
     def render(self):
         """Render the viewlet."""
         if self.request.form.get("c1[]", None) == self.sessions_collection_uid:
-            if self.session:
+            if self.sessions:
                 return self.index()
             return self.sessions_listing_view(self.context, self.request).render_table()
         return ""
 
     @property
-    def session(self):
-        session = None
+    def sessions(self):
         session_id = self.request.form.get("esign_session_id[]", None)
         if not session_id:
-            return
+            return []
+        session_id = int(session_id)
         sessions = get_session_annotation()["sessions"]
-        session = sessions.get(int(session_id))
+        session = sessions.get(session_id)
         if not session:
-            return
+            return []
+        session = deepcopy(session)
         session["id"] = session_id
-        return session
+        return [session]
 
     def get_table_rows(self, column):
         """Get the table rows following the column"""
@@ -258,37 +261,16 @@ def available(self):
         """Global availability of the viewlet."""
         return True
 
+    def render(self):
+        """Render the viewlet."""
+        if self.sessions:
+            return self.index()
+        return ""
+
     @property
     def sessions(self):
         """Return all sessions that contain files from this context."""
-        annot = get_session_annotation()
-        result = []
-        seen = set()
-        for f_uid in annot["c_uids"].get(self.context.UID(), []):
-            session_id = annot["uids"].get(f_uid)
-            if session_id is not None and session_id not in seen:
-                seen.add(session_id)
-                session = dict(annot["sessions"].get(session_id, {}))
-                session["id"] = session_id
-                result.append(session)
-        return result
-
-    @property
-    def session(self):
-        """Current session during render loop; also used by base template."""
-        return getattr(self, "_current_session", None) or {}
-
-    def render(self):
-        """Render viewlet once per session linked to this context."""
-        sessions = self.sessions
-        if not sessions:
-            return ""
-        parts = []
-        for s in sessions:
-            self._current_session = s
-            parts.append(self.index())
-        self._current_session = None
-        return "\n".join(parts)
+        return get_sessions_for(self.context.UID())
 
 
 @implementer(IPublishTraverse)

src/imio/esign/tests/test_browser_views.py

@@ -474,16 +474,3 @@ def test_sessions_multiple_sessions(self):
         self.assertEqual(len(sessions), 2)
         session_ids = {s["id"] for s in sessions}
         self.assertEqual(session_ids, {0, 1})
-
-        rendered_ids = []
-        def mock_index():
-            rendered_ids.append(viewlet._current_session["id"])
-            return u"<div>session {}</div>".format(viewlet._current_session["id"])
-        viewlet.index = mock_index
-        result = viewlet.render()
-        self.assertEqual(len(rendered_ids), 2)
-        self.assertIn(0, rendered_ids)
-        self.assertIn(1, rendered_ids)
-        self.assertIn(u"<div>session 0</div>", result)
-        self.assertIn(u"<div>session 1</div>", result)
-        self.assertIsNone(viewlet._current_session)

src/imio/esign/utils.py

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+from copy import deepcopy
 from datetime import datetime
 from datetime import timedelta
 from imio.esign import _tr as _
@@ -516,3 +517,20 @@ def get_state_description(state):
         'returned': u'The session is finished and signed documents are on the way back to the application.',
         'finalized': u'The session is finished and signed documents have been sent back to the application.',
     }.get(state, "")
+
+
+def get_sessions_for(context_uid, readonly=True):
+    """Returns a list of all sessions involving the provided context_uid"""
+    annot = get_session_annotation()
+    result = []
+    seen = set()
+    for f_uid in annot["c_uids"].get(context_uid, []):
+        session_id = annot["uids"].get(f_uid)
+        if session_id is not None and session_id not in seen:
+            seen.add(session_id)
+            session = annot["sessions"][session_id]
+            if readonly:
+                session = deepcopy(session)
+                session["id"] = session_id
+            result.append(session)
+    return result