-
Notifications
You must be signed in to change notification settings - Fork 39
/
Client.py
539 lines (454 loc) · 18.8 KB
/
Client.py
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
# =============================================================================
# _ __ _ _
# | |/ /__ _| | |_ _ _ _ _ __ _
# | ' </ _` | | _| || | '_/ _` |
# |_|\_\__,_|_|\__|\_,_|_| \__,_|
#
# This file is part of the Kaltura Collaborative Media Suite which allows users
# to do with audio, video, and animation what Wiki platfroms allow them to do
# with text.
#
# Copyright (C) 2006-2011 Kaltura Inc.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as
# published by the Free Software Foundation, either version 3 of the
# License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <http:#www.gnu.org/licenses/>.
#
# @ignore
# =============================================================================
from __future__ import absolute_import
from KalturaClient.Base import (
IKalturaClientPlugin,
IKalturaLogger,
KALTURA_SERVICE_FORMAT_XML,
KalturaEnumsFactory,
KalturaObjectBase,
KalturaObjectFactory,
KalturaParams,
getXmlNodeFloat,
getXmlNodeText,
)
from KalturaClient.exceptions import (
KalturaException, KalturaClientException)
from KalturaClient.Plugins.Core import (
API_VERSION, KalturaClientConfiguration, KalturaRequestConfiguration)
import binascii
import hashlib
import mimetypes
import random
import base64
import types
import time
import os
import xml.etree.ElementTree as etree
import requests
from requests_toolbelt.multipart.encoder import MultipartEncoder
import six
try:
from Crypto import Random
from Crypto.Cipher import AES
except ImportError:
pass # PyCrypto is required only for creating KS V2
def _get_file_params(files):
"""Return the full parameters needed for uploading files - name, file
handle and mimetype."""
for key, value in files.items():
if hasattr(value, "read"):
filename = getattr(value, "name", None)
filetype = mimetypes.guess_type(filename)[0] if filename else None
yield (key, (filename, value, filetype))
else:
yield (key, value)
class MultiRequestSubResult(object):
def __init__(self, value):
self.value = value
def __str__(self):
return '{%s}' % self.value
def __repr__(self):
return '{%s}' % self.value
def __getattr__(self, name):
if name.startswith('__') or name.endswith('__'):
raise AttributeError()
return MultiRequestSubResult('%s:%s' % (self.value, name))
def __getitem__(self, key):
return MultiRequestSubResult('%s:%s' % (self.value, key))
class PluginServicesProxy(object):
def addService(self, serviceName, serviceClass):
setattr(self, serviceName, serviceClass)
class KalturaClient(object):
RANDOM_SIZE = 16
FIELD_EXPIRY = '_e'
FIELD_TYPE = '_t'
FIELD_USER = '_u'
ENCODING = 'utf8'
def __init__(self, config):
self.config = None
self.shouldLog = False
self.multiRequestReturnType = None
self.callsQueue = []
self.requestHeaders = {}
self.clientConfiguration = {
'clientTag': 'python-@DATE@',
'apiVersion': API_VERSION,
}
self.requestConfiguration = {}
self.config = config
logger = self.config.getLogger()
if (logger):
self.shouldLog = True
KalturaObjectFactory.registerObjects(
{'KalturaObjectBase': KalturaObjectBase})
self.loadPlugins()
self.loadConfigurations()
def loadConfigurationItem(self, configurationMap, property_):
ucfirst = property_[0].upper() + property_[1:]
setter = lambda self, value: configurationMap.update(
{property_: value})
setattr(self, 'set' + ucfirst, types.MethodType(setter, self))
getter = lambda self: configurationMap[property_]
setattr(self, 'get' + ucfirst, types.MethodType(getter, self))
def loadConfiguration(self, configurationClass, configurationMap):
for property_ in configurationClass.PROPERTY_LOADERS:
self.loadConfigurationItem(configurationMap, property_)
def loadConfigurations(self):
self.loadConfiguration(
KalturaClientConfiguration, self.clientConfiguration)
self.loadConfiguration(
KalturaRequestConfiguration, self.requestConfiguration)
def loadPlugins(self):
pluginFiles = ['Core']
pluginsFolder = os.path.normpath(
os.path.join(os.path.dirname(__file__), 'Plugins'))
if os.path.isdir(pluginsFolder):
for fileName in os.listdir(pluginsFolder):
(pluginFile, fileExt) = os.path.splitext(fileName)
if fileExt.lower() != '.py':
continue
pluginFiles.append(pluginFile)
for pluginFile in pluginFiles:
self.loadPlugin(pluginFile)
def loadPlugin(self, pluginFile):
moduleHierarchy = ['KalturaClient', 'Plugins', pluginFile]
pluginModule = __import__('.'.join(moduleHierarchy))
for curModule in moduleHierarchy[1:]:
pluginModule = getattr(pluginModule, curModule)
if pluginFile == 'Core':
pluginClass = 'KalturaCoreClient'
else:
pluginClass = 'Kaltura%sClientPlugin' % pluginFile
if pluginClass not in dir(pluginModule):
return
pluginClassType = getattr(pluginModule, pluginClass)
plugin = pluginClassType.get()
if not isinstance(plugin, IKalturaClientPlugin):
return
self.registerPluginServices(plugin)
self.registerPluginObjects(plugin)
def registerPluginServices(self, plugin):
pluginName = plugin.getName()
if pluginName != '':
pluginProxy = PluginServicesProxy()
setattr(self, pluginName, pluginProxy)
for (serviceName, serviceFactory) in plugin.getServices().items():
serviceClass = serviceFactory(self)
if pluginName == '':
self.addCoreService(serviceName, serviceClass)
else:
pluginProxy.addService(serviceName, serviceClass)
def registerPluginObjects(self, plugin):
KalturaEnumsFactory.registerEnums(plugin.getEnums())
KalturaObjectFactory.registerObjects(plugin.getTypes())
def addCoreService(self, serviceName, serviceClass):
setattr(self, serviceName, serviceClass)
def getServeUrl(self):
if len(self.callsQueue) != 1:
return None
(result, params, _) = self.getRequestParams()
# reset state
self.callsQueue = []
if params is not None:
result += '?' + six.moves.urllib.parse.urlencode(params.get())
self.log("Returned url [%s]" % result)
return result
def queueServiceActionCall(self, service, action, returnType,
params=KalturaParams(), files=None):
for param in self.requestConfiguration:
if isinstance(self.requestConfiguration[param], KalturaObjectBase):
params.addObjectIfDefined(
param, self.requestConfiguration[param])
else:
params.put(param, self.requestConfiguration[param])
call = KalturaServiceActionCall(service, action, params, files)
if (self.multiRequestReturnType is not None):
self.multiRequestReturnType.append(returnType)
self.callsQueue.append(call)
def getRequestParams(self):
params = KalturaParams()
files = {}
for param in self.clientConfiguration:
params.put(param, self.clientConfiguration[param])
params.put("format", self.config.format)
url = self.config.serviceUrl + "/api_v3"
if (self.multiRequestReturnType is not None):
url += "/service/multirequest"
for i, call in enumerate(self.callsQueue):
callParams = call.getParamsForMultiRequest(i)
callFiles = call.getFilesForMultiRequest(i)
params.update(callParams)
if callFiles:
files.update(callFiles)
else:
call = self.callsQueue[0]
url += "/service/" + call.service + "/action/" + call.action
params.update(call.params.get())
if call.files:
files.update(call.files)
signature = params.signature()
params.put("kalsig", signature)
self.log("request url: [%s]" % url)
self.log("request json: [%s]" % params.toJson())
return (url, params, files)
@staticmethod
def closeHandle(fh):
fh.close()
@staticmethod
def openRequestUrl(url, params, files, requestHeaders, requestTimeout):
requestHeaders['Accept'] = 'text/xml'
requestHeaders['Accept-encoding'] = 'gzip'
try:
if not (params.get() or files):
requestHeaders['Content-Type'] = 'application/json'
return requests.post(
url, headers=requestHeaders, timeout=requestTimeout)
if files:
if 'Content-Type' in requestHeaders:
del requestHeaders['Content-Type']
fields = {}
fields["json"] = params.toJson()
fields.update(_get_file_params(files))
encoder = MultipartEncoder(fields=fields)
requestHeaders['Content-Type'] = encoder.content_type
return requests.post(
url, headers=requestHeaders,
data=encoder, timeout=requestTimeout)
else:
requestHeaders['Content-Type'] = 'application/json'
return requests.post(
url, json=params.get(), headers=requestHeaders,
timeout=requestTimeout)
except Exception as e:
raise KalturaClientException(
e, KalturaClientException.ERROR_CONNECTION_FAILED)
@staticmethod
def readHttpResponse(r):
try:
return r.content
except Exception as e:
raise KalturaClientException(
e, KalturaClientException.ERROR_READ_FAILED)
# Send http request
def doHttpRequest(self, url, params=KalturaParams(), files=None):
if not files:
requestTimeout = self.config.requestTimeout
else:
# 10 seconds is a reasonable default timeout
requestTimeout = 10
r = self.openRequestUrl(
url, params, files, self.requestHeaders, requestTimeout)
data = self.readHttpResponse(r)
self.responseHeaders = r.headers
return data
def parsePostResult(self, postResult):
self.log("result (xml): %s" % postResult)
try:
resultXml = etree.fromstring(postResult)
except etree.ParseError as e:
raise KalturaClientException(
e, KalturaClientException.ERROR_INVALID_XML)
resultNode = resultXml.find('result')
if resultNode is None:
raise KalturaClientException(
'Could not find result node in response xml',
KalturaClientException.ERROR_RESULT_NOT_FOUND)
execTime = resultXml.find('executionTime')
if execTime is not None:
self.executionTime = getXmlNodeFloat(execTime)
self.throwExceptionIfError(resultNode)
return resultNode
# Call all API services that are in queue
def doQueue(self):
self.responseHeaders = None
self.executionTime = None
if len(self.callsQueue) == 0:
self.multiRequestReturnType = None
return None
if self.config.format != KALTURA_SERVICE_FORMAT_XML:
raise KalturaClientException(
"unsupported format: %s" % (postResult),
KalturaClientException.ERROR_FORMAT_NOT_SUPPORTED)
startTime = time.time()
# get request params
(url, params, files) = self.getRequestParams()
# reset state
self.callsQueue = []
# issue the request
postResult = self.doHttpRequest(url, params, files)
endTime = time.time()
self.log("execution time for [%s]: [%s]" % (url, endTime - startTime))
# print server debug info to log
serverName = None
serverSession = None
for curHeader in self.responseHeaders:
if curHeader.startswith('X-Me:'):
serverName = curHeader.split(':', 1)[1].strip()
elif curHeader.startswith('X-Kaltura-Session:'):
serverSession = curHeader.split(':', 1)[1].strip()
if serverName is not None or serverSession is not None:
self.log(
"server: [%s], session [%s]" % (serverName, serverSession))
# parse the result
resultNode = self.parsePostResult(postResult)
return resultNode
def getConfig(self):
return self.config
def setConfig(self, config):
self.config = config
logger = self.config.getLogger()
if isinstance(logger, IKalturaLogger):
self.shouldLog = True
def getExceptionIfError(self, resultNode):
errorNode = resultNode.find('error')
if errorNode is None:
return None
messageNode = errorNode.find('message')
codeNode = errorNode.find('code')
if messageNode is None or codeNode is None:
return None
return KalturaException(
getXmlNodeText(messageNode), getXmlNodeText(codeNode))
# Validate the result xml node and raise exception if its an error
def throwExceptionIfError(self, resultNode):
exceptionObj = self.getExceptionIfError(resultNode)
if exceptionObj is None:
return
raise exceptionObj
def startMultiRequest(self):
self.multiRequestReturnType = []
def doMultiRequest(self):
resultXml = self.doQueue()
if resultXml is None:
return []
result = []
for i, childNode in enumerate(resultXml.getchildren()):
exceptionObj = self.getExceptionIfError(childNode)
if exceptionObj is not None:
result.append(exceptionObj)
elif childNode.find('objectType') is not None:
result.append(
KalturaObjectFactory.create(
childNode, self.multiRequestReturnType[i]))
elif childNode.find('item/objectType') is not None:
result.append(
KalturaObjectFactory.createArray(
childNode, self.multiRequestReturnType[i]))
else:
result.append(getXmlNodeText(childNode))
self.multiRequestReturnType = None
return result
def isMultiRequest(self):
return (self.multiRequestReturnType is not None)
def getMultiRequestResult(self):
return MultiRequestSubResult('%s:result' % len(self.callsQueue))
def log(self, msg):
if self.shouldLog:
self.config.getLogger().log(msg)
@staticmethod
def generateSession(adminSecretForSigning, userId, type_, partnerId,
expiry=86400, privileges=''):
rand = random.randint(0, 0x10000)
expiry = int(time.time()) + expiry
fields = [
partnerId, partnerId, expiry, type_, rand, userId, privileges]
fields = [
x if isinstance(x, six.binary_type)
else six.text_type(x).encode(KalturaClient.ENCODING)
for x in fields]
info = six.b(';').join(fields)
signature = binascii.hexlify(
KalturaClient.hash(
adminSecretForSigning.encode(KalturaClient.ENCODING) + info))
decodedKS = signature + six.b("|") + info
KS = base64.b64encode(decodedKS)
return KS
@staticmethod
def generateSessionV2(adminSecretForSigning, userId, type, partnerId,
expiry=86400, privileges=''):
# build fields array
fields = {}
for privilege in privileges.split(','):
privilege = privilege.strip()
if len(privilege) == 0:
continue
if privilege == '*':
privilege = 'all:*'
splittedPrivilege = privilege.split(':', 1)
if len(splittedPrivilege) > 1:
fields[splittedPrivilege[0]] = splittedPrivilege[1]
else:
fields[splittedPrivilege[0]] = ''
fields[KalturaClient.FIELD_EXPIRY] = str(int(time.time()) + expiry)
fields[KalturaClient.FIELD_TYPE] = str(type)
fields[KalturaClient.FIELD_USER] = str(userId)
# build fields string
fieldsStr = six.moves.urllib.parse.urlencode(fields).encode(
KalturaClient.ENCODING)
fieldsStr = Random.get_random_bytes(
KalturaClient.RANDOM_SIZE) + fieldsStr
fieldsStr = KalturaClient.hash(fieldsStr) + fieldsStr
# encrypt and encode
cipher = AES.new(
KalturaClient.hash(
adminSecretForSigning.encode(KalturaClient.ENCODING))[:16],
AES.MODE_CBC, six.b('\0') * 16)
if len(fieldsStr) % cipher.block_size != 0:
fieldsStr += six.b('\0') * (
cipher.block_size - len(fieldsStr) % cipher.block_size)
encryptedFields = cipher.encrypt(fieldsStr)
decodedKs = ("v2|%s|" % partnerId).encode(
KalturaClient.ENCODING) + encryptedFields
return base64.urlsafe_b64encode(decodedKs)
@staticmethod
def hash(msg):
m = hashlib.sha1()
m.update(msg)
return m.digest()
class KalturaServiceActionCall(object):
def __init__(self, service, action, params=KalturaParams(),
files=None):
self.service = service
self.action = action
self.params = params
self.files = files
# Return the parameters for a multi request
def getParamsForMultiRequest(self, multiRequestIndex):
self.params.put('service', self.service)
self.params.put('action', self.action)
multiRequestParams = KalturaParams()
multiRequestParams.add(multiRequestIndex, self.params.get())
return multiRequestParams.get()
def getFilesForMultiRequest(self, multiRequestIndex):
if not self.files:
return
multiRequestParams = {}
for (key, val) in self.files.items():
multiRequestParams["%s:%s" % (multiRequestIndex, key)] = val
return multiRequestParams