__init__.py 36.5 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):
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
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
    def _create_or_get_missing_hashes(
202
203
204
205
206
            self, obj, json,
            size=None,
            format='json',
            hashmap=True,
            content_type=None,
207
208
            if_etag_match=None,
            if_etag_not_match=None,
209
210
211
212
213
214
215
            content_encoding=None,
            content_disposition=None,
            permissions=None,
            public=None,
            success=(201, 409)):
        r = self.object_put(
            obj,
216
217
218
219
            format='json',
            hashmap=True,
            content_type=content_type,
            json=json,
220
221
            if_etag_match=if_etag_match,
            if_etag_not_match=if_etag_not_match,
222
223
224
225
            content_encoding=content_encoding,
            content_disposition=content_disposition,
            permissions=permissions,
            public=public,
226
            success=success)
227
        return None if r.status_code == 201 else r.json
228

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

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

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

253
        self._init_thread_limit()
254

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

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

290
        return [failure.kwargs['hash'] for failure in failures]
291

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

317
318
319
        :param if_etag_match: (str) Push that value to if-match header at file
            creation

320
321
322
323
324
        :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.

325
326
327
328
329
330
331
332
333
334
335
        :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)
        """
336
        self._assert_container()
337

338
        #init
339
340
        block_info = (blocksize, blockhash, size, nblocks) =\
            self._get_file_block_info(f, size)
341
        (hashes, hmap, offset) = ([], {}, 0)
342
        if not content_type:
343
            content_type = 'application/octet-stream'
344

345
        self._calculate_blocks_for_upload(
346
            *block_info,
347
348
349
            hashes=hashes,
            hmap=hmap,
            fileobj=f,
350
351
352
            hash_cb=hash_cb)

        hashmap = dict(bytes=size, hashes=hashes)
353
        missing = self._create_or_get_missing_hashes(
354
            obj, hashmap,
355
356
            content_type=content_type,
            size=size,
357
358
            if_etag_match=if_etag_match,
            if_etag_not_match='*' if if_not_exist else None,
359
360
361
362
            content_encoding=content_encoding,
            content_disposition=content_disposition,
            permissions=sharing,
            public=public)
363
364
365

        if missing is None:
            return
366

367
368
        if upload_cb:
            upload_gen = upload_cb(len(missing))
369
370
371
372
373
            for i in range(len(missing), len(hashmap['hashes']) + 1):
                try:
                    upload_gen.next()
                except:
                    upload_gen = None
374
375
376
        else:
            upload_gen = None

377
        retries = 7
378
        try:
379
            while retries:
380
                sendlog.info('%s blocks missing' % len(missing))
381
382
383
384
385
                num_of_blocks = len(missing)
                missing = self._upload_missing_blocks(
                    missing,
                    hmap,
                    f,
386
                    upload_gen)
387
388
389
390
391
                if missing:
                    if num_of_blocks == len(missing):
                        retries -= 1
                    else:
                        num_of_blocks = len(missing)
392
393
394
395
396
397
                else:
                    break
            if missing:
                raise ClientError(
                    '%s blocks failed to upload' % len(missing),
                    status=800)
398
        except KeyboardInterrupt:
399
            sendlog.info('- - - wait for threads to finish')
400
401
402
403
            for thread in activethreads():
                thread.join()
            raise

404
        self.object_put(
405
            obj,
406
407
408
            format='json',
            hashmap=True,
            content_type=content_type,
409
            if_etag_match=if_etag_match,
410
411
            if_etag_not_match='*' if if_not_exist else None,
            etag=etag,
412
            json=hashmap,
413
414
            permissions=sharing,
            public=public,
415
416
            success=201)

417
    # download_* auxiliary methods
Stavros Sachtouris's avatar
Stavros Sachtouris committed
418
    def _get_remote_blocks_info(self, obj, **restargs):
419
        #retrieve object hashmap
420
        myrange = restargs.pop('data_range', None)
421
        hashmap = self.get_object_hashmap(obj, **restargs)
422
        restargs['data_range'] = myrange
423
424
425
        blocksize = int(hashmap['block_size'])
        blockhash = hashmap['block_hash']
        total_size = hashmap['bytes']
Stavros Sachtouris's avatar
Stavros Sachtouris committed
426
        #assert total_size/blocksize + 1 == len(hashmap['hashes'])
427
        map_dict = {}
Stavros Sachtouris's avatar
Stavros Sachtouris committed
428
        for i, h in enumerate(hashmap['hashes']):
429
430
431
432
433
            #  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
434
        return (blocksize, blockhash, total_size, hashmap['hashes'], map_dict)
435

436
437
438
    def _dump_blocks_sync(
            self, obj, remote_hashes, blocksize, total_size, dst, range,
            **args):
Stavros Sachtouris's avatar
Stavros Sachtouris committed
439
        for blockid, blockhash in enumerate(remote_hashes):
440
441
442
443
444
445
446
447
448
449
            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
450

451
452
    def _get_block_async(self, obj, **args):
        event = SilentEvent(self.object_get, obj, success=(200, 206), **args)
453
454
        event.start()
        return event
455

456
457
458
459
460
461
462
    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())

463
    def _thread2file(self, flying, blockids, local_file, offset=0, **restargs):
464
        """write the results of a greenleted rest call to a file
