install.sh

#!/bin/bash

# KTC - Klipper Tool Changer code (v.2)
# Installation script
#
# Copyright (C) 2023  Andrei Ignat <andrei@ignat.se>
#
# This file may be distributed under the terms of the GNU GPLv3 license.
#

#
# The responsibility of this script is to setup the Python extensions
# and configure the update processes.

# Set this to terminate on error.
set -e

# Get the root path of the repo, aka, where this script is executing
REPO_DIR=$(realpath $(dirname "$0"))

# This is where Klipper is installed
KLIPPER_HOME="${HOME}/klipper"

# This is where the extension are downloaded to, a subdirectory of the repo.
EXTENSION_PATH="${REPO_DIR}/extensions"

# This is where Moonraker is installed
MOONRAKER_HOME="${HOME}/moonraker"

# This is where Klipper config files are stored
KLIPPER_CONFIG_HOME="${HOME}/printer_data/config"

# This is where Klipper config files were stored before the 0.10.0 release
OLD_KLIPPER_CONFIG_HOME="${HOME}/klipper_config"

#
# Console Write Helpers
#
c_default=$(echo -en "\e[39m")
c_green=$(echo -en "\e[92m")
c_yellow=$(echo -en "\e[93m")
c_magenta=$(echo -en "\e[35m")
c_red=$(echo -en "\e[91m")

log_header()
{
    echo -e "${c_magenta}$1${c_default}"
}

log_important()
{
    echo -e "${c_yellow}$1${c_default}"
}

log_error()
{
    log_blank
    echo -e "${c_red}$1${c_default}"
    log_blank
}

log_info()
{
    echo -e "${c_green}$1${c_default}"
}

log_blank()
{
    echo ""
}

# 
# Logic to check if Klipper is installed
# 
check_klipper() {
    # Check if Klipper is installed
    log_blank
    log_header "Checking if Klipper is installed..."
    if [ "$(sudo systemctl list-units --full -all -t service --no-legend | grep -F "klipper.service")" ]; then
        log_important "${INFO}Klipper service found"
    else
        log_error "${ERROR}Klipper service not found! Please install Klipper first"
        exit -1
    fi
}

# 
# Logic to verify the home directories
# 
verify_home_dirs() {
    log_blank
    log_header "Verifying home directories..."
    if [ ! -d "${KLIPPER_HOME}" ]; then
        log_error "Klipper home directory (${KLIPPER_HOME}) not found. Use '-k <dir>' option to override"
        exit -1
    fi
    if [ ! -d "${KLIPPER_CONFIG_HOME}" ]; then
        if [ ! -d "${OLD_KLIPPER_CONFIG_HOME}" ]; then
            log_error "Klipper config directory (${KLIPPER_CONFIG_HOME} or ${OLD_KLIPPER_CONFIG_HOME}) not found. Use '-c <dir>' option to override"
            exit -1
        fi
        KLIPPER_CONFIG_HOME="${OLD_KLIPPER_CONFIG_HOME}"
    fi
    log_info "Klipper config directory (${KLIPPER_CONFIG_HOME}) found"

    if [ ! -d "${MOONRAKER_HOME}" ]; then
        log_error "Moonraker home directory (${MOONRAKER_HOME}) not found. Use '-m <dir>' option to override"
        exit -1
    fi    
}

restart_klipper()
{
    log_header "Restarting Klipper..."
    sudo systemctl restart klipper
}

restart_moonraker()
{
    log_header "Restarting Moonraker..."
    sudo systemctl restart moonraker
}

verify_ready()
{
    if [ "$EUID" -eq 0 ]; then
        log_error "This script must not run as root"
        exit -1
    fi
}

