-
Notifications
You must be signed in to change notification settings - Fork 29
/
protocol.py
308 lines (266 loc) · 10.7 KB
/
protocol.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
# This Source Code Form is subject to the terms of the Mozilla Public
# License, v. 2.0. If a copy of the MPL was not distributed with this
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
#
# Copyright (c) 2017 Tyler Goodlet <tgoodlet@gmail.com>
"""
Inbound ESL asyncio protocol
"""
import asyncio
from collections import defaultdict, deque
from six.moves.urllib.parse import unquote
from . import utils
# debugging - watch out pformat() is slow...
# from pprint import pformat
_sendmsg = """\
sendmsg {uuid}
call-command: {cmd}
execute-app-name: {app}
execute-app-arg: {params}{arg}
loops: {loops}"""
class InboundProtocol(asyncio.Protocol):
"""Inbound ESL client which delivers parsed events to an
``asyncio.Queue``.
"""
def __init__(self, host, password, loop, autorecon=False,
on_disconnect=None):
self.host = host
self.password = password
self.loop = loop
self.on_disconnect = on_disconnect
self.autorecon = autorecon
self.event_queue = asyncio.Queue(loop=loop)
self.log = utils.get_logger(utils.pstr(self))
self.transport = None
self._previous = None, None
# segment data in the form (event, size, data)
self._segmented = ({}, 0, '')
self._disconnected = None
self._auth_resp = None
# futures to be set and waited on for the following content types
self._futures_map = defaultdict(deque)
for ctype in ['command/reply', 'auth/request', 'api/response']:
self._futures_map.get(ctype)
def connected(self):
return bool(self.transport) and not self.transport.is_closing()
def disconnected(self):
"""Return a future that can be used to wait for the connection
to tear down.
"""
return self._disconnected if self._disconnected else False
def connection_made(self, transport):
"""Login with ESL password on connection.
"""
self.log.debug("Connection made to {}".format(self.host))
self.transport = transport
self._disconnected = self.loop.create_future()
self.authenticate()
def connection_lost(self, exc):
self._auth_resp = None
self.log.debug('The connection closed @ {}'.format(self.host))
self._disconnected.set_result(True)
if self.autorecon:
self.on_disconnect(self)
def reg_fut(self, ctype, fut=None):
"""Register and return a future wrapping an event packet to be
received according to the Content-Type ``ctype``.
"""
fut = fut or self.loop.create_future()
self._futures_map[ctype].append(fut)
return fut
def authenticated(self):
if self._auth_resp is None:
return False
return self._auth_resp.done() and not self._auth_resp.cancelled()
def authenticate(self):
if self._auth_resp is None:
auth_req = self.reg_fut('auth/request')
self._auth_resp = auth_resp = self.loop.create_future()
def ack_auth(future):
event = future.result()
if event['Reply-Text'] != '+OK accepted':
self._auth_resp = None
raise ConnectionError("Invalid password?")
self.log.debug("Authenticated to {}".format(self.host))
def respond_to_auth(future):
fut = self.sendrecv(
'auth {}'.format(self.password), fut=auth_resp)
fut.add_done_callback(ack_auth)
auth_req.add_done_callback(respond_to_auth)
return self._auth_resp
def process_events(self, events, parsed):
"""Process an event by activating futures or pushing to the queue.
"""
fut_map = self._futures_map
for event in events:
# self.log.log(
# utils.TRACE, "Event packet:\n{}".format(pformat(event)))
ctype = event.get('Content-Type', None)
if ctype == 'command/reply':
if event.get('Job-UUID'):
ctype = 'job/reply'
futures = fut_map.get(ctype, None)
if ctype == 'text/disconnect-notice':
event['Event-Name'] = 'SERVER_DISCONNECTED'
self.event_queue.put_nowait(event)
return
if futures is None: # ship it for consumption
self.event_queue.put_nowait(event)
else:
try:
fut = futures.popleft()
fut.set_result(event)
except IndexError:
self.log.warning("no scheduled future could be found "
"for event?\n{!r}".format(event))
except asyncio.base_futures.InvalidStateError:
if not fut.cancelled():
self.log.warning(
"future was already cancelled for event {}"
.format(event))
else:
raise
@staticmethod
def parse_frame(frame):
parsed = unquote(frame)
chunk = {}
last_key = 'Body'
for line in parsed.strip().splitlines():
if not line:
last_key = 'Body'
continue
key, sep, value = line.partition(': ')
if sep and key and key[0] is not '+': # 'key: value' header
last_key = key
chunk[key] = value
else:
# no sep - 2 cases: multi-line value or body content
chunk[last_key] = chunk.setdefault(
last_key, '') + line + '\n'
return chunk
@staticmethod
def read_contents(data, iframe, clen):
segmented = False
clen = int(clen)
contents = data[iframe:iframe+clen]
diff = clen - len(contents)
if diff > 0:
segmented = True
iframe = iframe + clen
return contents, segmented, diff, iframe
def data_received(self, data):
"""Main socket data processing routine. This is the core event packet
parser and should be optimized for speed.
"""
data = data.decode()
parsed = unquote(data)
self.log.log(utils.TRACE, 'Socket data received:\n{}'.format(parsed))
events = deque(maxlen=1000)
# get any segmented event in progress
event, content_size, last_contents = self._segmented
self._segmented = {}, 0, ''
segmented = False
iframe = 0
if content_size: # finish processing segments
contents, segmented, diff, iframe = self.read_contents(
data, 0, content_size)
if segmented:
self._segmented = event, diff, last_contents + contents
return []
else: # all content bytes were retrieved
contents = last_contents + contents
event.update(self.parse_frame(contents))
events.append(event)
event = {}
elif last_contents: # finish segmented non-contents frame
data = last_contents + data
s = data.find('\n\n', iframe)
while s != -1:
frame = data[iframe:s+1]
chunk = self.parse_frame(frame)
event.update(chunk)
iframe = s+2
clen = chunk.get('Content-Length')
if clen:
contents, segmented, diff, iframe = self.read_contents(
data, iframe, clen)
if segmented:
self._segmented = event, diff, contents
break
if contents:
event.update(self.parse_frame(contents))
events.append(event)
event = {}
s = data.find('\n\n', iframe)
else:
remaining = data[iframe:]
if remaining: # segmented non-contents frame
self._segmented = event, 0, remaining
self.process_events(events, parsed)
return events # for testing
def send(self, data):
"""Write raw data to the transport.
"""
msg = (data + '\n'*2).encode()
self.log.log(utils.TRACE, 'Data sent: {!r}'.format(msg))
self.transport.write(msg)
def sendrecv(self, data, resp_type='command/reply', fut=None):
"""Send raw data to the transport and return a future representing
a response.
"""
if not self.connected():
raise ConnectionError("Protocol is not connected")
fut = self.reg_fut(resp_type, fut=fut)
self.send(data)
return fut
def _handle_cmd_resp(self, future):
try:
event = future.result()
except asyncio.CancelledError:
self.log.warning("future cancelled for cmd `{}`"
.format(future.cmd))
return {}
resp = event.get('Body', event.get('Reply-Text', ''))
if not resp:
raise RuntimeError("Missing a response?")
lines = resp.splitlines()
if lines and '-ERR' in lines[-1]:
self.log.error("Event {} reported\n{}".format(event, resp))
return event
def bgapi(self, cmd, errcheck=True):
# TODO: drop ``errcheck`` here - it's legacy and should be the default
future = self.sendrecv('bgapi {}'.format(cmd), resp_type='job/reply')
future.cmd = 'bgapi ' + cmd
if errcheck:
future.add_done_callback(self._handle_cmd_resp)
return future
def api(self, cmd, errcheck=True):
# TODO: drop ``errcheck`` here - it's legacy and should be the default
future = self.sendrecv('api {}'.format(cmd), 'api/response')
future.cmd = 'api ' + cmd
if errcheck:
future.add_done_callback(self._handle_cmd_resp)
return future
def sendmsg(self, uuid, cmd, app, arg='', params='', loops=1):
"""Send a message to the core using a sendmsg packet.
"""
cmd = _sendmsg.format(
uuid=uuid, cmd=cmd, app=app, arg=arg, params=params, loops=loops)
self.log.debug("Sending message:\n{}".format(cmd))
fut = self.sendrecv(cmd)
fut.add_done_callback(self._handle_cmd_resp)
fut.cmd = cmd
return fut
def disconnect(self):
"""Disconnect this protocol.
"""
def shutdown(future):
event = future.result()
reply = event['Reply-Text']
if reply != '+OK bye':
raise ConnectionError("Failed to disconnect with {}"
.format(reply))
self.autorecon = False
exit_resp = self.sendrecv('exit')
exit_resp.add_done_callback(shutdown)
return self._disconnected