Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support JSONP #98

Closed
wants to merge 2 commits into from
+163 −103
Closed

Support JSONP #98

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
155331d
Add JSONP support for Server
StoneMoe Feb 27, 2019
43f8fb5
Add JSONP support for AsyncServer
StoneMoe Feb 27, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 67 additions & 49 deletions engineio/asyncio_server.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,65 +181,82 @@ async def handle_request(self, *args, **kwargs):
environ = translate_request(*args, **kwargs)
method = environ['REQUEST_METHOD']
query = urllib.parse.parse_qs(environ.get('QUERY_STRING', ''))

sid = query['sid'][0] if 'sid' in query else None
b64 = False
jsonp = False
jsonp_index = None

if 'b64' in query:
if query['b64'][0] == "1" or query['b64'][0].lower() == "true":
b64 = True
if 'j' in query:
self.logger.warning('JSONP requests are not supported')
r = self._bad_request()
else:
sid = query['sid'][0] if 'sid' in query else None
b64 = False
if 'b64' in query:
if query['b64'][0] == "1" or query['b64'][0].lower() == "true":
b64 = True
if method == 'GET':
if sid is None:
transport = query.get('transport', ['polling'])[0]
if transport != 'polling' and transport != 'websocket':
self.logger.warning('Invalid transport %s', transport)
r = self._bad_request()
else:
r = await self._handle_connect(environ, transport,
b64)
jsonp = True
try:
jsonp_index = int(query['j'][0])
except (ValueError, KeyError, IndexError):
# Invalid JSONP index number
pass

if method == 'GET':
if sid is None:
transport = query.get('transport', ['polling'])[0]
if transport != 'polling' and transport != 'websocket':
self.logger.warning('Invalid transport %s', transport)
r = self._bad_request()
elif jsonp is True and jsonp_index is None:
self.logger.warning('Invalid JSONP index number')
r = self._bad_request()
else:
if sid not in self.sockets:
self.logger.warning('Invalid session %s', sid)
r = self._bad_request()
else:
socket = self._get_socket(sid)
try:
packets = await socket.handle_get_request(environ)
if isinstance(packets, list):
r = self._ok(packets, b64=b64)
else:
r = packets
except exceptions.EngineIOError:
if sid in self.sockets: # pragma: no cover
await self.disconnect(sid)
r = self._bad_request()
if sid in self.sockets and self.sockets[sid].closed:
del self.sockets[sid]
elif method == 'POST':
if sid is None or sid not in self.sockets:
r = await self._handle_connect(environ, transport,
b64, jsonp_index)
else:
if sid not in self.sockets:
self.logger.warning('Invalid session %s', sid)
r = self._bad_request()
elif jsonp is True and jsonp_index is None:
self.logger.warning('Invalid JSONP index number')
r = self._bad_request()
else:
socket = self._get_socket(sid)
try:
await socket.handle_post_request(environ)
r = self._ok()
packets = await socket.handle_get_request(environ)
if isinstance(packets, list):
r = self._ok(packets, b64=b64, jsonp_index=jsonp_index)
else:
r = packets
except exceptions.EngineIOError:
if sid in self.sockets: # pragma: no cover
await self.disconnect(sid)
r = self._bad_request()
except: # pragma: no cover
# for any other unexpected errors, we log the error
# and keep going
self.logger.exception('post request handler error')
r = self._ok()
elif method == 'OPTIONS':
r = self._ok()
if sid in self.sockets and self.sockets[sid].closed:
del self.sockets[sid]
elif method == 'POST':
if sid is None or sid not in self.sockets:
self.logger.warning('Invalid session %s', sid)
r = self._bad_request()
elif jsonp is True and jsonp_index is None:
self.logger.warning('Invalid JSONP index number')
r = self._bad_request()
else:
self.logger.warning('Method %s not supported', method)
r = self._method_not_found()
socket = self._get_socket(sid)
try:
await socket.handle_post_request(environ)
r = self._ok(jsonp_index=jsonp_index)
except exceptions.EngineIOError:
if sid in self.sockets: # pragma: no cover
await self.disconnect(sid)
r = self._bad_request()
except: # pragma: no cover
# for any other unexpected errors, we log the error
# and keep going
self.logger.exception('post request handler error')
r = self._ok(jsonp_index=jsonp_index)
elif method == 'OPTIONS':
r = self._ok()
else:
self.logger.warning('Method %s not supported', method)
r = self._method_not_found()
if not isinstance(r, dict):
return r if r is not None else []
if self.http_compression and \
Expand Down Expand Up @@ -320,7 +337,7 @@ def create_event(self, *args, **kwargs):
"""
return asyncio.Event(*args, **kwargs)

async def _handle_connect(self, environ, transport, b64=False):
async def _handle_connect(self, environ, transport, b64=False, jsonp_index=None):
"""Handle a client connection request."""
if self.start_service_task:
# start the service task to monitor connected clients
Expand All @@ -329,6 +346,7 @@ async def _handle_connect(self, environ, transport, b64=False):

sid = self._generate_id()
s = asyncio_socket.AsyncSocket(self, sid)
s.jsonp_index = jsonp_index
self.sockets[sid] = s

pkt = packet.Packet(
Expand Down Expand Up @@ -357,7 +375,7 @@ async def _handle_connect(self, environ, transport, b64=False):
if self.cookie:
headers = [('Set-Cookie', self.cookie + '=' + sid)]
try:
return self._ok(await s.poll(), headers=headers, b64=b64)
return self._ok(await s.poll(), headers=headers, b64=b64, jsonp_index=jsonp_index)
except exceptions.QueueEmpty:
return self._bad_request()

Expand Down
14 changes: 13 additions & 1 deletion engineio/payload.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

from . import packet

from six.moves import urllib


class Payload(object):
"""Engine.IO payload."""
Expand All @@ -10,7 +12,7 @@ def __init__(self, packets=None, encoded_payload=None):
if encoded_payload is not None:
self.decode(encoded_payload)

def encode(self, b64=False):
def encode(self, b64=False, jsonp_index=None):
"""Encode the payload for transmission."""
encoded_payload = b''
for pkt in self.packets:
Expand All @@ -29,12 +31,22 @@ def encode(self, b64=False):
else:
encoded_payload += b'\1'
encoded_payload += binary_len + b'\xff' + encoded_packet
if jsonp_index is not None:
encoded_payload = b'___eio[' + \
str(jsonp_index).encode() + \
b']("' + \
encoded_payload.replace(b'"', b'\\"') + \
b'");'
return encoded_payload

def decode(self, encoded_payload):
"""Decode a transmitted payload."""
self.packets = []
while encoded_payload:
# JSONP POST payload starts with 'd='
if encoded_payload.startswith(b'd='):
encoded_payload = urllib.parse.parse_qs(encoded_payload)[b'd'][0]

if six.byte2int(encoded_payload[0:1]) <= 1:
packet_len = 0
i = 1
Expand Down
123 changes: 71 additions & 52 deletions engineio/server.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -311,66 +311,84 @@ def handle_request(self, environ, start_response):
"""
method = environ['REQUEST_METHOD']
query = urllib.parse.parse_qs(environ.get('QUERY_STRING', ''))

