__init__.py 39.4 KB
Newer Older
Stavros Sachtouris's avatar
Stavros Sachtouris committed
1
# Copyright 2011-2013 GRNET S.A. All rights reserved.
Giorgos Verigakis's avatar
Giorgos Verigakis committed
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
#
# Redistribution and use in source and binary forms, with or
# without modification, are permitted provided that the following
# conditions are met:
#
#   1. Redistributions of source code must retain the above
#      copyright notice, this list of conditions and the following
#      disclaimer.
#
#   2. Redistributions in binary form must reproduce the above
#      copyright notice, this list of conditions and the following
#      disclaimer in the documentation and/or other materials
#      provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#
# The views and conclusions contained in the software and
# documentation are those of the authors and should not be
# interpreted as representing official policies, either expressed
# or implied, of GRNET S.A.

34
from threading import enumerate as activethreads
35

36
from os import fstat
37
from hashlib import new as newhashlib
38
from time import time
39
from StringIO import StringIO
Giorgos Verigakis's avatar
Giorgos Verigakis committed
40

41
from binascii import hexlify
Giorgos Verigakis's avatar
Giorgos Verigakis committed
42

43
from kamaki.clients import SilentEvent, sendlog
44
from kamaki.clients.pithos.rest_api import PithosRestClient
45
46
from kamaki.clients.storage import ClientError
from kamaki.clients.utils import path4url, filter_in
Giorgos Verigakis's avatar
Giorgos Verigakis committed
47

48

49
def _pithos_hash(block, blockhash):
50
    h = newhashlib(blockhash)
Giorgos Verigakis's avatar
Giorgos Verigakis committed
51
52
53
    h.update(block.rstrip('\x00'))
    return h.hexdigest()

54

55
56
57
58
59
def _range_up(start, end, a_range):
    if a_range:
        (rstart, rend) = a_range.split('-')
        (rstart, rend) = (int(rstart), int(rend))
        if rstart > end or rend < start:
60
            return (0, 0)
61
62
63
64
65
66
        if rstart > start:
            start = rstart
        if rend < end:
            end = rend
    return (start, end)

67

68
class PithosClient(PithosRestClient):
69
    """Synnefo Pithos+ API client"""
Giorgos Verigakis's avatar
Giorgos Verigakis committed
70

71
72
    def __init__(self, base_url, token, account=None, container=None):
        super(PithosClient, self).__init__(base_url, token, account, container)
73

74
    def purge_container(self, container=None):
75
76
        """Delete an empty container and destroy associated blocks
        """
77
78
79
        cnt_back_up = self.container
        try:
            self.container = container or cnt_back_up
80
            self.container_delete(until=unicode(time()))
81
82
        finally:
            self.container = cnt_back_up
83

84
85
86
87
88
89
90
91
92
93
    def upload_object_unchunked(
            self, obj, f,
            withHashFile=False,
            size=None,
            etag=None,
            content_encoding=None,
            content_disposition=None,
            content_type=None,
            sharing=None,
            public=None):
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
        """
        :param obj: (str) remote object path

        :param f: open file descriptor

        :param withHashFile: (bool)

        :param size: (int) size of data to upload

        :param etag: (str)

        :param content_encoding: (str)

        :param content_disposition: (str)

        :param content_type: (str)

        :param sharing: {'read':[user and/or grp names],
            'write':[usr and/or grp names]}

        :param public: (bool)
115
116

        :returns: (dict) created object metadata
117
        """
118
        self._assert_container()
119
120
121
122
123
124
125

        if withHashFile:
            data = f.read()
            try:
                import json
                data = json.dumps(json.loads(data))
            except ValueError:
126
                raise ClientError('"%s" is not json-formated' % f.name, 1)
127
            except SyntaxError:
128
129
                msg = '"%s" is not a valid hashmap file' % f.name
                raise ClientError(msg, 1)
130
            f = StringIO(data)
131
        else:
132
            data = f.read(size) if size else f.read()
133
        r = self.object_put(
134
            obj,
135
136
137
138
139
140
141
142
            data=data,
            etag=etag,
            content_encoding=content_encoding,
            content_disposition=content_disposition,
            content_type=content_type,
            permissions=sharing,
            public=public,
            success=201)
