kiauh/scripts/crowsnest.sh

#!/usr/bin/env bash

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

#=======================================================================#
# Crowsnest Installer brought to you by KwadFan <me@stephanwe.de>       #
# Copyright (C) 2022 KwadFan <me@stephanwe.de>                          #
# https://github.com/KwadFan/crowsnest                                  #
#=======================================================================#

# Error Handling
set -e

# Helper messages

function multi_instance_message(){
  echo -e "Crowsnest is NOT designed to support multi instances."
  echo -e "A workaround for this is to choose the most used instance as a 'master'"
  echo -e "Use this instance to set up your 'crowsnest.conf' and steering it's service.\n"
  echo -e "Found the following instances:\n"
  for i in ${1}; do
    select_msg "${i}"
  done
  echo -e "\nLaunching crowsnest's configuration tool ..."
  continue_config
}

# Helper funcs
function clone_crowsnest(){
  $(command -v git) clone "${CROWSNEST_REPO}" -b master "${CROWSNEST_DIR}"
}

function check_multi_instance(){
  local -a instances
  readarray -t instances < <(find "${HOME}" -regex "${HOME}/[a-zA-Z0-9_]+_data/*" -printf "%P\n" 2> /dev/null | sort)
  if [[ "${#instances[@]}" -gt 1 ]]; then
    status_msg "Multi instance install detected ..."
    multi_instance_message "${instances[*]}"
    if [[ -d "${HOME}/crowsnest" ]]; then
      pushd "${HOME}/crowsnest" &> /dev/null || exit 1
      if ! make config ;then
        error_msg "Something went wrong! Please try again..."
        if [[ -f "tools/.config" ]]; then
          rm -f tools/.config
        fi
        exit 1
      fi
      if [[ ! -f "tools/.config" ]]; then
        log_error "failure while generating .config"
        error_msg "Generating .config failed, installation aborted"
        exit 1
      fi
      popd &> /dev/null || exit 1
    fi
  fi
}

function continue_config() {
  local reply
  while true; do
    read -erp "${cyan}###### Continue with configuration? (y/N):${white} " reply
    case "${reply}" in
      Y|y|Yes|yes)
        select_msg "Yes"
        break;;
      N|n|No|no|"")
        select_msg "No"
        warn_msg "Installation aborted by user ... Exiting!"
        exit 1;;
      *)
        error_msg "Invalid Input!\n";;
    esac
  done
  return 0
}

# Install func
function install_crowsnest(){

  # Step 1: jump to home directory
  pushd "${HOME}" &> /dev/null || exit 1

  # Step 2: Clone crowsnest repo
  status_msg "Cloning 'crowsnest' repository ..."
  if [[ ! -d "${HOME}/crowsnest" && -z "$(ls -A "${HOME}/crowsnest" 2> /dev/null)" ]]; then
    clone_crowsnest
  else
    ok_msg "crowsnest repository already exists ..."
  fi

  # Step 3: Install dependencies
  dependency_check git make

  # Step 4: Check for Multi Instance
  check_multi_instance

  # Step 5: Launch crowsnest installer
  pushd "${HOME}/crowsnest" &> /dev/null || exit 1
  title_msg "Installer will prompt you for sudo password!"
  status_msg "Launching crowsnest installer ..."
  if ! sudo make install; then
    error_msg "Something went wrong! Please try again..."
    exit 1
  fi

  # Step 5: Leave directory (twice due two pushd)
  popd &> /dev/null || exit 1
  popd &> /dev/null || exit 1
}

# Remove func
function remove_crowsnest(){
  if [[ -d "${CROWSNEST_DIR}" ]]; then
    pushd "${HOME}/crowsnest" &> /dev/null || exit 1
    title_msg "Uninstaller will prompt you for sudo password!"
    status_msg "Launching crowsnest uninstaller ..."

    if ! make uninstall; then
      error_msg "Something went wrong! Please try again..."
      exit 1
    fi

    status_msg "Removing crowsnest directory ..."
    rm -rf "${CROWSNEST_DIR}"
    ok_msg "Directory removed!"
  fi

  print_confirm "Crowsnest successfully removed!"
}

# Status funcs
get_crowsnest_status(){
  local -a files
  local env_file
  env_file="$(grep "EnvironmentFile" /etc/systemd/system/crowsnest.service 2>/dev/null | cut -d "=" -f2)"
  files=(
    "${CROWSNEST_DIR}"
    "/usr/local/bin/crowsnest"
    "/etc/logrotate.d/crowsnest"
    "/etc/systemd/system/crowsnest.service"
    "${env_file}"
    )
  local count
  count=0

  for file in "${files[@]}"; do
    [[ -e "${file}" ]] && count=$(( count +1 ))
  done
  if [[ "${count}" -eq "${#files[*]}" ]]; then
    echo "Installed"
  elif [[ "${count}" -gt 0 ]]; then
    echo "Incomplete!"
  else
    echo "Not installed!"
  fi
}

# Update funcs
# Shameless stolen from KlipperScreen.sh
function get_local_crowsnest_commit() {
  [[ ! -d ${CROWSNEST_DIR} || ! -d "${CROWSNEST_DIR}/.git" ]] && return

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

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

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

function compare_crowsnest_versions() {
  local versions local_ver remote_ver
  local_ver="$(get_local_crowsnest_commit)"
  remote_ver="$(get_remote_crowsnest_commit)"

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

  echo "${versions}"
}

function install_crowsnest_dependencies() {
  local packages log_name="Crowsnest"
  local install_script="${CROWSNEST_DIR}/tools/install.sh"

  ### read PKGLIST from official install-script
  status_msg "Reading dependencies..."
  # shellcheck disable=SC2016
  packages="$(grep "PKGLIST=" "${install_script}" | cut -d'"' -f2 | sed 's/\${PKGLIST}//g' | tr -d '\n')"

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

  ### Update system package lists if stale
  update_system_package_lists

  ### Install required packages
  install_system_packages "${log_name}" "packages[@]"
}

function update_crowsnest() {
  do_action_service "stop" "crowsnest"

  if [[ ! -d ${CROWSNEST_DIR} ]]; then
    clone_crowsnest
  else
    status_msg "Updating Crowsnest ..."
    cd "${CROWSNEST_DIR}" && git pull
    ### read PKGLIST and install possible new dependencies
    install_crowsnest_dependencies
  fi
  ok_msg "Update complete!"
  do_action_service "restart" "crowsnest"
}