-
Notifications
You must be signed in to change notification settings - Fork 45
/
connection.py
244 lines (174 loc) · 6.13 KB
/
connection.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
from spotify.components.base import Component, USER_AGENT
from spotify.core.helpers import repr_trim
from spotify.core.request import Request
from pyemitter import Emitter
from threading import Lock, Timer
from ws4py import WS_VERSION
from ws4py.client.threadedclient import WebSocketClient
import json
import logging
log = logging.getLogger(__name__)
class Connection(Component, Emitter):
heartbeat_interval = 180 # (in seconds)
def __init__(self, sp):
super(Connection, self).__init__(sp)
self.client = None
self.connected = False
self.disconnecting = False
self.heartbeat_timer = None
self.seq = 0
self.requests = {}
self.send_lock = Lock()
def reset(self):
self.connected = False
self.disconnecting = False
if self.heartbeat_timer:
self.heartbeat_timer.cancel()
self.heartbeat_timer = None
self.seq = 0
self.requests = {}
self.send_lock = Lock()
def connect(self, url):
if self.client:
return
self.reset()
self.client = Client(self, url)\
.on('open', self.on_open)\
.on('message', self.on_message)\
.on('close', self.on_close)
log.info('Connecting to "%s"' % url)
self.client.connect()
def disconnect(self):
if not self.connected:
return
self.disconnecting = True
self.connected = False
if self.client:
self.client.close()
self.client = None
def on_open(self):
log.debug('WebSocket "open" event')
if self.connected:
return
self.send_connect()
def on_message(self, message):
if message is None:
log.warn('empty messaged received')
return
# Parse json message
try:
data = json.loads(message)
except Exception, e:
self.emit('error', 'Unable to decode message (%s): %s' % (e, message))
return
# Handle commands (do_work, ping_flash2, etc..)
if 'message' in data:
return self.emit('command', *data['message'])
mid = data.get('id')
# Request doesn't exist
if mid not in self.requests:
log.warn('Unhandled message received with id %s' % mid)
return
request = self.requests[mid]
# Delete request from map, not needed anymore
del self.requests[mid]
# Process the response (fire callbacks)
request.process(data)
def on_close(self, code, reason=None):
log.info('Spotify connection closed')
if self.disconnecting:
log.debug('Client requested disconnect, ignoring "close" event')
self.reset()
return
self.disconnect()
self.reset()
self.emit('close', code=code, reason=reason)
def send(self, name, *args):
return self.build(name, *args)\
.send()
def build(self, name, *args):
return Request(self.sp, name, args)
def send_request(self, request):
# Build message
message = request.build(self.seq)
if not message:
return None
# Store request (to trigger callback on response)
self.requests[self.seq] = request
self.seq += 1
# Build and send request
self.send_message(message)
return request
def send_message(self, message):
if self.client is None:
raise Exception('Unable to send message, socket has been closed')
encoded = json.dumps(message, separators=(',', ':'))
log.debug('send encoded: %s' % repr_trim(encoded))
with self.send_lock:
self.client.send(encoded)
def send_connect(self):
log.debug('send_connect()')
args = self.sp.config['credentials'][0].split(':', 2)
args[2] = args[2].decode('string_escape')
self.build('connect', *args)\
.on('success', self.on_connect)\
.pipe('error', self)\
.send()
def send_heartbeat(self):
self.build('sp/echo', 'h')\
.pipe('error', self)\
.send()
def schedule_heartbeat(self):
if not self.connected:
pass
def heartbeat_trigger():
# Send heartbeat ('sp/echo')
self.send_heartbeat()
# Schedule next heartbeat
self.schedule_heartbeat()
self.heartbeat_timer = Timer(self.heartbeat_interval, heartbeat_trigger)
self.heartbeat_timer.start()
def on_connect(self, message):
log.debug('SpotifyConnection "connect" event: %s', message)
if message.get('result') != 'ok':
# TODO: handle possible error case
log.error('unable to connect')
return
log.debug('connected')
self.connected = True
# Schedule initial heartbeat
self.schedule_heartbeat()
self.emit('connect')
class Client(WebSocketClient, Emitter):
threading = True
threading_workers = 4
def __init__(self, connection, *args, **kwargs):
WebSocketClient.__init__(self, *args, **kwargs)
self._connection = connection
self.daemon = True
@property
def handshake_headers(self):
"""
List of headers appropriate for the upgrade
handshake.
"""
headers = [
('Host', self.host),
('Connection', 'Upgrade'),
('Upgrade', 'websocket'),
('Origin', self.url),
('Sec-WebSocket-Version', str(max(WS_VERSION))),
('User-Agent', USER_AGENT),
('Sec-WebSocket-Key', self.key.decode('utf-8')),
]
if self.protocols:
headers.append(('Sec-WebSocket-Protocol', ','.join(self.protocols)))
if self.extra_headers:
headers.extend(self.extra_headers)
return headers
def opened(self):
self.emit('open')
def received_message(self, message):
self.emit('message', message=message.data)
def closed(self, code, reason=None):
self.emit('close', code=code, reason=reason)