143
        return r.headers
144

145
146
147
148
149
150
151
152
    def create_object_by_manifestation(
            self, obj,
            etag=None,
            content_encoding=None,
            content_disposition=None,
            content_type=None,
            sharing=None,
            public=None):
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
        """
        :param obj: (str) remote object path

        :param etag: (str)

        :param content_encoding: (str)

        :param content_disposition: (str)

        :param content_type: (str)

        :param sharing: {'read':[user and/or grp names],
            'write':[usr and/or grp names]}

        :param public: (bool)
168
169

        :returns: (dict) created object metadata
170
        """
171
        self._assert_container()
172
        r = self.object_put(
173
            obj,
174
175
176
177
178
179
180
181
            content_length=0,
            etag=etag,
            content_encoding=content_encoding,
            content_disposition=content_disposition,
            content_type=content_type,
            permissions=sharing,
            public=public,
            manifest='%s/%s' % (self.container, obj))
182
        return r.headers
183

184
    # upload_* auxiliary methods
185
    def _put_block_async(self, data, hash, upload_gen=None):
186
187
188
189
190
        event = SilentEvent(method=self._put_block, data=data, hash=hash)
        event.start()
        return event

    def _put_block(self, data, hash):
191
192
        r = self.container_post(
            update=True,
193
194
195
196
197
198
            content_type='application/octet-stream',
            content_length=len(data),
            data=data,
            format='json')
        assert r.json[0] == hash, 'Local hash does not match server'

199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
    def _get_file_block_info(self, fileobj, size=None, cache=None):
        """
        :param fileobj: (file descriptor) source

        :param size: (int) size of data to upload from source

        :param cache: (dict) if provided, cache container info response to
        avoid redundant calls
        """
        if isinstance(cache, dict):
            try:
                meta = cache[self.container]
            except KeyError:
                meta = self.get_container_info()
                cache[self.container] = meta
        else:
            meta = self.get_container_info()
216
217
        blocksize = int(meta['x-container-block-size'])
        blockhash = meta['x-container-block-hash']
218
        size = size if size is not None else fstat(fileobj.fileno()).st_size
219
        nblocks = 1 + (size - 1) // blocksize
220
221
        return (blocksize, blockhash, size, nblocks)

222
    def _create_or_get_missing_hashes(
223
224
225
226
227
            self, obj, json,
            size=None,
            format='json',
            hashmap=True,
            content_type=None,
228
229
            if_etag_match=None,
            if_etag_not_match=None,
230
231
232
233
234
235
236
            content_encoding=None,
            content_disposition=None,
            permissions=None,
            public=None,
            success=(201, 409)):
        r = self.object_put(
            obj,
237
238
239
240
            format='json',
            hashmap=True,
            content_type=content_type,
            json=json,
241
242
            if_etag_match=if_etag_match,
            if_etag_not_match=if_etag_not_match,
243
244
245
246
            content_encoding=content_encoding,
            content_disposition=content_disposition,
            permissions=permissions,
            public=public,
247
            success=success)
248
        return (None if r.status_code == 201 else r.json), r.headers
249

250
    def _calculate_blocks_for_upload(
251
252
            self, blocksize, blockhash, size, nblocks, hashes, hmap, fileobj,
            hash_cb=None):
253
        offset = 0
254
255
256
257
258
        if hash_cb:
            hash_gen = hash_cb(nblocks)
            hash_gen.next()

        for i in range(nblocks):
259
            block = fileobj.read(min(blocksize, size - offset))
260
            bytes = len(block)
261
            hash = _pithos_hash(block, blockhash)
262
            hashes.append(hash)
263
            hmap[hash] = (offset, bytes)
264
265
266
            offset += bytes
            if hash_cb:
                hash_gen.next()
Stavros Sachtouris's avatar
Stavros Sachtouris committed
267
        msg = 'Failed to calculate uploaded blocks:'
268
        ' Offset and object size do not match'
Stavros Sachtouris's avatar
Stavros Sachtouris committed
269
        assert offset == size, msg
270

271
272
    def _upload_missing_blocks(self, missing, hmap, fileobj, upload_gen=None):
        """upload missing blocks asynchronously"""
273

274
        self._init_thread_limit()
275

276
        flying = []
