#!/usr/bin/env bash

#=======================================================================#
# Copyright (C) 2020 - 2022 Dominik Willner <th33xitus@gmail.com>       #
#                                                                       #
# This file is part of KIAUH - Klipper Installation And Update Helper   #
# https://github.com/th33xitus/kiauh                                    #
#                                                                       #
# This file may be distributed under the terms of the GNU GPLv3 license #
#=======================================================================#

set -e

#=================================================#
#================ INSTALL KLIPPER ================#
#=================================================#

function klipper_setup_dialog() {
  status_msg "Initializing Klipper installation ..."

  local klipper_initd_service
  local klipper_systemd_services
  local python_version="${1}" user_input=()
  local error

  klipper_initd_service=$(find_klipper_initd)
  klipper_systemd_services=$(find_klipper_systemd)
  user_input+=("${python_version}")

  ### return early if klipper already exists
  if [[ -n ${klipper_initd_service} ]]; then
    error="Unsupported Klipper SysVinit service detected:"
    error="${error}\n ➔ ${klipper_initd_service}"
    error="${error}\n Please re-install Klipper with KIAUH!"
    log_info "Unsupported Klipper SysVinit service detected: ${klipper_initd_service}"
  elif [[ -n ${klipper_systemd_services} ]]; then
    error="At least one Klipper service is already installed:"

    for s in ${klipper_systemd_services}; do
      log_info "Found Klipper service: ${s}"
      error="${error}\n ➔ ${s}"
    done
  fi

  [[ -n ${error} ]] && print_error "${error}" && return

  ### ask for amount of instances to create
  top_border
  echo -e "| Please select the number of Klipper instances to set  |"
  echo -e "| up. The number of Klipper instances will determine    |"
  echo -e "| the amount of printers you can run from this host.    |"
  blank_line
  echo -e "| ${yellow}WARNING:${white}                                              |"
  echo -e "| ${yellow}Setting up too many instances may crash your system.${white}  |"
  bottom_border

  ### ask for amount of instances
  local klipper_count re="^[1-9][0-9]*$"
  while [[ ! ${klipper_count} =~ ${re} ]]; do
    read -p "${cyan}###### Number of Klipper instances to set up:${white} " -i "1" -e klipper_count
    ### break if input is valid
    [[ ${klipper_count} =~ ${re} ]] && break
    ### error messages on invalid input
    error_msg "Input not a number"
  done && select_msg "${klipper_count}"

  user_input+=("${klipper_count}")

  ### confirm instance amount
  local yn
  while true; do
    read -p "${cyan}###### Install ${klipper_count} instance(s)? (Y/n):${white} " yn
    case "${yn}" in
      Y|y|Yes|yes|"")
        select_msg "Yes"
        break;;
      N|n|No|no)
        select_msg "No"
        abort_msg "Exiting Klipper setup ...\n"
        return;;
      *)
        error_msg "Invalid Input!";;
    esac
  done

  ### ask for custom names
  if (( klipper_count > 1 )); then
    local custom_names="false"
    top_border
    echo -e "| You can give each instance a custom name or skip.     |"
    echo -e "| If skipped, KIAUH will automatically assign an index  |"
    echo -e "| to each instance in ascending order, starting at '1'. |"
    blank_line
    echo -e "| Info:                                                 |"
    echo -e "| Only alphanumeric characters will be allowed.         |"
    bottom_border
    while true; do
      read -p "${cyan}###### Use custom names? (y/N):${white} " yn
      case "${yn}" in
        Y|y|Yes|yes)
          select_msg "Yes"
          custom_names="true"
          break;;
        N|n|No|no|"")
          select_msg "No"
          break;;
        *)
          error_msg "Invalid Input!";;
      esac
    done

    ### get user input for custom names
    if [[ ${custom_names} == "true" ]]; then
      local i=1 name re="^[0-9a-zA-Z]+$"
      while [[ ! ${name} =~ ${re} || ${i} -le ${klipper_count} ]]; do
        read -p "${cyan}###### Name for instance #${i}:${white} " name
        if [[ ${name} =~ ${re} ]]; then
          select_msg "Name: ${name}"
          user_input+=("${name}")
          i=$(( i + 1 ))
        else
          error_msg "Invalid Input!"
        fi
      done
    else
      ### if no custom names are used, add the respective amount of indices to the user_input array
      for (( i=1; i <= klipper_count; i++ )); do
        user_input+=("${i}")
      done
    fi
  fi


  (( klipper_count > 1 )) && status_msg "Installing ${klipper_count} Klipper instances ..."
  (( klipper_count == 1 )) && status_msg "Installing single Klipper instance ..."

  klipper_setup "${user_input[@]}"
}

