sdk/python/arvados/collection.py

   1 # Copyright (C) The Arvados Authors. All rights reserved.
   2 #
   3 # SPDX-License-Identifier: Apache-2.0
   4
   5 from __future__ import absolute_import
   6 from future.utils import listitems, listvalues, viewkeys
   7 from builtins import str
   8 from past.builtins import basestring
   9 from builtins import object
  10 import functools
  11 import logging
  12 import os
  13 import re
  14 import errno
  15 import hashlib
  16 import datetime
  17 import ciso8601
  18 import time
  19 import threading
  20
  21 from collections import deque
  22 from stat import *
  23
  24 from .arvfile import split, _FileLikeObjectBase, ArvadosFile, ArvadosFileWriter, ArvadosFileReader, _BlockManager, synchronized, must_be_writable, NoopLock
  25 from .keep import KeepLocator, KeepClient
  26 from .stream import StreamReader
  27 from ._normalize_stream import normalize_stream
  28 from ._ranges import Range, LocatorAndRange
  29 from .safeapi import ThreadSafeApiCache
  30 import arvados.config as config
  31 import arvados.errors as errors
  32 import arvados.util
  33 import arvados.events as events
  34 from arvados.retry import retry_method
  35
  36 _logger = logging.getLogger('arvados.collection')
  37
  38 class CollectionBase(object):
  39     """Abstract base class for Collection classes."""
  40
  41     def __enter__(self):
  42         return self
  43
  44     def __exit__(self, exc_type, exc_value, traceback):
  45         pass
  46
  47     def _my_keep(self):
  48         if self._keep_client is None:
  49             self._keep_client = KeepClient(api_client=self._api_client,
  50                                            num_retries=self.num_retries)
  51         return self._keep_client
  52
  53     def stripped_manifest(self):
  54         """Get the manifest with locator hints stripped.
  55
  56         Return the manifest for the current collection with all
  57         non-portable hints (i.e., permission signatures and other
  58         hints other than size hints) removed from the locators.
  59         """
  60         raw = self.manifest_text()
  61         clean = []
  62         for line in raw.split("\n"):
  63             fields = line.split()
  64             if fields:
  65                 clean_fields = fields[:1] + [
  66                     (re.sub(r'\+[^\d][^\+]*', '', x)
  67                      if re.match(arvados.util.keep_locator_pattern, x)
  68                      else x)
  69                     for x in fields[1:]]
  70                 clean += [' '.join(clean_fields), "\n"]
  71         return ''.join(clean)
  72
  73
  74 class _WriterFile(_FileLikeObjectBase):
  75     def __init__(self, coll_writer, name):
  76         super(_WriterFile, self).__init__(name, 'wb')
  77         self.dest = coll_writer
  78
  79     def close(self):
  80         super(_WriterFile, self).close()
  81         self.dest.finish_current_file()
  82
  83     @_FileLikeObjectBase._before_close
  84     def write(self, data):
  85         self.dest.write(data)
  86
  87     @_FileLikeObjectBase._before_close
  88     def writelines(self, seq):
  89         for data in seq:
  90             self.write(data)
  91
  92     @_FileLikeObjectBase._before_close
  93     def flush(self):
  94         self.dest.flush_data()
  95
  96
  97 class CollectionWriter(CollectionBase):
  98     """Deprecated, use Collection instead."""
  99
 100     def __init__(self, api_client=None, num_retries=0, replication=None):
 101         """Instantiate a CollectionWriter.
 102
 103         CollectionWriter lets you build a new Arvados Collection from scratch.
 104         Write files to it.  The CollectionWriter will upload data to Keep as
 105         appropriate, and provide you with the Collection manifest text when
 106         you're finished.
 107
 108         Arguments:
 109         * api_client: The API client to use to look up Collections.  If not
 110           provided, CollectionReader will build one from available Arvados
 111           configuration.
 112         * num_retries: The default number of times to retry failed
 113           service requests.  Default 0.  You may change this value
 114           after instantiation, but note those changes may not
 115           propagate to related objects like the Keep client.
 116         * replication: The number of copies of each block to store.
 117           If this argument is None or not supplied, replication is
 118           the server-provided default if available, otherwise 2.
 119         """
 120         self._api_client = api_client
 121         self.num_retries = num_retries
 122         self.replication = (2 if replication is None else replication)
 123         self._keep_client = None
 124         self._data_buffer = []
 125         self._data_buffer_len = 0
 126         self._current_stream_files = []
 127         self._current_stream_length = 0
 128         self._current_stream_locators = []
 129         self._current_stream_name = '.'
 130         self._current_file_name = None
 131         self._current_file_pos = 0
 132         self._finished_streams = []
 133         self._close_file = None
 134         self._queued_file = None
 135         self._queued_dirents = deque()
 136         self._queued_trees = deque()
 137         self._last_open = None
 138
 139     def __exit__(self, exc_type, exc_value, traceback):
 140         if exc_type is None:
 141             self.finish()
 142
 143     def do_queued_work(self):
 144         # The work queue consists of three pieces:
 145         # * _queued_file: The file object we're currently writing to the
 146         #   Collection.
 147         # * _queued_dirents: Entries under the current directory
 148         #   (_queued_trees[0]) that we want to write or recurse through.
 149         #   This may contain files from subdirectories if
 150         #   max_manifest_depth == 0 for this directory.
 151         # * _queued_trees: Directories that should be written as separate
 152         #   streams to the Collection.
 153         # This function handles the smallest piece of work currently queued
 154         # (current file, then current directory, then next directory) until
 155         # no work remains.  The _work_THING methods each do a unit of work on
 156         # THING.  _queue_THING methods add a THING to the work queue.
 157         while True:
 158             if self._queued_file:
 159                 self._work_file()
 160             elif self._queued_dirents:
 161                 self._work_dirents()
 162             elif self._queued_trees:
 163                 self._work_trees()
 164             else:
 165                 break
 166
 167     def _work_file(self):
 168         while True:
 169             buf = self._queued_file.read(config.KEEP_BLOCK_SIZE)
 170             if not buf:
 171                 break
 172             self.write(buf)
 173         self.finish_current_file()
 174         if self._close_file:
 175             self._queued_file.close()
 176         self._close_file = None
 177         self._queued_file = None
 178
 179     def _work_dirents(self):
 180         path, stream_name, max_manifest_depth = self._queued_trees[0]
 181         if stream_name != self.current_stream_name():
 182             self.start_new_stream(stream_name)
 183         while self._queued_dirents:
 184             dirent = self._queued_dirents.popleft()
 185             target = os.path.join(path, dirent)
 186             if os.path.isdir(target):
 187                 self._queue_tree(target,
 188                                  os.path.join(stream_name, dirent),
 189                                  max_manifest_depth - 1)
 190             else:
 191                 self._queue_file(target, dirent)
 192                 break
 193         if not self._queued_dirents:
 194             self._queued_trees.popleft()
 195
 196     def _work_trees(self):
 197         path, stream_name, max_manifest_depth = self._queued_trees[0]
 198         d = arvados.util.listdir_recursive(
 199             path, max_depth = (None if max_manifest_depth == 0 else 0))
 200         if d:
 201             self._queue_dirents(stream_name, d)
 202         else:
 203             self._queued_trees.popleft()
 204
 205     def _queue_file(self, source, filename=None):
 206         assert (self._queued_file is None), "tried to queue more than one file"
 207         if not hasattr(source, 'read'):
 208             source = open(source, 'rb')
 209             self._close_file = True
 210         else:
 211             self._close_file = False
 212         if filename is None:
 213             filename = os.path.basename(source.name)
 214         self.start_new_file(filename)
 215         self._queued_file = source
 216
 217     def _queue_dirents(self, stream_name, dirents):
 218         assert (not self._queued_dirents), "tried to queue more than one tree"
 219         self._queued_dirents = deque(sorted(dirents))
 220
 221     def _queue_tree(self, path, stream_name, max_manifest_depth):
 222         self._queued_trees.append((path, stream_name, max_manifest_depth))
 223
 224     def write_file(self, source, filename=None):
 225         self._queue_file(source, filename)
 226         self.do_queued_work()
 227
 228     def write_directory_tree(self,
 229                              path, stream_name='.', max_manifest_depth=-1):
 230         self._queue_tree(path, stream_name, max_manifest_depth)
 231         self.do_queued_work()
 232
 233     def write(self, newdata):
 234         if isinstance(newdata, bytes):
 235             pass
 236         elif isinstance(newdata, str):
 237             newdata = newdata.encode()
 238         elif hasattr(newdata, '__iter__'):
 239             for s in newdata:
 240                 self.write(s)
 241             return
 242         self._data_buffer.append(newdata)
 243         self._data_buffer_len += len(newdata)
 244         self._current_stream_length += len(newdata)
 245         while self._data_buffer_len >= config.KEEP_BLOCK_SIZE:
 246             self.flush_data()
 247
 248     def open(self, streampath, filename=None):
 249         """open(streampath[, filename]) -> file-like object
 250
 251         Pass in the path of a file to write to the Collection, either as a
 252         single string or as two separate stream name and file name arguments.
 253         This method returns a file-like object you can write to add it to the
 254         Collection.
 255
 256         You may only have one file object from the Collection open at a time,
 257         so be sure to close the object when you're done.  Using the object in
 258         a with statement makes that easy::
 259
 260           with cwriter.open('./doc/page1.txt') as outfile:
 261               outfile.write(page1_data)
 262           with cwriter.open('./doc/page2.txt') as outfile:
 263               outfile.write(page2_data)
 264         """
 265         if filename is None:
 266             streampath, filename = split(streampath)
 267         if self._last_open and not self._last_open.closed:
 268             raise errors.AssertionError(
 269                 "can't open '{}' when '{}' is still open".format(
 270                     filename, self._last_open.name))
 271         if streampath != self.current_stream_name():
 272             self.start_new_stream(streampath)
 273         self.set_current_file_name(filename)
 274         self._last_open = _WriterFile(self, filename)
 275         return self._last_open
 276
 277     def flush_data(self):
 278         data_buffer = b''.join(self._data_buffer)
 279         if data_buffer:
 280             self._current_stream_locators.append(
 281                 self._my_keep().put(
 282                     data_buffer[0:config.KEEP_BLOCK_SIZE],
 283                     copies=self.replication))
 284             self._data_buffer = [data_buffer[config.KEEP_BLOCK_SIZE:]]
 285             self._data_buffer_len = len(self._data_buffer[0])
 286
 287     def start_new_file(self, newfilename=None):
 288         self.finish_current_file()
 289         self.set_current_file_name(newfilename)
 290
 291     def set_current_file_name(self, newfilename):
 292         if re.search(r'[\t\n]', newfilename):
 293             raise errors.AssertionError(
 294                 "Manifest filenames cannot contain whitespace: %s" %
 295                 newfilename)
 296         elif re.search(r'\x00', newfilename):
 297             raise errors.AssertionError(
 298                 "Manifest filenames cannot contain NUL characters: %s" %
 299                 newfilename)
 300         self._current_file_name = newfilename
 301
 302     def current_file_name(self):
 303         return self._current_file_name
 304
 305     def finish_current_file(self):
 306         if self._current_file_name is None:
 307             if self._current_file_pos == self._current_stream_length:
 308                 return
 309             raise errors.AssertionError(
 310                 "Cannot finish an unnamed file " +
 311                 "(%d bytes at offset %d in '%s' stream)" %
 312                 (self._current_stream_length - self._current_file_pos,
 313                  self._current_file_pos,
 314                  self._current_stream_name))
 315         self._current_stream_files.append([
 316                 self._current_file_pos,
 317                 self._current_stream_length - self._current_file_pos,
 318                 self._current_file_name])
 319         self._current_file_pos = self._current_stream_length
 320         self._current_file_name = None
 321
 322     def start_new_stream(self, newstreamname='.'):
 323         self.finish_current_stream()
 324         self.set_current_stream_name(newstreamname)
 325
 326     def set_current_stream_name(self, newstreamname):
 327         if re.search(r'[\t\n]', newstreamname):
 328             raise errors.AssertionError(
 329                 "Manifest stream names cannot contain whitespace: '%s'" %
 330                 (newstreamname))
 331         self._current_stream_name = '.' if newstreamname=='' else newstreamname
 332
 333     def current_stream_name(self):
 334         return self._current_stream_name
 335
 336     def finish_current_stream(self):
 337         self.finish_current_file()
 338         self.flush_data()
 339         if not self._current_stream_files:
 340             pass
 341         elif self._current_stream_name is None:
 342             raise errors.AssertionError(
 343                 "Cannot finish an unnamed stream (%d bytes in %d files)" %
 344                 (self._current_stream_length, len(self._current_stream_files)))
 345         else:
 346             if not self._current_stream_locators:
 347                 self._current_stream_locators.append(config.EMPTY_BLOCK_LOCATOR)
 348             self._finished_streams.append([self._current_stream_name,
 349                                            self._current_stream_locators,
 350                                            self._current_stream_files])
 351         self._current_stream_files = []
 352         self._current_stream_length = 0
 353         self._current_stream_locators = []
 354         self._current_stream_name = None
 355         self._current_file_pos = 0
 356         self._current_file_name = None
 357
 358     def finish(self):
 359         """Store the manifest in Keep and return its locator.
 360
 361         This is useful for storing manifest fragments (task outputs)
 362         temporarily in Keep during a Crunch job.
 363
 364         In other cases you should make a collection instead, by
 365         sending manifest_text() to the API server's "create
 366         collection" endpoint.
 367         """
 368         return self._my_keep().put(self.manifest_text().encode(),
 369                                    copies=self.replication)
 370
 371     def portable_data_hash(self):
 372         stripped = self.stripped_manifest().encode()
 373         return '{}+{}'.format(hashlib.md5(stripped).hexdigest(), len(stripped))
 374
 375     def manifest_text(self):
 376         self.finish_current_stream()
 377         manifest = ''
 378
 379         for stream in self._finished_streams:
 380             if not re.search(r'^\.(/.*)?$', stream[0]):
 381                 manifest += './'
 382             manifest += stream[0].replace(' ', '\\040')
 383             manifest += ' ' + ' '.join(stream[1])
 384             manifest += ' ' + ' '.join("%d:%d:%s" % (sfile[0], sfile[1], sfile[2].replace(' ', '\\040')) for sfile in stream[2])
 385             manifest += "\n"
 386
 387         return manifest
 388
 389     def data_locators(self):
 390         ret = []
 391         for name, locators, files in self._finished_streams:
 392             ret += locators
 393         return ret
 394
 395     def save_new(self, name=None):
 396         return self._api_client.collections().create(
 397             ensure_unique_name=True,
 398             body={
 399                 'name': name,
 400                 'manifest_text': self.manifest_text(),
 401             }).execute(num_retries=self.num_retries)
 402
 403
 404 class ResumableCollectionWriter(CollectionWriter):
 405     """Deprecated, use Collection instead."""
 406
 407     STATE_PROPS = ['_current_stream_files', '_current_stream_length',
 408                    '_current_stream_locators', '_current_stream_name',
 409                    '_current_file_name', '_current_file_pos', '_close_file',
 410                    '_data_buffer', '_dependencies', '_finished_streams',
 411                    '_queued_dirents', '_queued_trees']
 412
 413     def __init__(self, api_client=None, **kwargs):
 414         self._dependencies = {}
 415         super(ResumableCollectionWriter, self).__init__(api_client, **kwargs)
 416
 417     @classmethod
 418     def from_state(cls, state, *init_args, **init_kwargs):
 419         # Try to build a new writer from scratch with the given state.
 420         # If the state is not suitable to resume (because files have changed,
 421         # been deleted, aren't predictable, etc.), raise a
 422         # StaleWriterStateError.  Otherwise, return the initialized writer.
 423         # The caller is responsible for calling writer.do_queued_work()
 424         # appropriately after it's returned.
 425         writer = cls(*init_args, **init_kwargs)
 426         for attr_name in cls.STATE_PROPS:
 427             attr_value = state[attr_name]
 428             attr_class = getattr(writer, attr_name).__class__
 429             # Coerce the value into the same type as the initial value, if
 430             # needed.
 431             if attr_class not in (type(None), attr_value.__class__):
 432                 attr_value = attr_class(attr_value)
 433             setattr(writer, attr_name, attr_value)
 434         # Check dependencies before we try to resume anything.
 435         if any(KeepLocator(ls).permission_expired()
 436                for ls in writer._current_stream_locators):
 437             raise errors.StaleWriterStateError(
 438                 "locators include expired permission hint")
 439         writer.check_dependencies()
 440         if state['_current_file'] is not None:
 441             path, pos = state['_current_file']
 442             try:
 443                 writer._queued_file = open(path, 'rb')
 444                 writer._queued_file.seek(pos)
 445             except IOError as error:
 446                 raise errors.StaleWriterStateError(
 447                     "failed to reopen active file {}: {}".format(path, error))
 448         return writer
 449
 450     def check_dependencies(self):
 451         for path, orig_stat in listitems(self._dependencies):
 452             if not S_ISREG(orig_stat[ST_MODE]):
 453                 raise errors.StaleWriterStateError("{} not file".format(path))
 454             try:
 455                 now_stat = tuple(os.stat(path))
 456             except OSError as error:
 457                 raise errors.StaleWriterStateError(
 458                     "failed to stat {}: {}".format(path, error))
 459             if ((not S_ISREG(now_stat[ST_MODE])) or
 460                 (orig_stat[ST_MTIME] != now_stat[ST_MTIME]) or
 461                 (orig_stat[ST_SIZE] != now_stat[ST_SIZE])):
 462                 raise errors.StaleWriterStateError("{} changed".format(path))
 463
 464     def dump_state(self, copy_func=lambda x: x):
 465         state = {attr: copy_func(getattr(self, attr))
 466                  for attr in self.STATE_PROPS}
 467         if self._queued_file is None:
 468             state['_current_file'] = None
 469         else:
 470             state['_current_file'] = (os.path.realpath(self._queued_file.name),
 471                                       self._queued_file.tell())
 472         return state
 473
 474     def _queue_file(self, source, filename=None):
 475         try:
 476             src_path = os.path.realpath(source)
 477         except Exception:
 478             raise errors.AssertionError("{} not a file path".format(source))
 479         try:
 480             path_stat = os.stat(src_path)
 481         except OSError as stat_error:
 482             path_stat = None
 483         super(ResumableCollectionWriter, self)._queue_file(source, filename)
 484         fd_stat = os.fstat(self._queued_file.fileno())
 485         if not S_ISREG(fd_stat.st_mode):
 486             # We won't be able to resume from this cache anyway, so don't
 487             # worry about further checks.
 488             self._dependencies[source] = tuple(fd_stat)
 489         elif path_stat is None:
 490             raise errors.AssertionError(
 491                 "could not stat {}: {}".format(source, stat_error))
 492         elif path_stat.st_ino != fd_stat.st_ino:
 493             raise errors.AssertionError(
 494                 "{} changed between open and stat calls".format(source))
 495         else:
 496             self._dependencies[src_path] = tuple(fd_stat)
 497
 498     def write(self, data):
 499         if self._queued_file is None:
 500             raise errors.AssertionError(
 501                 "resumable writer can't accept unsourced data")
 502         return super(ResumableCollectionWriter, self).write(data)
 503
 504
 505 ADD = "add"
 506 DEL = "del"
 507 MOD = "mod"
 508 TOK = "tok"
 509 FILE = "file"
 510 COLLECTION = "collection"
 511
 512 class RichCollectionBase(CollectionBase):
 513     """Base class for Collections and Subcollections.
 514
 515     Implements the majority of functionality relating to accessing items in the
 516     Collection.
 517
 518     """
 519
 520     def __init__(self, parent=None):
 521         self.parent = parent
 522         self._committed = False
 523         self._callback = None
 524         self._items = {}
 525
 526     def _my_api(self):
 527         raise NotImplementedError()
 528
 529     def _my_keep(self):
 530         raise NotImplementedError()
 531
 532     def _my_block_manager(self):
 533         raise NotImplementedError()
 534
 535     def writable(self):
 536         raise NotImplementedError()
 537
 538     def root_collection(self):
 539         raise NotImplementedError()
 540
 541     def notify(self, event, collection, name, item):
 542         raise NotImplementedError()
 543
 544     def stream_name(self):
 545         raise NotImplementedError()
 546
 547     @must_be_writable
 548     @synchronized
 549     def find_or_create(self, path, create_type):
 550         """Recursively search the specified file path.
 551
 552         May return either a `Collection` or `ArvadosFile`.  If not found, will
 553         create a new item at the specified path based on `create_type`.  Will
 554         create intermediate subcollections needed to contain the final item in
 555         the path.
 556
 557         :create_type:
 558           One of `arvados.collection.FILE` or
 559           `arvados.collection.COLLECTION`.  If the path is not found, and value
 560           of create_type is FILE then create and return a new ArvadosFile for
 561           the last path component.  If COLLECTION, then create and return a new
 562           Collection for the last path component.
 563
 564         """
 565
 566         pathcomponents = path.split("/", 1)
 567         if pathcomponents[0]:
 568             item = self._items.get(pathcomponents[0])
 569             if len(pathcomponents) == 1:
 570                 if item is None:
 571                     # create new file
 572                     if create_type == COLLECTION:
 573                         item = Subcollection(self, pathcomponents[0])
 574                     else:
 575                         item = ArvadosFile(self, pathcomponents[0])
 576                     self._items[pathcomponents[0]] = item
 577                     self.set_committed(False)
 578                     self.notify(ADD, self, pathcomponents[0], item)
 579                 return item
 580             else:
 581                 if item is None:
 582                     # create new collection
 583                     item = Subcollection(self, pathcomponents[0])
 584                     self._items[pathcomponents[0]] = item
 585                     self.set_committed(False)
 586                     self.notify(ADD, self, pathcomponents[0], item)
 587                 if isinstance(item, RichCollectionBase):
 588                     return item.find_or_create(pathcomponents[1], create_type)
 589                 else:
 590                     raise IOError(errno.ENOTDIR, "Not a directory", pathcomponents[0])
 591         else:
 592             return self
 593
 594     @synchronized
 595     def find(self, path):
 596         """Recursively search the specified file path.
 597
 598         May return either a Collection or ArvadosFile. Return None if not
 599         found.
 600         If path is invalid (ex: starts with '/'), an IOError exception will be
 601         raised.
 602
 603         """
 604         if not path:
 605             raise errors.ArgumentError("Parameter 'path' is empty.")
 606
 607         pathcomponents = path.split("/", 1)
 608         if pathcomponents[0] == '':
 609             raise IOError(errno.ENOTDIR, "Not a directory", pathcomponents[0])
 610
 611         item = self._items.get(pathcomponents[0])
 612         if item is None:
 613             return None
 614         elif len(pathcomponents) == 1:
 615             return item
 616         else:
 617             if isinstance(item, RichCollectionBase):
 618                 if pathcomponents[1]:
 619                     return item.find(pathcomponents[1])
 620                 else:
 621                     return item
 622             else:
 623                 raise IOError(errno.ENOTDIR, "Not a directory", pathcomponents[0])
 624
 625     @synchronized
 626     def mkdirs(self, path):
 627         """Recursive subcollection create.
 628
 629         Like `os.makedirs()`.  Will create intermediate subcollections needed
 630         to contain the leaf subcollection path.
 631
 632         """
 633
 634         if self.find(path) != None:
 635             raise IOError(errno.EEXIST, "Directory or file exists", path)
 636
 637         return self.find_or_create(path, COLLECTION)
 638
 639     def open(self, path, mode="r"):
 640         """Open a file-like object for access.
 641
 642         :path:
 643           path to a file in the collection
 644         :mode:
 645           a string consisting of "r", "w", or "a", optionally followed
 646           by "b" or "t", optionally followed by "+".
 647           :"b":
 648             binary mode: write() accepts bytes, read() returns bytes.
 649           :"t":
 650             text mode (default): write() accepts strings, read() returns strings.
 651           :"r":
 652             opens for reading
 653           :"r+":
 654             opens for reading and writing.  Reads/writes share a file pointer.
 655           :"w", "w+":
 656             truncates to 0 and opens for reading and writing.  Reads/writes share a file pointer.
 657           :"a", "a+":
 658             opens for reading and writing.  All writes are appended to
 659             the end of the file.  Writing does not affect the file pointer for
 660             reading.
 661         """
 662
 663         if not re.search(r'^[rwa][bt]?\+?$', mode):
 664             raise errors.ArgumentError("Invalid mode {!r}".format(mode))
 665
 666         if mode[0] == 'r' and '+' not in mode:
 667             fclass = ArvadosFileReader
 668             arvfile = self.find(path)
 669         elif not self.writable():
 670             raise IOError(errno.EROFS, "Collection is read only")
 671         else:
 672             fclass = ArvadosFileWriter
 673             arvfile = self.find_or_create(path, FILE)
 674
 675         if arvfile is None:
 676             raise IOError(errno.ENOENT, "File not found", path)
 677         if not isinstance(arvfile, ArvadosFile):
 678             raise IOError(errno.EISDIR, "Is a directory", path)
 679
 680         if mode[0] == 'w':
 681             arvfile.truncate(0)
 682
 683         return fclass(arvfile, mode=mode, num_retries=self.num_retries)
 684
 685     def modified(self):
 686         """Determine if the collection has been modified since last commited."""
 687         return not self.committed()
 688
 689     @synchronized
 690     def committed(self):
 691         """Determine if the collection has been committed to the API server."""
 692         return self._committed
 693
 694     @synchronized
 695     def set_committed(self, value=True):
 696         """Recursively set committed flag.
 697
 698         If value is True, set committed to be True for this and all children.
 699
 700         If value is False, set committed to be False for this and all parents.
 701         """
 702         if value == self._committed:
 703             return
 704         if value:
 705             for k,v in listitems(self._items):
 706                 v.set_committed(True)
 707             self._committed = True
 708         else:
 709             self._committed = False
 710             if self.parent is not None:
 711                 self.parent.set_committed(False)
 712
 713     @synchronized
 714     def __iter__(self):
 715         """Iterate over names of files and collections contained in this collection."""
 716         return iter(viewkeys(self._items))
 717
 718     @synchronized
 719     def __getitem__(self, k):
 720         """Get a file or collection that is directly contained by this collection.
 721
 722         If you want to search a path, use `find()` instead.
 723
 724         """
 725         return self._items[k]
 726
 727     @synchronized
 728     def __contains__(self, k):
 729         """Test if there is a file or collection a directly contained by this collection."""
 730         return k in self._items
 731
 732     @synchronized
 733     def __len__(self):
 734         """Get the number of items directly contained in this collection."""
 735         return len(self._items)
 736
 737     @must_be_writable
 738     @synchronized
 739     def __delitem__(self, p):
 740         """Delete an item by name which is directly contained by this collection."""
 741         del self._items[p]
 742         self.set_committed(False)
 743         self.notify(DEL, self, p, None)
 744
 745     @synchronized
 746     def keys(self):
 747         """Get a list of names of files and collections directly contained in this collection."""
 748         return self._items.keys()
 749
 750     @synchronized
 751     def values(self):
 752         """Get a list of files and collection objects directly contained in this collection."""
 753         return listvalues(self._items)
 754
 755     @synchronized
 756     def items(self):
 757         """Get a list of (name, object) tuples directly contained in this collection."""
 758         return listitems(self._items)
 759
 760     def exists(self, path):
 761         """Test if there is a file or collection at `path`."""
 762         return self.find(path) is not None
 763
 764     @must_be_writable
 765     @synchronized
 766     def remove(self, path, recursive=False):
 767         """Remove the file or subcollection (directory) at `path`.
 768
 769         :recursive:
 770           Specify whether to remove non-empty subcollections (True), or raise an error (False).
 771         """
 772
 773         if not path:
 774             raise errors.ArgumentError("Parameter 'path' is empty.")
 775
 776         pathcomponents = path.split("/", 1)
 777         item = self._items.get(pathcomponents[0])
 778         if item is None:
 779             raise IOError(errno.ENOENT, "File not found", path)
 780         if len(pathcomponents) == 1:
 781             if isinstance(self._items[pathcomponents[0]], RichCollectionBase) and len(self._items[pathcomponents[0]]) > 0 and not recursive:
 782                 raise IOError(errno.ENOTEMPTY, "Directory not empty", path)
 783             deleteditem = self._items[pathcomponents[0]]
 784             del self._items[pathcomponents[0]]
 785             self.set_committed(False)
 786             self.notify(DEL, self, pathcomponents[0], deleteditem)
 787         else:
 788             item.remove(pathcomponents[1])
 789
 790     def _clonefrom(self, source):
 791         for k,v in listitems(source):
 792             self._items[k] = v.clone(self, k)
 793
 794     def clone(self):
 795         raise NotImplementedError()
 796
 797     @must_be_writable
 798     @synchronized
 799     def add(self, source_obj, target_name, overwrite=False, reparent=False):
 800         """Copy or move a file or subcollection to this collection.
 801
 802         :source_obj:
 803           An ArvadosFile, or Subcollection object
 804
 805         :target_name:
 806           Destination item name.  If the target name already exists and is a
 807           file, this will raise an error unless you specify `overwrite=True`.
 808
 809         :overwrite:
 810           Whether to overwrite target file if it already exists.
 811
 812         :reparent:
 813           If True, source_obj will be moved from its parent collection to this collection.
 814           If False, source_obj will be copied and the parent collection will be
 815           unmodified.
 816
 817         """
 818
 819         if target_name in self and not overwrite:
 820             raise IOError(errno.EEXIST, "File already exists", target_name)
 821
 822         modified_from = None
 823         if target_name in self:
 824             modified_from = self[target_name]
 825
 826         # Actually make the move or copy.
 827         if reparent:
 828             source_obj._reparent(self, target_name)
 829             item = source_obj
 830         else:
 831             item = source_obj.clone(self, target_name)
 832
 833         self._items[target_name] = item
 834         self.set_committed(False)
 835
 836         if modified_from:
 837             self.notify(MOD, self, target_name, (modified_from, item))
 838         else:
 839             self.notify(ADD, self, target_name, item)
 840
 841     def _get_src_target(self, source, target_path, source_collection, create_dest):
 842         if source_collection is None:
 843             source_collection = self
 844
 845         # Find the object
 846         if isinstance(source, basestring):
 847             source_obj = source_collection.find(source)
 848             if source_obj is None:
 849                 raise IOError(errno.ENOENT, "File not found", source)
 850             sourcecomponents = source.split("/")
 851         else:
 852             source_obj = source
 853             sourcecomponents = None
 854
 855         # Find parent collection the target path
 856         targetcomponents = target_path.split("/")
 857
 858         # Determine the name to use.
 859         target_name = targetcomponents[-1] if targetcomponents[-1] else sourcecomponents[-1]
 860
 861         if not target_name:
 862             raise errors.ArgumentError("Target path is empty and source is an object.  Cannot determine destination filename to use.")
 863
 864         if create_dest:
 865             target_dir = self.find_or_create("/".join(targetcomponents[0:-1]), COLLECTION)
 866         else:
 867             if len(targetcomponents) > 1:
 868                 target_dir = self.find("/".join(targetcomponents[0:-1]))
 869             else:
 870                 target_dir = self
 871
 872         if target_dir is None:
 873             raise IOError(errno.ENOENT, "Target directory not found", target_name)
 874
 875         if target_name in target_dir and isinstance(target_dir[target_name], RichCollectionBase) and sourcecomponents:
 876             target_dir = target_dir[target_name]
 877             target_name = sourcecomponents[-1]
 878
 879         return (source_obj, target_dir, target_name)
 880
 881     @must_be_writable
 882     @synchronized
 883     def copy(self, source, target_path, source_collection=None, overwrite=False):
 884         """Copy a file or subcollection to a new path in this collection.
 885
 886         :source:
 887           A string with a path to source file or subcollection, or an actual ArvadosFile or Subcollection object.
 888
 889         :target_path:
 890           Destination file or path.  If the target path already exists and is a
 891           subcollection, the item will be placed inside the subcollection.  If
 892           the target path already exists and is a file, this will raise an error
 893           unless you specify `overwrite=True`.
 894
 895         :source_collection:
 896           Collection to copy `source_path` from (default `self`)
 897
 898         :overwrite:
 899           Whether to overwrite target file if it already exists.
 900         """
 901
 902         source_obj, target_dir, target_name = self._get_src_target(source, target_path, source_collection, True)
 903         target_dir.add(source_obj, target_name, overwrite, False)
 904
 905     @must_be_writable
 906     @synchronized
 907     def rename(self, source, target_path, source_collection=None, overwrite=False):
 908         """Move a file or subcollection from `source_collection` to a new path in this collection.
 909
 910         :source:
 911           A string with a path to source file or subcollection.
 912
 913         :target_path:
 914           Destination file or path.  If the target path already exists and is a
 915           subcollection, the item will be placed inside the subcollection.  If
 916           the target path already exists and is a file, this will raise an error
 917           unless you specify `overwrite=True`.
 918
 919         :source_collection:
 920           Collection to copy `source_path` from (default `self`)
 921
 922         :overwrite:
 923           Whether to overwrite target file if it already exists.
 924         """
 925
 926         source_obj, target_dir, target_name = self._get_src_target(source, target_path, source_collection, False)
 927         if not source_obj.writable():
 928             raise IOError(errno.EROFS, "Source collection is read only", source)
 929         target_dir.add(source_obj, target_name, overwrite, True)
 930
 931     def portable_manifest_text(self, stream_name="."):
 932         """Get the manifest text for this collection, sub collections and files.
 933
 934         This method does not flush outstanding blocks to Keep.  It will return
 935         a normalized manifest with access tokens stripped.
 936
 937         :stream_name:
 938           Name to use for this stream (directory)
 939
 940         """
 941         return self._get_manifest_text(stream_name, True, True)
 942
 943     @synchronized
 944     def manifest_text(self, stream_name=".", strip=False, normalize=False,
 945                       only_committed=False):
 946         """Get the manifest text for this collection, sub collections and files.
 947
 948         This method will flush outstanding blocks to Keep.  By default, it will
 949         not normalize an unmodified manifest or strip access tokens.
 950
 951         :stream_name:
 952           Name to use for this stream (directory)
 953
 954         :strip:
 955           If True, remove signing tokens from block locators if present.
 956           If False (default), block locators are left unchanged.
 957
 958         :normalize:
 959           If True, always export the manifest text in normalized form
 960           even if the Collection is not modified.  If False (default) and the collection
 961           is not modified, return the original manifest text even if it is not
 962           in normalized form.
 963
 964         :only_committed:
 965           If True, don't commit pending blocks.
 966
 967         """
 968
 969         if not only_committed:
 970             self._my_block_manager().commit_all()
 971         return self._get_manifest_text(stream_name, strip, normalize,
 972                                        only_committed=only_committed)
 973
 974     @synchronized
 975     def _get_manifest_text(self, stream_name, strip, normalize, only_committed=False):
 976         """Get the manifest text for this collection, sub collections and files.
 977
 978         :stream_name:
 979           Name to use for this stream (directory)
 980
 981         :strip:
 982           If True, remove signing tokens from block locators if present.
 983           If False (default), block locators are left unchanged.
 984
 985         :normalize:
 986           If True, always export the manifest text in normalized form
 987           even if the Collection is not modified.  If False (default) and the collection
 988           is not modified, return the original manifest text even if it is not
 989           in normalized form.
 990
 991         :only_committed:
 992           If True, only include blocks that were already committed to Keep.
 993
 994         """
 995
 996         if not self.committed() or self._manifest_text is None or normalize:
 997             stream = {}
 998             buf = []
 999             sorted_keys = sorted(self.keys())