277
        failures = []
278
        for hash in missing:
279
            offset, bytes = hmap[hash]
280
281
            fileobj.seek(offset)
            data = fileobj.read(bytes)
282
            r = self._put_block_async(data, hash, upload_gen)
283
            flying.append(r)
284
285
            unfinished = self._watch_thread_limit(flying)
            for thread in set(flying).difference(unfinished):
286
287
                if thread.exception:
                    failures.append(thread)
288
                    if isinstance(
289
290
291
                            thread.exception,
                            ClientError) and thread.exception.status == 502:
                        self.POOLSIZE = self._thread_limit
292
                elif thread.isAlive():
293
                    flying.append(thread)
294
295
296
297
298
                elif upload_gen:
                    try:
                        upload_gen.next()
                    except:
                        pass
299
300
301
302
            flying = unfinished

        for thread in flying:
            thread.join()
303
304
            if thread.exception:
                failures.append(thread)
305
306
307
308
309
            elif upload_gen:
                try:
                    upload_gen.next()
                except:
                    pass
310

311
        return [failure.kwargs['hash'] for failure in failures]
312

313
314
315
316
317
318
    def upload_object(
            self, obj, f,
            size=None,
            hash_cb=None,
            upload_cb=None,
            etag=None,
319
            if_etag_match=None,
320
            if_not_exist=None,
321
322
323
324
            content_encoding=None,
            content_disposition=None,
            content_type=None,
            sharing=None,
325
326
            public=None,
            container_info_cache=None):
327
328
329
330
331
332
333
334
335
336
337
338
        """Upload an object using multiple connections (threads)

        :param obj: (str) remote object path

        :param f: open file descriptor (rb)

        :param hash_cb: optional progress.bar object for calculating hashes

        :param upload_cb: optional progress.bar object for uploading

        :param etag: (str)

339
340
341
        :param if_etag_match: (str) Push that value to if-match header at file
            creation

342
343
344
345
346
        :param if_not_exist: (bool) If true, the file will be uploaded ONLY if
            it does not exist remotely, otherwise the operation will fail.
            Involves the case of an object with the same path is created while
            the object is being uploaded.

347
348
349
350
351
352
353
354
355
356
        :param content_encoding: (str)

        :param content_disposition: (str)

        :param content_type: (str)

        :param sharing: {'read':[user and/or grp names],
            'write':[usr and/or grp names]}

        :param public: (bool)
357
358
359

        :param container_info_cache: (dict) if given, avoid redundant calls to
        server for container info (block size and hash information)
360
        """
361
        self._assert_container()
362

363
        #init
364
365
366
        block_info = (
            blocksize, blockhash, size, nblocks) = self._get_file_block_info(
                f, size, container_info_cache)
367
        (hashes, hmap, offset) = ([], {}, 0)
368
        if not content_type:
369
            content_type = 'application/octet-stream'
370

371
        self._calculate_blocks_for_upload(
372
            *block_info,
373
374
375
            hashes=hashes,
            hmap=hmap,
            fileobj=f,
376
377
378
            hash_cb=hash_cb)

        hashmap = dict(bytes=size, hashes=hashes)
379
        missing, obj_headers = self._create_or_get_missing_hashes(
380
            obj, hashmap,
381
382
            content_type=content_type,
            size=size,
383
384
            if_etag_match=if_etag_match,
            if_etag_not_match='*' if if_not_exist else None,
385
386
387
388
            content_encoding=content_encoding,
            content_disposition=content_disposition,
            permissions=sharing,
            public=public)
389
390

        if missing is None:
391
            return obj_headers
392

393
394
        if upload_cb:
            upload_gen = upload_cb(len(missing))
395
396
397
398
399
            for i in range(len(missing), len(hashmap['hashes']) + 1):
                try:
                    upload_gen.next()
                except:
                    upload_gen = None
400
401
402
        else:
            upload_gen = None

403
        retries = 7
404
        try:
405
            while retries:
406
                sendlog.info('%s blocks missing' % len(missing))
407
408
409
410
411
                num_of_blocks = len(missing)
                missing = self._upload_missing_blocks(
                    missing,
                    hmap,
                    f,
412
                    upload_gen)
