1
0
mirror of https://github.com/GNS3/gns3-server synced 2024-11-28 19:28:07 +00:00
gns3-server/gns3server/web/web_server.py

241 lines
7.8 KiB
Python
Raw Normal View History

# -*- coding: utf-8 -*-
#
2015-01-14 00:05:26 +00:00
# Copyright (C) 2015 GNS3 Technologies Inc.
#
# This program 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.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
2013-12-06 04:39:27 +00:00
"""
Set up and run the server.
2013-12-06 04:39:27 +00:00
"""
import os
2015-01-14 00:05:26 +00:00
import sys
import signal
2015-01-14 00:05:26 +00:00
import asyncio
import aiohttp
import functools
import types
import time
import atexit
from .route import Route
from .request_handler import RequestHandler
from ..config import Config
2016-04-15 15:57:06 +00:00
from ..compute import MODULES
from ..compute.port_manager import PortManager
2016-04-19 13:35:50 +00:00
from ..controller import Controller
# do not delete this import
import gns3server.handlers
2015-01-14 00:05:26 +00:00
import logging
log = logging.getLogger(__name__)
class WebServer:
def __init__(self, host, port):
self._host = host
self._port = port
2015-01-14 00:05:26 +00:00
self._loop = None
self._handler = None
2015-01-14 00:05:26 +00:00
self._start_time = time.time()
self._port_manager = PortManager(host)
@staticmethod
def instance(host=None, port=None):
"""
Singleton to return only one instance of Server.
:returns: instance of Server
"""
if not hasattr(WebServer, "_instance") or WebServer._instance is None:
assert host is not None
assert port is not None
WebServer._instance = WebServer(host, port)
return WebServer._instance
2015-01-14 00:05:26 +00:00
@asyncio.coroutine
def _run_application(self, handler, ssl_context=None):
2015-01-14 00:05:26 +00:00
try:
server = yield from self._loop.create_server(handler, self._host, self._port, ssl=ssl_context)
except OSError as e:
log.critical("Could not start the server: {}".format(e))
self._loop.stop()
return
2015-01-14 00:05:26 +00:00
return server
@asyncio.coroutine
def shutdown_server(self):
2013-12-06 04:39:27 +00:00
"""
Cleanly shutdown the server.
"""
if self._handler:
yield from self._handler.finish_connections()
self._handler = None
2015-01-22 10:49:22 +00:00
for module in MODULES:
log.debug("Unloading module {}".format(module.__name__))
m = module.instance()
yield from m.unload()
if self._port_manager.tcp_ports:
log.warning("TCP ports are still used {}".format(self._port_manager.tcp_ports))
if self._port_manager.udp_ports:
log.warning("UDP ports are still used {}".format(self._port_manager.udp_ports))
for task in asyncio.Task.all_tasks():
task.cancel()
2015-01-14 00:05:26 +00:00
self._loop.stop()
def _signal_handling(self):
2015-01-14 00:05:26 +00:00
def signal_handler(signame):
2015-01-20 13:59:19 +00:00
log.warning("Server has got signal {}, exiting...".format(signame))
asyncio.async(self.shutdown_server())
2015-01-14 00:05:26 +00:00
signals = ["SIGTERM", "SIGINT"]
if sys.platform.startswith("win"):
signals.extend(["SIGBREAK"])
else:
signals.extend(["SIGHUP", "SIGQUIT"])
2015-01-14 00:05:26 +00:00
for signal_name in signals:
callback = functools.partial(signal_handler, signal_name)
2015-01-14 00:05:26 +00:00
if sys.platform.startswith("win"):
# add_signal_handler() is not yet supported on Windows
signal.signal(getattr(signal, signal_name), callback)
else:
self._loop.add_signal_handler(getattr(signal, signal_name), callback)
2015-01-24 19:11:51 +00:00
def _create_ssl_context(self, server_config):
import ssl
ssl_context = ssl.SSLContext(ssl.PROTOCOL_SSLv23)
certfile = server_config["certfile"]
certkey = server_config["certkey"]
try:
ssl_context.load_cert_chain(certfile, certkey)
except FileNotFoundError:
log.critical("Could not find the SSL certfile or certkey")
raise SystemExit
except ssl.SSLError as e:
log.critical("SSL error: {}".format(e))
raise SystemExit
log.info("SSL is enabled")
2015-01-24 19:11:51 +00:00
return ssl_context
2015-02-20 21:40:20 +00:00
@asyncio.coroutine
def start_shell(self):
2015-02-24 00:08:34 +00:00
try:
from ptpython.repl import embed
except ImportError:
log.error("Unable to start a shell: the ptpython module must be installed!")
return
2015-02-20 21:40:20 +00:00
yield from embed(globals(), locals(), return_asyncio_coroutine=True, patch_stdout=True)
def _exit_handling(self):
"""
Makes sure the asyncio loop is closed.
"""
def close_asyncio_loop():
loop = None
try:
loop = asyncio.get_event_loop()
except AttributeError:
pass
if loop is not None:
loop.close()
atexit.register(close_asyncio_loop)
def run(self):
"""
2015-01-14 00:05:26 +00:00
Starts the server.
"""
2015-01-20 22:28:40 +00:00
logger = logging.getLogger("asyncio")
2015-10-14 16:10:05 +00:00
logger.setLevel(logging.ERROR)
2015-01-20 22:28:40 +00:00
2015-01-24 19:11:51 +00:00
server_config = Config.instance().get_section_config("Server")
if sys.platform.startswith("win"):
# use the Proactor event loop on Windows
loop = asyncio.ProactorEventLoop()
# Add a periodic callback to give a chance to process signals on Windows
# because asyncio.add_signal_handler() is not supported yet on that platform
# otherwise the loop runs outside of signal module's ability to trap signals.
def wakeup():
loop.call_later(0.5, wakeup)
loop.call_later(0.5, wakeup)
asyncio.set_event_loop(loop)
2015-01-24 19:11:51 +00:00
ssl_context = None
if server_config.getboolean("ssl"):
if sys.platform.startswith("win"):
log.critical("SSL mode is not supported on Windows")
raise SystemExit
ssl_context = self._create_ssl_context(server_config)
2015-01-14 00:05:26 +00:00
self._loop = asyncio.get_event_loop()
# Asyncio will raise error if coroutine is not called
self._loop.set_debug(True)
2016-04-19 13:35:50 +00:00
if server_config.getboolean("controller"):
asyncio.async(Controller.instance().load())
for key, val in os.environ.items():
log.debug("ENV %s=%s", key, val)
2015-01-14 00:05:26 +00:00
app = aiohttp.web.Application()
for method, route, handler in Route.get_routes():
2015-01-20 13:59:19 +00:00
log.debug("Adding route: {} {}".format(method, route))
2015-01-14 00:05:26 +00:00
app.router.add_route(method, route, handler)
for module in MODULES:
2015-01-20 13:59:19 +00:00
log.debug("Loading module {}".format(module.__name__))
2015-01-15 15:59:01 +00:00
m = module.instance()
m.port_manager = self._port_manager
2015-01-20 13:59:19 +00:00
log.info("Starting server on {}:{}".format(self._host, self._port))
self._handler = app.make_handler(handler=RequestHandler)
server = self._run_application(self._handler, ssl_context)
self._loop.run_until_complete(server)
self._signal_handling()
self._exit_handling()
2015-02-20 21:40:20 +00:00
if server_config.getboolean("shell"):
asyncio.async(self.start_shell())
try:
self._loop.run_forever()
except TypeError as e:
# This is to ignore an asyncio.windows_events exception
# on Windows when the process gets the SIGBREAK signal
# TypeError: async() takes 1 positional argument but 3 were given
log.warning("TypeError exception in the loop {}".format(e))
finally:
if self._handler and self._loop.is_running():
self._loop.run_until_complete(self._handler.finish_connections())
server.close()
if self._loop.is_running():
self._loop.run_until_complete(app.finish())