#!/bin/bash
# SPDX-Version: 3.0
# SPDX-CreationInfo: 2025-05-05; WEIDNER, Marc S.; <msw@coresecret.dev>
# SPDX-ExternalRef: GIT https://git.coresecret.dev/msw/CISS.debian.live.builder.git
# SPDX-FileContributor: WEIDNER, Marc S.; Centurion Intelligence Consulting Agency
# SPDX-FileCopyrightText: 2024-2025; WEIDNER, Marc S.; <msw@coresecret.dev>
# SPDX-FileType: SOURCE
# SPDX-License-Identifier: EUPL-1.2 OR LicenseRef-CCLA-1.0
# SPDX-LicenseComment: This file is part of the CISS.debian.installer.secure framework.
# SPDX-PackageName: CISS.debian.live.builder
# SPDX-Security-Contact: security@coresecret.eu

# TODO: Unbound variable Debug Meta Cascade.

guard_sourcing

#######################################
# Trap function to be called on 'EXIT'.
# Globals:
#   VAR_DEBUG_TRACE
#   VAR_DEBUG_TRAP
#   VAR_LAST_CMD
#   __preexec_invoke
# Arguments:
#   1: "$?"
#######################################
trap_exit() {
  trap - DEBUG ERR EXIT INT
  declare -r var_trap_on_exit_code="$1"
  declare -r var_trap_on_exit_scrt="$2"
  declare -r var_trap_on_exit_line="$3"
  declare -r var_trap_on_exit_func="$4"
  declare -r var_trap_on_exit_cmmd="$5"

  if [[ -n "${__preexec_invoke:-}" ]]; then
    debug_trap_logger "${var_trap_on_exit_code}" "${VAR_LAST_CMD}"
    unset __preexec_invoke
  fi

  if (( var_trap_on_exit_code == 0 )); then
    if [[ "${VAR_DEBUG_TRACE}" == "true" || "${VAR_DEBUG_TRAP}" == "true" ]]; then dump_vars_exiting; fi
    clean_up "${var_trap_on_exit_code}"
    print_scr_exit "${var_trap_on_exit_code}"
    exit "${var_trap_on_exit_code}"
  else
    if [[ "${ERRTRAP}" == "false" ]]; then
      if [[ "${VAR_DEBUG_TRACE}" == "true" || "${VAR_DEBUG_TRAP}" == "true" ]]; then dump_vars_exiting; fi
      case "${VAR_IN_DIALOG_WR}" in
        box   ) dialog_box_cleaner   ;;
        gauge ) dialog_gauge_cleaner ;;
      esac
    fi
    clean_up "${var_trap_on_exit_code}"
    print_scr_exit "${var_trap_on_exit_code}" \
      "${var_trap_on_exit_scrt}" \
      "${var_trap_on_exit_line}" \
      "${var_trap_on_exit_func}" \
      "${var_trap_on_exit_cmmd}"
    exit "${var_trap_on_exit_code}"
  fi
}

