install.sh

#!/bin/bash
rm -f log.txt
set -eo pipefail

{
SCRIPT_DIR=$(dirname "$(realpath "$0")")
cd "$SCRIPT_DIR"

#### Functions definitions

check_path() {
    local path="$1"
    
    if [ ! -d "$path" ]; then
        echo "Path $path not valid"
        exit 1
    fi
}


find_shortest_dir() {
    local search_path="$1"
    local search_key="$2"
    local search_type="${3:-f}"
    local shortest_dir

    shortest_dir=$(find "$search_path" -type "$search_type" -path "$search_key" 2>/dev/null | awk '{
        if (length($0) < len || len == 0) {
            len = length($0);
            min = $0; 
        }
    } END { if (min) print min; }' | xargs -I {} dirname {})
    echo "$shortest_dir"  # Output the result
}

#### MAIN


echo -e "\n-------------------------------------"
echo -e "\nWelcome to ResHelper Installation!\n"
echo -e  "-------------------------------------\n"

echo -e "$(date '+%Y-%m-%d %H:%M:%S') - Saving installation log into log.txt\n "

if [ "$(whoami)" = "root" ]; then
    echo 'ERROR: This script cannot be run as the root user. Please do not use "sudo"'
    exit 1
fi


#### Check for updates

if [ "$(git rev-parse --show-toplevel 2>/dev/null)" = "$(pwd)" ]; then
	echo -e "Checking for updates...\n"
	GIT_BRANCH=$(git rev-parse --abbrev-ref HEAD)
	git fetch
    if ! git diff --quiet HEAD origin/${GIT_BRANCH}; then  # Change 'main' if needed
    	echo ""
        read -p "An update is available. Do you want to update to the latest version? (y/n): " choice
        case "$choice" in
            y|Y )
                echo -e "Updating to the latest version..\n"
                git reset --hard origin/${GIT_BRANCH}  # Change 'main' if needed
                echo -e "\nUpdate complete. Please restart the installation process.\n"
                exit 0
                ;;
            n|N )
                echo "Continuing without update."
                ;;
            * )
                echo -e "\nInvalid choice. Please enter 'y' or 'n'.\n"
                exit 1
                ;;
        esac
    fi
fi


######## Path setup
echo -e "Detecting Paths...\n"



if [ -f ./defaults.conf ]; then
	echo -e "default.conf file found! Using specified defaults.\n"
	. ./defaults.conf  
else 
	I_USER=""
	I_HOME=""
	RH_PATH=""
	CONFIG_PATH=""
	KLIPPER_PATH=""
	PK_PATH=""
	KLIPPER_VER=""
	TMP_PATH=""
fi


if [ -z "$I_USER" ]; then
	I_USER="$USER"
fi
echo "User : ${I_USER}"

if [ -z "$I_HOME" ]; then
	I_HOME="$HOME"
fi
echo "User Home Path: ${I_HOME}"
check_path "$I_HOME"

if [ -z "$RH_PATH" ]; then
	RH_PATH="$(dirname "$(realpath "$0")")"
fi
check_path "$RH_PATH"
echo "ResHelper Path: ${RH_PATH}"

if [ -z "$KLIPPER_PATH" ]; then
	KLIPPER_PATH=$(find_shortest_dir "$I_HOME" '*/klipper/klippy/toolhead.py')
	KLIPPER_PATH="${KLIPPER_PATH%/*}"
	if [ ! -d "$KLIPPER_PATH" ]; then
	    echo "Error: No valid /klipper path found in the home folder."
	    exit 1
	fi
fi
echo "Klipper Path: ${KLIPPER_PATH}"

if [ -z "$KLIPPER_VER" ]; then
	if [ -e "${KLIPPER_PATH}/README.md" ]; then
		if grep -q "kalico" ${KLIPPER_PATH}/README.md; then
			if [ -f "${KLIPPER_PATH}/klippy/extras/extruder_smoother.py" ]; then
				KLIPPER_VER="DK_BE"
			else
		    	KLIPPER_VER="DK"
	    	fi
		else
		    KLIPPER_VER="MAIN"
		fi
	else
		echo "Couldn't determine Klipper Version."
		exit 1
	fi
fi
echo "Klipper Version: ${KLIPPER_VER}"


if [ -z "$PK_PATH" ]; then
	PK_PATH=$(find_shortest_dir "$I_HOME" '*/klippy-env/bin' d); 
	if [ ! -d "$PK_PATH" ]; then
		echo "Error: No valid PK_PATH path found."
		exit 1
	fi
	PK_PATH="$PK_PATH/bin"
