__init__.py 35.2 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
Giorgos Verigakis's avatar
Giorgos Verigakis committed
39

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

42
from kamaki.clients import SilentEvent, sendlog
43
from kamaki.clients.pithos.rest_api import PithosRestClient
44
45
from kamaki.clients.storage import ClientError
from kamaki.clients.utils import path4url, filter_in
46
from StringIO import StringIO
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):
Giorgos Verigakis's avatar
Giorgos Verigakis committed
69
    """GRNet 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
115
        """
        :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)
        """
116
        self._assert_container()
117
118
119
120
121
122
123

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

142
143
144
145
146
147
148
149
    def create_object_by_manifestation(
            self, obj,
            etag=None,
            content_encoding=None,
            content_disposition=None,
            content_type=None,
            sharing=None,
            public=None):
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
        """
        :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)
        """
166
        self._assert_container()
167
        self.object_put(
168
            obj,
169
170
171
172
173
174
175
176
177
            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))

178
    # upload_* auxiliary methods
179
    def _put_block_async(self, data, hash, upload_gen=None):
180
181
182
183
184
        event = SilentEvent(method=self._put_block, data=data, hash=hash)
        event.start()
        return event

    def _put_block(self, data, hash):
185
186
        r = self.container_post(
            update=True,
187
188
189
190
191
192
            content_type='application/octet-stream',
            content_length=len(data),
            data=data,
            format='json')
        assert r.json[0] == hash, 'Local hash does not match server'

193
    def _get_file_block_info(self, fileobj, size=None):
194
        meta = self.get_container_info()
195
196
        blocksize = int(meta['x-container-block-size'])
        blockhash = meta['x-container-block-hash']
197
        size = size if size is not None else fstat(fileobj.fileno()).st_size
198
        nblocks = 1 + (size - 1) // blocksize
199
200
        return (blocksize, blockhash, size, nblocks)

201
202
203
204
205
206
207
208
209
210
211
212
213
214
    def _get_missing_hashes(
            self, obj, json,
            size=None,
            format='json',
            hashmap=True,
            content_type=None,
            etag=None,
            content_encoding=None,
            content_disposition=None,
            permissions=None,
            public=None,
            success=(201, 409)):
        r = self.object_put(
            obj,
215
216
217
218
219
220
221
222
223
            format='json',
            hashmap=True,
            content_type=content_type,
            json=json,
            etag=etag,
            content_encoding=content_encoding,
            content_disposition=content_disposition,
            permissions=permissions,
            public=public,
224
            success=success)
225
        return None if r.status_code == 201 else r.json
226

227
    def _culculate_blocks_for_upload(
228
229
            self, blocksize, blockhash, size, nblocks, hashes, hmap, fileobj,
            hash_cb=None):
230
        offset = 0
231
232
233
234
235
        if hash_cb:
            hash_gen = hash_cb(nblocks)
            hash_gen.next()

        for i in range(nblocks):
236
            block = fileobj.read(min(blocksize, size - offset))
237
            bytes = len(block)
238
            hash = _pithos_hash(block, blockhash)
239
            hashes.append(hash)
240
            hmap[hash] = (offset, bytes)
241
242
243
            offset += bytes
            if hash_cb:
                hash_gen.next()
Stavros Sachtouris's avatar
Stavros Sachtouris committed
244
        msg = 'Failed to calculate uploaded blocks:'
245
        ' Offset and object size do not match'
Stavros Sachtouris's avatar
Stavros Sachtouris committed
246
        assert offset == size, msg
247

248
249
    def _upload_missing_blocks(self, missing, hmap, fileobj, upload_gen=None):
        """upload missing blocks asynchronously"""
250

251
        self._init_thread_limit()
252

253
        flying = []
254
        failures = []
255
        for hash in missing:
256
            offset, bytes = hmap[hash]
257
258
            fileobj.seek(offset)
            data = fileobj.read(bytes)
259
            r = self._put_block_async(data, hash, upload_gen)
260
            flying.append(r)
261
262
            unfinished = self._watch_thread_limit(flying)
            for thread in set(flying).difference(unfinished):
263
264
                if thread.exception:
                    failures.append(thread)
265
                    if isinstance(
266
267
268
                            thread.exception,
                            ClientError) and thread.exception.status == 502:
                        self.POOLSIZE = self._thread_limit
269
                elif thread.isAlive():
270
                    flying.append(thread)
271
272
273
274
275
                elif upload_gen:
                    try:
                        upload_gen.next()
                    except:
                        pass
276
277
278
279
            flying = unfinished

        for thread in flying:
            thread.join()
280
281
            if thread.exception:
                failures.append(thread)
282
283
284
285
286
            elif upload_gen:
                try:
                    upload_gen.next()
                except:
                    pass
287

288
        return [failure.kwargs['hash'] for failure in failures]
289

290
291
292
293
294
295
296
297
298
299
300
    def upload_object(
            self, obj, f,
            size=None,
            hash_cb=None,
            upload_cb=None,
            etag=None,
            content_encoding=None,
            content_disposition=None,
            content_type=None,
            sharing=None,
            public=None):
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
        """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)

        :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)
        """
324
        self._assert_container()
325

326
        #init
327
328
        block_info = (blocksize, blockhash, size, nblocks) =\
            self._get_file_block_info(f, size)
329
        (hashes, hmap, offset) = ([], {}, 0)
330
        if not content_type:
331
            content_type = 'application/octet-stream'
332

333
        self._culculate_blocks_for_upload(
334
            *block_info,
335
336
337
            hashes=hashes,
            hmap=hmap,
            fileobj=f,
338
339
340
            hash_cb=hash_cb)

        hashmap = dict(bytes=size, hashes=hashes)
341
342
        missing = self._get_missing_hashes(
            obj, hashmap,
343
344
345
346
347
348
349
            content_type=content_type,
            size=size,
            etag=etag,
            content_encoding=content_encoding,
            content_disposition=content_disposition,
            permissions=sharing,
            public=public)
350
351
352

        if missing is None:
            return
353

354
355
        if upload_cb:
            upload_gen = upload_cb(len(missing))
356
357
358
359
360
            for i in range(len(missing), len(hashmap['hashes']) + 1):
                try:
                    upload_gen.next()
                except:
                    upload_gen = None
361
362
363
        else:
            upload_gen = None

364
        retries = 7
365
        try:
366
            while retries:
367
                sendlog.info('%s blocks missing' % len(missing))
368
369
370
371
372
                num_of_blocks = len(missing)
                missing = self._upload_missing_blocks(
                    missing,
                    hmap,
                    f,
373
                    upload_gen)
374
375
376
377
378
                if missing:
                    if num_of_blocks == len(missing):
                        retries -= 1
                    else:
                        num_of_blocks = len(missing)
379
380
381
382
383
384
                else:
                    break
            if missing:
                raise ClientError(
                    '%s blocks failed to upload' % len(missing),
                    status=800)
385
        except KeyboardInterrupt:
386
            sendlog.info('- - - wait for threads to finish')
387
388
389
390
            for thread in activethreads():
                thread.join()
            raise

391
        self.object_put(
392
            obj,
393
394
395
396
397
398
            format='json',
            hashmap=True,
            content_type=content_type,
            json=hashmap,
            success=201)

399
    # download_* auxiliary methods
Stavros Sachtouris's avatar
Stavros Sachtouris committed
400
    def _get_remote_blocks_info(self, obj, **restargs):
401
        #retrieve object hashmap
402
        myrange = restargs.pop('data_range', None)
403
        hashmap = self.get_object_hashmap(obj, **restargs)
404
        restargs['data_range'] = myrange
405
406
407
        blocksize = int(hashmap['block_size'])
        blockhash = hashmap['block_hash']
        total_size = hashmap['bytes']
Stavros Sachtouris's avatar
Stavros Sachtouris committed
408
        #assert total_size/blocksize + 1 == len(hashmap['hashes'])
409
        map_dict = {}
Stavros Sachtouris's avatar
Stavros Sachtouris committed
410
411
412
        for i, h in enumerate(hashmap['hashes']):
            map_dict[h] = i
        return (blocksize, blockhash, total_size, hashmap['hashes'], map_dict)
413

414
415
416
    def _dump_blocks_sync(
            self, obj, remote_hashes, blocksize, total_size, dst, range,
            **args):
Stavros Sachtouris's avatar
Stavros Sachtouris committed
417
        for blockid, blockhash in enumerate(remote_hashes):
418
419
420
421
422
423
424
425
426
427
            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
428

429
430
    def _get_block_async(self, obj, **args):
        event = SilentEvent(self.object_get, obj, success=(200, 206), **args)
431
432
        event.start()
        return event
433

434
435
436
437
438
439
440
    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())

441
    def _thread2file(self, flying, local_file, offset=0, **restargs):
442
        """write the results of a greenleted rest call to a file