function klipper_setup() {
  read_kiauh_ini "${FUNCNAME[0]}"
  ### index 0: python version, index 1: instance count, index 2-n: instance names (optional)
  local user_input=("${@}")
  local python_version="${user_input[0]}" && unset "user_input[0]"
  local instance_arr=("${user_input[@]}") && unset "user_input[@]"
  local custom_repo="${custom_klipper_repo}"
  local custom_branch="${custom_klipper_repo_branch}"
  local dep=(git)

  ### checking dependencies
  dependency_check "${dep[@]}"

  ### step 1: clone klipper
  clone_klipper "${custom_repo}" "${custom_branch}"

  ### step 2: install klipper dependencies and create python virtualenv
  install_klipper_packages "${python_version}"
  create_klipper_virtualenv "${python_version}"

  ### step 3: configure and create klipper instances
  configure_klipper_service "${instance_arr[@]}"

  ### step 4: enable and start all instances
  do_action_service "enable" "klipper"
  do_action_service "start" "klipper"

  ### step 5: check for dialout group membership
  check_usergroups

  ### confirm message
  local confirm=""
  (( instance_arr[0] == 1 )) && confirm="Klipper has been set up!"
  (( instance_arr[0] > 1 )) && confirm="${instance_arr[0]} Klipper instances have been set up!"

  print_confirm "${confirm}" && return
}

function clone_klipper() {
  local repo=${1} branch=${2}

  [[ -z ${repo} ]] && repo="${KLIPPER_REPO}"
  repo=$(echo "${repo}" | sed -r "s/^(http|https):\/\/github\.com\///i; s/\.git$//")
  repo="https://github.com/${repo}"

  [[ -z ${branch} ]] && branch="master"

  ### force remove existing klipper dir and clone into fresh klipper dir
  [[ -d ${KLIPPER_DIR} ]] && rm -rf "${KLIPPER_DIR}"

  status_msg "Cloning Klipper from ${repo} ..."

  cd "${HOME}" || exit 1
  if git clone "${repo}" "${KLIPPER_DIR}"; then
    cd "${KLIPPER_DIR}" && git checkout "${branch}"
  else
    print_error "Cloning Klipper from\n ${repo}\n failed!"
    exit 1
  fi
}

function create_klipper_virtualenv() {
  local python_version="${1}"

  [[ ${python_version} == "python2" ]] && \
  status_msg "Installing $(python2 -V) virtual environment..."

  [[ ${python_version} == "python3" ]] && \
  status_msg "Installing $(python3 -V) virtual environment..."

  ### remove klippy-env if it already exists
  [[ -d ${KLIPPY_ENV} ]] && rm -rf "${KLIPPY_ENV}"

  if [[ ${python_version} == "python2" ]]; then
    if virtualenv -p python2 "${KLIPPY_ENV}"; then
      "${KLIPPY_ENV}"/bin/pip install -r "${KLIPPER_DIR}"/scripts/klippy-requirements.txt
    else
      log_error "failure while creating python2 klippy-env"
      error_msg "Creation of Klipper virtualenv failed!"
      exit 1
    fi
  fi

  if [[ ${python_version} == "python3" ]]; then
    if virtualenv -p python3 "${KLIPPY_ENV}"; then
      "${KLIPPY_ENV}"/bin/pip install -U pip
      "${KLIPPY_ENV}"/bin/pip install -r "${KLIPPER_DIR}"/scripts/klippy-requirements.txt
    else
      log_error "failure while creating python3 klippy-env"
      error_msg "Creation of Klipper virtualenv failed!"
      exit 1
    fi
  fi

  return
}

