Added field "Enabled?" to settings so it is possible to rely on a value for globally enabling eSign

Author: gbastien

src/imio/esign/browser/settings.py

@@ -1,7 +1,10 @@
 # -*- coding: utf-8 -*-
+
 from imio.esign import _
+from plone import api
 from plone.app.registry.browser.controlpanel import ControlPanelFormWrapper
 from plone.app.registry.browser.controlpanel import RegistryEditForm
+from plone.registry.interfaces import IRecordModifiedEvent
 from plone.z3cform import layout
 from zope import schema
 from zope.interface import Interface
@@ -38,6 +41,12 @@ def validate_vat_number(va_nb):
 
 class IImioEsignSettings(Interface):
 
+    enabled = schema.Bool(
+        title=_("Enabled?"),
+        description=_("Is the eSign service enabled?"),
+        default=True,
+    )
+
     vat_number = schema.TextLine(
         title=_("VAT number"),
         description=_("VAT number used for esign billing (BE0123456789)."),
@@ -79,3 +88,18 @@ class ImioEsignSettings(RegistryEditForm):
 ImioEsignSettingsView = layout.wrap_form(
     ImioEsignSettings, ControlPanelFormWrapper
 )
+
+
+def detect_settings_changed(event):
+    """
+        Manage our record changes
+    """
+    if IRecordModifiedEvent.providedBy(event) and event.record.interface == IImioEsignSettings:
+        new_value = event.newValue
+        if event.record.fieldName == 'enabled':
+            portal = api.portal.get()
+            # hide "sessions" link from navigation depending on eSign enable or not
+            if new_value is True:
+                portal.get('sessions').setExcludeFromNav(False)
+            else:
+                portal.get('sessions').setExcludeFromNav(True)

src/imio/esign/configure.zcml

@@ -44,6 +44,10 @@
   <adapter for="*"
     factory=".adapters.FilesBelongingToAGivenSession"
     provides="collective.compoundcriterion.interfaces.ICompoundCriterionFilter"
-    name="files-belonging-to-a-given-session"/>
+    name="files-belonging-to-a-given-session" />
+
+  <subscriber
+      for="plone.registry.interfaces.IRecordModifiedEvent"
+      handler=".browser.settings.detect_settings_changed" />
 
 </configure>

src/imio/esign/locales/en/LC_MESSAGES/imio.esign.po

@@ -1,7 +1,7 @@
 msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
-"POT-Creation-Date: 2026-01-09 12:23+0000\n"
+"POT-Creation-Date: 2026-01-16 12:42+0000\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI +ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
@@ -15,7 +15,7 @@ msgstr ""
 "Domain: imio.dashboard\n"
 "X-is-fallback-for: en-au en-ca en-gb en-us\n"
 
-#: ../browser/views.py:258
+#: ../browser/views.py:259
 msgid "A file identifier must be passed in the url !"
 msgstr ""
 
@@ -43,23 +43,27 @@ msgstr ""
 msgid "Email"
 msgstr ""
 
-#: ../browser/settings.py:62
+#: ../browser/settings.py:71
 msgid "Email of the eidas provider account containing the seal image."
 msgstr ""
 
-#: ../browser/views.py:152
+#: ../browser/settings.py:45
+msgid "Enabled?"
+msgstr ""
+
+#: ../browser/views.py:153
 msgid "Error while sending session: ${error}"
 msgstr ""
 
 #: ../browser/templates/faceted_session_info.pt:52
 msgid "External session"
 msgstr ""
 
-#: ../browser/views.py:149
+#: ../browser/views.py:150
 msgid "External session sent successfully!"
 msgstr ""
 
-#: ../browser/settings.py:49
+#: ../browser/settings.py:58
 msgid "File URL download domain"
 msgstr ""
 
@@ -75,7 +79,7 @@ msgstr ""
 msgid "ID"
 msgstr ""
 
-#: ../browser/settings.py:76
+#: ../browser/settings.py:85
 #: ../profiles/default/controlpanel.xml
 msgid "Imio Esign Settings"
 msgstr ""
@@ -84,10 +88,14 @@ msgstr ""
 msgid "Installs the imio.esign add-on."
 msgstr ""
 
-#: ../browser/settings.py:34
+#: ../browser/settings.py:37
 msgid "Invalid VAT number: checksum verification failed"
 msgstr ""
 
+#: ../browser/settings.py:46
+msgid "Is the eSign service enabled?"
+msgstr ""
+
 #: ../browser/table.py:57
 #: ../browser/templates/faceted_session_info.pt:30
 msgid "Last update"
@@ -101,11 +109,11 @@ msgstr ""
 msgid "No"
 msgstr ""
 
-#: ../browser/views.py:144
+#: ../browser/views.py:145
 msgid "No seal code defined in configuration ! Session ${id} not sent."
 msgstr ""
 
-#: ../browser/views.py:108
+#: ../browser/views.py:109
 msgid "No session ID provided!"
 msgstr ""
 
@@ -125,15 +133,15 @@ msgstr ""
 msgid "Remove from esign session"
 msgstr ""
 
-#: ../browser/settings.py:55
+#: ../browser/settings.py:64
 msgid "Seal code"
 msgstr ""
 
-#: ../browser/settings.py:56
+#: ../browser/settings.py:65
 msgid "Seal code given by eidas provider."
 msgstr ""
 
-#: ../browser/settings.py:61
+#: ../browser/settings.py:70
 msgid "Seal email"
 msgstr ""
 
@@ -149,39 +157,39 @@ msgstr ""
 msgid "Session ID"
 msgstr ""
 
-#: ../browser/views.py:115
+#: ../browser/views.py:116
 msgid "Session deleted successfully!"
 msgstr ""
 
 #: ../browser/templates/faceted_session_info.pt:11
 msgid "Session information : ${title}"
 msgstr ""
 
-#: ../browser/views.py:117
+#: ../browser/views.py:118
 msgid "Session not found!"
 msgstr ""
 
 #: ../browser/views.py:137
 msgid "Session not yet sent."
 msgstr ""
 
-#: ../browser/views.py:138
+#: ../browser/views.py:139
 msgid "Session with ID ${id} doesn't exist anymore !"
 msgstr ""
 
-#: ../browser/settings.py:67
+#: ../browser/settings.py:76
 msgid "Sign code"
 msgstr ""
 
-#: ../browser/settings.py:68
+#: ../browser/settings.py:77
 msgid "Sign code used to specify sign method. Keep empty to use default method."
 msgstr ""
 
 #: ../browser/views.py:139
 msgid "Sign url not yet received."
 msgstr ""
 
-#: ../browser/views.py:310
+#: ../browser/views.py:311
 msgid "Signed file download"
 msgstr ""
 
@@ -199,19 +207,19 @@ msgstr ""
 msgid "Status"
 msgstr ""
 
-#: ../browser/views.py:286
+#: ../browser/views.py:287
 msgid "The corresponding file content cannot be retrieved (${uid}) !"
 msgstr ""
 
-#: ../browser/views.py:266
+#: ../browser/views.py:267
 msgid "The corresponding file identifier cannot be retrieved (${uid}) !"
 msgstr ""
 
-#: ../browser/views.py:278
+#: ../browser/views.py:279
 msgid "The download period for this file has expired (was ${valid_date}) !"
 msgstr ""
 
-#: ../browser/views.py:262
+#: ../browser/views.py:263
 msgid "This file identifier is not correct !"
 msgstr ""
 
@@ -227,31 +235,31 @@ msgstr ""
 msgid "Title"
 msgstr ""
 
-#: ../browser/settings.py:50
+#: ../browser/settings.py:59
 msgid "URL domain where the file can be donwloaded."
 msgstr ""
 
 #: ../configure.zcml:32
 msgid "Uninstalls the imio.esign add-on."
 msgstr ""
 
-#: ../browser/settings.py:42
+#: ../browser/settings.py:51
 msgid "VAT number"
 msgstr ""
 
-#: ../browser/settings.py:22
+#: ../browser/settings.py:25
 msgid "VAT number must be 12 characters (BE + 10 digits)"
 msgstr ""
 
-#: ../browser/settings.py:26
+#: ../browser/settings.py:29
 msgid "VAT number must contain 10 digits after 'BE'"
 msgstr ""
 
-#: ../browser/settings.py:19
+#: ../browser/settings.py:22
 msgid "VAT number must start with 'BE'"
 msgstr ""
 
-#: ../browser/settings.py:43
+#: ../browser/settings.py:52
 msgid "VAT number used for esign billing (BE0123456789)."
 msgstr ""