rucio-clients 35.7.0__py3-none-any.whl

rucio/rse/__init__.py

@@ -0,0 +1,96 @@
+# Copyright European Organization for Nuclear Research (CERN) since 2012
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from dogpile.cache import make_region
+
+from rucio.common.utils import is_client
+from rucio.rse import rsemanager
+
+if is_client():
+    setattr(rsemanager, 'CLIENT_MODE', True)
+    setattr(rsemanager, 'SERVER_MODE', False)
+else:
+    setattr(rsemanager, 'CLIENT_MODE', False)
+    setattr(rsemanager, 'SERVER_MODE', True)
+
+
+def get_rse_client(rse, vo='def', **kwarg):
+    '''
+    get_rse_client
+    '''
+    from rucio.client.rseclient import RSEClient
+    client = RSEClient(vo=vo)
+    return client.get_rse(rse)
+
+
+def get_signed_url_client(rse, service, op, url, vo='def'):
+    '''
+    get_signed_url_client
+    '''
+    from rucio.client.credentialclient import CredentialClient
+    return CredentialClient(vo=vo).get_signed_url(rse, service, op, url)
+
+
+def get_signed_url_server(rse, service, op, url, vo='def'):
+    '''
+    get_signed_url_server
+    '''
+    from rucio.core.credential import get_signed_url
+    from rucio.core.rse import get_rse_id
+
+    rse_id = get_rse_id(rse=rse, vo=vo)
+    return get_signed_url(rse_id, service, op, url)
+
+
+def rse_key_generator(namespace, fn, **kwargs):
+    '''
+    Key generator for RSE
+    '''
+    def generate_key(rse, vo='def', session=None):
+        '''
+        generate_key
+        '''
+        return '{}:{}'.format(rse, vo)
+    return generate_key
+
+
+if rsemanager.CLIENT_MODE:   # pylint:disable=no-member
+    setattr(rsemanager, '__request_rse_info', get_rse_client)
+    setattr(rsemanager, '__get_signed_url', get_signed_url_client)
+
+    # Preparing region for dogpile.cache
+    RSE_REGION = make_region(function_key_generator=rse_key_generator).configure(
+        'dogpile.cache.memory',
+        expiration_time=900)
+    setattr(rsemanager, 'RSE_REGION', RSE_REGION)
+
+
+if rsemanager.SERVER_MODE:   # pylint:disable=no-member
+    from rucio.common.cache import make_region_memcached
+    from rucio.core.rse import get_rse_id, get_rse_protocols
+    from rucio.core.vo import map_vo
+
+    def tmp_rse_info(rse=None, vo='def', rse_id=None, session=None):
+        if rse_id is None:
+            # This can be called directly by client tools if they're co-located on a server
+            # i.e. running rucio cli on a server and during the test suite.
+            # We have to map to VO name here for this situations, despite this nominally
+            # not being a client interface.
+            rse_id = get_rse_id(rse=rse, vo=map_vo(vo))
+        return get_rse_protocols(rse_id=rse_id, session=session)
+
+    setattr(rsemanager, '__request_rse_info', tmp_rse_info)
+    setattr(rsemanager, '__get_signed_url', get_signed_url_server)
+    RSE_REGION = make_region_memcached(expiration_time=900)
+    setattr(rsemanager, 'RSE_REGION', RSE_REGION)

rucio/rse/protocols/__init__.py

@@ -0,0 +1,13 @@
+# Copyright European Organization for Nuclear Research (CERN) since 2012
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.

rucio/rse/protocols/bittorrent.py