sid = query['sid'][0] if 'sid' in query else None
b64 = False
jsonp = False
jsonp_index = None

if 'b64' in query:
if query['b64'][0] == "1" or query['b64'][0].lower() == "true":
b64 = True
if 'j' in query:
self.logger.warning('JSONP requests are not supported')
r = self._bad_request()
else:
sid = query['sid'][0] if 'sid' in query else None
b64 = False
if 'b64' in query:
if query['b64'][0] == "1" or query['b64'][0].lower() == "true":
b64 = True
if method == 'GET':
if sid is None:
transport = query.get('transport', ['polling'])[0]
if transport != 'polling' and transport != 'websocket':
self.logger.warning('Invalid transport %s', transport)
r = self._bad_request()
else:
r = self._handle_connect(environ, start_response,
transport, b64)
jsonp = True
try:
jsonp_index = int(query['j'][0])
except (ValueError, KeyError, IndexError):
# Invalid JSONP index number
pass

if method == 'GET':
if sid is None:
transport = query.get('transport', ['polling'])[0]
if transport != 'polling' and transport != 'websocket':
self.logger.warning('Invalid transport %s', transport)
r = self._bad_request()
elif jsonp is True and jsonp_index is None:
self.logger.warning('Invalid JSONP index number')
r = self._bad_request()
else:
if sid not in self.sockets:
self.logger.warning('Invalid session %s', sid)
r = self._bad_request()
else:
socket = self._get_socket(sid)
try:
packets = socket.handle_get_request(
environ, start_response)
if isinstance(packets, list):
r = self._ok(packets, b64=b64)
else:
r = packets
except exceptions.EngineIOError:
if sid in self.sockets: # pragma: no cover
self.disconnect(sid)
r = self._bad_request()
if sid in self.sockets and self.sockets[sid].closed:
del self.sockets[sid]
elif method == 'POST':
if sid is None or sid not in self.sockets:
r = self._handle_connect(environ, start_response,
transport, b64, jsonp_index)
else:
if sid not in self.sockets:
self.logger.warning('Invalid session %s', sid)
r = self._bad_request()
elif jsonp is True and jsonp_index is None:
self.logger.warning('Invalid JSONP index number')
r = self._bad_request()
else:
socket = self._get_socket(sid)
try:
socket.handle_post_request(environ)
r = self._ok()
packets = socket.handle_get_request(
environ, start_response)
if isinstance(packets, list):
r = self._ok(packets, b64=b64, jsonp_index=jsonp_index)
else:
r = packets
except exceptions.EngineIOError:
if sid in self.sockets: # pragma: no cover
self.disconnect(sid)
r = self._bad_request()
except: # pragma: no cover
# for any other unexpected errors, we log the error
# and keep going
self.logger.exception('post request handler error')
r = self._ok()
elif method == 'OPTIONS':
r = self._ok()
if sid in self.sockets and self.sockets[sid].closed:
del self.sockets[sid]
elif method == 'POST':
if sid is None or sid not in self.sockets:
self.logger.warning('Invalid session %s', sid)
r = self._bad_request()
elif jsonp is True and jsonp_index is None:
self.logger.warning('Invalid JSONP index number')
r = self._bad_request()
else:
self.logger.warning('Method %s not supported', method)
r = self._method_not_found()
socket = self._get_socket(sid)
try:
socket.handle_post_request(environ)
r = self._ok(jsonp_index=jsonp_index)
except exceptions.EngineIOError:
if sid in self.sockets: # pragma: no cover
self.disconnect(sid)
r = self._bad_request()
except: # pragma: no cover
# for any other unexpected errors, we log the error
# and keep going
self.logger.exception('post request handler error')
r = self._ok(jsonp_index=jsonp_index)
elif method == 'OPTIONS':
r = self._ok()
else:
self.logger.warning('Method %s not supported', method)
r = self._method_not_found()