443
444
445
446
447

        :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
        """
Stavros Sachtouris's avatar
Stavros Sachtouris committed
448
        finished = []
449
        for i, (start, g) in enumerate(flying.items()):
450
            if not g.isAlive():
Stavros Sachtouris's avatar
Stavros Sachtouris committed
451
452
                if g.exception:
                    raise g.exception
453
                block = g.value.content
454
                local_file.seek(start - offset)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
455
456
                local_file.write(block)
                self._cb_next()
457
                finished.append(flying.pop(start))
Stavros Sachtouris's avatar
Stavros Sachtouris committed
458
459
460
        local_file.flush()
        return finished

461
462
463
    def _dump_blocks_async(
            self, obj, remote_hashes, blocksize, total_size, local_file,
            blockhash=None, resume=False, filerange=None, **restargs):
464
        file_size = fstat(local_file.fileno()).st_size if resume else 0
465
466
        flying = {}
        finished = []
467
468
469
        offset = 0
        if filerange is not None:
            rstart = int(filerange.split('-')[0])
470
            offset = rstart if blocksize > rstart else rstart % blocksize
471

472
        self._init_thread_limit()
Stavros Sachtouris's avatar
Stavros Sachtouris committed
473
        for block_hash, blockid in remote_hashes.items():
474
            start = blocksize * blockid
475
476
            if start < file_size and block_hash == self._hash_from_file(
                    local_file, start, blocksize, blockhash):
477
478
                self._cb_next()
                continue
479
            self._watch_thread_limit(flying.values())
480
481
482
483
484
            finished += self._thread2file(
                flying,
                local_file,
                offset,
                **restargs)
485
486
            end = total_size - 1 if start + blocksize > total_size\
                else start + blocksize - 1
487
488
489
490
            (start, end) = _range_up(start, end, filerange)
            if start == end:
                self._cb_next()
                continue
491
            restargs['async_headers'] = {'Range': 'bytes=%s-%s' % (start, end)}
492
            flying[start] = self._get_block_async(obj, **restargs)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
493

494
495
496
        for thread in flying.values():
            thread.join()
        finished += self._thread2file(flying, local_file, offset, **restargs)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
497

498
499
500
501
502
503
504
505
506
507
    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):
508
        """Download an object (multiple connections, random blocks)