###
# extracts the required packages from the
# install-debian.sh script and installs them
#
# @param {string}: python_version - klipper-env python version
#
function install_klipper_packages() {
  local packages python_version="${1}"
  local install_script="${KLIPPER_DIR}/scripts/install-debian.sh"

  status_msg "Reading dependencies..."
  # shellcheck disable=SC2016
  packages=$(grep "PKGLIST=" "${install_script}" | cut -d'"' -f2 | sed 's/\${PKGLIST}//g' | tr -d '\n')
  ### add dfu-util for octopi-images
  packages+=" dfu-util"
  ### add dbus requirement for DietPi distro
  [[ -e "/boot/dietpi/.version" ]] && packages+=" dbus"

  if [[ ${python_version} == "python3" ]]; then
    ### replace python-dev with python3-dev if python3 was selected
    packages="${packages//python-dev/python3-dev}"
  elif [[ ${python_version} == "python2" ]]; then
    ### package name 'python-dev' is deprecated (-> no installation candidate) on more modern linux distros
    packages="${packages//python-dev/python2-dev}"
  else
    log_error "Internal Error: missing parameter 'python_version' during function call of ${FUNCNAME[0]}"
    error_msg "Internal Error: missing parameter 'python_version' during function call of ${FUNCNAME[0]}"
    exit 1
  fi

  echo "${cyan}${packages}${white}" | tr '[:space:]' '\n'
  read -r -a packages <<< "${packages}"

  ### Update system package info
  status_msg "Updating package lists..."
  if ! sudo apt-get update --allow-releaseinfo-change; then
    log_error "failure while updating package lists"
    error_msg "Updating package lists failed!"
    exit 1
  fi

  ### Install required packages
  status_msg "Installing required packages..."
  if ! sudo apt-get install --yes "${packages[@]}"; then
    log_error "failure while installing required klipper packages"
    error_msg "Installing required packages failed!"
    exit 1
  fi
}