465
466
467
468
469

        :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
        """
470
471
472
473
474
475
476
477
        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
478
479
                local_file.write(block)
                self._cb_next()
480
481
            flying.pop(key)
            blockids.pop(key)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
482
483
        local_file.flush()

484
485
486
    def _dump_blocks_async(
            self, obj, remote_hashes, blocksize, total_size, local_file,
            blockhash=None, resume=False, filerange=None, **restargs):
487
        file_size = fstat(local_file.fileno()).st_size if resume else 0
488
489
        flying = dict()
        blockid_dict = dict()
490
491
492
        offset = 0
        if filerange is not None:
            rstart = int(filerange.split('-')[0])
493
            offset = rstart if blocksize > rstart else rstart % blocksize
494

495
        self._init_thread_limit()
496
        for block_hash, blockids in remote_hashes.items():
497
498
499
500
501
502
503
            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]
504
                self._watch_thread_limit(flying.values())
505
506
                self._thread2file(
                    flying, blockid_dict, local_file, offset,
507
                    **restargs)
508
509
510
                end = total_size - 1 if key + blocksize > total_size\
                    else key + blocksize - 1
                start, end = _range_up(key, end, filerange)
511
512
513
514
515
                if start == end:
                    self._cb_next()
                    continue
                restargs['async_headers'] = {
                    'Range': 'bytes=%s-%s' % (start, end)}
516
517
                flying[key] = self._get_block_async(obj, **restargs)
                blockid_dict[key] = unsaved
Stavros Sachtouris's avatar
Stavros Sachtouris committed
518

519
520
        for thread in flying.values():
            thread.join()
521
        self._thread2file(flying, blockid_dict, local_file, offset, **restargs)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
522

523
524
525
526
527
528
529
530
531
532
    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):
533
        """Download an object (multiple connections, random blocks)
534
535
536
537
538
539
540
541
542
543
544

        :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

545
        :param range_str: (str) from, to are file positions (int) in bytes
546
547
548
549
550
551
552

        :param if_match: (str)

        :param if_none_match: (str)

        :param if_modified_since: (str) formated date