413
414
415
416
417
                if missing:
                    if num_of_blocks == len(missing):
                        retries -= 1
                    else:
                        num_of_blocks = len(missing)
418
419
420
421
422
423
                else:
                    break
            if missing:
                raise ClientError(
                    '%s blocks failed to upload' % len(missing),
                    status=800)
424
        except KeyboardInterrupt:
425
            sendlog.info('- - - wait for threads to finish')
426
427
428
429
            for thread in activethreads():
                thread.join()
            raise

430
        r = self.object_put(
431
            obj,
432
433
434
            format='json',
            hashmap=True,
            content_type=content_type,
435
            if_etag_match=if_etag_match,
436
437
            if_etag_not_match='*' if if_not_exist else None,
            etag=etag,
438
            json=hashmap,
439
440
            permissions=sharing,
            public=public,
441
            success=201)
442
        return r.headers
443

444
    # download_* auxiliary methods
Stavros Sachtouris's avatar
Stavros Sachtouris committed
445
    def _get_remote_blocks_info(self, obj, **restargs):
446
        #retrieve object hashmap
447
        myrange = restargs.pop('data_range', None)
448
        hashmap = self.get_object_hashmap(obj, **restargs)
449
        restargs['data_range'] = myrange
450
451
452
        blocksize = int(hashmap['block_size'])
        blockhash = hashmap['block_hash']
        total_size = hashmap['bytes']
Stavros Sachtouris's avatar
Stavros Sachtouris committed
453
        #assert total_size/blocksize + 1 == len(hashmap['hashes'])
454
        map_dict = {}
Stavros Sachtouris's avatar
Stavros Sachtouris committed
455
        for i, h in enumerate(hashmap['hashes']):
456
457
458
459
460
            #  map_dict[h] = i   CHAGE
            if h in map_dict:
                map_dict[h].append(i)
            else:
                map_dict[h] = [i]
Stavros Sachtouris's avatar
Stavros Sachtouris committed
461
        return (blocksize, blockhash, total_size, hashmap['hashes'], map_dict)
462

463
464
465
    def _dump_blocks_sync(
            self, obj, remote_hashes, blocksize, total_size, dst, range,
            **args):
Stavros Sachtouris's avatar
Stavros Sachtouris committed
466
        for blockid, blockhash in enumerate(remote_hashes):
467
468
469
470
471
472
473
474
475
476
            if blockhash:
                start = blocksize * blockid
                is_last = start + blocksize > total_size
                end = (total_size - 1) if is_last else (start + blocksize - 1)
                (start, end) = _range_up(start, end, range)
                args['data_range'] = 'bytes=%s-%s' % (start, end)
                r = self.object_get(obj, success=(200, 206), **args)
                self._cb_next()
                dst.write(r.content)
                dst.flush()
Stavros Sachtouris's avatar
Stavros Sachtouris committed
477

478
479
    def _get_block_async(self, obj, **args):
        event = SilentEvent(self.object_get, obj, success=(200, 206), **args)
480
481
        event.start()
        return event
482

483
484
485
486
487
488
489
    def _hash_from_file(self, fp, start, size, blockhash):
        fp.seek(start)
        block = fp.read(size)
        h = newhashlib(blockhash)
        h.update(block.strip('\x00'))
        return hexlify(h.digest())

490
    def _thread2file(self, flying, blockids, local_file, offset=0, **restargs):
491
        """write the results of a greenleted rest call to a file
492
493
494
495
496

        :param offset: the offset of the file up to blocksize
        - e.g. if the range is 10-100, all blocks will be written to
        normal_position - 10
        """
497
498
499
500
501
502
503
504
        for i, (key, g) in enumerate(flying.items()):
            if g.isAlive():
                continue
            if g.exception:
                raise g.exception
            block = g.value.content
            for block_start in blockids[key]:
                local_file.seek(block_start + offset)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
505
506
                local_file.write(block)
                self._cb_next()
507
508
            flying.pop(key)
            blockids.pop(key)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
509
510
        local_file.flush()

511
512
513
    def _dump_blocks_async(
            self, obj, remote_hashes, blocksize, total_size, local_file,
            blockhash=None, resume=False, filerange=None, **restargs):
514
        file_size = fstat(local_file.fileno()).st_size if resume else 0
