aboutsummaryrefslogtreecommitdiffstats
path: root/fg21sim/webui/app.py
blob: 9f8092e5846655397e1b0373a47c2bb29849e9ee (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# Copyright (c) 2016 Weitian LI <liweitianux@live.com>
# MIT license

"""
Web user interface (UI) of "fg21sim" based upon Tornado_ web server and
using the WebSocket_ protocol.

.. _Tornado: http://www.tornadoweb.org/

.. _WebSocket: https://en.wikipedia.org/wiki/WebSocket ,
   http://caniuse.com/#feat=websockets
"""

import os

import tornado.web
from tornado.web import url

from .handlers import IndexHandler, LoginHandler, WSHandler
from .utils import gen_cookie_secret
from ..configs import ConfigManager


class Application(tornado.web.Application):
    """
    Application of the "fg21sim" Web UI.

    Attributes
    ----------
    configmanager : `~fg21sim.configs.ConfigManager`
        A ``ConfigManager`` instance, which saves the current configurations
        status.  The configuration operations (e.g., "set", "get", "load")
        are performed on this instance, which is also passed to the
        foregrounds simulation programs.
    ws_clients : set
        Current connected clients through WebSocket.
        When a new WebSocket connection established, it is added to this
        list, which is also removed from this list when the connection lost.
    """

    def __init__(self, **kwargs):
        self.configmanager = ConfigManager()
        self.ws_clients = set()
        # URL handlers
        handlers = [
            url(r"/", IndexHandler, name="index"),
            url(r"/login", LoginHandler, name="login"),
            url(r"/ws", WSHandler),
        ]
        # Application settings
        settings = {
            # The static files will be served from the default "/static/" URI.
            # Recommend to use `{{ static_url(filepath) }}` in the templates.
            "static_path": os.path.join(os.path.dirname(__file__),
                                        "static"),
            "template_path": os.path.join(os.path.dirname(__file__),
                                          "templates"),
            # URL to be redirected to if the user is not logged in
            "login_url": r"/login",
            # Secret key used to sign the cookies
            "cookie_secret": gen_cookie_secret(),
            # Enable "cross-site request forgery" (XSRF)
            "xsrf_cookies": True,
        }
        settings.update(kwargs)
        super().__init__(handlers, **settings)