# Store the non-zero exit status received by the trap.

local EXIT_STATUS=$?

# Display the exit status.

echo -e "${EXIT_TEXT}Exiting with status '${EXIT_STATUS}'.${CLEAR_TEXT}"

# Terminate the script.

exit "$EXIT_STATUS"

echo -e "Usage:

${COMMAND_TEXT}./setup.sh --user${CLEAR_TEXT} # Install WinApps and selected applications in ${HOME}

${COMMAND_TEXT}./setup.sh --system${CLEAR_TEXT} # Install WinApps and selected applications in /usr

${COMMAND_TEXT}./setup.sh --user --setupAllOfficiallySupportedApps${CLEAR_TEXT} # Install WinApps and all officially supported applications in ${HOME}

${COMMAND_TEXT}./setup.sh --system --setupAllOfficiallySupportedApps${CLEAR_TEXT} # Install WinApps and all officially supported applications in /usr

${COMMAND_TEXT}./setup.sh --user --uninstall${CLEAR_TEXT} # Uninstall everything in ${HOME}

${COMMAND_TEXT}./setup.sh --system --uninstall${CLEAR_TEXT} # Uninstall everything in /usr

${COMMAND_TEXT}./setup.sh --help${CLEAR_TEXT} # Display this usage message."

# Declare variables.

local SCRIPT_DIR_PATH="" # Stores the absolute path of the directory containing the script.

# Determine the absolute path to the directory containing the script.

SCRIPT_DIR_PATH=$(readlink -f "$(dirname "${BASH_SOURCE[0]}")")

# Check if winapps is currently installed on $SOURCE_PATH

if [ -f "$SCRIPT_DIR_PATH/winapps" ] && [ "$SCRIPT_DIR_PATH" -ne "$SOURCE_PATH" ]; then

# Display a warning.

echo -e "${WARNING_TEXT}[WARNING]${CLEAR_TEXT} You are running a WinApps installation located outside of default location '${SOURCE_PATH}'. A new installation will be created."

echo -e "${WARNING_TEXT}[WARNING]${CLEAR_TEXT} You might want to remove your old installation on '${SCRIPT_DIR_PATH}'."

fi

if [[ ! -d "$SOURCE_PATH" ]]; then

$SUDO git clone --recurse-submodules --remote-submodules https://github.com/winapps-org/winapps.git "$SOURCE_PATH"

else

echo -e "${INFO_TEXT}WinApps installation already present at ${CLEAR_TEXT}${COMMAND_TEXT}${SOURCE_PATH}${CLEAR_TEXT}${INFO_TEXT}. Updating...${CLEAR_TEXT}"

$SUDO git -C "$SOURCE_PATH" pull --no-rebase

fi

# Silently change the working directory.

if ! cd "$SOURCE_PATH" &>/dev/null; then

# Display the error type.

echo -e "${ERROR_TEXT}ERROR:${CLEAR_TEXT} ${BOLD_TEXT}DIRECTORY CHANGE FAILURE.${CLEAR_TEXT}"

# Display error details.

echo -e "${INFO_TEXT}Failed to change the working directory to ${CLEAR_TEXT}${COMMAND_TEXT}${SOURCE_PATH}${CLEAR_TEXT}${INFO_TEXT}.${CLEAR_TEXT}"

# Display the suggested action(s).

echo "--------------------------------------------------------------------------------"

echo "Ensure:"

echo -e " - ${COMMAND_TEXT}${SOURCE_PATH}${CLEAR_TEXT} exists."

echo -e " - ${COMMAND_TEXT}${SOURCE_PATH}${CLEAR_TEXT} has been cloned and checked out properly."

echo -e " - The current user has sufficient permissions to access and write to ${COMMAND_TEXT}${SOURCE_PATH}${CLEAR_TEXT}."

echo "--------------------------------------------------------------------------------"

# Terminate the script.

return "$EC_FAILED_CD"

fi

local PROMPT="$1"

shift

local -n OPTIONS_REF="$1"

local -n RESULT="$2"

local ZENITY_OPTIONS=()

for option in "${OPTIONS_REF[@]}"; do

ZENITY_OPTIONS+=("$option")

done

RESULT=$(zenity --list \

--title="WinApps Setup" \

--text="$PROMPT" \

--column="Options" \

"${ZENITY_OPTIONS[@]}" \

--width=400 --height=300 \

--print-column=ALL)

local PROMPT="$1"

shift

local -n OPTIONS="$1"

local -n RESULT="$2"

RESULT=($(zenity --list \

--title="WinApps Setup" \

--text="$PROMPT" \

--checklist \

--column="Select" \

--column="Options" \

$(printf "FALSE %s " "${OPTIONS[@]}") \

--width=400 --height=300 \

--print-column=2))

# Declare variables.

local OPTIONS=() # Stores the options.

local SELECTED_OPTION # Stores the option selected by the user.

