From 5351405f1c6ad218f65ab87683404a4540871373 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Lebleu?= Date: Thu, 12 Jun 2014 16:19:43 +0200 Subject: [PATCH] [fix] Do not install /messages route if WebSocket is disabled --- moulinette/__init__.py | 9 +++++---- moulinette/interfaces/api.py | 25 ++++++++++++++++--------- 2 files changed, 21 insertions(+), 13 deletions(-) diff --git a/moulinette/__init__.py b/moulinette/__init__.py index 88f17212..698cda5e 100755 --- a/moulinette/__init__.py +++ b/moulinette/__init__.py @@ -82,10 +82,11 @@ def api(namespaces, host='localhost', port=80, routes={}, """ moulinette = init_interface('api', - kwargs={'routes': routes}, - actionsmap={'namespaces': namespaces, - 'use_cache': use_cache}) - moulinette.run(host, port, use_websocket) + kwargs={ 'routes': routes, + 'use_websocket': use_websocket }, + actionsmap={ 'namespaces': namespaces, + 'use_cache': use_cache }) + moulinette.run(host, port) def cli(namespaces, args, print_json=False, use_cache=True): """Command line interface diff --git a/moulinette/interfaces/api.py b/moulinette/interfaces/api.py index ad6334d5..d1c1038a 100644 --- a/moulinette/interfaces/api.py +++ b/moulinette/interfaces/api.py @@ -102,17 +102,21 @@ class _ActionsMapPlugin(object): Keyword arguments: - actionsmap -- An ActionsMap instance + - use_websocket -- If true, install a WebSocket on /messages in order + to serve messages coming from the 'display' signal """ name = 'actionsmap' api = 2 - def __init__(self, actionsmap): + def __init__(self, actionsmap, use_websocket): # Connect signals to handlers msignals.set_handler('authenticate', self._do_authenticate) - msignals.set_handler('display', self._do_display) + if use_websocket: + msignals.set_handler('display', self._do_display) self.actionsmap = actionsmap + self.use_websocket = use_websocket # TODO: Save and load secrets? self.secrets = {} self.queues = {} @@ -159,8 +163,9 @@ class _ActionsMapPlugin(object): callback=self.logout, skip=['actionsmap'], apply=_logout) # Append messages route - app.route('/messages', name='messages', - callback=self.messages, skip=['actionsmap']) + if self.use_websocket: + app.route('/messages', name='messages', + callback=self.messages, skip=['actionsmap']) # Append routes from the actions map for (m, p) in self.actionsmap.parser.routes: @@ -575,9 +580,12 @@ class Interface(BaseInterface): - actionsmap -- The ActionsMap instance to connect to - routes -- A dict of additional routes to add in the form of {(method, path): callback} + - use_websocket -- Serve via WSGI to handle asynchronous responses """ - def __init__(self, actionsmap, routes={}): + def __init__(self, actionsmap, routes={}, use_websocket=True): + self.use_websocket = use_websocket + # TODO: Return OK to 'OPTIONS' xhr requests (l173) app = Bottle(autojson=True) @@ -600,7 +608,7 @@ class Interface(BaseInterface): # Install plugins app.install(apiheader) app.install(api18n) - app.install(_ActionsMapPlugin(actionsmap)) + app.install(_ActionsMapPlugin(actionsmap, use_websocket)) # Append default routes # app.route(['/api', '/api/'], method='GET', @@ -613,7 +621,7 @@ class Interface(BaseInterface): self._app = app - def run(self, host='localhost', port=80, use_websocket=True): + def run(self, host='localhost', port=80): """Run the moulinette Start a server instance on the given port to serve moulinette @@ -622,11 +630,10 @@ class Interface(BaseInterface): Keyword arguments: - host -- Server address to bind to - port -- Server port to bind to - - use_websocket -- Serve via WSGI to handle asynchronous responses """ try: - if use_websocket: + if self.use_websocket: from gevent.pywsgi import WSGIServer from geventwebsocket.handler import WebSocketHandler