-
Notifications
You must be signed in to change notification settings - Fork 285
/
Pubnub.py
487 lines (414 loc) · 14.6 KB
/
Pubnub.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
## www.pubnub.com - PubNub Real-time push service in the cloud.
# coding=utf8
## PubNub Real-time Push APIs and Notifications Framework
## Copyright (c) 2010 Stephen Blum
## http://www.pubnub.com/
## -----------------------------------
## PubNub 3.1 Real-time Push Cloud API
## -----------------------------------
import sys
import json
import time
import hashlib
import urllib2
import uuid
try:
from hashlib import sha256
digestmod = sha256
except ImportError:
import Crypto.Hash.SHA256 as digestmod
sha256 = digestmod.new
import hmac
from twisted.internet import reactor
from twisted.internet.defer import Deferred
from twisted.internet.protocol import Protocol
from twisted.web.client import Agent
from twisted.web.client import HTTPConnectionPool
from twisted.web.http_headers import Headers
from PubnubCrypto import PubnubCrypto
import gzip
import zlib
pnconn_pool = HTTPConnectionPool(reactor)
pnconn_pool.maxPersistentPerHost = 100
pnconn_pool.cachedConnectionTimeout = 310
class Pubnub():
def start(self): reactor.run()
def stop(self): reactor.stop()
def timeout( self, callback, delay ):
reactor.callLater( delay, callback )
def __init__(
self,
publish_key,
subscribe_key,
secret_key = False,
cipher_key = False,
ssl_on = False,
origin = 'pubsub.pubnub.com'
) :
"""
#**
#* Pubnub
#*
#* Init the Pubnub Client API
#*
#* @param string publish_key required key to send messages.
#* @param string subscribe_key required key to receive messages.
#* @param string secret_key required key to sign messages.
#* @param boolean ssl required for 2048 bit encrypted messages.
#* @param string origin PUBNUB Server Origin.
#**
## Initiat Class
pubnub = Pubnub( 'PUBLISH-KEY', 'SUBSCRIBE-KEY', 'SECRET-KEY', False )
"""
self.origin = origin
self.publish_key = publish_key
self.subscribe_key = subscribe_key
self.secret_key = secret_key
self.cipher_key = cipher_key
self.ssl = ssl_on
self.subscriptions = {}
if self.ssl :
self.origin = 'https://' + self.origin
else :
self.origin = 'http://' + self.origin
def publish( self, args ) :
"""
#**
#* Publish
#*
#* Send a message to a channel.
#*
#* @param array args with channel and message.
#* @return array success information.
#**
## Publish Example
def publish_complete(info):
print(info)
pubnub.publish({
'channel' : 'hello_world',
'message' : {
'some_text' : 'Hello my World'
},
'callback' : publish_complete
})
"""
## Capture Callback
if args.has_key('callback'): callback = args['callback']
else: callback = lambda x : x
## Fail if bad input.
if not (args['channel'] and args['message']):
callback([ 0, 'Missing Channel or Message', 0 ])
return False
## Capture User Input
channel = str(args['channel'])
message = args['message']
if self.cipher_key :
pc = PubnubCrypto()
out = []
if type( message ) == type(list()):
for item in message:
encryptItem = pc.encrypt(self.cipher_key, item ).rstrip()
out.append(encryptItem)
message = json.dumps(out)
elif type( message ) == type(dict()):
outdict = {}
for k, item in message.iteritems():
encryptItem = pc.encrypt(self.cipher_key, item ).rstrip()
outdict[k] = encryptItem
out.append(outdict)
message = json.dumps(out[0])
else:
message = json.dumps(pc.encrypt(self.cipher_key, message).replace('\n',''))
else :
message = json.dumps(args['message'])
def publish_response(info):
callback(info or [0, 'Disconnected', 0]);
## Sign Message
if self.secret_key :
hashObject = sha256()
hashObject.update(self.secret_key)
hashedSecret = hashObject.hexdigest()
hash = hmac.HMAC(hashedSecret, '/'.join([
self.publish_key,
self.subscribe_key,
self.secret_key,
channel,
message
]), digestmod=digestmod)
signature = hash.hexdigest()
else :
signature = '0'
## Send Message
return self._request([
'publish',
self.publish_key,
self.subscribe_key,
signature,
channel,
'0',
message
], publish_response )
def subscribe( self, args ) :
"""
#**
#* Subscribe
#*
#* This is NON-BLOCKING.
#* Listen for a message on a channel.
#*
#* @param array args with channel and message.
#* @return false on fail, array on success.
#**
## Subscribe Example
def receive(message) :
print(message)
return True
## On Connect Callback
def connected() :
pubnub.publish({
'channel' : 'hello_world',
'message' : { 'some_var' : 'text' }
})
## Subscribe
pubnub.subscribe({
'channel' : 'hello_world',
'connect' : connected,
'callback' : receive
})
"""
## Fail if missing channel
if not 'channel' in args :
return 'Missing Channel.'
## Fail if missing callback
if not 'callback' in args :
return 'Missing Callback.'
## Capture User Input
channel = str(args['channel'])
callback = args['callback']
connectcb = args['connect']
if 'errorback' in args:
errorback = args['errorback']
else:
errorback = lambda x: x
## New Channel?
if not (channel in self.subscriptions) :
self.subscriptions[channel] = {
'first' : False,
'connected' : 0,
'timetoken' : '0'
}
## Ensure Single Connection
if self.subscriptions[channel]['connected'] :
return "Already Connected"
self.subscriptions[channel]['connected'] = 1
## SUBSCRIPTION RECURSION
def substabizel():
## STOP CONNECTION?
if not self.subscriptions[channel]['connected']:
return
def sub_callback(response):
## STOP CONNECTION?
if not self.subscriptions[channel]['connected']:
return
## CONNECTED CALLBACK
if not self.subscriptions[channel]['first'] :
self.subscriptions[channel]['first'] = True
connectcb()
## PROBLEM?
if not response:
def time_callback(_time):
if not _time:
reactor.callLater( 1, substabizel )
return errorback("Lost Network Connection")
else:
reactor.callLater( 1, substabizel )
## ENSURE CONNECTED (Call Time Function)
return self.time({ 'callback' : time_callback })
self.subscriptions[channel]['timetoken'] = response[1]
substabizel()
pc = PubnubCrypto()
out = []
for message in response[0]:
if self.cipher_key :
if type( message ) == type(list()):
for item in message:
encryptItem = pc.decrypt(self.cipher_key, item )
out.append(encryptItem)
message = out
elif type( message ) == type(dict()):
outdict = {}
for k, item in message.iteritems():
encryptItem = pc.decrypt(self.cipher_key, item )
outdict[k] = encryptItem
out.append(outdict)
message = out[0]
else:
message = pc.decrypt(self.cipher_key, message )
else :
message
callback(message)
## CONNECT TO PUBNUB SUBSCRIBE SERVERS
try :
self._request( [
'subscribe',
self.subscribe_key,
channel,
'0',
str(self.subscriptions[channel]['timetoken'])
], sub_callback )
except :
reactor.callLater( 1, substabizel )
return
## BEGIN SUBSCRIPTION (LISTEN FOR MESSAGES)
substabizel()
def unsubscribe( self, args ):
channel = str(args['channel'])
if not (channel in self.subscriptions):
return False
## DISCONNECT
self.subscriptions[channel]['connected'] = 0
self.subscriptions[channel]['timetoken'] = 0
self.subscriptions[channel]['first'] = False
def history( self, args ) :
"""
#**
#* History
#*
#* Load history from a channel.
#*
#* @param array args with 'channel' and 'limit'.
#* @return mixed false on fail, array on success.
#*
## History Example
history = pubnub.history({
'channel' : 'hello_world',
'limit' : 1
})
print(history)
"""
## Capture User Input
limit = args.has_key('limit') and int(args['limit']) or 10
channel = str(args['channel'])
## Fail if bad input.
if not channel :
return 'Missing Channel'
## Get History
pc = PubnubCrypto()
return self._request( [
'history',
self.subscribe_key,
channel,
'0',
str(limit)
], args['callback'] )
def time( self, args ) :
"""
#**
#* Time
#*
#* Timestamp from PubNub Cloud.
#*
#* @return int timestamp.
#*
## PubNub Server Time Example
def time_complete(timestamp):
print(timestamp)
pubnub.time(time_complete)
"""
def complete(response) :
if not response: return 0
args['callback'](response[0])
self._request( [
'time',
'0'
], complete )
def uuid(self) :
"""
#**
#* uuid
#*
#* Generate a UUID
#*
#* @return UUID.
#*
## PubNub UUID Example
uuid = pubnub.uuid()
print(uuid)
"""
return uuid.uuid1()
def _request( self, request, callback ) :
global pnconn_pool
## Build URL
url = self.origin + '/' + "/".join([
"".join([ ' ~`!@#$%^&*()+=[]\\{}|;\':",./<>?'.find(ch) > -1 and
hex(ord(ch)).replace( '0x', '%' ).upper() or
ch for ch in list(bit)
]) for bit in request])
requestType = request[0]
agent = Agent(
reactor,
self.ssl and None or pnconn_pool,
connectTimeout=30
)
request = agent.request( 'GET', url, Headers({
'V' : ['3.1'],
'User-Agent' : ['Python-Twisted'],
'Accept-Encoding' : ['gzip']
}), None )
self.resulting_is = str()
def received(response):
headerlist = list(response.headers.getAllRawHeaders())
for item in headerlist:
if( item[0] == "Content-Encoding"):
if type(item[1]) == type(list()):
for subitem in item[1]:
self.resulting_is = subitem
elif type(item[1]) == type(str()):
self.resulting_is = item[1]
finished = Deferred()
response.deliverBody(PubNubResponse(finished))
return finished
def complete(data):
if ( type(data) == type(str()) ):
if self.resulting_is:
d = zlib.decompressobj(16+zlib.MAX_WBITS)
try : data = d.decompress(data) # try/catch here, pass through if except
except : data = data
try : obj = json.loads(data)
except : obj = None
pc = PubnubCrypto()
out = []
if self.cipher_key :
if requestType == "history" :
if type(obj) == type(list()):
for item in obj:
if type(item) == type(list()):
for subitem in item:
encryptItem = pc.decrypt(self.cipher_key, subitem )
out.append(encryptItem)
elif type(item) == type(dict()):
outdict = {}
for k, subitem in item.iteritems():
encryptItem = pc.decrypt(self.cipher_key, subitem )
outdict[k] = encryptItem
out.append(outdict)
else :
encryptItem = pc.decrypt(self.cipher_key, item )
out.append(encryptItem)
callback(out)
elif type( obj ) == type(dict()):
for k, item in obj.iteritems():
encryptItem = pc.decrypt(self.cipher_key, item )
out.append(encryptItem)
callback(out)
else :
callback(obj)
else :
callback(obj)
request.addCallback(received)
request.addBoth(complete)
class PubNubResponse(Protocol):
def __init__( self, finished ):
self.finished = finished
def dataReceived( self, bytes ):
self.finished.callback(bytes)