zynthian_webconf.py

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# ********************************************************************
# ZYNTHIAN PROJECT: Zynthian Web Configurator
#
# Web Service API
#
# Copyright (C) 2015-2017 Fernando Moyano <jofemodo@zynthian.org>
#
# ********************************************************************
#
# 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 2 of
# the License, or 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.
#
# For a full copy of the GNU General Public License see the LICENSE.txt file.
#
# ********************************************************************

import os
import sys
import string
import random
import logging
import asyncio
import tornado.web
import tornado.ioloop
import tornado_xstatic
from terminado import TermSocket, SingleTermManager

# autopep8: off
# TODO: This initialisatoin needs to be here before other imports due to odd dependancies but it shouldn't. Need to fix inappropriate inter-dependancies.
sys.path.append(os.environ.get('ZYNTHIAN_UI_DIR'))
from zyncoder.zyncore import lib_zyncore_init_minimal
lib_zyncore_init_minimal()

from lib.zynterm_handler import ZyntermHandler
from lib.audio_mixer_handler import AudioConfigMessageHandler, AudioMixerHandler
from lib.repository_handler import RepositoryHandler
from lib.midi_log_handler import MidiLogHandler
from lib.ui_log_handler import UiLogHandler
from lib.engines_handler import EnginesHandler
from lib.captures_config_handler import CapturesConfigHandler
from lib.pianoteq_handler import PianoteqHandler
from lib.dsp56300_handler import dsp56300Handler
from lib.zynthian_websocket_handler import ZynthianWebSocketHandler
from lib.presets_config_handler import PresetsConfigHandler
from lib.software_update_handler import SoftwareUpdateHandler
from lib.system_backup_handler import SystemBackupHandler
from lib.upload_handler import UploadHandler
from lib.midi_config_handler import MidiConfigHandler
from lib.snapshot_config_handler import SnapshotConfigHandler, SnapshotRemoveOptionHandler, SnapshotAddOptionsHandler, SnapshotDownloadHandler, SnapshotRemoveChainHandler
from lib.wifi_config_handler import WifiConfigHandler
from lib.hwoptions_config_handler import HWOptionsConfigHandler
from lib.wiring_config_handler import WiringConfigHandler
from lib.kit_config_handler import KitConfigHandler
from lib.ui_keybind_handler import UiKeybindHandler
from lib.ui_config_handler import UiConfigHandler
from lib.security_config_handler import SecurityConfigHandler
from lib.poweroff_handler import PoweroffHandler
from lib.reboot_handler import RebootConfirmedHandler
from lib.reboot_handler import RebootHandler
from lib.display_config_handler import DisplayConfigHandler
from lib.audio_config_handler import AudioConfigHandler
from lib.dashboard_handler import DashboardHandler
from lib.login_handler import LoginHandler, LogoutHandler
# autopep8: on

# ------------------------------------------------------------------------------

MB = 1024 * 1024
GB = 1024 * MB
TB = 1024 * GB
MAX_STREAMED_SIZE = 1*TB

# ------------------------------------------------------------------------------
# Configure Logging
# ------------------------------------------------------------------------------

if os.environ.get('ZYNTHIAN_WEBCONF_LOG_LEVEL'):
    log_level = int(os.environ.get('ZYNTHIAN_WEBCONF_LOG_LEVEL'))
else:
    log_level = logging.WARNING
    # log_level = logging.ERROR

# Set root logging level
logging.basicConfig(format='%(levelname)s:%(module)s: %(message)s',
                    stream=sys.stderr, level=log_level)
logging.getLogger().setLevel(level=log_level)

# ------------------------------------------------------------------------------
# Non cached static files (capture log)
# ------------------------------------------------------------------------------


class CaptureLogStaticFileHandler(tornado.web.StaticFileHandler):
    def set_extra_headers(self, path):
        # Disable cache
        self.set_header('Cache-Control',
                        'no-store, no-cache, must-revalidate, max-age=0')

# ------------------------------------------------------------------------------
# Build Web App & Start Server
# ------------------------------------------------------------------------------


# Try to load from config file. If doesn't exist, generate a new one and save it!
def get_cookie_secret():
    cookie_secret_fpath = "%s/webconf_cookie_secret.txt" % os.environ.get(
        'ZYNTHIAN_CONFIG_DIR')
    try:
        with open(cookie_secret_fpath, "r") as fh:
            cookie_secret = fh.read().strip()
            # logging.info("Cookie Secret: %s" % cookie_secret)
            return cookie_secret
    except:
        cookie_secret = ''.join(random.choice(
            string.ascii_uppercase + string.ascii_lowercase + string.digits) for _ in range(37))
        logging.info("Generated new Cookie Secret: %s" % cookie_secret)
        try:
            with open(cookie_secret_fpath, "w") as fh:
                fh.write(cookie_secret)
                fh.flush()
                os.fsync(fh.fileno())
        except Exception as e:
            logging.error("Can't save cookie secret file '%s': %s" % (
                cookie_secret_fpath, e))
        return cookie_secret


