Fix version number (don't ask)

Closes #22

lug-helper.sh

@@ -47,6 +47,12 @@
 # https://github.com/richardtatum/sc-runner-updater
 ############################################################################
 
+# Check if script is run as root
+if [ "$(id -u)" -eq 0 ]; then
+    echo "This script is not supposed to be run as root!"
+    exit 1
+fi
+
 # Check for dependencies
 if [ ! -x "$(command -v curl)" ]; then
 # Print to stderr and also try warning the user through notify-send
@@ -75,12 +81,20 @@ conf_subdir="starcitizen-lug"
 tmp_dir="$(mktemp -d --suffix=".lughelper")"
 trap 'rm -r "$tmp_dir"' EXIT
 
-# The game's user subdirectory name
-user_subdir_name="USER"
-# The location within the USER directory to which the game exports keybinds
-keybinds_export_path="Controls/Mappings"
+######## Game Directories ##################################################
 
-dxvk_cache_file="StarCitizen.dxvk-cache"
+# The game's base directory name
+sc_base_dir="StarCitizen"
+# The default install location within a WINE prefix:
+install_path="drive_c/Program Files/Roberts Space Industries/$sc_base_dir"
+
+# The names of the live/ptu directories
+live_dir="LIVE"
+ptu_dir="PTU"
+
+# Remaining directory paths are set at the end of the getdirs() function
+
+############################################################################
 
 # Lutris wine runners directory
 runners_dir="$data_dir/lutris/runners/wine"
@@ -92,6 +106,8 @@ runners_dir="$data_dir/lutris/runners/wine"
 runner_sources=(
     "RawFox" "https://api.github.com/repos/rawfoxDE/raw-wine/releases"
     "Molotov/Snatella" "https://api.github.com/repos/snatella/wine-runner-sc/releases"
+    "/dev/null" "https://api.github.com/repos/gort818/wine-sc-lug/releases"
+    "GloriousEggroll" "https://api.github.com/repos/GloriousEggroll/wine-ge-custom/releases"
 )
 # Set a maximum number of runner versions to display from each url
 max_runners=20
@@ -110,6 +126,11 @@ else
     lug_logo="info"
 fi
 
+# Github repo and script version info
+repo="the-sane/lug-helper"
+releases_url="https://github.com/the-sane/lug-helper/releases"
+current_version="v1.9.2"
+
 ############################################################################
 ############################################################################
 
@@ -242,6 +263,7 @@ message() {
 #   This text will be displayed above the menu options.
 #   Zenity supports Pango Markup for text formatting.
 # - The integer "menu_height" specifies the height of the zenity menu.
+# - The string "cancel_label" should contain the text of the cancel button.
 # 
 # The final element in each array is expected to be a quit option.
 #
@@ -263,6 +285,8 @@ menu() {
         debug_print exit "Script error: The string 'menu_text_terminal' was not set\nbefore calling the menu function. Aborting."
     elif [ -z "$menu_height" ]; then
         debug_print exit "Script error: The string 'menu_height' was not set\nbefore calling the menu function. Aborting."
+    elif [ -z "$cancel_label" ]; then
+        debug_print exit "Script error: The string 'menu_height' was not set\nbefore calling the menu function. Aborting."
     fi
     
     # Use Zenity if it is available
@@ -282,7 +306,7 @@ menu() {
         done
 
         # Display the zenity radio button menu
-        choice="$(zenity --list --radiolist --width="480" --height="$menu_height" --text="$menu_text_zenity" --title="Star Citizen LUG Helper" --hide-header --window-icon=$lug_logo --column="" --column="Option" "${zen_options[@]}" 2>/dev/null)"
+        choice="$(zenity --list --radiolist --width="480" --height="$menu_height" --text="$menu_text_zenity" --title="Star Citizen LUG Helper" --hide-header --cancel-label "$cancel_label" --window-icon=$lug_logo --column="" --column="Option" "${zen_options[@]}" 2>/dev/null)"
 
         # Loop through the options array to match the chosen option
         matched="false"
@@ -360,7 +384,7 @@ getdirs() {
     fi
     if [ -f "$conf_dir/$conf_subdir/$game_conf" ]; then
         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")" != "$sc_base_dir" ]; then
             debug_print continue "Unexpected game path found in config file, ignoring."
             game_path=""
         fi
@@ -387,15 +411,15 @@ getdirs() {
 
             # Get the game path
             if [ -z "$game_path" ]; then
-                if [ -d "$wine_prefix/drive_c/Program Files/Roberts Space Industries/StarCitizen" ] && 
-                       message question "Is this your Star Citizen game directory?\n\n$wine_prefix/drive_c/Program Files/Roberts Space Industries/StarCitizen"; then
-                    game_path="$wine_prefix/drive_c/Program Files/Roberts Space Industries/StarCitizen"
+                if [ -d "$wine_prefix/$install_path" ] && 
+                       message question "Is this your Star Citizen game directory?\n\n$wine_prefix/$install_path"; then
+                    game_path="$wine_prefix/$install_path"
                 else
-                    while game_path="$(zenity --file-selection --directory --title="Select your Star Citizen directory" --filename="$wine_prefix/drive_c/Program Files/Roberts Space Industries/StarCitizen" 2>/dev/null)"; do
+                    while game_path="$(zenity --file-selection --directory --title="Select your Star Citizen directory" --filename="$wine_prefix/$install_path" 2>/dev/null)"; do
                         if [ "$?" -eq -1 ]; then
                             message warning "An unexpected error has occurred. The Helper is unable to proceed."
                             return 1
-                        elif [ "$(basename "$game_path")" != "StarCitizen" ]; then
+                        elif [ "$(basename "$game_path")" != "$sc_base_dir" ]; then
                             message warning "You must select the Star Citizen base game directory.\n\nFor Example:  prefix/drive_c/Program Files/Roberts Space Industries/StarCitizen"
                         else
                             # All good or cancel
@@ -428,17 +452,17 @@ getdirs() {
 
             # Get the game path
             if [ -z "$game_path" ]; then
-                if [ -d "$wine_prefix/drive_c/Program Files/Roberts Space Industries/StarCitizen" ] && 
-                       message question "Is this your Star Citizen game directory?\n\n$wine_prefix/drive_c/Program Files/Roberts Space Industries/StarCitizen"; then
-                    game_path="$wine_prefix/drive_c/Program Files/Roberts Space Industries/StarCitizen"
+                if [ -d "$wine_prefix/$install_path" ] && 
+                       message question "Is this your Star Citizen game directory?\n\n$wine_prefix/$install_path"; then
+                    game_path="$wine_prefix/$install_path"
                 else
                     printf "\nEnter the full path to your Star Citizen installation directory (case sensitive)\n"
                     printf "ie. /home/USER/Games/star-citizen/drive_c/Program Files/Roberts Space Industries/StarCitizen\n"
                     while read -rp ": " game_path; do
                         if [ ! -d "$game_path" ]; then
                             printf "That directory is invalid or does not exist. Please try again.\n\n"
-                        elif [ "$(basename "$game_path")" != "StarCitizen" ]; then
-                            printf "You must enter the full path to the directory named 'StarCitizen'\n\n"
+                        elif [ "$(basename "$game_path")" != "$sc_base_dir" ]; then
+                            printf "You must enter the full path to the directory named '$sc_base_dir'\n\n"
                         else
                             break
                         fi
@@ -452,9 +476,18 @@ getdirs() {
         echo "$game_path" > "$conf_dir/$conf_subdir/$game_conf"
     fi
 
-    # Set some remaining directory paths
-    user_dir="$game_path/$live_or_ptu/$user_subdir_name"
-    keybinds_dir="$user_dir/$keybinds_export_path"
+    ######## Set remaining directory paths #####################################
+    # $live_or_ptu is set in the set_version() function
+    ############################################################################
+    # The game's user directory
+    user_dir="$game_path/$live_or_ptu/USER/Client/0"
+    # The location within the USER directory to which the game exports keybinds
+    keybinds_dir="$user_dir/Controls/Mappings"
+    # Shaders directory
+    shaders_dir="$user_dir/shaders"
+    # dxvk cache file
+    dxvk_cache="$game_path/$live_or_ptu/StarCitizen.dxvk-cache"
+    # Where to store backed up keybinds
     backup_path="$conf_dir/$conf_subdir"
 }
 
@@ -640,7 +673,7 @@ filelimit_check() {
 
 # Check total system memory
 memory_check() {
-    memtotal="$(awk '/MemTotal/ {printf "%.1f \n", $2/1024/1024}' /proc/meminfo)"
+    memtotal="$(LC_NUMERIC=C awk '/MemTotal/ {printf "%.1f \n", $2/1024/1024}' /proc/meminfo)"
     if [ ${memtotal%.*} -ge "15" ]; then
         preflight_pass+=("Your system has $memtotal GB of memory.")  
     else
@@ -668,8 +701,6 @@ rm_shaders() {
         return 0
     fi
 
-    shaders_dir="$user_dir/shaders"
-
     # Sanity check
     if [ ! -d "$shaders_dir" ]; then
         message warning "Shaders directory not found. There is nothing to delete!\n\n$shaders_dir"
@@ -694,8 +725,6 @@ rm_dxvkcache() {
         return 0
     fi
 
-    dxvk_cache="$game_path/$live_or_ptu/$dxvk_cache_file"
-    
     # Sanity check
     if [ ! -f "$dxvk_cache" ]; then
         message warning "Unable to find the DXVK cache file. There is nothing to delete!\n\n$dxvk_cache"
@@ -773,6 +802,9 @@ runner_select_delete() {
         menu_height="400"
     fi
     
+    # Set the label for the cancel button
+    cancel_label="Go Back"
+       
     # Call the menu function.  It will use the options as configured above
     menu
 }
@@ -800,6 +832,9 @@ runner_install() {
         *.tgz)
             runner_name="$(basename "$runner_file" .tgz)"
             ;;
+        *.tar.xz)
+            runner_name="$(basename "$runner_file" .tar.xz)"
+            ;;
         *)
             debug_print exit "Unknown archive filetype in runner_install function. Aborting."
             ;;
@@ -854,7 +889,7 @@ runner_install() {
     # 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)"
+    first_filepath="$(stdbuf -oL tar -tf "$tmp_dir/$runner_file" | head -n 1)"
     
     # Extract the runner
     case "$first_filepath" in
@@ -863,10 +898,10 @@ runner_install() {
             debug_print continue "Installing runner into $runners_dir/$runner_name..."
             if [ "$use_zenity" -eq 1 ]; then
                 # Use Zenity progress bar
-                mkdir -p "$runners_dir/$runner_name" && tar -xzf "$tmp_dir/$runner_file" -C "$runners_dir/$runner_name" | \
+                mkdir -p "$runners_dir/$runner_name" && tar -xf "$tmp_dir/$runner_file" -C "$runners_dir/$runner_name" | \
                 zenity --progress --pulsate --no-cancel --auto-close --title="Star Citizen LUG Helper" --text="Installing runner...\n" 2>/dev/null
             else
-                mkdir -p "$runners_dir/$runner_name" && tar -xzf "$tmp_dir/$runner_file" -C "$runners_dir/$runner_name"
+                mkdir -p "$runners_dir/$runner_name" && tar -xf "$tmp_dir/$runner_file" -C "$runners_dir/$runner_name"
             fi
             lutris_needs_restart="true"
             ;;
@@ -875,10 +910,10 @@ runner_install() {
             debug_print continue "Installing runner into $runners_dir..."
             if [ "$use_zenity" -eq 1 ]; then
                 # Use Zenity progress bar
-                mkdir -p "$runners_dir" && tar -xzf "$tmp_dir/$runner_file" -C "$runners_dir" | \
+                mkdir -p "$runners_dir" && tar -xf "$tmp_dir/$runner_file" -C "$runners_dir" | \
                 zenity --progress --pulsate --no-cancel --auto-close --title="Star Citizen LUG Helper" --text="Installing runner...\n" 2>/dev/null
             else
-                mkdir -p "$runners_dir" && tar -xzf "$tmp_dir/$runner_file" -C "$runners_dir"
+                mkdir -p "$runners_dir" && tar -xf "$tmp_dir/$runner_file" -C "$runners_dir"
             fi
             lutris_needs_restart="true"
             ;;
@@ -897,7 +932,8 @@ runner_select_install() {
         debug_print exit "Script error:  The runner_select_install function expects a numerical argument. Aborting."
     fi
 
-    # Store the url from the selected contributor
+    # Store info from the selected contributor
+    contributor_name="${runner_sources[$1]}"
     contributor_url="${runner_sources[$1+1]}"
 
     # Check the provided contributor url to make sure we know how to handle it
@@ -912,11 +948,22 @@ runner_select_install() {
             ;;
     esac
     
+    # Check GlibC version against the requirements of the selected runner
+    if [ "$contributor_name" = "/dev/null" ]; then
+        required_glibc="2.33"
+        system_glibc="$(ldd --version | awk '/ldd/{print $NF}')"
+
+        if [ "$(bc <<< "$required_glibc > $system_glibc")" = "1" ]; then
+            message warning "Your glibc version is incompatible with the selected runner.\n\nSystem glibc: v$system_glibc\nMinimum required glibc: v$required_glibc"
+            return 1
+        fi
+    fi
+
     # Fetch a list of runner versions from the selected contributor
     # To add new sources, handle them here, in the if statement
     # just above, and the runner_install function above
     if [ "$runner_url_type" = "github" ]; then
-        runner_versions=($(curl -s "$contributor_url" | awk '/browser_download_url/ {print $2}' | xargs basename -a))
+        runner_versions=($(curl -s "$contributor_url" | awk '/browser_download_url/ {print $2}' | grep -vE "*.sha512sum" | xargs basename -a))
     else
         debug_print exit "Script error:  Unknown api/url format in runner_sources array. Aborting."
     fi
@@ -948,6 +995,9 @@ runner_select_install() {
             *.tgz)
                 runner_name="$(basename "${runner_versions[i]}" .tgz)"
                 ;;
+            *.tar.xz)
+                runner_name="$(basename "${runner_versions[i]}" .tar.xz)"
+                ;;        
             *)
                 debug_print exit "Unknown archive filetype in runner_select_install function. Aborting."
                 ;;
@@ -972,6 +1022,9 @@ runner_select_install() {
         menu_height="400"
     fi
     
+    # Set the label for the cancel button
+    cancel_label="Go Back"
+       
     # Call the menu function.  It will use the options as configured above
     menu
 }
@@ -1019,6 +1072,9 @@ runner_manage() {
         # Calculate the total height the menu should be
         menu_height="$(($menu_option_height * ${#menu_options[@]} + $menu_text_height))"
         
+       # Set the label for the cancel button
+       cancel_label="Go Back"
+       
         # Call the menu function.  It will use the options as configured above
         menu
     done
@@ -1157,6 +1213,9 @@ maintenance_menu() {
         # Calculate the total height the menu should be
         menu_height="$(($menu_option_height * ${#menu_options[@]} + $menu_text_height))"
        
+       # Set the label for the cancel button
+       cancel_label="Go Back"
+       
         # Call the menu function.  It will use the options as configured above
         menu
     done
@@ -1165,7 +1224,7 @@ maintenance_menu() {
 # Get a random Penguin's Star Citizen referral code
 referral_randomizer() {
     # Populate the referral codes array
-    referral_codes=("STAR-4TZD-6KMM" "STAR-4XM2-VM99" "STAR-2NPY-FCR2" "STAR-T9Z9-7W6P" "STAR-VLBF-W2QR" "STAR-BYR6-YHMF" "STAR-3X2H-VZMX" "STAR-BRWN-FB9T" "STAR-FG6Y-N4Q4" "STAR-VLD6-VZRG" "STAR-T9KF-LV77" "STAR-4XHB-R7RF" "STAR-9NVF-MRN7" "STAR-3Q4W-9TC3" "STAR-3SBK-7QTT" "STAR-XFBT-9TTK" "STAR-F3H9-YPHN" "STAR-BYK6-RCCL" "STAR-XCKH-W6T7" "STAR-H292-39WK" "STAR-ZRT5-PJB7" "STAR-GMBP-SH9Y" "STAR-PLWB-LMFY" "STAR-TNZN-H4ZT")
+    referral_codes=("STAR-4TZD-6KMM" "STAR-4XM2-VM99" "STAR-2NPY-FCR2" "STAR-T9Z9-7W6P" "STAR-VLBF-W2QR" "STAR-BYR6-YHMF" "STAR-3X2H-VZMX" "STAR-BRWN-FB9T" "STAR-FG6Y-N4Q4" "STAR-VLD6-VZRG" "STAR-T9KF-LV77" "STAR-4XHB-R7RF" "STAR-9NVF-MRN7" "STAR-3Q4W-9TC3" "STAR-3SBK-7QTT" "STAR-XFBT-9TTK" "STAR-F3H9-YPHN" "STAR-BYK6-RCCL" "STAR-XCKH-W6T7" "STAR-H292-39WK" "STAR-ZRT5-PJB7" "STAR-GMBP-SH9Y" "STAR-PLWB-LMFY" "STAR-TNZN-H4ZT" "STAR-T5G5-L2GJ" "STAR-6TPV-7QH2" "STAR-THHD-TV3Y")
     # Pick a random array element. Scale a floating point number for
     # a more random distribution than simply calling RANDOM
     random_code="${referral_codes[$(awk '{srand($2); print int(rand()*$1)}' <<< "${#referral_codes[@]} $RANDOM")]}"
@@ -1175,15 +1234,15 @@ referral_randomizer() {
 
 # Toggle between the LIVE and PTU game directories for all Helper functions
 set_version() {
-    if [ "$live_or_ptu" = "LIVE" ]; then
-        live_or_ptu="PTU"
+    if [ "$live_or_ptu" = "$live_dir" ]; then
+        live_or_ptu="$ptu_dir"
         message info "The Helper will now target your Star Citizen PTU installation."
-    elif [ "$live_or_ptu" = "PTU" ]; then
-        live_or_ptu="LIVE"
+    elif [ "$live_or_ptu" = "$ptu_dir" ]; then
+        live_or_ptu="$live_dir"
         message info "The Helper will now target your Star Citizen LIVE installation."
     else
         debug_print continue "Unexpected game version provided.  Defaulting to the LIVE installation."
-        live_or_ptu="LIVE"
+        live_or_ptu="$live_dir"
     fi
 }
 
@@ -1197,6 +1256,19 @@ reset_helper() {
     fi
 }
 
+# Get the latest release version of a repo. Expects "user/repo_name" as input
+# Credits for this go to https://gist.github.com/lukechilds/a83e1d7127b78fef38c2914c4ececc3c
+get_latest_release() {
+    # Sanity check
+    if [ "$#" -lt 1 ]; then
+        debug_print exit "Script error: The get_latest_release function expects one argument. Aborting."
+    fi
+    
+    curl --silent "https://api.github.com/repos/$1/releases/latest" | # Get latest release from GitHub api
+        grep '"tag_name":' |                                            # Get tag line
+        sed -E 's/.*"([^"]+)".*/\1/'                                    # Pluck JSON value
+}
+
 quit() {
     exit 0
 }
@@ -1213,9 +1285,22 @@ if [ -x "$(command -v zenity)" ]; then
 fi
 
 # Set some defaults
-live_or_ptu="LIVE"
+live_or_ptu="$live_dir"
 lutris_needs_restart="false"
 
+# Check if a newer verison of the script is available
+latest_version=$(get_latest_release "$repo")
+
+if [ "$latest_version" != "$current_version" ]; then
+    if [ "$use_zenity" -eq 1 ]; then
+        releases_url_formatted="<a href='$releases_url'>$releases_url</a>"
+    else
+        releases_url_formatted="$releases_url"
+    fi
+    
+    message info "The latest version of the LUG Helper is $latest_version\nYou are using $current_version\n\nYou can download new releases here:\n$releases_url_formatted"
+fi
+
 # If invoked with command line arguments, process them and exit
 if [ "$#" -gt 0 ]; then
     while [ "$#" -gt 0 ]
@@ -1255,9 +1340,9 @@ Usage: lug-helper <options>
             --target=* | -t=* )
                 live_or_ptu="$(echo "$1" | cut -d'=' -f2)"
                 if [ "$live_or_ptu" = "live" ] || [ "$live_or_ptu" = "LIVE" ]; then
-                    live_or_ptu="LIVE"
+                    live_or_ptu="$live_dir"
                 elif [ "$live_or_ptu" = "ptu" ] || [ "$live_or_ptu" = "PTU" ]; then
-                    live_or_ptu="PTU"
+                    live_or_ptu="$ptu_dir"
                 else
                     printf "$0: Invalid option '$1'\n"
                     exit 0
@@ -1324,6 +1409,9 @@ while true; do
     # Calculate the total height the menu should be
     menu_height="$(($menu_option_height * ${#menu_options[@]} + $menu_text_height))"
     
+    # Set the label for the cancel button
+    cancel_label="Quit"
+    
     # Call the menu function.  It will use the options as configured above
     menu
 done