515
516
        flying = dict()
        blockid_dict = dict()
517
518
519
        offset = 0
        if filerange is not None:
            rstart = int(filerange.split('-')[0])
520
            offset = rstart if blocksize > rstart else rstart % blocksize
521

522
        self._init_thread_limit()
523
        for block_hash, blockids in remote_hashes.items():
524
525
526
527
528
529
530
            blockids = [blk * blocksize for blk in blockids]
            unsaved = [blk for blk in blockids if not (
                blk < file_size and block_hash == self._hash_from_file(
                        local_file, blk, blocksize, blockhash))]
            self._cb_next(len(blockids) - len(unsaved))
            if unsaved:
                key = unsaved[0]
531
                self._watch_thread_limit(flying.values())
532
533
                self._thread2file(
                    flying, blockid_dict, local_file, offset,
534
                    **restargs)
535
536
537
                end = total_size - 1 if key + blocksize > total_size\
                    else key + blocksize - 1
                start, end = _range_up(key, end, filerange)
538
539
540
541
542
                if start == end:
                    self._cb_next()
                    continue
                restargs['async_headers'] = {
                    'Range': 'bytes=%s-%s' % (start, end)}
543
544
                flying[key] = self._get_block_async(obj, **restargs)
                blockid_dict[key] = unsaved
Stavros Sachtouris's avatar
Stavros Sachtouris committed
545

546
547
        for thread in flying.values():
            thread.join()
548
        self._thread2file(flying, blockid_dict, local_file, offset, **restargs)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
549

550
551
552
553
554
555
556
557
558
559
    def download_object(
            self, obj, dst,
            download_cb=None,
            version=None,
            resume=False,
            range_str=None,
            if_match=None,
            if_none_match=None,
            if_modified_since=None,
            if_unmodified_since=None):
560
        """Download an object (multiple connections, random blocks)
561
562
563
564
565
566
567
568
569
570
571

        :param obj: (str) remote object path

        :param dst: open file descriptor (wb+)

        :param download_cb: optional progress.bar object for downloading

        :param version: (str) file version

        :param resume: (bool) if set, preserve already downloaded file parts

572
        :param range_str: (str) from, to are file positions (int) in bytes
573
574
575
576
577
578
579

        :param if_match: (str)

        :param if_none_match: (str)

        :param if_modified_since: (str) formated date

580
        :param if_unmodified_since: (str) formated date"""
581
582
583
        restargs = dict(
            version=version,
            data_range=None if range_str is None else 'bytes=%s' % range_str,
Stavros Sachtouris's avatar
Stavros Sachtouris committed
584
585
586
587
588
            if_match=if_match,
            if_none_match=if_none_match,
            if_modified_since=if_modified_since,
            if_unmodified_since=if_unmodified_since)

589
590
        (
            blocksize,
Stavros Sachtouris's avatar
Stavros Sachtouris committed
591
592
            blockhash,
            total_size,
593
            hash_list,
Stavros Sachtouris's avatar
Stavros Sachtouris committed
594
595
596
597
            remote_hashes) = self._get_remote_blocks_info(obj, **restargs)
        assert total_size >= 0

        if download_cb:
598
            self.progress_bar_gen = download_cb(len(hash_list))
Stavros Sachtouris's avatar
Stavros Sachtouris committed
599
600
601
            self._cb_next()

        if dst.isatty():
602
603
            self._dump_blocks_sync(
                obj,
604
605
606
607
                hash_list,
                blocksize,
                total_size,
                dst,
608
                range_str,
609
                **restargs)
610
        else:
611
612
            self._dump_blocks_async(
                obj,
613
614
615
616
617
618
                remote_hashes,
                blocksize,
                total_size,
                dst,
                blockhash,
                resume,
619
                range_str,
620
                **restargs)
621
            if not range_str:
622
                dst.truncate(total_size)
623

Stavros Sachtouris's avatar
Stavros Sachtouris committed
624
625
        self._complete_cb()