553
        :param if_unmodified_since: (str) formated date"""
554
555
556
        restargs = dict(
            version=version,
            data_range=None if range_str is None else 'bytes=%s' % range_str,
Stavros Sachtouris's avatar
Stavros Sachtouris committed
557
558
559
560
561
            if_match=if_match,
            if_none_match=if_none_match,
            if_modified_since=if_modified_since,
            if_unmodified_since=if_unmodified_since)

562
563
        (
            blocksize,
Stavros Sachtouris's avatar
Stavros Sachtouris committed
564
565
            blockhash,
            total_size,
566
            hash_list,
Stavros Sachtouris's avatar
Stavros Sachtouris committed
567
568
569
570
            remote_hashes) = self._get_remote_blocks_info(obj, **restargs)
        assert total_size >= 0

        if download_cb:
571
            self.progress_bar_gen = download_cb(len(hash_list))
Stavros Sachtouris's avatar
Stavros Sachtouris committed
572
573
574
            self._cb_next()

        if dst.isatty():
575
576
            self._dump_blocks_sync(
                obj,
577
578
579
580
                hash_list,
                blocksize,
                total_size,
                dst,
581
                range_str,
582
                **restargs)
583
        else:
584
585
            self._dump_blocks_async(
                obj,
586
587
588
589
590
591
                remote_hashes,
                blocksize,
                total_size,
                dst,
                blockhash,
                resume,
592
                range_str,
593
                **restargs)
594
            if not range_str:
595
                dst.truncate(total_size)
596

Stavros Sachtouris's avatar
Stavros Sachtouris committed
597
598
599
        self._complete_cb()

    #Command Progress Bar method
600
    def _cb_next(self, step=1):
Stavros Sachtouris's avatar
Stavros Sachtouris committed
601
602
        if hasattr(self, 'progress_bar_gen'):
            try:
603
604
                for i in xrange(step):
                    self.progress_bar_gen.next()
Stavros Sachtouris's avatar
Stavros Sachtouris committed
605
606
            except:
                pass
607

Stavros Sachtouris's avatar
Stavros Sachtouris committed
608
609
610
    def _complete_cb(self):
        while True:
            try:
611
                self.progress_bar_gen.next()
Stavros Sachtouris's avatar
Stavros Sachtouris committed
612
613
            except:
                break
Stavros Sachtouris's avatar
Stavros Sachtouris committed
614

615
616
617
618
619
620
621
622
    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):
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
        """
        :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)
        """
639
        try:
640
641
            r = self.object_get(
                obj,
642
643
644
645
646
647
648
                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)
649
650
651
652
        except ClientError as err:
            if err.status == 304 or err.status == 412:
                return {}
            raise
653
        return r.json
654

655
    def set_account_group(self, group, usernames):
656
657
658
659
660
        """
        :param group: (str)

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

663
    def del_account_group(self, group):
664
665
666
        """
        :param group: (str)
        """
667
        self.account_post(update=True, groups={group: []})
668

Stavros Sachtouris's avatar
Stavros Sachtouris committed
669
    def get_account_info(self, until=None):
670
671
672
673
674
        """
        :param until: (str) formated date

        :returns: (dict)
        """
Stavros Sachtouris's avatar
Stavros Sachtouris committed
675
        r = self.account_head(until=until)
676
        if r.status_code == 401:
677
            raise ClientError("No authorization", status=401)
678
        return r.headers
679

Stavros Sachtouris's avatar
Stavros Sachtouris committed
680
    def get_account_quota(self):
681
682
683
        """
        :returns: (dict)
        """
684
685
        return filter_in(
            self.get_account_info(),
686
687
            'X-Account-Policy-Quota',
            exactMatch=True)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
688
689

    def get_account_versioning(self):
690
691
692
        """
        :returns: (dict)
        """
693
694
        return filter_in(
            self.get_account_info(),
695
696
            'X-Account-Policy-Versioning',
            exactMatch=True)
697

Stavros Sachtouris's avatar
Stavros Sachtouris committed
698
    def get_account_meta(self, until=None):
