firstRun.py

"""
A script to run first-time setup for a Discord bot.

This script installs dependencies, prepares the database, fetches data from GitHub,
indexes MyAnimeList data from AnimeAPI, and copies .env.example to .env.

Usage: python3 firstRun.py

Example: python3 firstRun.py
"""

import asyncio
import os
import shlex
import subprocess

from modules.oobe.commons import (check_termux, current_os, prepare_database,
                                  py_bin_path)
from modules.oobe.getNekomimi import nk_run
from modules.oobe.malIndexer import mal_run
from modules.oobe.migrate import migrate


class FirstRunError(Exception):
    """An exception class for first run script."""


async def first_run(py_bin: str = py_bin_path()):
    """
    Runs the first run script.

    Args:
        py_bin (str, optional): Path to the Python binary. Defaults to py_bin_path().

    Returns:
        None

    Raises:
        Exception: If the script is not run from the root directory.
    """
    # Check if the script is run from the root directory
    if not os.path.exists("requirements.txt"):
        raise FirstRunError("Please run the script from the repo's directory.")
    match os.name:
        case "nt":
            safe_path = py_bin
        case _:
            safe_path = shlex.quote(py_bin)
    try:
        # Check if Termux is used
        env = {"MATHLAB": "m"} if check_termux() else {}
        # Install dependencies
        print(
            "Installing and upgrading dependencies for the next step and the bot itself..."
        )
        proc_args = [
            safe_path,
            "-m",
            "pip",
            "install",
            "-U",
            "-r",
            "requirements.txt",
        ]
        if current_os() == "Windows":
            subprocess.run(proc_args, check=True)
        else:
            subprocess.run(proc_args, check=True, env=env)

    except subprocess.CalledProcessError:
        print("\033[31mError installing packages, please run frollowing command:")
        command = "pip install -U -r requirements.txt"
        if check_termux():
            command = "MATHLAB=m " + command
        print(f"{command}\033[0m")

    # create a dummy file named cache/dict_installed, if it doesn't exist
    if not os.path.exists("cache/dict_installed"):
        print("Installing unidic dictionary from NINJAL...")
        try:
            subprocess.run(
                [
                    safe_path,
                    "-m",
                    "unidic",
                    "download",
                ],
                check=True,
            )
            with open("cache/dict_installed", "w", encoding="utf8") as file:
                file.write("")
        except subprocess.CalledProcessError:
            print(
                "\033[31mError installing unidic dictionary, please run frollowing command:"
            )
            print(f"{py_bin} -m unidic download\033[0m")

    # Prepare the database
    print("Preparing the database as database.csv in tabbed format...")
    prepare_database()

    # Fetch data from GitHub
    print("Fetching the latest github:nattadasu/nekomimiDb data...")
    await nk_run()

    # Index MyAnimeList data from AnimeAPI
    print("Indexing MyAnimeList data from AnimeAPI...")
    await mal_run()

    # Migrate the database
    print("Migrating database to new schema...")
    await migrate()

    # Check if .env exists, if not, copy .env.example
    if not os.path.exists(".env"):
        print("Copying .env.example to .env...")
        if current_os() == "Windows":
            os.system("copy .env.example .env")
        else:
            os.system("cp .env.example .env")
    else:
        print(".env already exists, skipping...")

    print("Initialization finished. You should be able to run the bot safely now.")


if __name__ == "__main__":
    asyncio.run(first_run())