Added utils.get_file_uid_url method and added download domain registry config

Author: sgeulette

checkouts.cfg

@@ -3,6 +3,7 @@ always-checkout = force
 auto-checkout +=
     imio.annex
     imio.helpers
+    imio.pyutils
 
 [remotes]
 imio = https://github.com/imio
@@ -20,4 +21,4 @@ collective_push = git@github.com:collective
 [sources]
 imio.annex = git ${remotes:imio}/imio.annex.git pushurl=${remotes:imio_push}/imio.annex.git
 imio.helpers = git ${remotes:imio}/imio.helpers.git pushurl=${remotes:imio_push}/imio.helpers.git
-
+imio.pyutils = git ${remotes:imio}/imio.pyutils.git pushurl=${remotes:imio_push}/imio.pyutils.git

src/imio/esign/browser/settings.py

@@ -45,6 +45,12 @@ class IImioEsignSettings(Interface):
         required=True,
     )
 
+    file_url = schema.URI(
+        title=_("File URL download domain"),
+        description=_("URL domain where the file can be donwloaded."),
+        required=False,
+    )
+
     seal_code = schema.TextLine(
         title=_("Seal code"),
         description=_("Seal code given by eidas provider."),

src/imio/esign/tests/test_utils.py

@@ -2,10 +2,12 @@
 """utils tests for this package."""
 from imio.esign.testing import IMIO_ESIGN_INTEGRATION_TESTING  # noqa: E501
 from imio.esign.utils import add_files_to_session
+from imio.esign.utils import get_file_uid_url
 from imio.esign.utils import get_session_annotation
 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
+from imio.pyutils.utils import shortuid_decode_id
 from plone import api
 from plone.app.testing import setRoles
 from plone.app.testing import TEST_USER_ID
@@ -293,6 +295,33 @@ def test_remove_session(self):
         self.assertEqual(len(annot["c_uids"]), 2)
         self.assertEqual(len(annot["sessions"]), 1)
 
+    def test_get_file_uid_url(self):
+        """Test generating file download URL from UID."""
+        uid = "f40682caafc045b4b81973bd82ea9ab6"
+        # Test error when no root_url is configured
+        with self.assertRaises(Exception) as cm:
+            get_file_uid_url(uid)
+        self.assertIn("No root URL provided", str(cm.exception))
+
+        api.portal.set_registry_record("imio.esign.file_url", "https://downloads.files.com")
+
+        result = get_file_uid_url(uid)
+        self.assertEqual(result, "https://downloads.files.com/Rzgwy-9BVG9-viEts-5GBkn-Rm")
+
+        result = get_file_uid_url(uid, separator="_", block_size=3)
+        self.assertEqual(result, "https://downloads.files.com/Rzg_wy9_BVG_9vi_Ets_5GB_knR_m")
+
+        custom_url = "https://custom.domain.org/"
+        result = get_file_uid_url(uid, root_url=custom_url)
+        self.assertEqual(result, "https://custom.domain.org/Rzgwy-9BVG9-viEts-5GBkn-Rm")
+
+        # Test with another UID to verify encoding works
+        uid2 = self.uids[0]
+        result2 = get_file_uid_url(uid2)
+        self.assertTrue(result2.startswith("https://downloads.files.com/"))
+        suid = result2[len("https://downloads.files.com/") :]
+        self.assertEqual(shortuid_decode_id(suid, separator="-"), uid2)  # correctly decoded
+
 
 # example of annotation content
 """

src/imio/esign/utils.py

@@ -8,6 +8,7 @@
 from imio.helpers.content import uuidToObject
 from imio.helpers.transmogrifier import get_correct_id
 from imio.pyutils.system import post_request
+from imio.pyutils.utils import shortuid_encode_id
 from os import path
 from persistent.list import PersistentList
 from persistent.mapping import PersistentMapping
@@ -376,3 +377,21 @@ def remove_session(session_id):
 
     del sessions[session_id]
     # logger.info("Session %s removed", session_id)
+
+
+def get_file_uid_url(uid, separator="-", block_size=5, root_url=None):
+    """Get the file download URL for a given file UID.
+
+    :param uid: file UID
+    :param separator: separator used in short UID encoding
+    :param block_size: block size used in short UID encoding
+    :param root_url: root URL. If not provided, the settings value is used
+    :return: file download URL
+    """
+    if not root_url:
+        root_url = api.portal.get_registry_record("imio.esign.file_url", default="")
+
+    if not root_url:
+        raise Exception("No root URL provided for file download url.")
+    short_uid = shortuid_encode_id(uid, separator=separator, block_size=block_size)
+    return "{}/{}".format(root_url.strip('/'), short_uid)