509
510
511
512
513
514
515
516
517
518
519

        :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

520
        :param range_str: (str) from, to are file positions (int) in bytes
521
522
523
524
525
526
527

        :param if_match: (str)

        :param if_none_match: (str)

        :param if_modified_since: (str) formated date

528
        :param if_unmodified_since: (str) formated date"""
529
530
531
        restargs = dict(
            version=version,
            data_range=None if range_str is None else 'bytes=%s' % range_str,
Stavros Sachtouris's avatar
Stavros Sachtouris committed
532
533
534
535
536
            if_match=if_match,
            if_none_match=if_none_match,
            if_modified_since=if_modified_since,
            if_unmodified_since=if_unmodified_since)

537
538
        (
            blocksize,
Stavros Sachtouris's avatar
Stavros Sachtouris committed
539
540
            blockhash,
            total_size,
541
            hash_list,
Stavros Sachtouris's avatar
Stavros Sachtouris committed
542
543
544
545
            remote_hashes) = self._get_remote_blocks_info(obj, **restargs)
        assert total_size >= 0

        if download_cb:
546
            self.progress_bar_gen = download_cb(len(remote_hashes))
Stavros Sachtouris's avatar
Stavros Sachtouris committed
547
548
549
            self._cb_next()

        if dst.isatty():
550
551
            self._dump_blocks_sync(
                obj,
552
553
554
555
                hash_list,
                blocksize,
                total_size,
                dst,
556
                range_str,
557
                **restargs)
558
        else:
559
560
            self._dump_blocks_async(
                obj,
561
562
563
564
565
566
                remote_hashes,
                blocksize,
                total_size,
                dst,
                blockhash,
                resume,
567
                range_str,
568
                **restargs)
569
            if not range_str:
570
                dst.truncate(total_size)
571

Stavros Sachtouris's avatar
Stavros Sachtouris committed
572
573
574
575
576
577
578
579
580
        self._complete_cb()

    #Command Progress Bar method
    def _cb_next(self):
        if hasattr(self, 'progress_bar_gen'):
            try:
                self.progress_bar_gen.next()
            except:
                pass
581

Stavros Sachtouris's avatar
Stavros Sachtouris committed
582
583
584
585
586
587
    def _complete_cb(self):
        while True:
            try:
                self.progress_bar_gen.next()
            except:
                break
Stavros Sachtouris's avatar
Stavros Sachtouris committed
588

589
590
591
592
593
594
595
596
    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):
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
        """
        :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)
        """
613
        try:
614
615
            r = self.object_get(
                obj,
616
617
618
619
620
621
622
                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)
623
624
625
626
        except ClientError as err:
            if err.status == 304 or err.status == 412:
                return {}
            raise
627
        return r.json
628

629
    def set_account_group(self, group, usernames):
630
631
632
633
634
        """
        :param group: (str)

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

