Repository navigation
Expand file tree
/
Copy pathparsers.py
More file actions
462 lines (365 loc) · 14.8 KB
/
Copy pathparsers.py
File metadata and controls
462 lines (365 loc) · 14.8 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
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
# -*- coding: utf-8 -*-
# MinIO Python Library for Amazon S3 Compatible Cloud Storage,
# (C) 2015 MinIO, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""
minio.parsers
~~~~~~~~~~~~~~~~~~~
This module contains core API parsers.
:copyright: (c) 2015 by MinIO, Inc.
:license: Apache 2.0, see LICENSE for more details.
"""
from xml.etree import ElementTree
from xml.etree.ElementTree import ParseError
from .compat import unquote
from .credentials import Value
from .definitions import (Bucket, CopyObjectResult, IncompleteUpload,
MultipartUploadResult, Object, UploadPart)
# minio specific.
from .error import InvalidXMLError, MultiDeleteError
from .helpers import _iso8601_to_utc_datetime
from .xml_marshal import NOTIFICATIONS_ARN_FIELDNAME_MAP
# dependencies.
_XML_NS = {
's3': 'http://s3.amazonaws.com/doc/2006-03-01/',
'sts': 'https://sts.amazonaws.com/doc/2011-06-15/'
}
class S3Element:
"""S3 aware XML parsing class. Wraps a root element name and
ElementTree.Element instance. Provides S3 namespace aware parsing
functions.
"""
def __init__(self, root_name, element):
self.root_name = root_name
self.element = element
@classmethod
def fromstring(cls, root_name, data):
"""Initialize S3Element from name and XML string data.
:param name: Name for XML data. Used in XML errors.
:param data: string data to be parsed.
:return: Returns an S3Element.
"""
try:
return cls(root_name, ElementTree.fromstring(data.strip()))
except (ParseError, AttributeError, ValueError, TypeError) as error:
raise InvalidXMLError(
'"{}" XML is not parsable. Message: {}'.format(
root_name, error
)
)
def findall(self, name):
"""Similar to ElementTree.Element.findall()
"""
return [
S3Element(self.root_name, elem)
for elem in self.element.findall('s3:{}'.format(name), _XML_NS)
]
def find(self, name):
"""Similar to ElementTree.Element.find()
"""
elt = self.element.find('s3:{}'.format(name), _XML_NS)
return S3Element(self.root_name, elt) if elt else None
def get_child_text(self, name, strict=True):
"""Extract text of a child element. If strict, and child element is
not present, raises InvalidXMLError and otherwise returns
None.
"""
if strict:
try:
return self.element.find('s3:{}'.format(name), _XML_NS).text
except (ParseError, AttributeError, ValueError, TypeError) as error:
raise InvalidXMLError(
('Invalid XML provided for "{}" - erroring tag <{}>. '
'Message: {}').format(self.root_name, name, error)
)
else:
return self.element.findtext('s3:{}'.format(name), None, _XML_NS)
def get_urldecoded_elem_text(self, name, strict=True):
"""Like self.get_child_text(), but also performs urldecode() on the
result.
"""
text = self.get_child_text(name, strict)
# strictness is already enforced above.
return unquote(text) if text is not None else None
def get_etag_elem(self, strict=True):
"""Fetches an 'ETag' child element suitably processed.
"""
return self.get_child_text('ETag', strict).replace('"', '')
def get_int_elem(self, name):
"""Fetches an integer type XML child element by name.
"""
return int(self.get_child_text(name))
def get_localized_time_elem(self, name):
"""Parse a time XML child element.
"""
return _iso8601_to_utc_datetime(self.get_child_text(name))
def text(self):
"""Fetch the current node's text
"""
return self.element.text
def is_dir(self):
"""Returns True if the object is a dir
ie, if an object name has `/` suffixed.
"""
text = self.get_child_text('Key')
return text.endswith("/")
def parse_multipart_upload_result(data):
"""
Parser for complete multipart upload response.
:param data: Response data for complete multipart upload.
:return: :class:`MultipartUploadResult <MultipartUploadResult>`.
"""
root = S3Element.fromstring('CompleteMultipartUploadResult', data)
return MultipartUploadResult(
root.get_child_text('Bucket'),
root.get_child_text('Key'),
root.get_child_text('Location'),
root.get_etag_elem()
)
def parse_copy_object(bucket_name, object_name, data):
"""
Parser for copy object response.
:param data: Response data for copy object.
:return: :class:`CopyObjectResult <CopyObjectResult>`
"""
root = S3Element.fromstring('CopyObjectResult', data)
return CopyObjectResult(
bucket_name, object_name,
root.get_etag_elem(),
root.get_localized_time_elem('LastModified')
)
def parse_list_buckets(data):
"""
Parser for list buckets response.
:param data: Response data for list buckets.
:return: List of :class:`Bucket <Bucket>`.
"""
root = S3Element.fromstring('ListBucketsResult', data)
return [
Bucket(bucket.get_child_text('Name'),
bucket.get_localized_time_elem('CreationDate'))
for buckets in root.findall('Buckets')
for bucket in buckets.findall('Bucket')
]
def _parse_objects_from_xml_elts(bucket_name, contents, common_prefixes):
"""Internal function that extracts objects and common prefixes from
list_objects responses.
"""
objects = [
Object(bucket_name,
content.get_child_text('Key'),
content.get_localized_time_elem('LastModified'),
content.get_etag_elem(strict=False),
content.get_int_elem('Size'),
is_dir=content.is_dir())
for content in contents
]
object_dirs = [
Object(bucket_name, dir_elt.text(), None, '', 0, is_dir=True)
for dirs_elt in common_prefixes
for dir_elt in dirs_elt.findall('Prefix')
]
return objects, object_dirs
def parse_list_objects(data, bucket_name):
"""
Parser for list objects response.
:param data: Response data for list objects.
:param bucket_name: Response for the bucket.
:return: Replies back three distinctive components.
- List of :class:`Object <Object>`
- True if list is truncated, False otherwise.
- Object name marker for the next request.
"""
root = S3Element.fromstring('ListObjectResult', data)
is_truncated = root.get_child_text('IsTruncated').lower() == 'true'
# NextMarker element need not be present.
marker = root.get_urldecoded_elem_text('NextMarker', strict=False)
objects, object_dirs = _parse_objects_from_xml_elts(
bucket_name,
root.findall('Contents'),
root.findall('CommonPrefixes')
)
if is_truncated and marker is None:
marker = objects[-1].object_name
return objects + object_dirs, is_truncated, marker
def parse_list_objects_v2(data, bucket_name):
"""
Parser for list objects version 2 response.
:param data: Response data for list objects.
:param bucket_name: Response for the bucket.
:return: Returns three distinct components:
- List of :class:`Object <Object>`
- True if list is truncated, False otherwise.
- Continuation Token for the next request.
"""
root = S3Element.fromstring('ListObjectV2Result', data)
is_truncated = root.get_child_text('IsTruncated').lower() == 'true'
# NextContinuationToken may not be present.
continuation_token = root.get_child_text('NextContinuationToken',
strict=False)
objects, object_dirs = _parse_objects_from_xml_elts(
bucket_name,
root.findall('Contents'),
root.findall('CommonPrefixes')
)
return objects + object_dirs, is_truncated, continuation_token
def parse_list_multipart_uploads(data, bucket_name):
"""
Parser for list multipart uploads response.
:param data: Response data for list multipart uploads.
:param bucket_name: Response for the bucket.
:return: Replies back four distinctive components.
- List of :class:`IncompleteUpload <IncompleteUpload>`
- True if list is truncated, False otherwise.
- Object name marker for the next request.
- Upload id marker for the next request.
"""
root = S3Element.fromstring('ListMultipartUploadsResult', data)
is_truncated = root.get_child_text('IsTruncated').lower() == 'true'
key_marker = root.get_urldecoded_elem_text('NextKeyMarker', strict=False)
upload_id_marker = root.get_child_text('NextUploadIdMarker', strict=False)
uploads = [
IncompleteUpload(bucket_name,
upload.get_urldecoded_elem_text('Key'),
upload.get_child_text('UploadId'),
upload.get_localized_time_elem('Initiated'))
for upload in root.findall('Upload')
]
return uploads, is_truncated, key_marker, upload_id_marker
def parse_list_parts(data, bucket_name, object_name, upload_id):
"""
Parser for list parts response.
:param data: Response data for list parts.
:param bucket_name: Response for the bucket.
:param object_name: Response for the object.
:param upload_id: Upload id of object name for
the active multipart session.
:return: Replies back three distinctive components.
- List of :class:`UploadPart <UploadPart>`.
- True if list is truncated, False otherwise.
- Next part marker for the next request if the
list was truncated.
"""
root = S3Element.fromstring('ListPartsResult', data)
is_truncated = root.get_child_text('IsTruncated').lower() == 'true'
part_marker = root.get_child_text('NextPartNumberMarker', strict=False)
parts = [
UploadPart(bucket_name, object_name, upload_id,
part.get_int_elem('PartNumber'),
part.get_etag_elem(),
part.get_localized_time_elem('LastModified'),
part.get_int_elem('Size'))
for part in root.findall('Part')
]
return parts, is_truncated, part_marker
def parse_new_multipart_upload(data):
"""
Parser for new multipart upload response.
:param data: Response data for new multipart upload.
:return: Returns a upload id.
"""
root = S3Element.fromstring('InitiateMultipartUploadResult', data)
return root.get_child_text('UploadId')
def parse_location_constraint(data):
"""
Parser for location constraint response.
:param data: Response data for get bucket location.
:return: Returns location of your bucket.
"""
root = S3Element.fromstring('BucketLocationConstraintResult', data)
return root.text()
def parse_get_bucket_notification(data):
"""
Parser for a get_bucket_notification response from S3.
:param data: Body of response from get_bucket_notification.
:return: Returns bucket notification configuration
"""
root = S3Element.fromstring('GetBucketNotificationResult', data)
notifications = _add_notifying_service_config(
root, {},
'TopicConfigurations', 'TopicConfiguration'
)
notifications = _add_notifying_service_config(
root, notifications,
'QueueConfigurations', 'QueueConfiguration'
)
notifications = _add_notifying_service_config(
root, notifications,
'CloudFunctionConfigurations', 'CloudFunctionConfiguration'
)
return notifications
def _add_notifying_service_config(data, notifications, service_key,
service_xml_tag):
"""Add service configuration in notification."""
arn_elt_name = NOTIFICATIONS_ARN_FIELDNAME_MAP[service_xml_tag]
config = []
for service in data.findall(service_xml_tag):
config_item = {}
config_item['Id'] = service.get_child_text('Id')
config_item['Arn'] = service.get_child_text(arn_elt_name)
config_item['Events'] = [
event.text() for event in service.findall('Event')
]
filter_terms = [
{
'Key': {
'FilterRules': [
{
'Name': xml_filter_rule.get_child_text('Name'),
'Value': xml_filter_rule.get_child_text('Value'),
}
for xml_filter_rule in xml_filter_rules.findall(
'./S3Key/FilterRule')
]
}
}
for xml_filter_rules in service.findall('Filter')
]
if len(filter_terms) > 0:
config_item['Filter'] = filter_terms
config.append(config_item)
if len(config) > 0:
notifications[service_key] = config
return notifications
def parse_multi_delete_response(data):
"""Parser for Multi-Object Delete API response.
:param data: XML response body content from service.
:return: Returns list of error objects for each delete object that
had an error.
"""
root = S3Element.fromstring('MultiObjectDeleteResult', data)
return [
MultiDeleteError(errtag.get_child_text('Key'),
errtag.get_child_text('Code'),
errtag.get_child_text('Message'))
for errtag in root.findall('Error')
]
def parse_assume_role(data):
"""
Parser for assume role response.
:param data: XML response data for STS assume role as a string.
:return: A 2-tuple containing:
- a :class:`minio.credentials.Value` instance with the
temporary credentials.
- A :class:`DateTime` instance of when the credentials expire.
"""
root = ElementTree.fromstring(data)
credentials = root.find("sts:AssumeRoleResult", _XML_NS).find(
"sts:Credentials", _XML_NS)
access_key = credentials.find("sts:AccessKeyId", _XML_NS).text
secret_key = credentials.find("sts:SecretAccessKey", _XML_NS).text
session_token = credentials.find("sts:SessionToken", _XML_NS).text
expiry_str = credentials.find("sts:Expiration", _XML_NS).text
expiry = _iso8601_to_utc_datetime(expiry_str)
return Value(access_key, secret_key, session_token), expiry