1000             for filename in [s for s in sorted_keys if isinstance(self[s], ArvadosFile)]:
1001                 # Create a stream per file `k`
1002                 arvfile = self[filename]
1003                 filestream = []
1004                 for segment in arvfile.segments():
1005                     loc = segment.locator
1006                     if arvfile.parent._my_block_manager().is_bufferblock(loc):
1007                         if only_committed:
1008                             continue
1009                         loc = arvfile.parent._my_block_manager().get_bufferblock(loc).locator()
1010                     if strip:
1011                         loc = KeepLocator(loc).stripped()
1012                     filestream.append(LocatorAndRange(loc, KeepLocator(loc).size,
1013                                          segment.segment_offset, segment.range_size))
1014                 stream[filename] = filestream
1015             if stream:
1016                 buf.append(" ".join(normalize_stream(stream_name, stream)) + "\n")
1017             for dirname in [s for s in sorted_keys if isinstance(self[s], RichCollectionBase)]:
1018                 buf.append(self[dirname].manifest_text(stream_name=os.path.join(stream_name, dirname), strip=strip, normalize=True, only_committed=only_committed))
1019             return "".join(buf)
1020         else:
1021             if strip:
1022                 return self.stripped_manifest()
1023             else:
1024                 return self._manifest_text
1025
1026     @synchronized
1027     def _copy_remote_blocks(self, remote_blocks={}):
1028         """Scan through the entire collection and ask Keep to copy remote blocks.
1029
1030         When accessing a remote collection, blocks will have a remote signature
1031         (+R instead of +A). Collect these signatures and request Keep to copy the
1032         blocks to the local cluster, returning local (+A) signatures.
1033
1034         :remote_blocks:
1035           Shared cache of remote to local block mappings. This is used to avoid
1036           doing extra work when blocks are shared by more than one file in
1037           different subdirectories.
1038
1039         """
1040         for item in self:
1041             if isinstance(self[item], ArvadosFile):
1042                 for s in self[item].segments():
1043                     if '+R' in s.locator:
1044                         try:
1045                             loc = remote_blocks[s.locator]
1046                         except KeyError:
1047                             loc = self._my_keep().refresh_signature(s.locator)
1048                             remote_blocks[s.locator] = loc
1049                         s.locator = loc
1050                         self.set_committed(False)
1051             elif isinstance(self[item], RichCollectionBase):
1052                 remote_blocks = self[item]._copy_remote_blocks(remote_blocks)
1053         return remote_blocks
1054
1055     @synchronized
1056     def diff(self, end_collection, prefix=".", holding_collection=None):
1057         """Generate list of add/modify/delete actions.
1058
1059         When given to `apply`, will change `self` to match `end_collection`
1060
1061         """
1062         changes = []
1063         if holding_collection is None:
1064             holding_collection = Collection(api_client=self._my_api(), keep_client=self._my_keep())
1065         for k in self:
1066             if k not in end_collection:
1067                changes.append((DEL, os.path.join(prefix, k), self[k].clone(holding_collection, "")))
1068         for k in end_collection:
1069             if k in self:
1070                 if isinstance(end_collection[k], Subcollection) and isinstance(self[k], Subcollection):
1071                     changes.extend(self[k].diff(end_collection[k], os.path.join(prefix, k), holding_collection))
1072                 elif end_collection[k] != self[k]:
1073                     changes.append((MOD, os.path.join(prefix, k), self[k].clone(holding_collection, ""), end_collection[k].clone(holding_collection, "")))
1074                 else:
1075                     changes.append((TOK, os.path.join(prefix, k), self[k].clone(holding_collection, ""), end_collection[k].clone(holding_collection, "")))
1076             else:
1077                 changes.append((ADD, os.path.join(prefix, k), end_collection[k].clone(holding_collection, "")))
1078         return changes
1079
1080     @must_be_writable
1081     @synchronized
1082     def apply(self, changes):
1083         """Apply changes from `diff`.
1084
1085         If a change conflicts with a local change, it will be saved to an
1086         alternate path indicating the conflict.
1087
1088         """
1089         if changes:
1090             self.set_committed(False)
1091         for change in changes:
1092             event_type = change[0]
1093             path = change[1]
1094             initial = change[2]
1095             local = self.find(path)
1096             conflictpath = "%s~%s~conflict~" % (path, time.strftime("%Y%m%d-%H%M%S",
1097                                                                     time.gmtime()))
1098             if event_type == ADD:
1099                 if local is None:
1100                     # No local file at path, safe to copy over new file
1101                     self.copy(initial, path)
1102                 elif local is not None and local != initial:
1103                     # There is already local file and it is different:
1104                     # save change to conflict file.
1105                     self.copy(initial, conflictpath)
1106             elif event_type == MOD or event_type == TOK:
1107                 final = change[3]
1108                 if local == initial:
1109                     # Local matches the "initial" item so it has not
1110                     # changed locally and is safe to update.
1111                     if isinstance(local, ArvadosFile) and isinstance(final, ArvadosFile):
1112                         # Replace contents of local file with new contents
1113                         local.replace_contents(final)
1114                     else:
1115                         # Overwrite path with new item; this can happen if
1116                         # path was a file and is now a collection or vice versa
1117                         self.copy(final, path, overwrite=True)
1118                 else:
1119                     # Local is missing (presumably deleted) or local doesn't
1120                     # match the "start" value, so save change to conflict file
1121                     self.copy(final, conflictpath)
1122             elif event_type == DEL:
1123                 if local == initial:
1124                     # Local item matches "initial" value, so it is safe to remove.
1125                     self.remove(path, recursive=True)
1126                 # else, the file is modified or already removed, in either
1127                 # case we don't want to try to remove it.
1128
1129     def portable_data_hash(self):
1130         """Get the portable data hash for this collection's manifest."""
1131         if self._manifest_locator and self.committed():
1132             # If the collection is already saved on the API server, and it's committed
1133             # then return API server's PDH response.
1134             return self._portable_data_hash
1135         else:
1136             stripped = self.portable_manifest_text().encode()
1137             return '{}+{}'.format(hashlib.md5(stripped).hexdigest(), len(stripped))
1138
1139     @synchronized
1140     def subscribe(self, callback):
1141         if self._callback is None:
1142             self._callback = callback
1143         else:
1144             raise errors.ArgumentError("A callback is already set on this collection.")
1145
1146     @synchronized
1147     def unsubscribe(self):
1148         if self._callback is not None:
1149             self._callback = None
1150
1151     @synchronized
1152     def notify(self, event, collection, name, item):
1153         if self._callback:
1154             self._callback(event, collection, name, item)
1155         self.root_collection().notify(event, collection, name, item)
1156
1157     @synchronized
1158     def __eq__(self, other):
1159         if other is self:
1160             return True
1161         if not isinstance(other, RichCollectionBase):
1162             return False
1163         if len(self._items) != len(other):
1164             return False
1165         for k in self._items:
1166             if k not in other:
1167                 return False
1168             if self._items[k] != other[k]:
1169                 return False
1170         return True
1171
1172     def __ne__(self, other):
1173         return not self.__eq__(other)
1174
1175     @synchronized
1176     def flush(self):
1177         """Flush bufferblocks to Keep."""
1178         for e in listvalues(self):
1179             e.flush()
1180
1181
1182 class Collection(RichCollectionBase):
1183     """Represents the root of an Arvados Collection.
1184
1185     This class is threadsafe.  The root collection object, all subcollections
1186     and files are protected by a single lock (i.e. each access locks the entire
1187     collection).
1188
1189     Brief summary of
1190     useful methods:
1191
1192     :To read an existing file:
1193       `c.open("myfile", "r")`
1194
1195     :To write a new file:
1196       `c.open("myfile", "w")`
1197
1198     :To determine if a file exists:
1199       `c.find("myfile") is not None`
1200
1201     :To copy a file:
1202       `c.copy("source", "dest")`
1203
1204     :To delete a file:
1205       `c.remove("myfile")`
1206
1207     :To save to an existing collection record:
1208       `c.save()`
1209
1210     :To save a new collection record:
1211     `c.save_new()`
1212
1213     :To merge remote changes into this object:
1214       `c.update()`
1215
1216     Must be associated with an API server Collection record (during
1217     initialization, or using `save_new`) to use `save` or `update`
1218
1219     """
1220
1221     def __init__(self, manifest_locator_or_text=None,
1222                  api_client=None,
1223                  keep_client=None,
1224                  num_retries=None,
1225                  parent=None,
1226                  apiconfig=None,
1227                  block_manager=None,
1228                  replication_desired=None,
1229                  put_threads=None):
1230         """Collection constructor.
1231
1232         :manifest_locator_or_text:
1233           An Arvados collection UUID, portable data hash, raw manifest
1234           text, or (if creating an empty collection) None.
1235
1236         :parent:
1237           the parent Collection, may be None.
1238
1239         :apiconfig:
1240           A dict containing keys for ARVADOS_API_HOST and ARVADOS_API_TOKEN.
1241           Prefer this over supplying your own api_client and keep_client (except in testing).
1242           Will use default config settings if not specified.
1243
1244         :api_client:
1245           The API client object to use for requests.  If not specified, create one using `apiconfig`.
1246
1247         :keep_client:
1248           the Keep client to use for requests.  If not specified, create one using `apiconfig`.
1249
1250         :num_retries:
1251           the number of retries for API and Keep requests.
1252
1253         :block_manager:
1254           the block manager to use.  If not specified, create one.
1255
1256         :replication_desired:
1257           How many copies should Arvados maintain. If None, API server default
1258           configuration applies. If not None, this value will also be used
1259           for determining the number of block copies being written.
1260
1261         """
1262         super(Collection, self).__init__(parent)
1263         self._api_client = api_client
1264         self._keep_client = keep_client
1265         self._block_manager = block_manager
1266         self.replication_desired = replication_desired
1267         self.put_threads = put_threads
1268
1269         if apiconfig:
1270             self._config = apiconfig
1271         else:
1272             self._config = config.settings()
1273
1274         self.num_retries = num_retries if num_retries is not None else 0
1275         self._manifest_locator = None
1276         self._manifest_text = None
1277         self._portable_data_hash = None
1278         self._api_response = None
1279         self._past_versions = set()
1280
1281         self.lock = threading.RLock()
1282         self.events = None
1283
1284         if manifest_locator_or_text:
1285             if re.match(arvados.util.keep_locator_pattern, manifest_locator_or_text):
1286                 self._manifest_locator = manifest_locator_or_text
1287             elif re.match(arvados.util.collection_uuid_pattern, manifest_locator_or_text):
1288                 self._manifest_locator = manifest_locator_or_text
1289             elif re.match(arvados.util.manifest_pattern, manifest_locator_or_text):
1290                 self._manifest_text = manifest_locator_or_text
1291             else:
1292                 raise errors.ArgumentError(
1293                     "Argument to CollectionReader is not a manifest or a collection UUID")
1294
1295             try:
1296                 self._populate()
1297             except (IOError, errors.SyntaxError) as e:
1298                 raise errors.ArgumentError("Error processing manifest text: %s", e)
1299
1300     def root_collection(self):
1301         return self
1302
1303     def get_properties(self):
1304         if self._api_response and self._api_response["properties"]:
1305             return self._api_response["properties"]
1306         else:
1307             return {}
1308
1309     def get_trash_at(self):
1310         if self._api_response and self._api_response["trash_at"]:
1311             return ciso8601.parse_datetime(self._api_response["trash_at"])
1312         else:
1313             return None
1314
1315     def stream_name(self):
1316         return "."
1317
1318     def writable(self):
1319         return True
1320
1321     @synchronized
1322     def known_past_version(self, modified_at_and_portable_data_hash):
1323         return modified_at_and_portable_data_hash in self._past_versions
1324
1325     @synchronized
1326     @retry_method
1327     def update(self, other=None, num_retries=None):
1328         """Merge the latest collection on the API server with the current collection."""
1329
1330         if other is None:
1331             if self._manifest_locator is None:
1332                 raise errors.ArgumentError("`other` is None but collection does not have a manifest_locator uuid")
1333             response = self._my_api().collections().get(uuid=self._manifest_locator).execute(num_retries=num_retries)
1334             if (self.known_past_version((response.get("modified_at"), response.get("portable_data_hash"))) and
1335                 response.get("portable_data_hash") != self.portable_data_hash()):
1336                 # The record on the server is different from our current one, but we've seen it before,
1337                 # so ignore it because it's already been merged.
1338                 # However, if it's the same as our current record, proceed with the update, because we want to update
1339                 # our tokens.
1340                 return
1341             else:
1342                 self._past_versions.add((response.get("modified_at"), response.get("portable_data_hash")))
1343             other = CollectionReader(response["manifest_text"])
1344         baseline = CollectionReader(self._manifest_text)
1345         self.apply(baseline.diff(other))
1346         self._manifest_text = self.manifest_text()
1347
1348     @synchronized
1349     def _my_api(self):
1350         if self._api_client is None:
1351             self._api_client = ThreadSafeApiCache(self._config)
1352             if self._keep_client is None:
1353                 self._keep_client = self._api_client.keep
1354         return self._api_client
1355
1356     @synchronized
1357     def _my_keep(self):
1358         if self._keep_client is None:
1359             if self._api_client is None:
1360                 self._my_api()
1361             else:
1362                 self._keep_client = KeepClient(api_client=self._api_client)
1363         return self._keep_client
1364
1365     @synchronized
1366     def _my_block_manager(self):
1367         if self._block_manager is None:
1368             copies = (self.replication_desired or
1369                       self._my_api()._rootDesc.get('defaultCollectionReplication',
1370                                                    2))
1371             self._block_manager = _BlockManager(self._my_keep(), copies=copies, put_threads=self.put_threads)
1372         return self._block_manager
1373
1374     def _remember_api_response(self, response):
1375         self._api_response = response
1376         self._past_versions.add((response.get("modified_at"), response.get("portable_data_hash")))
1377
1378     def _populate_from_api_server(self):
1379         # As in KeepClient itself, we must wait until the last
1380         # possible moment to instantiate an API client, in order to
1381         # avoid tripping up clients that don't have access to an API
1382         # server.  If we do build one, make sure our Keep client uses
1383         # it.  If instantiation fails, we'll fall back to the except
1384         # clause, just like any other Collection lookup
1385         # failure. Return an exception, or None if successful.
1386         self._remember_api_response(self._my_api().collections().get(
1387             uuid=self._manifest_locator).execute(
1388                 num_retries=self.num_retries))
1389         self._manifest_text = self._api_response['manifest_text']
1390         self._portable_data_hash = self._api_response['portable_data_hash']
1391         # If not overriden via kwargs, we should try to load the
1392         # replication_desired from the API server
1393         if self.replication_desired is None:
1394             self.replication_desired = self._api_response.get('replication_desired', None)
1395
1396     def _populate(self):
1397         if self._manifest_text is None:
1398             if self._manifest_locator is None:
1399                 return
1400             else:
1401                 self._populate_from_api_server()
1402         self._baseline_manifest = self._manifest_text
1403         self._import_manifest(self._manifest_text)
1404
1405     def _has_collection_uuid(self):
1406         return self._manifest_locator is not None and re.match(arvados.util.collection_uuid_pattern, self._manifest_locator)
1407
1408     def _has_local_collection_uuid(self):
1409         return self._has_collection_uuid and \
1410             self._my_api()._rootDesc['uuidPrefix'] == self._manifest_locator.split('-')[0]
1411
1412     def __enter__(self):
1413         return self
1414
1415     def __exit__(self, exc_type, exc_value, traceback):
1416         """Support scoped auto-commit in a with: block."""
1417         if exc_type is None:
1418             if self.writable() and self._has_collection_uuid():
1419                 self.save()
1420         self.stop_threads()
1421
1422     def stop_threads(self):
1423         if self._block_manager is not None:
1424             self._block_manager.stop_threads()
1425
1426     @synchronized
1427     def manifest_locator(self):
1428         """Get the manifest locator, if any.
1429
1430         The manifest locator will be set when the collection is loaded from an
1431         API server record or the portable data hash of a manifest.
1432
1433         The manifest locator will be None if the collection is newly created or
1434         was created directly from manifest text.  The method `save_new()` will
1435         assign a manifest locator.
1436
1437         """
1438         return self._manifest_locator
1439
1440     @synchronized
1441     def clone(self, new_parent=None, new_name=None, readonly=False, new_config=None):
1442         if new_config is None:
1443             new_config = self._config
1444         if readonly:
1445             newcollection = CollectionReader(parent=new_parent, apiconfig=new_config)
1446         else:
1447             newcollection = Collection(parent=new_parent, apiconfig=new_config)
1448
1449         newcollection._clonefrom(self)
1450         return newcollection
1451
1452     @synchronized
1453     def api_response(self):
1454         """Returns information about this Collection fetched from the API server.
1455
1456         If the Collection exists in Keep but not the API server, currently
1457         returns None.  Future versions may provide a synthetic response.
1458
1459         """
1460         return self._api_response
1461
1462     def find_or_create(self, path, create_type):
1463         """See `RichCollectionBase.find_or_create`"""
1464         if path == ".":
1465             return self
1466         else:
1467             return super(Collection, self).find_or_create(path[2:] if path.startswith("./") else path, create_type)
1468
1469     def find(self, path):
1470         """See `RichCollectionBase.find`"""
1471         if path == ".":
1472             return self
1473         else:
1474             return super(Collection, self).find(path[2:] if path.startswith("./") else path)
1475
1476     def remove(self, path, recursive=False):
1477         """See `RichCollectionBase.remove`"""
1478         if path == ".":
1479             raise errors.ArgumentError("Cannot remove '.'")
1480         else:
1481             return super(Collection, self).remove(path[2:] if path.startswith("./") else path, recursive)
1482
1483     @must_be_writable
1484     @synchronized
1485     @retry_method
1486     def save(self,
1487              properties=None,
1488              storage_classes=None,
1489              trash_at=None,
1490              merge=True,
1491              num_retries=None):
1492         """Save collection to an existing collection record.
1493
1494         Commit pending buffer blocks to Keep, merge with remote record (if
1495         merge=True, the default), and update the collection record. Returns
1496         the current manifest text.
1497
1498         Will raise AssertionError if not associated with a collection record on
1499         the API server.  If you want to save a manifest to Keep only, see
1500         `save_new()`.
1501
1502         :properties:
1503           Additional properties of collection. This value will replace any existing
1504           properties of collection.
1505
1506         :storage_classes:
1507           Specify desirable storage classes to be used when writing data to Keep.
1508
1509         :trash_at:
1510           A collection is *expiring* when it has a *trash_at* time in the future.
1511           An expiring collection can be accessed as normal,
1512           but is scheduled to be trashed automatically at the *trash_at* time.
1513
1514         :merge:
1515           Update and merge remote changes before saving.  Otherwise, any
1516           remote changes will be ignored and overwritten.
1517
1518         :num_retries:
1519           Retry count on API calls (if None,  use the collection default)
1520
1521         """
1522         if properties and type(properties) is not dict:
1523             raise errors.ArgumentError("properties must be dictionary type.")
1524
1525         if storage_classes and type(storage_classes) is not list:
1526             raise errors.ArgumentError("storage_classes must be list type.")
1527
1528         if trash_at and type(trash_at) is not datetime.datetime:
1529             raise errors.ArgumentError("trash_at must be datetime type.")
1530
1531         body={}
1532         if properties:
1533             body["properties"] = properties
1534         if storage_classes:
1535             body["storage_classes_desired"] = storage_classes
1536         if trash_at:
1537             t = trash_at.strftime("%Y-%m-%dT%H:%M:%S.%fZ")
1538             body["trash_at"] = t
1539
1540         # Copy any remote blocks to the local cluster.
1541         self._copy_remote_blocks(remote_blocks={})
1542
1543         if not self.committed():
1544             if not self._has_collection_uuid():
1545                 raise AssertionError("Collection manifest_locator is not a collection uuid.  Use save_new() for new collections.")
1546             elif not self._has_local_collection_uuid():
1547                 raise AssertionError("Collection manifest_locator is from a remote cluster. Use save_new() to save it on the local cluster.")
1548
1549             self._my_block_manager().commit_all()
1550
1551             if merge:
1552                 self.update()
1553
1554             text = self.manifest_text(strip=False)
1555             body['manifest_text'] = text
1556
1557             self._remember_api_response(self._my_api().collections().update(
1558                 uuid=self._manifest_locator,
1559                 body=body
1560                 ).execute(num_retries=num_retries))
1561             self._manifest_text = self._api_response["manifest_text"]
1562             self._portable_data_hash = self._api_response["portable_data_hash"]
1563             self.set_committed(True)
1564         elif body:
1565             self._remember_api_response(self._my_api().collections().update(
1566                 uuid=self._manifest_locator,
1567                 body=body
1568                 ).execute(num_retries=num_retries))
1569
1570         return self._manifest_text
1571
1572
1573     @must_be_writable
1574     @synchronized
1575     @retry_method
1576     def save_new(self, name=None,
1577                  create_collection_record=True,
1578                  owner_uuid=None,
1579                  properties=None,
1580                  storage_classes=None,
1581                  trash_at=None,
1582                  ensure_unique_name=False,
1583                  num_retries=None):
1584         """Save collection to a new collection record.
1585
1586         Commit pending buffer blocks to Keep and, when create_collection_record
1587         is True (default), create a new collection record.  After creating a
1588         new collection record, this Collection object will be associated with
1589         the new record used by `save()`. Returns the current manifest text.
1590
1591         :name:
1592           The collection name.
1593
1594         :create_collection_record:
1595            If True, create a collection record on the API server.
1596            If False, only commit blocks to Keep and return the manifest text.
1597
1598         :owner_uuid:
1599           the user, or project uuid that will own this collection.
1600           If None, defaults to the current user.
1601
1602         :properties:
1603           Additional properties of collection. This value will replace any existing
1604           properties of collection.
1605
1606         :storage_classes:
1607           Specify desirable storage classes to be used when writing data to Keep.
1608
1609         :trash_at:
1610           A collection is *expiring* when it has a *trash_at* time in the future.
1611           An expiring collection can be accessed as normal,
1612           but is scheduled to be trashed automatically at the *trash_at* time.
1613
1614         :ensure_unique_name:
1615           If True, ask the API server to rename the collection
1616           if it conflicts with a collection with the same name and owner.  If
1617           False, a name conflict will result in an error.
1618
1619         :num_retries:
1620           Retry count on API calls (if None,  use the collection default)
1621
1622         """
1623         if properties and type(properties) is not dict:
1624             raise errors.ArgumentError("properties must be dictionary type.")
1625
1626         if storage_classes and type(storage_classes) is not list:
1627             raise errors.ArgumentError("storage_classes must be list type.")
1628
1629         if trash_at and type(trash_at) is not datetime.datetime:
1630             raise errors.ArgumentError("trash_at must be datetime type.")
1631
1632         # Copy any remote blocks to the local cluster.
1633         self._copy_remote_blocks(remote_blocks={})
1634
1635         self._my_block_manager().commit_all()
1636         text = self.manifest_text(strip=False)
1637
1638         if create_collection_record:
1639             if name is None:
1640                 name = "New collection"
1641                 ensure_unique_name = True
1642
1643             body = {"manifest_text": text,
1644                     "name": name,
1645                     "replication_desired": self.replication_desired}
1646             if owner_uuid:
1647                 body["owner_uuid"] = owner_uuid
1648             if properties:
1649                 body["properties"] = properties
1650             if storage_classes:
1651                 body["storage_classes_desired"] = storage_classes
1652             if trash_at:
1653                 t = trash_at.strftime("%Y-%m-%dT%H:%M:%S.%fZ")
1654                 body["trash_at"] = t
1655
1656             self._remember_api_response(self._my_api().collections().create(ensure_unique_name=ensure_unique_name, body=body).execute(num_retries=num_retries))
1657             text = self._api_response["manifest_text"]
1658
1659             self._manifest_locator = self._api_response["uuid"]
1660             self._portable_data_hash = self._api_response["portable_data_hash"]
1661
1662             self._manifest_text = text
1663             self.set_committed(True)
1664
1665         return text
1666
1667     _token_re = re.compile(r'(\S+)(\s+|$)')
1668     _block_re = re.compile(r'[0-9a-f]{32}\+(\d+)(\+\S+)*')
1669     _segment_re = re.compile(r'(\d+):(\d+):(\S+)')
1670
1671     @synchronized
1672     def _import_manifest(self, manifest_text):
1673         """Import a manifest into a `Collection`.
1674
1675         :manifest_text:
1676           The manifest text to import from.
1677
1678         """
1679         if len(self) > 0:
1680             raise ArgumentError("Can only import manifest into an empty collection")
1681
1682         STREAM_NAME = 0
1683         BLOCKS = 1
1684         SEGMENTS = 2
1685
1686         stream_name = None
1687         state = STREAM_NAME
1688
1689         for token_and_separator in self._token_re.finditer(manifest_text):
1690             tok = token_and_separator.group(1)
1691             sep = token_and_separator.group(2)
1692
1693             if state == STREAM_NAME:
1694                 # starting a new stream
1695                 stream_name = tok.replace('\\040', ' ')
1696                 blocks = []
1697                 segments = []
1698                 streamoffset = 0
1699                 state = BLOCKS
1700                 self.find_or_create(stream_name, COLLECTION)
1701                 continue
1702
1703             if state == BLOCKS:
1704                 block_locator = self._block_re.match(tok)
1705                 if block_locator:
1706                     blocksize = int(block_locator.group(1))
1707                     blocks.append(Range(tok, streamoffset, blocksize, 0))
1708                     streamoffset += blocksize
1709                 else:
1710                     state = SEGMENTS
1711
1712             if state == SEGMENTS:
1713                 file_segment = self._segment_re.match(tok)
1714                 if file_segment:
1715                     pos = int(file_segment.group(1))
1716                     size = int(file_segment.group(2))
1717                     name = file_segment.group(3).replace('\\040', ' ')
1718                     filepath = os.path.join(stream_name, name)
1719                     afile = self.find_or_create(filepath, FILE)
1720                     if isinstance(afile, ArvadosFile):
1721                         afile.add_segment(blocks, pos, size)
1722                     else:
1723                         raise errors.SyntaxError("File %s conflicts with stream of the same name.", filepath)
1724                 else:
1725                     # error!
1726                     raise errors.SyntaxError("Invalid manifest format, expected file segment but did not match format: '%s'" % tok)
1727
1728             if sep == "\n":
1729                 stream_name = None
1730                 state = STREAM_NAME
1731
1732         self.set_committed(True)
1733
1734     @synchronized
1735     def notify(self, event, collection, name, item):
1736         if self._callback:
1737             self._callback(event, collection, name, item)
1738
1739
1740 class Subcollection(RichCollectionBase):
1741     """This is a subdirectory within a collection that doesn't have its own API
1742     server record.
1743
1744     Subcollection locking falls under the umbrella lock of its root collection.
1745
1746     """
1747
1748     def __init__(self, parent, name):
1749         super(Subcollection, self).__init__(parent)
1750         self.lock = self.root_collection().lock
1751         self._manifest_text = None
1752         self.name = name
1753         self.num_retries = parent.num_retries
1754
1755     def root_collection(self):
1756         return self.parent.root_collection()
1757
1758     def writable(self):
1759         return self.root_collection().writable()
1760
1761     def _my_api(self):
1762         return self.root_collection()._my_api()
1763
1764     def _my_keep(self):
1765         return self.root_collection()._my_keep()
1766
1767     def _my_block_manager(self):
1768         return self.root_collection()._my_block_manager()
1769
1770     def stream_name(self):
1771         return os.path.join(self.parent.stream_name(), self.name)
1772
1773     @synchronized
1774     def clone(self, new_parent, new_name):
1775         c = Subcollection(new_parent, new_name)
1776         c._clonefrom(self)
1777         return c
1778
1779     @must_be_writable
1780     @synchronized
1781     def _reparent(self, newparent, newname):
1782         self.set_committed(False)
1783         self.flush()
1784         self.parent.remove(self.name, recursive=True)
1785         self.parent = newparent
1786         self.name = newname
1787         self.lock = self.parent.root_collection().lock
1788
1789
1790 class CollectionReader(Collection):
1791     """A read-only collection object.
1792
1793     Initialize from a collection UUID or portable data hash, or raw
1794     manifest text.  See `Collection` constructor for detailed options.
1795
1796     """
1797     def __init__(self, manifest_locator_or_text, *args, **kwargs):
1798         self._in_init = True
1799         super(CollectionReader, self).__init__(manifest_locator_or_text, *args, **kwargs)
1800         self._in_init = False
1801
1802         # Forego any locking since it should never change once initialized.
1803         self.lock = NoopLock()
1804
1805         # Backwards compatability with old CollectionReader
1806         # all_streams() and all_files()
1807         self._streams = None
1808
1809     def writable(self):
1810         return self._in_init
1811
1812     def _populate_streams(orig_func):
1813         @functools.wraps(orig_func)
1814         def populate_streams_wrapper(self, *args, **kwargs):
1815             # Defer populating self._streams until needed since it creates a copy of the manifest.
1816             if self._streams is None:
1817                 if self._manifest_text:
1818                     self._streams = [sline.split()
1819                                      for sline in self._manifest_text.split("\n")
1820                                      if sline]
1821                 else:
1822                     self._streams = []
1823             return orig_func(self, *args, **kwargs)
1824         return populate_streams_wrapper
1825
1826     @_populate_streams
1827     def normalize(self):
1828         """Normalize the streams returned by `all_streams`.
1829
1830         This method is kept for backwards compatability and only affects the
1831         behavior of `all_streams()` and `all_files()`
1832
1833         """
1834
1835         # Rearrange streams
1836         streams = {}
1837         for s in self.all_streams():
1838             for f in s.all_files():
1839                 streamname, filename = split(s.name() + "/" + f.name())
1840                 if streamname not in streams:
1841                     streams[streamname] = {}
1842                 if filename not in streams[streamname]:
1843                     streams[streamname][filename] = []
1844                 for r in f.segments:
1845                     streams[streamname][filename].extend(s.locators_and_ranges(r.locator, r.range_size))
1846
1847         self._streams = [normalize_stream(s, streams[s])
1848                          for s in sorted(streams)]
1849     @_populate_streams
1850     def all_streams(self):
1851         return [StreamReader(s, self._my_keep(), num_retries=self.num_retries)
1852                 for s in self._streams]
1853
1854     @_populate_streams
1855     def all_files(self):
1856         for s in self.all_streams():
1857             for f in s.all_files():
1858                 yield f