if [[ $# -gt 0 ]]; then

# Parse arguments.

for argument in "$@"; do

case "$argument" in

"--user")

OPT_USER=1

;;

"--system")

OPT_SYSTEM=1

;;

"--setupAllOfficiallySupportedApps")

OPT_AOSA=1

;;

"--uninstall")

OPT_UNINSTALL=1

;;

"--help")

waUsage

exit 0

;;

*)

# Display the error type.

echo -e "${ERROR_TEXT}ERROR:${CLEAR_TEXT} ${BOLD_TEXT}INVALID ARGUMENT.${CLEAR_TEXT}"

# Display the error details.

echo -e "${INFO_TEXT}Unsupported argument${CLEAR_TEXT} ${COMMAND_TEXT}${argument}${CLEAR_TEXT}${INFO_TEXT}.${CLEAR_TEXT}"

# Display the suggested action(s).

echo "--------------------------------------------------------------------------------"

waUsage

echo "--------------------------------------------------------------------------------"

# Terminate the script.

return "$EC_BAD_ARGUMENT"

;;

esac

done

else

# Install vs. uninstall?

OPTIONS=("Install" "Uninstall")

inqMenu "Install or uninstall WinApps?" OPTIONS SELECTED_OPTION

# Set flags.

if [[ $SELECTED_OPTION == "Uninstall" ]]; then

OPT_UNINSTALL=1

fi

# User vs. system?

OPTIONS=("Current User" "System")

inqMenu "Configure WinApps for the current user '$(whoami)' or the whole system?" OPTIONS SELECTED_OPTION

# Set flags.

if [[ $SELECTED_OPTION == "Current User" ]]; then

OPT_USER=1

elif [[ $SELECTED_OPTION == "System" ]]; then

OPT_SYSTEM=1

fi

# Automatic vs. manual?

if [ "$OPT_UNINSTALL" -eq 0 ]; then

OPTIONS=("Manual (Default)" "Automatic")

inqMenu "Automatically install supported applications or choose manually?" OPTIONS SELECTED_OPTION

# Set flags.

if [[ $SELECTED_OPTION == "Automatic" ]]; then

OPT_AOSA=1

fi

fi

# Newline.

echo ""

fi

# Simultaneous 'User' and 'System'.

if [ "$OPT_SYSTEM" -eq 1 ] && [ "$OPT_USER" -eq 1 ]; then

# Display the error type.

echo -e "${ERROR_TEXT}ERROR:${CLEAR_TEXT} ${BOLD_TEXT}CONFLICTING ARGUMENTS.${CLEAR_TEXT}"

# Display the error details.

echo -e "${INFO_TEXT}You cannot specify both${CLEAR_TEXT} ${COMMAND_TEXT}--user${CLEAR_TEXT} ${INFO_TEXT}and${CLEAR_TEXT} ${COMMAND_TEXT}--system${CLEAR_TEXT} ${INFO_TEXT}simultaneously.${CLEAR_TEXT}"

# Display the suggested action(s).

echo "--------------------------------------------------------------------------------"

waUsage

echo "--------------------------------------------------------------------------------"

# Terminate the script.

return "$EC_BAD_ARGUMENT"

fi

# Simultaneous 'Uninstall' and 'AOSA'.

if [ "$OPT_UNINSTALL" -eq 1 ] && [ "$OPT_AOSA" -eq 1 ]; then

# Display the error type.

echo -e "${ERROR_TEXT}ERROR:${CLEAR_TEXT} ${BOLD_TEXT}CONFLICTING ARGUMENTS.${CLEAR_TEXT}"

# Display the error details.

echo -e "${INFO_TEXT}You cannot specify both${CLEAR_TEXT} ${COMMAND_TEXT}--uninstall${CLEAR_TEXT} ${INFO_TEXT}and${CLEAR_TEXT} ${COMMAND_TEXT}--aosa${CLEAR_TEXT} ${INFO_TEXT}simultaneously.${CLEAR_TEXT}"

# Display the suggested action(s).

echo "--------------------------------------------------------------------------------"

waUsage

echo "--------------------------------------------------------------------------------"

# Terminate the script.

return "$EC_BAD_ARGUMENT"

fi

# No 'User' or 'System'.

if [ "$OPT_SYSTEM" -eq 0 ] && [ "$OPT_USER" -eq 0 ]; then

# Display the error type.

echo -e "${ERROR_TEXT}ERROR:${CLEAR_TEXT} ${BOLD_TEXT}INSUFFICIENT ARGUMENTS.${CLEAR_TEXT}"

# Display the error details.

echo -e "${INFO_TEXT}You must specify either${CLEAR_TEXT} ${COMMAND_TEXT}--user${CLEAR_TEXT} ${INFO_TEXT}or${CLEAR_TEXT} ${COMMAND_TEXT}--system${CLEAR_TEXT} ${INFO_TEXT}to proceed.${CLEAR_TEXT}"

# Display the suggested action(s).