637
    def del_account_group(self, group):
638
639
640
        """
        :param group: (str)
        """
641
        self.account_post(update=True, groups={group: []})
642

Stavros Sachtouris's avatar
Stavros Sachtouris committed
643
    def get_account_info(self, until=None):
644
645
646
647
648
        """
        :param until: (str) formated date

        :returns: (dict)
        """
Stavros Sachtouris's avatar
Stavros Sachtouris committed
649
        r = self.account_head(until=until)
650
        if r.status_code == 401:
651
            raise ClientError("No authorization", status=401)
652
        return r.headers
653

Stavros Sachtouris's avatar
Stavros Sachtouris committed
654
    def get_account_quota(self):
655
656
657
        """
        :returns: (dict)
        """
658
659
        return filter_in(
            self.get_account_info(),
660
661
            'X-Account-Policy-Quota',
            exactMatch=True)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
662
663

    def get_account_versioning(self):
664
665
666
        """
        :returns: (dict)
        """
667
668
        return filter_in(
            self.get_account_info(),
669
670
            'X-Account-Policy-Versioning',
            exactMatch=True)
671

Stavros Sachtouris's avatar
Stavros Sachtouris committed
672
    def get_account_meta(self, until=None):
673
674
675
676
677
        """
        :meta until: (str) formated date

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

680
    def get_account_group(self):
681
682
683
        """
        :returns: (dict)
        """
684
685
        return filter_in(self.get_account_info(), 'X-Account-Group-')

686
    def set_account_meta(self, metapairs):
687
688
689
        """
        :param metapairs: (dict) {key1:val1, key2:val2, ...}
        """
690
        assert(type(metapairs) is dict)
691
        self.account_post(update=True, metadata=metapairs)
692

693
    def del_account_meta(self, metakey):
694
695
696
        """
        :param metakey: (str) metadatum key
        """
697
        self.account_post(update=True, metadata={metakey: ''})
698

Stavros Sachtouris's avatar
Stavros Sachtouris committed
699
    def set_account_quota(self, quota):
700
701
702
        """
        :param quota: (int)
        """
703
        self.account_post(update=True, quota=quota)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
704
705

    def set_account_versioning(self, versioning):
706
707
708
        """
        "param versioning: (str)
        """
709
        self.account_post(update=True, versioning=versioning)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
710

711
    def list_containers(self):
712
713
714
        """
        :returns: (dict)
        """
715
        r = self.account_get()
716
        return r.json
717

718
    def del_container(self, until=None, delimiter=None):
719
720
721
        """
        :param until: (str) formated date

722
        :param delimiter: (str) with / empty container