#######################################
# Print Success Message for Trap on 'EXIT' on 'stdout'.
# Globals:
#   LOG_DBG
#   LOG_TRC
#   LOG_VAR
#   VAR_DEBUG_TRACE
#   VAR_DEBUG_TRAP
#   VAR_SCRIPT_SUCCESS
# Arguments:
#   1: ${var_trap_on_exit_code} of trap_exit()
#######################################
print_scr_exit() {
  declare -r var_print_scr_exit_code="$1"
  declare -r var_print_scr_exit_scrt="$2"
  declare -r var_print_scr_exit_line="$3"
  declare -r var_print_scr_exit_func="$4"
  declare -r var_print_scr_exit_cmmd="$5"
  if (( var_print_scr_exit_code == 0 )); then
    if [[ "${VAR_SCRIPT_SUCCESS}" == "true" ]]; then
      printf "\n"
      printf "\e[92m✅ CISS.debian.installer Script successful. \e[0m\n"
      printf "\e[92m✅ Exited with Status : %s \e[0m\n" "${var_print_scr_exit_code}"
      printf "\n"
      if [[ "${VAR_DEBUG_TRACE}" == "true" || "${VAR_DEBUG_TRAP}" == "true" ]]; then
        printf "\e[92m✅ Vars Dump saved at : %s \e[0m\n" "${LOG_VAR}"
        printf "\e[92m✅                  cat %s \e[0m\n" "${LOG_VAR}"
      fi
      if "${VAR_DEBUG_TRAP}"; then
        printf "\e[92m✅ DEBUG Log saved at : %s \e[0m\n" "${LOG_DBG}"
        printf "\e[92m✅                  cat %s \e[0m\n" "${LOG_DBG}"
      fi
      if "${VAR_DEBUG_TRACE}"; then
        printf "\e[92m✅ TRACE Log saved at : %s \e[0m\n" "${LOG_TRC}"
        printf "\e[92m✅                  cat %s \e[0m\n" "${LOG_TRC}"
      fi
      printf "\n"
      printf "\e[95m💷 Please consider donating to my work at: \e[0m\n"
      printf "\e[95m🔗 https://coresecret.eu/spenden/          \e[0m\n"
      printf "\n"
    fi
  else
    if [[ "${ERRTRAP}" == "false" ]]; then
      printf "%s❌ CISS.debian.installer Script failed. Most probably cause of unbound variable. %s%s" "${RED}" "${RES}" "${NL}" >&2
      printf "%s❌ GIT Commit          : %s %s%s" "${RED}" "${VAR_GIT_HEAD}" "${RES}" "${NL}" >&2
      printf "%s❌ Version             : %s %s%s" "${RED}" "${VAR_VERSION}" "${RES}" "${NL}" >&2
      printf "%s❌ Hostsystem          : %s %s%s" "${RED}" "${VAR_SYSTEM}" "${RES}" "${NL}" >&2
      printf "%s❌ Error               : %s %s%s" "${RED}" "${var_print_scr_exit_code}" "${RES}" "${NL}" >&2
      printf "%s❌ Line                : %s %s%s" "${RED}" "${var_print_scr_exit_line}" "${RES}" "${NL}" >&2
      printf "%s❌ Script              : %s %s%s" "${RED}" "${var_print_scr_exit_scrt}" "${RES}" "${NL}" >&2
      printf "%s❌ Function            : %s %s%s" "${RED}" "${var_print_scr_exit_func}" "${RES}" "${NL}" >&2
      printf "%s❌ Command             : %s %s%s" "${RED}" "${var_print_scr_exit_cmmd}" "${RES}" "${NL}" >&2
      printf "%s❌ Script PID          : %s %s%s" "${RED}" "${$}" "${RES}" "${NL}" >&2
      printf "%s❌ Script Runtime      : %s %s%s" "${RED}" "${SECONDS}" "${RES}" "${NL}" >&2
      printf "%s❌ Arguments Counter   : %s %s%s" "${RED}" "${VAR_PARAM_COUNT}" "${RES}" "${NL}" >&2
      printf "%s❌ Arguments Original  : %s %s%s" "${RED}" "${ARG_STR_ORG_INPUT}" "${RES}" "${NL}" >&2
      printf "%s❌ Arguments Sanitized : %s %s%s" "${RED}" "${VAR_ARG_SANITIZED}" "${RES}" "${NL}" >&2
      if [[ "${VAR_DEBUG_TRACE}" == "true" || "${VAR_DEBUG_TRAP}" == "true" ]]; then
        printf "%s❌ Vars Dump saved at  : %s %s%s" "${RED}" "${LOG_VAR}" "${RES}" "${NL}" >&2
      fi
      if "${VAR_DEBUG_TRAP}"; then
        printf "%s❌ Debug Log saved at  : %s %s%s" "${RED}" "${LOG_DBG}" "${RES}" "${NL}" >&2
        printf "%s❌                   cat %s %s%s" "${RED}" "${LOG_DBG}" "${RES}" "${NL}" >&2
      fi
      if "${VAR_DEBUG_TRACE}"; then
        printf "%s❌ Debug Log saved at  : %s %s%s" "${RED}" "${LOG_TRC}" "${RES}" "${NL}" >&2
        printf "%s❌                   cat %s %s%s" "${RED}" "${LOG_TRC}" "${RES}" "${NL}" >&2
      fi
    fi
  fi
}
# vim: number et ts=2 sw=2 sts=2 ai tw=128 ft=sh