echo "--------------------------------------------------------------------------------"

waUsage

echo "--------------------------------------------------------------------------------"

# Terminate the script.

return "$EC_BAD_ARGUMENT"

fi

if [ "$OPT_USER" -eq 1 ]; then

SUDO=""

SOURCE_PATH="$USER_SOURCE_PATH"

BIN_PATH="$USER_BIN_PATH"

APP_PATH="$USER_APP_PATH"

APPDATA_PATH="$USER_APPDATA_PATH"

elif [ "$OPT_SYSTEM" -eq 1 ]; then

SUDO="sudo"

SOURCE_PATH="$SYS_SOURCE_PATH"

BIN_PATH="$SYS_BIN_PATH"

APP_PATH="$SYS_APP_PATH"

APPDATA_PATH="$SYS_APPDATA_PATH"

# Preemptively obtain superuser privileges.

sudo -v || {

# Display the error type.

echo -e "${ERROR_TEXT}ERROR:${CLEAR_TEXT} ${BOLD_TEXT}AUTHENTICATION FAILURE.${CLEAR_TEXT}"

# Display the error details.

echo -e "${INFO_TEXT}Failed to gain superuser privileges.${CLEAR_TEXT}"

# Display the suggested action(s).

echo "--------------------------------------------------------------------------------"

echo "Please check your password and try again."

echo "If you continue to experience issues, contact your system administrator."

echo "--------------------------------------------------------------------------------"

# Terminate the script.

return "$EC_NO_SUDO"

}

fi

# Print feedback.

echo -n "Checking for existing conflicting WinApps installations... "

# Check for an existing 'user' installation.

if [[ -f "${USER_BIN_PATH}/winapps" || -d "${USER_SOURCE_PATH}/winapps" ]]; then

# Complete the previous line.

echo -e "${FAIL_TEXT}Failed!${CLEAR_TEXT}\n"

# Display the error type.

echo -e "${ERROR_TEXT}ERROR:${CLEAR_TEXT} ${BOLD_TEXT}EXISTING 'USER' WINAPPS INSTALLATION.${CLEAR_TEXT}"

# Display the error details.

echo -e "${INFO_TEXT}A previous WinApps installation was detected for the current user.${CLEAR_TEXT}"

# Display the suggested action(s).

echo "--------------------------------------------------------------------------------"

echo -e "Please remove the existing WinApps installation using ${COMMAND_TEXT}./setup.sh --user --uninstall${CLEAR_TEXT}."

echo "--------------------------------------------------------------------------------"

# Terminate the script.

return "$EC_EXISTING_INSTALL"

fi

# Check for an existing 'system' installation.

if [[ -f "${SYS_BIN_PATH}/winapps" || -d "${SYS_SOURCE_PATH}/winapps" ]]; then

# Complete the previous line.

echo -e "${FAIL_TEXT}Failed!${CLEAR_TEXT}\n"

# Display the error type.

echo -e "${ERROR_TEXT}ERROR:${CLEAR_TEXT} ${BOLD_TEXT}EXISTING 'SYSTEM' WINAPPS INSTALLATION.${CLEAR_TEXT}"

# Display the error details.

echo -e "${INFO_TEXT}A previous system-wide WinApps installation was detected.${CLEAR_TEXT}"

# Display the suggested action(s).

echo "--------------------------------------------------------------------------------"

echo -e "Please remove the existing WinApps installation using ${COMMAND_TEXT}./setup.sh --system --uninstall${CLEAR_TEXT}."

echo "--------------------------------------------------------------------------------"

# Terminate the script.

return "$EC_EXISTING_INSTALL"

fi

# Print feedback.

echo -e "${DONE_TEXT}Done!${CLEAR_TEXT}"

# Define variables.

local OLD_SCALE=100

local VALID_SCALE_1=100

local VALID_SCALE_2=140

local VALID_SCALE_3=180

# Check for an unsupported value.

if [ "$RDP_SCALE" != "$VALID_SCALE_1" ] && [ "$RDP_SCALE" != "$VALID_SCALE_2" ] && [ "$RDP_SCALE" != "$VALID_SCALE_3" ]; then

# Save the unsupported scale.

OLD_SCALE="$RDP_SCALE"

# Calculate the absolute differences.

local DIFF_1=$((RDP_SCALE > VALID_SCALE_1 ? RDP_SCALE - VALID_SCALE_1 : VALID_SCALE_1 - RDP_SCALE))

local DIFF_2=$((RDP_SCALE > VALID_SCALE_2 ? RDP_SCALE - VALID_SCALE_2 : VALID_SCALE_2 - RDP_SCALE))

local DIFF_3=$((RDP_SCALE > VALID_SCALE_3 ? RDP_SCALE - VALID_SCALE_3 : VALID_SCALE_3 - RDP_SCALE))

# Set the final scale to the valid scale value with the smallest absolute difference.

if ((DIFF_1 <= DIFF_2 && DIFF_1 <= DIFF_3)); then

