Skip to content
Navigation Menu
{{ message }}
This repository was archived by the owner on Aug 20, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 29
Expand file tree
/
Copy pathclient.py
More file actions
executable file
·387 lines (325 loc) · 12.9 KB
/
Copy pathclient.py
File metadata and controls
executable file
·387 lines (325 loc) · 12.9 KB
1
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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
"""
Client module. Contains the primary interface for the client.
See COPYING for license information.
"""
from object_storage.utils import json, Model
from object_storage.container import Container
from object_storage.storage_object import StorageObject
from object_storage.utils import get_path
from object_storage import errors
import logging
logger = logging.getLogger(__name__)
class AccountModel(Model):
def __init__(self, controller, headers={}):
_headers = {}
# Lowercase headers
for key, value in headers.iteritems():
_key = key.lower()
_headers[_key] = value
self.headers = _headers
self._meta = None
_properties = {}
_properties['container_count'] = int(
self.headers.get('x-account-container-count') or
self.headers.get('count') or 0)
_properties['object_count'] = int(
self.headers.get('x-account-object-count') or
self.headers.get('object_count') or 0)
_properties['size'] = int(
self.headers.get('x-account-bytes-used') or
self.headers.get('size') or 0)
_properties['path'] = controller.path
_properties['url'] = controller.url
meta = {}
for key, value in self.headers.iteritems():
if key.startswith('meta_'):
meta[key[5:]] = value
elif key.startswith('x-account-meta-'):
meta[key[15:]] = value
self.meta = meta
_properties['meta'] = self.meta
self.properties = _properties
self.data = self.properties
class Client(object):
"""
Client class. Primary interface for the client.
"""
def __init__(self,
username=None,
api_key=None,
connection=None,
delimiter='/',
**kwargs):
""" constructor for Client object
@param username: the username
@param api_key: api_key for Object Storage
@param connection: `object_storage.transport.AuthenticatedConnection`
instance.
@param delimiter: the symbol to use to divid up hiearchical divisions
for objects.
@param container_class: factory or class for Container constructing
@param object_class: factory or class for StorageObject constructing
"""
self.username = username
self.api_key = api_key
self.delimiter = delimiter
self.container_class = kwargs.get('container_class', Container)
self.object_class = kwargs.get('object_class', StorageObject)
self.storage_url = None
self.conn = connection
self.model = None
def load(self, cdn=True):
""" load data for the account
@return: object_storage.client, self
"""
def _formatter(res):
self.model = AccountModel(self, res.headers)
return self
return self.make_request('HEAD', formatter=_formatter)
def get_info(self):
""" loads data if not already available and returns the properties """
if not self.model:
self.load()
return self.model.properties
@property
def properties(self):
""" loads data if not already available and returns the properties """
return self.get_info()
props = properties
@property
def headers(self):
""" loads data if not already available and returns the raw headers
for the account """
if not self.model:
self.load()
return self.model.headers
@property
def meta(self):
""" loads data if not already available and returns the metadata for
the account """
if not self.model:
self.load()
return self.model.meta
@property
def path(self):
""" Returns the file-path. Always returns an empty string. """
return ''
@property
def url(self):
""" Returns the url of the resource. """
return self.get_url()
def is_dir(self):
""" Returns whether or not this is a directory. Always True. """
return True
def search(self, q=None, options=None, **kwargs):
""" Access the search interface.
@param q: the search query. This can be None.
@param options: options for the search API. Valid options:
q.[fieldname] -> define search query for a specific field.
field -> field name (when using q)
type -> 'object' or 'container'; default shows both.
recursive -> whether to search recursively or to limit to
one level; default=true
@param **kwargs: to be merged into the options param.
Provides a nicer interface for the same thing.
More information on options:
http://sldn.softlayer.com/article/API-Operations-Search-Services
"""
default_params = {
'format': 'json',
}
if q:
default_params['q'] = q
params = {}
options = options or {}
options.update(kwargs)
for key, val in options.iteritems():
if key.startswith('q_'):
params["q.%s" % key[2:]] = val
else:
params[key] = val
params = dict(default_params.items() + params.items())
headers = {'X-Context': 'search'}
_path = None
if 'container' in options:
_path = [options['container']]
if 'path' in options and type(options['path']) is not dict:
_path = [options['path']]
def _formatter(response):
""" Formats search results. """
headers = response.headers
items = json.loads(response.content)
objs = []
for item in items:
if 'type' not in item or item['type'] == 'container':
objs.append(self.container(item['name'], headers=item))
elif item['type'] == 'object':
obj = self.storage_object(item['container'],
item['name'],
headers=item)
objs.append(obj)
count = int(headers.get('x-search-items-count', 0))
total = int(headers.get('x-search-items-total', 0))
offset = int(headers.get('x-search-items-offset', 0))
return {'count': count,
'total': total,
'offset': offset,
'results': objs}
return self.make_request('GET', _path,
headers=headers,
params=params,
formatter=_formatter)
def set_delimiter(self, delimiter):
""" Sets the delimiter for pseudo hierarchical directory structure.
@param delimiter: delimiter to use
"""
self.delimiter = delimiter
def set_storage_url(self, url):
""" Sets the storage URL. After authentication, the URL is
automatically populated, but the default value can be overwritten.
@param url: url to use to call the Object Storage API.
"""
self.storage_url = url
def container(self, name, headers=None):
""" Initializes container object.
@param name: name of the container
@param headers: initial headers to use to initialize the object
"""
return self.container_class(name, headers=headers, client=self)
def get_container(self, name):
""" Makes a container object and calls load() on it.
@param name: container name
@raises ResponseError
"""
return self.container(name).load()
def set_metadata(self, meta, headers={}):
""" Sets metadata for the account
@param meta: dict of metadata on the account
@raises ResponseError
"""
meta_headers = {}
for k, v in headers.iteritems():
meta_headers[k] = v
for k, v in meta.iteritems():
meta_headers["x-account-meta-%s" % (k, )] = v
self.make_request('POST', headers=meta_headers)
def create_container(self, name):
""" Creates a new container
@param name: container name
@raises ResponseError
"""
return self.container(name).create()
def delete_container(self, name, recursive=False):
""" Deletes a container.
@param name: container name
@raises ResponseError
@raises ContainerNotEmpty if container is not empty
"""
params = {}
if recursive:
params['recursive'] = True
try:
return self.make_request('DELETE', [name],
params=params, formatter=lambda r: True)
except errors.ResponseError, ex:
if ex.status == 409:
raise errors.ContainerNotEmpty(ex.status,
"ContainerNotEmpty Error")
raise ex
def containers(self, marker=None, headers=None):
""" Lists containers
@param marker: start listing after this container name
@param headers: extra headers to use when making the listing call
@raises ResponseError
"""
params = {'format': 'json'}
if marker:
params['marker'] = marker
def _formatter(res):
containers = []
if res.content:
items = json.loads(res.content)
for item in items:
name = item.get('name', None)
containers.append(self.container(name, item))
return containers
return self.make_request('GET',
params=params,
headers=headers,
formatter=_formatter)
def public_containers(self, *args, **kwargs):
""" Lists public containers. Same interface as self.containers()
@raises ResponseError
"""
kwargs['headers'] = {'X-Context': 'cdn'}
return self.containers(*args, **kwargs)
def storage_object(self, container, name, headers=None):
""" Initialize a StorageObject instance
@param container: container name
@param name: object name
@param headers: initial headers to use to initialize the object
"""
return self.object_class(container, name,
headers=headers,
client=self)
def get_object(self, container, name):
""" Load an object from swift
@param container: container name
@param name: object name
@raises ResponseError
"""
return self.storage_object(container, name).load()
def delete_object(self, container, name):
""" Delete an object from swift
@param container: container name
@param name: object name
@raises ResponseError
"""
return self.make_request('DELETE', [container, name],
formatter=lambda r: True)
def get_url(self, path=None):
""" Returns the url of the resource
@param path: path to append to the end of the URL
"""
url = self.storage_url
if not url:
self.storage_url = self.conn.storage_url
url = self.storage_url
if path:
url = "%s/%s" % (url, get_path(path))
return url
def make_request(self, method, path=None, *args, **kwargs):
""" Make an HTTP request
@param method: HTTP method (GET, HEAD, POST, PUT, ...)
@param path: path
@raises ResponseError
"""
url = self.get_url(path)
result = self.conn.make_request(method, url, *args, **kwargs)
return result
def chunk_download(self, path, chunk_size=10 * 1024, headers=None):
""" Returns a chunk download generator
@param path: path
@param chunk_size: the max size in bytes to return on each yield
@param headers: extra headers to use with this request
@raises ResponseError
"""
url = self.get_url(path)
return self.conn.chunk_download(url, chunk_size=chunk_size)
def chunk_upload(self, path, size=None, headers=None):
""" Returns a chunkable connection object at the given path
@param path: path
@param headers: extra headers to use with this request
@raises ResponseError
"""
url = self.get_url(path)
logger.debug("%s %s %s" % ('PUT', url, headers))
return self.conn.chunk_upload('PUT', url, size=size, headers=headers)
def __getitem__(self, name):
""" Returns a container object with the given name """
return self.container(name)
def __iter__(self):
""" Returns an interator based on results of self.containers() """
listing = self.containers()
for obj in listing:
yield obj
You can’t perform that action at this time.