Added possiblity to add custom data when creating session

Fixed delete session action
Make ItemSessionInfoViewlet inherits from FacetedSessionInfoViewlet
Added utils.get_session_info

Author: gbastien

src/imio/esign/adapters.py

@@ -77,6 +77,12 @@ def get_watchers(self):
 
     def get_discriminators(self):
         """
-        List of watchers email for that element.
+        List of discriminators for that element to associate it to an available session.
         """
         return []
+
+    def get_create_session_custom_data(self):
+        """
+        Dict of custom data that will be stored on session at creation time.
+        """
+        return {}

src/imio/esign/browser/configure.zcml

@@ -71,7 +71,7 @@
             for="eea.facetednavigation.subtypes.interfaces.IFacetedNavigable"
             manager="collective.eeafaceted.z3ctable.interfaces.ITopAboveNavManager"
             name="esign-faceted-session-info"
-            template="templates/faceted_session_info.pt"
+            template="templates/session_info.pt"
             class=".views.FacetedSessionInfoViewlet"
             permission="zope2.View"
     />
@@ -81,7 +81,7 @@
             manager="plone.app.layout.viewlets.interfaces.IBelowContentTitle"
             view="plone.app.layout.globals.interfaces.IViewView"
             name="esign-item-session-info"
-            template="templates/faceted_session_info.pt"
+            template="templates/session_info.pt"
             class=".views.ItemSessionInfoViewlet"
             permission="imio.esign.ManageSessions"
     /-->

src/imio/esign/browser/table.py

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+from eea.facetednavigation.interfaces import IFacetedNavigable
 from DateTime import DateTime
 from imio.esign import _
 from imio.esign import manage_session_perm
@@ -14,10 +15,18 @@ class IdColumn(Column):
     weight = 10
     cssClasses = {"th": "th_header_sessions_id"}
 
+    def renderHeadCell(self):
+        """
+        Override to add JS that will the "No results" link when displayed in faceted dashboard.
+        """
+        res = super(IdColumn, self).renderHeadCell()
+        if IFacetedNavigable.providedBy(self.context):
+            res += "<script>$('div.table_faceted_results').hide();</script>"
+        return res
+
     def renderCell(self, item):
         # this will hide the "No results" link when displayed in faceted dashboard
-        return "<script>$('div.table_faceted_results').hide();</script>" \
-            "<span id='{0}'>{0}</span>".format(str(item.get("id")))
+        return "<span id='{0}'>{0}</span>".format(str(item.get("id")))
 
 
 def external_session_link(session, title=None):
@@ -104,7 +113,7 @@ def renderCell(self, item):
             u"onclick=\"toggleDetails('collapsible-session-files_{0}', "
             u"toggle_parent_active=true, parent_tag=null, "
             u"load_view='@@esign-session-files?session_id={0}', "
-            u"base_url='{1}');\"> <a href='#'>{2}</a></div>"
+            u"base_url='{1}');\"> {2}</div>"
             u'<div id="collapsible-session-files_{0}" class="collapsible-content" style="display: none;">'
             u'<div class="collapsible-inner-content">'
             u'<img src="{1}/spinner_small.gif" />'
@@ -126,12 +135,11 @@ def renderCell(self, item):
         session_id = item.get("id")
         dashboard_link = self.table.view.get_dashboard_link({"id": session_id})
         sessions_url = self.table.view.get_sessions_url()