def make_app():
    settings = {
        "xstatic_url": tornado_xstatic.url_maker('/xstatic/'),
        "template_path": "templates",
        "template_whitespace": "single",
        "cookie_secret": get_cookie_secret(),
        "login_url": "/login",
        "upload_progress_handler": dict()
        # "autoescape": None
    }

    return tornado.web.Application([
        (r"/$", DashboardHandler),
        (r"/mockup/capture/(.*\.log)$",
         CaptureLogStaticFileHandler, {'path': 'mockup/capture'}),
        (r"/mockup/(.*)$", tornado.web.StaticFileHandler,
         {'path': 'mockup'}),
        # (r'/()$', tornado.web.StaticFileHandler, {'path': 'html', "default_filename": "index.html"}),
        (r"/(.*\.html)$", tornado.web.StaticFileHandler, {'path': 'html'}),
        (r"/(favicon\.ico)$",
         tornado.web.StaticFileHandler, {'path': 'img'}),
        (r"/fonts/(.*)$", tornado.web.StaticFileHandler,
         {'path': 'fonts'}),
        (r"/img/(.*)$", tornado.web.StaticFileHandler, {'path': 'img'}),
        (r"/css/(.*)$", tornado.web.StaticFileHandler, {'path': 'css'}),
        (r"/js/(.*)$", tornado.web.StaticFileHandler, {'path': 'js'}),
        # (r"/captures/(.*)$", tornado.web.StaticFileHandler, {'path': 'captures'}),
        (r"/bower_components/(.*)$", tornado.web.StaticFileHandler,
         {'path': 'bower_components'}),
        (r"/login", LoginHandler),
        (r"/logout", LogoutHandler),
        (r"/lib-snapshot$", SnapshotConfigHandler),
        (r"/lib-snapshot/ajax/(.*)$", SnapshotConfigHandler),
        (r"/lib-snapshot/download/(.*)$", SnapshotDownloadHandler),
        (r"/lib-snapshot/remove/(.*)/(.*)$", SnapshotRemoveOptionHandler),
        (r"/lib-snapshot/remove-chain/(.*)/(.*)$", SnapshotRemoveChainHandler),
        (r"/lib-snapshot/add/(.*)/(.*)$", SnapshotAddOptionsHandler),
        (r"/lib-presets$", PresetsConfigHandler),
        (r"/lib-presets/(.*)$", PresetsConfigHandler),
        (r"/lib-presets/(.*)/(.*)$", PresetsConfigHandler),
        (r"/lib-captures$", CapturesConfigHandler),
        (r"/hw-kit$", KitConfigHandler),
        (r"/hw-audio$", AudioConfigHandler),
        (r"/hw-audio-mixer$", AudioMixerHandler),
        (r"/hw-audio-mixer/(.*)/(.*)$", AudioMixerHandler),
        (r"/hw-display$", DisplayConfigHandler),
        (r"/hw-wiring$", WiringConfigHandler),
        (r"/hw-options$", HWOptionsConfigHandler),
        (r"/sw-update$", SoftwareUpdateHandler),
        (r"/sw-pianoteq$", PianoteqHandler),
		(r"/sw-dsp56300$", dsp56300Handler),
		(r"/sw-engines$", EnginesHandler),
        (r"/sw-repos$", RepositoryHandler),
        (r"/ui-options$", UiConfigHandler),
        (r"/ui-keybind$", UiKeybindHandler),
        (r"/ui-log$", UiLogHandler),
        (r"/ui-midi-options$", MidiConfigHandler),
        (r"/ui-midi-log$", MidiLogHandler),
        (r"/sys-wifi$", WifiConfigHandler),
        (r"/sys-backup$", SystemBackupHandler),
        (r"/sys-security$", SecurityConfigHandler),
        (r"/sys-reboot$", RebootHandler),
        (r"/sys-reboot/confirmed$", RebootConfirmedHandler),
        (r"/sys-poweroff$", PoweroffHandler),
        (r'/upload$', UploadHandler),
        (r"/ws$", ZynthianWebSocketHandler),
        (r"/zynterm", ZyntermHandler),
        (r"/zynterm_ws", TermSocket, {'term_manager': term_manager}),
        (r"/xstatic/(.*)", tornado_xstatic.XStaticFileHandler,
         {'allowed_modules': ['termjs']})
    ], **settings)


async def amain():
    app = make_app()
    app.listen(os.environ.get('ZYNTHIAN_WEBCONF_PORT', 80),
               max_body_size=MAX_STREAMED_SIZE)
    app.listen(443, max_body_size=MAX_STREAMED_SIZE, ssl_options={
        "certfile": "cert/cert.pem",
        "keyfile": "cert/key.pem"
    })
    await asyncio.Event().wait()


async def ashutdown():
    await term_manager.shutdown()


if __name__ == "__main__":
    try:
        term_manager = SingleTermManager(shell_command=['./zynbash.sh'])
        asyncio.run(amain())
    except KeyboardInterrupt:
        print("Shutting down on SIGINT")
    finally:
        asyncio.run(ashutdown())

# ------------------------------------------------------------------------------