import logging as log
from CoreLayer import Core
from tornado.ioloop import IOLoop
from CoreLayer import AccessLayer
from CoreLayer import UtilityLayer
from tornado.web import Application
from CoreLayer.AccessLayer import StaticHandler
[docs]class Webserver(object):
""" Starts the :class:`CoreLayer.Core` and tornado web app.
Sends the ``db`` argument to the new :class:`CoreLayer.Core`.
Arguments
-----------
db : :data:`bfly.Butterfly._db_type`
A fully-loaded database
config: dict
Used in :class:`AccessLayer.RequestHandler`
Attributes
------------
_db: :data:`bfly.Butterfly._db_type`
Taken from first argument ``db``
_core: :class:`CoreLayer.Core`
Also given the ``db`` argument
RUNTIME: :class:`RUNTIME`
Shared runtime instance with :data:`_db`
_webapp: :class:`tornado.web.Application`
Allow access to content at /api and /ocp \
with :class:`API` and :class:`OCP`
_server: :class:`tornado.web.Application.IOLoop`
Allows us to stop the :data:`webapp`. \
It is the :data:`webapp`'s IOLoop instance. \
Only set after :meth:`start` starts :data:`_webapp`.
_port: int
Only set after port passed to :meth:`start`
"""
#: Max bytes of memory for :data:`_webapp`
_maxbuffer = 1024 * 1024 * 200
def __init__(self, db, config):
# Create a core with a database
self.RUNTIME = db.RUNTIME
self._core = Core(db)
self._db = db
# Arguments for data and info requests
app_in = {
'_config': config,
'_core': self._core,
'_root': __name__,
'_db': self._db,
}
# Arguments for static requests
stat_in = {
'_root': __name__
}
# Set for entire webapp
app_set = {
'autoreload': UtilityLayer.DEV_MODE
}
# Create the webapp with both access layers
self._webapp = Application([
(r'/api/(.*)', AccessLayer.API, app_in),
(r'/nd/(.*)', AccessLayer.NDStore, app_in),
(r'/ws/(.*)', AccessLayer.Websocket, app_in),
(r'/pre/(.*)', AccessLayer.Precomputed, app_in),
# A file requested from root of static,
# Or a file requested from a static folder
(r'/([^/]*\..*)?', StaticHandler, stat_in),
(r'/(shaders/.*)', StaticHandler, stat_in),
(r'/(meshes/.*)', StaticHandler, stat_in),
(r'/(images/.*)', StaticHandler, stat_in),
(r'/(style/.*)', StaticHandler, stat_in),
(r'/(index/.*)', StaticHandler, stat_in),
(r'/(ng/.*)', StaticHandler, stat_in),
(r'/(viz/.*)', StaticHandler, stat_in),
(r'/(x3d/.*)', StaticHandler, stat_in),
], **app_set)
[docs] def start(self, _port):
""" Starts the :data:`_webapp` on the given port
Sets two new class attributes:
* :data:`_port` taken from the ``port`` argument
* :data:`_server` needed to stop the :data:`_webapp`
Arguments
-----------
_port: int
The port number to serve all entry points
Returns
---------
tornado.IOLoop
The :data:`_server` needed to stop the :data:`_webapp`
"""
app_start = {
'max_buffer_size': self._maxbuffer
}
self._port = _port
# Begin to serve the web application
self._webapp.listen(_port, **app_start)
self._server = IOLoop.instance()
# Send the logging message
msg = """
*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*
Start server on port {0}.
_______________________________
"""
log.critical(msg.format(_port))
# Return the webserver
return self._server
[docs] def stop(self):
""" Stops the :data:`_webapp`.
Adds a :data:`_server``.``stop`` callback to :data:`_server`. \
This stops :data:`_server`, which is \
also known as the :data:`_webapp`'s IOLoop.
Arguments
-----------
_port: int
The port number to serve all entry points. \
Also sets the class attribute :data:`_port`
"""
# Ask tornado to stop
ioloop = self._server
ioloop.add_callback(ioloop.stop)
# Send the stop message
msg = """
|||||||||||||||||||||||||||||||
Stop server on port {0}.
*~*~*~*~*~*~*~*~*~*~*~*~*~*~*~*
"""
log.critical(msg.format(self._port))
