import os import sys import json import asyncio import logging import tornado.web import tornado.ioloop import tornado.log import tornado.template import tornado.escape import tornado.locale import tornado.httpserver from app.classes.models.management import HelpersManagement from app.classes.shared.console import Console from app.classes.helpers.helpers import Helpers from app.classes.helpers.file_helpers import FileHelpers from app.classes.shared.main_controller import Controller from app.classes.web.public_handler import PublicHandler from app.classes.web.panel_handler import PanelHandler from app.classes.web.default_handler import DefaultHandler from app.classes.web.routes.api.api_handlers import api_handlers from app.classes.web.routes.metrics.metrics_handlers import metrics_handlers from app.classes.web.server_handler import ServerHandler from app.classes.web.websocket_handler import WebSocketHandler from app.classes.web.static_handler import CustomStaticHandler from app.classes.web.status_handler import StatusHandler logger = logging.getLogger(__name__) class Webserver: controller: Controller helper: Helpers def __init__( self, helper: Helpers, controller: Controller, tasks_manager, file_helper: FileHelpers, ): self.ioloop = None self.https_server = None self.helper = helper self.controller = controller self.tasks_manager = tasks_manager self.file_helper = file_helper self._asyncio_patch() @staticmethod def log_function(handler): info = { "Status_Code": handler.get_status(), "Method": handler.request.method, "URL": handler.request.uri, "Remote_IP": handler.request.remote_ip, # pylint: disable=consider-using-f-string "Elapsed_Time": "%.2fms" % (handler.request.request_time() * 1000), } tornado.log.access_log.info(json.dumps(info, indent=4)) @staticmethod def _asyncio_patch(): """ As of Python 3.8 (on Windows), the asyncio default event handler has changed to "proactor", where tornado expects the "selector" handler. This function checks if the platform is windows and changes the event handler to suit. (Taken from https://github.com/mkdocs/mkdocs/commit/cf2b136d4257787c0de51eba2d9e30ded5245b31) """ logger.debug("Checking if asyncio patch is required") if sys.platform.startswith("win") and sys.version_info >= (3, 8): # pylint: disable=reimported,import-outside-toplevel,redefined-outer-name import asyncio try: from asyncio import WindowsSelectorEventLoopPolicy except ImportError: logger.debug( "asyncio patch isn't required" ) # Can't assign a policy which doesn't exist. else: if not isinstance( asyncio.get_event_loop_policy(), WindowsSelectorEventLoopPolicy ): asyncio.set_event_loop_policy(WindowsSelectorEventLoopPolicy()) logger.debug("Applied asyncio patch") def run_tornado(self): # let's verify we have an SSL cert self.helper.create_self_signed_cert() https_port = self.helper.get_setting("https_port") debug_errors = self.helper.get_setting("show_errors") try: cookie_secret = HelpersManagement.get_cookie_secret() except: cookie_secret = False if cookie_secret is False or cookie_secret == "": cookie_secret = self.helper.random_string_generator(32) HelpersManagement.set_cookie_secret(cookie_secret) if not https_port: https_port = 8443 cert_objects = { "certfile": os.path.join( self.helper.config_dir, "web", "certs", "commander.cert.pem" ), "keyfile": os.path.join( self.helper.config_dir, "web", "certs", "commander.key.pem" ), } logger.info(f"Starting Web Server on ports https:{https_port}") asyncio.set_event_loop(asyncio.new_event_loop()) tornado.template.Loader(".") # TODO: Remove because we don't and won't use tornado.locale.set_default_locale("en_EN") handler_args = { "helper": self.helper, "controller": self.controller, "tasks_manager": self.tasks_manager, "translator": self.helper.translation, "file_helper": self.file_helper, } handlers = [ (r"/", DefaultHandler, handler_args), (r"/panel/(.*)", PanelHandler, handler_args), (r"/server/(.*)", ServerHandler, handler_args), (r"/ws", WebSocketHandler, handler_args), (r"/status", StatusHandler, handler_args), # API Routes V2 *api_handlers(handler_args), # API Routes OpenMetrics *metrics_handlers(handler_args), # Using this one at the end # to catch all the other requests to Public Handler (r"/(.*)", PublicHandler, handler_args), ] app = tornado.web.Application( handlers, template_path=os.path.join(self.helper.webroot, "templates"), static_path=os.path.join(self.helper.webroot, "static"), debug=debug_errors, cookie_secret=cookie_secret, xsrf_cookies=True, autoreload=False, log_function=self.log_function, login_url="/login", default_handler_class=PublicHandler, static_handler_class=CustomStaticHandler, serve_traceback=debug_errors, ) self.https_server = tornado.httpserver.HTTPServer(app, ssl_options=cert_objects) self.https_server.listen(https_port) logger.info( f"https://{Helpers.get_local_ip()}:{https_port} " f"is up and ready for connections." ) Console.info( f"https://{Helpers.get_local_ip()}:{https_port} " f"is up and ready for connections." ) Console.info("Server Init Complete: Listening For Connections!") self.ioloop = tornado.ioloop.IOLoop.current() self.ioloop.start() def stop_web_server(self): logger.info("Shutting Down Web Server") Console.info("Shutting Down Web Server") self.ioloop.stop() self.https_server.stop() logger.info("Web Server Stopped") Console.info("Web Server Stopped")