@@ -0,0 +1,184 @@
+# Copyright European Organization for Nuclear Research (CERN) since 2012
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import base64
+import logging
+import os.path
+import time
+from urllib.parse import parse_qs, urlencode, urlparse
+
+from rucio.common import exception
+from rucio.common.extra import import_extras
+from rucio.common.utils import construct_torrent, resolve_ip
+from rucio.rse import rsemanager
+from rucio.rse.protocols.protocol import RSEProtocol
+
+EXTRA_MODULES = import_extras(['libtorrent'])
+
+lt = None
+if EXTRA_MODULES['libtorrent']:
+    import libtorrent as lt  # pylint: disable=E0401
+
+if getattr(rsemanager, 'CLIENT_MODE', None):
+    from rucio.client.didclient import DIDClient
+
+    def _fetch_meta_client(rse_id: str, scope: str, name: str):
+        return DIDClient().get_metadata(scope=scope, name=name, plugin='all')
+
+    _fetch_meta = _fetch_meta_client
+else:
+    from rucio.common.types import InternalScope
+    from rucio.core.did import get_metadata
+    from rucio.core.rse import get_rse_vo
+
+    def _fetch_meta_server(rse_id: str, scope: str, name: str):
+        vo = get_rse_vo(rse_id)
+        return get_metadata(scope=InternalScope(scope, vo=vo), name=name, plugin='all')
+
+    _fetch_meta = _fetch_meta_server
+
+
+class Default(RSEProtocol):
+
+    def __init__(self, protocol_attr, rse_settings, logger=logging.log):
+        super(Default, self).__init__(protocol_attr, rse_settings, logger=logger)
+        self.logger = logger
+
+    def lfns2pfns(self, lfns):
+        pfns = {}
+        prefix = self.attributes['prefix']
+
+        if not prefix.startswith('/'):
+            prefix = ''.join(['/', prefix])
+        if not prefix.endswith('/'):
+            prefix = ''.join([prefix, '/'])
+
+        host_port = '%s:%s' % (self.attributes['hostname'], str(self.attributes['port']))
+
+        lfns = [lfns] if isinstance(lfns, dict) else lfns
+        for lfn in lfns:
+            scope, name = lfn['scope'], lfn['name']
+
+            if 'path' in lfn and lfn['path'] is not None:
+                path = lfn['path'] if not lfn['path'].startswith('/') else lfn['path'][1:]
+            else:
+                path = self._get_path(scope=scope, name=name)
+
+            scope_name = '%s:%s' % (scope, name)
+
+            query = {
+                'x.pe': host_port,
+                'x.rucio_scope': scope,
+                'x.rucio_name': name,
+                'x.rucio_path': ''.join((prefix, path))
+            }
+            pfns[scope_name] = 'magnet:?' + urlencode(query)
+
+        return pfns
+
+    def parse_pfns(self, pfns):
+        ret = dict()
+        pfns = [pfns] if isinstance(pfns, str) else pfns
+
+        for pfn in pfns:
+            parsed = urlparse(pfn)
+            scheme = parsed.scheme
+
+            query = parse_qs(parsed.query)
+            host_port = next(iter(query.get('x.pe', [])), ':')
+            hostname, port = host_port.split(':')
+            port = int(port)
+            path = next(iter(query.get('x.rucio_path', [])), '')
+            scope = next(iter(query.get('x.rucio_scope', [])), '')
+            name = next(iter(query.get('x.rucio_name', [])), '')
+
+            # Protect against 'lazy' defined prefixes for RSEs in the repository
+            if not self.attributes['prefix'].startswith('/'):
+                self.attributes['prefix'] = '/' + self.attributes['prefix']
+            if not self.attributes['prefix'].endswith('/'):
+                self.attributes['prefix'] += '/'
+
+            if self.attributes['hostname'] != hostname:
+                if self.attributes['hostname'] != 'localhost':  # In the database empty hostnames are replaced with localhost but for some URIs (e.g. file) a hostname is not included
+                    raise exception.RSEFileNameNotSupported('Invalid hostname: provided \'%s\', expected \'%s\'' % (hostname, self.attributes['hostname']))
+
+            if self.attributes['port'] != port:
+                raise exception.RSEFileNameNotSupported('Invalid port: provided \'%s\', expected \'%s\'' % (port, self.attributes['port']))
+
+            if not path.startswith(self.attributes['prefix']):
+                raise exception.RSEFileNameNotSupported('Invalid prefix: provided \'%s\', expected \'%s\'' % ('/'.join(path.split('/')[0:len(self.attributes['prefix'].split('/')) - 1]),
+                                                                                                              self.attributes['prefix']))  # len(...)-1 due to the leading '/
+
+            # Splitting parsed.path into prefix, path, filename
+            prefix = self.attributes['prefix']
+            path = path.partition(self.attributes['prefix'])[2]
+            path = '/'.join(path.split('/')[:-1])
+            if not path.startswith('/'):
+                path = '/' + path
+            if path != '/' and not path.endswith('/'):
+                path = path + '/'
+            ret[pfn] = {'path': path, 'scope': scope, 'name': name, 'scheme': scheme, 'prefix': prefix, 'port': port, 'hostname': hostname, }
+
+        return ret
+
+    def connect(self):
+        pass
+
+    def close(self):
+        pass
+
+    def get(self, path, dest, transfer_timeout=None):
+        if not lt:
+            raise exception.RucioException('The libtorrent python package is required to perform this operation')
+
+        [lfn] = self.parse_pfns([path]).values()
+        scope = lfn['scope']
+        name = lfn['name']
+        hostname = lfn['hostname']
+        port = lfn['port']
+
+        meta = _fetch_meta(rse_id=self.rse['id'], scope=scope, name=name)
+        pieces_root = base64.b64decode(meta.get('bittorrent_pieces_root', ''))
+        if not pieces_root:
+            raise exception.RucioException('Torrent metadata missing. Cannot download file.')
+
+        length = meta.get('bytes')
+        piece_length = meta.get('bittorrent_piece_length', 0)
+        pieces_layers = base64.b64decode(meta.get('bittorrent_pieces_layers', ''))
+
+        _, torrent = construct_torrent(
+            scope=scope,
+            name=name,
+            length=length,
+            piece_length=piece_length,
+            pieces_root=pieces_root,
+            pieces_layers=pieces_layers,
+        )
+
+        ses = lt.session()  # type: ignore # noqa
+        params = {
+            'ti': lt.torrent_info(torrent),  # type: ignore # noqa
+            'save_path': os.path.dirname(dest),
+            'name': os.path.basename(dest),
+            'renamed_files': {0: os.path.basename(dest)},
+        }
+
+        handle = ses.add_torrent(params)
+        try:
+            handle.resume()
+            handle.connect_peer((resolve_ip(hostname), port))
+            while handle.status().progress != 1.0:
+                time.sleep(0.25)
+        finally:
+            ses.remove_torrent(handle)