if not isinstance(r, dict):
return r or []
if self.http_compression and \
Expand Down Expand Up @@ -447,7 +465,7 @@ def _generate_id(self):
"""Generate a unique session id."""
return uuid.uuid4().hex

def _handle_connect(self, environ, start_response, transport, b64=False):
def _handle_connect(self, environ, start_response, transport, b64=False, jsonp_index=None):
"""Handle a client connection request."""
if self.start_service_task:
# start the service task to monitor connected clients
Expand All @@ -456,6 +474,7 @@ def _handle_connect(self, environ, start_response, transport, b64=False):

sid = self._generate_id()
s = socket.Socket(self, sid)
s.jsonp_index = jsonp_index
self.sockets[sid] = s

pkt = packet.Packet(
Expand Down Expand Up @@ -483,7 +502,7 @@ def _handle_connect(self, environ, start_response, transport, b64=False):
if self.cookie:
headers = [('Set-Cookie', self.cookie + '=' + sid)]
try:
return self._ok(s.poll(), headers=headers, b64=b64)
return self._ok(s.poll(), headers=headers, b64=b64, jsonp_index=jsonp_index)
except exceptions.QueueEmpty:
return self._bad_request()

Expand Down Expand Up @@ -521,7 +540,7 @@ def _get_socket(self, sid):
raise KeyError('Session is disconnected')
return s

def _ok(self, packets=None, headers=None, b64=False):
def _ok(self, packets=None, headers=None, b64=False, jsonp_index=None):
"""Generate a successful HTTP response."""
if packets is not None:
if headers is None:
Expand All @@ -532,7 +551,7 @@ def _ok(self, packets=None, headers=None, b64=False):
headers += [('Content-Type', 'application/octet-stream')]
return {'status': '200 OK',
'headers': headers,
'response': payload.Payload(packets=packets).encode(b64)}
'response': payload.Payload(packets=packets).encode(b64, jsonp_index)}
else:
return {'status': '200 OK',
'headers': [('Content-Type', 'text/plain')],
Expand Down
1 change: 1 addition & 0 deletions engineio/socket.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ def __init__(self, server, sid):
self.closing = False
self.closed = False
self.session = {}
self.jsonp_index = None

def poll(self):
"""Wait for packets to send to the client."""
Expand Down
Loading