refactor: make the 'Obico for Klipper' name consistent (#385)

This commit is contained in:
Kenneth Jiang
2023-09-29 11:20:21 -07:00
committed by GitHub
parent b88d0085ba
commit 16d3388ff2
2 changed files with 29 additions and 30 deletions

View File

@@ -63,7 +63,7 @@ function obico_server_url_prompt() {
} }
function moonraker_obico_setup_dialog() { function moonraker_obico_setup_dialog() {
status_msg "Initializing Moonraker-obico installation ..." status_msg "Initializing Obico installation ..."
local moonraker_count local moonraker_count
local moonraker_names local moonraker_names
@@ -73,7 +73,7 @@ function moonraker_obico_setup_dialog() {
if (( moonraker_count == 0 )); then if (( moonraker_count == 0 )); then
### return early if moonraker is not installed ### return early if moonraker is not installed
local error="Moonraker not installed! Please install Moonraker first!" local error="Moonraker not installed! Please install Moonraker first!"
log_error "Moonraker-obico setup started without Moonraker being installed. Aborting setup." log_error "Obico setup started without Moonraker being installed. Aborting setup."
print_error "${error}" && return print_error "${error}" && return
elif (( moonraker_count > 1 )); then elif (( moonraker_count > 1 )); then
# moonraker_names is valid only in case of multi-instance # moonraker_names is valid only in case of multi-instance
@@ -90,10 +90,10 @@ function moonraker_obico_setup_dialog() {
if (( allowed_moonraker_obico_count == 0 && moonraker_count > 0 )) && [[ $(get_moonraker_obico_status) != "Not linked!" ]]; then if (( allowed_moonraker_obico_count == 0 && moonraker_count > 0 )) && [[ $(get_moonraker_obico_status) != "Not linked!" ]]; then
local yn local yn
while true; do while true; do
echo "${yellow}Obico for Klipper is already installed.${white}" echo "${yellow}Obico is already installed.${white}"
echo "It is safe to run the install again to repair any issues." echo "It is safe to run the install again to repair any issues."
echo "" echo ""
local question="Do you want to reinstall Obico for Klipper?" local question="Do you want to reinstall Obico?"
read -p "${cyan}###### ${question} (Y/n):${white} " yn read -p "${cyan}###### ${question} (Y/n):${white} " yn
case "${yn}" in case "${yn}" in
Y|y|Yes|yes|"") Y|y|Yes|yes|"")
@@ -101,7 +101,7 @@ function moonraker_obico_setup_dialog() {
break;; break;;
N|n|No|no) N|n|No|no)
select_msg "No" select_msg "No"
abort_msg "Exiting Obico for Klipper installation...\n" abort_msg "Exiting Obico installation...\n"
return;; return;;
*) *)
error_msg "Invalid Input!";; error_msg "Invalid Input!";;
@@ -126,31 +126,30 @@ function moonraker_obico_setup_dialog() {
done done
blank_line blank_line
if (( existing_moonraker_obico_count > 0 )); then if (( existing_moonraker_obico_count > 0 )); then
printf "|${green}%-55s${white}|\n" " ${existing_moonraker_obico_count} Moonraker-obico instances already installed!" printf "|${green}%-55s${white}|\n" " ${existing_moonraker_obico_count} Obico instances already installed!"
for svc in ${moonraker_obico_services}; do for svc in ${moonraker_obico_services}; do
printf "|${cyan}%-57s${white}|\n" " ● moonraker-obco-$(get_instance_name "${svc}")" printf "|${cyan}%-57s${white}|\n" " ● moonraker-obco-$(get_instance_name "${svc}")"
done done
fi fi
blank_line blank_line
echo -e "| The setup will apply the same names to |" echo -e "| The setup will apply the same names to Obico! |"
echo -e "| Moonraker-obico! |"
blank_line blank_line
echo -e "| Please select the number of Moonraker-obico instances |" echo -e "| Please select the number of Obico instances |"
echo -e "| to install. Usually one Moonraker-obico instance per |" echo -e "| to install. Usually one Obico instance per |"
echo -e "| Moonraker instance is required, but you may not |" echo -e "| Moonraker instance is required, but you may not |"
echo -e "| install more Moonraker-obico instances than available |" echo -e "| install more Obico instances than available |"
echo -e "| Moonraker instances. |" echo -e "| Moonraker instances. |"
bottom_border bottom_border
### ask for amount of instances ### ask for amount of instances
local re="^[1-9][0-9]*$" local re="^[1-9][0-9]*$"
while [[ ! ${new_moonraker_obico_count} =~ ${re} || ${new_moonraker_obico_count} -gt ${allowed_moonraker_obico_count} ]]; do while [[ ! ${new_moonraker_obico_count} =~ ${re} || ${new_moonraker_obico_count} -gt ${allowed_moonraker_obico_count} ]]; do
read -p "${cyan}###### Number of new Moonraker-obico instances to set up:${white} " -i "${allowed_moonraker_obico_count}" -e new_moonraker_obico_count read -p "${cyan}###### Number of new Obico instances to set up:${white} " -i "${allowed_moonraker_obico_count}" -e new_moonraker_obico_count
### break if input is valid ### break if input is valid
[[ ${new_moonraker_obico_count} =~ ${re} && ${new_moonraker_obico_count} -le ${allowed_moonraker_obico_count} ]] && break [[ ${new_moonraker_obico_count} =~ ${re} && ${new_moonraker_obico_count} -le ${allowed_moonraker_obico_count} ]] && break
### conditional error messages ### conditional error messages
[[ ! ${new_moonraker_obico_count} =~ ${re} ]] && error_msg "Input not a number" [[ ! ${new_moonraker_obico_count} =~ ${re} ]] && error_msg "Input not a number"
(( new_moonraker_obico_count > allowed_moonraker_obico_count )) && error_msg "Number of Moonraker-obico instances larger than installed Moonraker instances" (( new_moonraker_obico_count > allowed_moonraker_obico_count )) && error_msg "Number of Obico instances larger than installed Moonraker instances"
done && select_msg "${new_moonraker_obico_count}" done && select_msg "${new_moonraker_obico_count}"
else else
log_error "Internal error. moonraker_count of '${moonraker_count}' not equal or grather than one!" log_error "Internal error. moonraker_count of '${moonraker_count}' not equal or grather than one!"
@@ -160,8 +159,8 @@ function moonraker_obico_setup_dialog() {
### Step 2: Confirm instance amount ### Step 2: Confirm instance amount
local yn local yn
while true; do while true; do
(( new_moonraker_obico_count == 1 )) && local question="Install Moonraker-obico?" (( new_moonraker_obico_count == 1 )) && local question="Install Obico?"
(( new_moonraker_obico_count > 1 )) && local question="Install ${new_moonraker_obico_count} Moonraker-obico instances?" (( new_moonraker_obico_count > 1 )) && local question="Install ${new_moonraker_obico_count} Obico instances?"
read -p "${cyan}###### ${question} (Y/n):${white} " yn read -p "${cyan}###### ${question} (Y/n):${white} " yn
case "${yn}" in case "${yn}" in
Y|y|Yes|yes|"") Y|y|Yes|yes|"")
@@ -169,7 +168,7 @@ function moonraker_obico_setup_dialog() {
break;; break;;
N|n|No|no) N|n|No|no)
select_msg "No" select_msg "No"
abort_msg "Exiting Moonraker-obico setup ...\n" abort_msg "Exiting Obico setup ...\n"
return;; return;;
*) *)
error_msg "Invalid Input!";; error_msg "Invalid Input!";;
@@ -191,8 +190,8 @@ function moonraker_obico_setup_dialog() {
fi fi
done done
(( new_moonraker_obico_count > 1 )) && status_msg "Installing ${new_moonraker_obico_count} Moonraker-obico instances ..." (( new_moonraker_obico_count > 1 )) && status_msg "Installing ${new_moonraker_obico_count} Obico instances ..."
(( new_moonraker_obico_count == 1 )) && status_msg "Installing Moonraker-obico ..." (( new_moonraker_obico_count == 1 )) && status_msg "Installing Obico ..."
### Step 5: Clone the moonraker-obico repo ### Step 5: Clone the moonraker-obico repo
clone_moonraker_obico "${MOONRAKER_OBICO_REPO}" clone_moonraker_obico "${MOONRAKER_OBICO_REPO}"
@@ -244,9 +243,9 @@ function moonraker_obico_setup_dialog() {
if (( ${#not_linked_instances[@]} > 0 )); then if (( ${#not_linked_instances[@]} > 0 )); then
top_border top_border
if (( moonraker_count == 1 )); then if (( moonraker_count == 1 )); then
printf "|${green}%-55s${white}|\n" " Moonraker-obico not linked to the server!" printf "|${green}%-55s${white}|\n" " Obico not linked to the server!"
else else
printf "|${green}%-55s${white}|\n" " ${#not_linked_instances[@]} Moonraker-obico instances not linked to the server!" printf "|${green}%-55s${white}|\n" " ${#not_linked_instances[@]} Obico instances not linked to the server!"
for i in "${not_linked_instances[@]}"; do for i in "${not_linked_instances[@]}"; do
printf "|${cyan}%-57s${white}|\n" " ● moonraker-obico-${moonraker_names[${i}]}" printf "|${cyan}%-57s${white}|\n" " ● moonraker-obico-${moonraker_names[${i}]}"
done done
@@ -272,7 +271,7 @@ function moonraker_obico_setup_dialog() {
break;; break;;
N|n|No|no) N|n|No|no)
select_msg "No" select_msg "No"
abort_msg "Exiting Moonraker-obico setup ...\n" abort_msg "Exiting Obico setup ...\n"
return;; return;;
*) *)
error_msg "Invalid Input!";; error_msg "Invalid Input!";;
@@ -295,13 +294,13 @@ function moonraker_obico_setup_dialog() {
function clone_moonraker_obico() { function clone_moonraker_obico() {
local repo=${1} local repo=${1}
status_msg "Cloning Moonraker-obico from ${repo} ..." status_msg "Cloning Obico from ${repo} ..."
### force remove existing Moonraker-obico dir ### force remove existing Obico dir
[[ -d "${MOONRAKER_OBICO_DIR}" ]] && rm -rf "${MOONRAKER_OBICO_DIR}" [[ -d "${MOONRAKER_OBICO_DIR}" ]] && rm -rf "${MOONRAKER_OBICO_DIR}"
cd "${HOME}" || exit 1 cd "${HOME}" || exit 1
if ! git clone "${repo}" "${MOONRAKER_OBICO_DIR}"; then if ! git clone "${repo}" "${MOONRAKER_OBICO_DIR}"; then
print_error "Cloning Moonraker-obico from\n ${repo}\n failed!" print_error "Cloning Obico from\n ${repo}\n failed!"
exit 1 exit 1
fi fi
} }
@@ -316,7 +315,7 @@ function moonraker_obico_install() {
function remove_moonraker_obico_systemd() { function remove_moonraker_obico_systemd() {
[[ -z $(moonraker_obico_systemd) ]] && return [[ -z $(moonraker_obico_systemd) ]] && return
status_msg "Removing Moonraker-obico Systemd Services ..." status_msg "Removing Obico Systemd Services ..."
for service in $(moonraker_obico_systemd | cut -d"/" -f5); do for service in $(moonraker_obico_systemd | cut -d"/" -f5); do
status_msg "Removing ${service} ..." status_msg "Removing ${service} ..."
@@ -329,7 +328,7 @@ function remove_moonraker_obico_systemd() {
### reloading units ### reloading units
sudo systemctl daemon-reload sudo systemctl daemon-reload
sudo systemctl reset-failed sudo systemctl reset-failed
ok_msg "Moonraker-obico Services removed!" ok_msg "Obico Services removed!"
} }
function remove_moonraker_obico_logs() { function remove_moonraker_obico_logs() {
@@ -361,7 +360,7 @@ function remove_legacy_moonraker_obico_logs() {
function remove_moonraker_obico_dir() { function remove_moonraker_obico_dir() {
[[ ! -d ${MOONRAKER_OBICO_DIR} ]] && return [[ ! -d ${MOONRAKER_OBICO_DIR} ]] && return
status_msg "Removing Moonraker-obico directory ..." status_msg "Removing Obico directory ..."
rm -rf "${MOONRAKER_OBICO_DIR}" rm -rf "${MOONRAKER_OBICO_DIR}"
ok_msg "Directory removed!" ok_msg "Directory removed!"
} }
@@ -380,7 +379,7 @@ function remove_moonraker_obico() {
remove_moonraker_obico_dir remove_moonraker_obico_dir
remove_moonraker_obico_env remove_moonraker_obico_env
print_confirm "Moonraker-obico was successfully removed!" print_confirm "Obico was successfully removed!"
return return
} }
@@ -394,7 +393,7 @@ function update_moonraker_obico() {
if [[ ! -d ${MOONRAKER_OBICO_DIR} ]]; then if [[ ! -d ${MOONRAKER_OBICO_DIR} ]]; then
clone_moonraker_obico "${MOONRAKER_OBICO_REPO}" clone_moonraker_obico "${MOONRAKER_OBICO_REPO}"
else else
status_msg "Updating Moonraker-obico ..." status_msg "Updating Obico ..."
cd "${MOONRAKER_OBICO_DIR}" && git pull cd "${MOONRAKER_OBICO_DIR}" && git pull
fi fi

View File

@@ -57,7 +57,7 @@ function print_status() {
elif [[ ${status} == "Incomplete!" ]]; then elif [[ ${status} == "Incomplete!" ]]; then
status="${yellow}${status}${white}" status="${yellow}${status}${white}"
elif [[ ${status} == "Not linked!" ]]; then elif [[ ${status} == "Not linked!" ]]; then
### "Not linked!" is only required for Moonraker-obico ### "Not linked!" is only required for Obico for Klipper
status="${yellow}${status}${white}" status="${yellow}${status}${white}"
else else
status="${green}${status}${white}" status="${green}${status}${white}"