libretime/playout/libretime_playout/notify/main.py

"""
Python part of radio playout (pypo)

This function acts as a gateway between liquidsoap and the server API.
Mainly used to tell the platform what pypo/liquidsoap does.

Main case:
 - whenever LS starts playing a new track, its on_metadata callback calls
   a function in ls (notify(m)) which then calls the python script here
   with the currently starting filename as parameter
 - this python script takes this parameter, tries to extract the actual
   media id from it, and then calls back to the API to tell about it about it.

"""

import logging
from pathlib import Path
from typing import Literal, Optional

import click
from libretime_api_client.v1 import ApiClient as LegacyClient
from libretime_shared.cli import cli_config_options, cli_logging_options
from libretime_shared.config import DEFAULT_ENV_PREFIX
from libretime_shared.logging import setup_logger

from ..config import Config

logger = logging.getLogger(__name__)


# pylint: disable=too-few-public-methods
class App:
    config: Config
    api_client: LegacyClient

    def __init__(self, config: Config) -> None:
        self.config = config
        self.api_client = LegacyClient(
            base_url=config.general.public_url,
            api_key=config.general.api_key,
        )


pass_app = click.make_pass_decorator(App)


@click.group(context_settings={"auto_envvar_prefix": DEFAULT_ENV_PREFIX})
@cli_logging_options()
@cli_config_options()
@click.pass_context
def cli(
    ctx: click.Context,
    log_level: str,
    log_filepath: Optional[Path],
    config_filepath: Optional[Path],
):
    """
    A gateway between Liquidsoap and the API.
    """
    setup_logger(log_level, log_filepath, rotate=False)
    ctx.obj = App(config=Config(config_filepath))


@cli.command()
@click.argument("media_id")
@pass_app
def media(app: App, media_id):
    """
    Notify currently playing media.

    Replaces: notify --media-id=#{m['schedule_table_id']}
    """
    logger.info("Sending currently playing media id '%s'", media_id)
    app.api_client.notify_media_item_start_playing(media_id)


@cli.command()
@click.argument("media_id")
@click.argument("data")
@pass_app
def webstream(app: App, media_id, data):
    """
    Notify currently playing webstream.

    Replaces: notify --webstream='#{json_str}' --media-id=#{!current_dyn_id}
    """
    logger.info("Sending currently playing webstream '%s' data '%s'", media_id, data)
    app.api_client.notify_webstream_data(data, media_id)


@cli.command()
@click.argument("name")
@click.argument("status")
@pass_app
def live(app: App, name, status):
    """
    Notify currently playing live input.

    Replaces: notify --source-name=#{sourcename} --source-status=#{status}
    """
    logger.info("Sending currently playing live source '%s' status '%s'", name, status)
    app.api_client.notify_source_status(name, status)


@cli.command()
@click.argument("input_name", type=click.Choice(["main", "show"]))
@click.argument("username")
@click.argument("password")
@pass_app
def live_auth(
    app: App,
    input_name: Literal["main", "show"],
    username: str,
    password: str,
):
    """
    Check live stream user authentication.
    """
    input_name_map = {"main": "master", "show": "dj"}

    logger.info(
        "Checking '%s' live stream user authentication '%s'",
        input_name,
        username,
    )
    resp = app.api_client.check_live_stream_auth(
        username,
        password,
        input_name_map[input_name],
    )

    payload: dict = resp.json()
    if payload.get("msg", False) is True:
        raise SystemExit(0)
    raise SystemExit(1)


@cli.command()
@click.argument("stream_id")
@click.argument("time")
@click.option("--error", help="Error message if any occurred.")
@pass_app
def stream(app: App, stream_id, time, error):
    """
    Notify about output stream status.

    Replaces: notify --error='#{msg}' --stream-id=#{stream} --time=#{!time}
    Replaces: notify --connect --stream-id=#{stream} --time=#{!time}
    """
    status = "OK"
    if error is not None:
        status = error

    logger.info("Sending output stream '%s' status '%s'", stream_id, status)
    app.api_client.notify_liquidsoap_status(status, stream_id, time)


@cli.command()
@pass_app
def started(app: App):
    """
    Notify liquidsoap startup status.

    Replaces: notify --liquidsoap-started
    """
    logger.debug("Notifying server that Liquidsoap has started")
    app.api_client.notify_liquidsoap_started()