BAPSicle/web_server.py

from flask import Flask, render_template, send_from_directory, request, jsonify, abort
from flask_cors import CORS
from setproctitle import setproctitle
import logging
from typing import Any, Optional, List
from multiprocessing.queues import Queue
from queue import Empty
from time import sleep
import json

from helpers.os_environment import isBundelled, isMacOS
from helpers.logging_manager import LoggingManager
from helpers.device_manager import DeviceManager
from helpers.state_manager import StateManager

app = Flask(__name__, static_url_path="")


logger: LoggingManager
server_state: StateManager

api_from_q: Queue
api_to_q: Queue

player_to_q: List[Queue] = []
player_from_q: List[Queue] = []

# General UI Endpoints


@app.errorhandler(404)
def page_not_found(e: Any):
    data = {"ui_page": "404", "ui_title": "404"}
    return render_template("404.html", data=data), 404


@app.route("/")
def ui_index():
    data = {
        "ui_page": "index",
        "ui_title": "",
        "server_version": server_state.state["server_version"],
        "server_build": server_state.state["server_build"],
        "server_name": server_state.state["server_name"],
    }
    return render_template("index.html", data=data)


@app.route("/status")
def ui_status():
    channel_states = []
    for i in range(server_state.state["num_channels"]):
        channel_states.append(status(i))

    data = {"channels": channel_states,
            "ui_page": "status", "ui_title": "Status"}
    return render_template("status.html", data=data)


@app.route("/config/player")
def ui_config_player():
    channel_states = []
    for i in range(server_state.state["num_channels"]):
        channel_states.append(status(i))

    outputs = DeviceManager.getAudioOutputs()

    data = {
        "channels": channel_states,
        "outputs": outputs,
        "ui_page": "config",
        "ui_title": "Player Config",
    }
    return render_template("config_player.html", data=data)


@app.route("/config/server")
def ui_config_server():
    data = {
        "ui_page": "server",
        "ui_title": "Server Config",
        "state": server_state.state,
        "ser_ports": DeviceManager.getSerialPorts(),
    }
    return render_template("config_server.html", data=data)


@app.route("/config/server/update", methods=["POST"])
def ui_config_server_update():
    server_state.update("server_name", request.form["name"])
    server_state.update("host", request.form["host"])
    server_state.update("port", int(request.form["port"]))
    server_state.update("num_channels", int(request.form["channels"]))
    server_state.update("ws_port", int(request.form["ws_port"]))
    server_state.update("serial_port", request.form["serial_port"])

    # Because we're not showing the api key once it's set.
    if "myradio_api_key" in request.form and request.form["myradio_api_key"] != "":
        server_state.update("myradio_api_key", request.form["myradio_api_key"])

    server_state.update("myradio_base_url", request.form["myradio_base_url"])
    server_state.update("myradio_api_url", request.form["myradio_api_url"])
    # stopServer()
    return ui_config_server()


@app.route("/logs")
def ui_logs_list():
    data = {
        "ui_page": "logs",
        "ui_title": "Logs",
        "logs": ["BAPSicleServer"]
        + ["Player{}".format(x) for x in range(server_state.state["num_channels"])],
    }
    return render_template("loglist.html", data=data)


@app.route("/logs/<path:path>")
def ui_logs_render(path):
    log_file = open("logs/{}.log".format(path))
    data = {
        "logs": log_file.read().splitlines(),
        "ui_page": "logs",
        "ui_title": "Logs - {}".format(path),
    }
    log_file.close()
    return render_template("log.html", data=data)


# Player Audio Control Endpoints
# Just useful for messing arround without presenter / websockets.


@app.route("/player/<int:channel>/<command>")
def player_simple(channel: int, command: str):

    simple_endpoints = ["play", "pause", "unpause", "stop", "unload", "clear"]
    if command in simple_endpoints:
        player_to_q[channel].put("UI:" + command.upper())
        return ui_status()

    return page_not_found()


@app.route("/player/<int:channel>/seek/<float:pos>")
def player_seek(channel: int, pos: float):

    player_to_q[channel].put("UI:SEEK:" + str(pos))

    return ui_status()


@app.route("/player/<int:channel>/load/<int:channel_weight>")
def player_load(channel: int, channel_weight: int):

    player_to_q[channel].put("UI:LOAD:" + str(channel_weight))
    return ui_status()


@app.route("/player/<int:channel>/remove/<int:channel_weight>")
def player_remove(channel: int, channel_weight: int):
    player_to_q[channel].put("UI:REMOVE:" + str(channel_weight))

    return ui_status()


@app.route("/player/<int:channel>/output/<name>")
def player_output(channel: int, name: Optional[str]):
    player_to_q[channel].put("UI:OUTPUT:" + str(name))
    return ui_config_player()


@app.route("/player/<int:channel>/autoadvance/<int:state>")
def player_autoadvance(channel: int, state: int):
    player_to_q[channel].put("UI:AUTOADVANCE:" + str(state))
    return ui_status()


@app.route("/player/<int:channel>/repeat/<state>")
def player_repeat(channel: int, state: str):
    player_to_q[channel].put("UI:REPEAT:" + state.upper())
    return ui_status()


@app.route("/player/<int:channel>/playonload/<int:state>")
def player_playonload(channel: int, state: int):
    player_to_q[channel].put("UI:PLAYONLOAD:" + str(state))
    return ui_status()


