sdk/python/arvados/commands/put.py

   1 #!/usr/bin/env python
   2
   3 # TODO:
   4 # --md5sum - display md5 of each file as read from disk
   5
   6 import argparse
   7 import arvados
   8 import base64
   9 import errno
  10 import fcntl
  11 import hashlib
  12 import json
  13 import os
  14 import sys
  15 import tempfile
  16
  17 def parse_arguments(arguments):
  18     parser = argparse.ArgumentParser(
  19         description='Copy data from the local filesystem to Keep.')
  20
  21     parser.add_argument('paths', metavar='path', type=str, nargs='*',
  22                         help="""
  23     Local file or directory. Default: read from standard input.
  24     """)
  25
  26     parser.add_argument('--max-manifest-depth', type=int, metavar='N',
  27                         default=-1, help="""
  28     Maximum depth of directory tree to represent in the manifest
  29     structure. A directory structure deeper than this will be represented
  30     as a single stream in the manifest. If N=0, the manifest will contain
  31     a single stream. Default: -1 (unlimited), i.e., exactly one manifest
  32     stream per filesystem directory that contains files.
  33     """)
  34
  35     group = parser.add_mutually_exclusive_group()
  36
  37     group.add_argument('--as-stream', action='store_true', dest='stream',
  38                        help="""
  39     Synonym for --stream.
  40     """)
  41
  42     group.add_argument('--stream', action='store_true',
  43                        help="""
  44     Store the file content and display the resulting manifest on
  45     stdout. Do not write the manifest to Keep or save a Collection object
  46     in Arvados.
  47     """)
  48
  49     group.add_argument('--as-manifest', action='store_true', dest='manifest',
  50                        help="""
  51     Synonym for --manifest.
  52     """)
  53
  54     group.add_argument('--in-manifest', action='store_true', dest='manifest',
  55                        help="""
  56     Synonym for --manifest.
  57     """)
  58
  59     group.add_argument('--manifest', action='store_true',
  60                        help="""
  61     Store the file data and resulting manifest in Keep, save a Collection
  62     object in Arvados, and display the manifest locator (Collection uuid)
  63     on stdout. This is the default behavior.
  64     """)
  65
  66     group.add_argument('--as-raw', action='store_true', dest='raw',
  67                        help="""
  68     Synonym for --raw.
  69     """)
  70
  71     group.add_argument('--raw', action='store_true',
  72                        help="""
  73     Store the file content and display the data block locators on stdout,
  74     separated by commas, with a trailing newline. Do not store a
  75     manifest.
  76     """)
  77
  78     parser.add_argument('--use-filename', type=str, default=None,
  79                         dest='filename', help="""
  80     Synonym for --filename.
  81     """)
  82
  83     parser.add_argument('--filename', type=str, default=None,
  84                         help="""
  85     Use the given filename in the manifest, instead of the name of the
  86     local file. This is useful when "-" or "/dev/stdin" is given as an
  87     input file. It can be used only if there is exactly one path given and
  88     it is not a directory. Implies --manifest.
  89     """)
  90
  91     group = parser.add_mutually_exclusive_group()
  92     group.add_argument('--progress', action='store_true',
  93                        help="""
  94     Display human-readable progress on stderr (bytes and, if possible,
  95     percentage of total data size). This is the default behavior when
  96     stderr is a tty.
  97     """)
  98
  99     group.add_argument('--no-progress', action='store_true',
 100                        help="""
 101     Do not display human-readable progress on stderr, even if stderr is a
 102     tty.
 103     """)
 104
 105     group.add_argument('--batch-progress', action='store_true',
 106                        help="""
 107     Display machine-readable progress on stderr (bytes and, if known,
 108     total data size).
 109     """)
 110
 111     args = parser.parse_args(arguments)
 112
 113     if len(args.paths) == 0:
 114         args.paths += ['/dev/stdin']
 115
 116     if len(args.paths) != 1 or os.path.isdir(args.paths[0]):
 117         if args.filename:
 118             parser.error("""
 119     --filename argument cannot be used when storing a directory or
 120     multiple files.
 121     """)
 122
 123     # Turn on --progress by default if stderr is a tty.
 124     if (not (args.batch_progress or args.no_progress)
 125         and os.isatty(sys.stderr.fileno())):
 126         args.progress = True
 127
 128     if args.paths == ['-']:
 129         args.paths = ['/dev/stdin']
 130         if not args.filename:
 131             args.filename = '-'
 132
 133     return args
 134
 135 class ResumeCacheConflict(Exception):
 136     pass
 137
 138
 139 class ResumeCache(object):
 140     CACHE_DIR = os.path.expanduser('~/.cache/arvados/arv-put')
 141
 142     def __init__(self, file_spec):
 143         try:
 144             self.cache_file = open(file_spec, 'a+')
 145         except TypeError:
 146             file_spec = self.make_path(file_spec)
 147             self.cache_file = open(file_spec, 'a+')
 148         self._lock_file(self.cache_file)
 149         self.filename = self.cache_file.name
 150
 151     @classmethod
 152     def make_path(cls, args):
 153         md5 = hashlib.md5()
 154         md5.update(arvados.config.get('ARVADOS_API_HOST', '!nohost'))
 155         realpaths = sorted(os.path.realpath(path) for path in args.paths)
 156         md5.update(''.join(realpaths))
 157         if any(os.path.isdir(path) for path in realpaths):
 158             md5.update(str(max(args.max_manifest_depth, -1)))
 159         elif args.filename:
 160             md5.update(args.filename)
 161         return os.path.join(cls.CACHE_DIR, md5.hexdigest())
 162
 163     def _lock_file(self, fileobj):
 164         try:
 165             fcntl.flock(fileobj, fcntl.LOCK_EX | fcntl.LOCK_NB)
 166         except IOError:
 167             raise ResumeCacheConflict("{} locked".format(fileobj.name))
 168
 169     def load(self):
 170         self.cache_file.seek(0)
 171         return json.load(self.cache_file)
 172
 173     def save(self, data):
 174         try:
 175             new_cache_fd, new_cache_name = tempfile.mkstemp(
 176                 dir=os.path.dirname(self.filename))
 177             self._lock_file(new_cache_fd)
 178             new_cache = os.fdopen(new_cache_fd, 'r+')
 179             json.dump(data, new_cache)
 180             os.rename(new_cache_name, self.filename)
 181         except (IOError, OSError, ResumeCacheConflict) as error:
 182             try:
 183                 os.unlink(new_cache_name)
 184             except NameError:  # mkstemp failed.
 185                 pass
 186         else:
 187             self.cache_file.close()
 188             self.cache_file = new_cache
 189
 190     def close(self):
 191         self.cache_file.close()
 192
 193     def destroy(self):
 194         try:
 195             os.unlink(self.filename)
 196         except OSError as error:
 197             if error.errno != errno.ENOENT:  # That's what we wanted anyway.
 198                 raise
 199         self.close()
 200
 201
 202 class ArvPutCollectionWriter(arvados.ResumableCollectionWriter):
 203     def __init__(self, cache=None, reporter=None, bytes_expected=None):
 204         self.__init_locals__(cache, reporter, bytes_expected)
 205         super(ArvPutCollectionWriter, self).__init__()
 206
 207     def __init_locals__(self, cache, reporter, bytes_expected):
 208         self.cache = cache
 209         self.report_func = reporter
 210         self.bytes_written = 0
 211         self.bytes_expected = bytes_expected
 212
 213     @classmethod
 214     def from_cache(cls, cache, reporter=None, bytes_expected=None):
 215         try:
 216             state = cache.load()
 217             state['_data_buffer'] = [base64.decodestring(state['_data_buffer'])]
 218             writer = cls.from_state(state)
 219         except (TypeError, ValueError,
 220                 arvados.errors.StaleWriterStateError) as error:
 221             return cls(cache, reporter, bytes_expected)
 222         else:
 223             writer.__init_locals__(cache, reporter, bytes_expected)
 224             return writer
 225
 226     def checkpoint_state(self):
 227         if self.cache is None:
 228             return
 229         state = self.dump_state()
 230         # Transform attributes for serialization.
 231         for attr, value in state.items():
 232             if attr == '_data_buffer':
 233                 state[attr] = base64.encodestring(''.join(value))
 234             elif hasattr(value, 'popleft'):
 235                 state[attr] = list(value)
 236         self.cache.save(state)
 237
 238     def flush_data(self):
 239         bytes_buffered = self._data_buffer_len
 240         super(ArvPutCollectionWriter, self).flush_data()
 241         self.bytes_written += (bytes_buffered - self._data_buffer_len)
 242         if self.report_func is not None:
 243             self.report_func(self.bytes_written, self.bytes_expected)
 244
 245
 246 def expected_bytes_for(pathlist):
 247     # Walk the given directory trees and stat files, adding up file sizes,
 248     # so we can display progress as percent
 249     bytesum = 0
 250     for path in pathlist:
 251         if os.path.isdir(path):
 252             for filename in arvados.util.listdir_recursive(path):
 253                 bytesum += os.path.getsize(os.path.join(path, filename))
 254         elif not os.path.isfile(path):
 255             return None
 256         else:
 257             bytesum += os.path.getsize(path)
 258     return bytesum
 259
 260 _machine_format = "{} {}: {{}} written {{}} total\n".format(sys.argv[0],
 261                                                             os.getpid())
 262 def machine_progress(bytes_written, bytes_expected):
 263     return _machine_format.format(
 264         bytes_written, -1 if (bytes_expected is None) else bytes_expected)
 265
 266 def human_progress(bytes_written, bytes_expected):
 267     if bytes_expected:
 268         return "\r{}M / {}M {:.1f}% ".format(
 269             bytes_written >> 20, bytes_expected >> 20,
 270             bytes_written / bytes_expected)
 271     else:
 272         return "\r{} ".format(bytes_written)
 273
 274 def progress_writer(progress_func, outfile=sys.stderr):
 275     def write_progress(bytes_written, bytes_expected):
 276         outfile.write(progress_func(bytes_written, bytes_expected))
 277     return write_progress
 278
 279 def main(arguments=None):
 280     args = parse_arguments(arguments)
 281
 282     if args.progress:
 283         reporter = progress_writer(human_progress)
 284     elif args.batch_progress:
 285         reporter = progress_writer(machine_progress)
 286     else:
 287         reporter = None
 288
 289     writer = ArvPutCollectionWriter(
 290         reporter=reporter, bytes_expected=expected_bytes_for(args.paths))
 291
 292     # Copy file data to Keep.
 293     for path in args.paths:
 294         if os.path.isdir(path):
 295             writer.write_directory_tree(
 296                 path, max_manifest_depth=args.max_manifest_depth)
 297         else:
 298             writer.start_new_stream()
 299             writer.write_file(path, args.filename or os.path.basename(path))
 300
 301     if args.stream:
 302         print writer.manifest_text(),
 303     elif args.raw:
 304         writer.finish_current_stream()
 305         print ','.join(writer.data_locators())
 306     else:
 307         # Register the resulting collection in Arvados.
 308         arvados.api().collections().create(
 309             body={
 310                 'uuid': writer.finish(),
 311                 'manifest_text': writer.manifest_text(),
 312                 },
 313             ).execute()
 314
 315         # Print the locator (uuid) of the new collection.
 316         print writer.finish()
 317
 318 if __name__ == '__main__':
 319     main()