conjurer/conjurer_musician/conjurer_musician.py

# This Python file uses the following encoding: utf-8
"""
The provided Python script sets up a Flask web server to manage a list of music files, with
functions for rescanning the music folder, updating the music list, and serving the music list via
API endpoints.
"""
import json
import logging
import re
import threading
import time
from datetime import datetime
from logging import handlers
from pathlib import Path
from platform import uname
from sys import platform
from flask import Flask, jsonify, redirect, request, send_from_directory, render_template
from waitress import serve

HOST_ADDRESS = "192.168.1.15"
PORT_ADDRESS = 5000
if platform in ("linux", "linux2"):
    SEPARATOR_FILE_PATH = "/"
    if "microsoft-standard" in uname().release:
        LOGFILE = "/home/mtuszowski/conjurer/discord_mus_service.log"
        MUSIC_FOLDER = "/mnt/g/Muzyka/"
        NETRC_FILE = "/home/mtuszowski/.netrc"
        LOGSTORE = "/home/mtuszowski/conjurer/logs/"
        ENCODING = "utf-8"

    else:
        LOGFILE = "/home/pi/Conjurer/discord_mus_service.log"
        NETRC_FILE = "/home/pi/.netrc"
        LOGSTORE = "/home/pi/RetroPie/logs/"
        ENCODING = "utf-8"
        MUSIC_FOLDER = "/home/pi/RetroPie/mp3/"
        PRIORITY_FOLDER = "/home/pi/RetroPie/mp3/Magiczne i chuj/"


music_file_list = []
priority_list = []

def rescan():
    """
    The `rescan` function logs a message, scans for mp3 files in a specified folder,
    and adds them to a list of music files.
    """
    logging.info("Rescan triggered")

    for mp3_item in Path.glob(Path(MUSIC_FOLDER), "**/*.mp3"):
        temp_music_file = mp3_item.as_posix()
        if platform == "win32":
            temp_music_file = temp_music_file.replace("/", "\\")
        music_file_list.append(temp_music_file)

    for mp3_item in Path.glob(Path(PRIORITY_FOLDER), "**/*.mp3"):
        temp_music_file = mp3_item.as_posix()
        if platform == "win32":
            temp_music_file = temp_music_file.replace("/", "\\")
        priority_list.append(temp_music_file)

    with open(
            "/home/pi/Conjurer/all_playlist.playlist", "w", encoding="utf-8"
        ) as w_file:
        try:
            for item in music_file_list:
                w_file.write(item)
                w_file.write("\n")
        except json.JSONDecodeError:
            pass
    with open("/home/pi/Conjurer/hit.playlist", "w", encoding="utf-8") as w_file:
        try:
            for item in priority_list:
                w_file.write(item)
                w_file.write("\n")
        except json.JSONDecodeError:
            pass


def thread_rescan():
    """
    The `thread_rescan` function periodically triggers a rescan operation after a specified time
    interval.
    """
    logging.info("Starting filesystemupdater")
    while True:
        time.sleep(60 * 60 * 24)
        logging.info("Rescan triggered")
        rescan()


app = Flask(__name__)


# TODO: Odpalić wyszukiwarki w wątkach i dopiero po wszystkim zsumować wyszukiwanie.
def wyszukaj(word_list, how_many, _logger=None, return_to_bot=True):
    """
    Searches for music files based on a list of keywords and returns a list of matching files.

    Args:
        word_list (list): A list of keywords to search for.
        how_many (int): The maximum number of matching files to return.

    Returns:
        list: A list of matching files, sorted by their search weight.

    """
    if _logger is None:
        fun_logger = logging.getLogger()
    else:
        fun_logger = _logger
    return_list = []
    search_weight = []

    for _ in range(len(music_file_list)):
        search_weight.append((0, ""))

    time_start = datetime.now()
    if int(how_many) > 0:
        skip_start = 2
    else:
        skip_start = 1
    for word in word_list[skip_start:]:
        token_weight = len(word)
        fun_logger.info("Słowo kluczowe: %s", word)
        itr = 0
        for file in music_file_list:
            file = file.split(SEPARATOR_FILE_PATH)

            char_remove = [
                ".",
                "^",
                "$",
                "*",
                "+",
                "?",
                "{",
                "}",
                "[",
                "]",
                "\\",
                "/",
                "|",
                "(",
                ")",
                "!",
                ",",
                "-",
                ":",
                "mp3",
            ]
            all_words = []
            for f_iter in file:
                for char in char_remove:
                    f_iter = remove_characters(f_iter, char)
                tmp = f_iter.split()
                all_words.extend(tmp)
            pingu = 1
            pattern_len = len(all_words)
            if platform == "win32":
                skip = 2
            else:
                skip = 4
            matched_times = 1
            # TODO: To do wątków albo for asynchroniczny
            for itm in all_words[skip:]:
                pingu += 1
                pattern = ".*" + word + ".*"
                if re.match(pattern, itm, re.IGNORECASE):
                    temp_weight = (
                        search_weight[itr][0]
                        + (token_weight + (pingu**1.5) / pattern_len) / matched_times
                    )
                    search_weight[itr] = (
                        temp_weight,
                        music_file_list[itr],
                    )
                    matched_times += 1
            itr += 1

    fun_logger.info(
        "Stworzylem tablice wag zajęło mi to %s", datetime.now() - time_start
    )
    time_start = datetime.now()
    item_to_search = max_weight(search_weight)
    itr = 0
    if item_to_search == 0:
        return []
    not_found = True
    return_list = []
    if int(how_many) <= 0:
        fun_logger.info("Jeden plik do zagrania")
        while not_found:
            if search_weight[itr][0] == item_to_search:
                return_list.append(search_weight[itr])
                if not return_to_bot:
                    with open(
                        "/home/pi/Conjurer/priority_queue.playlist",
                        "r+",
                        encoding="utf-8",
                    ) as s_file:
                        s_file.write(search_weight[itr][1])
                break
            itr += 1
    else:
        fun_logger.info("Wiele plików do zagrania")
        search_weight.sort(key=lambda x: x[0], reverse=True)
        return_list.extend(search_weight[: int(how_many)])
    fun_logger.info("Done: %s", return_list)
    return return_list