function nextfilename {
    local name="$1"
    if [ -d "${name}" ]; then
        printf "%s-%s" ${name%%.*} $(date '+%Y%m%d_%H%M%S')
    else
        printf "%s-%s.%s-old" ${name%%.*} $(date '+%Y%m%d_%H%M%S') ${name#*.}
    fi
}

# 
# Logic to link the extension to Klipper
# 
link_extension()
{
    log_blank
    log_header "Linking extension files to Klipper..."

    for file in $(cd ${EXTENSION_PATH}/ ; ls *.py); do
        ln -sf "${EXTENSION_PATH}/${file}" "${KLIPPER_HOME}/klippy/extras/${file}"
        log_info "Linking extension file: (${file})."
    done
}

# 
# Logic to install the update manager to Moonraker
# 
install_update_manager() {
    log_blank
    log_header "Adding update manager to moonraker.conf"
    dest=${KLIPPER_CONFIG_HOME}/moonraker.conf
    if test -f "$dest"; then
        already_included=$(grep -c "\[update_manager KTC\]" ${dest} || true)
        if [ "${already_included}" -eq 0 ]; then
            # Backup the original  moonraker.conf file
            next_dest="$(nextfilename $dest)"
            log_info "Copying original moonraker.conf file to ${next_dest}"
            cp ${dest} ${next_dest}

            # Add the configuration to moonraker.conf
            echo "" >> "${dest}"    # Add a blank line
            echo "" >> "${dest}"    # Add a blank line
            echo -e "[update_manager KTC]" >> "${dest}"    # Add the section header
            echo -e "type: git_repo" >> "${dest}"
            echo -e "path: ${REPO_DIR}" >> "${dest}"
            echo -e "origin: https://github.com/TypQxQ/KTC.git" >> "${dest}"
            echo -e "primary_branch: main" >> "${dest}"
            echo -e "install_script: install.sh" >> "${dest}"
            echo -e "managed_services: klipper" >> "${dest}"

            restart_moonraker
        else
            log_error "[update_manager KTC] already exists in moonraker.conf - skipping installing it there"
        fi
    else
        log_error "moonraker.conf not found!"
    fi
}

# 
# Logic to install the configuration to Klipper
# 
install_klipper_config() {
    log_header "Adding configuration to printer.cfg"

    # Add configuration to printer.cfg if it doesn't exist
    dest=${KLIPPER_CONFIG_HOME}/printer.cfg
    if test -f $dest; then
        # Backup the original printer.cfg file
        next_dest="$(nextfilename "$dest")"
        log_info "Copying original printer.cfg file to ${next_dest}"
        cp ${dest} ${next_dest}

        # Add the configuration to printer.cfg
        # This example assumes that that both the server and the webcam stream are running on the same machine as Klipper
        # The ktc section is not needed if a tool is configured but loaded here for the macros to work if no tool is configured
        already_included=$(grep -c "\[ktc\]" ${dest} || true)
        if [ "${already_included}" -eq 0 ]; then
            echo "" >> "${dest}"    # Add a blank line
            echo "" >> "${dest}"    # Add a blank line
            echo -e "[ktc]" >> "${dest}"    # Add the section header

            log_info "Added KTC configuration to printer.cfg"
            log_important "Please check the configuration in printer.cfg and adjust it as needed"
        else
            log_error "[ktc] already exists in printer.cfg - skipping adding it there"
        fi

        # Add the inclusion of macros to printer.cfg if it doesn't exist
        already_included=$(grep -c "\[include ktc/base/*.cfg\]" ${dest} || true)
        if [ "${already_included}" -eq 0 ]; then
            echo "" >> "${dest}"    # Add a blank line
            echo -e "[include ktc/base/*.cfg]" >> "${dest}"    # Add the section header
            echo -e "[include ktc/optional_rrf_compability/*.cfg]" >> "${dest}"    # Add the section header
        else
            log_error "[include ktc/base/*.cfg] already exists in printer.cfg - skipping adding it and the optional macros there"
        fi
    else
        log_error "File printer.cfg file not found! Cannot add KTC configuration. Do it manually."
    fi

    if [ ! -d "${KLIPPER_CONFIG_HOME}/ktc" ]; then
        log_info "Creating the ${KLIPPER_CONFIG_HOME}/ktc directory"
        mkdir ${KLIPPER_CONFIG_HOME}/ktc
    else
        log_error "ktc directory already exists in ${KLIPPER_CONFIG_HOME} - skipping creating it"
    fi

    if [ ! -d "${KLIPPER_CONFIG_HOME}/ktc/base" ]; then
        log_info "Copying base macros to ${KLIPPER_CONFIG_HOME}/ktc"
        cp -r ${REPO_DIR}/macros/base ${KLIPPER_CONFIG_HOME}/ktc
    else
        log_error "Base macros already exists in ${KLIPPER_CONFIG_HOME}/ktc/base - skipping copying it there"
    fi

    if [ ! -d "${KLIPPER_CONFIG_HOME}/ktc/optional_rrf_compability" ]; then
        log_info "Copying optional_rrf_compability macros to ${KLIPPER_CONFIG_HOME}/ktc"
        cp -r ${REPO_DIR}/macros/optional_rrf_compability ${KLIPPER_CONFIG_HOME}/ktc
    else
        log_error "Optional RRF compability macros already exists in ${KLIPPER_CONFIG_HOME}/ktc/optional_rrf_compability - skipping copying it there"
    fi
    # Restart Klipper
    restart_klipper

}

# 
# Logic to ask a question and get a yes or no answer while displaying a prompt under installation
# 
prompt_yn() {
    while true; do
        read -n1 -p "
$@ (y/n)? " yn
        case "${yn}" in
            Y|y)
                echo "y" 
                break;;
            N|n)
                echo "n" 
                break;;
            *)
                ;;
        esac
    done
}

log_blank
log_blank
log_blank
log_blank
log_blank
log_blank
log_blank
log_blank
log_blank
log_blank
log_blank
log_blank
log_blank
log_blank
log_blank
log_blank
log_blank
log_blank
log_blank
log_blank
log_blank
log_blank
log_blank
log_blank
log_blank
log_blank
log_blank
log_blank
log_blank
log_blank
log_blank
log_blank
log_blank
log_blank
log_blank
log_header "                     KTC"
log_header "   Klipper Tool Changer code (v2)"
log_blank
log_blank
log_important "KTC is used to facilitate toolchanging under Klipper."
log_blank
log_info "Usage: $0 [-k <klipper_home_dir>] [-c <klipper_config_dir>] [-m <moonraker_home_dir>]"
log_blank
log_blank
log_important "This script will install the KTC extensions and macros."
log_important "It will add the base configuration in printer.cfg and moonraker.conf."
log_blank
yn=$(prompt_yn "Do you want to continue?")
echo
case $yn in
    y)
        ;;
    n)
        log_info "You can run this script again later to install KTC."
        log_blank
    exit 0
        ;;
esac



# Make sure we aren't running as root
verify_ready

# Check that Klipper is installed
check_klipper

# Check that the home directories are valid
verify_home_dirs

# Link the extension to Klipper
link_extension

# Install the update manager to Moonraker
install_update_manager

# Install the configuration to Klipper
install_klipper_config

log_blank
log_blank
log_important "KTC is now installed. Settings can be found in the printer.cfg file."