723
724
725
726
727

        :raises ClientError: 404 Container does not exist

        :raises ClientError: 409 Container is not empty
        """
728
        self._assert_container()
729
730
        r = self.container_delete(
            until=until,
731
732
            delimiter=delimiter,
            success=(204, 404, 409))
733
        if r.status_code == 404:
734
735
            raise ClientError(
                'Container "%s" does not exist' % self.container,
736
                r.status_code)
737
        elif r.status_code == 409:
738
739
            raise ClientError(
                'Container "%s" is not empty' % self.container,
740
                r.status_code)
741

742
    def get_container_versioning(self, container=None):
743
744
745
746
747
        """
        :param container: (str)

        :returns: (dict)
        """
748
749
750
751
752
753
754
755
        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
756

757
    def get_container_quota(self, container=None):
758
759
760
761
762
        """
        :param container: (str)

        :returns: (dict)
        """
763
764
765
766
767
768
769
770
        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
771

772
    def get_container_info(self, until=None):
773
774
775
776
        """
        :param until: (str) formated date

        :returns: (dict)
777
778

        :raises ClientError: 404 Container not found
779
        """
780
781
782
783
784
        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
785
786
        return r.headers

787
    def get_container_meta(self, until=None):
788
789
790
791
792
        """
        :param until: (str) formated date

        :returns: (dict)
        """
793
794
        return filter_in(
            self.get_container_info(until=until),
795
            'X-Container-Meta')
796

797
    def get_container_object_meta(self, until=None):
798
799
800
801
802
        """
        :param until: (str) formated date

        :returns: (dict)
        """
803
804
        return filter_in(
            self.get_container_info(until=until),
805
            'X-Container-Object-Meta')
806

807
    def set_container_meta(self, metapairs):
808
809
810
        """
        :param metapairs: (dict) {key1:val1, key2:val2, ...}
        """
811
        assert(type(metapairs) is dict)
812
        self.container_post(update=True, metadata=metapairs)
813

Stavros Sachtouris's avatar
Stavros Sachtouris committed
814
    def del_container_meta(self, metakey):
815
816
817
        """
        :param metakey: (str) metadatum key
        """
818
        self.container_post(update=True, metadata={metakey: ''})
819

Stavros Sachtouris's avatar
Stavros Sachtouris committed
820
    def set_container_quota(self, quota):
821
822
823
        """
        :param quota: (int)
        """
824
        self.container_post(update=True, quota=quota)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
825
826

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

832
    def del_object(self, obj, until=None, delimiter=None):
833
834
835
836
837
838
839
        """
        :param obj: (str) remote object path

        :param until: (str) formated date

        :param delimiter: (str)
        """
840
        self._assert_container()
841
        self.object_delete(obj, until=until, delimiter=delimiter)
842

843
844
845
846
847
848
    def set_object_meta(self, obj, metapairs):
        """
        :param obj: (str) remote object path

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

852
    def del_object_meta(self, obj, metakey):
853
854
        """
        :param obj: (str) remote object path
855
856

        :param metakey: (str) metadatum key
857
        """
858
        self.object_post(obj, update=True, metadata={metakey: ''})
859

860
861
862
    def publish_object(self, obj):
        """
        :param obj: (str) remote object path
863
864

        :returns: (str) access url
865
        """
866
        self.object_post(obj, update=True, public=True)
867
        info = self.get_object_info(obj)
868
869
        pref, sep, rest = self.base_url.partition('//')
        base = rest.split('/')[0]
870
        return '%s%s%s/%s' % (pref, sep, base, info['x-object-public'])
Stavros Sachtouris's avatar
Stavros Sachtouris committed
871

872
873
874
875
    def unpublish_object(self, obj):
        """
        :param obj: (str) remote object path
        """
876
        self.object_post(obj, update=True, public=False)
877

Stavros Sachtouris's avatar
Stavros Sachtouris committed
878
    def get_object_info(self, obj, version=None):
879
880
881
882
883
884
885
        """
        :param obj: (str) remote object path

        :param version: (str)

        :returns: (dict)
        """
886
887
888
889
890
        try:
            r = self.object_head(obj, version=version)
            return r.headers
        except ClientError as ce:
            if ce.status == 404:
891
                raise ClientError('Object %s not found' % obj, status=404)
892
            raise
Stavros Sachtouris's avatar
Stavros Sachtouris committed
893
894

    def get_object_meta(self, obj, version=None):
895
896
897
898
899
900
901
        """
        :param obj: (str) remote object path

        :param version: (str)

        :returns: (dict)
        """
902
903
        return filter_in(
            self.get_object_info(obj, version=version),
904
            'X-Object-Meta')
