sporada/lug-helper
1
0
Fork 0
mirror of https://github.com/the-sane/lug-helper.git synced 2024-12-28 17:44:25 +00:00
Code Issues Projects Releases Wiki Activity

Refactor URL handling for easy future additions

Browse Source 
Store runner source URLs in an array for easy expansion.
Handle different file extensions automatically.
Detect whether the archive is packaged with a subdirectory or not and handle it automatically.
This commit is contained in:
the-sane 2020-12-31 20:28:34 -05:00 committed by GitHub
parent 363be810aa
commit 48582c3a22
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 147 additions and 74 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

221
lug-helper.sh
View File

@ -42,6 +42,7 @@ else
conf_dir="$XDG_CONFIG_HOME" conf_dir="$XDG_CONFIG_HOME"
fi fi
conf_subdir="starcitizen-lug" conf_subdir="starcitizen-lug"
tmp_dir="/tmp"
# The game's user subdirectory name # The game's user subdirectory name
user_subdir_name="USER" user_subdir_name="USER"
@ -57,10 +58,15 @@ else
runner_dir="$XDG_DATA_HOME/lutris/runners/wine" runner_dir="$XDG_DATA_HOME/lutris/runners/wine"
fi fi
# URLs for downloading Lutris runners # URLs for downloading Lutris runners
rawfox_url="https://api.github.com/repos/rawfoxDE/raw-wine/releases" # Elements in this array must be added in quoted pairs of: "description" "url"
snatella_url="https://api.github.com/repos/snatella/wine-runner-sc/releases" # The first string in the pair is expected to contain the runner description
# The second is expected to contain the github api releases url
# Set a maximum number of runners # ie. "RawFox" "https://api.github.com/repos/rawfoxDE/raw-wine/releases"
runner_sources=(
"RawFox" "https://api.github.com/repos/rawfoxDE/raw-wine/releases"
"Molotov/Snatella" "https://api.github.com/repos/snatella/wine-runner-sc/releases"
)
# Set a maximum number of runner versions to display from each url
max_runners=20 max_runners=20
# Pixels to add for each Zenity menu option # Pixels to add for each Zenity menu option
@ -744,99 +750,157 @@ runner_select_delete() {
} }
# Download and install the selected runner # Download and install the selected runner
# Note: The variables contributor_url, runner_versions, runner_name, and runner_url_type
# are expected to be set before calling this function
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 an argument. Aborting." debug_echo "Script error: The runner_install function expects a numerical argument. Aborting."
read -n 1 -s -p "Press any key..." read -n 1 -s -p "Press any key..."
exit 0 exit 0
fi fi
# Store the selected runner name and url
runner_name="${runner_versions[$1]}"
if [ "$latest_url" = "$snatella_url" ]; then
# Runners with .tgz file extension
runner_url="$(curl -s "$latest_url" | grep "browser_download_url.*$runner_name.tgz" | cut -d \" -f4)"
else
# Runners with .tar.gz file extension
runner_url="$(curl -s "$latest_url" | grep "browser_download_url.*$runner_name.tar.gz" | cut -d \" -f4)"
fi
# Sanity check # Get the runner filename including file extension
if [ -z "$runner_url" ]; then runner_file="${runner_versions[$1]}"
message warning "Could not find the requested runner. The Github API may be down or rate limited."
return 1
fi
message info "The selected runner will now be downloaded.\nThis might take a moment." # Get the selected runner name minus the file extension
case "$runner_file" in
# Download and extract the runner *.tar.gz)
if [ "$latest_url" = "$snatella_url" ]; then runner_name="$(basename "$runner_file" .tar.gz)"
# Runners without a subdirectory in the archive
debug_echo "Downloading $runner_url\ninto $runner_dir/$runner_name"
mkdir -p "$runner_dir/$runner_name" && curl -L "$runner_url" | tar -xzf - -C "$runner_dir/$runner_name"
lutris_needs_restart="true"
else
# Runners with a subdirectory in the archive
debug_echo "Downloading $runner_url\ninto $runner_dir"
mkdir -p "$runner_dir" && curl -L "$runner_url" | tar -xzf - -C "$runner_dir"
lutris_needs_restart="true"
fi
}
# List available runners for download
runner_select_install() {
# This function expects the name of the runner contributor to be passed in as an argument
if [ -z "$1" ]; then
debug_echo "Script error: The runner_select_install function expects an argument. Aborting."
read -n 1 -s -p "Press any key..."
exit 0
fi
# set download urls
case "$1" in
"snatella")
latest_url="$snatella_url"
runner_versions=($(curl -s "$latest_url" | grep "browser_download_url" | awk '{print $2}' | xargs basename -as .tgz))
;; ;;
"rawfox") *.tgz)
latest_url="$rawfox_url" runner_name="$(basename "$runner_file" .tgz)"
runner_versions=($(curl -s "$latest_url" | grep "browser_download_url" | awk '{print $2}' | xargs basename -as .tar.gz))
;; ;;
*) *)
debug_echo "Script Error: Invalid parameter passed to the runner version function. Aborting." debug_echo "Unknown archive filetype in runner_install function. Aborting."
read -n 1 -s -p "Press any key..." read -n 1 -s -p "Press any key..."
exit 0 exit 0
;; ;;
esac esac
# Get the selected runner url
if [ "$runner_url_type" = "github" ]; then
runner_dl_url="$(curl -s "$contributor_url" | grep "browser_download_url.*$runner_file" | cut -d \" -f4)"
else
debug_echo "Script error: Unknown api/url format in runner_sources array. Aborting."
read -n 1 -s -p "Press any key..."
exit 0
fi
# Sanity check
if [ -z "$runner_dl_url" ]; then
message warning "Could not find the requested runner. The source API may be down or rate limited."
return 1
fi
message info "The selected runner will now be downloaded.\nThis might take a moment."
# Download the runner to the tmp directory
debug_echo "Downloading $runner_dl_url into $tmp_dir/$runner_file..."
(cd "$tmp_dir" && curl -LO "$runner_dl_url")
# Sanity check
if [ ! -f "$tmp_dir/$runner_file" ]; then
debug_echo "Script error: The requested runner file was not downloaded. Aborting"
read -n 1 -s -p "Press any key..."
exit 0
fi
# Get the path of the first item listed in the archive
# This should either be a subdirectory or the path ./
# depending on how the archive was created
first_filepath="$(stdbuf -oL tar -tzf "$tmp_dir/$runner_file" | head -n 1)"
# Download and extract the runner
case "$first_filepath" in
# If the files in the archive begin with ./ there is no subdirectory
./*)
debug_echo "Installing runner into $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"
;;
*)
# Runners with a subdirectory in the archive
debug_echo "Installing runner into $runner_dir..."
mkdir -p "$runner_dir" && tar -xzf "$tmp_dir/$runner_file" -C "$runner_dir"
lutris_needs_restart="true"
;;
esac
# Cleanup tmp download
debug_echo "Removing $tmp_dir/$runner_file..."
rm "$tmp_dir/$runner_file"
}
# List available runners for download
runner_select_install() {
# This function expects an element number for the array runner_sources to be passed in as an argument
if [ -z "$1" ]; then
debug_echo "Script error: The runner_select_install function expects a numerical argument. Aborting."
read -n 1 -s -p "Press any key..."
exit 0
fi
# Store the url from the selected contributor
contributor_url="${runner_sources[$1+1]}"
# Check the provided contributor url to make sure we know how to handle it
case "$contributor_url" in
https://api.github.com*)
runner_url_type="github"
;;
*)
debug_echo "Script error: Unknown api/url format in runner_sources array. Aborting."
read -n 1 -s -p "Press any key..."
exit 0
;;
esac
# Fetch a list of runner versions from the selected contributor
if [ "$runner_url_type" = "github" ]; then
runner_versions=($(curl -s "$contributor_url" | grep "browser_download_url" | awk '{print $2}' | xargs basename -a))
else
debug_echo "Script error: Unknown api/url format in runner_sources array. Aborting."
read -n 1 -s -p "Press any key..."
exit 0
fi
# Sanity check # Sanity check
if [ "${#runner_versions[@]}" -eq 0 ]; then if [ "${#runner_versions[@]}" -eq 0 ]; then
message warning "No runner versions were found. The Github API may be down or rate limited." message warning "No runner versions were found. The source API may be down or rate limited."
return 1 return 1
fi fi
# Configure the menu # Configure the menu
menu_text_zenity="Select the Lutris runner you want to install:" menu_text_zenity="Select the Lutris runner you want to install:"
menu_text_terminal="Select the Lutris runner you want to install:" menu_text_terminal="Select the Lutris runner you want to install:"
menu_text_height="65" menu_text_height="65"
goback="Return to the runner management menu" goback="Return to the runner management menu"
unset menu_options unset menu_options
unset menu_actions unset menu_actions
# Allow up to max_runners to be displayed in the list
if [ "${#runner_versions[@]}" -gt "$max_runners" ]; then
runner_count="$max_runners"
else
runner_count="${#runner_versions[@]}"
fi
# Iterate through the versions, check if they are installed, and add them to the menu options # Iterate through the versions, check if they are installed, and add them to the menu options
for (( i=0; i<"$runner_count"; i++ )); do for (( i=0; i<"$max_runners" && i<"${#runner_versions[@]}"; i++ )); do
if [ -d "$runner_dir/${runner_versions[i]}" ]; then # Get the runner name minus the file extension
menu_options+=("${runner_versions[i]} [installed]") case "${runner_versions[i]}" in
*.tar.gz)
runner_name="$(basename "${runner_versions[i]}" .tar.gz)"
;;
*.tgz)
runner_name="$(basename "${runner_versions[i]}" .tgz)"
;;
*)
debug_echo "Unknown archive filetype in runner_select_install function. Aborting."
read -n 1 -s -p "Press any key..."
exit 0
;;
esac
# Add the runner names to the menu
if [ -d "$runner_dir/$runner_name" ]; then
menu_options+=("$runner_name [installed]")
else else
menu_options+=("${runner_versions[i]}") menu_options+=("$runner_name")
fi fi
menu_actions+=("runner_install $i") menu_actions+=("runner_install $i")
done done
@ -878,14 +942,23 @@ runner_manage() {
menu_text_height="100" menu_text_height="100"
# Configure the menu options # Configure the menu options
rawfox="Install a runner from RawFox"
snatella="Install a runner from Molotov/Snatella"
delete="Remove an installed runner" delete="Remove an installed runner"
back="Return to the main menu" back="Return to the main menu"
# Set the options to be displayed in the menu unset menu_options
menu_options=("$rawfox" "$snatella" "$delete" "$back") unset menu_actions
# Set the corresponding functions to be called for each of the options
menu_actions=("runner_select_install rawfox" "runner_select_install snatella" "runner_select_delete" "runner_manage_done") # Loop through the runner_sources array and create a menu item for each one
# Even numbered elements will contain the runner name
for (( i=0; i<"${#runner_sources[@]}"; i=i+2 )); do
# Set the options to be displayed in the menu
menu_options+=("Install a runner from ${runner_sources[i]}")
# Set the corresponding functions to be called for each of the options
menu_actions+=("runner_select_install $i")
done
# Complete the menu by adding options to remove a runner or to go back to the previous menu
menu_options+=("$delete" "$back")
menu_actions+=("runner_select_delete" "runner_manage_done")
# Calculate the total height the menu should be # Calculate the total height the menu should be
menu_height="$(("$menu_option_height" * "${#menu_options[@]}" + "$menu_text_height"))" menu_height="$(("$menu_option_height" * "${#menu_options[@]}" + "$menu_text_height"))"