699
700
701
702
703
        """
        :meta until: (str) formated date

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

706
    def get_account_group(self):
707
708
709
        """
        :returns: (dict)
        """
710
711
        return filter_in(self.get_account_info(), 'X-Account-Group-')

712
    def set_account_meta(self, metapairs):
713
714
715
        """
        :param metapairs: (dict) {key1:val1, key2:val2, ...}
        """
716
        assert(type(metapairs) is dict)
717
        self.account_post(update=True, metadata=metapairs)
718

719
    def del_account_meta(self, metakey):
720
721
722
        """
        :param metakey: (str) metadatum key
        """
723
        self.account_post(update=True, metadata={metakey: ''})
724

725
    """
Stavros Sachtouris's avatar
Stavros Sachtouris committed
726
    def set_account_quota(self, quota):
727
        ""
728
        :param quota: (int)
729
        ""
730
        self.account_post(update=True, quota=quota)
731
    """
Stavros Sachtouris's avatar
Stavros Sachtouris committed
732
733

    def set_account_versioning(self, versioning):
734
735
736
        """
        "param versioning: (str)
        """
737
        self.account_post(update=True, versioning=versioning)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
738

739
    def list_containers(self):
740
741
742
        """
        :returns: (dict)
        """
743
        r = self.account_get()
744
        return r.json
745

746
    def del_container(self, until=None, delimiter=None):
747
748
749
        """
        :param until: (str) formated date

750
        :param delimiter: (str) with / empty container
751
752
753
754
755

        :raises ClientError: 404 Container does not exist

        :raises ClientError: 409 Container is not empty
        """
756
        self._assert_container()
757
758
        r = self.container_delete(
            until=until,
759
760
            delimiter=delimiter,
            success=(204, 404, 409))
761
        if r.status_code == 404:
762
763
            raise ClientError(
                'Container "%s" does not exist' % self.container,
764
                r.status_code)
765
        elif r.status_code == 409:
766
767
            raise ClientError(
                'Container "%s" is not empty' % self.container,
768
                r.status_code)
769

770
    def get_container_versioning(self, container=None):
771
772
773
774
775
        """
        :param container: (str)

        :returns: (dict)
        """
776
777
778
779
780
781
782
783
        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
784

785
    def get_container_limit(self, container=None):
786
787
788
789
790
        """
        :param container: (str)

        :returns: (dict)
        """
791
792
793
794
795
796
797
798
        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
799

800
    def get_container_info(self, until=None):
801
802
803
804
        """
        :param until: (str) formated date

        :returns: (dict)
805
806

        :raises ClientError: 404 Container not found
807
        """
808
809
810
811
812
        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
813
814
        return r.headers

815
    def get_container_meta(self, until=None):
816
817
818
819
820
        """
        :param until: (str) formated date

        :returns: (dict)
        """
821
822
        return filter_in(
            self.get_container_info(until=until),
823
            'X-Container-Meta')
824

825
    def get_container_object_meta(self, until=None):
826
827
828
829
830
        """
        :param until: (str) formated date

        :returns: (dict)
        """
831
832
        return filter_in(
            self.get_container_info(until=until),
833
            'X-Container-Object-Meta')
834

835
    def set_container_meta(self, metapairs):
836
837
838
        """
        :param metapairs: (dict) {key1:val1, key2:val2, ...}
        """
839
        assert(type(metapairs) is dict)
840
        self.container_post(update=True, metadata=metapairs)
841

Stavros Sachtouris's avatar
Stavros Sachtouris committed
842
    def del_container_meta(self, metakey):
843
844
845
        """
        :param metakey: (str) metadatum key
        """
846
        self.container_post(update=True, metadata={metakey: ''})
847

848
    def set_container_limit(self, limit):
849
        """
850
        :param limit: (int)