fi
echo "klippy-env Path: ${PK_PATH}"


if [ -z "$CONFIG_PATH" ]; then
	CONFIG_PATH=$(find_shortest_dir "$I_HOME" '*/config/printer.cfg')
	if [ ! -d "$CONFIG_PATH" ]; then
	    echo "Error: No valid printer_data/config  path found."
	    exit 1
	fi
fi
echo "Klipper Config Path: ${CONFIG_PATH}"


if [ -z "$TMP_PATH" ]; then
	TMP_PATH="/tmp"
fi
check_path "$TMP_PATH"
echo "Temp Path: ${TMP_PATH}"

echo -e "\nPaths detected successfully!"


######### Saving Paths
echo -e "\nSaving paths to paths.conf file..."
rm -f paths.conf

cat << EOF > paths.conf
### Paths auto-generated by ResHelper install.sh 

I_USER="${I_USER}"
I_HOME="${I_HOME}"
RH_PATH="${RH_PATH}"
CONFIG_PATH="${CONFIG_PATH}"
KLIPPER_PATH="${KLIPPER_PATH}"
PK_PATH="${PK_PATH}"
KLIPPER_VER="${KLIPPER_VER}"
TMP_PATH="${TMP_PATH}"
EOF

echo -e "Paths saved!\n"


#### Check Prerequisites

## Check Klipper
echo -e "Checking Klipper modules..."


PK_VERSION=$(${PK_PATH}/python --version 2>&1 | awk '{print $2}')
if [[ "$PK_VERSION" > "3.0" ]]; then
    echo "Klipper Python version is ${PK_VERSION}"
else
    echo "WARNING: Klipper Python version is ${PK_VERSION}!"
    echo "It is highly recommended to upgrade Klipper to a Python 3.x version!"
    echo "Use KIAUH to remove and reinstall Klipper (Python 3.x)"
fi


## Check Numpy
echo -e "\nChecking Numpy module..."

if ${PK_PATH}/python -c 'import numpy' 2>/dev/null; then
    echo "Numpy is installed!"
else
    echo -e "\nNumpy is not installed."
    echo -e "Installing Numpy module...\n"
    ${PK_PATH}/pip install -v numpy
    echo -e "\nDone: Numpy Installed!\n"
    echo -e "\nNOTE: If you encouter Numpy issues, make sure that you are running a Klipper Python 3.x version"
    echo -e "If the issue is still not resolved, you can also try installing the following modules:"
    echo -e '"sudo apt install python3-numpy python3-matplotlib libatlas-base-dev libopenblas-dev"\n'
fi

## Check Matplotlib
echo -e "\nChecking Matplotlib module..."

if ${PK_PATH}/python -c 'import matplotlib' 2>/dev/null; then
    echo "Matplotlib is installed!"
else
    echo -e "\nMatplotlib is not installed."
    echo -e "Installing Matplotlib module...\n"
    ${PK_PATH}/pip install -v matplotlib
    echo -e "\nDone: Matplotlib Installed!\n"
    echo -e "\nNOTE: If you encouter Matplotlib issues, make sure that you are running a Klipper Python 3.x version"
    echo -e "If the issue is still not resolved, you can also try installing the following modules:"
    echo -e '"sudo apt install python3-numpy python3-matplotlib libatlas-base-dev libopenblas-dev"\n'
fi


## Check Libatlas
echo -e "\nChecking libatlas modules..."

DEBIAN_VERSION=$(grep -oP '(?<=VERSION_CODENAME=).*' /etc/os-release 2>/dev/null || echo "unknown")
if [ "$DEBIAN_VERSION" = "trixie" ]; then
    echo "Debian Trixie detected. Skipping libatlas-base-dev (not available). libopenblas-dev will be used instead."
elif dpkg-query -W -f='${Status}' libatlas-base-dev 2>/dev/null | grep -q "ok installed"; then
    echo "Libatlas-base-dev is installed!"
else
    echo "Libatlas-base-dev is not installed."
	sudo apt-get -y install libatlas-base-dev
	echo -e "\nDone: Libatlas-base-dev Installed!\n"
fi

if dpkg-query -W -f='${Status}' libopenblas-dev 2>/dev/null | grep -q "ok installed"; then
    echo "Libopenblas-dev is installed!"
