feat (SE): add getWLCGTokenPath methods

dirac.cfg

@@ -801,6 +801,7 @@ Resources
       SpaceReservation = LHCb-EOS # Space reservation name if any. Concept like SpaceToken
       ArchiveTimeout = 84600 # Timeout for the FTS archiving
       BringOnlineTimeout = 84600 # Timeout for the bring online operation used by FTS
+      WLCGTokenBasePath = /eos/lhcb # EXPERIMENTAL Path from which the token should be relative to
       # Protocol section, see http://dirac.readthedocs.io/en/latest/AdministratorGuide/Resources/Storages/index.html#available-protocol-plugins
       GFAL2_SRM2
       {

docs/source/AdministratorGuide/Resources/storage.rst

@@ -59,6 +59,7 @@ Configuration options are:
 * ``SpaceReservation``: just a name of a zone of the physical storage which can have some space reserved. Extends the SRM ``SpaceToken`` concept.
 * ``ArchiveTimeout``: for tape SE only. If set to a value in seconds, enables the `FTS Archive Monitoring feature <https://fts3-docs.web.cern.ch/fts3-docs/docs/archive_monitoring.html>`_
 * ``BringOnlineTimeout``: for tape SE only. If set to a value in seconds, specify the BringOnline parameter for FTS transfers. Otherwise, the default is whatever is in the ``FTS3Job`` class.
+* ``WLCGTokenBasePath``: EXPERIMENTAL Path from which the token should be relative to
 
 VO specific paths
 -----------------

src/DIRAC/Resources/Storage/StorageBase.py

@@ -39,6 +39,8 @@
 import shutil
 import tempfile
 
+from pathlib import Path
+
 from DIRAC import S_OK, S_ERROR
 from DIRAC.Core.Utilities.Pfn import pfnparse, pfnunparse
 from DIRAC.Core.Utilities.ReturnValues import returnSingleResult
@@ -462,3 +464,16 @@ def getOccupancy(self, **kwargs):
         finally:
             # Clean the temporary dir
             shutil.rmtree(tmpDirName)
+
+    def getWLCGTokenPath(self, lfn: str, wlcgTokenBasePath: str) -> str:
+        """
+        Returns the path expected to be in a WLCG token
+        It basically consists of ``basepath - tokenBasePath  + LFN``
+        The tokenBasePath is a configuration on the storage side.
+
+        """
+
+        allDict = dict.fromkeys(["Protocol", "Host", "Port", "Path", "FileName", "Options"], "")
+        allDict.update({"Path": self.protocolParameters["Path"], "FileName": lfn.lstrip("/")})
+        fullPath = pfnunparse(allDict)["Value"]
+        return Path(fullPath).relative_to(Path(wlcgTokenBasePath))

src/DIRAC/Resources/Storage/StorageElement.py

@@ -21,7 +21,7 @@
 from DIRAC.Core.Utilities import DErrno
 from DIRAC.Core.Utilities.File import convertSizeUnits
 from DIRAC.Core.Utilities.List import getIndexInList
-from DIRAC.Core.Utilities.ReturnValues import S_OK, S_ERROR, returnSingleResult
+from DIRAC.Core.Utilities.ReturnValues import S_OK, S_ERROR, returnSingleResult, convertToReturnValue
 from DIRAC.Core.Utilities.TimeUtilities import toEpochMilliSeconds
 from DIRAC.Resources.Storage.StorageFactory import StorageFactory
 from DIRAC.Core.Utilities.Pfn import pfnparse
@@ -294,6 +294,7 @@ def __init__(self, name, protocolSections=None, vo=None, hideExceptions=False):
             "isDirectory",
             "isFile",
             "getOccupancy",
+            "getWLCGTokenPath",
         ]
 
         self.okMethods = [
@@ -964,6 +965,25 @@ def getLFNFromURL(self, urls):
     # This is the generic wrapper for file operations
     #
 
+    @convertToReturnValue
+    def getWLCGTokenPath(self, lfn: str):
+        """
+        EXPERIMENTAL
+        return the path to put in the token, relative to the vo path as configured
+        in the storage.
+
+        """
+        wlcgTokenBasePath = self.options.get("WLCGTokenBasePath")
+        if not wlcgTokenBasePath:
+            raise ValueError("WLCGTokenBasePath not configured")
+
+        for storage in self.storages.values():
+            try:
+                return storage.getWLCGTokenPath(lfn, wlcgTokenBasePath)
+            except Exception:
+                continue
+        raise RuntimeError("Could not get WLCGTokenPath")
+
     def getURL(self, lfn, protocol=False, replicaDict=None):
         """execute 'getTransportURL' operation.