851
        """
852
        self.container_post(update=True, quota=limit)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
853
854

    def set_container_versioning(self, versioning):
855
856
857
        """
        :param versioning: (str)
        """
858
        self.container_post(update=True, versioning=versioning)
Stavros Sachtouris's avatar
Stavros Sachtouris committed
859

860
    def del_object(self, obj, until=None, delimiter=None):
861
862
863
864
865
866
867
        """
        :param obj: (str) remote object path

        :param until: (str) formated date

        :param delimiter: (str)
        """
868
        self._assert_container()
869
        self.object_delete(obj, until=until, delimiter=delimiter)
870

871
872
873
874
875
876
    def set_object_meta(self, obj, metapairs):
        """
        :param obj: (str) remote object path

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

880
    def del_object_meta(self, obj, metakey):
881
882
        """
        :param obj: (str) remote object path
883
884

        :param metakey: (str) metadatum key
885
        """
886
        self.object_post(obj, update=True, metadata={metakey: ''})
887

888
889
890
    def publish_object(self, obj):
        """
        :param obj: (str) remote object path
891
892

        :returns: (str) access url
893
        """
894
        self.object_post(obj, update=True, public=True)
895
        info = self.get_object_info(obj)
896
897
        pref, sep, rest = self.base_url.partition('//')
        base = rest.split('/')[0]
898
        return '%s%s%s/%s' % (pref, sep, base, info['x-object-public'])
Stavros Sachtouris's avatar
Stavros Sachtouris committed
899

900
901
902
903
    def unpublish_object(self, obj):
        """
        :param obj: (str) remote object path
        """
904
        self.object_post(obj, update=True, public=False)
905

Stavros Sachtouris's avatar
Stavros Sachtouris committed
906
    def get_object_info(self, obj, version=None):
907
908
909
910
911
912
913
        """
        :param obj: (str) remote object path

        :param version: (str)

        :returns: (dict)
        """
914
915
916
917
918
        try:
            r = self.object_head(obj, version=version)
            return r.headers
        except ClientError as ce:
            if ce.status == 404:
919
                raise ClientError('Object %s not found' % obj, status=404)
920
            raise
Stavros Sachtouris's avatar
Stavros Sachtouris committed
921
922

    def get_object_meta(self, obj, version=None):
923
924
925
926
927
928
929
        """
        :param obj: (str) remote object path

        :param version: (str)

        :returns: (dict)
        """
930
931
        return filter_in(
            self.get_object_info(obj, version=version),
932
            'X-Object-Meta')
Stavros Sachtouris's avatar
Stavros Sachtouris committed
933

934
935
936
937
938
939
    def get_object_sharing(self, obj):
        """
        :param obj: (str) remote object path

        :returns: (dict)
        """
940
941
        r = filter_in(
            self.get_object_info(obj),
942
943
            'X-Object-Sharing',
            exactMatch=True)
944
945
946
947
948
949
950
951
952
953
954
        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
955

956
    def set_object_sharing(
957
958
            self, obj,
            read_permition=False, write_permition=False):
959
        """Give read/write permisions to an object.
960
961
962
963
964
965
966
967
968

        :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
969
           permissions will be removed
970
        """
971

972
        perms = dict(read=read_permition or '', write=write_permition or '')
973
        self.object_post(obj, update=True, permissions=perms)
974

975
976
977
978
979
980
981
982
983
984
985
    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
986

987
        :param upload_db: progress.bar for uploading
Stavros Sachtouris's avatar
Stavros Sachtouris committed
988
        """
989

990
        self._assert_container()
991
        meta = self.get_container_info()
Stavros Sachtouris's avatar
Stavros Sachtouris committed
992
        blocksize = int(meta['x-container-block-size'])
993
        filesize = fstat(source_file.fileno()).st_size
994
        nblocks = 1 + (filesize - 1) // blocksize
Stavros Sachtouris's avatar
Stavros Sachtouris committed
995
        offset = 0
996
        if upload_cb:
Stavros Sachtouris's avatar
Stavros Sachtouris committed
997
            upload_gen = upload_cb(nblocks)
998
            upload_gen.next()
Stavros Sachtouris's avatar
Stavros Sachtouris committed
999
1000