else
    echo "Libopenblas-dev is not installed."
	sudo apt-get -y install libopenblas-dev
	echo -e "\nDone: Libopenblas-dev  Installed!\n"
fi


## Check bc (Basic Calculator) 
echo -e "\nChecking bc (Basic Calculator) ..."

if command -v "bc" 2>&1 >/dev/null; then
    echo "bc is installed!"
else
    echo -e "\nbc (Basic Calculator) is not installed."
    echo -e "Installing bc...\n"
    sudo apt-get -y install bc
    echo -e "\nDone: bc Installed!\n"
fi



#### Patching klipper 
echo -e "\nDetermining required Klipper patches...\n"

if [ "$KLIPPER_VER" = "DK" ]; then
    echo "Kalico MAIN detected. No patches required! Skipping.."
elif [ "$KLIPPER_VER" = "DK_BE" ]; then 
    echo -e "Kalico with Smooth Shapers detected!"
    echo -e "Preparing classic mode patch.."
	cp ./patches/dk_be/shaper_calibrate_classic.py ${KLIPPER_PATH}/klippy/plugins/
	cp ./patches/dk_be/calibrate_shaper_classic.py ${KLIPPER_PATH}/scripts/
    cd $KLIPPER_PATH
    echo "klippy/plugins/shaper_calibrate_classic.py" >> .git/info/exclude
    echo "scripts/calibrate_shaper_classic.py" >> .git/info/exclude
    git update-index --assume-unchanged klippy/plugins/shaper_calibrate_classic.py > /dev/null 2>&1 || true
    git update-index --assume-unchanged scripts/calibrate_shaper_classic.py > /dev/null 2>&1 || true
	echo "Added shaper_calibrate_classic.py to klipper/klippy/plugins/"
	echo "Added calibrate_shaper_classic.py to klipper/scripts"
	echo "Patching Done!"
    
elif [ "$KLIPPER_VER" = "MAIN" ]; then
		echo -e "Klipper mainline detected"
	    echo -e "Note: For ResHelper to work properly Klipper needs to be up to date"
	    # echo -e "To restore the previous file run: git restore --source=HEAD -- /klippy/extras/resonance_tester.py" 

	    # echo -e "\nInstalling resonance_tester accel_per_hz patch...\n" 
	    # cp ./patches/main/resonance_tester.py ${KLIPPER_PATH}/klippy/extras/
	    cd $KLIPPER_PATH
	    # echo "klippy/extras/resonance_tester.py" >> .git/info/exclude
		echo -e "Restoring resonance_tester.py module"
	    git update-index --no-assume-unchanged klippy/extras/resonance_tester.py > /dev/null 2>&1 || true
		git restore --source=HEAD -- klippy/extras/resonance_tester.py

		if [ -f "${KLIPPER_PATH}/klippy/extras/gcode_shell_command.py" ]; then
			 echo "GCode Shell Command found. Skipping..."
		else
			 echo -e "\nInstalling gcode_shell_command module...\n"
			 cd ${KLIPPER_PATH}/klippy/extras
		  	 wget https://raw.githubusercontent.com/KalicoCrew/kalico/refs/heads/main/klippy/extras/gcode_shell_command.py
			 cd ${KLIPPER_PATH}
			 echo "klippy/extras/gcode_shell_command.py" >> .git/info/exclude
			 git update-index --assume-unchanged klippy/extras/gcode_shell_command.py > /dev/null 2>&1 || true
    	fi		
	    
	    echo -e "\nKlipper Patching Done!\n"      
else
	echo -e "Failed to detect Klipper variant. Exiting.."
    exit 1  
fi


#### Setting up reshelper.cfg
echo -e "\nSetting up reshelper.cfg..."
echo -e "Path set to: ${RH_PATH}/gen.sh"

cd $RH_PATH
rm -f reshelper.cfg
cp reshelper.cfg.ref reshelper.cfg
sed -i "s|<rh_path>|${RH_PATH}/gen.sh|g" reshelper.cfg

echo -e "\nCopying reshelper.cfg to $CONFIG_PATH"
if [ -f "${CONFIG_PATH}/reshelper.cfg" ]; then
	echo -e "Existing reshelper.cfg found. Renaming it to reshelper.cfg.old"
	mv "${CONFIG_PATH}/reshelper.cfg" "${CONFIG_PATH}/reshelper.cfg.old"
fi	
cp reshelper.cfg "${CONFIG_PATH}"
echo -e "Done!\n"


#### Check includes