RDP_SCALE="$VALID_SCALE_1"

elif ((DIFF_2 <= DIFF_1 && DIFF_2 <= DIFF_3)); then

RDP_SCALE="$VALID_SCALE_2"

else

RDP_SCALE="$VALID_SCALE_3"

fi

# Print feedback.

echo -e "${WARNING_TEXT}[WARNING]${CLEAR_TEXT} Unsupported RDP_SCALE value '${OLD_SCALE}' detected. Defaulting to '${RDP_SCALE}'."

fi

# Print feedback.

echo -n "Attempting to load WinApps configuration file... "

if [ ! -f "$CONFIG_PATH" ]; then

# Complete the previous line.

echo -e "${FAIL_TEXT}Failed!${CLEAR_TEXT}\n"

# Display the error type.

echo -e "${ERROR_TEXT}ERROR:${CLEAR_TEXT} ${BOLD_TEXT}MISSING CONFIGURATION FILE.${CLEAR_TEXT}"

# Display the error details.

echo -e "${INFO_TEXT}A valid WinApps configuration file was not found.${CLEAR_TEXT}"

# Display the suggested action(s).

echo "--------------------------------------------------------------------------------"

echo -e "Please create a configuration file at ${COMMAND_TEXT}${CONFIG_PATH}${CLEAR_TEXT}."

echo -e "See https://github.com/winapps-org/winapps?tab=readme-ov-file#step-3-create-a-winapps-configuration-file"

echo "--------------------------------------------------------------------------------"

# Terminate the script.

return "$EC_NO_CONFIG"

else

# Load the WinApps configuration file.

# shellcheck source=/dev/null # Exclude this file from being checked by ShellCheck.

source "$CONFIG_PATH"

fi

# Print feedback.

echo -e "${DONE_TEXT}Done!${CLEAR_TEXT}"

# 'Git'

if ! command -v git &>/dev/null; then

# Display the error type.

echo -e "${ERROR_TEXT}ERROR:${CLEAR_TEXT} ${BOLD_TEXT}MISSING DEPENDENCIES.${CLEAR_TEXT}"

# Display the error details.

echo -e "${INFO_TEXT}Please install 'git' to proceed.${CLEAR_TEXT}"

# Display the suggested action(s).

echo "--------------------------------------------------------------------------------"

echo "Debian/Ubuntu-based systems:"

echo -e " ${COMMAND_TEXT}sudo apt install git${CLEAR_TEXT}"

echo "Red Hat/Fedora-based systems:"

echo -e " ${COMMAND_TEXT}sudo dnf install git${CLEAR_TEXT}"

echo "Arch Linux systems:"

echo -e " ${COMMAND_TEXT}sudo pacman -S git${CLEAR_TEXT}"

echo "Gentoo Linux systems:"

echo -e " ${COMMAND_TEXT}sudo emerge --ask dev-vcs/git${CLEAR_TEXT}"

echo "--------------------------------------------------------------------------------"

# Terminate the script.

return "$EC_MISSING_DEPS"

fi

# 'curl'

if ! command -v curl &>/dev/null; then

# Display the error type.

echo -e "${ERROR_TEXT}ERROR:${CLEAR_TEXT} ${BOLD_TEXT}MISSING DEPENDENCIES.${CLEAR_TEXT}"

# Display the error details.

echo -e "${INFO_TEXT}Please install 'curl' to proceed.${CLEAR_TEXT}"

# Display the suggested action(s).

echo "--------------------------------------------------------------------------------"

echo "Debian/Ubuntu-based systems:"

echo -e " ${COMMAND_TEXT}sudo apt install curl${CLEAR_TEXT}"

echo "Red Hat/Fedora-based systems:"

echo -e " ${COMMAND_TEXT}sudo dnf install curl${CLEAR_TEXT}"

echo "Arch Linux systems:"

echo -e " ${COMMAND_TEXT}sudo pacman -S curl${CLEAR_TEXT}"

echo "Gentoo Linux systems:"

echo -e " ${COMMAND_TEXT}sudo emerge --ask net-misc/curl${CLEAR_TEXT}"

echo "--------------------------------------------------------------------------------"

# Terminate the script.

return "$EC_MISSING_DEPS"

fi

# 'Zenity'

if ! command -v zenity &>/dev/null; then

# Display the error type.

echo -e "${ERROR_TEXT}ERROR:${CLEAR_TEXT} ${BOLD_TEXT}MISSING DEPENDENCIES.${CLEAR_TEXT}"

# Display the error details.

echo -e "${INFO_TEXT}Please install 'zenity' to proceed.${CLEAR_TEXT}"

# Display the suggested action(s).

echo "--------------------------------------------------------------------------------"

echo "Debian/Ubuntu-based systems:"

echo -e " ${COMMAND_TEXT}sudo apt install zenity${CLEAR_TEXT}"

echo "Red Hat/Fedora-based systems:"