@app.route("/player/<int:channel>/status")
def player_status_json(channel: int):

    return jsonify(status(channel))


@app.route("/player/all/stop")
def player_all_stop():

    for channel in player_to_q:
        channel.put("UI:STOP")
    return ui_status()


# Show Plan Functions

@app.route("/plan/load/<int:timeslotid>")
def plan_load(timeslotid: int):

    for channel in player_to_q:
        channel.put("UI:GET_PLAN:" + str(timeslotid))

    return ui_status()


@app.route("/plan/clear")
def plan_clear():
    for channel in player_to_q:
        channel.put("UI:CLEAR")
    return ui_status()


# API Proxy Endpoints

@app.route("/plan/list")
def api_list_showplans():

    while not api_from_q.empty():
        api_from_q.get()  # Just waste any previous status responses.

    api_to_q.put("LIST_PLANS")

    while True:
        try:
            response = api_from_q.get_nowait()
            if response.startswith("LIST_PLANS:"):
                response = response[response.index(":") + 1:]
                return response

        except Empty:
            pass

        sleep(0.02)


@app.route("/library/search/<type>")
def api_search_library(type: str):

    if type not in ["managed", "track"]:
        abort(404)

    while not api_from_q.empty():
        api_from_q.get()  # Just waste any previous status responses.

    params = json.dumps(
        {"title": request.args.get(
            "title"), "artist": request.args.get("artist")}
    )
    api_to_q.put("SEARCH_TRACK:{}".format(params))

    while True:
        try:
            response = api_from_q.get_nowait()
            if response.startswith("SEARCH_TRACK:"):
                response = response.split(":", 1)[1]
                return response

        except Empty:
            pass

        sleep(0.02)


@app.route("/library/playlists/<type>")
def api_get_playlists(type: str):

    if type not in ["music", "aux"]:
        abort(401)

    while not api_from_q.empty():
        api_from_q.get()  # Just waste any previous status responses.

    command = "LIST_PLAYLIST_{}".format(type.upper())
    api_to_q.put(command)

    while True:
        try:
            response = api_from_q.get_nowait()
            if response.startswith(command):
                response = response.split(":", 1)[1]
                return response

        except Empty:
            pass

        sleep(0.02)


@app.route("/library/playlist/<type>/<library_id>")
def api_get_playlist(type: str, library_id: str):

    if type not in ["music", "aux"]:
        abort(401)

    while not api_from_q.empty():
        api_from_q.get()  # Just waste any previous status responses.

    command = "GET_PLAYLIST_{}:{}".format(type.upper(), library_id)
    api_to_q.put(command)

    while True:
        try:
            response = api_from_q.get_nowait()
            if response.startswith(command):
                response = response[len(command) + 1:]
                if response == "null":
                    abort(401)
                return response

        except Empty:
            pass

        sleep(0.02)


# JSON Outputs


@app.route("/status-json")
def json_status():
    channel_states = []
    for i in range(server_state.state["num_channels"]):
        channel_states.append(status(i))
    return {"server": server_state.state, "channels": channel_states}


# Get audio for UI to generate waveforms.


@app.route("/audiofile/<type>/<int:id>")
def audio_file(type: str, id: int):
    if type not in ["managed", "track"]:
        abort(404)
    return send_from_directory("music-tmp", type + "-" + str(id) + ".mp3")


# Static Files

@app.route("/favicon.ico")
def serve_favicon():
    return send_from_directory("ui-static", "favicon.ico")


@app.route("/static/<path:path>")
def serve_static(path: str):
    return send_from_directory("ui-static", path)


@app.route("/presenter/")
def serve_presenter_index():
    return send_from_directory("presenter-build", "index.html")


@app.route("/presenter/<path:path>")
def serve_presenter_static(path: str):
    return send_from_directory("presenter-build", path)


# Helper Functions

def status(channel: int):
    while not player_from_q[channel].empty():
        player_from_q[channel].get()  # Just waste any previous status responses.

    player_to_q[channel].put("UI:STATUS")
    retries = 0
    while retries < 40:
        try:
            response = player_from_q[channel].get_nowait()
            if response.startswith("UI:STATUS:"):
                response = response.split(":", 2)[2]
                # TODO: Handle OKAY / FAIL
                response = response[response.index(":") + 1:]
                try:
                    response = json.loads(response)
                except Exception as e:
                    raise e
                return response

        except Empty:
            pass

        retries += 1

        sleep(0.02)

# WebServer Start / Stop Functions


@app.route("/quit")
def quit():
    # stopServer()
    return "Shutting down..."


# Don't use reloader, it causes Nested Processes!
def WebServer(player_to: List[Queue], player_from: List[Queue], api_to: Queue, api_from: Queue, state: StateManager):

    global player_to_q, player_from_q, api_to_q, api_from_q, server_state
    player_to_q = player_to
    player_from_q = player_from
    api_from_q = api_from
    api_to_q = api_to
    server_state = state

    process_title = "WebServer"
    setproctitle(process_title)
    CORS(app, supports_credentials=True)  # Allow ALL CORS!!!

    if not isBundelled():
        log = logging.getLogger("werkzeug")
        log.disabled = True

    app.logger.disabled = True
    app.run(
        host=server_state.state["host"],
        port=server_state.state["port"],
        debug=True,
        use_reloader=False,
        threaded=False  # While API handles are singlethreaded.
    )