root / kamaki / clients / image / __init__.py @ 76e7661e
History | View | Annotate | Download (6.1 kB)
1 |
# Copyright 2011 GRNET S.A. All rights reserved.
|
---|---|
2 |
#
|
3 |
# Redistribution and use in source and binary forms, with or
|
4 |
# without modification, are permitted provided that the following
|
5 |
# conditions are met:
|
6 |
#
|
7 |
# 1. Redistributions of source code must retain the above
|
8 |
# copyright notice, this list of conditions and the following
|
9 |
# disclaimer.
|
10 |
#
|
11 |
# 2. Redistributions in binary form must reproduce the above
|
12 |
# copyright notice, this list of conditions and the following
|
13 |
# disclaimer in the documentation and/or other materials
|
14 |
# provided with the distribution.
|
15 |
#
|
16 |
# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS
|
17 |
# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
18 |
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
19 |
# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR
|
20 |
# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
21 |
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
22 |
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
|
23 |
# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
|
24 |
# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
25 |
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
26 |
# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
27 |
# POSSIBILITY OF SUCH DAMAGE.
|
28 |
#
|
29 |
# The views and conclusions contained in the software and
|
30 |
# documentation are those of the authors and should not be
|
31 |
# interpreted as representing official policies, either expressed
|
32 |
# or implied, of GRNET S.A.
|
33 |
|
34 |
from kamaki.clients import Client, ClientError |
35 |
from kamaki.clients.utils import path4url, filter_in |
36 |
|
37 |
|
38 |
class ImageClient(Client): |
39 |
"""Synnefo Plankton API client"""
|
40 |
|
41 |
def __init__(self, base_url, token): |
42 |
super(ImageClient, self).__init__(base_url, token) |
43 |
|
44 |
def list_public(self, detail=False, filters={}, order=''): |
45 |
"""
|
46 |
:param detail: (bool)
|
47 |
|
48 |
:param filters: (dict) request filters
|
49 |
|
50 |
:param order: (str) order listing by field (default is ascending, - for
|
51 |
descending)
|
52 |
|
53 |
:returns: (list) id,name + full image info if detail
|
54 |
"""
|
55 |
path = path4url('images', 'detail') if detail else ( |
56 |
path4url('images') + '/') |
57 |
|
58 |
async_params = {} |
59 |
if isinstance(filters, dict): |
60 |
for key, value in filters.items(): |
61 |
if value:
|
62 |
async_params[key] = value |
63 |
if order.startswith('-'): |
64 |
async_params['sort_dir'] = 'desc' |
65 |
order = order[1:]
|
66 |
else:
|
67 |
async_params['sort_dir'] = 'asc' |
68 |
if order:
|
69 |
async_params['sort_key'] = order
|
70 |
|
71 |
r = self.get(path, async_params=async_params, success=200) |
72 |
return r.json
|
73 |
|
74 |
def get_meta(self, image_id): |
75 |
"""
|
76 |
:param image_id: (string)
|
77 |
|
78 |
:returns: (list) image metadata (key:val)
|
79 |
"""
|
80 |
path = path4url('images', image_id)
|
81 |
r = self.head(path, success=200) |
82 |
|
83 |
reply = {} |
84 |
properties = {} |
85 |
meta_prefix = 'x-image-meta-'
|
86 |
property_prefix = 'x-image-meta-property-'
|
87 |
|
88 |
for key, val in r.headers.items(): |
89 |
key = key.lower() |
90 |
if key.startswith(property_prefix):
|
91 |
key = key[len(property_prefix):]
|
92 |
properties[key] = val |
93 |
elif key.startswith(meta_prefix):
|
94 |
key = key[len(meta_prefix):]
|
95 |
reply[key] = val |
96 |
|
97 |
if properties:
|
98 |
reply['properties'] = properties
|
99 |
return reply
|
100 |
|
101 |
def register(self, name, location, params={}, properties={}): |
102 |
"""Register image put at location
|
103 |
|
104 |
:param name: (str)
|
105 |
|
106 |
:param location: (str) pithos://<account>/<container>/<path>
|
107 |
|
108 |
:param params: (dict) image metadata (X-Image-Meta) can be id, store,
|
109 |
disc_format, container_format, size, checksum, is_public, owner
|
110 |
|
111 |
:param properties: (dict) image properties (X-Image-Meta-Property)
|
112 |
|
113 |
:returns: (dict) details of the created image
|
114 |
"""
|
115 |
path = path4url('images') + '/' |
116 |
self.set_header('X-Image-Meta-Name', name) |
117 |
self.set_header('X-Image-Meta-Location', location) |
118 |
|
119 |
async_headers = {} |
120 |
for key, val in params.items(): |
121 |
if key in ('store', 'disk_format', 'container_format', |
122 |
'size', 'checksum', 'is_public', 'owner') and val: |
123 |
key = 'x-image-meta-' + key.replace('_', '-') |
124 |
async_headers[key] = val |
125 |
|
126 |
for key, val in properties.items(): |
127 |
async_headers['x-image-meta-property-%s' % key] = val
|
128 |
|
129 |
r = self.post(path, success=200, async_headers=async_headers) |
130 |
return filter_in(r.headers, 'X-Image-') |
131 |
|
132 |
def list_members(self, image_id): |
133 |
"""
|
134 |
:param image_id: (str)
|
135 |
|
136 |
:returns: (list) users who can use current user's images
|
137 |
"""
|
138 |
path = path4url('images', image_id, 'members') |
139 |
r = self.get(path, success=200) |
140 |
return r.json['members'] |
141 |
|
142 |
def list_shared(self, member): |
143 |
"""
|
144 |
:param member: (str) sharers account
|
145 |
|
146 |
:returns: (list) images shared by member
|
147 |
"""
|
148 |
path = path4url('shared-images', member)
|
149 |
#self.set_param('format', 'json')
|
150 |
r = self.get(path, success=200) |
151 |
return r.json['shared_images'] |
152 |
|
153 |
def add_member(self, image_id, member): |
154 |
"""
|
155 |
:param image_id: (str)
|
156 |
|
157 |
:param member: (str) user to allow access to current user's images
|
158 |
"""
|
159 |
path = path4url('images', image_id, 'members', member) |
160 |
self.put(path, success=204) |
161 |
|
162 |
def remove_member(self, image_id, member): |
163 |
"""
|
164 |
:param image_id: (str)
|
165 |
|
166 |
:param member: (str) user to deprive from current user's images
|
167 |
"""
|
168 |
path = path4url('images', image_id, 'members', member) |
169 |
self.delete(path, success=204) |
170 |
|
171 |
def set_members(self, image_id, members): |
172 |
"""
|
173 |
:param image_id: (str)
|
174 |
|
175 |
:param members: (list) user to deprive from current user's images
|
176 |
"""
|
177 |
path = path4url('images', image_id, 'members') |
178 |
req = {'memberships': [{'member_id': member} for member in members]} |
179 |
self.put(path, json=req, success=204) |