def max_weight(lista):
    """
    Take a list of weights and return the maximum weight.

    :param lista: It seems like the parameter `lista` is a list of items, possibly representing weights.
    The function name `max_weight` suggests that the function is intended to find the maximum weight
    from the list. However, without more context or information about the problem, it's difficult to say
    for sure what the
    """
    maximum_weight = 0
    for iterator in lista:
        if iterator[0] > maximum_weight:
            maximum_weight = iterator[0]
    return maximum_weight


def remove_characters(string, character):
    """
    The `remove_characters` function removes all occurrences of a specified character from a given
    string.

    :param string: The string parameter is the input string from which characters will be removed
    :param character: The character parameter is the character that you want to remove from the string
    :return: a new string where all occurrences of the specified character have been removed.
    """
    return string.replace(character, "")


@app.route("/stream", methods=["GET"])
def stream_music():
    """
    The function `stream_music` is a route handler for the "/stream" endpoint.
    It returns a JSON response containing a key "music_file_list" with the value of the variable `music_file_list`.

    :return: A JSON response containing a key "music_file_list" with the value of the variable `music_file_list`.
    """

    #return send_from_directory("/tmp/hls", "stream.m3u8")
    return render_template("/home/pi/Conjurer/stream.html")

@app.route("/<string:file_name>")
def stream(file_name):
    """
    Stream the specified file from the video directory.

    Args:
        file_name (str): The name of the file to be streamed.

    Returns:
        Response: The response containing the streamed file.
    """
    # trunk-ignore(bandit/B108)
    video_dir = "/tmp/hls"
    return send_from_directory(video_dir, file_name)

@app.route("/stream_mp3", methods=["GET"])
def stream_music_mp3():
    """
    The function `stream_music_mp3` is a route handler for the "/stream_mp3" endpoint.
    It redirects the user to the URL "http://www.example.com" with a status code of 302.

    :return: A redirect response to "http://www.example.com" with a status code of 302.
    """
    return redirect("http://www.example.com", code=302)


@app.route("/clear_pr_pls", methods=["GET"])
def clear_pr_pls():
    """
    The function `clear_pr_pls` clears the contents of the priority queue playlist file.

    :return: A JSON response indicating the success of the operation.
    """
    app.logger.info("CLEARING PLAYLIST")
    with open('/home/pi/Conjurer/priority_queue.playlist', 'w', encoding='utf-8') as cleared_pl:
        cleared_pl.write('')

    return_data = jsonify(isError=False, message="Success", statusCode=200, data=[])
    return return_data, 200


@app.route("/mp3", methods=["GET"])
def get_music_list():
    """
    The function `get_music_list` returns a JSON object containing a list of music files.
    :return: A JSON response containing a key "music_file_list" with the value of the variable
    `music_file_list`.
    """
    return jsonify({"music_file_list": music_file_list})


@app.route("/update_mp3", methods=["POST"])
def update_music_list():
    """
    The function `update_music_list` receives a POST request with a JSON payload, logs the received
    item, adds it to a music file list, and returns a success message along with the updated record.
    :return: The function `update_music_list` is returning a tuple containing a JSON response and a
    status code. The JSON response includes keys `isError`, `message`, `statusCode`, and `data`,
    with values indicating the success of the operation and the data that was
    received and added to the `music_file_list`.
    The status code returned is 200, indicating a successful response.
    """
    record = json.loads(request.data)
    app.logger.info(record["item"])
    music_file_list.append(record["item"])
    return_data = (
        jsonify(isError=False, message="Success", statusCode=200, data=record),
        200,
    )
    return return_data


