Source code for automate.extensions.wsgi.abstractwsgi

# -*- coding: utf-8 -*-
# (c) 2015 Tuomas Airaksinen
# This file is part of automate-wsgi.
# automate-wsgi is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
# automate-wsgi is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with automate-wsgi.  If not, see <>.

from __future__ import unicode_literals
import threading
import socket

import tornado
import tornado.wsgi
import tornado.httpserver
import tornado.ioloop
import tornado.web
import tornado.websocket

from traits.api import Instance, Int, CStr, Dict, Str

from automate.common import threaded
from automate.service import AbstractUserService

web_thread = None

[docs]class TornadoService(AbstractUserService): """ Abstract service that provides HTTP server for WSGI applications. """ #: Which ip address to listen. Use ```` (default) to listen to all local networking interfaces. http_ipaddr = CStr("") #: HTTP (or HTTPS if using SSL) port to listen http_port = Int(3000) #: Path to ssl certificate file. If set, SSL will be used. #: #: .. tip:: #: #: You may use script scripts/ to generate a #: self-signed openssl certificate. ssl_certificate = CStr #: Path to ssl private key file ssl_private_key = CStr #: Number of listener threads to spawn num_threads = Int(5) #: Extra static dirs you want to serve. Example:: #: #: static_dirs = {'/my_static/(.*)': '/path/to/my_static'} static_dirs = Dict(key_trait=Str, value_trait=Str) _http_server = Instance(tornado.httpserver.TCPServer) @property def is_alive(self): return bool(self._http_server)
[docs] def get_wsgi_application(self): """ Get WSGI function. Implement this in subclasses. """ raise NotImplementedError
def get_websocket(self): return None def get_filehandler_class(self): return tornado.web.StaticFileHandler def get_tornado_handlers(self): tornado_handlers = [] websocket = self.get_websocket() if websocket: tornado_handlers.append(('/socket', websocket)) for entrypoint, path in self.static_dirs.items(): tornado_handlers.append((entrypoint, self.get_filehandler_class(), {'path': path})) wsgi_app = self.get_wsgi_application() if wsgi_app: wsgi_container = tornado.wsgi.WSGIContainer(wsgi_app) tornado_handlers.append(('.*', tornado.web.FallbackHandler, dict(fallback=wsgi_container))) return tornado_handlers def setup(self): if self.is_alive: self.logger.debug('Server is already running, no need to start new') tornado_app = tornado.web.Application(self.get_tornado_handlers()) if self.ssl_certificate and self.ssl_private_key: ssl_options = { "certfile": self.ssl_certificate, "keyfile": self.ssl_private_key, } else: ssl_options = None self._http_server = tornado.httpserver.HTTPServer(tornado_app, ssl_options=ssl_options) try: self._http_server.listen(self.http_port, self.http_ipaddr) except socket.error as e: self.logger.error('Could not start server: %s', e) self._http_server = None return self.start_ioloop() def start_ioloop(self): global web_thread ioloop = tornado.ioloop.IOLoop.instance() if not ioloop._running: web_thread = threading.Thread(target=threaded(ioloop.start), name="%s::%s" % (, self.__class__.__name__)) web_thread.start() def cleanup(self): if self.is_alive: tornado.ioloop.IOLoop.instance().stop() self._http_server.stop() self._http_server = None web_thread.join()