319 lines
9.7 KiB
Python
319 lines
9.7 KiB
Python
import websocket
|
|
from anyjson import dumps, loads
|
|
from threading import Thread, Event
|
|
from urllib import urlopen
|
|
|
|
|
|
__version__ = '0.1.2'
|
|
|
|
|
|
PROTOCOL = 1 # SocketIO protocol version
|
|
|
|
|
|
class BaseNamespace(object):
|
|
|
|
def __init__(self, socketIO):
|
|
self.socketIO = socketIO
|
|
|
|
def on_connect(self, socketIO):
|
|
pass
|
|
|
|
def on_disconnect(self):
|
|
pass
|
|
|
|
def on_error(self, reason, advice):
|
|
print '[Error] %s' % advice
|
|
|
|
def on_message(self, messageData):
|
|
print '[Message] %s' % messageData
|
|
|
|
def on_(self, eventName, *eventArguments):
|
|
print '[Event] %s%s' % (eventName, eventArguments)
|
|
|
|
def on_open(self, *args):
|
|
print '[Open]', args
|
|
|
|
def on_close(self, *args):
|
|
print '[Close]', args
|
|
|
|
def on_retry(self, *args):
|
|
print '[Retry]', args
|
|
|
|
def on_reconnect(self, *args):
|
|
print '[Reconnect]', args
|
|
|
|
|
|
class SocketIO(object):
|
|
|
|
messageID = 0
|
|
|
|
def __init__(self, host, port, Namespace=BaseNamespace):
|
|
self.host = host
|
|
self.port = int(port)
|
|
self.namespace = Namespace(self)
|
|
self.__connect()
|
|
|
|
heartbeatInterval = self.heartbeatTimeout - 2
|
|
self.heartbeatThread = RhythmicThread(heartbeatInterval,
|
|
self._send_heartbeat)
|
|
self.heartbeatThread.start()
|
|
|
|
self.channelByName = {}
|
|
self.callbackByEvent = {}
|
|
self.namespaceThread = ListenerThread(self)
|
|
self.namespaceThread.start()
|
|
|
|
def __del__(self):
|
|
self.heartbeatThread.cancel()
|
|
self.namespaceThread.cancel()
|
|
self.connection.close()
|
|
|
|
def __connect(self):
|
|
baseURL = '%s:%d/socket.io/%s' % (self.host, self.port, PROTOCOL)
|
|
try:
|
|
response = urlopen('http://%s/' % baseURL)
|
|
except IOError:
|
|
raise SocketIOError('Could not start connection')
|
|
if 200 != response.getcode():
|
|
raise SocketIOError('Could not establish connection')
|
|
responseParts = response.readline().split(':')
|
|
self.sessionID = responseParts[0]
|
|
self.heartbeatTimeout = int(responseParts[1])
|
|
self.connectionTimeout = int(responseParts[2])
|
|
self.supportedTransports = responseParts[3].split(',')
|
|
if 'websocket' not in self.supportedTransports:
|
|
raise SocketIOError('Could not parse handshake')
|
|
socketURL = 'ws://%s/websocket/%s' % (baseURL, self.sessionID)
|
|
self.connection = websocket.create_connection(socketURL)
|
|
|
|
def _recv_packet(self):
|
|
packetID, channelName, data = None, None, None
|
|
try:
|
|
packet = self.connection.recv()
|
|
packetParts = packet.split(':', 3)
|
|
except (websocket.WebSocketException, AttributeError):
|
|
return 0, packetID, channelName, data
|
|
packetCount = len(packetParts)
|
|
if 4 == packetCount:
|
|
code, packetID, channelName, data = packetParts
|
|
elif 3 == packetCount:
|
|
code, packetID, channelName = packetParts
|
|
elif 1 == packetCount:
|
|
code = packetParts[0]
|
|
else:
|
|
raise ValueError('Could not parse packet:\n' + packet)
|
|
return int(code), packetID, channelName, data
|
|
|
|
def _send_packet(self, code, channelName='', data='', callback=None):
|
|
try:
|
|
self.connection.send(':'.join([
|
|
str(code),
|
|
self.set_callback(callback) if callback else '',
|
|
channelName,
|
|
data]))
|
|
except Exception, e:
|
|
pass
|
|
|
|
def disconnect(self, channelName=''):
|
|
self._send_packet(0, channelName)
|
|
if channelName:
|
|
del self.channelByName[channelName]
|
|
|
|
@property
|
|
def connected(self):
|
|
return self.connection.connected
|
|
|
|
def connect(self, channelName, Namespace=BaseNamespace):
|
|
channel = Channel(self, channelName, Namespace)
|
|
self.channelByName[channelName] = channel
|
|
self._send_packet(1, channelName)
|
|
return channel
|
|
|
|
def _send_heartbeat(self):
|
|
self._send_packet(2)
|
|
|
|
def message(self, messageData, callback=None, channelName=''):
|
|
if isinstance(messageData, basestring):
|
|
code = 3
|
|
data = messageData
|
|
else:
|
|
code = 4
|
|
data = dumps(messageData)
|
|
self._send_packet(code, channelName, data, callback)
|
|
|
|
def emit(self, eventName, *eventArguments, **eventKeywords):
|
|
code = 5
|
|
if callable(eventArguments[-1]):
|
|
callback = eventArguments[-1]
|
|
eventArguments = eventArguments[:-1]
|
|
else:
|
|
callback = None
|
|
channelName = eventKeywords.get('channelName', '')
|
|
data = dumps(dict(name=eventName, args=eventArguments))
|
|
self._send_packet(code, channelName, data, callback)
|
|
|
|
def get_callback(self, channelName, eventName):
|
|
'Get callback associated with channelName and eventName'
|
|
socketIO = self.channelByName[channelName] if channelName else self
|
|
try:
|
|
return socketIO.callbackByEvent[eventName]
|
|
except KeyError:
|
|
pass
|
|
namespace = socketIO.namespace
|
|
|
|
def callback_(*eventArguments):
|
|
return namespace.on_(eventName, *eventArguments)
|
|
return getattr(namespace, name_callback(eventName), callback_)
|
|
|
|
def set_callback(self, callback):
|
|
'Set callback that will be called after receiving an acknowledgment'
|
|
self.messageID += 1
|
|
self.namespaceThread.set_callback(self.messageID, callback)
|
|
return '%s+' % self.messageID
|
|
|
|
def on(self, eventName, callback):
|
|
self.callbackByEvent[eventName] = callback
|
|
|
|
def wait(self):
|
|
self.namespaceThread.wait()
|
|
|
|
|
|
class Channel(object):
|
|
|
|
def __init__(self, socketIO, channelName, Namespace):
|
|
self.socketIO = socketIO
|
|
self.channelName = channelName
|
|
self.namespace = Namespace(self)
|
|
self.callbackByEvent = {}
|
|
|
|
def disconnect(self):
|
|
self.socketIO.disconnect(self.channelName)
|
|
|
|
def emit(self, eventName, *eventArguments):
|
|
self.socketIO.emit(eventName, *eventArguments,
|
|
channelName=self.channelName)
|
|
|
|
def message(self, messageData, callback=None):
|
|
self.socketIO.message(messageData, callback,
|
|
channelName=self.channelName)
|
|
|
|
def on(self, eventName, eventCallback):
|
|
self.callbackByEvent[eventName] = eventCallback
|
|
|
|
|
|
class ListenerThread(Thread):
|
|
'Process messages from SocketIO server'
|
|
|
|
daemon = True
|
|
|
|
def __init__(self, socketIO):
|
|
super(ListenerThread, self).__init__()
|
|
self.socketIO = socketIO
|
|
self.done = Event()
|
|
self.waiting = Event()
|
|
self.callbackByMessageID = {}
|
|
self.get_callback = self.socketIO.get_callback
|
|
|
|
def run(self):
|
|
while not self.done.is_set():
|
|
code, packetID, channelName, data = self.socketIO._recv_packet()
|
|
delegate = {
|
|
0: self.on_disconnect,
|
|
1: self.on_connect,
|
|
2: self.on_heartbeat,
|
|
3: self.on_message,
|
|
4: self.on_json,
|
|
5: self.on_event,
|
|
6: self.on_acknowledgment,
|
|
7: self.on_error,
|
|
}[code]
|
|
delegate(packetID, channelName, data)
|
|
|
|
def cancel(self):
|
|
self.done.set()
|
|
|
|
def wait(self):
|
|
self.waiting.set()
|
|
self.join()
|
|
|
|
def set_callback(self, messageID, callback):
|
|
self.callbackByMessageID[messageID] = callback
|
|
|
|
def on_disconnect(self, packetID, channelName, data):
|
|
callback = self.get_callback(channelName, 'disconnect')
|
|
callback()
|
|
|
|
def on_connect(self, packetID, channelName, data):
|
|
callback = self.get_callback(channelName, 'connect')
|
|
callback(self.socketIO)
|
|
|
|
def on_heartbeat(self, packetID, channelName, data):
|
|
pass
|
|
|
|
def on_message(self, packetID, channelName, data):
|
|
callback = self.get_callback(channelName, 'message')
|
|
callback(data)
|
|
|
|
def on_json(self, packetID, channelName, data):
|
|
callback = self.get_callback(channelName, 'message')
|
|
callback(loads(data))
|
|
|
|
def on_event(self, packetID, channelName, data):
|
|
valueByName = loads(data)
|
|
eventName = valueByName['name']
|
|
eventArguments = valueByName['args']
|
|
callback = self.get_callback(channelName, eventName)
|
|
callback(*eventArguments)
|
|
|
|
def on_acknowledgment(self, packetID, channelName, data):
|
|
dataParts = data.split('+', 1)
|
|
messageID = int(dataParts[0])
|
|
print data
|
|
print dataParts
|
|
print dataParts[1]
|
|
arguments = loads(dataParts[1]) or []
|
|
try:
|
|
callback = self.callbackByMessageID[messageID]
|
|
except KeyError:
|
|
pass
|
|
else:
|
|
del self.callbackByMessageID[messageID]
|
|
callback(*arguments)
|
|
if self.waiting.is_set() and not len(self.callbackByMessageID):
|
|
self.cancel()
|
|
|
|
def on_error(self, packetID, channelName, data):
|
|
reason, advice = data.split('+', 1)
|
|
callback = self.get_callback(channelName, 'error')
|
|
callback(reason, advice)
|
|
|
|
|
|
class RhythmicThread(Thread):
|
|
'Execute rhythmicFunction every few seconds'
|
|
|
|
daemon = True
|
|
|
|
def __init__(self, intervalInSeconds, rhythmicFunction, *args, **kw):
|
|
super(RhythmicThread, self).__init__()
|
|
self.intervalInSeconds = intervalInSeconds
|
|
self.rhythmicFunction = rhythmicFunction
|
|
self.args = args
|
|
self.kw = kw
|
|
self.done = Event()
|
|
|
|
def run(self):
|
|
self.done.wait(self.intervalInSeconds)
|
|
while not self.done.is_set():
|
|
self.rhythmicFunction(*self.args, **self.kw)
|
|
self.done.wait(self.intervalInSeconds)
|
|
|
|
def cancel(self):
|
|
self.done.set()
|
|
|
|
|
|
class SocketIOError(Exception):
|
|
pass
|
|
|
|
|
|
def name_callback(eventName):
|
|
return 'on_' + eventName.replace(' ', '_')
|