626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
    def download_to_string(
            self, obj,
            download_cb=None,
            version=None,
            range_str=None,
            if_match=None,
            if_none_match=None,
            if_modified_since=None,
            if_unmodified_since=None):
        """Download an object to a string (multiple connections)

        :param obj: (str) remote object path

        :param download_cb: optional progress.bar object for downloading

        :param version: (str) file version

        :param range_str: (str) from, to are file positions (int) in bytes

        :param if_match: (str)

        :param if_none_match: (str)

        :param if_modified_since: (str) formated date

        :param if_unmodified_since: (str) formated date

        :returns: (str) the whole object contents
        """
        restargs = dict(
            version=version,
            data_range=None if range_str is None else 'bytes=%s' % range_str,
            if_match=if_match,
            if_none_match=if_none_match,
            if_modified_since=if_modified_since,
            if_unmodified_since=if_unmodified_since)

        (
            blocksize,
            blockhash,
            total_size,
            hash_list,
            remote_hashes) = self._get_remote_blocks_info(obj, **restargs)
        assert total_size >= 0

        if download_cb:
            self.progress_bar_gen = download_cb(len(hash_list))
            self._cb_next()

        ret = ''
        for blockid, blockhash in enumerate(remote_hashes):
            start = blocksize * blockid
            is_last = start + blocksize > total_size
            end = (total_size - 1) if is_last else (start + blocksize - 1)
            (start, end) = _range_up(start, end, range_str)
            if start == end:
                continue
            restargs['data_range'] = 'bytes=%s-%s' % (start, end)
            r = self.object_get(obj, success=(200, 206), **restargs)
            ret += r.content
            self._cb_next()

        self._complete_cb()
        return ret

Stavros Sachtouris's avatar
Stavros Sachtouris committed
691
    #Command Progress Bar method
692
    def _cb_next(self, step=1):
Stavros Sachtouris's avatar
Stavros Sachtouris committed
693
694
        if hasattr(self, 'progress_bar_gen'):
            try:
695
696
                for i in xrange(step):
                    self.progress_bar_gen.next()
Stavros Sachtouris's avatar
Stavros Sachtouris committed
697
698
            except:
                pass
699

Stavros Sachtouris's avatar
Stavros Sachtouris committed
700
701
702
    def _complete_cb(self):
        while True:
            try:
703
                self.progress_bar_gen.next()
Stavros Sachtouris's avatar
Stavros Sachtouris committed
704
705
            except:
                break
Stavros Sachtouris's avatar
Stavros Sachtouris committed
706

707
708
709
710
711
712
713
714
    def get_object_hashmap(
            self, obj,
            version=None,
            if_match=None,
            if_none_match=None,
            if_modified_since=None,
            if_unmodified_since=None,
            data_range=None):
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
        """
        :param obj: (str) remote object path

        :param if_match: (str)

        :param if_none_match: (str)

        :param if_modified_since: (str) formated date

        :param if_unmodified_since: (str) formated date

        :param data_range: (str) from-to where from and to are integers
            denoting file positions in bytes

        :returns: (list)
        """
731
        try:
732
733
            r = self.object_get(
                obj,
734
735
736
737
738
739
740
                hashmap=True,
                version=version,
                if_etag_match=if_match,
                if_etag_not_match=if_none_match,
                if_modified_since=if_modified_since,
                if_unmodified_since=if_unmodified_since,
                data_range=data_range)
741
742
743
744
        except ClientError as err:
            if err.status == 304 or err.status == 412:
                return {}
            raise
745
        return r.json
746

747
    def set_account_group(self, group, usernames):
748
749
750
751
752
        """
        :param group: (str)

        :param usernames: (list)
        """
753
        self.account_post(update=True, groups={group: usernames})
Stavros Sachtouris's avatar
Stavros Sachtouris committed
754

755
    def del_account_group(self, group):
756
757
758
        """
        :param group: (str)
        """
759
        self.account_post(update=True, groups={group: []})
760

Stavros Sachtouris's avatar
Stavros Sachtouris committed
761
    def get_account_info(self, until=None):
762
763
764
765
766
        """
        :param until: (str) formated date

        :returns: (dict)
        """
Stavros Sachtouris's avatar
Stavros Sachtouris committed
767
        r = self.account_head(until=until)
768
        if r.status_code == 401:
769
            raise ClientError("No authorization", status=401)
770
        return r.headers
771

Stavros Sachtouris's avatar
Stavros Sachtouris committed
772
    def get_account_quota(self):
773
774
775
        """
        :returns: (dict)
        """