function configure_klipper_service() {
  local input=("${@}")
  local klipper_count=${input[0]} && unset "input[0]"
  local names=("${input[@]}") && unset "input[@]"
  local printer_data cfg_dir cfg log printer uds service env_file

  if (( klipper_count == 1 )) && [[ ${#names[@]} -eq 0 ]]; then
    printer_data="${HOME}/printer_data"
    cfg_dir="${printer_data}/config"
    cfg="${cfg_dir}/printer.cfg"
    log="${printer_data}/logs/klippy.log"
    printer="${printer_data}/comms/klippy.serial"
    uds="${printer_data}/comms/klippy.sock"
    service="${SYSTEMD}/klipper.service"
    env_file="${printer_data}/systemd/klipper.env"

    ### create required folder structure
    create_required_folders "${printer_data}"

    ### write single instance service
    write_klipper_service "" "${cfg}" "${log}" "${printer}" "${uds}" "${service}" "${env_file}"
    write_example_printer_cfg "${cfg_dir}" "${cfg}"
    ok_msg "Klipper instance created!"

  elif (( klipper_count >= 1 )) && [[ ${#names[@]} -gt 0 ]]; then
    local j=0 re="^[1-9][0-9]*$"

    for (( i=1; i <= klipper_count; i++ )); do
      ### overwrite config folder if name is only a number
      if [[ ${names[j]} =~ ${re} ]]; then
        printer_data="${HOME}/printer_${names[${j}]}_data"
      else
        printer_data="${HOME}/${names[${j}]}_data"
      fi

      cfg_dir="${printer_data}/config"
      cfg="${cfg_dir}/printer.cfg"
      log="${printer_data}/logs/klippy.log"
      printer="${printer_data}/comms/klippy.serial"
      uds="${printer_data}/comms/klippy.sock"
      service="${SYSTEMD}/klipper-${names[${j}]}.service"
      env_file="${printer_data}/systemd/klipper.env"

      ### create required folder structure
      create_required_folders "${printer_data}"

      ### write multi instance service
      write_klipper_service "${names[${j}]}" "${cfg}" "${log}" "${printer}" "${uds}" "${service}" "${env_file}"
      write_example_printer_cfg "${cfg_dir}" "${cfg}"
      ok_msg "Klipper instance 'klipper-${names[${j}]}' created!"
      j=$(( j + 1 ))
    done && unset j

  else
    return 1
  fi
}

function write_klipper_service() {
  local i=${1} cfg=${2} log=${3} printer=${4} uds=${5} service=${6} env_file=${7}
  local service_template="${KIAUH_SRCDIR}/resources/klipper.service"
  local env_template="${KIAUH_SRCDIR}/resources/klipper.env"

  ### replace all placeholders
  if [[ ! -f ${service} ]]; then
    status_msg "Creating Klipper Service ${i} ..."
    sudo cp "${service_template}" "${service}"
    sudo cp "${env_template}" "${env_file}"
    [[ -z ${i} ]] && sudo sed -i "s| %INST%||" "${service}"
    [[ -n ${i} ]] && sudo sed -i "s|%INST%|${i}|" "${service}"
    sudo sed -i "s|%USER%|${USER}|g; s|%ENV%|${KLIPPY_ENV}|; s|%ENV_FILE%|${env_file}|" "${service}"
    sudo sed -i "s|%USER%|${USER}|; s|%LOG%|${log}|; s|%CFG%|${cfg}|; s|%PRINTER%|${printer}|; s|%UDS%|${uds}|" "${env_file}"
  fi
}

function write_example_printer_cfg() {
  local cfg_dir=${1} cfg=${2}
  local cfg_template="${KIAUH_SRCDIR}/resources/example.printer.cfg"

  ### create a config directory if it doesn't exist
  if [[ ! -d ${cfg_dir} ]]; then
    status_msg "Creating '${cfg_dir}' ..."
    mkdir -p "${cfg_dir}"
  fi

  ### create a minimal config if there is no printer.cfg
  if [[ ! -f ${cfg} ]]; then
    status_msg "Creating minimal example printer.cfg ..."
    cp "${cfg_template}" "${cfg}"
  fi
}

#================================================#
#================ REMOVE KLIPPER ================#
#================================================#

function remove_klipper_sysvinit() {
  [[ ! -e "${INITD}/klipper" ]] && return

  status_msg "Removing Klipper SysVinit service ..."
  sudo systemctl stop klipper
  sudo update-rc.d -f klipper remove
  sudo rm -f "${INITD}/klipper" "${ETCDEF}/klipper"
  ok_msg "Klipper SysVinit service removed!"
}

function remove_klipper_systemd() {
  [[ -z $(find_klipper_systemd) ]] && return

  status_msg "Removing Klipper Systemd Services ..."
  for service in $(find_klipper_systemd | cut -d"/" -f5); do
    status_msg "Removing ${service} ..."
    sudo systemctl stop "${service}"
    sudo systemctl disable "${service}"
    sudo rm -f "${SYSTEMD}/${service}"
    ok_msg "Done!"
  done

  ### reloading units
  sudo systemctl daemon-reload
  sudo systemctl reset-failed
  ok_msg "Klipper Service removed!"
}

function remove_klipper_env_file() {
  local files regex="\/home\/${USER}\/([A-Za-z0-9_]+)\/systemd\/klipper\.env"
  files=$(find "${HOME}" -maxdepth 3 -regextype posix-extended -regex "${regex}" | sort)

  if [[ -n ${files} ]]; then
    for file in ${files}; do
      status_msg "Removing ${file} ..."
      rm -f "${file}"
      ok_msg "${file} removed!"
    done
  fi
}

function remove_klipper_logs() {
  local files regex="\/home\/${USER}\/([A-Za-z0-9_]+)\/logs\/klippy\.log.*"
  files=$(find "${HOME}" -maxdepth 3 -regextype posix-extended -regex "${regex}" | sort)

  if [[ -n ${files} ]]; then
    for file in ${files}; do
      status_msg "Removing ${file} ..."
      rm -f "${file}"
      ok_msg "${file} removed!"
    done
  fi
}

function remove_legacy_klipper_logs() {
  local files regex="klippy(-[0-9a-zA-Z]+)?\.log(.*)?"
  files=$(find "${HOME}/klipper_logs" -maxdepth 1 -regextype posix-extended -regex "${HOME}/klipper_logs/${regex}" 2> /dev/null | sort)

  if [[ -n ${files} ]]; then
    for file in ${files}; do
      status_msg "Removing ${file} ..."
      rm -f "${file}"
      ok_msg "${file} removed!"
    done
  fi
}

function remove_klipper_uds() {
  local files regex="\/home\/${USER}\/([A-Za-z0-9_]+)\/comms\/klippy\.sock"
  files=$(find "${HOME}" -maxdepth 3 -regextype posix-extended -regex "${regex}" | sort)

  if [[ -n ${files} ]]; then
    for file in ${files}; do
      status_msg "Removing ${file} ..."
      rm -f "${file}"
      ok_msg "${file} removed!"
    done
  fi
}

function remove_klipper_printer() {
  local files regex="\/home\/${USER}\/([A-Za-z0-9_]+)\/comms\/klippy\.serial"
  files=$(find "${HOME}" -maxdepth 3 -regextype posix-extended -regex "${regex}" | sort)

  if [[ -n ${files} ]]; then
    for file in ${files}; do
      status_msg "Removing ${file} ..."
      rm -f "${file}"
      ok_msg "${file} removed!"
    done
  fi
}

function remove_legacy_klipper_printer() {
  local files
  files=$(find /tmp -maxdepth 1 -regextype posix-extended -regex "/tmp/printer(-[0-9a-zA-Z]+)?" | sort)

  if [[ -n ${files} ]]; then
    for file in ${files}; do
      status_msg "Removing ${file} ..."
      rm -f "${file}"
      ok_msg "${file} removed!"
    done
  fi
}

function remove_klipper_dir() {
  [[ ! -d ${KLIPPER_DIR} ]] && return

  status_msg "Removing Klipper directory ..."
  rm -rf "${KLIPPER_DIR}"
  ok_msg "Directory removed!"
}

function remove_klipper_env() {
  [[ ! -d ${KLIPPY_ENV} ]] && return

  status_msg "Removing klippy-env directory ..."
  rm -rf "${KLIPPY_ENV}"
  ok_msg "Directory removed!"
}

function remove_klipper() {
  remove_klipper_sysvinit
  remove_klipper_systemd
  remove_klipper_env_file
  remove_klipper_logs
  remove_legacy_klipper_logs
  remove_klipper_uds
  remove_klipper_printer
  remove_legacy_klipper_printer
  remove_klipper_dir
  remove_klipper_env

  local confirm="Klipper was successfully removed!"
  print_confirm "${confirm}" && return
}

#================================================#
#================ UPDATE KLIPPER ================#
#================================================#

###
# stops klipper, performs a git pull, installs
# possible new dependencies, then restarts klipper
#
function update_klipper() {
  read_kiauh_ini "${FUNCNAME[0]}"

  local py_ver
  local custom_repo="${custom_klipper_repo}"
  local custom_branch="${custom_klipper_repo_branch}"

  py_ver="python$(get_klipper_python_ver)"

  do_action_service "stop" "klipper"

  if [[ ! -d ${KLIPPER_DIR} ]]; then
    clone_klipper "${custom_repo}" "${custom_branch}"
  else
    backup_before_update "klipper"

    status_msg "Updating Klipper ..."
    cd "${KLIPPER_DIR}" && git pull
    ### read PKGLIST and install possible new dependencies
    install_klipper_packages "${py_ver}"
    ### install possible new python dependencies
    "${KLIPPY_ENV}"/bin/pip install -r "${KLIPPER_DIR}/scripts/klippy-requirements.txt"
  fi

  ok_msg "Update complete!"
  do_action_service "restart" "klipper"
}

#================================================#
#================ KLIPPER STATUS ================#
#================================================#

function get_klipper_status() {
  local sf_count status py_ver
  sf_count="$(find_klipper_systemd | wc -w)"

  ### detect an existing "legacy" klipper init.d installation
  if [[ $(find_klipper_systemd | wc -w) -eq 0 ]] \
  && [[ $(find_klipper_initd | wc -w) -ge 1 ]]; then
    sf_count=1
  fi

  py_ver=$(get_klipper_python_ver)

  ### remove the "SERVICE" entry from the data array if a klipper service is installed
  local data_arr=(SERVICE "${KLIPPER_DIR}" "${KLIPPY_ENV}")
  (( sf_count > 0 )) && unset "data_arr[0]"

  ### count+1 for each found data-item from array
  local filecount=0
  for data in "${data_arr[@]}"; do
    [[ -e ${data} ]] && filecount=$(( filecount + 1 ))
  done

  if (( filecount == ${#data_arr[*]} )); then
    if (( py_ver == 3 )); then
      status="Installed: ${sf_count}(py${py_ver})"
    else
      status="Installed: ${sf_count}"
    fi
  elif (( filecount == 0 )); then
    status="Not installed!"
  else
    status="Incomplete!"
  fi

  echo "${status}"
}

function get_local_klipper_commit() {
  [[ ! -d ${KLIPPER_DIR} || ! -d "${KLIPPER_DIR}/.git" ]] && return

  local commit
  cd "${KLIPPER_DIR}"
  commit="$(git describe HEAD --always --tags | cut -d "-" -f 1,2)"
  echo "${commit}"
}

function get_remote_klipper_commit() {
  [[ ! -d ${KLIPPER_DIR} || ! -d "${KLIPPER_DIR}/.git" ]] && return

  local commit
  cd "${KLIPPER_DIR}" && git fetch origin -q
  commit=$(git describe origin/master --always --tags | cut -d "-" -f 1,2)
  echo "${commit}"
}

function compare_klipper_versions() {
  local versions local_ver remote_ver
  local_ver="$(get_local_klipper_commit)"
  remote_ver="$(get_remote_klipper_commit)"

  if [[ ${local_ver} != "${remote_ver}" ]]; then
    versions="${yellow}$(printf " %-14s" "${local_ver}")${white}"
    versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
    # add klipper to application_updates_available in kiauh.ini
    add_to_application_updates "klipper"
  else
    versions="${green}$(printf " %-14s" "${local_ver}")${white}"
    versions+="|${green}$(printf " %-13s" "${remote_ver}")${white}"
  fi

  echo "${versions}"
}

#================================================#
#=================== HELPERS ====================#
#================================================#

###
# reads the python version from the klipper virtual environment
#
# @output: writes the python major version to STDOUT
#
function get_klipper_python_ver() {
  [[ ! -d ${KLIPPY_ENV} ]] && return

  local version
  version=$("${KLIPPY_ENV}"/bin/python --version 2>&1 | cut -d" " -f2 | cut -d"." -f1)
  echo "${version}"
}