echo -e "Checking printer.cfg for required includes...\n"
MANUAL_INCLUDE="false"

if [ -f "${CONFIG_PATH}/printer.cfg" ]; then 
	if grep -q "\[include reshelper.cfg\]" ${CONFIG_PATH}/printer.cfg; then
		    echo "\"[include reshelper.cfg]\" detected!"
		    HAS_RH="true"
	else
		    echo "\"[include reshelper.cfg]\" missing"
		    HAS_RH="false"
	fi	
	if grep -qi "allow_plugin_override:\s*true" ${CONFIG_PATH}/printer.cfg; then 
		 HAS_PG="true"
	     echo "\"allow_plugin_override: True\", detected!"
	else   
		if [ "$KLIPPER_VER" = "DK_BE" ];then
		    echo "\"allow_plugin_override: True\", missing"
  		 	HAS_PG="false"
	 	else
	 		HAS_PG="true"
 		fi
	fi
else
	echo "printer.cfg not found at: ${CONFIG_PATH}"
	echo "Skipping automatic includes..."
	MANUAL_INCLUDE="true"
fi

### Asking for automatic includes

if [ "$MANUAL_INCLUDE" = "false" ] && { [ "$HAS_RH" = "false" ] || [ "$HAS_PG" = "false" ]; }; then
	echo ""
	read -p "Do you want to automatically set up the printer.cfg includes for you? (y/n): " response
	echo ""
	if [ "$response" = "y" ] || [ "$response" = "Y" ]; then
	    MANUAL_INCLUDE="false"
	    echo "Automatic setup will be performed."
	else
	    MANUAL_INCLUDE="true"
	    echo "You chose manual setup."
	fi
else
	MANUAL_INCLUDE="true"  # safety condition in case something went wrong 
fi


### Preparing automatic includes

if [ "$MANUAL_INCLUDE" = "false" ]; then 
	CFG_INCLUDE=""
	if [ "$HAS_RH" = "false" ]; then
		CFG_INCLUDE+="[include reshelper.cfg]\n"
	fi

	if [ "$HAS_PG" = "false" ]; then
		CFG_INCLUDE+="\n[danger_options]\n"
		CFG_INCLUDE+="allow_plugin_override: True\n"
	fi
	
	if [ ! -z "$CFG_INCLUDE"  ]; then
		CFG_INCLUDE+="\n[mcu]"
	else
		echo "WARNING: Issuse detected in the include logic. Skpping automatic include ... "
		MANUAL_INCLUDE="true"
	fi
	# echo -e "\nDEBUG: Replace String: \n${CFG_INCLUDE}\n "
fi


### Performing automatic includes

if [ "$MANUAL_INCLUDE" = "false" ]; then
	if grep -q "\[mcu\]" ${CONFIG_PATH}/printer.cfg; then
		if command -v awk >/dev/null 2>&1; then
			echo -e "\nBacking up printer.cfg..."
			cp "${CONFIG_PATH}/printer.cfg" "${CONFIG_PATH}/printer.cfg.bak" && 
			awk -v mcu="$CFG_INCLUDE" '
			  /\[mcu\]/ {print mcu; next}
			  {print}
			' "${CONFIG_PATH}/printer.cfg" > "${CONFIG_PATH}/printer.cfg.tmp" && 
			mv "${CONFIG_PATH}/printer.cfg.tmp" "${CONFIG_PATH}/printer.cfg" &&
			echo "Added required includes into printer.cfg!" 
		else
			echo -e "WARNING: \"awk\" command was not found on this machine. Skipping procedure.."
			MANUAL_INCLUDE="true"
		fi
	else
		echo "WARNING: Reference string [mcu] was not found in printer.cfg. Skipping procedure.."
		MANUAL_INCLUDE="true"		
	fi
fi


#### Finishing	
echo -e "\nRestarting klipper"
systemctl restart klipper
echo -e "\nInstallation Finished!\n"

if [ "$MANUAL_INCLUDE" = "true" ] && { [ "$HAS_RH" = "false" ] || [ "$HAS_PG" = "false" ]; }; then
	echo -e "[include reshelper.cfg] needs to be added to your printer.cfg!"

	if [ "$KLIPPER_VER" = "DK_BE" ];then 
		echo -e "For Kalico Klipper also add the following:\n"
		echo -e "[danger_options]"
		echo -e "allow_plugin_override: True\n"
	fi
fi

echo -e "Wow, this actually worked :O Enjoy!\n"
exit 0
} | tee -a log.txt