class StorageElementItem(object):
"""
.. class:: StorageElement
common interface to the grid storage element
self.name is the resolved name of the StorageElement i.e CERN-tape
self.options is dictionary containing the general options defined in the CS e.g. self.options['Backend] = 'Castor2'
self.storages is a list of the stub objects created by StorageFactory for the protocols found in the CS.
self.localPlugins is a list of the local protocols that were created by StorageFactory
self.remotePlugins is a list of the remote protocols that were created by StorageFactory
self.protocolOptions is a list of dictionaries containing the options found in the CS. (should be removed)
dynamic method :
retransferOnlineFile( lfn )
exists( lfn )
isFile( lfn )
getFile( lfn, localPath = False )
putFile( lfnLocal, sourceSize = 0 ) : {lfn:local}
replicateFile( lfn, sourceSize = 0 )
getFileMetadata( lfn )
getFileSize( lfn )
removeFile( lfn )
prestageFile( lfn, lifetime = 86400 )
prestageFileStatus( lfn )
pinFile( lfn, lifetime = 60 * 60 * 24 )
releaseFile( lfn )
isDirectory( lfn )
getDirectoryMetadata( lfn )
getDirectorySize( lfn )
listDirectory( lfn )
removeDirectory( lfn, recursive = False )
createDirectory( lfn )
putDirectory( lfn )
getDirectory( lfn, localPath = False )
"""
__deprecatedArguments = ["singleFile", "singleDirectory"
] # Arguments that are now useless
# Some methods have a different name in the StorageElement and the plugins...
# We could avoid this static list in the __getattr__ by checking the storage plugin and so on
# but fine... let's not be too smart, otherwise it becomes unreadable :-)
__equivalentMethodNames = {
"exists": "exists",
"isFile": "isFile",
"getFile": "getFile",
"putFile": "putFile",
"replicateFile": "putFile",
"getFileMetadata": "getFileMetadata",
"getFileSize": "getFileSize",
"removeFile": "removeFile",
"prestageFile": "prestageFile",
"prestageFileStatus": "prestageFileStatus",
"pinFile": "pinFile",
"releaseFile": "releaseFile",
"isDirectory": "isDirectory",
"getDirectoryMetadata": "getDirectoryMetadata",
"getDirectorySize": "getDirectorySize",
"listDirectory": "listDirectory",
"removeDirectory": "removeDirectory",
"createDirectory": "createDirectory",
"putDirectory": "putDirectory",
"getDirectory": "getDirectory",
}
# We can set default argument in the __executeFunction which impacts all plugins
__defaultsArguments = {
"putFile": {
"sourceSize": 0
},
"getFile": {
"localPath": False
},
"prestageFile": {
"lifetime": 86400
},
"pinFile": {
"lifetime": 60 * 60 * 24
},
"removeDirectory": {
"recursive": False
},
"getDirectory": {
"localPath": False
},
}
def __init__(self, name, plugins=None, vo=None, hideExceptions=False):
""" c'tor
:param str name: SE name
:param list plugins: requested storage plugins
:param: vo
"""
self.methodName = None
if vo:
self.vo = vo
else:
result = getVOfromProxyGroup()
if not result['OK']:
return
self.vo = result['Value']
self.opHelper = Operations(vo=self.vo)
# These things will soon have to go as well. 'AccessProtocol.1' is all but flexible.
proxiedProtocols = gConfig.getValue(
'/LocalSite/StorageElements/ProxyProtocols', "").split(',')
self.useProxy = (gConfig.getValue(
"/Resources/StorageElements/%s/AccessProtocol.1/Protocol" % name,
"UnknownProtocol") in proxiedProtocols)
if not self.useProxy:
self.useProxy = gConfig.getValue(
'/LocalSite/StorageElements/%s/UseProxy' % name, False)
if not self.useProxy:
self.useProxy = self.opHelper.getValue(
'/Services/StorageElements/%s/UseProxy' % name, False)
self.valid = True
if plugins == None:
res = StorageFactory(useProxy=self.useProxy,
vo=self.vo).getStorages(
name,
pluginList=[],
hideExceptions=hideExceptions)
else:
res = StorageFactory(useProxy=self.useProxy,
vo=self.vo).getStorages(
name,
pluginList=plugins,
hideExceptions=hideExceptions)
if not res['OK']:
self.valid = False
self.name = name
self.errorReason = res['Message']
else:
factoryDict = res['Value']
self.name = factoryDict['StorageName']
self.options = factoryDict['StorageOptions']
self.localPlugins = factoryDict['LocalPlugins']
self.remotePlugins = factoryDict['RemotePlugins']
self.storages = factoryDict['StorageObjects']
self.protocolOptions = factoryDict['ProtocolOptions']
self.turlProtocols = factoryDict['TurlProtocols']
for storage in self.storages:
storage.setStorageElement(self)
self.log = gLogger.getSubLogger("SE[%s]" % self.name)
if self.valid:
self.useCatalogURL = gConfig.getValue(
'/Resources/StorageElements/%s/UseCatalogURL' % self.name,
False)
self.log.debug("useCatalogURL: %s" % self.useCatalogURL)
self.__dmsHelper = DMSHelpers(vo=vo)
# Allow SE to overwrite general operation config
accessProto = self.options.get('AccessProtocols')
self.localAccessProtocolList = accessProto if accessProto else self.__dmsHelper.getAccessProtocols(
)
self.log.debug("localAccessProtocolList %s" %
self.localAccessProtocolList)
writeProto = self.options.get('WriteProtocols')
self.localWriteProtocolList = writeProto if writeProto else self.__dmsHelper.getWriteProtocols(
)
self.log.debug("localWriteProtocolList %s" %
self.localWriteProtocolList)
# 'getTransportURL',
self.readMethods = [
'getFile', 'prestageFile', 'prestageFileStatus', 'getDirectory'
]
self.writeMethods = [
'retransferOnlineFile', 'putFile', 'replicateFile', 'pinFile',
'releaseFile', 'createDirectory', 'putDirectory'
]
self.removeMethods = ['removeFile', 'removeDirectory']
self.checkMethods = [
'exists',
'getDirectoryMetadata',
'getDirectorySize',
'getFileSize',
'getFileMetadata',
'listDirectory',
'isDirectory',
'isFile',
]
self.okMethods = [
'getLocalProtocols', 'getProtocols', 'getRemoteProtocols',
'getStorageElementName', 'getStorageParameters', 'getTransportURL',
'isLocalSE'
]
self.__fileCatalog = None
def dump(self):
""" Dump to the logger a summary of the StorageElement items. """
log = self.log.getSubLogger('dump', True)
log.verbose("Preparing dump for StorageElement %s." % self.name)
if not self.valid:
log.debug("Failed to create StorageElement plugins.",
self.errorReason)
return
i = 1
outStr = "\n\n============ Options ============\n"
for key in sorted(self.options):
outStr = "%s%s: %s\n" % (outStr, key.ljust(15), self.options[key])
for storage in self.storages:
outStr = "%s============Protocol %s ============\n" % (outStr, i)
storageParameters = storage.getParameters()
for key in sorted(storageParameters):
outStr = "%s%s: %s\n" % (outStr, key.ljust(15),
storageParameters[key])
i = i + 1
log.verbose(outStr)
#################################################################################################
#
# These are the basic get functions for storage configuration
#
def getStorageElementName(self):
""" SE name getter """
self.log.getSubLogger('getStorageElementName').verbose(
"The Storage Element name is %s." % self.name)
return S_OK(self.name)
def getChecksumType(self):
""" get local /Resources/StorageElements/SEName/ChecksumType option if defined, otherwise
global /Resources/StorageElements/ChecksumType
"""
self.log.getSubLogger('getChecksumType').verbose(
"get checksum type for %s." % self.name)
return S_OK(
str(
gConfig.getValue("/Resources/StorageElements/ChecksumType",
"ADLER32")).upper() if "ChecksumType" not in
self.options else str(self.options["ChecksumType"]).upper())
def getStatus(self):
"""
Return Status of the SE, a dictionary with:
* Read: True (is allowed), False (it is not allowed)
* Write: True (is allowed), False (it is not allowed)
* Remove: True (is allowed), False (it is not allowed)
* Check: True (is allowed), False (it is not allowed).
.. note:: Check is always allowed IF Read is allowed (regardless of what set in the Check option of the configuration)
* DiskSE: True if TXDY with Y > 0 (defaults to True)
* TapeSE: True if TXDY with X > 0 (defaults to False)
* TotalCapacityTB: float (-1 if not defined)
* DiskCacheTB: float (-1 if not defined)
"""
self.log.getSubLogger('getStatus').verbose(
"determining status of %s." % self.name)
retDict = {}
if not self.valid:
retDict['Read'] = False
retDict['Write'] = False
retDict['Remove'] = False
retDict['Check'] = False
retDict['DiskSE'] = False
retDict['TapeSE'] = False
retDict['TotalCapacityTB'] = -1
retDict['DiskCacheTB'] = -1
return S_OK(retDict)
# If nothing is defined in the CS Access is allowed
# If something is defined, then it must be set to Active
retDict['Read'] = not ('ReadAccess' in self.options
and self.options['ReadAccess']
not in ('Active', 'Degraded'))
retDict['Write'] = not ('WriteAccess' in self.options
and self.options['WriteAccess']
not in ('Active', 'Degraded'))
retDict['Remove'] = not ('RemoveAccess' in self.options
and self.options['RemoveAccess']
not in ('Active', 'Degraded'))
if retDict['Read']:
retDict['Check'] = True
else:
retDict['Check'] = not ('CheckAccess' in self.options
and self.options['CheckAccess']
not in ('Active', 'Degraded'))
diskSE = True
tapeSE = False
if 'SEType' in self.options:
# Type should follow the convention TXDY
seType = self.options['SEType']
diskSE = re.search('D[1-9]', seType) != None
tapeSE = re.search('T[1-9]', seType) != None
retDict['DiskSE'] = diskSE
retDict['TapeSE'] = tapeSE
try:
retDict['TotalCapacityTB'] = float(self.options['TotalCapacityTB'])
except Exception:
retDict['TotalCapacityTB'] = -1
try:
retDict['DiskCacheTB'] = float(self.options['DiskCacheTB'])
except Exception:
retDict['DiskCacheTB'] = -1
return S_OK(retDict)
def isValid(self, operation=''):
""" check CS/RSS statuses for :operation:
:param str operation: operation name
"""
log = self.log.getSubLogger('isValid', True)
log.verbose("Determining if the StorageElement %s is valid for VO %s" %
(self.name, self.vo))
if not self.valid:
log.debug("Failed to create StorageElement plugins.",
self.errorReason)
return S_ERROR(
"SE.isValid: Failed to create StorageElement plugins: %s" %
self.errorReason)
# Check if the Storage Element is eligible for the user's VO
if 'VO' in self.options and not self.vo in self.options['VO']:
log.debug("StorageElement is not allowed for VO", self.vo)
return S_ERROR(
errno.EACCES,
"StorageElement.isValid: StorageElement is not allowed for VO")
log.verbose("Determining if the StorageElement %s is valid for %s" %
(self.name, operation))
if (not operation) or (operation in self.okMethods):
return S_OK()
# Determine whether the StorageElement is valid for checking, reading, writing
res = self.getStatus()
if not res['OK']:
log.debug("Could not call getStatus", res['Message'])
return S_ERROR("SE.isValid could not call the getStatus method")
checking = res['Value']['Check']
reading = res['Value']['Read']
writing = res['Value']['Write']
removing = res['Value']['Remove']
# Determine whether the requested operation can be fulfilled
if (not operation) and (not reading) and (not writing) and (
not checking):
log.debug("Read, write and check access not permitted.")
return S_ERROR(
errno.EACCES,
"SE.isValid: Read, write and check access not permitted.")
# The supplied operation can be 'Read','Write' or any of the possible StorageElement methods.
if (operation in self.readMethods) or (operation.lower()
in ('read', 'readaccess')):
operation = 'ReadAccess'
elif operation in self.writeMethods or (operation.lower()
in ('write', 'writeaccess')):
operation = 'WriteAccess'
elif operation in self.removeMethods or (operation.lower()
in ('remove',
'removeaccess')):
operation = 'RemoveAccess'
elif operation in self.checkMethods or (operation.lower()
in ('check', 'checkaccess')):
operation = 'CheckAccess'
else:
log.debug("The supplied operation is not known.", operation)
return S_ERROR(DErrno.ENOMETH,
"SE.isValid: The supplied operation is not known.")
log.debug("check the operation: %s " % operation)
# Check if the operation is valid
if operation == 'CheckAccess':
if not reading:
if not checking:
log.debug("Check access not currently permitted.")
return S_ERROR(
errno.EACCES,
"SE.isValid: Check access not currently permitted.")
if operation == 'ReadAccess':
if not reading:
log.debug("Read access not currently permitted.")
return S_ERROR(
errno.EACCES,
"SE.isValid: Read access not currently permitted.")
if operation == 'WriteAccess':
if not writing:
log.debug("Write access not currently permitted.")
return S_ERROR(
errno.EACCES,
"SE.isValid: Write access not currently permitted.")
if operation == 'RemoveAccess':
if not removing:
log.debug("Remove access not currently permitted.")
return S_ERROR(
errno.EACCES,
"SE.isValid: Remove access not currently permitted.")
return S_OK()
def getPlugins(self):
""" Get the list of all the plugins defined for this Storage Element
"""
self.log.getSubLogger('getPlugins').verbose(
"Obtaining all plugins of %s." % self.name)
if not self.valid:
return S_ERROR(self.errorReason)
allPlugins = self.localPlugins + self.remotePlugins
return S_OK(allPlugins)
def getRemotePlugins(self):
""" Get the list of all the remote access protocols defined for this Storage Element
"""
self.log.getSubLogger('getRemotePlugins').verbose(
"Obtaining remote protocols for %s." % self.name)
if not self.valid:
return S_ERROR(self.errorReason)
return S_OK(self.remotePlugins)
def getLocalPlugins(self):
""" Get the list of all the local access protocols defined for this Storage Element
"""
self.log.getSubLogger('getLocalPlugins').verbose(
"Obtaining local protocols for %s." % self.name)
if not self.valid:
return S_ERROR(self.errorReason)
return S_OK(self.localPlugins)
def getStorageParameters(self, plugin=None, protocol=None):
""" Get plugin specific options
:param plugin : plugin we are interested in
:param protocol: protocol we are interested in
Either plugin or protocol can be defined, not both, but at least one of them
"""
# both set
if plugin and protocol:
return S_ERROR(errno.EINVAL,
"plugin and protocol cannot be set together.")
# both None
elif not (plugin or protocol):
return S_ERROR(errno.EINVAL,
"plugin and protocol cannot be None together.")
log = self.log.getSubLogger('getStorageParameters')
reqStr = "plugin %s" % plugin if plugin else "protocol %s" % protocol
log.verbose("Obtaining storage parameters for %s for %s." %
(self.name, reqStr))
for storage in self.storages:
storageParameters = storage.getParameters()
if plugin and storageParameters['PluginName'] == plugin:
return S_OK(storageParameters)
elif protocol and storageParameters['Protocol'] == protocol:
return S_OK(storageParameters)
errStr = "Requested plugin or protocol not available."
log.debug(errStr, "%s for %s" % (reqStr, self.name))
return S_ERROR(errStr)
def __getAllProtocols(self, protoType):
""" Returns the list of all protocols for Input or Output
:param proto = InputProtocols or OutputProtocols
"""
return set(
reduce(lambda x, y: x + y, [
plugin.protocolParameters[protoType]
for plugin in self.storages
]))
def _getAllInputProtocols(self):
""" Returns all the protocols supported by the SE for Input
"""
return self.__getAllProtocols('InputProtocols')
def _getAllOutputProtocols(self):
""" Returns all the protocols supported by the SE for Output
"""
return self.__getAllProtocols('OutputProtocols')
def negociateProtocolWithOtherSE(self, sourceSE, protocols=None):
""" Negotiate what protocol could be used for a third party transfer
between the sourceSE and ourselves. If protocols is given,
the chosen protocol has to be among those
:param sourceSE : storageElement instance of the sourceSE
:param protocols: ordered protocol restriction list
:return: a list protocols that fits the needs, or None
"""
# No common protocols if this is a proxy storage
if self.useProxy:
return S_OK([])
log = self.log.getSubLogger('negociateProtocolWithOtherSE', child=True)
log.debug("Negociating protocols between %s and %s (protocols %s)" %
(sourceSE.name, self.name, protocols))
# Take all the protocols the destination can accept as input
destProtocols = self._getAllInputProtocols()
log.debug("Destination input protocols %s" % destProtocols)
# Take all the protocols the source can provide
sourceProtocols = sourceSE._getAllOutputProtocols()
log.debug("Source output protocols %s" % sourceProtocols)
commonProtocols = destProtocols & sourceProtocols
# If a restriction list is defined
# take the intersection, and sort the commonProtocols
# based on the protocolList order
if protocols:
protocolList = list(protocols)
commonProtocols = sorted(
commonProtocols & set(protocolList),
key=lambda x: self.__getIndexInList(x, protocolList))
log.debug("Common protocols %s" % commonProtocols)
return S_OK(list(commonProtocols))
#################################################################################################
#
# These are the basic get functions for lfn manipulation
#
def __getURLPath(self, url):
""" Get the part of the URL path below the basic storage path.
This path must coincide with the LFN of the file in order to be compliant with the DIRAC conventions.
"""
log = self.log.getSubLogger('__getURLPath')
log.verbose("Getting path from url in %s." % self.name)
if not self.valid:
return S_ERROR(self.errorReason)
res = pfnparse(url)
if not res['OK']:
return res
fullURLPath = '%s/%s' % (res['Value']['Path'],
res['Value']['FileName'])
# Check all available storages and check whether the url is for that protocol
urlPath = ''
for storage in self.storages:
res = storage.isNativeURL(url)
if res['OK']:
if res['Value']:
parameters = storage.getParameters()
saPath = parameters['Path']
if not saPath:
# If the sa path doesn't exist then the url path is the entire string
urlPath = fullURLPath
else:
if re.search(saPath, fullURLPath):
# Remove the sa path from the fullURLPath
urlPath = fullURLPath.replace(saPath, '')
if urlPath:
return S_OK(urlPath)
# This should never happen. DANGER!!
errStr = "Failed to get the url path for any of the protocols!!"
log.debug(errStr)
return S_ERROR(errStr)
def getLFNFromURL(self, urls):
""" Get the LFN from the PFNS .
:param lfn : input lfn or lfns (list/dict)
"""
result = checkArgumentFormat(urls)
if result['OK']:
urlDict = result['Value']
else:
errStr = "Supplied urls must be string, list of strings or a dictionary."
self.log.getSubLogger('getLFNFromURL').debug(errStr)
return S_ERROR(errno.EINVAL, errStr)
retDict = {"Successful": {}, "Failed": {}}
for url in urlDict:
res = self.__getURLPath(url)
if res["OK"]:
retDict["Successful"][url] = res["Value"]
else:
retDict["Failed"][url] = res["Message"]
return S_OK(retDict)
###########################################################################################
#
# This is the generic wrapper for file operations
#
def getURL(self, lfn, protocol=False, replicaDict=None):
""" execute 'getTransportURL' operation.
:param str lfn: string, list or dictionary of lfns
:param protocol: if no protocol is specified, we will request self.turlProtocols
:param replicaDict: optional results from the File Catalog replica query
"""
self.log.getSubLogger('getURL').verbose(
"Getting accessUrl %s for lfn in %s." %
("(%s)" % protocol if protocol else "", self.name))
if not protocol:
# This turlProtocols seems totally useless.
# Get ride of it when gfal2 is totally ready
# and replace it with the localAccessProtocol list
protocols = self.turlProtocols
elif isinstance(protocol, list):
protocols = protocol
elif isinstance(protocol, basestring):
protocols = [protocol]
self.methodName = "getTransportURL"
result = self.__executeMethod(lfn, protocols=protocols)
return result
def __isLocalSE(self):
""" Test if the Storage Element is local in the current context
"""
self.log.getSubLogger('LocalSE').verbose(
"Determining whether %s is a local SE." % self.name)
import DIRAC
localSEs = getSEsForSite(DIRAC.siteName())['Value']
if self.name in localSEs:
return S_OK(True)
else:
return S_OK(False)
def __getFileCatalog(self):
if not self.__fileCatalog:
self.__fileCatalog = FileCatalog(vo=self.vo)
return self.__fileCatalog
def __generateURLDict(self, lfns, storage, replicaDict=None):
""" Generates a dictionary (url : lfn ), where the url are constructed
from the lfn using the constructURLFromLFN method of the storage plugins.
:param: lfns : dictionary {lfn:whatever}
:returns dictionary {constructed url : lfn}
"""
log = self.log.getSubLogger("__generateURLDict")
log.verbose("generating url dict for %s lfn in %s." %
(len(lfns), self.name))
if not replicaDict:
replicaDict = {}
urlDict = {} # url : lfn
failed = {} # lfn : string with errors
for lfn in lfns:
if self.useCatalogURL:
# Is this self.name alias proof?
url = replicaDict.get(lfn, {}).get(self.name, '')
if url:
urlDict[url] = lfn
continue
else:
fc = self.__getFileCatalog()
result = fc.getReplicas()
if not result['OK']:
failed[lfn] = result['Message']
url = result['Value']['Successful'].get(lfn, {}).get(
self.name, '')
if not url:
failed[lfn] = 'Failed to get catalog replica'
else:
# Update the URL according to the current SE description
result = returnSingleResult(storage.updateURL(url))
if not result['OK']:
failed[lfn] = result['Message']
else:
urlDict[result['Value']] = lfn
else:
result = storage.constructURLFromLFN(lfn, withWSUrl=True)
if not result['OK']:
errStr = result['Message']
log.debug(errStr, 'for %s' % (lfn))
failed[lfn] = "%s %s" % (
failed[lfn], errStr) if lfn in failed else errStr
else:
urlDict[result['Value']] = lfn
res = S_OK({'Successful': urlDict, 'Failed': failed})
# res['Failed'] = failed
return res
@staticmethod
def __getIndexInList(x, l):
""" Return the index of the element x in the list l
or sys.maxint if it does not exist
:param x: element to look for
:param l: list to look int
:return: the index or sys.maxint
"""
try:
return l.index(x)
except ValueError:
return sys.maxint
def __filterPlugins(self, methodName, protocols=None, inputProtocol=None):
""" Determine the list of plugins that
can be used for a particular action
Args:
method(str): method to execute
protocols(list): specific protocols might be requested
inputProtocol(str): in case the method is putFile, this specifies
the protocol given as source
Returns:
list: list of storage plugins
"""
log = self.log.getSubLogger('__filterPlugins', child=True)
log.debug(
"Filtering plugins for %s (protocol = %s ; inputProtocol = %s)" %
(methodName, protocols, inputProtocol))
if isinstance(protocols, basestring):
protocols = [protocols]
pluginsToUse = []
potentialProtocols = []
allowedProtocols = []
if methodName in self.readMethods + self.checkMethods:
allowedProtocols = self.localAccessProtocolList
elif methodName in self.removeMethods + self.writeMethods:
allowedProtocols = self.localWriteProtocolList
else:
# OK methods
# If a protocol or protocol list is specified, we only use the plugins that
# can generate such protocol
# otherwise we return them all
if protocols:
setProtocol = set(protocols)
for plugin in self.storages:
if set(plugin.protocolParameters.get(
"OutputProtocols", [])) & setProtocol:
log.debug(
"Plugin %s can generate compatible protocol" %
plugin.pluginName)
pluginsToUse.append(plugin)
else:
pluginsToUse = self.storages
# The closest list for "OK" methods is the AccessProtocol preference, so we sort based on that
pluginsToUse.sort(key=lambda x: self.__getIndexInList(
x.protocolParameters['Protocol'], self.localAccessProtocolList)
)
log.debug("Plugins to be used for %s: %s" %
(methodName, [p.pluginName for p in pluginsToUse]))
return pluginsToUse
log.debug("Allowed protocol: %s" % allowedProtocols)
# if a list of protocol is specified, take it into account
if protocols:
potentialProtocols = list(set(allowedProtocols) & set(protocols))
else:
potentialProtocols = allowedProtocols
log.debug('Potential protocols %s' % potentialProtocols)
localSE = self.__isLocalSE()['Value']
for plugin in self.storages:
# Determine whether to use this storage object
pluginParameters = plugin.getParameters()
pluginName = pluginParameters.get('PluginName')
if not pluginParameters:
log.debug("Failed to get storage parameters.",
"%s %s" % (self.name, pluginName))
continue
if not (pluginName in self.remotePlugins
) and not localSE and not pluginName == "Proxy":
# If the SE is not local then we can't use local protocols
log.debug(
"Local protocol not appropriate for remote use: %s." %
pluginName)
continue
if pluginParameters['Protocol'] not in potentialProtocols:
log.debug("Plugin %s not allowed for %s." %
(pluginName, methodName))
continue
# If we are attempting a putFile and we know the inputProtocol
if methodName == 'putFile' and inputProtocol:
if inputProtocol not in pluginParameters['InputProtocols']:
log.debug(
"Plugin %s not appropriate for %s protocol as input." %
(pluginName, inputProtocol))
continue
pluginsToUse.append(plugin)
# sort the plugins according to the lists in the CS
pluginsToUse.sort(key=lambda x: self.__getIndexInList(
x.protocolParameters['Protocol'], allowedProtocols))
log.debug("Plugins to be used for %s: %s" %
(methodName, [p.pluginName for p in pluginsToUse]))
return pluginsToUse
def __executeMethod(self, lfn, *args, **kwargs):
""" Forward the call to each storage in turn until one works.
The method to be executed is stored in self.methodName
:param lfn : string, list or dictionary
:param *args : variable amount of non-keyword arguments. SHOULD BE EMPTY
:param **kwargs : keyword arguments
:returns S_OK( { 'Failed': {lfn : reason} , 'Successful': {lfn : value} } )
The Failed dict contains the lfn only if the operation failed on all the storages
The Successful dict contains the value returned by the successful storages.
A special kwargs is 'inputProtocol', which can be specified for putFile. It describes
the protocol used as source protocol, since there is in principle only one.
"""
removedArgs = {}
log = self.log.getSubLogger('__executeMethod')
log.verbose("preparing the execution of %s" % (self.methodName))
# args should normaly be empty to avoid problem...
if len(args):
log.verbose("args should be empty!%s" % args)
# because there is normally only one kw argument, I can move it from args to kwargs
methDefaultArgs = StorageElementItem.__defaultsArguments.get(
self.methodName, {}).keys()
if len(methDefaultArgs):
kwargs[methDefaultArgs[0]] = args[0]
args = args[1:]
log.verbose(
"put it in kwargs, but dirty and might be dangerous!args %s kwargs %s"
% (args, kwargs))
# We check the deprecated arguments
for depArg in StorageElementItem.__deprecatedArguments:
if depArg in kwargs:
log.verbose(
"%s is not an allowed argument anymore. Please change your code!"
% depArg)
removedArgs[depArg] = kwargs[depArg]
del kwargs[depArg]
# Set default argument if any
methDefaultArgs = StorageElementItem.__defaultsArguments.get(
self.methodName, {})
for argName in methDefaultArgs:
if argName not in kwargs:
log.debug("default argument %s for %s not present.\
Setting value %s." %
(argName, self.methodName, methDefaultArgs[argName]))
kwargs[argName] = methDefaultArgs[argName]
res = checkArgumentFormat(lfn)
if not res['OK']:
errStr = "Supplied lfns must be string, list of strings or a dictionary."
log.debug(errStr)
return res
lfnDict = res['Value']
log.verbose("Attempting to perform '%s' operation with %s lfns." %
(self.methodName, len(lfnDict)))
res = self.isValid(operation=self.methodName)
if not res['OK']:
return res
else:
if not self.valid:
return S_ERROR(self.errorReason)
# In case executing putFile, we can assume that all the source urls
# are from the same protocol. This optional parameter, if defined
# can be used to ignore some storage plugins and thus save time
# and avoid fake failures showing in the accounting
inputProtocol = kwargs.pop('inputProtocol', None)
successful = {}
failed = {}
filteredPlugins = self.__filterPlugins(self.methodName,
kwargs.get('protocols'),
inputProtocol)
if not filteredPlugins:
return S_ERROR( errno.EPROTONOSUPPORT, "No storage plugins matching the requirements\
(operation %s protocols %s inputProtocol %s)" \
% ( self.methodName, kwargs.get( 'protocols' ), inputProtocol ) )
# Try all of the storages one by one
for storage in filteredPlugins:
# Determine whether to use this storage object
storageParameters = storage.getParameters()
pluginName = storageParameters['PluginName']
if not lfnDict:
log.debug("No lfns to be attempted for %s protocol." %
pluginName)
continue
log.verbose("Generating %s protocol URLs for %s." %
(len(lfnDict), pluginName))
replicaDict = kwargs.pop('replicaDict', {})
if storage.pluginName != "Proxy":
res = self.__generateURLDict(lfnDict,
storage,
replicaDict=replicaDict)
urlDict = res['Value']['Successful'] # url : lfn
failed.update(res['Value']['Failed'])
else:
urlDict = dict([(lfn, lfn) for lfn in lfnDict])
if not len(urlDict):
log.verbose(
"__executeMethod No urls generated for protocol %s." %
pluginName)
else:
log.verbose(
"Attempting to perform '%s' for %s physical files" %
(self.methodName, len(urlDict)))
fcn = None
if hasattr(storage, self.methodName) and callable(
getattr(storage, self.methodName)):
fcn = getattr(storage, self.methodName)
if not fcn:
return S_ERROR(
DErrno.ENOMETH,
"SE.__executeMethod: unable to invoke %s, it isn't a member function of storage"
)
urlsToUse = {
} # url : the value of the lfn dictionary for the lfn of this url
for url in urlDict:
urlsToUse[url] = lfnDict[urlDict[url]]
startDate = datetime.datetime.utcnow()
startTime = time.time()
res = fcn(urlsToUse, *args, **kwargs)
elapsedTime = time.time() - startTime
self.addAccountingOperation(urlsToUse, startDate, elapsedTime,
storageParameters, res)
if not res['OK']:
errStr = "Completely failed to perform %s." % self.methodName
log.debug(
errStr,
'with plugin %s: %s' % (pluginName, res['Message']))
for lfn in urlDict.values():
if lfn not in failed:
failed[lfn] = ''
failed[lfn] = "%s %s" % (
failed[lfn],
res['Message']) if failed[lfn] else res['Message']
else:
for url, lfn in urlDict.items():
if url not in res['Value']['Successful']:
if lfn not in failed:
failed[lfn] = ''
if url in res['Value']['Failed']:
self.log.debug(res['Value']['Failed'][url])
failed[lfn] = "%s %s" % (
failed[lfn],
res['Value']['Failed'][url]) if failed[
lfn] else res['Value']['Failed'][url]
else:
errStr = 'No error returned from plug-in'
failed[lfn] = "%s %s" % (
failed[lfn],
errStr) if failed[lfn] else errStr
else:
successful[lfn] = res['Value']['Successful'][url]
if lfn in failed:
failed.pop(lfn)
lfnDict.pop(lfn)
gDataStoreClient.commit()
return S_OK({'Failed': failed, 'Successful': successful})
def __getattr__(self, name):
""" Forwards the equivalent Storage calls to __executeMethod"""
# We take either the equivalent name, or the name itself
self.methodName = StorageElementItem.__equivalentMethodNames.get(
name, None)
if self.methodName:
return self.__executeMethod
raise AttributeError("StorageElement does not have a method '%s'" %
name)
def addAccountingOperation(self, lfns, startDate, elapsedTime,
storageParameters, callRes):
"""
Generates a DataOperation accounting if needs to be, and adds it to the DataStore client cache
:param lfns : list of lfns on which we attempted the operation
:param startDate : datetime, start of the operation
:param elapsedTime : time (seconds) the operation took
:param storageParameters : the parameters of the plugins used to perform the operation
:param callRes : the return of the method call, S_OK or S_ERROR
The operation is generated with the OperationType "se.methodName"
The TransferSize and TransferTotal for directory methods actually take into
account the files inside the directory, and not the amount of directory given
as parameter
"""
if self.methodName not in (self.readMethods + self.writeMethods +
self.removeMethods):
return
baseAccountingDict = {}
baseAccountingDict['OperationType'] = 'se.%s' % self.methodName
baseAccountingDict['User'] = getProxyInfo().get('Value', {}).get(
'username', 'unknown')
baseAccountingDict['RegistrationTime'] = 0.0
baseAccountingDict['RegistrationOK'] = 0
baseAccountingDict['RegistrationTotal'] = 0
# if it is a get method, then source and destination of the transfer should be inverted
if self.methodName == 'getFile':
baseAccountingDict['Destination'] = siteName()
baseAccountingDict['Source'] = self.name
else:
baseAccountingDict['Destination'] = self.name
baseAccountingDict['Source'] = siteName()
baseAccountingDict['TransferTotal'] = 0
baseAccountingDict['TransferOK'] = 0
baseAccountingDict['TransferSize'] = 0
baseAccountingDict['TransferTime'] = 0.0
baseAccountingDict['FinalStatus'] = 'Successful'
oDataOperation = DataOperation()
oDataOperation.setValuesFromDict(baseAccountingDict)
oDataOperation.setStartTime(startDate)
oDataOperation.setEndTime(startDate +
datetime.timedelta(seconds=elapsedTime))
oDataOperation.setValueByKey('TransferTime', elapsedTime)
oDataOperation.setValueByKey(
'Protocol', storageParameters.get('Protocol', 'unknown'))
if not callRes['OK']:
# Everything failed
oDataOperation.setValueByKey('TransferTotal', len(lfns))
oDataOperation.setValueByKey('FinalStatus', 'Failed')
else:
succ = callRes.get('Value', {}).get('Successful', {})
failed = callRes.get('Value', {}).get('Failed', {})
totalSize = 0
# We don't take len(lfns) in order to make two
# separate entries in case of few failures
totalSucc = len(succ)
if self.methodName in ('putFile', 'getFile'):
# putFile and getFile return for each entry
# in the successful dir the size of the corresponding file
totalSize = sum(succ.values())
elif self.methodName in ('putDirectory', 'getDirectory'):
# putDirectory and getDirectory return for each dir name
# a dictionnary with the keys 'Files' and 'Size'
totalSize = sum(
val.get('Size', 0) for val in succ.values()
if isinstance(val, dict))
totalSucc = sum(
val.get('Files', 0) for val in succ.values()
if isinstance(val, dict))
oDataOperation.setValueByKey('TransferOK', len(succ))
oDataOperation.setValueByKey('TransferSize', totalSize)
oDataOperation.setValueByKey('TransferTotal', totalSucc)
oDataOperation.setValueByKey('TransferOK', totalSucc)
if callRes['Value']['Failed']:
oDataOperationFailed = copy.deepcopy(oDataOperation)
oDataOperationFailed.setValueByKey('TransferTotal',
len(failed))
oDataOperationFailed.setValueByKey('TransferOK', 0)
oDataOperationFailed.setValueByKey('TransferSize', 0)
oDataOperationFailed.setValueByKey('FinalStatus', 'Failed')
accRes = gDataStoreClient.addRegister(oDataOperationFailed)
if not accRes['OK']:
self.log.error("Could not send failed accounting report",
accRes['Message'])
accRes = gDataStoreClient.addRegister(oDataOperation)
if not accRes['OK']:
self.log.error("Could not send accounting report",
accRes['Message'])
class StorageElementItem(object):
"""
.. class:: StorageElement
common interface to the grid storage element
self.name is the resolved name of the StorageElement i.e CERN-tape
self.options is dictionary containing the general options defined in the CS e.g. self.options['Backend] = 'Castor2'
self.storages is a list of the stub objects created by StorageFactory for the protocols found in the CS.
self.localPlugins is a list of the local protocols that were created by StorageFactory
self.remotePlugins is a list of the remote protocols that were created by StorageFactory
self.protocolOptions is a list of dictionaries containing the options found in the CS. (should be removed)
dynamic method::
retransferOnlineFile( lfn )
exists( lfn )
isFile( lfn )
getFile( lfn, localPath = False )
putFile( lfnLocal, sourceSize = 0 ) : {lfn:local}
replicateFile( lfn, sourceSize = 0 )
getFileMetadata( lfn )
getFileSize( lfn )
removeFile( lfn )
prestageFile( lfn, lifetime = 86400 )
prestageFileStatus( lfn )
pinFile( lfn, lifetime = 60 * 60 * 24 )
releaseFile( lfn )
isDirectory( lfn )
getDirectoryMetadata( lfn )
getDirectorySize( lfn )
listDirectory( lfn )
removeDirectory( lfn, recursive = False )
createDirectory( lfn )
putDirectory( lfn )
getDirectory( lfn, localPath = False )
"""
__deprecatedArguments = ["singleFile", "singleDirectory"] # Arguments that are now useless
# Some methods have a different name in the StorageElement and the plugins...
# We could avoid this static list in the __getattr__ by checking the storage plugin and so on
# but fine... let's not be too smart, otherwise it becomes unreadable :-)
__equivalentMethodNames = {"exists": "exists",
"isFile": "isFile",
"getFile": "getFile",
"putFile": "putFile",
"replicateFile": "putFile",
"getFileMetadata": "getFileMetadata",
"getFileSize": "getFileSize",
"removeFile": "removeFile",
"prestageFile": "prestageFile",
"prestageFileStatus": "prestageFileStatus",
"pinFile": "pinFile",
"releaseFile": "releaseFile",
"isDirectory": "isDirectory",
"getDirectoryMetadata": "getDirectoryMetadata",
"getDirectorySize": "getDirectorySize",
"listDirectory": "listDirectory",
"removeDirectory": "removeDirectory",
"createDirectory": "createDirectory",
"putDirectory": "putDirectory",
"getDirectory": "getDirectory"}
# We can set default argument in the __executeFunction which impacts all plugins
__defaultsArguments = {"putFile": {"sourceSize": 0},
"getFile": {"localPath": False},
"prestageFile": {"lifetime": 86400},
"pinFile": {"lifetime": 60 * 60 * 24},
"removeDirectory": {"recursive": False},
"getDirectory": {"localPath": False}}
def __init__(self, name, plugins=None, vo=None, hideExceptions=False):
""" c'tor
:param str name: SE name
:param list plugins: requested storage plugins
:param vo: vo
"""
self.methodName = None
if vo:
self.vo = vo
else:
result = getVOfromProxyGroup()
if not result['OK']:
return
self.vo = result['Value']
self.opHelper = Operations(vo=self.vo)
# These things will soon have to go as well. 'AccessProtocol.1' is all but flexible.
proxiedProtocols = gConfig.getValue('/LocalSite/StorageElements/ProxyProtocols', "").split(',')
self.useProxy = (
gConfig.getValue(
"/Resources/StorageElements/%s/AccessProtocol.1/Protocol" %
name, "UnknownProtocol") in proxiedProtocols)
if not self.useProxy:
self.useProxy = gConfig.getValue('/LocalSite/StorageElements/%s/UseProxy' % name, False)
if not self.useProxy:
self.useProxy = self.opHelper.getValue('/Services/StorageElements/%s/UseProxy' % name, False)
self.valid = True
if plugins is None:
res = StorageFactory(
useProxy=self.useProxy,
vo=self.vo).getStorages(
name,
pluginList=[],
hideExceptions=hideExceptions)
else:
res = StorageFactory(
useProxy=self.useProxy,
vo=self.vo).getStorages(
name,
pluginList=plugins,
hideExceptions=hideExceptions)
if not res['OK']:
self.valid = False
self.name = name
self.errorReason = res['Message']
else:
factoryDict = res['Value']
self.name = factoryDict['StorageName']
self.options = factoryDict['StorageOptions']
self.localPlugins = factoryDict['LocalPlugins']
self.remotePlugins = factoryDict['RemotePlugins']
self.storages = factoryDict['StorageObjects']
self.protocolOptions = factoryDict['ProtocolOptions']
self.turlProtocols = factoryDict['TurlProtocols']
for storage in self.storages:
storage.setStorageElement(self)
self.log = gLogger.getSubLogger("SE[%s]" % self.name)
if self.valid:
self.useCatalogURL = gConfig.getValue(
'/Resources/StorageElements/%s/UseCatalogURL' %
self.name, False)
self.log.debug("useCatalogURL: %s" % self.useCatalogURL)
self.__dmsHelper = DMSHelpers(vo=vo)
# Allow SE to overwrite general operation config
accessProto = self.options.get('AccessProtocols')
self.localAccessProtocolList = accessProto if accessProto else self.__dmsHelper.getAccessProtocols()
self.log.debug("localAccessProtocolList %s" % self.localAccessProtocolList)
writeProto = self.options.get('WriteProtocols')
self.localWriteProtocolList = writeProto if writeProto else self.__dmsHelper.getWriteProtocols()
self.log.debug("localWriteProtocolList %s" % self.localWriteProtocolList)
# 'getTransportURL',
self.readMethods = ['getFile',
'prestageFile',
'prestageFileStatus',
'getDirectory']
self.writeMethods = ['retransferOnlineFile',
'putFile',
'replicateFile',
'pinFile',
'releaseFile',
'createDirectory',
'putDirectory']
self.removeMethods = ['removeFile',
'removeDirectory']
self.checkMethods = ['exists',
'getDirectoryMetadata',
'getDirectorySize',
'getFileSize',
'getFileMetadata',
'listDirectory',
'isDirectory',
'isFile',
'getOccupancy'
]
self.okMethods = ['getLocalProtocols',
'getProtocols',
'getRemoteProtocols',
'storageElementName',
'getStorageParameters',
'getTransportURL',
'isLocalSE']
self.__fileCatalog = None
def dump(self):
""" Dump to the logger a summary of the StorageElement items. """
log = self.log.getSubLogger('dump', True)
log.verbose("Preparing dump for StorageElement %s." % self.name)
if not self.valid:
log.debug("Failed to create StorageElement plugins.", self.errorReason)
return
i = 1
outStr = "\n\n============ Options ============\n"
for key in sorted(self.options):
outStr = "%s%s: %s\n" % (outStr, key.ljust(15), self.options[key])
for storage in self.storages:
outStr = "%s============Protocol %s ============\n" % (outStr, i)
storageParameters = storage.getParameters()
for key in sorted(storageParameters):
outStr = "%s%s: %s\n" % (outStr, key.ljust(15), storageParameters[key])
i = i + 1
log.verbose(outStr)
#################################################################################################
#
# These are the basic get functions for storage configuration
#
def getStorageElementName(self):
""" SE name getter for backward compatibility """
return S_OK(self.storageElementName())
def storageElementName(self):
""" SE name getter """
self.log.getSubLogger('storageElementName').verbose(
"The Storage Element name is %s." % self.name)
return self.name
def getChecksumType(self):
""" Checksum type getter for backward compatibility """
return S_OK(self.checksumType())
def checksumType(self):
""" get specific /Resources/StorageElements/<SEName>/ChecksumType option if defined, otherwise
global /Resources/StorageElements/ChecksumType
"""
self.log.getSubLogger('checksumType').verbose("get checksum type for %s." % self.name)
return self.options["ChecksumType"].upper() if "ChecksumType" in self.options else gConfig.getValue(
"/Resources/StorageElements/ChecksumType", "ADLER32").upper()
def getStatus(self):
"""
Return Status of the SE only if the SE is valid
It returns an S_OK/S_ERROR structure
"""
valid = self.isValid()
if not valid['OK']:
return valid
return S_OK(self.status())
def isSameSE(self, otherSE):
""" Compares two SE together and tries to guess if the two SEs are pointing at the same
location from the namespace point of view.
This is primarily aimed at avoiding to overwrite a file with itself, in particular
where the difference is only the SRM spacetoken.
Two SEs are considered to be the same if they have a couple (Host, Path) in common
among their various protocols
:param otherSE: the storage element to which we compare
:returns: boolean. True if the two SEs are the same.
"""
# If the two objects are the same, it is obviously the same SE
if self == otherSE:
return True
# Otherwise, we build the list of (Host, Path) couples
selfEndpoints = set()
otherSEEndpoints = set()
for storage in self.storages:
storageParam = storage.getParameters()
selfEndpoints.add((storageParam['Host'], storageParam['Path']))
for storage in otherSE.storages:
storageParam = storage.getParameters()
otherSEEndpoints.add((storageParam['Host'], storageParam['Path']))
# The two SEs are the same if they have at least one couple in common
return bool(selfEndpoints & otherSEEndpoints)
def getOccupancy(self, unit='MB', **kwargs):
""" Retrieves the space information about the storage.
It returns the Total and Free space.
It loops over the different Storage Plugins to query it.
:params occupancyLFN: (named param) LFN where to find the space reporting json file on the storage
The json file should contain the Free and Total space in MB.
If not specified, the default path will be </vo/occupancy.json>
:returns: S_OK with dict (keys: Total, Free)
"""
log = self.log.getSubLogger('getOccupancy', True)
# Mandatory parameters
mandatoryParams = set(['Total', 'Free'])
if 'occupancyLFN' not in kwargs:
occupancyLFN = self.options.get('OccupancyLFN')
if not occupancyLFN:
occupancyLFN = os.path.join('/', self.vo, DEFAULT_OCCUPANCY_FILE)
kwargs['occupancyLFN'] = occupancyLFN
filteredPlugins = self.__filterPlugins('getOccupancy')
if not filteredPlugins:
return S_ERROR(errno.EPROTONOSUPPORT, "No storage plugins to query the occupancy")
# Try all of the storages one by one
for storage in filteredPlugins:
# The result of the plugin is always in MB
res = storage.getOccupancy(**kwargs)
if res['OK']:
occupancyDict = res['Value']
# Make sure all the mandatory parameters are present
if set(occupancyDict) & mandatoryParams != mandatoryParams:
log.verbose("Missing mandatory parameters", mandatoryParams - set(occupancyDict))
continue
if unit != 'MB':
for space in ['Total', 'Free']:
convertedSpace = convertSizeUnits(occupancyDict[space], 'MB', unit)
# If we have a conversion error, we go to the next plugin
if convertedSpace == -sys.maxsize:
log.verbose(
"Error converting %s space from MB to %s: %s" %
(space, unit, occupancyDict[space]))
break
occupancyDict[space] = convertedSpace
return res
return S_ERROR("Could not retrieve the occupancy from any plugin")
def status(self):
"""
Return Status of the SE, a dictionary with:
* Read: True (is allowed), False (it is not allowed)
* Write: True (is allowed), False (it is not allowed)
* Remove: True (is allowed), False (it is not allowed)
* Check: True (is allowed), False (it is not allowed).
.. note:: Check is always allowed IF Read is allowed
(regardless of what set in the Check option of the configuration)
* DiskSE: True if TXDY with Y > 0 (defaults to True)
* TapeSE: True if TXDY with X > 0 (defaults to False)
* TotalCapacityTB: float (-1 if not defined)
* DiskCacheTB: float (-1 if not defined)
It returns directly the dictionary
"""
self.log.getSubLogger('getStatus').verbose("determining status of %s." % self.name)
retDict = {}
if not self.valid:
retDict['Read'] = False
retDict['Write'] = False
retDict['Remove'] = False
retDict['Check'] = False
retDict['DiskSE'] = False
retDict['TapeSE'] = False
retDict['TotalCapacityTB'] = -1
retDict['DiskCacheTB'] = -1
return retDict
# If nothing is defined in the CS Access is allowed
# If something is defined, then it must be set to Active
retDict['Read'] = not (
'ReadAccess' in self.options and self.options['ReadAccess'] not in (
'Active', 'Degraded'))
retDict['Write'] = not (
'WriteAccess' in self.options and self.options['WriteAccess'] not in (
'Active', 'Degraded'))
retDict['Remove'] = not (
'RemoveAccess' in self.options and self.options['RemoveAccess'] not in (
'Active', 'Degraded'))
if retDict['Read']:
retDict['Check'] = True
else:
retDict['Check'] = not (
'CheckAccess' in self.options and self.options['CheckAccess'] not in (
'Active', 'Degraded'))
diskSE = True
tapeSE = False
if 'SEType' in self.options:
# Type should follow the convention TXDY
seType = self.options['SEType']
diskSE = re.search('D[1-9]', seType) is not None
tapeSE = re.search('T[1-9]', seType) is not None
retDict['DiskSE'] = diskSE
retDict['TapeSE'] = tapeSE
try:
retDict['TotalCapacityTB'] = float(self.options['TotalCapacityTB'])
except Exception:
retDict['TotalCapacityTB'] = -1
try:
retDict['DiskCacheTB'] = float(self.options['DiskCacheTB'])
except Exception:
retDict['DiskCacheTB'] = -1
return retDict
def isValid(self, operation=None):
""" check CS/RSS statuses for :operation:
:param str operation: operation name
"""
log = self.log.getSubLogger('isValid', True)
log.verbose("Determining if the StorageElement %s is valid for VO %s" % (self.name, self.vo))
if not self.valid:
log.debug("Failed to create StorageElement plugins.", self.errorReason)
return S_ERROR("SE.isValid: Failed to create StorageElement plugins: %s" % self.errorReason)
# Check if the Storage Element is eligible for the user's VO
if 'VO' in self.options and self.vo not in self.options['VO']:
log.debug("StorageElement is not allowed for VO", self.vo)
return S_ERROR(errno.EACCES, "StorageElement.isValid: StorageElement is not allowed for VO")
log.verbose(
"Determining if the StorageElement %s is valid for operation '%s'" %
(self.name, operation))
if (not operation) or (operation in self.okMethods):
return S_OK()
# Determine whether the StorageElement is valid for checking, reading, writing
status = self.status()
checking = status['Check']
reading = status['Read']
writing = status['Write']
removing = status['Remove']
# Determine whether the requested operation can be fulfilled
if (not operation) and (not reading) and (not writing) and (not checking):
log.debug("Read, write and check access not permitted.")
return S_ERROR(errno.EACCES, "SE.isValid: Read, write and check access not permitted.")
# The supplied operation can be 'Read','Write' or any of the possible StorageElement methods.
if (operation in self.readMethods) or (operation.lower() in ('read', 'readaccess')):
operation = 'ReadAccess'
elif operation in self.writeMethods or (operation.lower() in ('write', 'writeaccess')):
operation = 'WriteAccess'
elif operation in self.removeMethods or (operation.lower() in ('remove', 'removeaccess')):
operation = 'RemoveAccess'
elif operation in self.checkMethods or (operation.lower() in ('check', 'checkaccess')):
operation = 'CheckAccess'
else:
log.debug("The supplied operation is not known.", operation)
return S_ERROR(DErrno.ENOMETH, "SE.isValid: The supplied operation is not known.")
log.debug("check the operation: %s " % operation)
# Check if the operation is valid
if operation == 'CheckAccess':
if not reading:
if not checking:
log.debug("Check access not currently permitted.")
return S_ERROR(errno.EACCES, "SE.isValid: Check access not currently permitted.")
if operation == 'ReadAccess':
if not reading:
log.debug("Read access not currently permitted.")
return S_ERROR(errno.EACCES, "SE.isValid: Read access not currently permitted.")
if operation == 'WriteAccess':
if not writing:
log.debug("Write access not currently permitted.")
return S_ERROR(errno.EACCES, "SE.isValid: Write access not currently permitted.")
if operation == 'RemoveAccess':
if not removing:
log.debug("Remove access not currently permitted.")
return S_ERROR(errno.EACCES, "SE.isValid: Remove access not currently permitted.")
return S_OK()
def getPlugins(self):
""" Get the list of all the plugins defined for this Storage Element
"""
self.log.getSubLogger('getPlugins').verbose("Obtaining all plugins of %s." % self.name)
if not self.valid:
return S_ERROR(self.errorReason)
allPlugins = self.localPlugins + self.remotePlugins
return S_OK(allPlugins)
def getRemotePlugins(self):
""" Get the list of all the remote access protocols defined for this Storage Element
"""
self.log.getSubLogger('getRemotePlugins').verbose(
"Obtaining remote protocols for %s." % self.name)
if not self.valid:
return S_ERROR(self.errorReason)
return S_OK(self.remotePlugins)
def getLocalPlugins(self):
""" Get the list of all the local access protocols defined for this Storage Element
"""
self.log.getSubLogger('getLocalPlugins').verbose(
"Obtaining local protocols for %s." % self.name)
if not self.valid:
return S_ERROR(self.errorReason)
return S_OK(self.localPlugins)
def getStorageParameters(self, plugin=None, protocol=None):
""" Get plugin specific options
:param plugin : plugin we are interested in
:param protocol: protocol we are interested in
Either plugin or protocol can be defined, not both, but at least one of them
"""
# both set
if plugin and protocol:
return S_ERROR(errno.EINVAL, "plugin and protocol cannot be set together.")
# both None
elif not (plugin or protocol):
return S_ERROR(errno.EINVAL, "plugin and protocol cannot be None together.")
log = self.log.getSubLogger('getStorageParameters')
reqStr = "plugin %s" % plugin if plugin else "protocol %s" % protocol
log.verbose("Obtaining storage parameters for %s for %s." % (self.name,
reqStr))
for storage in self.storages:
storageParameters = storage.getParameters()
if plugin and storageParameters['PluginName'] == plugin:
return S_OK(storageParameters)
elif protocol and storageParameters['Protocol'] == protocol:
return S_OK(storageParameters)
errStr = "Requested plugin or protocol not available."
log.debug(errStr, "%s for %s" % (reqStr, self.name))
return S_ERROR(errno.ENOPROTOOPT, errStr)
def __getAllProtocols(self, protoType):
""" Returns the list of all protocols for Input or Output
:param proto = InputProtocols or OutputProtocols
"""
return set(reduce(lambda x, y: x +
y, [plugin.protocolParameters[protoType] for plugin in self.storages]))
def _getAllInputProtocols(self):
""" Returns all the protocols supported by the SE for Input
"""
return self.__getAllProtocols('InputProtocols')
def _getAllOutputProtocols(self):
""" Returns all the protocols supported by the SE for Output
"""
return self.__getAllProtocols('OutputProtocols')
def generateTransferURLsBetweenSEs(self, lfns, sourceSE, protocols=None):
""" This negociate the URLs to be used for third party copy.
This is mostly useful for FTS. If protocols is given,
it restricts the list of plugins to use
:param lfns: list/dict of lfns to generate the URLs
:param sourceSE: storageElement instance of the sourceSE
:param protocols: ordered protocol restriction list
:return:dictionnary Successful/Failed with pair (src, dest) urls
"""
log = self.log.getSubLogger('generateTransferURLsBetweenSEs')
result = checkArgumentFormat(lfns)
if result['OK']:
lfns = result['Value']
else:
errStr = "Supplied urls must be string, list of strings or a dictionary."
log.debug(errStr)
return S_ERROR(errno.EINVAL, errStr)
# First, find common protocols to use
res = self.negociateProtocolWithOtherSE(sourceSE, protocols=protocols)
if not res['OK']:
return res
commonProtocols = res['Value']
# Taking each protocol at the time, we try to generate src and dest URLs
for proto in commonProtocols:
srcPlugin = None
destPlugin = None
log.debug("Trying to find plugins for protocol %s" % proto)
# Finding the source storage plugin
for storagePlugin in sourceSE.storages:
log.debug("Testing %s as source plugin" % storagePlugin.pluginName)
storageParameters = storagePlugin.getParameters()
nativeProtocol = storageParameters['Protocol']
# If the native protocol of the plugin is allowed for read
if nativeProtocol in sourceSE.localAccessProtocolList:
# If the plugin can generate the protocol we are interested in
if proto in storageParameters['OutputProtocols']:
log.debug("Selecting it")
srcPlugin = storagePlugin
break
# If we did not find a source plugin, continue
if srcPlugin is None:
log.debug("Could not find a source plugin for protocol %s" % proto)
continue
# Finding the destination storage plugin
for storagePlugin in self.storages:
log.debug("Testing %s as destination plugin" % storagePlugin.pluginName)
storageParameters = storagePlugin.getParameters()
nativeProtocol = storageParameters['Protocol']
# If the native protocol of the plugin is allowed for write
if nativeProtocol in self.localWriteProtocolList:
# If the plugin can accept the protocol we are interested in
if proto in storageParameters['InputProtocols']:
log.debug("Selecting it")
destPlugin = storagePlugin
break
# If we found both a source and destination plugin, we are happy,
# otherwise we continue with the next protocol
if destPlugin is None:
log.debug("Could not find a destination plugin for protocol %s" % proto)
srcPlugin = None
continue
failed = {}
successful = {}
# Generate the URLs
for lfn in lfns:
# Source URL first
res = srcPlugin.constructURLFromLFN(lfn, withWSUrl=True)
if not res['OK']:
errMsg = "Error generating source url: %s" % res['Message']
gLogger.debug("Error generating source url", errMsg)
failed[lfn] = errMsg
continue
srcURL = res['Value']
# Destination URL
res = destPlugin.constructURLFromLFN(lfn, withWSUrl=True)
if not res['OK']:
errMsg = "Error generating destination url: %s" % res['Message']
gLogger.debug("Error generating destination url", errMsg)
failed[lfn] = errMsg
continue
destURL = res['Value']
successful[lfn] = (srcURL, destURL)
return S_OK({'Successful': successful, 'Failed': failed})
return S_ERROR(errno.ENOPROTOOPT, "Could not find a protocol ")
def negociateProtocolWithOtherSE(self, sourceSE, protocols=None):
""" Negotiate what protocol could be used for a third party transfer
between the sourceSE and ourselves. If protocols is given,
the chosen protocol has to be among those
:param sourceSE : storageElement instance of the sourceSE
:param protocols: ordered protocol restriction list
:return: a list protocols that fits the needs, or None
"""
# No common protocols if this is a proxy storage
if self.useProxy:
return S_OK([])
log = self.log.getSubLogger('negociateProtocolWithOtherSE', child=True)
log.debug(
"Negociating protocols between %s and %s (protocols %s)" %
(sourceSE.name, self.name, protocols))
# Take all the protocols the destination can accept as input
destProtocols = self._getAllInputProtocols()
log.debug("Destination input protocols %s" % destProtocols)
# Take all the protocols the source can provide
sourceProtocols = sourceSE._getAllOutputProtocols()
log.debug("Source output protocols %s" % sourceProtocols)
commonProtocols = destProtocols & sourceProtocols
# If a restriction list is defined
# take the intersection, and sort the commonProtocols
# based on the protocolList order
if protocols:
protocolList = list(protocols)
commonProtocols = sorted(
commonProtocols & set(protocolList),
key=lambda x: self.__getIndexInList(
x,
protocolList))
log.debug("Common protocols %s" % commonProtocols)
return S_OK(list(commonProtocols))
#################################################################################################
#
# These are the basic get functions for lfn manipulation
#
def __getURLPath(self, url):
""" Get the part of the URL path below the basic storage path.
This path must coincide with the LFN of the file in order to be compliant with the DIRAC conventions.
"""
log = self.log.getSubLogger('__getURLPath')
log.verbose("Getting path from url in %s." % self.name)
if not self.valid:
return S_ERROR(self.errorReason)
res = pfnparse(url)
if not res['OK']:
return res
fullURLPath = '%s/%s' % (res['Value']['Path'], res['Value']['FileName'])
# Check all available storages and check whether the url is for that protocol
urlPath = ''
for storage in self.storages:
res = storage.isNativeURL(url)
if res['OK']:
if res['Value']:
parameters = storage.getParameters()
saPath = parameters['Path']
if not saPath:
# If the sa path doesn't exist then the url path is the entire string
urlPath = fullURLPath
else:
if re.search(saPath, fullURLPath):
# Remove the sa path from the fullURLPath
urlPath = fullURLPath.replace(saPath, '')
if urlPath:
return S_OK(urlPath)
# This should never happen. DANGER!!
errStr = "Failed to get the url path for any of the protocols!!"
log.debug(errStr)
return S_ERROR(errStr)
def getLFNFromURL(self, urls):
""" Get the LFN from the PFNS .
:param lfn : input lfn or lfns (list/dict)
"""
result = checkArgumentFormat(urls)
if result['OK']:
urlDict = result['Value']
else:
errStr = "Supplied urls must be string, list of strings or a dictionary."
self.log.getSubLogger('getLFNFromURL').debug(errStr)
return S_ERROR(errno.EINVAL, errStr)
retDict = {"Successful": {}, "Failed": {}}
for url in urlDict:
res = self.__getURLPath(url)
if res["OK"]:
retDict["Successful"][url] = res["Value"]
else:
retDict["Failed"][url] = res["Message"]
return S_OK(retDict)
###########################################################################################
#
# This is the generic wrapper for file operations
#
def getURL(self, lfn, protocol=False, replicaDict=None):
""" execute 'getTransportURL' operation.
:param str lfn: string, list or dictionary of lfns
:param protocol: if no protocol is specified, we will request self.turlProtocols
:param replicaDict: optional results from the File Catalog replica query
"""
self.log.getSubLogger('getURL').verbose("Getting accessUrl %s for lfn in %s." %
("(%s)" % protocol if protocol else "", self.name))
if not protocol:
# This turlProtocols seems totally useless.
# Get ride of it when gfal2 is totally ready
# and replace it with the localAccessProtocol list
protocols = self.turlProtocols
elif isinstance(protocol, list):
protocols = protocol
elif isinstance(protocol, basestring):
protocols = [protocol]
self.methodName = "getTransportURL"
result = self.__executeMethod(lfn, protocols=protocols)
return result
def __isLocalSE(self):
""" Test if the Storage Element is local in the current context
"""
self.log.getSubLogger('LocalSE').verbose("Determining whether %s is a local SE." % self.name)
import DIRAC
localSEs = getSEsForSite(DIRAC.siteName())['Value']
if self.name in localSEs:
return S_OK(True)
else:
return S_OK(False)
def __getFileCatalog(self):
if not self.__fileCatalog:
self.__fileCatalog = FileCatalog(vo=self.vo)
return self.__fileCatalog
def __generateURLDict(self, lfns, storage, replicaDict=None):
""" Generates a dictionary (url : lfn ), where the url are constructed
from the lfn using the constructURLFromLFN method of the storage plugins.
:param: lfns : dictionary {lfn:whatever}
:returns dictionary {constructed url : lfn}
"""
log = self.log.getSubLogger("__generateURLDict")
log.verbose("generating url dict for %s lfn in %s." % (len(lfns), self.name))
if not replicaDict:
replicaDict = {}
urlDict = {} # url : lfn
failed = {} # lfn : string with errors
for lfn in lfns:
if self.useCatalogURL:
# Is this self.name alias proof?
url = replicaDict.get(lfn, {}).get(self.name, '')
if url:
urlDict[url] = lfn
continue
else:
fc = self.__getFileCatalog()
result = fc.getReplicas()
if not result['OK']:
failed[lfn] = result['Message']
url = result['Value']['Successful'].get(lfn, {}).get(self.name, '')
if not url:
failed[lfn] = 'Failed to get catalog replica'
else:
# Update the URL according to the current SE description
result = returnSingleResult(storage.updateURL(url))
if not result['OK']:
failed[lfn] = result['Message']
else:
urlDict[result['Value']] = lfn
else:
result = storage.constructURLFromLFN(lfn, withWSUrl=True)
if not result['OK']:
errStr = result['Message']
log.debug(errStr, 'for %s' % (lfn))
failed[lfn] = "%s %s" % (failed[lfn], errStr) if lfn in failed else errStr
else:
urlDict[result['Value']] = lfn
res = S_OK({'Successful': urlDict, 'Failed': failed})
# res['Failed'] = failed
return res
@staticmethod
def __getIndexInList(x, l):
""" Return the index of the element x in the list l
or sys.maxint if it does not exist
:param x: element to look for
:param l: list to look int
:return: the index or sys.maxint
"""
try:
return l.index(x)
except ValueError:
return sys.maxsize
def __filterPlugins(self, methodName, protocols=None, inputProtocol=None):
""" Determine the list of plugins that
can be used for a particular action
Args:
method(str): method to execute
protocols(list): specific protocols might be requested
inputProtocol(str): in case the method is putFile, this specifies
the protocol given as source
Returns:
list: list of storage plugins
"""
log = self.log.getSubLogger('__filterPlugins', child=True)
log.debug(
"Filtering plugins for %s (protocol = %s ; inputProtocol = %s)" %
(methodName, protocols, inputProtocol))
if isinstance(protocols, basestring):
protocols = [protocols]
pluginsToUse = []
potentialProtocols = []
allowedProtocols = []
if methodName in self.readMethods + self.checkMethods:
allowedProtocols = self.localAccessProtocolList
elif methodName in self.removeMethods + self.writeMethods:
allowedProtocols = self.localWriteProtocolList
else:
# OK methods
# If a protocol or protocol list is specified, we only use the plugins that
# can generate such protocol
# otherwise we return them all
if protocols:
setProtocol = set(protocols)
for plugin in self.storages:
if set(plugin.protocolParameters.get("OutputProtocols", [])) & setProtocol:
log.debug("Plugin %s can generate compatible protocol" % plugin.pluginName)
pluginsToUse.append(plugin)
else:
pluginsToUse = self.storages
# The closest list for "OK" methods is the AccessProtocol preference, so we sort based on that
pluginsToUse.sort(
key=lambda x: self.__getIndexInList(
x.protocolParameters['Protocol'],
self.localAccessProtocolList))
log.debug("Plugins to be used for %s: %s" %
(methodName, [p.pluginName for p in pluginsToUse]))
return pluginsToUse
log.debug("Allowed protocol: %s" % allowedProtocols)
# if a list of protocol is specified, take it into account
if protocols:
potentialProtocols = list(set(allowedProtocols) & set(protocols))
else:
potentialProtocols = allowedProtocols
log.debug('Potential protocols %s' % potentialProtocols)
localSE = self.__isLocalSE()['Value']
for plugin in self.storages:
# Determine whether to use this storage object
pluginParameters = plugin.getParameters()
pluginName = pluginParameters.get('PluginName')
if not pluginParameters:
log.debug("Failed to get storage parameters.", "%s %s" % (self.name, pluginName))
continue
if not (pluginName in self.remotePlugins) and not localSE and not pluginName == "Proxy":
# If the SE is not local then we can't use local protocols
log.debug("Local protocol not appropriate for remote use: %s." % pluginName)
continue
if pluginParameters['Protocol'] not in potentialProtocols:
log.debug("Plugin %s not allowed for %s." % (pluginName, methodName))
continue
# If we are attempting a putFile and we know the inputProtocol
if methodName == 'putFile' and inputProtocol:
if inputProtocol not in pluginParameters['InputProtocols']:
log.debug(
"Plugin %s not appropriate for %s protocol as input." %
(pluginName, inputProtocol))
continue
pluginsToUse.append(plugin)
# sort the plugins according to the lists in the CS
pluginsToUse.sort(
key=lambda x: self.__getIndexInList(
x.protocolParameters['Protocol'],
allowedProtocols))
log.debug("Plugins to be used for %s: %s" % (methodName, [p.pluginName for p in pluginsToUse]))
return pluginsToUse
def __executeMethod(self, lfn, *args, **kwargs):
""" Forward the call to each storage in turn until one works.
The method to be executed is stored in self.methodName
:param lfn : string, list or dictionary
:param *args : variable amount of non-keyword arguments. SHOULD BE EMPTY
:param **kwargs : keyword arguments
:returns S_OK( { 'Failed': {lfn : reason} , 'Successful': {lfn : value} } )
The Failed dict contains the lfn only if the operation failed on all the storages
The Successful dict contains the value returned by the successful storages.
A special kwargs is 'inputProtocol', which can be specified for putFile. It describes
the protocol used as source protocol, since there is in principle only one.
"""
removedArgs = {}
log = self.log.getSubLogger('__executeMethod')
log.verbose("preparing the execution of %s" % (self.methodName))
# args should normaly be empty to avoid problem...
if args:
log.verbose("args should be empty!%s" % args)
# because there is normally only one kw argument, I can move it from args to kwargs
methDefaultArgs = StorageElementItem.__defaultsArguments.get(self.methodName, {}).keys()
if methDefaultArgs:
kwargs[methDefaultArgs[0]] = args[0]
args = args[1:]
log.verbose(
"put it in kwargs, but dirty and might be dangerous!args %s kwargs %s" %
(args, kwargs))
# We check the deprecated arguments
for depArg in StorageElementItem.__deprecatedArguments:
if depArg in kwargs:
log.verbose("%s is not an allowed argument anymore. Please change your code!" % depArg)
removedArgs[depArg] = kwargs[depArg]
del kwargs[depArg]
# Set default argument if any
methDefaultArgs = StorageElementItem.__defaultsArguments.get(self.methodName, {})
for argName in methDefaultArgs:
if argName not in kwargs:
log.debug("default argument %s for %s not present.\
Setting value %s." % (argName, self.methodName, methDefaultArgs[argName]))
kwargs[argName] = methDefaultArgs[argName]
res = checkArgumentFormat(lfn)
if not res['OK']:
errStr = "Supplied lfns must be string, list of strings or a dictionary."
log.debug(errStr)
return res
lfnDict = res['Value']
log.verbose(
"Attempting to perform '%s' operation with %s lfns." %
(self.methodName, len(lfnDict)))
res = self.isValid(operation=self.methodName)
if not res['OK']:
return res
else:
if not self.valid:
return S_ERROR(self.errorReason)
# In case executing putFile, we can assume that all the source urls
# are from the same protocol. This optional parameter, if defined
# can be used to ignore some storage plugins and thus save time
# and avoid fake failures showing in the accounting
inputProtocol = kwargs.pop('inputProtocol', None)
successful = {}
failed = {}
filteredPlugins = self.__filterPlugins(self.methodName, kwargs.get('protocols'), inputProtocol)
if not filteredPlugins:
return S_ERROR(errno.EPROTONOSUPPORT, "No storage plugins matching the requirements\
(operation %s protocols %s inputProtocol %s)" %
(self.methodName, kwargs.get('protocols'), inputProtocol))
# Try all of the storages one by one
for storage in filteredPlugins:
# Determine whether to use this storage object
storageParameters = storage.getParameters()
pluginName = storageParameters['PluginName']
if not lfnDict:
log.debug("No lfns to be attempted for %s protocol." % pluginName)
continue
log.verbose("Generating %s protocol URLs for %s." % (len(lfnDict), pluginName))
replicaDict = kwargs.pop('replicaDict', {})
if storage.pluginName != "Proxy":
res = self.__generateURLDict(lfnDict, storage, replicaDict=replicaDict)
urlDict = res['Value']['Successful'] # url : lfn
failed.update(res['Value']['Failed'])
else:
urlDict = dict([(lfn, lfn) for lfn in lfnDict])
if not urlDict:
log.verbose("__executeMethod No urls generated for protocol %s." % pluginName)
else:
log.verbose(
"Attempting to perform '%s' for %s physical files" %
(self.methodName, len(urlDict)))
fcn = None
if hasattr(storage, self.methodName) and callable(getattr(storage, self.methodName)):
fcn = getattr(storage, self.methodName)
if not fcn:
return S_ERROR(
DErrno.ENOMETH,
"SE.__executeMethod: unable to invoke %s, it isn't a member function of storage")
urlsToUse = {} # url : the value of the lfn dictionary for the lfn of this url
for url in urlDict:
urlsToUse[url] = lfnDict[urlDict[url]]
startDate = datetime.datetime.utcnow()
startTime = time.time()
res = fcn(urlsToUse, *args, **kwargs)
elapsedTime = time.time() - startTime
self.addAccountingOperation(urlsToUse, startDate, elapsedTime, storageParameters, res)
if not res['OK']:
errStr = "Completely failed to perform %s." % self.methodName
log.debug(errStr, 'with plugin %s: %s' % (pluginName, res['Message']))
for lfn in urlDict.values():
if lfn not in failed:
failed[lfn] = ''
failed[lfn] = "%s %s" % (failed[lfn], res['Message']) if failed[lfn] else res['Message']
else:
for url, lfn in urlDict.items():
if url not in res['Value']['Successful']:
if lfn not in failed:
failed[lfn] = ''
if url in res['Value']['Failed']:
self.log.debug(res['Value']['Failed'][url])
failed[lfn] = "%s %s" % (failed[lfn], res['Value']['Failed'][url]
) if failed[lfn] else res['Value']['Failed'][url]
else:
errStr = 'No error returned from plug-in'
failed[lfn] = "%s %s" % (failed[lfn], errStr) if failed[lfn] else errStr
else:
successful[lfn] = res['Value']['Successful'][url]
if lfn in failed:
failed.pop(lfn)
lfnDict.pop(lfn)
gDataStoreClient.commit()
return S_OK({'Failed': failed, 'Successful': successful})
def __getattr__(self, name):
""" Forwards the equivalent Storage calls to __executeMethod"""
# We take either the equivalent name, or the name itself
self.methodName = StorageElementItem.__equivalentMethodNames.get(name, None)
if self.methodName:
return self.__executeMethod
raise AttributeError("StorageElement does not have a method '%s'" % name)
def addAccountingOperation(self, lfns, startDate, elapsedTime, storageParameters, callRes):
"""
Generates a DataOperation accounting if needs to be, and adds it to the DataStore client cache
:param lfns : list of lfns on which we attempted the operation
:param startDate : datetime, start of the operation
:param elapsedTime : time (seconds) the operation took
:param storageParameters : the parameters of the plugins used to perform the operation
:param callRes : the return of the method call, S_OK or S_ERROR
The operation is generated with the OperationType "se.methodName"
The TransferSize and TransferTotal for directory methods actually take into
account the files inside the directory, and not the amount of directory given
as parameter
"""
if self.methodName not in (self.readMethods + self.writeMethods + self.removeMethods):
return
baseAccountingDict = {}
baseAccountingDict['OperationType'] = 'se.%s' % self.methodName
baseAccountingDict['User'] = getProxyInfo().get('Value', {}).get('username', 'unknown')
baseAccountingDict['RegistrationTime'] = 0.0
baseAccountingDict['RegistrationOK'] = 0
baseAccountingDict['RegistrationTotal'] = 0
# if it is a get method, then source and destination of the transfer should be inverted
if self.methodName == 'getFile':
baseAccountingDict['Destination'] = siteName()
baseAccountingDict['Source'] = self.name
else:
baseAccountingDict['Destination'] = self.name
baseAccountingDict['Source'] = siteName()
baseAccountingDict['TransferTotal'] = 0
baseAccountingDict['TransferOK'] = 0
baseAccountingDict['TransferSize'] = 0
baseAccountingDict['TransferTime'] = 0.0
baseAccountingDict['FinalStatus'] = 'Successful'
oDataOperation = DataOperation()
oDataOperation.setValuesFromDict(baseAccountingDict)
oDataOperation.setStartTime(startDate)
oDataOperation.setEndTime(startDate + datetime.timedelta(seconds=elapsedTime))
oDataOperation.setValueByKey('TransferTime', elapsedTime)
oDataOperation.setValueByKey('Protocol', storageParameters.get('Protocol', 'unknown'))
if not callRes['OK']:
# Everything failed
oDataOperation.setValueByKey('TransferTotal', len(lfns))
oDataOperation.setValueByKey('FinalStatus', 'Failed')
else:
succ = callRes.get('Value', {}).get('Successful', {})
failed = callRes.get('Value', {}).get('Failed', {})
totalSize = 0
# We don't take len(lfns) in order to make two
# separate entries in case of few failures
totalSucc = len(succ)
if self.methodName in ('putFile', 'getFile'):
# putFile and getFile return for each entry
# in the successful dir the size of the corresponding file
totalSize = sum(succ.values())
elif self.methodName in ('putDirectory', 'getDirectory'):
# putDirectory and getDirectory return for each dir name
# a dictionnary with the keys 'Files' and 'Size'
totalSize = sum(val.get('Size', 0) for val in succ.values() if isinstance(val, dict))
totalSucc = sum(val.get('Files', 0) for val in succ.values() if isinstance(val, dict))
oDataOperation.setValueByKey('TransferOK', len(succ))
oDataOperation.setValueByKey('TransferSize', totalSize)
oDataOperation.setValueByKey('TransferTotal', totalSucc)
oDataOperation.setValueByKey('TransferOK', totalSucc)
if callRes['Value']['Failed']:
oDataOperationFailed = copy.deepcopy(oDataOperation)
oDataOperationFailed.setValueByKey('TransferTotal', len(failed))
oDataOperationFailed.setValueByKey('TransferOK', 0)
oDataOperationFailed.setValueByKey('TransferSize', 0)
oDataOperationFailed.setValueByKey('FinalStatus', 'Failed')
accRes = gDataStoreClient.addRegister(oDataOperationFailed)
if not accRes['OK']:
self.log.error("Could not send failed accounting report", accRes['Message'])
accRes = gDataStoreClient.addRegister(oDataOperation)
if not accRes['OK']:
self.log.error("Could not send accounting report", accRes['Message'])
def getStorageElements(vo):
"""
Get configuration of storage elements
:param vo: VO name that an SE supports
:return: S_OK/S_ERROR, Value dictionary with key SE and value protocol list
"""
log = gLogger.getLocalSubLogger("RucioSynchronizer/%s" % vo)
seProtocols = {}
dms = DMSHelpers(vo=vo)
for seName in dms.getStorageElements():
se = StorageElement(seName)
if not se.valid:
log.warn("Storage element is not valid.", seName)
continue
if vo not in se.options.get("VO", []):
log.debug("SE is valid, but it doesn't support the VO. Skipped.",
"[SE: %s, VO: %s]" % (seName, vo))
continue
log.debug(" Processing a valid SE for VO: ",
"[SE:%s, VO:%s]" % (seName, vo))
log.debug("Available SE options ", se.options)
seProtocols[seName] = []
all_protocols = []
read_protocols = {}
protocols = se.options.get("AccessProtocols")
log.debug("Global AccessProtocols:",
"[VO: %s, protocols: %s]" % (vo, protocols))
if not protocols:
protocols = dms.getAccessProtocols()
if not protocols:
log.warn(
" No global or SE specific access protocols defined for SE ",
seName)
continue
log.debug("AccessProtocols:",
"[VO: %s, protocols:%s]" % (vo, protocols))
idx = 1
for prot in protocols:
read_protocols[prot] = idx
idx += 1
if prot not in all_protocols:
all_protocols.append(prot)
write_protocols = {}
protocols = se.options.get("WriteProtocols")
if not protocols:
if not protocols:
protocols = dms.getWriteProtocols()
if not protocols:
log.warn(
" No global or SE specific write protocols defined for SE ",
seName)
continue
idx = 1
for prot in protocols:
write_protocols[prot] = idx
idx += 1
if prot not in all_protocols:
all_protocols.append(prot)
mapping = {
"Protocol": "scheme",
"Host": "hostname",
"Port": "port",
"Path": "prefix"
}
for protocol in all_protocols:
space_token = None
params = {
"hostname": None,
"scheme": None,
"port": None,
"prefix": None,
"impl": "rucio.rse.protocols.gfal.Default",
"domains": {
"lan": {
"read": 0,
"write": 0,
"delete": 0
},
"wan": {
"read": 0,
"write": 0,
"delete": 0,
"third_party_copy": 0
},
},
}
res = se.getStorageParameters(protocol=protocol)
if res["OK"]:
values = res["Value"]
for key in [
"Protocol", "Host", "Access", "Path", "Port", "WSUrl",
"SpaceToken", "WSUrl", "PluginName"
]:
value = values.get(key)
if key in mapping:
params[mapping[key]] = value
else:
if key == "SpaceToken":
space_token = value
if params["scheme"] == "srm" and key == "WSUrl":
params["extended_attributes"] = {
"web_service_path": "%s" % value,
"space_token": space_token,
}
if key == "Protocol":
params["domains"]["lan"]["read"] = read_protocols.get(
value, 0)
params["domains"]["wan"]["read"] = read_protocols.get(
value, 0)
params["domains"]["lan"][
"write"] = write_protocols.get(value, 0)
params["domains"]["wan"][
"write"] = write_protocols.get(value, 0)
params["domains"]["lan"][
"delete"] = write_protocols.get(value, 0)
params["domains"]["wan"][
"delete"] = write_protocols.get(value, 0)
params["domains"]["wan"][
"third_party_copy"] = write_protocols.get(
value, 0)
seProtocols[seName].append(params)
log.debug("Accepted Dirac SEs: ", seProtocols)
return S_OK(seProtocols)