776
777
        return filter_in(
            self.get_account_info(),
778
779
            'X-Account-Policy-Quota',
            exactMatch=True)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
780
781

    def get_account_versioning(self):
782
783
784
        """
        :returns: (dict)
        """
785
786
        return filter_in(
            self.get_account_info(),
787
788
            'X-Account-Policy-Versioning',
            exactMatch=True)
789

Stavros Sachtouris's avatar
Stavros Sachtouris committed
790
    def get_account_meta(self, until=None):
791
792
793
794
795
        """
        :meta until: (str) formated date

        :returns: (dict)
        """
796
        return filter_in(self.get_account_info(until=until), 'X-Account-Meta-')
797

798
    def get_account_group(self):
799
800
801
        """
        :returns: (dict)
        """
802
803
        return filter_in(self.get_account_info(), 'X-Account-Group-')

804
    def set_account_meta(self, metapairs):
805
806
807
        """
        :param metapairs: (dict) {key1:val1, key2:val2, ...}
        """
808
        assert(type(metapairs) is dict)
809
        self.account_post(update=True, metadata=metapairs)
810

811
    def del_account_meta(self, metakey):
812
813
814
        """
        :param metakey: (str) metadatum key
        """
815
        self.account_post(update=True, metadata={metakey: ''})
816

817
    """
Stavros Sachtouris's avatar
Stavros Sachtouris committed
818
    def set_account_quota(self, quota):
819
        ""
820
        :param quota: (int)
821
        ""
822
        self.account_post(update=True, quota=quota)
823
    """
Stavros Sachtouris's avatar
Stavros Sachtouris committed
824
825

    def set_account_versioning(self, versioning):
826
827
828
        """
        "param versioning: (str)
        """
829
        self.account_post(update=True, versioning=versioning)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
830

831
    def list_containers(self):
832
833
834
        """
        :returns: (dict)
        """
835
        r = self.account_get()
836
        return r.json
837

838
    def del_container(self, until=None, delimiter=None):
839
840
841
        """
        :param until: (str) formated date

842
        :param delimiter: (str) with / empty container
843
844
845
846
847

        :raises ClientError: 404 Container does not exist

        :raises ClientError: 409 Container is not empty
        """
848
        self._assert_container()
849
850
        r = self.container_delete(
            until=until,
851
852
            delimiter=delimiter,
            success=(204, 404, 409))
853
        if r.status_code == 404:
854
855
            raise ClientError(
                'Container "%s" does not exist' % self.container,
856
                r.status_code)
857
        elif r.status_code == 409:
858
859
            raise ClientError(
                'Container "%s" is not empty' % self.container,
860
                r.status_code)
861

862
    def get_container_versioning(self, container=None):
863
864
865
866
867
        """
        :param container: (str)

        :returns: (dict)
        """
868
869
870
871
872
873
874
875
        cnt_back_up = self.container
        try:
            self.container = container or cnt_back_up
            return filter_in(
                self.get_container_info(),
                'X-Container-Policy-Versioning')
        finally:
            self.container = cnt_back_up
Stavros Sachtouris's avatar
Stavros Sachtouris committed
876

877
    def get_container_limit(self, container=None):
878
879
880
881
882
        """
        :param container: (str)

        :returns: (dict)
        """
883
884
885
886
887
888
889
890
        cnt_back_up = self.container
        try:
            self.container = container or cnt_back_up
            return filter_in(
                self.get_container_info(),
                'X-Container-Policy-Quota')
        finally:
            self.container = cnt_back_up
891

892
    def get_container_info(self, until=None):
893
894
895
896
        """
        :param until: (str) formated date

        :returns: (dict)
897
898

        :raises ClientError: 404 Container not found
899
        """
900
901
902
903
904
        try:
            r = self.container_head(until=until)
        except ClientError as err:
            err.details.append('for container %s' % self.container)
            raise err
Stavros Sachtouris's avatar
Stavros Sachtouris committed
905
906
        return r.headers

907
    def get_container_meta(self, until=None):
908
909
910
911
912
        """
        :param until: (str) formated date

        :returns: (dict)
        """
913
914
        return filter_in(
            self.get_container_info(until=until),
915
            'X-Container-Meta')
916