echo -e " ${COMMAND_TEXT}sudo dnf install zenity${CLEAR_TEXT}"

echo "Arch Linux systems:"

echo -e " ${COMMAND_TEXT}sudo pacman -S zenity${CLEAR_TEXT}"

echo "Gentoo Linux systems:"

echo -e " ${COMMAND_TEXT}sudo emerge --ask gnome-extra/zenity${CLEAR_TEXT}"

echo "--------------------------------------------------------------------------------"

# Terminate the script.

return "$EC_MISSING_DEPS"

fi

# Declare variables.

local FREERDP_MAJOR_VERSION="" # Stores the major version of the installed copy of FreeRDP.

# Print feedback.

echo -n "Checking whether dependencies are installed... "

# 'libnotify'

if ! command -v notify-send &>/dev/null; then

# Complete the previous line.

echo -e "${FAIL_TEXT}Failed!${CLEAR_TEXT}\n"

# Display the error type.

echo -e "${ERROR_TEXT}ERROR:${CLEAR_TEXT} ${BOLD_TEXT}MISSING DEPENDENCIES.${CLEAR_TEXT}"

# Display the error details.

echo -e "${INFO_TEXT}Please install 'libnotify' to proceed.${CLEAR_TEXT}"

# Display the suggested action(s).

echo "--------------------------------------------------------------------------------"

echo "Debian/Ubuntu-based systems:"

echo -e " ${COMMAND_TEXT}sudo apt install libnotify-bin${CLEAR_TEXT}"

echo "Red Hat/Fedora-based systems:"

echo -e " ${COMMAND_TEXT}sudo dnf install libnotify${CLEAR_TEXT}"

echo "Arch Linux systems:"

echo -e " ${COMMAND_TEXT}sudo pacman -S libnotify${CLEAR_TEXT}"

echo "Gentoo Linux systems:"

echo -e " ${COMMAND_TEXT}sudo emerge --ask x11-libs/libnotify${CLEAR_TEXT}"

echo "--------------------------------------------------------------------------------"

# Terminate the script.

return "$EC_MISSING_DEPS"

fi

# 'Netcat'

if ! command -v nc &>/dev/null; then

# Complete the previous line.

echo -e "${FAIL_TEXT}Failed!${CLEAR_TEXT}\n"

# Display the error type.

echo -e "${ERROR_TEXT}ERROR:${CLEAR_TEXT} ${BOLD_TEXT}MISSING DEPENDENCIES.${CLEAR_TEXT}"

# Display the error details.

echo -e "${INFO_TEXT}Please install 'netcat' to proceed.${CLEAR_TEXT}"

# Display the suggested action(s).

echo "--------------------------------------------------------------------------------"

echo "Debian/Ubuntu-based systems:"

echo -e " ${COMMAND_TEXT}sudo apt install netcat${CLEAR_TEXT}"

echo "Red Hat/Fedora-based systems:"

echo -e " ${COMMAND_TEXT}sudo dnf install nmap-ncat${CLEAR_TEXT}"

echo "Arch Linux systems:"

echo -e " ${COMMAND_TEXT}sudo pacman -S gnu-netcat${CLEAR_TEXT}"

echo "Gentoo Linux systems:"

echo -e " ${COMMAND_TEXT}sudo emerge --ask net-analyzer/netcat${CLEAR_TEXT}"

echo "--------------------------------------------------------------------------------"

# Terminate the script.

return "$EC_MISSING_DEPS"

fi

# 'FreeRDP' (Version 3).

# Attempt to set a FreeRDP command if the command variable is empty.

if [ -z "$FREERDP_COMMAND" ]; then

# Check common commands used to launch FreeRDP.

if command -v xfreerdp &>/dev/null; then

# Check FreeRDP major version is 3 or greater.

FREERDP_MAJOR_VERSION=$(xfreerdp --version | head -n 1 | grep -o -m 1 '\b[0-9]\S*' | head -n 1 | cut -d'.' -f1)

if [[ $FREERDP_MAJOR_VERSION =~ ^[0-9]+$ ]] && ((FREERDP_MAJOR_VERSION >= 3)); then

FREERDP_COMMAND="xfreerdp"

fi

fi

# Check for xfreerdp3 command as a fallback option.

if [ -z "$FREERDP_COMMAND" ]; then

if command -v xfreerdp3 &>/dev/null; then

# Check FreeRDP major version is 3 or greater.

FREERDP_MAJOR_VERSION=$(xfreerdp3 --version | head -n 1 | grep -o -m 1 '\b[0-9]\S*' | head -n 1 | cut -d'.' -f1)

if [[ $FREERDP_MAJOR_VERSION =~ ^[0-9]+$ ]] && ((FREERDP_MAJOR_VERSION >= 3)); then

FREERDP_COMMAND="xfreerdp3"

fi

fi

fi

# Check for FreeRDP flatpak as a fallback option.

if [ -z "$FREERDP_COMMAND" ]; then