@app.route("/get_music", methods=["POST"])
def look_for_playlist():
    """
    The function `look_for_playlist` receives a POST request with a JSON payload, logs the received
    item, adds it to a music file list, and returns a success message along with the updated record.

    :return: A tuple containing a JSON response and a status code. The JSON response includes keys `isError`,
             `message`, `statusCode`, and `data`, with values indicating the success of the operation and the
             data that was received and added to the `music_file_list`. The status code returned is 200,
             indicating a successful response.
    """
    record = json.loads(request.data)
    app.logger.info(record)
    app.logger.info(record["lista_slow"])
    app.logger.info(record["UUID"])
    app.logger.info(record["dlugosc_plejlisty"])
    return_data = wyszukaj(
        record["lista_slow"], record["dlugosc_plejlisty"], app.logger, True
    )

    return_data = (
        jsonify(isError=False, message="Success", statusCode=200, data=return_data),
        200,
    )
    return return_data


@app.route("/request_radio_file", methods=["POST"])
def add_request():
    record = json.loads(request.data)
    app.logger.info(record)
    app.logger.info(record["lista_slow"])
    app.logger.info(record["UUID"])
    return_data = wyszukaj(
        record["lista_slow"], 0, app.logger, False
    )

    with open(
        "/home/pi/Conjurer/request.playlist", "a", encoding="utf-8"
    ) as s_file:
        for item in return_data:
            s_file.write(item[1] + "\n")
    return_data = (
        jsonify(isError=False, message="Success", statusCode=200, data={"status": "OK"}),
        200,
    )
    return return_data

@app.route("/create_priority_playlist", methods=["POST"])
def create_priority_playlist():
    """
    The function `create_priority_playlist` receives a POST request with a JSON payload, logs the received
    item, adds it to a music file list, and returns a success message along with the updated record.

    :return: A tuple containing a JSON response and a status code.
        The JSON response includes keys `isError`,
        `message`, `statusCode`, and `data`, with values
        indicating the success of the operation and the
        data that was received and added to the `music_file_list`.
        The status code returned is 200,indicating a successful response.
    """
    record = json.loads(request.data)
    app.logger.info(record)
    app.logger.info(record["lista_slow"])
    app.logger.info(record["UUID"])
    app.logger.info(record["dlugosc_plejlisty"])
    return_data = wyszukaj(
        record["lista_slow"], record["dlugosc_plejlisty"], app.logger, False
    )
    with open(
        "/home/pi/Conjurer/request.playlist", "a", encoding="utf-8"
    ) as s_file:
        for item in return_data:
            s_file.write(item[1] + "\n")
    return_data = (
        jsonify(isError=False, message="Success", statusCode=200, data={"status": "OK"}),
        200,
    )
    return return_data


@app.route("/add_to_priority", methods=["POST"])
def add_to_priority():
    """
    The function `add_to_priority` receives a POST request with a JSON payload, logs the received
    item, adds it to a music file list, and returns a success message along with the updated record.

    :return: A tuple containing a JSON response and a status code.
        The JSON response includes keys `isError`,
        `message`, `statusCode`, and `data`, with values
        indicating the success of the operation and the
        data that was received and added to the `music_file_list`.
        The status code returned is 200,indicating a successful response.
    """
    record = json.loads(request.data)
    app.logger.info(record)
    app.logger.info(record["lista_slow"])
    app.logger.info(record["UUID"])
    app.logger.info(record["dlugosc_plejlisty"])
    return_data = wyszukaj(
        record["lista_slow"], record["dlugosc_plejlisty"], app.logger, False
    )
    with open(
        "/home/pi/Conjurer/priority_queue.playlist", "a", encoding="utf-8"
    ) as s_file:
        for item in return_data:
            s_file.write(item[1] + "\n")
    return_data = (
        jsonify(isError=False, message="Success", statusCode=200, data={"status": "OK"}),
        200,
    )
    return return_data


def flask_debug():
    """
    The `flask_debug` function starts a Flask application in debug mode without using the reloader.
    Do not use for production for fucks sake.
    """
    # trunk-ignore(bandit/B201)
    app.run(debug=True, use_reloader=False, host=HOST_ADDRESS, port=PORT_ADDRESS)


def waitress_run():
    """
    The `waitress_run` function serves the `app` on host HOST_ADDRESS
    and port 5000 using the Waitress WSGI server.

    This function starts the Waitress server and listens for incoming requests
    on the specified host and port. It uses the `serve` function from the Waitress
    library to handle the serving process.

    Parameters:
        None

    Returns:
        None
    """
    serve(app, host=HOST_ADDRESS, port=PORT_ADDRESS)


if __name__ == "__main__":
    logger = logging.getLogger("conjurer_musician")
    logger.setLevel(logging.DEBUG)
    formatter = logging.Formatter(
        "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
    )
    handler = handlers.RotatingFileHandler(
        filename=LOGFILE,
        encoding=ENCODING,
        mode="a",
        maxBytes=6 * 1024 * 1024,
        backupCount=6,
    )
    handler.setFormatter(formatter)
    logger.addHandler(handler)

    rescan()
    logger.info("Started")
    threads = []
    # threads.append(threading.Thread(target=flask_debug))
    threads.append(threading.Thread(target=waitress_run))
    threads.append(threading.Thread(target=thread_rescan))

    for worker in threads:
        worker.start()

    for worker in threads:
        worker.join()