917
    def get_container_object_meta(self, until=None):
918
919
920
921
922
        """
        :param until: (str) formated date

        :returns: (dict)
        """
923
924
        return filter_in(
            self.get_container_info(until=until),
925
            'X-Container-Object-Meta')
926

927
    def set_container_meta(self, metapairs):
928
929
930
        """
        :param metapairs: (dict) {key1:val1, key2:val2, ...}
        """
931
        assert(type(metapairs) is dict)
932
        self.container_post(update=True, metadata=metapairs)
933

Stavros Sachtouris's avatar
Stavros Sachtouris committed
934
    def del_container_meta(self, metakey):
935
936
937
        """
        :param metakey: (str) metadatum key
        """
938
        self.container_post(update=True, metadata={metakey: ''})
939

940
    def set_container_limit(self, limit):
941
        """
942
        :param limit: (int)
943
        """
944
        self.container_post(update=True, quota=limit)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
945
946

    def set_container_versioning(self, versioning):
947
948
949
        """
        :param versioning: (str)
        """
950
        self.container_post(update=True, versioning=versioning)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
951

952
    def del_object(self, obj, until=None, delimiter=None):
953
954
955
956
957
958
959
        """
        :param obj: (str) remote object path

        :param until: (str) formated date

        :param delimiter: (str)
        """
960
        self._assert_container()
961
        self.object_delete(obj, until=until, delimiter=delimiter)
962

963
964
965
966
967
968
    def set_object_meta(self, obj, metapairs):
        """
        :param obj: (str) remote object path

        :param metapairs: (dict) {key1:val1, key2:val2, ...}
        """
969
        assert(type(metapairs) is dict)
970
        self.object_post(obj, update=True, metadata=metapairs)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
971

972
    def del_object_meta(self, obj, metakey):
973
974
        """
        :param obj: (str) remote object path
975
976

        :param metakey: (str) metadatum key
977
        """
978
        self.object_post(obj, update=True, metadata={metakey: ''})
979

980
981
982
    def publish_object(self, obj):
        """
        :param obj: (str) remote object path
983
984

        :returns: (str) access url
985
        """
986
        self.object_post(obj, update=True, public=True)
987
        info = self.get_object_info(obj)
988
989
        pref, sep, rest = self.base_url.partition('//')
        base = rest.split('/')[0]
990
        return '%s%s%s/%s' % (pref, sep, base, info['x-object-public'])
Stavros Sachtouris's avatar
Stavros Sachtouris committed
991

992
993
994
995
    def unpublish_object(self, obj):
        """
        :param obj: (str) remote object path
        """
996
        self.object_post(obj, update=True, public=False)
997

Stavros Sachtouris's avatar
Stavros Sachtouris committed
998
    def get_object_info(self, obj, version=None):
999
1000
1001
1002
1003
1004
1005
        """
        :param obj: (str) remote object path

        :param version: (str)

        :returns: (dict)
        """
1006
1007
1008
1009
1010
        try:
            r = self.object_head(obj, version=version)
            return r.headers
        except ClientError as ce:
            if ce.status == 404:
1011
                raise ClientError('Object %s not found' % obj, status=404)
1012
            raise
Stavros Sachtouris's avatar
Stavros Sachtouris committed
1013
1014

    def get_object_meta(self, obj, version=None):
1015
1016
1017
1018
1019
1020
1021
        """
        :param obj: (str) remote object path

        :param version: (str)

        :returns: (dict)
        """
1022
1023
        return filter_in(
            self.get_object_info(obj, version=version),
1024
            'X-Object-Meta')
Stavros Sachtouris's avatar
Stavros Sachtouris committed
1025

1026
1027
1028
1029
1030
1031
    def get_object_sharing(self, obj):
        """
        :param obj: (str) remote object path

        :returns: (dict)
        """
1032
1033
        r = filter_in(
            self.get_object_info(obj),
1034
1035
            'X-Object-Sharing',
            exactMatch=True)
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
        reply = {}
        if len(r) > 0:
            perms = r['x-object-sharing'].split(';')
            for perm in perms:
                try:
                    perm.index('=')
                except ValueError:
                    raise ClientError('Incorrect reply format')
                (key, val) = perm.strip().split('=')
                reply[key] = val
        return reply