rucio/rse/protocols/cache.py

@@ -0,0 +1,122 @@
+# Copyright European Organization for Nuclear Research (CERN) since 2012
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from rucio.rse.protocols import protocol
+
+
+class Default(protocol.RSEProtocol):
+    """ Implementing access to RSEs using the local filesystem."""
+
+    def __init__(self, protocol_attr, rse_settings, logger=None):
+        """ Initializes the object with information about the referred RSE.
+
+            :param props: Properties derived from the RSE Repository
+        """
+        super(Default, self).__init__(protocol_attr, rse_settings, logger=logger)
+        self.attributes.pop('determinism_type', None)
+        self.files = []
+
+    def _get_path(self, scope, name):
+        """ Transforms the physical file name into the local URI in the referred RSE.
+            Suitable for sites implementoing the RUCIO naming convention.
+
+            :param name: filename
+            :param scope: scope
+
+            :returns: RSE specific URI of the physical file
+        """
+        return '%s/%s' % (scope, name)
+
+    def path2pfn(self, path):
+        """
+            Returns a fully qualified PFN for the file referred by path.
+
+            :param path: The path to the file.
+
+            :returns: Fully qualified PFN.
+
+        """
+        return ''.join([self.rse['scheme'], '://%s' % self.rse['hostname'], path])
+
+    def exists(self, pfn):
+        """ Checks if the requested file is known by the referred RSE.
+
+            :param pfn: Physical file name
+
+            :returns: True if the file exists, False if it doesn't
+
+            :raise  ServiceUnavailable
+        """
+        raise NotImplementedError
+
+    def connect(self):
+        """ Establishes the actual connection to the referred RSE.
+
+            :param credentials: Provide all necessary information to establish a connection
+                to the referred storage system. Some is loaded from the repository inside the
+                RSE class and some must be provided specific for the SFTP protocol like
+                username, password, private_key, private_key_pass, port.
+                For details about possible additional parameters and details about their usage
+                see the pysftp.Connection() documentation.
+                NOTE: the host parametrer is overwritten with the value provided by the repository
+
+            :raise RSEAccessDenied
+        """
+        raise NotImplementedError
+
+    def close(self):
+        """ Closes the connection to RSE."""
+        raise NotImplementedError
+
+    def get(self, pfn, dest, transfer_timeout=None):
+        """ Provides access to files stored inside connected the RSE.
+
+            :param pfn: Physical file name of requested file
+            :param dest: Name and path of the files when stored at the client
+            :param transfer_timeout Transfer timeout (in seconds)
+
+            :raises DestinationNotAccessible, ServiceUnavailable, SourceNotFound
+         """
+        raise NotImplementedError
+
+    def put(self, source, target, source_dir=None, transfer_timeout=None):
+        """ Allows to store files inside the referred RSE.
+
+            :param source: Physical file name
+            :param target: Name of the file on the storage system e.g. with prefixed scope
+            :param source_dir Path where the to be transferred files are stored in the local file system
+            :param transfer_timeout Transfer timeout (in seconds)
+
+            :raises DestinationNotAccessible, ServiceUnavailable, SourceNotFound
+        """
+        raise NotImplementedError
+
+    def delete(self, pfn):
+        """ Deletes a file from the connected RSE.
+
+            :param pfn: Physical file name
+
+            :raises ServiceUnavailable, SourceNotFound
+        """
+        raise NotImplementedError
+
+    def rename(self, pfn, new_pfn):
+        """ Allows to rename a file stored inside the connected RSE.
+
+            :param pfn:      Current physical file name
+            :param new_pfn  New physical file name
+
+            :raises DestinationNotAccessible, ServiceUnavailable, SourceNotFound
+        """
+        raise NotImplementedError