if command -v flatpak &>/dev/null; then

if flatpak list --columns=application | grep -q "^com.freerdp.FreeRDP$"; then

# Check FreeRDP major version is 3 or greater.

FREERDP_MAJOR_VERSION=$(flatpak list --columns=application,version | grep "^com.freerdp.FreeRDP" | awk '{print $2}' | cut -d'.' -f1)

if [[ $FREERDP_MAJOR_VERSION =~ ^[0-9]+$ ]] && ((FREERDP_MAJOR_VERSION >= 3)); then

FREERDP_COMMAND="flatpak run --command=xfreerdp com.freerdp.FreeRDP"

fi

fi

fi

fi

fi

if ! command -v "$FREERDP_COMMAND" &>/dev/null && [ "$FREERDP_COMMAND" != "flatpak run --command=xfreerdp com.freerdp.FreeRDP" ]; then

# Complete the previous line.

echo -e "${FAIL_TEXT}Failed!${CLEAR_TEXT}\n"

# Display the error type.

echo -e "${ERROR_TEXT}ERROR:${CLEAR_TEXT} ${BOLD_TEXT}MISSING DEPENDENCIES.${CLEAR_TEXT}"

# Display the error details.

echo -e "${INFO_TEXT}Please install 'FreeRDP' version 3 to proceed.${CLEAR_TEXT}"

# Display the suggested action(s).

echo "--------------------------------------------------------------------------------"

echo "Debian/Ubuntu-based systems:"

echo -e " ${COMMAND_TEXT}sudo apt install freerdp3-x11${CLEAR_TEXT}"

echo "Red Hat/Fedora-based systems:"

echo -e " ${COMMAND_TEXT}sudo dnf install freerdp${CLEAR_TEXT}"

echo "Arch Linux systems:"

echo -e " ${COMMAND_TEXT}sudo pacman -S freerdp${CLEAR_TEXT}"

echo "Gentoo Linux systems:"

echo -e " ${COMMAND_TEXT}sudo emerge --ask net-misc/freerdp${CLEAR_TEXT}"

echo ""

echo "You can also install FreeRDP as a Flatpak."

echo "Install Flatpak, add the Flathub repository and then install FreeRDP:"

echo -e "${COMMAND_TEXT}flatpak install flathub com.freerdp.FreeRDP${CLEAR_TEXT}"

echo -e "${COMMAND_TEXT}sudo flatpak override --filesystem=home com.freerdp.FreeRDP${CLEAR_TEXT}"

echo "--------------------------------------------------------------------------------"

# Terminate the script.

return "$EC_MISSING_DEPS"

fi

# 'libvirt'/'virt-manager' + 'iproute2'.

if [ "$WAFLAVOR" = "libvirt" ]; then

if ! command -v virsh &>/dev/null; then

# Complete the previous line.

echo -e "${FAIL_TEXT}Failed!${CLEAR_TEXT}\n"

# Display the error type.

echo -e "${ERROR_TEXT}ERROR:${CLEAR_TEXT} ${BOLD_TEXT}MISSING DEPENDENCIES.${CLEAR_TEXT}"

# Display the error details.

echo -e "${INFO_TEXT}Please install 'Virtual Machine Manager' to proceed.${CLEAR_TEXT}"

# Display the suggested action(s).

echo "--------------------------------------------------------------------------------"

echo "Debian/Ubuntu-based systems:"

echo -e " ${COMMAND_TEXT}sudo apt install virt-manager${CLEAR_TEXT}"

echo "Red Hat/Fedora-based systems:"

echo -e " ${COMMAND_TEXT}sudo dnf install virt-manager${CLEAR_TEXT}"

echo "Arch Linux systems:"

echo -e " ${COMMAND_TEXT}sudo pacman -S virt-manager${CLEAR_TEXT}"

echo "Gentoo Linux systems:"

echo -e " ${COMMAND_TEXT}sudo emerge --ask app-emulation/virt-manager${CLEAR_TEXT}"

echo "--------------------------------------------------------------------------------"

# Terminate the script.

return "$EC_MISSING_DEPS"

fi

if ! command -v ip &>/dev/null; then

# Complete the previous line.

echo -e "${FAIL_TEXT}Failed!${CLEAR_TEXT}\n"

# Display the error type.

echo -e "${ERROR_TEXT}ERROR:${CLEAR_TEXT} ${BOLD_TEXT}MISSING DEPENDENCIES.${CLEAR_TEXT}"

# Display the error details.

echo -e "${INFO_TEXT}Please install 'iproute2' to proceed.${CLEAR_TEXT}"

# Display the suggested action(s).

echo "--------------------------------------------------------------------------------"

echo "Debian/Ubuntu-based systems:"

echo -e " ${COMMAND_TEXT}sudo apt install iproute2${CLEAR_TEXT}"

echo "Red Hat/Fedora-based systems:"

