sporada/lug-helper
1
0
Fork 0
mirror of https://github.com/the-sane/lug-helper.git synced 2024-09-21 17:32:53 +00:00
Code Issues Projects Releases Wiki Activity

Improve debug_echo function

Browse Source
This commit is contained in:
the-sane 2020-12-31 20:43:10 -05:00 committed by GitHub
parent 48582c3a22
commit a5d372a43b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 64 additions and 80 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

136
lug-helper.sh
View File

@ -77,15 +77,33 @@ menu_option_height="25"
############################################################################ ############################################################################
# Echo a debug message to the terminal with newlines # Echo a formatted debug message to the terminal and optionally exit
# Accepts either "continue" or "exit" as the first argument
# followed by the string to be echoed
debug_echo() { debug_echo() {
# This function expects a string argument # This function expects two string arguments
if [ -z "$1" ]; then if [ "$#" -lt 2 ]; then
echo -e "\nScript error: The debug_echo function expects an argument. Aborting." echo -e "\nScript error: The debug_echo function expects two arguments. Aborting."
read -n 1 -s -p "Press any key..." read -n 1 -s -p "Press any key..."
exit 0 exit 0
fi fi
echo -e "\n$1\n"
# Echo the provided string and, optionally, exit the script
case "$1" in
"continue")
echo -e "\n$2\n"
;;
"exit")
echo -e "\n$2"
read -n 1 -s -p "Press any key..."
exit 0
;;
*)
echo -e "\nScript error: Unknown argument provided to debug_echo function. Aborting."
read -n 1 -s -p "Press any key..."
exit 0
;;
esac
} }
# Display a message to the user. # Display a message to the user.
@ -97,9 +115,7 @@ debug_echo() {
message() { message() {
# Sanity check # Sanity check
if [ "$#" -lt 2 ]; then if [ "$#" -lt 2 ]; then
debug_echo "Script error: The message function expects two arguments. Aborting." debug_echo exit "Script error: The message function expects two arguments. Aborting."
read -n 1 -s -p "Press any key..."
exit 0
fi fi
# Use zenity messages if available # Use zenity messages if available
@ -121,9 +137,7 @@ message() {
margs=("--question" "--text=") margs=("--question" "--text=")
;; ;;
*) *)
debug_echo "Script Error: Invalid message type passed to the message function. Aborting." debug_echo exit "Script Error: Invalid message type passed to the message function. Aborting."
read -n 1 -s -p "Press any key..."
exit 0
;; ;;
esac esac
@ -168,9 +182,7 @@ message() {
done done
;; ;;
*) *)
debug_echo "Script Error: Invalid message type passed to the message function. Aborting." debug_echo exit "Script Error: Invalid message type passed to the message function. Aborting."
read -n 1 -s -p "Press any key..."
exit 0
;; ;;
esac esac
fi fi
@ -204,25 +216,15 @@ message() {
menu() { menu() {
# Sanity checks # Sanity checks
if [ "${#menu_options[@]}" -eq 0 ]; then if [ "${#menu_options[@]}" -eq 0 ]; then
debug_echo "Script error: The array 'menu_options' was not set\nbefore calling the menu function. Aborting." debug_echo exit "Script error: The array 'menu_options' was not set\nbefore calling the menu function. Aborting."
read -n 1 -s -p "Press any key..."
exit 0
elif [ "${#menu_actions[@]}" -eq 0 ]; then elif [ "${#menu_actions[@]}" -eq 0 ]; then
debug_echo "Script error: The array 'menu_actions' was not set\nbefore calling the menu function. Aborting." debug_echo exit "Script error: The array 'menu_actions' was not set\nbefore calling the menu function. Aborting."
read -n 1 -s -p "Press any key..."
exit 0
elif [ -z "$menu_text_zenity" ]; then elif [ -z "$menu_text_zenity" ]; then
debug_echo "Script error: The string 'menu_text_zenity' was not set\nbefore calling the menu function. Aborting." debug_echo exit "Script error: The string 'menu_text_zenity' was not set\nbefore calling the menu function. Aborting."
read -n 1 -s -p "Press any key..."
exit 0
elif [ -z "$menu_text_terminal" ]; then elif [ -z "$menu_text_terminal" ]; then
debug_echo "Script error: The string 'menu_text_terminal' was not set\nbefore calling the menu function. Aborting." debug_echo exit "Script error: The string 'menu_text_terminal' was not set\nbefore calling the menu function. Aborting."
read -n 1 -s -p "Press any key..."
exit 0
elif [ -z "$menu_height" ]; then elif [ -z "$menu_height" ]; then
debug_echo "Script error: The string 'menu_height' was not set\nbefore calling the menu function. Aborting." debug_echo exit "Script error: The string 'menu_height' was not set\nbefore calling the menu function. Aborting."
read -n 1 -s -p "Press any key..."
exit 0
fi fi
# Use Zenity if it is available # Use Zenity if it is available
@ -308,21 +310,21 @@ getdirs() {
if [ -f "$conf_dir/$conf_subdir/$wine_conf" ]; then if [ -f "$conf_dir/$conf_subdir/$wine_conf" ]; then
wine_prefix="$(cat "$conf_dir/$conf_subdir/$wine_conf")" wine_prefix="$(cat "$conf_dir/$conf_subdir/$wine_conf")"
if [ ! -d "$wine_prefix" ]; then if [ ! -d "$wine_prefix" ]; then
debug_echo "The saved wine prefix does not exist, ignoring." debug_echo continue "The saved wine prefix does not exist, ignoring."
wine_prefix="" wine_prefix=""
fi fi
fi fi
if [ -f "$conf_dir/$conf_subdir/$game_conf" ]; then if [ -f "$conf_dir/$conf_subdir/$game_conf" ]; then
game_path="$(cat "$conf_dir/$conf_subdir/$game_conf")" game_path="$(cat "$conf_dir/$conf_subdir/$game_conf")"
if [ ! -d "$game_path" ] || [ "$(basename "$game_path")" != "StarCitizen" ]; then if [ ! -d "$game_path" ] || [ "$(basename "$game_path")" != "StarCitizen" ]; then
debug_echo "Unexpected game path found in config file, ignoring." debug_echo continue "Unexpected game path found in config file, ignoring."
game_path="" game_path=""
fi fi
fi fi
if [ -f "$conf_dir/$conf_subdir/$backup_conf" ]; then if [ -f "$conf_dir/$conf_subdir/$backup_conf" ]; then
backup_path="$(cat "$conf_dir/$conf_subdir/$backup_conf")" backup_path="$(cat "$conf_dir/$conf_subdir/$backup_conf")"
if [ ! -d "$backup_path" ]; then if [ ! -d "$backup_path" ]; then
debug_echo "The saved backup path does not exist, ignoring." debug_echo continue "The saved backup path does not exist, ignoring."
backup_path="" backup_path=""
fi fi
fi fi
@ -475,21 +477,21 @@ sanitize() {
if message question "This helper will delete the following directory:\n\n$user_dir\n\nDo you want to proceed?"; then if message question "This helper will delete the following directory:\n\n$user_dir\n\nDo you want to proceed?"; then
# Back up keybinds # Back up keybinds
if [ "$exported" -eq 1 ]; then if [ "$exported" -eq 1 ]; then
debug_echo "Backing up all saved keybinds..." debug_echo continue "Backing up all saved keybinds..."
cp -r "$keybinds_dir/." "$backup_path/keybinds/" cp -r "$keybinds_dir/." "$backup_path/keybinds/"
debug_echo "Done." debug_echo continue "Done."
fi fi
# Wipe the user directory # Wipe the user directory
debug_echo "Wiping USER directory..." debug_echo continue "Wiping USER directory..."
rm -r "$user_dir" rm -r "$user_dir"
debug_echo "Done." debug_echo continue "Done."
# Restore custom keybinds # Restore custom keybinds
if [ "$exported" -eq 1 ]; then if [ "$exported" -eq 1 ]; then
debug_echo "Restoring keybinds..." debug_echo continue "Restoring keybinds..."
mkdir -p "$keybinds_dir" && cp -r "$backup_path/keybinds/." "$keybinds_dir/" mkdir -p "$keybinds_dir" && cp -r "$backup_path/keybinds/." "$keybinds_dir/"
debug_echo "Done." debug_echo continue "Done."
message info "To re-import your keybinds, select it in-game from the list:\nOptions->Keybindings->Control Profiles" message info "To re-import your keybinds, select it in-game from the list:\nOptions->Keybindings->Control Profiles"
fi fi
@ -644,9 +646,9 @@ rm_shaders() {
# Delete the shader directory # Delete the shader directory
if message question "This helper will delete the following directory:\n\n$shaders_dir\n\nDo you want to proceed?"; then if message question "This helper will delete the following directory:\n\n$shaders_dir\n\nDo you want to proceed?"; then
debug_echo "Deleting shaders..." debug_echo continue "Deleting shaders..."
rm -r "$shaders_dir" rm -r "$shaders_dir"
debug_echo "Done." debug_echo continue "Done."
message info "Your shaders have been deleted!" message info "Your shaders have been deleted!"
fi fi
} }
@ -670,9 +672,9 @@ rm_vidcache() {
# Delete the cache file # Delete the cache file
if message question "This helper will delete the following file:\n\n$dxvk_cache\n\nDo you want to proceed?"; then if message question "This helper will delete the following file:\n\n$dxvk_cache\n\nDo you want to proceed?"; then
debug_echo "Deleting DXVK cache..." debug_echo continue "Deleting DXVK cache..."
rm "$dxvk_cache" rm "$dxvk_cache"
debug_echo "Done." debug_echo continue "Done."
message info "Your DXVK cache has been deleted!" message info "Your DXVK cache has been deleted!"
fi fi
} }
@ -684,7 +686,7 @@ lutris_restart() {
if [ "$lutris_needs_restart" = "true" ]; then if [ "$lutris_needs_restart" = "true" ]; then
if message question "Lutris must be restarted to detect runner changes.\nWould you like this helper to restart it for you?"; then if message question "Lutris must be restarted to detect runner changes.\nWould you like this helper to restart it for you?"; then
if [ "$(pgrep lutris)" ]; then if [ "$(pgrep lutris)" ]; then
debug_echo "Restarting Lutris..." debug_echo continue "Restarting Lutris..."
pkill -SIGTERM lutris && nohup lutris </dev/null &>/dev/null & pkill -SIGTERM lutris && nohup lutris </dev/null &>/dev/null &
else else
message info "Lutris does not appear to be running." message info "Lutris does not appear to be running."
@ -698,15 +700,13 @@ lutris_restart() {
runner_delete() { runner_delete() {
# This function expects an index number for the array installed_runners to be passed in as an argument # This function expects an index number for the array installed_runners to be passed in as an argument
if [ -z "$1" ]; then if [ -z "$1" ]; then
debug_echo "Script error: The runner_delete function expects an argument. Aborting." debug_echo exit "Script error: The runner_delete function expects an argument. Aborting."
read -n 1 -s -p "Press any key..."
exit 0
fi fi
runner_to_delete="$1" runner_to_delete="$1"
if message question "Are you sure you want to delete the following runner?\n\n${installed_runners[$runner_to_delete]}"; then if message question "Are you sure you want to delete the following runner?\n\n${installed_runners[$runner_to_delete]}"; then
rm -r "${installed_runners[$runner_to_delete]}" rm -r "${installed_runners[$runner_to_delete]}"
debug_echo "Deleted ${installed_runners[$runner_to_delete]}" debug_echo continue "Deleted ${installed_runners[$runner_to_delete]}"
lutris_needs_restart="true" lutris_needs_restart="true"
fi fi
} }
@ -755,9 +755,7 @@ runner_select_delete() {
runner_install() { runner_install() {
# This function expects an index number for the array runner_versions to be passed in as an argument # This function expects an index number for the array runner_versions to be passed in as an argument
if [ -z "$1" ]; then if [ -z "$1" ]; then
debug_echo "Script error: The runner_install function expects a numerical argument. Aborting." debug_echo exit "Script error: The runner_install function expects a numerical argument. Aborting."
read -n 1 -s -p "Press any key..."
exit 0
fi fi
# Get the runner filename including file extension # Get the runner filename including file extension
@ -772,9 +770,7 @@ runner_install() {
runner_name="$(basename "$runner_file" .tgz)" runner_name="$(basename "$runner_file" .tgz)"
;; ;;
*) *)
debug_echo "Unknown archive filetype in runner_install function. Aborting." debug_echo exit "Unknown archive filetype in runner_install function. Aborting."
read -n 1 -s -p "Press any key..."
exit 0
;; ;;
esac esac
@ -782,9 +778,7 @@ runner_install() {
if [ "$runner_url_type" = "github" ]; then if [ "$runner_url_type" = "github" ]; then
runner_dl_url="$(curl -s "$contributor_url" | grep "browser_download_url.*$runner_file" | cut -d \" -f4)" runner_dl_url="$(curl -s "$contributor_url" | grep "browser_download_url.*$runner_file" | cut -d \" -f4)"
else else
debug_echo "Script error: Unknown api/url format in runner_sources array. Aborting." debug_echo exit "Script error: Unknown api/url format in runner_sources array. Aborting."
read -n 1 -s -p "Press any key..."
exit 0
fi fi
# Sanity check # Sanity check
@ -796,14 +790,12 @@ runner_install() {
message info "The selected runner will now be downloaded.\nThis might take a moment." message info "The selected runner will now be downloaded.\nThis might take a moment."
# Download the runner to the tmp directory # Download the runner to the tmp directory
debug_echo "Downloading $runner_dl_url into $tmp_dir/$runner_file..." debug_echo continue "Downloading $runner_dl_url into $tmp_dir/$runner_file..."
(cd "$tmp_dir" && curl -LO "$runner_dl_url") (cd "$tmp_dir" && curl -LO "$runner_dl_url")
# Sanity check # Sanity check
if [ ! -f "$tmp_dir/$runner_file" ]; then if [ ! -f "$tmp_dir/$runner_file" ]; then
debug_echo "Script error: The requested runner file was not downloaded. Aborting" debug_echo exit "Script error: The requested runner file was not downloaded. Aborting"
read -n 1 -s -p "Press any key..."
exit 0
fi fi
# Get the path of the first item listed in the archive # Get the path of the first item listed in the archive
@ -815,20 +807,20 @@ runner_install() {
case "$first_filepath" in case "$first_filepath" in
# If the files in the archive begin with ./ there is no subdirectory # If the files in the archive begin with ./ there is no subdirectory
./*) ./*)
debug_echo "Installing runner into $runner_dir/$runner_name..." debug_echo continue "Installing runner into $runner_dir/$runner_name..."
mkdir -p "$runner_dir/$runner_name" && tar -xzf "$tmp_dir/$runner_file" -C "$runner_dir/$runner_name" mkdir -p "$runner_dir/$runner_name" && tar -xzf "$tmp_dir/$runner_file" -C "$runner_dir/$runner_name"
lutris_needs_restart="true" lutris_needs_restart="true"
;; ;;
*) *)
# Runners with a subdirectory in the archive # Runners with a subdirectory in the archive
debug_echo "Installing runner into $runner_dir..." debug_echo continue "Installing runner into $runner_dir..."
mkdir -p "$runner_dir" && tar -xzf "$tmp_dir/$runner_file" -C "$runner_dir" mkdir -p "$runner_dir" && tar -xzf "$tmp_dir/$runner_file" -C "$runner_dir"
lutris_needs_restart="true" lutris_needs_restart="true"
;; ;;
esac esac
# Cleanup tmp download # Cleanup tmp download
debug_echo "Removing $tmp_dir/$runner_file..." debug_echo continue "Removing $tmp_dir/$runner_file..."
rm "$tmp_dir/$runner_file" rm "$tmp_dir/$runner_file"
} }
@ -836,9 +828,7 @@ runner_install() {
runner_select_install() { runner_select_install() {
# This function expects an element number for the array runner_sources to be passed in as an argument # This function expects an element number for the array runner_sources to be passed in as an argument
if [ -z "$1" ]; then if [ -z "$1" ]; then
debug_echo "Script error: The runner_select_install function expects a numerical argument. Aborting." debug_echo exit "Script error: The runner_select_install function expects a numerical argument. Aborting."
read -n 1 -s -p "Press any key..."
exit 0
fi fi
# Store the url from the selected contributor # Store the url from the selected contributor
@ -850,9 +840,7 @@ runner_select_install() {
runner_url_type="github" runner_url_type="github"
;; ;;
*) *)
debug_echo "Script error: Unknown api/url format in runner_sources array. Aborting." debug_echo exit "Script error: Unknown api/url format in runner_sources array. Aborting."
read -n 1 -s -p "Press any key..."
exit 0
;; ;;
esac esac
@ -860,9 +848,7 @@ runner_select_install() {
if [ "$runner_url_type" = "github" ]; then if [ "$runner_url_type" = "github" ]; then
runner_versions=($(curl -s "$contributor_url" | grep "browser_download_url" | awk '{print $2}' | xargs basename -a)) runner_versions=($(curl -s "$contributor_url" | grep "browser_download_url" | awk '{print $2}' | xargs basename -a))
else else
debug_echo "Script error: Unknown api/url format in runner_sources array. Aborting." debug_echo exit "Script error: Unknown api/url format in runner_sources array. Aborting."
read -n 1 -s -p "Press any key..."
exit 0
fi fi
# Sanity check # Sanity check
@ -890,9 +876,7 @@ runner_select_install() {
runner_name="$(basename "${runner_versions[i]}" .tgz)" runner_name="$(basename "${runner_versions[i]}" .tgz)"
;; ;;
*) *)
debug_echo "Unknown archive filetype in runner_select_install function. Aborting." debug_echo exit "Unknown archive filetype in runner_select_install function. Aborting."
read -n 1 -s -p "Press any key..."
exit 0
;; ;;
esac esac
@ -983,7 +967,7 @@ set_version() {
live_or_ptu="LIVE" live_or_ptu="LIVE"
message info "The helper will now target your Star Citizen LIVE installation." message info "The helper will now target your Star Citizen LIVE installation."
else else
debug_echo "Unexpected game version provided. Defaulting to the LIVE installation." debug_echo continue "Unexpected game version provided. Defaulting to the LIVE installation."
live_or_ptu="LIVE" live_or_ptu="LIVE"
fi fi
} }