request.py
16.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
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
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you 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.
# coding=utf-8
import abc
from aliyunsdkcore.vendored.six import iterkeys
from aliyunsdkcore.vendored.six import iteritems
from aliyunsdkcore.vendored.six import add_metaclass
from aliyunsdkcore.http import protocol_type
from aliyunsdkcore.http import method_type as mt
from aliyunsdkcore.http import format_type as ft
from aliyunsdkcore.auth.composer import rpc_signature_composer as rpc_signer
from aliyunsdkcore.auth.composer import roa_signature_composer as roa_signer
from aliyunsdkcore.utils.parameter_helper import md5_sum
from aliyunsdkcore.auth.algorithm import sha_hmac1
from aliyunsdkcore.acs_exception import exceptions
from aliyunsdkcore.acs_exception import error_code
from aliyunsdkcore.compat import ensure_string
from aliyunsdkcore.vendored.requests.structures import CaseInsensitiveDict
"""
Acs request model.
"""
STYLE_RPC = 'RPC'
STYLE_ROA = 'ROA'
_default_protocol_type = protocol_type.HTTP
def set_default_protocol_type(user_protocol_type):
global _default_protocol_type
if user_protocol_type == protocol_type.HTTP or user_protocol_type == protocol_type.HTTPS:
_default_protocol_type = user_protocol_type
else:
raise exceptions.ClientException(
error_code.SDK_INVALID_PARAMS,
"Invalid 'protocol_type', should be 'http' or 'https'"
)
def get_default_protocol_type():
return _default_protocol_type
@add_metaclass(abc.ABCMeta)
class AcsRequest:
"""
Acs request base class. This class wraps up common parameters for a request.
"""
def __init__(self, product, version=None,
action_name=None,
location_service_code=None,
location_endpoint_type='openAPI',
accept_format=None,
protocol_type=None,
method=None):
"""
:param product:
:param version:
:param action_name:
:param params:
:param resource_owner_account:
:param protocol_type:
:param accept_format:
:return:
"""
self._version = version
self._product = product
self._action_name = action_name
self._protocol_type = protocol_type
if self._protocol_type is None:
self._protocol_type = _default_protocol_type
self._accept_format = accept_format
self._params = {}
self._method = method
self._header = {}
if action_name is not None:
self.add_header('x-acs-action', action_name)
if version is not None:
self.add_header('x-acs-version', version)
self._body_params = {}
self._uri_pattern = None
self._uri_params = None
self._content = None
self._location_service_code = location_service_code
self._location_endpoint_type = location_endpoint_type
self.add_header('x-sdk-invoke-type', 'normal')
self.endpoint = None
self._extra_user_agent = {}
self.string_to_sign = ''
self._request_connect_timeout = None
self._request_read_timeout = None
self.request_network = "public"
self.product_suffix = ""
self.endpoint_map = None
self.endpoint_regional = None
def add_query_param(self, k, v):
self._params[k] = v
def add_body_params(self, k, v):
self._body_params[k] = v
def get_body_params(self):
return self._body_params
def get_uri_pattern(self):
return self._uri_pattern
def get_uri_params(self):
return self._uri_params
def get_product(self):
return self._product
def get_version(self):
return self._version
def get_action_name(self):
return self._action_name
def get_accept_format(self):
return self._accept_format
def get_protocol_type(self):
return self._protocol_type
def get_query_params(self):
return self._params
def get_method(self):
return self._method
def set_uri_pattern(self, pattern):
self._uri_pattern = pattern
def set_uri_params(self, params):
self._uri_params = params
def set_method(self, method):
self._method = method
def set_product(self, product):
self._product = product
def set_version(self, version):
self._header['x-acs-version'] = version
self._version = version
def set_action_name(self, action_name):
self._header['x-acs-action'] = action_name
self._action_name = action_name
def set_accept_format(self, accept_format):
self._accept_format = accept_format
def set_protocol_type(self, protocol_type):
self._protocol_type = protocol_type
def set_query_params(self, params):
self._params = params
def set_body_params(self, body_params):
self._body_params = body_params
def set_content(self, content):
"""
:param content: ByteArray
:return:
"""
self._content = content
def get_content(self):
"""
:return: ByteArray
"""
return self._content
def get_headers(self):
"""
:return: Dict
"""
return self._header
def set_headers(self, headers):
"""
:param headers: Dict
:return:
"""
self._header = headers
def add_header(self, k, v):
self._header[k] = v
def set_user_agent(self, agent):
self.add_header('User-Agent', agent)
def append_user_agent(self, key, value):
self._extra_user_agent.update({key: value})
def request_user_agent(self):
request_user_agent = {}
if 'User-Agent' in self.get_headers():
request_user_agent.update({
'request': self.get_headers().get('User-Agent')
})
else:
request_user_agent.update(self._extra_user_agent)
return CaseInsensitiveDict(request_user_agent)
def set_location_service_code(self, location_service_code):
self._location_service_code = location_service_code
def get_location_service_code(self):
return self._location_service_code
def get_location_endpoint_type(self):
return self._location_endpoint_type
def set_content_type(self, content_type):
self.add_header("Content-Type", content_type)
@abc.abstractmethod
def get_style(self):
pass
@abc.abstractmethod
def get_url(self, region_id, ak, secret):
pass
@abc.abstractmethod
def get_signed_header(self, region_id, ak, secret):
pass
def set_endpoint(self, endpoint):
self.endpoint = endpoint
def get_connect_timeout(self):
return self._request_connect_timeout
def set_connect_timeout(self, connect_timeout):
self._request_connect_timeout = connect_timeout
def get_read_timeout(self):
return self._request_read_timeout
def set_read_timeout(self, read_timeout):
self._request_read_timeout = read_timeout
class RpcRequest(AcsRequest):
"""
Class to compose an RPC style request with.
"""
def __init__(
self,
product,
version,
action_name,
location_service_code=None,
location_endpoint_type='openAPI',
format=None,
protocol=None,
signer=sha_hmac1):
AcsRequest.__init__(
self,
product,
version,
action_name,
location_service_code,
location_endpoint_type,
format,
protocol,
mt.GET)
self._style = STYLE_RPC
self._signer = signer
def get_style(self):
return self._style
def _get_sign_params(self):
req_params = self.get_query_params()
if req_params is None:
req_params = {}
req_params['Version'] = self.get_version()
req_params['Action'] = self.get_action_name()
req_params['Format'] = self.get_accept_format()
return req_params
def get_url(self, region_id, access_key_id, access_key_secret):
sign_params = dict(self._get_sign_params())
if 'RegionId' not in iterkeys(sign_params):
sign_params['RegionId'] = region_id
url, string_to_sign = rpc_signer.get_signed_url(
sign_params,
access_key_id,
access_key_secret,
self.get_accept_format(),
self.get_method(),
self.get_body_params(),
self._signer)
self.string_to_sign = string_to_sign
return url
def get_signed_header(self, region_id=None, ak=None, secret=None):
headers = {}
for headerKey, headerValue in iteritems(self.get_headers()):
if headerKey.startswith("x-acs-") or headerKey.startswith("x-sdk-"):
headers[headerKey] = headerValue
return headers
class RoaRequest(AcsRequest):
"""
Class to compose an ROA style request with.
"""
def __init__(
self,
product,
version,
action_name,
location_service_code=None,
location_endpoint_type='openAPI',
method=None,
headers=None,
uri_pattern=None,
path_params=None,
protocol=None):
"""
:param product: String, mandatory
:param version: String, mandatory
:param action_name: String, mandatory
:param method: String
:param headers: Dict
:param uri_pattern: String
:param path_params: Dict
:param protocol: String
:return:
"""
AcsRequest.__init__(
self,
product,
version,
action_name,
location_service_code,
location_endpoint_type,
ft.RAW,
protocol,
method)
self._style = STYLE_ROA
self._method = method
if headers is not None:
self._header = headers
self._uri_pattern = uri_pattern
self._path_params = path_params
def get_style(self):
"""
:return: String
"""
return self._style
def get_path_params(self):
return self._path_params
def set_path_params(self, path_params):
self._path_params = path_params
def add_path_param(self, k, v):
if self._path_params is None:
self._path_params = {}
self._path_params[k] = v
def _get_sign_params(self):
req_params = self.get_query_params()
if req_params is None:
req_params = {}
self.add_header("x-acs-version", self.get_version())
# req_params['Version'] = self.get_version()
# req_params['Action'] = self.get_action_name()
# req_params['Format'] = self.get_accept_format()
return req_params
def get_signed_header(self, region_id, ak, secret):
"""
Generate signed header
:param region_id: String
:param ak: String
:param secret: String
:return: Dict
"""
sign_params = dict(self._get_sign_params())
if self.get_content() is not None:
self.add_header(
'Content-MD5', md5_sum(self.get_content()))
if 'RegionId' not in sign_params.keys():
sign_params['RegionId'] = region_id
self.add_header('x-acs-region-id', str(region_id))
signed_headers, sign_to_string = roa_signer.get_signature_headers(
sign_params,
ak,
secret,
self.get_accept_format(),
self.get_headers().copy(),
self.get_uri_pattern(),
self.get_path_params(),
self.get_method())
self.string_to_sign = sign_to_string
return signed_headers
def get_url(self, region_id, ak=None, secret=None):
"""
Compose request url without domain
:param region_id: String
:return: String
"""
sign_params = dict(self.get_query_params())
if 'RegionId' not in sign_params.keys():
sign_params['RegionId'] = region_id
url = roa_signer.get_url(
self.get_uri_pattern(),
sign_params,
self.get_path_params())
return url
class CommonRequest(AcsRequest):
def __init__(self, domain=None, version=None, action_name=None, uri_pattern=None, product=None,
location_endpoint_type='openAPI'):
super(CommonRequest, self).__init__(product, version, action_name)
self.request = None
self.endpoint = domain
self._version = version
self._action_name = action_name
self._uri_pattern = uri_pattern
self._product = product
self._location_endpoint_type = location_endpoint_type
self._signer = sha_hmac1
self.add_header('x-sdk-invoke-type', 'common')
self._path_params = None
self._method = "GET"
def get_path_params(self):
return self._path_params
def set_path_params(self, path_params):
self._path_params = path_params
def add_path_param(self, k, v):
if self._path_params is None:
self._path_params = {}
self._path_params[k] = v
def set_domain(self, domain):
self.endpoint = domain
def get_domain(self):
return self.endpoint
def set_uri_pattern(self, uri_pattern):
self._uri_pattern = uri_pattern
def get_uri_pattern(self):
return self._uri_pattern
def set_product(self, product):
self._product = product
def get_product(self):
return self._product
def trans_to_acs_request(self):
if not self._version:
raise exceptions.ClientException(
error_code.SDK_INVALID_PARAMS,
'common params [version] is required, cannot be empty')
if not self._action_name and not self._uri_pattern:
raise exceptions.ClientException(
error_code.SDK_INVALID_PARAMS,
'At least one of [action] and [uri_pattern] has a value')
if not self.endpoint and not self._product:
raise exceptions.ClientException(
error_code.SDK_INVALID_PARAMS,
'At least one of [domain] and [product_name] has a value')
if self._uri_pattern:
self._style = STYLE_ROA
self.request = RoaRequest(product=self.get_product(), version=self.get_version(),
action_name=self.get_action_name(),
location_endpoint_type=self.get_location_endpoint_type()
)
self.fill_params()
else:
self._style = STYLE_RPC
self.request = RpcRequest(product=self.get_product(), version=self.get_version(),
action_name=self.get_action_name(),
location_endpoint_type=self.get_location_endpoint_type(),
)
self.fill_params()
def get_style(self):
return self._style
def get_url(self, region_id, ak, secret):
return self.request.get_url(region_id, ak, secret)
def get_signed_header(self, region_id, access_key_id, access_key_secret):
return self.request.get_signed_header(region_id, access_key_id, access_key_secret)
def fill_params(self):
self.request.set_uri_pattern(self.get_uri_pattern())
self.request.set_uri_params(self.get_uri_params())
if self.get_style() == STYLE_ROA:
self.request.set_path_params(self.get_path_params())
self.request.set_method(self.get_method())
self.request.set_product(self.get_product())
self.request.set_version(self.get_version())
self.request.set_action_name(self.get_action_name())
self.request.set_accept_format(self.get_accept_format())
self.request.set_protocol_type(self.get_protocol_type())
self.request.set_query_params(self.get_query_params())
self.request.set_content(self.get_content())
self.request.set_headers(self.get_headers())
self.request.set_location_service_code(
self.get_location_service_code())
self.request.set_body_params(self.get_body_params())