echo -e " ${COMMAND_TEXT}sudo dnf install iproute${CLEAR_TEXT}"

echo "Arch Linux systems:"

echo -e " ${COMMAND_TEXT}sudo pacman -S iproute2${CLEAR_TEXT}"

echo "Gentoo Linux systems:"

echo -e " ${COMMAND_TEXT}sudo emerge --ask net-misc/iproute2${CLEAR_TEXT}"

echo "--------------------------------------------------------------------------------"

# Terminate the script.

return "$EC_MISSING_DEPS"

fi

elif [ "$WAFLAVOR" = "docker" ]; then

if ! command -v docker &>/dev/null; then

# Complete the previous line.

echo -e "${FAIL_TEXT}Failed!${CLEAR_TEXT}\n"

# Display the error type.

echo -e "${ERROR_TEXT}ERROR:${CLEAR_TEXT} ${BOLD_TEXT}MISSING DEPENDENCIES.${CLEAR_TEXT}"

# Display the error details.

echo -e "${INFO_TEXT}Please install 'Docker Engine' to proceed.${CLEAR_TEXT}"

# Display the suggested action(s).

echo "--------------------------------------------------------------------------------"

echo "Please visit https://docs.docker.com/engine/install/ for more information."

echo "--------------------------------------------------------------------------------"

# Terminate the script.

return "$EC_MISSING_DEPS"

fi

elif [ "$WAFLAVOR" = "podman" ]; then

if ! command -v podman-compose &>/dev/null || ! command -v podman &>/dev/null; then

# Complete the previous line.

echo -e "${FAIL_TEXT}Failed!${CLEAR_TEXT}\n"

# Display the error type.

echo -e "${ERROR_TEXT}ERROR:${CLEAR_TEXT} ${BOLD_TEXT}MISSING DEPENDENCIES.${CLEAR_TEXT}"

# Display the error details.

echo -e "${INFO_TEXT}Please install 'podman' and 'podman-compose' to proceed.${CLEAR_TEXT}"

# Display the suggested action(s).

echo "--------------------------------------------------------------------------------"

echo "Please visit https://podman.io/docs/installation for more information."

echo "Please visit https://github.com/containers/podman-compose for more information."

echo "--------------------------------------------------------------------------------"

# Terminate the script.

return "$EC_MISSING_DEPS"

fi

fi

# Print feedback.

echo -e "${DONE_TEXT}Done!${CLEAR_TEXT}"

# Print feedback.

echo -n "Checking whether the user '$(whoami)' is part of the required groups... "

# Declare variables.

local USER_GROUPS="" # Stores groups the current user belongs to.

# Identify groups the current user belongs to.

USER_GROUPS=$(groups "$(whoami)")

if ! (echo "$USER_GROUPS" | grep -q -E "\blibvirt\b") || ! (echo "$USER_GROUPS" | grep -q -E "\bkvm\b"); then

# Complete the previous line.

echo -e "${FAIL_TEXT}Failed!${CLEAR_TEXT}\n"

# Display the error type.

echo -e "${ERROR_TEXT}ERROR:${CLEAR_TEXT} ${BOLD_TEXT}GROUP MEMBERSHIP CHECK ERROR.${CLEAR_TEXT}"

# Display the error details.

echo -e "${INFO_TEXT}The current user '$(whoami)' is not part of group 'libvirt' and/or group 'kvm'.${CLEAR_TEXT}"

# Display the suggested action(s).

echo "--------------------------------------------------------------------------------"

echo "Please run the below commands, followed by a system reboot:"

echo -e "${COMMAND_TEXT}sudo usermod -a -G libvirt $(whoami)${CLEAR_TEXT}"

echo -e "${COMMAND_TEXT}sudo usermod -a -G kvm $(whoami)${CLEAR_TEXT}"

echo "--------------------------------------------------------------------------------"

# Terminate the script.

return "$EC_NOT_IN_GROUP"

fi

# Print feedback.

echo -e "${DONE_TEXT}Done!${CLEAR_TEXT}"

# Print feedback.

echo -n "Checking the status of the Windows VM... "

# Declare variables.

local VM_STATE="" # Stores the state of the Windows VM.

# Obtain VM Status

VM_PAUSED=0

virsh list --state-paused | grep -wq "$VM_NAME" || VM_PAUSED="$?"

VM_RUNNING=0

virsh list --state-running | grep -wq "$VM_NAME" || VM_RUNNING="$?"

VM_SHUTOFF=0

virsh list --state-shutoff | grep -wq "$VM_NAME" || VM_SHUTOFF="$?"

if [[ $VM_SHUTOFF == "0" ]]; then

# Complete the previous line.

echo -e "${FAIL_TEXT}Failed!${CLEAR_TEXT}\n"

# Display the error type.

echo -e "${ERROR_TEXT}ERROR:${CLEAR_TEXT} ${BOLD_TEXT}WINDOWS VM NOT RUNNING.${CLEAR_TEXT}"

