Merge remote-tracking branch 'origin/main' into PARAF-359_file_added_to_same_session_again

Author: gbastien

CHANGES.rst

@@ -33,6 +33,11 @@ Changelog
   [chris-adam]
 - Manage file added again to same session, data is updated.
   [gbastien]
+- Configured the `@@remove-from-esign-session` the same way as `@@remove-item-from-esign-session`
+  so relying on an `available` method to show it only if a context is in a session.
+  [gbastien]
+- Fixed faceted viewlet broken because sessions format changed from list to OrderedDict.
+  [gbastien]
 
 1.0a2 (2026-02-06)
 ------------------

src/imio/esign/browser/actions.py

@@ -101,6 +101,11 @@ def get_uid_to_remove(self):
         """ """
         return self.context.UID()
 
+    def available(self):
+        """Defines if the action is available or not."""
+        annot = get_session_annotation()
+        return self.context.UID() in annot.get("c_uids", {})
+
 
 class RemoveItemFromSessionView(BrowserView):
     """View to remove an item from an esign session."""

src/imio/esign/browser/static/add_to_esign_session.png

@@ -1,7 +1,6 @@
 # -*- coding: utf-8 -*-
 
 from AccessControl import Unauthorized
-from copy import deepcopy
 from datetime import datetime
 from datetime import timedelta
 from imio.esign import _
@@ -13,6 +12,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_session_info
 from imio.esign.utils import get_sessions_for
 from imio.esign.utils import get_state_description
 from imio.esign.utils import remove_session
@@ -215,18 +215,21 @@ def render(self):
 
     @property
     def sessions(self):
+        # caching
+        if hasattr(self, "_cached_session"):
+            return self._cached_session
         session_id = self.request.form.get("esign_session_id[]", None)
         try:
             session_id = int(session_id)
         except (TypeError, ValueError):
-            return []
-        sessions = get_session_annotation()["sessions"]
-        session = sessions.get(session_id)
-        if not session:
-            return []
-        session = deepcopy(session)
-        session["id"] = session_id
-        return [session]
+            return {}
+        session = {}
+        session_info = get_session_info(session_id)
+        if session_info:
+            session = {session_id: session_info}
+        # caching
+        self._cached_session = session
+        return session
 
     def get_table_rows(self, column):
         """Get the table rows following the column"""

src/imio/esign/browser/static/document-signed.png

@@ -6,7 +6,7 @@
    <property name="title" i18n:translate="">Add to esign session</property>
    <property name="description" i18n:translate="">This will add this element or configured sub elements to the relevant esign session</property>
    <property name="url_expr">string:${object/absolute_url}/@@add-to-esign-session</property>
-   <property name="icon_expr"></property>
+   <property name="icon_expr">string:$portal_url/++resource++imio.esign/add_to_esign_session.png</property>
    <property name="available_expr"></property>
    <property name="permissions">
     <element value="Manage portal"/>
@@ -17,8 +17,8 @@
    <property name="title" i18n:translate="">Remove from esign session</property>
    <property name="description" i18n:translate="">This will remove this element or configured sub elements from the relevant esign session</property>
    <property name="url_expr">string:${object/absolute_url}/@@remove-from-esign-session</property>
-   <property name="icon_expr"></property>
-   <property name="available_expr"></property>
+   <property name="icon_expr">string:$portal_url/++resource++imio.esign/remove_from_esign_session.png</property>
+   <property name="available_expr">object/@@remove-from-esign-session/available</property>
    <property name="permissions">
     <element value="Manage portal"/>
    </property>
@@ -28,7 +28,7 @@
    <property name="title" i18n:translate="">Remove item from esign session</property>
    <property name="description" i18n:translate="">This will remove this element from the relevant esign session</property>
    <property name="url_expr">string:${object/absolute_url}/@@remove-item-from-esign-session</property>
-   <property name="icon_expr"></property>
+   <property name="icon_expr">string:$portal_url/++resource++imio.esign/remove_item_from_esign_session.png</property>
    <property name="available_expr">object/@@remove-item-from-esign-session/available</property>
    <property name="permissions">
     <element value="Manage portal"/>

src/imio/esign/browser/static/remove_from_esign_session.png

@@ -17,8 +17,8 @@
 import unittest
 
 
-class TestRemoveItemFromSessionView(unittest.TestCase):
-    """Test RemoveItemFromSessionView browser view."""
+class BaseRemoveFromSession(unittest.TestCase):
+    """Base class to centralize setUp."""
 
     layer = IMIO_ESIGN_INTEGRATION_TESTING
 
@@ -73,6 +73,10 @@ def setUp(self):
                 self.annexes.append(annex)
         self.signers = [("user1", "user1@sign.com", "User 1", "Position 1")]
 
+
+class TestRemoveItemFromSessionView(BaseRemoveFromSession):
+    """Test RemoveItemFromSessionView browser view."""
+
     def test_available(self):
         """Test available method returns True."""
         view = getMultiAdapter((self.annexes[0], self.request), name="remove-item-from-esign-session")
@@ -124,3 +128,27 @@ 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 TestRemoveFromSessionView(BaseRemoveFromSession):
+    """Test RemoveFromSessionView browser view."""
+
+    def test_available(self):
+        """Test available method returns True."""
+        annot = get_session_annotation()
+        self.assertFalse(annot["sessions"])
+        # only available on "context_uid"
+        annex = self.annexes[0]
+        view = getMultiAdapter((annex, self.request), name="remove-from-esign-session")
+        self.assertFalse(view.available())
+        add_files_to_session(self.signers, [annex.UID()])
+        self.assertTrue(annot["sessions"])
+        self.assertFalse(view.available())
+        # available on parent
+        folder = annex.aq_parent
+        view = getMultiAdapter((folder, self.request), name="remove-from-esign-session")
+        self.assertTrue(view.available())
+        # call the view so context is removed so no more session
+        view()
+        self.assertFalse(annot["sessions"])
+        self.assertFalse(view.available())

src/imio/esign/browser/static/remove_item_from_esign_session.png

@@ -555,9 +555,9 @@ 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))
+        self.assertEqual(get_session_info(0), {})
+        self.assertEqual(get_session_info(1), {})
+        self.assertEqual(get_session_info(2), {})
         signers = [
             ("user1", "user1@sign.com", "User 1", "Position 1"),
             ("user2", "user2@sign.com", "User 2", "Position 2"),