rucio/rse/protocols/dummy.py

@@ -0,0 +1,111 @@
+# Copyright European Organization for Nuclear Research (CERN) since 2012
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from rucio.rse.protocols import protocol
+
+
+class Default(protocol.RSEProtocol):
+    """ Implementing access to RSEs using the local filesystem."""
+
+    def __init__(self, protocol_attr, rse_settings, logger=None):
+        """ Initializes the object with information about the referred RSE.
+
+            :param props: Properties derived from the RSE Repository
+        """
+        super(Default, self).__init__(protocol_attr, rse_settings, logger=logger)
+        self.attributes.pop('determinism_type', None)
+        self.files = []
+
+    def path2pfn(self, path):
+        """
+            Returns a fully qualified PFN for the file referred by path.
+
+            :param path: The path to the file.
+
+            :returns: Fully qualified PFN.
+
+        """
+        return ''.join([self.rse['scheme'], '://%s' % self.rse['hostname'], path])
+
+    def exists(self, pfn):
+        """ Checks if the requested file is known by the referred RSE.
+
+            :param pfn: Physical file name
+
+            :returns: True if the file exists, False if it doesn't
+
+            :raise  ServiceUnavailable
+        """
+        raise NotImplementedError
+
+    def connect(self):
+        """ Establishes the actual connection to the referred RSE.
+
+            :param credentials: Provide all necessary information to establish a connection
+                to the referred storage system. Some is loaded from the repository inside the
+                RSE class and some must be provided specific for the SFTP protocol like
+                username, password, private_key, private_key_pass, port.
+                For details about possible additional parameters and details about their usage
+                see the pysftp.Connection() documentation.
+                NOTE: the host parametrer is overwritten with the value provided by the repository
+
+            :raise RSEAccessDenied
+        """
+        raise NotImplementedError
+
+    def close(self):
+        """ Closes the connection to RSE."""
+        raise NotImplementedError
+
+    def get(self, pfn, dest, transfer_timeout=None):
+        """ Provides access to files stored inside connected the RSE.
+
+            :param pfn: Physical file name of requested file
+            :param dest: Name and path of the files when stored at the client
+            :param transfer_timeout Transfer timeout (in seconds)
+
+            :raises DestinationNotAccessible, ServiceUnavailable, SourceNotFound
+         """
+        raise NotImplementedError
+
+    def put(self, source, target, source_dir=None, transfer_timeout=None):
+        """ Allows to store files inside the referred RSE.
+
+            :param source: Physical file name
+            :param target: Name of the file on the storage system e.g. with prefixed scope
+            :param source_dir Path where the to be transferred files are stored in the local file system
+            :param transfer_timeout Transfer timeout (in seconds)
+
+            :raises DestinationNotAccessible, ServiceUnavailable, SourceNotFound
+        """
+        raise NotImplementedError
+
+    def delete(self, pfn):
+        """ Deletes a file from the connected RSE.
+
+            :param pfn: Physical file name
+
+            :raises ServiceUnavailable, SourceNotFound
+        """
+        raise NotImplementedError
+
+    def rename(self, pfn, new_pfn):
+        """ Allows to rename a file stored inside the connected RSE.
+
+            :param pfn:      Current physical file name
+            :param new_pfn  New physical file name
+
+            :raises DestinationNotAccessible, ServiceUnavailable, SourceNotFound
+        """
+        raise NotImplementedError