# Display the error details.

echo -e "${INFO_TEXT}The Windows VM '${VM_NAME}' is powered off.${CLEAR_TEXT}"

# Display the suggested action(s).

echo "--------------------------------------------------------------------------------"

echo "Please run the below command to start the Windows VM:"

echo -e "${COMMAND_TEXT}virsh start ${VM_NAME}${CLEAR_TEXT}"

echo "--------------------------------------------------------------------------------"

# Terminate the script.

return "$EC_VM_OFF"

elif [[ $VM_PAUSED == "0" ]]; then

# Complete the previous line.

echo -e "${FAIL_TEXT}Failed!${CLEAR_TEXT}\n"

# Display the error type.

echo -e "${ERROR_TEXT}ERROR:${CLEAR_TEXT} ${BOLD_TEXT}WINDOWS VM NOT RUNNING.${CLEAR_TEXT}"

# Display the error details.

echo -e "${INFO_TEXT}The Windows VM '${VM_NAME}' is paused.${CLEAR_TEXT}"

# Display the suggested action(s).

echo "--------------------------------------------------------------------------------"

echo "Please run the below command to resume the Windows VM:"

echo -e "${COMMAND_TEXT}virsh resume ${VM_NAME}${CLEAR_TEXT}"

echo "--------------------------------------------------------------------------------"

# Terminate the script.

return "$EC_VM_PAUSED"

elif [[ $VM_RUNNING != "0" ]]; then

# Complete the previous line.

echo -e "${FAIL_TEXT}Failed!${CLEAR_TEXT}\n"

# Display the error type.

echo -e "${ERROR_TEXT}ERROR:${CLEAR_TEXT} ${BOLD_TEXT}WINDOWS VM DOES NOT EXIST.${CLEAR_TEXT}"

# Display the error details.

echo -e "${INFO_TEXT}The Windows VM '${VM_NAME}' could not be found.${CLEAR_TEXT}"

# Display the suggested action(s).

echo "--------------------------------------------------------------------------------"

echo "Please ensure a Windows VM with the name '${VM_NAME}' exists."

echo "--------------------------------------------------------------------------------"

# Terminate the script.

return "$EC_VM_ABSENT"

fi

# Print feedback.

echo -e "${DONE_TEXT}Done!${CLEAR_TEXT}"

# Print feedback.

echo -n "Checking container status... "

# Declare variables.

local CONTAINER_STATE=""

local COMPOSE_COMMAND=""

# Determine the state of the container.

CONTAINER_STATE=$("$WAFLAVOR" ps --all --filter name="WinApps" --format '{{.Status}}')

CONTAINER_STATE=${CONTAINER_STATE,,} # Convert the string to lowercase.

CONTAINER_STATE=${CONTAINER_STATE%% *} # Extract the first word.

# Determine the compose command.

case "$WAFLAVOR" in

"docker") COMPOSE_COMMAND="docker compose" ;;

"podman") COMPOSE_COMMAND="podman-compose" ;;

esac

# Check container state.

if [[ "$CONTAINER_STATE" != "up" ]]; then

# Complete the previous line.

echo -e "${FAIL_TEXT}Failed!${CLEAR_TEXT}\n"

# Display the error type.

echo -e "${ERROR_TEXT}ERROR:${CLEAR_TEXT} ${BOLD_TEXT}CONTAINER NOT RUNNING.${CLEAR_TEXT}"

# Display the error details.

echo -e "${INFO_TEXT}Windows is not running.${CLEAR_TEXT}"

# Display the suggested action(s).

echo "--------------------------------------------------------------------------------"

echo "Please ensure Windows is powered on:"

echo -e "${COMMAND_TEXT}${COMPOSE_COMMAND} --file ~/.config/winapps/compose.yaml start${CLEAR_TEXT}"

echo "--------------------------------------------------------------------------------"

# Terminate the script.

return "$EC_CONTAINER_OFF"

fi

# Print feedback.

echo -e "${DONE_TEXT}Done!${CLEAR_TEXT}"

# Print feedback.

echo -n "Checking for an open RDP Port on Windows... "

# Declare variables.

local VM_MAC="" # Stores the MAC address of the Windows VM.

# Obtain Windows VM IP Address (FOR 'libvirt' ONLY)

# Note: 'RDP_IP' should not be empty if 'WAFLAVOR' is 'docker', since it is set to localhost before this function is called.

if [ -z "$RDP_IP" ] && [ "$WAFLAVOR" = "libvirt" ]; then

VM_MAC=$(virsh domiflist "$VM_NAME" | grep -oE "([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})") # VM MAC address.

RDP_IP=$(ip neigh show | grep "$VM_MAC" | grep -oE "([0-9]{1,3}\.){3}[0-9]{1,3}") # VM IP address.

if [ -z "$RDP_IP" ]; then

# Complete the previous line.

echo -e "${FAIL_TEXT}Failed!${CLEAR_TEXT}\n"