-        if not sessions_url.endswith("/"):
-            sessions_url += "/"
+        #if not sessions_url.endswith("/"):
+        #    sessions_url += "/"
         admin_buttons = u"""
         <img title="{delete}" onclick="javascript:confirmDeleteObject(base_url='{sessions_url}', object_uid=null, this,
-        msgName=null, view_name='@@esign-session-delete?esign_session_id={session_id}');
-        window.location.reload();" style="cursor:pointer" src="delete_icon.png">
+        msgName=null, view_name='@@esign-session-delete?esign_session_id={session_id}', redirect=null);" style="cursor:pointer" src="delete_icon.png">
         """.format(
             delete=translate(_("Delete session"), context=self.request),
             sessions_url=sessions_url,

…rowser/templates/faceted_session_info.pt …/esign/browser/templates/session_info.ptsrc/imio/esign/browser/templates/faceted_session_info.pt renamed to src/imio/esign/browser/templates/session_info.pt src/imio/esign/browser/templates/faceted_session_info.pt renamed to src/imio/esign/browser/templates/session_info.pt

@@ -161,7 +161,6 @@ def __call__(self, session_id=None):
 class FacetedSessionInfoViewlet(ViewletBase):
     """Show selected session info inside faceted results."""
 
-    index = ViewPageTemplateFile("templates/faceted_session_info.pt")
     sessions_listing_view = SessionsListingView  # to be overridden in subclass
 
     def available(self):
@@ -195,24 +194,26 @@ def session(self):
         session["id"] = session_id
         return session
 
+    def get_table_rows(self, column):
+        """Get the table rows following the column"""
+        return {1: ["session_id", "state", "update_date", "sealed"],
+                2: ["external_link", "signers"]}.get(column, [])
+
     def ext_session_link(self, session):
         return external_session_link(session)
 
+    @property
+    def session_listing_url(self):
+        return api.portal.get().absolute_url() + "/sessions/@@esign-sessions-listing"
 
-class ItemSessionInfoViewlet(ViewletBase):
-    """Show selected session info for an item."""
 
-    index = ViewPageTemplateFile("templates/faceted_session_info.pt")
+class ItemSessionInfoViewlet(FacetedSessionInfoViewlet):
+    """Show selected session info for an item."""
 
     def available(self):
         """Global availability of the viewlet."""
         return True
 
-    def get_table_rows(self, column):
-        """Get the table rows following the column"""
-        return {1: ["session_id", "state", "update_date", "sealed"],
-                2: ["external_link", "signers"]}.get(column, [])
-
     def render(self):
         """Render the viewlet."""
         if self.session:
@@ -229,14 +230,6 @@ def session(self):
                 return session
         return {}
 
-    @property
-    def session_listing_url(self):
-        return api.portal.get().absolute_url() + "/@@esign-sessions-listing"
-
-    def ext_session_link(self, session):
-        return external_session_link(session)
-# TODO clean up css
-
 
 @implementer(IPublishTraverse)
 class DownloadFileView(BrowserView):

src/imio/esign/browser/views.py

@@ -7,6 +7,7 @@
 from imio.esign.utils import get_file_download_url
 from imio.esign.utils import get_max_download_date
 from imio.esign.utils import get_session_annotation
+from imio.esign.utils import get_session_info
 from imio.esign.utils import remove_context_from_session
 from imio.esign.utils import remove_files_from_session
 from imio.esign.utils import remove_session
@@ -298,6 +299,20 @@ def test_remove_session(self):
         self.assertEqual(len(annot["c_uids"]), 2)
         self.assertEqual(len(annot["sessions"]), 1)
 
+    def test_get_session_info(self):
+        """Test getting info about a given session id."""
+        annot = get_session_annotation()
+        self.assertEqual(len(annot["sessions"]), 0)
+        self.assertIsNone(get_session_info(0))
+        self.assertIsNone(get_session_info(1))
+        self.assertIsNone(get_session_info(2))
+        signers = [
+            ("user1", "user1@sign.com", "User 1", "Position 1"),
+            ("user2", "user2@sign.com", "User 2", "Position 2"),
+        ]
+        sid, session = add_files_to_session(signers, (self.uids[0], self.uids[1]))
+        self.assertEqual(get_session_info(sid), session)
+
     def test_get_file_download_url(self):
         """Test generating file download URL from UID."""
         uid = "f40682caafc045b4b81973bd82ea9ab6"

src/imio/esign/tests/test_utils.py

@@ -30,7 +30,7 @@
 
 
 def add_files_to_session(
-    signers, files_uids, seal=None, acroform=True, session_id=None, title=None, discriminators=(), watchers=()
+    signers, files_uids, seal=None, acroform=True, session_id=None, title=None, discriminators=(), watchers=(), create_session_custom_data={}
 ):
     """Add files to a session with the given signers.
 
@@ -42,6 +42,7 @@ def add_files_to_session(
     :param title: optional string for session title. If it contains {sign_id} or {session_id} it will be replaced
     :param discriminators: optional list of string discriminators to use for session discrimination
     :param watchers: optional list of external esign session watchers emails (used only when creating a new session)
+    :param create_session_custom_data: optional custom dict of custom session data
     :return: session_id, session
     """
     annot = get_session_annotation()
@@ -56,7 +57,8 @@ def add_files_to_session(
     if not session:
         session_id, session = create_session(
             signers, seal, acroform=acroform, title=title or "", annot=annot, discriminators=discriminators,
-            watchers=watchers
+            watchers=watchers,
+            create_session_custom_data=create_session_custom_data,
         )
     existing_files = [path.splitext(f["filename"])[0] for f in session["files"]]
     for uid in files_uids:
@@ -170,7 +172,7 @@ def create_external_session(session_id, b64_cred=None, esign_root_url=None):
     return ret
 
 
-def create_session(signers, seal=False, acroform=True, title=None, annot=None, discriminators=(), watchers=()):
+def create_session(signers, seal=False, acroform=True, title=None, annot=None, discriminators=(), watchers=(), create_session_custom_data={}):
     """Create a session with the given signers and seal.
 
     :param signers: a list of signers, each is a quartet with userid, email, fullname and position text
@@ -180,6 +182,7 @@ def create_session(signers, seal=False, acroform=True, title=None, annot=None, d
     :param annot: esign annotation, if not provided it will be fetched
     :param discriminators: optional list of string discriminators
     :param watchers: optional list of external esign session watchers emails
+    :param create_session_custom_data: optional custom dict of custom session data
     :return: session id and session information
     """
     if not annot:
@@ -208,6 +211,8 @@ def create_session(signers, seal=False, acroform=True, title=None, annot=None, d
         "title": title,
         "returns": PersistentList(),
     })
+    for k, v in create_session_custom_data.items():
+        sessions[session_id][k] = v
     return session_id, sessions[session_id]
 
 
@@ -300,6 +305,17 @@ def get_session_annotation(portal=None):
     return annotations["imio.esign"]
 
 
+def get_session_info(session_id, portal=None):
+    """Return a session info for a given numbering.
+
+    :param session_id: the session id to return
+    :param portal: portal if necessary to get the session annotation
+    """
+    annot = get_session_annotation(portal=portal)
+    if session_id in annot['sessions']:
+        return annot['sessions'][session_id]
+
+
 def remove_context_from_session(context_uids):
     """Remove all files from a session that are linked to the given context UIDs.