root / kamaki / clients / image.py @ 2005b18e
History | View | Annotate | Download (6.9 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 |
36 |
|
37 |
|
38 |
class ImageClient(Client): |
39 |
"""OpenStack Image Service API 1.0 and GRNET Plankton 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 path4url('images/') |
56 |
|
57 |
async_params = {} |
58 |
if isinstance(filters, dict): |
59 |
for key, value in filters.items(): |
60 |
if value:
|
61 |
async_params[key] = value |
62 |
if order.startswith('-'): |
63 |
self.set_param('sort_dir', 'desc') |
64 |
order = order[1:]
|
65 |
else:
|
66 |
self.set_param('sort_dir', 'asc') |
67 |
self.set_param('sort_key', order, iff=order) |
68 |
|
69 |
r = self.get(path, async_params=async_params, success=200) |
70 |
return r.json
|
71 |
|
72 |
def get_meta(self, image_id): |
73 |
"""
|
74 |
:param image_id: (string)
|
75 |
|
76 |
:returns: (list) image metadata (key:val)
|
77 |
"""
|
78 |
path = path4url('images', image_id)
|
79 |
r = self.head(path, success=200) |
80 |
|
81 |
reply = {} |
82 |
properties = {} |
83 |
meta_prefix = 'x-image-meta-'
|
84 |
property_prefix = 'x-image-meta-property-'
|
85 |
|
86 |
for key, val in r.headers.items(): |
87 |
key = key.lower() |
88 |
if key.startswith(property_prefix):
|
89 |
key = key[len(property_prefix):]
|
90 |
properties[key] = val |
91 |
elif key.startswith(meta_prefix):
|
92 |
key = key[len(meta_prefix):]
|
93 |
reply[key] = val |
94 |
|
95 |
if properties:
|
96 |
reply['properties'] = properties
|
97 |
return reply
|
98 |
|
99 |
def register(self, name, location, params={}, properties={}): |
100 |
"""Register image put at location
|
101 |
|
102 |
:param name: (str)
|
103 |
|
104 |
:param location: (str) pithos://<account>/<container>/<path>
|
105 |
|
106 |
:param params: (dict) image metadata (X-Image-Meta) can be id, store,
|
107 |
disc_format, container_format, size, checksum, is_public, owner
|
108 |
|
109 |
:param properties: (dict) image properties (X-Image-Meta-Property)
|
110 |
"""
|
111 |
path = path4url('images/')
|
112 |
self.set_header('X-Image-Meta-Name', name) |
113 |
self.set_header('X-Image-Meta-Location', location) |
114 |
|
115 |
for key, val in params.items(): |
116 |
if key in ('id', 'store', 'disk_format', 'container_format', |
117 |
'size', 'checksum', 'is_public', 'owner'): |
118 |
key = 'x-image-meta-' + key.replace('_', '-') |
119 |
self.set_header(key, val)
|
120 |
|
121 |
for key, val in properties.items(): |
122 |
self.set_header('X-Image-Meta-Property-%s' % key, val) |
123 |
|
124 |
r = self.post(path, success=200) |
125 |
r.release() |
126 |
|
127 |
def reregister(self, location, name=None, params={}, properties={}): |
128 |
"""Update existing image (key: location)
|
129 |
|
130 |
:param location: (str) pithos://<account>/<container>/<path>
|
131 |
|
132 |
:param name: (str)
|
133 |
|
134 |
:param params: (dict) image metadata (X-Image-Meta) can be id, store,
|
135 |
disc_format, container_format, size, checksum, is_public, owner
|
136 |
|
137 |
:param properties: (dict) image properties (X-Image-Meta-Property)
|
138 |
"""
|
139 |
path = path4url('images', 'detail') |
140 |
r = self.get(path, success=200) |
141 |
imgs = [img for img in r.json if img['location'] == location] |
142 |
for img in imgs: |
143 |
img_name = name if name else img['name'] |
144 |
img_properties = img['properties']
|
145 |
for k, v in properties.items(): |
146 |
img_properties[k] = v |
147 |
self.register(img_name, location, params, img_properties)
|
148 |
r.release() |
149 |
|
150 |
def list_members(self, image_id): |
151 |
"""
|
152 |
:param image_id: (str)
|
153 |
|
154 |
:returns: (list) users who can use current user's images
|
155 |
"""
|
156 |
path = path4url('images', image_id, 'members') |
157 |
r = self.get(path, success=200) |
158 |
return r.json['members'] |
159 |
|
160 |
def list_shared(self, member): |
161 |
"""
|
162 |
:param member: (str) sharers account
|
163 |
|
164 |
:returns: (list) images shared by member
|
165 |
"""
|
166 |
path = path4url('shared-images', member)
|
167 |
#self.set_param('format', 'json')
|
168 |
r = self.get(path, success=200) |
169 |
return r.json['shared_images'] |
170 |
|
171 |
def add_member(self, image_id, member): |
172 |
"""
|
173 |
:param image_id: (str)
|
174 |
|
175 |
:param member: (str) user to allow access to current user's images
|
176 |
"""
|
177 |
path = path4url('images', image_id, 'members', member) |
178 |
r = self.put(path, success=204) |
179 |
r.release() |
180 |
|
181 |
def remove_member(self, image_id, member): |
182 |
"""
|
183 |
:param image_id: (str)
|
184 |
|
185 |
:param member: (str) user to deprive from current user's images
|
186 |
"""
|
187 |
path = path4url('images', image_id, 'members', member) |
188 |
r = self.delete(path, success=204) |
189 |
r.release() |
190 |
|
191 |
def set_members(self, image_id, members): |
192 |
"""
|
193 |
:param image_id: (str)
|
194 |
|
195 |
:param members: (list) user to deprive from current user's images
|
196 |
"""
|
197 |
path = path4url('images', image_id, 'members') |
198 |
req = {'memberships': [{'member_id': member} for member in members]} |
199 |
r = self.put(path, json=req, success=204) |
200 |
r.release() |