Stavros Sachtouris's avatar
Stavros Sachtouris committed
905

906
907
908
909
910
911
    def get_object_sharing(self, obj):
        """
        :param obj: (str) remote object path

        :returns: (dict)
        """
912
913
        r = filter_in(
            self.get_object_info(obj),
914
915
            'X-Object-Sharing',
            exactMatch=True)
916
917
918
919
920
921
922
923
924
925
926
        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
927

928
    def set_object_sharing(
929
930
            self, obj,
            read_permition=False, write_permition=False):
931
        """Give read/write permisions to an object.
932
933
934
935
936
937
938
939
940

        :param obj: (str) remote object path

        :param read_permition: (list - bool) users and user groups that get
            read permition for this object - False means all previous read
            permissions will be removed

        :param write_perimition: (list - bool) of users and user groups to get
           write permition for this object - False means all previous write
941
           permissions will be removed
942
        """
943

944
        perms = dict(read=read_permition or '', write=write_permition or '')
945
        self.object_post(obj, update=True, permissions=perms)
946

947
948
949
950
951
952
953
954
955
956
957
    def del_object_sharing(self, obj):
        """
        :param obj: (str) remote object path
        """
        self.set_object_sharing(obj)

    def append_object(self, obj, source_file, upload_cb=None):
        """
        :param obj: (str) remote object path

        :param source_file: open file descriptor
958

959
        :param upload_db: progress.bar for uploading
Stavros Sachtouris's avatar
Stavros Sachtouris committed
960
        """
961

962
        self._assert_container()
963
        meta = self.get_container_info()
Stavros Sachtouris's avatar
Stavros Sachtouris committed
964
        blocksize = int(meta['x-container-block-size'])
965
        filesize = fstat(source_file.fileno()).st_size
966
        nblocks = 1 + (filesize - 1) // blocksize
Stavros Sachtouris's avatar
Stavros Sachtouris committed
967
        offset = 0
968
        if upload_cb:
Stavros Sachtouris's avatar
Stavros Sachtouris committed
969
            upload_gen = upload_cb(nblocks)
970
            upload_gen.next()
Stavros Sachtouris's avatar
Stavros Sachtouris committed
971
972
973
        for i in range(nblocks):
            block = source_file.read(min(blocksize, filesize - offset))
            offset += len(block)
974
            self.object_post(
975
                obj,
976
977
978
979
980
981
                update=True,
                content_range='bytes */*',
                content_type='application/octet-stream',
                content_length=len(block),
                data=block)

982
            if upload_cb:
Stavros Sachtouris's avatar
Stavros Sachtouris committed
983
                upload_gen.next()
Stavros Sachtouris's avatar
Stavros Sachtouris committed
984

985
986
987
988
989
990
    def truncate_object(self, obj, upto_bytes):
        """
        :param obj: (str) remote object path

        :param upto_bytes: max number of bytes to leave on file
        """
991
        self.object_post(
992
            obj,
993
994
995
996
            update=True,
            content_range='bytes 0-%s/*' % upto_bytes,
            content_type='application/octet-stream',
            object_bytes=upto_bytes,
997
            source_object=path4url(self.container, obj))
Stavros Sachtouris's avatar
Stavros Sachtouris committed
998

999
    def overwrite_object(self, obj, start, end, source_file, upload_cb=None):
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
        """Overwrite a part of an object from local source file

        :param obj: (str) remote object path

        :param start: (int) position in bytes to start overwriting from

        :param end: (int) position in bytes to stop overwriting at

        :param source_file: open file descriptor

        :param upload_db: progress.bar for uploading
Stavros Sachtouris's avatar
Stavros Sachtouris committed
1011
        """
1012

1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
        r = self.get_object_info(obj)
        rf_size = int(r['content-length'])
        if rf_size < int(start):
            raise ClientError(
                'Range start exceeds file size',
                status=416)
        elif rf_size < int(end):
            raise ClientError(
                'Range end exceeds file size',
                status=416)
1023
        self._assert_container()
1024
        meta = self.get_container_info()
Stavros Sachtouris's avatar
Stavros Sachtouris committed
1025
        blocksize = int(meta['x-container-block-size'])
1026
        filesize = fstat(source_file.fileno()).st_size