#!/usr/bin/env bash

# ------------------------------------------------------------------------------
# Build the Sphinx documentation.
#
# Examples:
#   ./build.sh
#   ./build.sh --name my-documentation
# ------------------------------------------------------------------------------

PROJECT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )/.." && pwd )"

# shellcheck disable=SC1090
source "${PROJECT_DIR}/bin/shflags/shflags"
# shellcheck disable=SC1090
source "${PROJECT_DIR}/bin/ansi/ansi"
# shellcheck disable=SC1090
source "${PROJECT_DIR}/bin/ndd-log4b/ndd-log4b.sh"
# shellcheck disable=SC1090
source "${PROJECT_DIR}/bin/ndd-utils4b/ndd-utils4b.sh"
# shellcheck disable=SC1090
source "${PROJECT_DIR}/bin/variables.sh"



# disable before shflags
ndd::base::catch_more_errors_off

DEFINE_string  "name"  "${DDIDIER_SPHINX_CONTAINER_NAME}"  "The name of the container"  "n"
DEFINE_boolean "pdf"   false                               "Enable PDF gneration"       "p"
DEFINE_boolean "debug" false                               "Enable debug mode"          "d"

read -r -d '' FLAGS_HELP <<EOF
Run Sphinx in build mode. Sphinx will build the documentation only once.
Examples:
  ./build.sh
EOF

# parse the command-line
FLAGS "$@" || exit $?
eval set -- "${FLAGS_ARGV}"

# enable after shflags
ndd::base::catch_more_errors_on



function main() {

    if [[ "${FLAGS_debug}" -eq "${FLAGS_TRUE}" ]]; then
        # shellcheck disable=SC2034
        ndd::logger::set_stdout_level "DEBUG"
    else
        # shellcheck disable=SC2034
        ndd::logger::set_stdout_level "INFO"
    fi

    local container_name

    if [[ "${FLAGS_pdf}" -eq "${FLAGS_TRUE}" ]]; then
        container_name="${FLAGS_name}-pdf"
    else
        container_name="${FLAGS_name}"
    fi

    if [[ -z "${container_name}" ]]; then
        log error "┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
        log error "┃ The container name cannot be empty. Please use '-n' or '--name'"
        log error "┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
        exit 1
    fi

    local docker_image="ddidier/sphinx-doc:${DDIDIER_SPHINX_IMAGE_VERSION}"
    local source_directory="${PROJECT_DIR}"

    # $UID and $USER may not be defined
    # local container_uid="${UID}"
    # local container_username="${USER}"
    local container_uid
    local container_username
    container_uid="$(id -u)"
    container_username="$(id -u -n)"

    if [[ -L "${source_directory}" ]]; then
        log warning "The source directory cannot be a symbolic link."
        source_directory="$(realpath "${source_directory}")"
    fi

    local sphinx_make_target

    if [[ "${FLAGS_pdf}" -eq "${FLAGS_TRUE}" ]]; then
        sphinx_make_target=latexpdf
    else
        sphinx_make_target=html
    fi

    log info "┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
    log info "┃ Building the Sphinx documentation"
    log info "┃"
    log info "┃ - using the Docker image: ${docker_image}"
    log info "┃ - in the container: ${container_name}"
    log info "┃ - as the user: ${container_username}"
    log info "┃ - as the user ID: ${container_uid}"
    log info "┃"
    log info "┃ This container can usually be terminated with: Control+C"
    log info "┃ But if this does not work: docker kill ${container_name}"
    log info "┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"

    # Use the terminal if present
    local docker_run_interactive=""
    local docker_run_tty=""

    if [[ -t 1 ]]; then
        docker_run_interactive="-i"
        docker_run_tty="-t"
    fi

    # echo                                                                   \
    # docker run --rm                                                        \
    #     ${docker_run_interactive}                                          \
    #     ${docker_run_tty}                                                  \
    #     --name "${container_name}"                                         \
    #     -e USER_ID="${container_uid}"                                      \
    #     -e USER_NAME="${container_username}"                               \
    #     -v "${source_directory}":/data                                     \
    #     "${docker_image}"                                                  \
    #         make --makefile=Makefile-sphinx "${sphinx_make_target}" "${@}" \
    # || true

    log info "$(ndd::print::script_output_start)"
    docker run --rm                                                         \
        ${docker_run_interactive}                                           \
        ${docker_run_tty}                                                   \
        --name "${container_name}"                                          \
        -e USER_ID="${container_uid}"                                       \
        -e USER_NAME="${container_username}"                                \
        -v "${source_directory}":/data                                      \
        "${docker_image}"                                                   \
            make --makefile=Makefile-sphinx "${sphinx_make_target}" "${@}"  \
    || true
    log info "$(ndd::print::script_output_end)"

    log info "┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
    log info "┃ BUILD -- Success!                                                             "
    log info "┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
}

function error_handler() {
    local error_code="$?"

    test $error_code == 0 && return;

    log error "An unexpected error has occured:\n%s" "$(ndd::base::print_stack_trace 2>&1)"

    exit 1
}

trap 'error_handler ${?}' ERR

main "${@}"

exit 0