# 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 copy import enum import itertools import logging import os import random import secrets import shutil import signal import subprocess import time from queue import Empty, Queue, deque from threading import Thread from typing import Any, Optional from rucio import version from rucio.client.client import Client from rucio.common.config import config_get from rucio.common.didtype import DID from rucio.common.exception import InputValidationError, NoFilesDownloaded, NotAllFilesDownloaded, RucioException from rucio.common.pcache import Pcache from rucio.common.utils import CHECKSUM_ALGO_DICT, GLOBALLY_SUPPORTED_CHECKSUMS, PREFERRED_CHECKSUM, adler32, detect_client_location, execute, extract_scope, generate_uuid, parse_replicas_from_file, parse_replicas_from_string, send_trace, sizefmt from rucio.rse import rsemanager as rsemgr @enum.unique class FileDownloadState(str, enum.Enum): """ The state a file can be in before/while/after downloading. """ PROCESSING = "PROCESSING" DOWNLOAD_ATTEMPT = "DOWNLOAD_ATTEMPT" DONE = "DONE" ALREADY_DONE = "ALREADY_DONE" FOUND_IN_PCACHE = "FOUND_IN_PCACHE" FILE_NOT_FOUND = "FILE_NOT_FOUND" FAIL_VALIDATE = "FAIL_VALIDATE" FAILED = "FAILED" class BaseExtractionTool: def __init__(self, program_name, useability_check_args, extract_args, logger=logging.log): """ Initialises a extraction tool object :param program_name: the name of the archive extraction program, e.g., unzip :param useability_check_args: the arguments of the extraction program to test if its installed, e.g., --version :param extract_args: the arguments that will be passed to the program for extraction :param logger: optional decorated logging.log object that can be passed from the calling daemon or client. """ self.program_name = program_name self.useability_check_args = useability_check_args self.extract_args = extract_args self.logger = logger self.is_useable_result = None def is_useable(self): """ Checks if the extraction tool is installed and usable :returns: True if it is usable otherwise False """ if self.is_useable_result is not None: return self.is_useable_result self.is_usable_result = False cmd = '%s %s' % (self.program_name, self.useability_check_args) try: exitcode, out, err = execute(cmd) exitcode = int(exitcode) self.logger(logging.DEBUG, '"%s" returned with exitcode %d' % (cmd, exitcode)) self.is_usable_result = (exitcode == 0) except Exception as error: self.logger(logging.DEBUG, 'Failed to execute: "%s"' % cmd) self.logger(logging.DEBUG, error) return self.is_usable_result def try_extraction(self, archive_file_path, file_to_extract, dest_dir_path): """ Calls the extraction program to extract a file from an archive :param archive_file_path: path to the archive :param file_to_extract: file name to extract from the archive :param dest_dir_path: destination directory where the extracted file will be stored :returns: True on success otherwise False """ if not self.is_useable(): return False args_map = {'archive_file_path': archive_file_path, 'file_to_extract': file_to_extract, 'dest_dir_path': dest_dir_path} extract_args = self.extract_args % args_map cmd = '%s %s' % (self.program_name, extract_args) try: exitcode, out, err = execute(cmd) exitcode = int(exitcode) self.logger(logging.DEBUG, '"%s" returned with exitcode %d' % (cmd, exitcode)) return (exitcode == 0) except Exception as error: self.logger(logging.DEBUG, 'Failed to execute: "%s"' % cmd) self.logger(logging.DEBUG, error) return False class DownloadClient: def __init__(self, client=None, logger=None, tracing=True, check_admin=False, check_pcache=False): """ Initialises the basic settings for an DownloadClient object :param client: Optional: rucio.client.client.Client object. If None, a new object will be created. :param external_traces: Optional: reference to a list where traces can be added :param logger: Optional: logging.Logger object. If None, default logger will be used. """ self.check_pcache = check_pcache if not logger: self.logger = logging.log else: self.logger = logger.log self.tracing = tracing if not self.tracing: logger(logging.DEBUG, 'Tracing is turned off.') self.is_human_readable = True self.client = client if client else Client() # if token should be used, use only JWT tokens self.auth_token = self.client.auth_token if len(self.client.auth_token.split(".")) == 3 else None self.client_location = detect_client_location() self.is_tape_excluded = True self.is_admin = False if check_admin: account_attributes = list(self.client.list_account_attributes(self.client.account)) for attr in account_attributes[0]: if attr['key'] == 'admin': self.is_admin = attr['value'] is True break if self.is_admin: self.is_tape_excluded = False logger(logging.DEBUG, 'Admin mode enabled') self.trace_tpl = {} self.trace_tpl['hostname'] = self.client_location['fqdn'] self.trace_tpl['localSite'] = self.client_location['site'] self.trace_tpl['account'] = self.client.account if self.client.vo != 'def': self.trace_tpl['vo'] = self.client.vo self.trace_tpl['eventType'] = 'download' self.trace_tpl['eventVersion'] = 'api_%s' % version.RUCIO_VERSION[0] self.use_cea_threshold = 10 self.extraction_tools = [] # unzip -d extract_args = '%(archive_file_path)s %(file_to_extract)s -d %(dest_dir_path)s' self.extraction_tools.append(BaseExtractionTool('unzip', '-v', extract_args, logger=self.logger)) # tar -C -xf extract_args = '-C %(dest_dir_path)s -xf %(archive_file_path)s %(file_to_extract)s' self.extraction_tools.append(BaseExtractionTool('tar', '--version', extract_args, logger=self.logger)) self.extract_scope_convention = config_get('common', 'extract_scope', False, None) def download_pfns( self, items: list[dict[str, Any]], num_threads: int = 2, trace_custom_fields: Optional[dict[str, Any]] = None, traces_copy_out: Optional[list[dict[str, Any]]] = None, deactivate_file_download_exceptions: bool = False ) -> list[dict[str, Any]]: """ Download items with a given PFN. This function can only download files, no datasets. :param items: List of dictionaries. Each dictionary describing a file to download. Keys: pfn - PFN string of this file did - DID string of this file (e.g. 'scope:file.name'). Wildcards are not allowed rse - rse name (e.g. 'CERN-PROD_DATADISK'). RSE Expressions are not allowed base_dir - Optional: Base directory where the downloaded files will be stored. (Default: '.') no_subdir - Optional: If true, files are written directly into base_dir. (Default: False) adler32 - Optional: The adler32 checmsum to compare the downloaded files adler32 checksum with md5 - Optional: The md5 checksum to compare the downloaded files md5 checksum with transfer_timeout - Optional: Timeout time for the download protocols. (Default: None) check_local_with_filesize_only - Optional: If true, already downloaded files will not be validated by checksum. :param num_threads: Suggestion of number of threads to use for the download. It will be lowered if it's too high. :param trace_custom_fields: Custom key value pairs to send with the traces :param traces_copy_out: reference to an external list, where the traces should be uploaded :param deactivate_file_download_exceptions: Boolean, if file download exceptions shouldn't be raised :returns: a list of dictionaries with an entry for each file, containing the input options, the did, and the clientState clientState can be one of the following: ALREADY_DONE, DONE, FILE_NOT_FOUND, FAIL_VALIDATE, FAILED :raises InputValidationError: if one of the input items is in the wrong format :raises NoFilesDownloaded: if no files could be downloaded :raises NotAllFilesDownloaded: if not all files could be downloaded :raises RucioException: if something unexpected went wrong during the download """ trace_custom_fields = trace_custom_fields or {} logger = self.logger trace_custom_fields['uuid'] = generate_uuid() logger(logging.INFO, 'Processing %d item(s) for input' % len(items)) input_items = [] for item in items: did_str = item.get('did') pfn = item.get('pfn') rse = item.get('rse') item['input_dids'] = {DID(did_str): {}} if not did_str or not pfn or not rse: logger(logging.DEBUG, item) raise InputValidationError('The keys did, pfn, and rse are mandatory') logger(logging.DEBUG, 'Preparing PFN download of %s (%s) from %s' % (did_str, pfn, rse)) if '*' in did_str: logger(logging.DEBUG, did_str) raise InputValidationError('Cannot use PFN download with wildcard in DID') did_scope, did_name = self._split_did_str(did_str) dest_dir_path = self._prepare_dest_dir(item.get('base_dir', '.'), did_scope, item.get('no_subdir')) item['scope'] = did_scope item['name'] = did_name item['sources'] = [{'pfn': pfn, 'rse': rse}] did_path_name = did_name if did_name.startswith('/'): did_path_name = did_name[1:] dest_file_path = os.path.join(dest_dir_path, did_path_name) item['dest_file_paths'] = [dest_file_path] item['temp_file_path'] = '%s.part' % dest_file_path options = item.setdefault('merged_options', {}) options['ignore_checksum'] = 'adler32' not in item and 'md5' not in item options.setdefault('transfer_timeout', item.pop('transfer_timeout', None)) input_items.append(item) num_files_in = len(input_items) output_items = self._download_multithreaded(input_items, num_threads, trace_custom_fields, traces_copy_out) num_files_out = len(output_items) if not deactivate_file_download_exceptions and num_files_in != num_files_out: raise RucioException('%d items were in the input queue but only %d are in the output queue' % (num_files_in, num_files_out)) return self._check_output(output_items, deactivate_file_download_exceptions=deactivate_file_download_exceptions) def download_dids( self, items: list[dict[str, Any]], num_threads: int = 2, trace_custom_fields: Optional[dict[str, Any]] = None, traces_copy_out: Optional[list[dict[str, Any]]] = None, deactivate_file_download_exceptions: bool = False, sort: Optional[str] = None ) -> list[dict[str, Any]]: """ Download items with given DIDs. This function can also download datasets and wildcarded DIDs. :param items: List of dictionaries. Each dictionary describing an item to download. Keys: did - DID string of this file (e.g. 'scope:file.name') filters - Filter to select DIDs for download. Optional if DID is given rse - Optional: rse name (e.g. 'CERN-PROD_DATADISK') or rse expression from where to download impl - Optional: name of the protocol implementation to be used to download this item. no_resolve_archives - Optional: bool indicating whether archives should not be considered for download (Default: False) resolve_archives - Deprecated: Use no_resolve_archives instead force_scheme - Optional: force a specific scheme to download this item. (Default: None) base_dir - Optional: base directory where the downloaded files will be stored. (Default: '.') no_subdir - Optional: If true, files are written directly into base_dir. (Default: False) nrandom - Optional: if the DID addresses a dataset, nrandom files will be randomly chosen for download from the dataset ignore_checksum - Optional: If true, skips the checksum validation between the downloaded file and the rucio catalouge. (Default: False) transfer_timeout - Optional: Timeout time for the download protocols. (Default: None) transfer_speed_timeout - Optional: Minimum allowed transfer speed (in KBps). Ignored if transfer_timeout set. Otherwise, used to compute default timeout (Default: 500) check_local_with_filesize_only - Optional: If true, already downloaded files will not be validated by checksum. :param num_threads: Suggestion of number of threads to use for the download. It will be lowered if it's too high. :param trace_custom_fields: Custom key value pairs to send with the traces. :param traces_copy_out: reference to an external list, where the traces should be uploaded :param deactivate_file_download_exceptions: Boolean, if file download exceptions shouldn't be raised :param sort: Select best replica by replica sorting algorithm. Available algorithms: ``geoip`` - based on src/dst IP topographical distance ``closeness`` - based on src/dst closeness ``dynamic`` - Rucio Dynamic Smart Sort (tm) :returns: a list of dictionaries with an entry for each file, containing the input options, the did, and the clientState :raises InputValidationError: if one of the input items is in the wrong format :raises NoFilesDownloaded: if no files could be downloaded :raises NotAllFilesDownloaded: if not all files could be downloaded :raises RucioException: if something unexpected went wrong during the download """ trace_custom_fields = trace_custom_fields or {} logger = self.logger trace_custom_fields['uuid'] = generate_uuid() logger(logging.INFO, 'Processing %d item(s) for input' % len(items)) did_to_input_items, file_items_with_sources = self._resolve_and_merge_input_items(copy.deepcopy(items), sort=sort) self.logger(logging.DEBUG, 'num_unmerged_items=%d; num_dids=%d; num_file_items=%d' % (len(items), len(did_to_input_items), len(file_items_with_sources))) input_items = self._prepare_items_for_download(did_to_input_items, file_items_with_sources) num_files_in = len(input_items) output_items = self._download_multithreaded(input_items, num_threads, trace_custom_fields, traces_copy_out) num_files_out = len(output_items) if not deactivate_file_download_exceptions and num_files_in != num_files_out: raise RucioException('%d items were in the input queue but only %d are in the output queue' % (num_files_in, num_files_out)) return self._check_output(output_items, deactivate_file_download_exceptions=deactivate_file_download_exceptions) def download_from_metalink_file( self, item: dict[str, Any], metalink_file_path: str, num_threads: int = 2, trace_custom_fields: Optional[dict[str, Any]] = None, traces_copy_out: Optional[list[dict[str, Any]]] = None, deactivate_file_download_exceptions: bool = False ) -> list[dict[str, Any]]: """ Download items using a given metalink file. :param item: dictionary describing an item to download. Keys: base_dir - Optional: base directory where the downloaded files will be stored. (Default: '.') no_subdir - Optional: If true, files are written directly into base_dir. (Default: False) ignore_checksum - Optional: If true, skips the checksum validation between the downloaded file and the rucio catalouge. (Default: False) transfer_timeout - Optional: Timeout time for the download protocols. (Default: None) check_local_with_filesize_only - Optional: If true, already downloaded files will not be validated by checksum. :param num_threads: Suggestion of number of threads to use for the download. It will be lowered if it's too high. :param trace_custom_fields: Custom key value pairs to send with the traces. :param traces_copy_out: reference to an external list, where the traces should be uploaded :param deactivate_file_download_exceptions: Boolean, if file download exceptions shouldn't be raised :returns: a list of dictionaries with an entry for each file, containing the input options, the did, and the clientState :raises InputValidationError: if one of the input items is in the wrong format :raises NoFilesDownloaded: if no files could be downloaded :raises NotAllFilesDownloaded: if not all files could be downloaded :raises RucioException: if something unexpected went wrong during the download """ trace_custom_fields = trace_custom_fields or {} logger = self.logger logger(logging.INFO, 'Getting sources from metalink file') metalinks = parse_replicas_from_file(metalink_file_path) trace_custom_fields['uuid'] = generate_uuid() did_to_options = {} for metalink in metalinks: did = DID(metalink['did']) did_to_options[did] = [item] metalink['input_dids'] = {did: {}} input_items = self._prepare_items_for_download(did_to_options, metalinks) num_files_in = len(input_items) output_items = self._download_multithreaded(input_items, num_threads, trace_custom_fields, traces_copy_out) num_files_out = len(output_items) if not deactivate_file_download_exceptions and num_files_in != num_files_out: raise RucioException('%d items were in the input queue but only %d are in the output queue' % (num_files_in, num_files_out)) return self._check_output(output_items, deactivate_file_download_exceptions=deactivate_file_download_exceptions) def _download_multithreaded( self, input_items: list[dict[str, Any]], num_threads: int, trace_custom_fields: Optional[dict[str, Any]] = None, traces_copy_out: Optional[list[dict[str, Any]]] = None ) -> list[dict[str, Any]]: """ Starts an appropriate number of threads to download items from the input list. (This function is meant to be used as class internal only) :param input_items: list containing the input items to download :param num_threads: suggestion of how many threads should be started :param trace_custom_fields: Custom key value pairs to send with the traces :param traces_copy_out: reference to an external list, where the traces should be uploaded :returns: list with output items as dictionaries """ trace_custom_fields = trace_custom_fields or {} logger = self.logger num_files = len(input_items) nlimit = 5 num_threads = max(1, num_threads) num_threads = min(num_files, num_threads, nlimit) input_queue = Queue() output_queue = Queue() input_queue.queue = deque(input_items) if num_threads < 2: logger(logging.INFO, 'Using main thread to download %d file(s)' % num_files) self._download_worker(input_queue, output_queue, trace_custom_fields, traces_copy_out, '') return list(output_queue.queue) logger(logging.INFO, 'Using %d threads to download %d files' % (num_threads, num_files)) threads = [] for thread_num in range(0, num_threads): log_prefix = 'Thread %s/%s: ' % (thread_num, num_threads) kwargs = {'input_queue': input_queue, 'output_queue': output_queue, 'trace_custom_fields': trace_custom_fields, 'traces_copy_out': traces_copy_out, 'log_prefix': log_prefix} try: thread = Thread(target=self._download_worker, kwargs=kwargs) thread.start() threads.append(thread) except Exception as error: logger(logging.WARNING, 'Failed to start thread %d' % thread_num) logger(logging.DEBUG, error) try: logger(logging.DEBUG, 'Waiting for threads to finish') for thread in threads: thread.join() except KeyboardInterrupt: logger(logging.WARNING, 'You pressed Ctrl+C! Exiting gracefully') for thread in threads: thread.kill_received = True return list(output_queue.queue) def _download_worker(self, input_queue, output_queue, trace_custom_fields, traces_copy_out, log_prefix): """ This function runs as long as there are items in the input queue, downloads them and stores the output in the output queue. (This function is meant to be used as class internal only) :param input_queue: queue containing the input items to download :param output_queue: queue where the output items will be stored :param trace_custom_fields: Custom key value pairs to send with the traces :param traces_copy_out: reference to an external list, where the traces should be uploaded :param log_prefix: string that will be put at the beginning of every log message """ logger = self.logger logger(logging.DEBUG, '%sStart processing queued downloads' % log_prefix) while True: try: item = input_queue.get_nowait() except Empty: break try: trace = copy.deepcopy(self.trace_tpl) trace.update(trace_custom_fields) download_result = self._download_item(item, trace, traces_copy_out, log_prefix) output_queue.put(download_result) except KeyboardInterrupt: logger(logging.WARNING, 'You pressed Ctrl+C! Exiting gracefully') os.kill(os.getpgid(), signal.SIGINT) break except Exception as error: logger(logging.ERROR, '%sFailed to download item' % log_prefix) logger(logging.DEBUG, error) item["clientState"] = "FAILED" output_queue.put(item) @staticmethod def _compute_actual_transfer_timeout(item): """ Merge the two options related to timeout into the value which will be used for protocol download. :param item: dictionary that describes the item to download :return: timeout in seconds """ default_transfer_timeout = 360 default_transfer_speed_timeout = 500 # KBps # Static additive increment of the speed timeout. To include the static cost of # establishing connections and download of small files transfer_speed_timeout_static_increment = 60 transfer_timeout = item.get('merged_options', {}).get('transfer_timeout') if transfer_timeout is not None: return transfer_timeout transfer_speed_timeout = item.get('merged_options', {}).get('transfer_speed_timeout') bytes_ = item.get('bytes') if not bytes_ or transfer_speed_timeout is None: return default_transfer_timeout if not transfer_speed_timeout > 0: transfer_speed_timeout = default_transfer_speed_timeout # Convert from KBytes/s to bytes/s transfer_speed_timeout = transfer_speed_timeout * 1000 timeout = bytes_ // transfer_speed_timeout + transfer_speed_timeout_static_increment return timeout def _download_item(self, item, trace, traces_copy_out, log_prefix=''): """ Downloads the given item and sends traces for success/failure. (This function is meant to be used as class internal only) :param item: dictionary that describes the item to download :param trace: dictionary representing a pattern of trace that will be send :param traces_copy_out: reference to an external list, where the traces should be uploaded :param log_prefix: string that will be put at the beginning of every log message :returns: dictionary with all attributes from the input item and a clientState attribute """ logger = self.logger pcache = Pcache() if self.check_pcache and len(item.get('archive_items', [])) == 0 else None did_scope = item['scope'] did_name = item['name'] did_str = '%s:%s' % (did_scope, did_name) logger(logging.INFO, '%sPreparing download of %s' % (log_prefix, did_str)) trace['scope'] = did_scope trace['filename'] = did_name trace.setdefault('datasetScope', item.get('dataset_scope', '')) trace.setdefault('dataset', item.get('dataset_name', '')) trace.setdefault('filesize', item.get('bytes')) trace.setdefault('clientState', FileDownloadState.PROCESSING) trace.setdefault('stateReason', 'UNKNOWN') dest_file_paths = item['dest_file_paths'] # appending trace to list reference, if the reference exists if traces_copy_out is not None: traces_copy_out.append(trace) # if file already exists make sure it exists at all destination paths, set state, send trace, and return for dest_file_path in dest_file_paths: if os.path.isfile(dest_file_path): if item.get('merged_options', {}).get('check_local_with_filesize_only', False): local_filesize = os.stat(dest_file_path).st_size if item.get('bytes') != local_filesize: logger(logging.INFO, '%sFile with same name exists locally, but filesize mismatches: %s' % (log_prefix, did_str)) logger(logging.DEBUG, '%slocal filesize: %d bytes, expected filesize: %d bytes' % (log_prefix, local_filesize, item.get('bytes'))) continue elif not item.get('merged_options', {}).get('ignore_checksum', False): verified, _, _ = _verify_checksum(item, dest_file_path) if not verified: logger(logging.INFO, '%sFile with same name exists locally, but checksum mismatches: %s' % (log_prefix, did_str)) continue logger(logging.INFO, '%sFile exists already locally: %s' % (log_prefix, did_str)) for missing_file_path in dest_file_paths: if not os.path.isfile(missing_file_path): logger(logging.DEBUG, "copying '%s' to '%s'" % (dest_file_path, missing_file_path)) shutil.copy2(dest_file_path, missing_file_path) item['clientState'] = FileDownloadState.ALREADY_DONE trace['transferStart'] = time.time() trace['transferEnd'] = time.time() trace['clientState'] = FileDownloadState.ALREADY_DONE send_trace(trace, self.client.host, self.client.user_agent) return item # check if file has replicas sources = item.get('sources') if not sources or not len(sources): logger(logging.WARNING, '%sNo available source found for file: %s' % (log_prefix, did_str)) item['clientState'] = FileDownloadState.FILE_NOT_FOUND trace['clientState'] = FileDownloadState.FILE_NOT_FOUND trace['stateReason'] = 'No available sources' self._send_trace(trace) return item # checking Pcache storage_prefix = None if pcache: # to check only first replica is enough pfn = sources[0]['pfn'] rse_name = sources[0]['rse'] # protocols are needed to extract deterministic part of the pfn scheme = None prots = self.client.get_protocols(rse_name) for prot in prots: if prot['scheme'] in pfn and prot['prefix'] in pfn: scheme = prot['scheme'] storage_prefix = prot['prefix'] # proceed with the actual check logger(logging.INFO, 'Checking whether %s is in pcache' % dest_file_path) pcache_state = None hardlink_state = None try: pcache_state, hardlink_state = pcache.check_and_link(src=pfn, storage_root=storage_prefix, dst=dest_file_path) except Exception as e: logger(logging.WARNING, 'Pcache failure: %s' % str(e)) # if file found in pcache, send trace and return if pcache_state == 0 and hardlink_state == 1: logger(logging.INFO, 'File found in pcache.') item['clientState'] = FileDownloadState.FOUND_IN_PCACHE trace['transferStart'] = time.time() trace['transferEnd'] = time.time() trace['clientState'] = FileDownloadState.FOUND_IN_PCACHE self._send_trace(trace) return item else: logger(logging.INFO, 'File not found in pcache.') # try different PFNs until one succeeded temp_file_path = item['temp_file_path'] success = False i = 0 while not success and i < len(sources): source = sources[i] i += 1 pfn = source['pfn'] rse_name = source['rse'] scheme = pfn.split(':')[0] try: rse = rsemgr.get_rse_info(rse_name, vo=self.client.vo) except RucioException as error: logger(logging.WARNING, '%sCould not get info of RSE %s: %s' % (log_prefix, rse_name, error)) trace['stateReason'] = str(error) continue trace['remoteSite'] = rse_name trace['clientState'] = FileDownloadState.DOWNLOAD_ATTEMPT trace['protocol'] = scheme transfer_timeout = self._compute_actual_transfer_timeout(item) timeout_log_string = "" if transfer_timeout: timeout_log_string = " and timeout of %ds" % transfer_timeout logger(logging.INFO, '%sTrying to download with %s%s from %s: %s ' % (log_prefix, scheme, timeout_log_string, rse_name, did_str)) impl = item.get('impl') if impl: logger(logging.INFO, '%sUsing Implementation (impl): %s ' % (log_prefix, impl)) try: protocol = rsemgr.create_protocol(rse, operation='read', scheme=scheme, impl=impl, auth_token=self.auth_token, logger=logger) protocol.connect() except Exception as error: logger(logging.WARNING, '%sFailed to create protocol for PFN: %s' % (log_prefix, pfn)) logger(logging.DEBUG, 'scheme: %s, exception: %s' % (scheme, error)) trace['stateReason'] = str(error) continue logger(logging.INFO, '%sUsing PFN: %s' % (log_prefix, pfn)) attempt = 0 retries = 2 # do some retries with the same PFN if the download fails while not success and attempt < retries: attempt += 1 item['attemptnr'] = attempt if os.path.isfile(temp_file_path): logger(logging.DEBUG, '%sDeleting existing temporary file: %s' % (log_prefix, temp_file_path)) os.unlink(temp_file_path) start_time = time.time() try: protocol.get(pfn, temp_file_path, transfer_timeout=transfer_timeout) success = True except Exception as error: logger(logging.DEBUG, error) trace['clientState'] = FileDownloadState.FAILED trace['stateReason'] = str(error) end_time = time.time() if success and not item.get('merged_options', {}).get('ignore_checksum', False): verified, rucio_checksum, local_checksum = _verify_checksum(item, temp_file_path) if not verified: success = False os.unlink(temp_file_path) logger(logging.WARNING, '%sChecksum validation failed for file: %s' % (log_prefix, did_str)) logger(logging.DEBUG, 'Local checksum: %s, Rucio checksum: %s' % (local_checksum, rucio_checksum)) trace['clientState'] = FileDownloadState.FAIL_VALIDATE trace['stateReason'] = 'Checksum validation failed: Local checksum: %s, Rucio checksum: %s' % (local_checksum, rucio_checksum) if not success: logger(logging.WARNING, '%sDownload attempt failed. Try %s/%s' % (log_prefix, attempt, retries)) self._send_trace(trace) protocol.close() if not success: logger(logging.ERROR, '%sFailed to download file %s' % (log_prefix, did_str)) item['clientState'] = FileDownloadState.FAILED return item dest_file_path_iter = iter(dest_file_paths) first_dest_file_path = next(dest_file_path_iter) logger(logging.DEBUG, "renaming '%s' to '%s'" % (temp_file_path, first_dest_file_path)) os.rename(temp_file_path, first_dest_file_path) # if the file was downloaded with success, it can be linked to pcache if pcache: logger(logging.INFO, 'File %s is going to be registered into pcache.' % dest_file_path) try: pcache_state, hardlink_state = pcache.check_and_link(src=pfn, storage_root=storage_prefix, local_src=first_dest_file_path) logger(logging.INFO, 'File %s is now registered into pcache.' % first_dest_file_path) except Exception as e: logger(logging.WARNING, 'Failed to load file to pcache: %s' % str(e)) for cur_dest_file_path in dest_file_path_iter: logger(logging.DEBUG, "copying '%s' to '%s'" % (first_dest_file_path, cur_dest_file_path)) shutil.copy2(first_dest_file_path, cur_dest_file_path) trace['transferStart'] = start_time trace['transferEnd'] = end_time trace['clientState'] = FileDownloadState.DONE trace['stateReason'] = 'OK' item['clientState'] = FileDownloadState.DONE self._send_trace(trace) duration = round(end_time - start_time, 2) size = item.get('bytes') size_str = sizefmt(size, self.is_human_readable) if size and duration: rate = round((size / duration) * 1e-6, 2) logger(logging.INFO, '%sFile %s successfully downloaded. %s in %s seconds = %s MBps' % (log_prefix, did_str, size_str, duration, rate)) else: logger(logging.INFO, '%sFile %s successfully downloaded in %s seconds' % (log_prefix, did_str, duration)) file_items_in_archive = item.get('archive_items', []) if len(file_items_in_archive) > 0: logger(logging.INFO, '%sExtracting %d file(s) from %s' % (log_prefix, len(file_items_in_archive), did_name)) archive_file_path = first_dest_file_path for file_item in file_items_in_archive: extraction_ok = False extract_file_name = file_item['name'] dest_file_path_iter = iter(file_item['dest_file_paths']) first_dest_file_path = next(dest_file_path_iter) dest_dir = os.path.dirname(first_dest_file_path) logger(logging.DEBUG, '%sExtracting %s to %s' % (log_prefix, extract_file_name, dest_dir)) for extraction_tool in self.extraction_tools: if extraction_tool.try_extraction(archive_file_path, extract_file_name, dest_dir): extraction_ok = True break if not extraction_ok: logger(logging.ERROR, 'Extraction of file %s from archive %s failed.' % (extract_file_name, did_name)) continue first_dest_file_path = os.path.join(dest_dir, extract_file_name) for cur_dest_file_path in dest_file_path_iter: logger(logging.DEBUG, "copying '%s' to '%s'" % (first_dest_file_path, cur_dest_file_path)) shutil.copy2(first_dest_file_path, cur_dest_file_path) if not item.get('shall_keep_archive'): logger(logging.DEBUG, '%sDeleting archive %s' % (log_prefix, did_name)) os.remove(archive_file_path) return item def download_aria2c( self, items: list[dict[str, Any]], trace_custom_fields: Optional[dict[str, Any]] = None, filters: Optional[dict[str, Any]] = None, deactivate_file_download_exceptions: bool = False, sort: Optional[str] = None ) -> list[dict[str, Any]]: """ Uses aria2c to download the items with given DIDs. This function can also download datasets and wildcarded DIDs. It only can download files that are available via https/davs. Aria2c needs to be installed and X509_USER_PROXY needs to be set! :param items: List of dictionaries. Each dictionary describing an item to download. Keys: did - DID string of this file (e.g. 'scope:file.name'). Wildcards are not allowed rse - Optional: rse name (e.g. 'CERN-PROD_DATADISK') or rse expression from where to download base_dir - Optional: base directory where the downloaded files will be stored. (Default: '.') no_subdir - Optional: If true, files are written directly into base_dir. (Default: False) nrandom - Optional: if the DID addresses a dataset, nrandom files will be randomly chosen for download from the dataset ignore_checksum - Optional: If true, skips the checksum validation between the downloaded file and the rucio catalouge. (Default: False) check_local_with_filesize_only - Optional: If true, already downloaded files will not be validated by checksum. :param trace_custom_fields: Custom key value pairs to send with the traces :param filters: dictionary containing filter options :param deactivate_file_download_exceptions: Boolean, if file download exceptions shouldn't be raised :param sort: Select best replica by replica sorting algorithm. Available algorithms: ``geoip`` - based on src/dst IP topographical distance ``closeness`` - based on src/dst closeness ``dynamic`` - Rucio Dynamic Smart Sort (tm) :returns: a list of dictionaries with an entry for each file, containing the input options, the did, and the clientState :raises InputValidationError: if one of the input items is in the wrong format :raises NoFilesDownloaded: if no files could be downloaded :raises NotAllFilesDownloaded: if not all files could be downloaded :raises RucioException: if something went wrong during the download (e.g. aria2c could not be started) """ trace_custom_fields = trace_custom_fields or {} filters = filters or {} logger = self.logger trace_custom_fields['uuid'] = generate_uuid() rpc_secret = '%x' % (secrets.randbits(64)) rpc_auth = 'token:%s' % rpc_secret rpcproc, aria_rpc = self._start_aria2c_rpc(rpc_secret) for item in items: item['force_scheme'] = ['https', 'davs'] item['no_resolve_archives'] = True logger(logging.INFO, 'Processing %d item(s) for input' % len(items)) did_to_input_items, file_items_with_sources = self._resolve_and_merge_input_items(copy.deepcopy(items), sort=sort) self.logger(logging.DEBUG, 'num_unmerged_items=%d; num_dids=%d; num_file_items=%d' % (len(items), len(did_to_input_items), len(file_items_with_sources))) input_items = self._prepare_items_for_download(did_to_input_items, file_items_with_sources) try: output_items = self._download_items_aria2c(input_items, aria_rpc, rpc_auth, trace_custom_fields) except Exception as error: self.logger(logging.ERROR, 'Unknown exception during aria2c download') self.logger(logging.DEBUG, error) finally: try: aria_rpc.aria2.forceShutdown(rpc_auth) finally: rpcproc.terminate() return self._check_output(output_items, deactivate_file_download_exceptions=deactivate_file_download_exceptions) def _start_aria2c_rpc(self, rpc_secret): """ Starts aria2c in RPC mode as a subprocess. Also creates the RPC proxy instance. (This function is meant to be used as class internal only) :param rpc_secret: the secret for the RPC proxy :returns: a tuple with the process and the rpc proxy objects :raises RucioException: if the process or the proxy could not be created """ logger = self.logger from xmlrpc.client import ServerProxy as RPCServerProxy cmd = 'aria2c '\ '--enable-rpc '\ '--certificate=$X509_USER_PROXY '\ '--private-key=$X509_USER_PROXY '\ '--ca-certificate=/etc/pki/tls/certs/CERN-bundle.pem '\ '--quiet=true '\ '--allow-overwrite=true '\ '--auto-file-renaming=false '\ '--stop-with-process=%d '\ '--rpc-secret=%s '\ '--rpc-listen-all=false '\ '--rpc-max-request-size=100M '\ '--connect-timeout=5 '\ '--rpc-listen-port=%d' logger(logging.INFO, 'Starting aria2c rpc server...') # trying up to 3 random ports for attempt in range(3): port = random.randint(1024, 65534) # noqa: S311 logger(logging.DEBUG, 'Trying to start rpc server on port: %d' % port) try: to_exec = cmd % (os.getpid(), rpc_secret, port) logger(logging.DEBUG, to_exec) rpcproc = subprocess.Popen( cmd, shell=True, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE ) except Exception as error: raise RucioException('Failed to execute aria2c!', error) # if port is in use aria should fail to start so give it some time time.sleep(2) # did it fail? if rpcproc.poll() is not None: (out, err) = rpcproc.communicate() logger(logging.DEBUG, 'Failed to start aria2c with port: %d' % port) logger(logging.DEBUG, 'aria2c output: %s' % out) else: break if rpcproc.poll() is not None: raise RucioException('Failed to start aria2c rpc server!') try: aria_rpc = RPCServerProxy('http://localhost:%d/rpc' % port) except Exception as error: rpcproc.kill() raise RucioException('Failed to initialise rpc proxy!', error) return (rpcproc, aria_rpc) def _download_items_aria2c( self, items: list[dict[str, Any]], aria_rpc: Any, rpc_auth: str, trace_custom_fields: Optional[dict[str, Any]] = None ) -> list[dict[str, Any]]: """ Uses aria2c to download the given items. Aria2c needs to be started as RPC background process first and a RPC proxy is needed. (This function is meant to be used as class internal only) :param items: list of dictionaries containing one dict for each file to download :param aria_rcp: RPCProxy to the aria2c process :param rpc_auth: the rpc authentication token :param trace_custom_fields: Custom key value pairs to send with the traces :returns: a list of dictionaries with an entry for each file, containing the input options, the did, and the clientState """ trace_custom_fields = trace_custom_fields or {} logger = self.logger gid_to_item = {} # maps an aria2c download id (gid) to the download item pfn_to_rse = {} items_to_queue = [item for item in items] # items get removed from gid_to_item when they are complete or failed while len(gid_to_item) or len(items_to_queue): num_queued = 0 # queue up to 100 files and then check arias status while (num_queued < 100) and len(items_to_queue): item = items_to_queue.pop() file_scope = item['scope'] file_name = item['name'] file_did_str = '%s:%s' % (file_scope, file_name) trace = {'scope': file_scope, 'filename': file_name, 'datasetScope': item.get('dataset_scope', ''), 'dataset': item.get('dataset_name', ''), 'protocol': 'https', 'remoteSite': '', 'filesize': item.get('bytes', None), 'transferStart': time.time(), 'transferEnd': time.time()} trace.update(self.trace_tpl) trace.update(trace_custom_fields) # get pfns from all replicas pfns = [] for src in item['sources']: pfn = src['pfn'] if pfn[0:4].lower() == 'davs': pfn = pfn.replace('davs', 'https', 1) pfns.append(pfn) pfn_to_rse[pfn] = src['rse'] # does file exist and are sources available? # workaround: only consider first dest file path for aria2c download dest_file_path = next(iter(item['dest_file_paths'])) if os.path.isfile(dest_file_path): logger(logging.INFO, 'File exists already locally: %s' % file_did_str) item['clientState'] = FileDownloadState.ALREADY_DONE trace['clientState'] = FileDownloadState.ALREADY_DONE self._send_trace(trace) elif len(pfns) == 0: logger(logging.WARNING, 'No available source found for file: %s' % file_did_str) item['clientState'] = FileDownloadState.FILE_NOT_FOUND trace['clientState'] = FileDownloadState.FILE_NOT_FOUND self._send_trace(trace) else: item['trace'] = trace options = {'dir': os.path.dirname(dest_file_path), 'out': os.path.basename(item['temp_file_path'])} gid = aria_rpc.aria2.addUri(rpc_auth, pfns, options) gid_to_item[gid] = item num_queued += 1 logger(logging.DEBUG, 'Queued file: %s' % file_did_str) # get some statistics aria_stat = aria_rpc.aria2.getGlobalStat(rpc_auth) num_active = int(aria_stat['numActive']) num_waiting = int(aria_stat['numWaiting']) num_stopped = int(aria_stat['numStoppedTotal']) # save start time if one of the active downloads has started active = aria_rpc.aria2.tellActive(rpc_auth, ['gid', 'completedLength']) for dlinfo in active: gid = dlinfo['gid'] if int(dlinfo['completedLength']) > 0: gid_to_item[gid].setdefault('transferStart', time.time()) stopped = aria_rpc.aria2.tellStopped(rpc_auth, -1, num_stopped, ['gid', 'status', 'files']) for dlinfo in stopped: gid = dlinfo['gid'] item = gid_to_item[gid] file_scope = item['scope'] file_name = item['name'] file_did_str = '%s:%s' % (file_scope, file_name) temp_file_path = item['temp_file_path'] # workaround: only consider first dest file path for aria2c download dest_file_path = next(iter(item['dest_file_paths'])) # ensure we didn't miss the active state (e.g. a very fast download) start_time = item.setdefault('transferStart', time.time()) end_time = item.setdefault('transferEnd', time.time()) # get used pfn for traces trace = item['trace'] for uri in dlinfo['files'][0]['uris']: if uri['status'].lower() == 'used': trace['remoteSite'] = pfn_to_rse.get(uri['uri'], '') trace['transferStart'] = start_time trace['transferEnd'] = end_time # ensure file exists status = dlinfo.get('status', '').lower() if status == 'complete' and os.path.isfile(temp_file_path): # checksum check skip_check = item.get('ignore_checksum', False) rucio_checksum = 0 if skip_check else item.get('adler32') local_checksum = 0 if skip_check else adler32(temp_file_path) if str(rucio_checksum).lstrip('0') == str(local_checksum).lstrip('0'): item['clientState'] = FileDownloadState.DONE trace['clientState'] = FileDownloadState.DONE # remove .part ending os.rename(temp_file_path, dest_file_path) # calculate duration duration = round(end_time - start_time, 2) duration = max(duration, 0.01) # protect against 0 division size = item.get('bytes', 0) rate = round((size / duration) * 1e-6, 2) size_str = sizefmt(size, self.is_human_readable) logger(logging.INFO, 'File %s successfully downloaded. %s in %s seconds = %s MBps' % (file_did_str, size_str, duration, rate)) else: os.unlink(temp_file_path) logger(logging.WARNING, 'Checksum validation failed for file: %s' % file_did_str) logger(logging.DEBUG, 'Local checksum: %s, Rucio checksum: %s' % (local_checksum, rucio_checksum)) item['clientState'] = FileDownloadState.FAIL_VALIDATE trace['clientState'] = FileDownloadState.FAIL_VALIDATE else: logger(logging.ERROR, 'Failed to download file: %s' % file_did_str) logger(logging.DEBUG, 'Aria2c status: %s' % status) item['clientState'] = FileDownloadState.FAILED trace['clientState'] = FileDownloadState.DOWNLOAD_ATTEMPT self._send_trace(trace) del item['trace'] aria_rpc.aria2.removeDownloadResult(rpc_auth, gid) del gid_to_item[gid] if len(stopped) > 0: logger(logging.INFO, 'Active: %d, Waiting: %d, Stopped: %d' % (num_active, num_waiting, num_stopped)) return items def _resolve_one_item_dids(self, item): """ Resolve scopes or wildcard DIDs to lists of full did names: :param item: One input item """ dids = item.get('did') filters = item.get('filters', {}) if filters: filters = copy.copy(filters) if dids is None: self.logger(logging.DEBUG, 'Resolving DIDs by using filter options') scope = filters.pop('scope') for did in self.client.list_dids(scope, filters=filters, did_type='all', long=True): yield did return if not isinstance(dids, list): dids = [dids] for did_str in dids: scope, did_name = self._split_did_str(did_str) filters['name'] = did_name any_did_resolved = False for did in self.client.list_dids(scope, filters=filters, did_type='all', long=True): yield did any_did_resolved = True # Maintain compatibility with existing code, which expects non-existing DIDs be # passed through in order to correctly set trace state to FILE_NOT_FOUND if not any_did_resolved and '*' not in did_name: yield {'scope': scope, 'name': did_name} def _resolve_and_merge_input_items(self, input_items, sort=None): """ This function takes the input items given to download_dids etc. and resolves the sources. - It first performs a list_dids call to dereference any wildcards and retrieve DID stats (size, length, type). - Next, input items are grouped together by common list_replicas options. For each group, a single list_replicas call is performed. - The resolved File DIDs with sources are finally mapped back to initial input items to be able to correctly retrieve download options (timeout, destination directories, etc) :param input_items: List of dictionaries. Each dictionary describing an input item :returns: a tuple: - a dictionary that maps the dereferenced(w/o wildcards) input DIDs to a list of input items - and a list with a dictionary for each file DID which has to be downloaded :raises InputValidationError: if one of the input items is in the wrong format """ logger = self.logger # check mandatory options before doing any server calls resolve_archives = False for item in input_items: if item.get('resolve_archives') is not None: logger(logging.WARNING, 'resolve_archives option is deprecated and will be removed in a future release.') item.setdefault('no_resolve_archives', not item.pop('resolve_archives')) # If any item needs to resolve archives if not item.get('no_resolve_archives'): resolve_archives = True if not item.get('did'): if not item.get('filters', {}).get('scope'): logger(logging.DEBUG, item) raise InputValidationError('Item without did and filter/scope') if resolve_archives: # perhaps we'll need an extraction tool so check what is installed self.extraction_tools = [tool for tool in self.extraction_tools if tool.is_useable()] if len(self.extraction_tools) < 1: logger(logging.WARNING, 'Archive resolution is enabled but no extraction tool is available. ' 'Sources whose protocol does not support extraction will not be considered for download.') # if excluding tapes, we need to list them first tape_rses = [] if self.is_tape_excluded: try: tape_rses = [endp['rse'] for endp in self.client.list_rses(rse_expression='istape=true')] except: logger(logging.DEBUG, 'No tapes found.') # Matches each dereferenced DID back to a list of input items did_to_input_items = {} # Resolve DIDs for item in input_items: resolved_dids = list(self._resolve_one_item_dids(item)) if not resolved_dids: logger(logging.WARNING, 'An item did not have any DIDs after resolving the input: %s.' % item.get('did', item)) item['dids'] = resolved_dids for did in resolved_dids: did_to_input_items.setdefault(DID(did), []).append(item) if 'CONTAINER' in did.get('did_type', '').upper() or ('length' in did and not did['length']): did_with_size = self.client.get_did(scope=did['scope'], name=did['name'], dynamic_depth='FILE') did['length'] = did_with_size['length'] did['bytes'] = did_with_size['bytes'] # group input items by common options to reduce the number of calls to list_replicas distinct_keys = ['rse', 'force_scheme', 'no_resolve_archives'] item_groups = [] for item in input_items: found_compatible_group = False if not item.get('nrandom'): # Don't merge items if nrandom is set. Otherwise two items with the same nrandom will be merged into one # and we'll effectively download only half of the desired replicas for each item. for item_group in item_groups: if all(item.get(k) == item_group[0].get(k) for k in distinct_keys): item_group.append(item) found_compatible_group = True break if not found_compatible_group: item_groups.append([item]) # List replicas for dids merged_items_with_sources = [] for item_group in item_groups: # Take configuration from the first item in the group; but dids from all items item = item_group[0] input_dids = {DID(did): did for item in item_group for did in item.get('dids')} # since we're using metalink we need to explicitly give all schemes schemes = item.get('force_scheme') if schemes: schemes = schemes if isinstance(schemes, list) else [schemes] logger(logging.DEBUG, 'schemes: %s' % schemes) # RSE expression, still with tape endpoints included rse_expression = item.get('rse') logger(logging.DEBUG, 'rse_expression: %s' % rse_expression) # obtaining the choice of Implementation impl = item.get('impl') if impl: impl_split = impl.split('.') if len(impl_split) == 1: impl = 'rucio.rse.protocols.' + impl + '.Default' else: impl = 'rucio.rse.protocols.' + impl logger(logging.DEBUG, 'impl: %s' % impl) # get PFNs of files and datasets logger(logging.DEBUG, 'num DIDs for list_replicas call: %d' % len(item['dids'])) nrandom = item.get('nrandom') if nrandom: logger(logging.INFO, 'Selecting %d random replicas from DID(s): %s' % (nrandom, [str(did) for did in input_dids])) metalink_str = self.client.list_replicas([{'scope': did.scope, 'name': did.name} for did in input_dids], schemes=schemes, ignore_availability=False, rse_expression=rse_expression, client_location=self.client_location, sort=sort, resolve_archives=not item.get('no_resolve_archives'), resolve_parents=True, nrandom=nrandom, metalink=True) file_items = parse_replicas_from_string(metalink_str) for file in file_items: if impl: file['impl'] = impl elif not item.get('force_scheme'): file['impl'] = self.preferred_impl(file['sources']) logger(logging.DEBUG, 'num resolved files: %s' % len(file_items)) if not nrandom or nrandom != len(file_items): # If list_replicas didn't resolve any file DIDs for any input did, we pass through the input DID. # This is done to keep compatibility with later code which generates "FILE_NOT_FOUND" traces # and output items. # In the special case of nrandom, when serverside filtering is applied, it's "normal" for some input # dids to be ignored as long as we got exactly nrandom file_items from the server. for input_did in input_dids: if not any([input_did == f['did'] or str(input_did) in f['parent_dids'] for f in file_items]): logger(logging.ERROR, 'DID does not exist: %s' % input_did) # TODO: store did directly as DIDType object file_items.append({'did': str(input_did), 'adler32': None, 'md5': None, 'sources': [], 'parent_dids': set(), 'impl': impl or None}) # filtering out tape sources if self.is_tape_excluded: for file_item in file_items: unfiltered_sources = copy.copy(file_item['sources']) for src in unfiltered_sources: if src['rse'] in tape_rses: file_item['sources'].remove(src) if unfiltered_sources and not file_item['sources']: logger(logging.WARNING, 'The requested DID {} only has replicas on tape. Direct download from tape is prohibited. ' 'Please request a transfer to a non-tape endpoint.'.format(file_item['did'])) # Match the file did back to the dids which were provided to list_replicas. # Later, this will allow to match the file back to input_items via did_to_input_items for file_item in file_items: file_did = DID(file_item['did']) file_input_dids = {DID(did) for did in file_item.get('parent_dids', [])}.intersection(input_dids) if file_did in input_dids: file_input_dids.add(file_did) file_item['input_dids'] = {did: input_dids[did] for did in file_input_dids} merged_items_with_sources.extend(file_items) return did_to_input_items, merged_items_with_sources def _options_from_input_items(self, input_items): """ Best-effort generation of download options from multiple input items which resolve to the same file DID. This is done to download each file DID only once, even if it is requested multiple times via overlapping datasets and/or wildcard resolutions in distinct input items. Some options can be easily merged. For example: multiple base_dir are all appended to a list. As a result, the file is downloaded once and copied to all desired destinations. Other options are not necessarily compatible. For example, two items requesting two different values for download timeout. We make our best to merge the options in such cases. """ options = {} for item in input_items: base_dir = item.get('base_dir', '.') no_subdir = item.get('no_subdir', False) new_transfer_timeout = item.get('transfer_timeout', None) new_transfer_speed_timeout = item.get('transfer_speed_timeout', None) options.setdefault('destinations', set()).add((base_dir, no_subdir)) # Merge some options # The other options of this DID will be inherited from the first item that contained the DID options['ignore_checksum'] = options.get('ignore_checksum') or item.get('ignore_checksum', False) options['check_local_with_filesize_only'] = options.get('check_local_with_filesize_only') or item.get('check_local_with_filesize_only', False) # if one item wants to resolve archives we enable it for all items options['resolve_archives'] = (options.get('resolve_archives') or not item.get('no_resolve_archives')) cur_transfer_timeout = options.setdefault('transfer_timeout', None) if cur_transfer_timeout is not None and new_transfer_timeout is not None: options['transfer_timeout'] = max(int(cur_transfer_timeout), int(new_transfer_timeout)) elif new_transfer_timeout is not None: options['transfer_timeout'] = int(new_transfer_timeout) cur_transfer_speed_timeout = options.setdefault('transfer_speed_timeout', None) if cur_transfer_speed_timeout is not None and new_transfer_speed_timeout is not None: options['transfer_speed_timeout'] = min(float(cur_transfer_speed_timeout), float(new_transfer_speed_timeout)) elif new_transfer_speed_timeout is not None: options['transfer_speed_timeout'] = float(new_transfer_speed_timeout) return options def _prepare_items_for_download(self, did_to_input_items, file_items): """ Optimises the amount of files to download (This function is meant to be used as class internal only) :param did_to_input_items: dictionary that maps resolved input DIDs to input items :param file_items: list of dictionaries. Each dictionary describes a File DID to download :returns: list of dictionaries. Each dictionary describes an element to download :raises InputValidationError: if the given input is not valid or incomplete """ logger = self.logger # maps file item IDs (fiid) to the file item object fiid_to_file_item = {} # cea -> client_extract archives to avoid confusion with archives that dont need explicit extraction # this dict will contain all ids of cea's that definitely will be downloaded cea_id_pure_to_fiids = {} # this dict will contain ids of cea's that have higher prioritised non cea sources cea_id_mixed_to_fiids = {} all_dest_file_paths = set() # get replicas for every file of the given dids for file_item in file_items: file_did = DID(file_item['did']) input_items = list(itertools.chain.from_iterable(did_to_input_items.get(did, []) for did in file_item['input_dids'])) options = self._options_from_input_items(input_items) file_item['scope'] = file_did.scope file_item['name'] = file_did.name logger(logging.DEBUG, 'Queueing file: %s' % file_did) logger(logging.DEBUG, 'real parents: %s' % [str(did) for did in file_item['input_dids'] if did != file_did]) logger(logging.DEBUG, 'options: %s' % options) # prepare destinations folders: dest_file_paths = file_item.get('dest_file_paths', set()) for input_did in file_item['input_dids']: for item in did_to_input_items[input_did]: base_dir = item.get('base_dir', '.') no_subdir = item.get('no_subdir', False) file_did_path = file_did.name if input_did != file_did: # if datasets were given: prepare the destination paths for each dataset if self.extract_scope_convention == 'belleii' and file_did_path.startswith('/'): file_did_path = file_did_path.split('/')[-1] path = os.path.join(self._prepare_dest_dir(base_dir, input_did.name, no_subdir), file_did_path) else: # if no datasets were given only prepare the given destination paths if file_did_path.startswith('/'): file_did_path = file_did_path[1:] path = os.path.join(self._prepare_dest_dir(base_dir, file_did.scope, no_subdir), file_did_path) if path in all_dest_file_paths: raise RucioException("Multiple file items with same destination file path") all_dest_file_paths.add(path) dest_file_paths.add(path) # workaround: just take any given dataset for the traces and the output file_item.setdefault('dataset_scope', input_did.scope) file_item.setdefault('dataset_name', input_did.name) if not options: continue resolve_archives = options.get('resolve_archives') file_item['merged_options'] = options file_item['dest_file_paths'] = list(dest_file_paths) file_item['temp_file_path'] = '%s.part' % file_item['dest_file_paths'][0] # the file did str is not an unique key for this dict because multiple calls of list_replicas # could result in the same DID multiple times. So we're using the id of the dictionary objects fiid = id(file_item) fiid_to_file_item[fiid] = file_item if resolve_archives: min_cea_priority = None num_non_cea_sources = 0 cea_ids = [] sources = [] # go through sources and check how many (non-)cea sources there are, # index cea sources, or remove cea sources if there is no extraction tool for source in file_item['sources']: is_cea = source.get('client_extract', False) if is_cea and (len(self.extraction_tools) > 0): priority = int(source['priority']) if min_cea_priority is None or priority < min_cea_priority: min_cea_priority = priority # workaround since we dont have the archive DID use the part behind the last slash of the PFN # this doesn't respect the scope of the archive DID!!! # and we trust that client_extract==True sources dont have any parameters at the end of the PFN cea_id = source['pfn'].split('/') cea_id = cea_id[-1] if len(cea_id[-1]) > 0 else cea_id[-2] cea_ids.append(cea_id) sources.append(source) elif not is_cea: num_non_cea_sources += 1 sources.append(source) else: # no extraction tool logger(logging.DEBUG, 'client_extract=True; ignoring source: %s' % source['pfn']) logger(logging.DEBUG, 'Prepared sources: num_sources=%d/%d; num_non_cea_sources=%d; num_cea_ids=%d' % (len(sources), len(file_item['sources']), num_non_cea_sources, len(cea_ids))) file_item['sources'] = sources # if there are no cea sources we are done for this item if min_cea_priority is None: continue # decide if file item belongs to the pure or mixed map # if no non-archive src exists or the highest prio src is an archive src we put it in the pure map elif num_non_cea_sources == 0 or min_cea_priority == 1: logger(logging.DEBUG, 'Adding fiid to cea pure map: ' 'num_non_cea_sources=%d; min_cea_priority=%d; num_cea_sources=%d' % (num_non_cea_sources, min_cea_priority, len(cea_ids))) for cea_id in cea_ids: cea_id_pure_to_fiids.setdefault(cea_id, set()).add(fiid) file_item.setdefault('cea_ids_pure', set()).add(cea_id) # if there are non-archive sources and archive sources we put it in the mixed map elif len(cea_ids) > 0: logger(logging.DEBUG, 'Adding fiid to cea mixed map: ' 'num_non_cea_sources=%d; min_cea_priority=%d; num_cea_sources=%d' % (num_non_cea_sources, min_cea_priority, len(cea_ids))) for cea_id in cea_ids: cea_id_mixed_to_fiids.setdefault(cea_id, set()).add(fiid) file_item.setdefault('cea_ids_mixed', set()).add(cea_id) # put all archives from the mixed list into the pure list if they meet # certain conditions, e.g., an archive that is already in the pure list for cea_id_mixed in list(cea_id_mixed_to_fiids.keys()): fiids_mixed = cea_id_mixed_to_fiids[cea_id_mixed] if cea_id_mixed in cea_id_pure_to_fiids: # file from mixed list is already in a pure list logger(logging.DEBUG, 'Mixed ID is already in cea pure map: ' 'cea_id_mixed=%s; num_fiids_mixed=%d; num_cea_pure_fiids=%d' % (cea_id_mixed, len(fiids_mixed), len(cea_id_pure_to_fiids[cea_id_mixed]))) elif len(fiids_mixed) >= self.use_cea_threshold: # more than use_cea_threshold files are in a common archive logger(logging.DEBUG, 'Number of needed files in cea reached threshold: ' 'cea_id_mixed=%s; num_fiids_mixed=%d; threshold=%d' % (cea_id_mixed, len(fiids_mixed), self.use_cea_threshold)) else: # dont move from mixed list to pure list continue # first add cea_id to pure map so it can be removed from mixed map later cea_id_pure_to_fiids.setdefault(cea_id_mixed, set()).update(fiids_mixed) # now update all file_item mixed/pure maps for fiid_mixed in list(fiids_mixed): file_item = fiid_to_file_item[fiid_mixed] # add cea id to file_item pure map file_item.setdefault('cea_ids_pure', set()).add(cea_id_mixed) # remove file item mixed map and # remove references from all other mixed archives to file_item for cea_id_mixed2 in file_item.pop('cea_ids_mixed'): cea_id_mixed_to_fiids[cea_id_mixed2].remove(fiid_mixed) # finally remove cea_id from mixed map cea_id_mixed_to_fiids.pop(cea_id_mixed) for file_item in file_items: cea_ids_pure = file_item.get('cea_ids_pure', set()) cea_ids_mixed = file_item.get('cea_ids_mixed', set()) if len(cea_ids_pure) > 0: logger(logging.DEBUG, 'Removing all non-cea sources of file %s' % file_item['did']) file_item['sources'] = [s for s in file_item['sources'] if s.get('client_extract', False)] elif len(cea_ids_mixed) > 0: logger(logging.DEBUG, 'Removing all cea sources of file %s' % file_item['did']) file_item['sources'] = [s for s in file_item['sources'] if not s.get('client_extract', False)] # reduce the amount of archives to download by removing # all redundant pure archives (=all files can be extracted from other archives) for cea_id_pure in list(cea_id_pure_to_fiids.keys()): # if all files of this archive are available in more than one archive the archive is redundant if all(len(fiid_to_file_item[fiid_pure]['cea_ids_pure']) > 1 for fiid_pure in cea_id_pure_to_fiids[cea_id_pure]): for fiid_pure in cea_id_pure_to_fiids[cea_id_pure]: fiid_to_file_item[fiid_pure]['cea_ids_pure'].discard(cea_id_pure) logger(logging.DEBUG, 'Removing redundant archive %s' % cea_id_pure) cea_id_pure_to_fiids.pop(cea_id_pure) # remove all archives of a file except a single one so # that each file is assigned to exactly one pure archive for cea_id_pure in cea_id_pure_to_fiids: for fiid_pure in cea_id_pure_to_fiids[cea_id_pure]: cea_ids_pure = fiid_to_file_item[fiid_pure]['cea_ids_pure'] for cea_id_pure_other in list(cea_ids_pure): if cea_id_pure != cea_id_pure_other: cea_id_pure_to_fiids[cea_id_pure_other].discard(fiid_pure) cea_ids_pure.discard(cea_id_pure_other) download_packs = [] cea_id_to_pack = {} for file_item in file_items: cea_ids = file_item.get('cea_ids_pure', set()) if len(cea_ids) > 0: cea_id = next(iter(cea_ids)) pack = cea_id_to_pack.get(cea_id) if pack is None: scope = file_item['scope'] first_dest = next(iter(file_item['merged_options']['destinations'])) dest_path = os.path.join(self._prepare_dest_dir(first_dest[0], scope, first_dest[1]), cea_id) pack = {'scope': scope, 'name': cea_id, 'dest_file_paths': [dest_path], 'temp_file_path': '%s.part' % dest_path, 'sources': file_item['sources'], 'merged_options': {'ignore_checksum': True}, # we currently dont have checksums for the archive 'archive_items': [] } cea_id_to_pack[cea_id] = pack download_packs.append(pack) file_item.pop('sources') pack['archive_items'].append(file_item) else: download_packs.append(file_item) return download_packs def _split_did_str(self, did_str): """ Splits a given DID string (e.g. 'scope1:name.file') into its scope and name part (This function is meant to be used as class internal only) :param did_str: the DID string that will be split :returns: the scope- and name part of the given DID :raises InputValidationError: if the given DID string is not valid """ did = did_str.split(':') if len(did) == 2: did_scope = did[0] did_name = did[1] elif len(did) == 1: if self.extract_scope_convention == 'belleii': scopes = [scope for scope in self.client.list_scopes()] did_scope, did_name = extract_scope(did[0], scopes) else: did = did_str.split('.') did_scope = did[0] if did_scope == 'user' or did_scope == 'group': did_scope = '%s.%s' % (did[0], did[1]) did_name = did_str else: raise InputValidationError('%s is not a valid DID. To many colons.' % did_str) if did_name.endswith('/'): did_name = did_name[:-1] return did_scope, did_name def _prepare_dest_dir(self, base_dir, dest_dir_name, no_subdir): """ Builds the final destination path for a file and creates the destination directory if it's not existent. (This function is meant to be used as class internal only) :param base_dir: base directory part :param dest_dir_name: name of the destination directory :param no_subdir: if no subdirectory should be created :returns: the absolute path of the destination directory """ # append dest_dir_name, if subdir should be used if dest_dir_name.startswith('/'): dest_dir_name = dest_dir_name[1:] dest_dir_path = os.path.join(os.path.abspath(base_dir), '' if no_subdir else dest_dir_name) if not os.path.isdir(dest_dir_path): os.makedirs(dest_dir_path) return dest_dir_path def _check_output(self, output_items, deactivate_file_download_exceptions=False): """ Checks if all files were successfully downloaded (This function is meant to be used as class internal only) :param output_items: list of dictionaries describing the downloaded files :param deactivate_file_download_exceptions: Boolean, if file download exceptions shouldn't be raised :returns: output_items list :raises NoFilesDownloaded: :raises NotAllFilesDownloaded: """ success_states = [FileDownloadState.ALREADY_DONE, FileDownloadState.DONE, FileDownloadState.FOUND_IN_PCACHE] num_successful = 0 num_failed = 0 for item in output_items: clientState = item.get('clientState', FileDownloadState.FAILED) if clientState in success_states: num_successful += 1 else: num_failed += 1 if not deactivate_file_download_exceptions and num_successful == 0: raise NoFilesDownloaded() elif not deactivate_file_download_exceptions and num_failed > 0: raise NotAllFilesDownloaded() return output_items def _send_trace(self, trace): """ Checks if sending trace is allowed and send the trace. :param trace: the trace """ if self.tracing: send_trace(trace, self.client.trace_host, self.client.user_agent) def preferred_impl(self, sources): """ Finds the optimum protocol impl preferred by the client and supported by the remote RSE. :param sources: List of sources for a given DID :raises RucioException(msg): general exception with msg for more details. """ preferred_protocols = [] checked_rses = [] supported_impl = None try: preferred_impls = config_get('download', 'preferred_impl') except Exception as error: self.logger(logging.INFO, 'No preferred protocol impl in rucio.cfg: %s' % (error)) return supported_impl else: preferred_impls = list(preferred_impls.split(', ')) i = 0 while i < len(preferred_impls): impl = preferred_impls[i] impl_split = impl.split('.') if len(impl_split) == 1: preferred_impls[i] = 'rucio.rse.protocols.' + impl + '.Default' else: preferred_impls[i] = 'rucio.rse.protocols.' + impl i += 1 for source in sources: if source['rse'] in checked_rses: continue try: rse_settings = rsemgr.get_rse_info(source['rse'], vo=self.client.vo) checked_rses.append(str(source['rse'])) except RucioException as error: self.logger(logging.DEBUG, 'Could not get info of RSE %s: %s' % (source['source'], error)) continue preferred_protocols = [protocol for protocol in reversed(rse_settings['protocols']) if protocol['impl'] in preferred_impls] if len(preferred_protocols) == 0: continue for protocol in preferred_protocols: if not protocol['domains']['wan'].get("read"): self.logger(logging.WARNING, 'Unsuitable protocol "%s": "WAN Read" operation is not supported' % (protocol['impl'])) continue try: supported_protocol = rsemgr.create_protocol(rse_settings, 'read', impl=protocol['impl'], auth_token=self.auth_token, logger=self.logger) supported_protocol.connect() except Exception as error: self.logger(logging.WARNING, 'Failed to create protocol "%s", exception: %s' % (protocol['impl'], error)) pass else: self.logger(logging.INFO, 'Preferred protocol impl supported locally and remotely: %s' % (protocol['impl'])) supported_impl = protocol['impl'] break return supported_impl def _verify_checksum(item, path): rucio_checksum = item.get(PREFERRED_CHECKSUM) local_checksum = None checksum_algo = CHECKSUM_ALGO_DICT.get(PREFERRED_CHECKSUM) if rucio_checksum and checksum_algo: local_checksum = checksum_algo(path) return rucio_checksum == local_checksum, rucio_checksum, local_checksum for checksum_name in GLOBALLY_SUPPORTED_CHECKSUMS: rucio_checksum = item.get(checksum_name) checksum_algo = CHECKSUM_ALGO_DICT.get(checksum_name) if rucio_checksum and checksum_algo: local_checksum = checksum_algo(path) return rucio_checksum == local_checksum, rucio_checksum, local_checksum return False, None, None