#!/usr/bin/env bash
# es-tests.sh
#############
# This script lets you install a non-official emulationstation mod in RetroPie.
# It is for those who want to test and help devs with feedback.
#
# Bear in mind that many of those mods are still in development, and you need
# to know how to fix things if something break.
#
# Acknowledgements:
# @BuZz: my script takes advantage of some parts of RetroPie-Setup code. Your
#        talent and rigour with the RetroPie-Setup code makes it very flexible
#        and modular. Very well done!
# @Zigurana : for having the idea to make this tool.
# @TMNTturtlguy : I've made this tool based on your suggestion.
# @Hex : for the make clean omission tip, and many other improvements.
# @Zigurana , @pjft , @jdrassa , @fieldofcows and other ES hackers: for improving EmulationStation.
#
# meleu - June-2017


# globals ####################################################################

VERSION="epsilon"

# TESTERS: set NO_WARNING_FLAG to 1 if you don't want that warning message.
NO_WARNING_FLAG=0

SCRIPT_URL="https://raw.githubusercontent.com/meleu/rp-testers/master/es-tests.sh"
SCRIPT_DIR="$(dirname "$0")"
SCRIPT_DIR="$(cd "$SCRIPT_DIR" && pwd)"
SCRIPT_NAME="$(basename "$0")"
REPO_FILE="es-repos.txt"
REPO_FILE_FULL="$SCRIPT_DIR/$REPO_FILE"
BACKTITLE="$SCRIPT_NAME (version: $VERSION) - manage EmulationStation mods on your RetroPie"
REPO_URL_TEMPLATE="https://github.com/"
SRC_DIR="$HOME/src"
RP_SETUP_DIR="$HOME/RetroPie-Setup"
RP_SUPPLEMENTARY_SRC_DIR="$RP_SETUP_DIR/scriptmodules/supplementary"
RP_PACKAGES_SH="$RP_SETUP_DIR/retropie_packages.sh"
RP_SUPPLEMENTARY_DIR="/opt/retropie/supplementary"

[[ "$1" == "--no-warning" ]] && NO_WARNING_FLAG=1
if [[ "$NO_WARNING_FLAG" == 0 ]]; then
    dialog --backtitle "W A R N I N G !" --title " WARNING! " \
    --yesno "\nThis script lets you install a non-official emulationstation mod in RetroPie. It is for those who want to test and help devs with feedback.\n\nBear in mind that many of those mods are still in development and you will need to know how to fix things if something break!\n\n\nDo you want to proceed?" \
    15 75 2>&1 > /dev/tty \
    || exit
fi

# dialog functions ##########################################################

function dialogMenu() {
    local text="$1"
    shift
    dialog --no-mouse \
        --backtitle "$BACKTITLE" \
        --cancel-label "Back" \
        --ok-label "OK" \
        --menu "$text\n\nChoose an option." 17 75 10 "$@" \
        2>&1 > /dev/tty
}

function dialogMenuHelp() {
    local text="$1"
    shift
    dialog --no-mouse \
        --backtitle "$BACKTITLE" \
        --cancel-label "Back" \
        --ok-label "OK" \
        --item-help \
        --menu "$text\n\nChoose an option." 17 75 10 "$@" \
        2>&1 > /dev/tty
}

function dialogYesNo() {
    dialog --no-mouse --backtitle "$BACKTITLE" --yesno "$@" 15 75 2>&1 > /dev/tty
}

function dialogMsg() {
    dialog --no-mouse --ok-label "OK" --backtitle "$BACKTITLE" --msgbox "$@" 20 70 2>&1 > /dev/tty
}

function dialogInfo {
    dialog --infobox "$@" 8 50 2>&1 >/dev/tty
}

# end of dialog functions ###################################################


function main_menu() {
    local choice

    while true; do
        choice=$(dialog --backtitle "$BACKTITLE" --title " MAIN MENU " \
            --ok-label OK --cancel-label Exit \
            --menu "What do you want to do?" 17 75 10 \
            B "Build an ES branch from the list" \
            E "Edit the ES repo/branch list" \
            C "Choose an installed ES branch to be the default" \
            R "Remove an installed unofficial ES branch" \
            U "Update \"$SCRIPT_NAME\" script" \
            2>&1 > /dev/tty)

        case "$choice" in
            B)  build_es_branch_menu ;;
            E)  edit_repo_branch_menu ;;
            C)  set_default_es_menu ;;
            R)  remove_installed_es_menu ;;
            U)  update_script ;;
            *)  break ;;
        esac
    done
}


function build_es_branch_menu() {
    if [[ ! -s "$REPO_FILE_FULL" ]]; then
        dialogMsg "\"$REPO_FILE\" is empty!\n\nAdd some ES repo/branch to the list first."
        return 1
    fi

    local options=()
    local choice
    local i

    while true; do
        options=()
        while read -r line_number repo branch description; do
            developer=$(get_developer "$repo")
            options+=( "$line_number" "${developer}'s \"$branch\" branch" "$description")
        done < <(nl -s' ' -w1 "$REPO_FILE_FULL")

        choice=$(dialogMenuHelp "List of available ES branches to download, build and install (from \"$REPO_FILE\")." "${options[@]}") \
        || return 1

        repo=$(  sed -n ${choice}p "$REPO_FILE_FULL" | cut -d' ' -f1)
        branch=$(sed -n ${choice}p "$REPO_FILE_FULL" | cut -d' ' -f2)
        es_download_build_install "$repo" "$branch"
    done
}


function es_download_build_install() {
    local developer=$(get_developer "$repo")
    local es_src_dir=$(friendly_repo_branch_name)
    local es_install_dir="${RP_SUPPLEMENTARY_DIR}/$es_src_dir"
    es_src_dir="$SRC_DIR/$es_src_dir"

    dialogYesNo "Are you sure you want to download, build and install ${developer}'s $branch ES branch?\n\n(Note: source files will be stored at \"$es_src_dir\")" \
    || return

    dialogInfo "Downloading source files for ${developer}'s $branch ES branch..."
    if ! git_pull_or_clone "$es_src_dir" "$repo" "$branch"; then
        dialogMsg "Failed to download ${developer}'s $branch ES branch source code.\n\nCheck your connection and try again."
        return 1
    fi

    dialogInfo "Building ${developer}'s $branch ES branch..."
    if ! build_es; then
        echo "====== W A R N I N G !!! ======"
        echo "= SOMETHING WRONG HAPPENED!!! ="
        echo "==============================="
        read -t 30 -p "Look for error messages above. Press <enter> to continue."
        dialogMsg "Failed to build ${developer}'s $branch ES branch. :(\n\n(you should have seen the error messages, right?)"
        return 1
    fi

    dialogInfo "Installing ${developer}'s $branch ES branch in \"$es_install_dir\"."
    if ! install_es; then
        echo "====== W A R N I N G !!! ======"
        echo "= SOMETHING WRONG HAPPENED!!! ="
        echo "==============================="
        read -t 30 -p "Look for error messages above. Press <enter> to continue."
        dialogMsg "Failed to install ${developer}'s $branch ES branch in \"$es_install_dir\". :(\n\n(you should have seen the error messages, right?)"
        return 1
    fi

    dialogMsg "SUCCESS!\n\nThe ${developer}'s EmulationStation $branch branch was successfully installed!\n\nThis ES version is now the default emulationstation on your system.\n\nYou can choose which ES version will be the default one using the \"C\" option at Main Menu."
}


function build_es() {
    local ret=0
    local make_clean_flag=0

    cd "$es_src_dir"
    rpSwap on 512
    cmake . -DFREETYPE_INCLUDE_DIRS=/usr/include/freetype2/ || ret=1
    # following RetroPie user Hex's suggestion [https://retropie.org.uk/forum/post/81034]
    dialogYesNo "We are ready to compile ${developer}'s \"$branch\" ES branch.\n\nWould you like to skip the 'make clean' before running 'make'?\n(this will make compilation faster if previously compiled)" \
    || make clean
    make || ret=1
    rpSwap off
    cd -
    return $ret
}


function install_es() {
    local ret=0

    sudo mkdir -p "$es_install_dir"
    sudo cp -f "$es_src_dir/CREDITS.md" "$es_install_dir/"
    sudo cp -f "$es_src_dir/emulationstation" "$es_install_dir/" || return 1
    sudo cp -f "$es_src_dir/emulationstation.sh" "$es_install_dir/" || return 1
    sudo cp -f "$es_src_dir/GAMELISTS.md" "$es_install_dir/"
    sudo cp -f "$es_src_dir/README.md" "$es_install_dir/"
    sudo cp -f "$es_src_dir/THEMES.md" "$es_install_dir/"

    rp_scriptmodule_action configure || return 1
}


function rp_scriptmodule_action() {
    [[ -z "$1" ]] && return 1

    local action="$1"
    local module_id="$2"
    local scriptmodule
    local ret=0

    [[ -z "$module_id" ]] && module_id=$(basename "$es_src_dir")

    if [[ "$module_id" == emulationstation || "$module_id" == emulationstation-kids ]]; then
        sudo "$RP_PACKAGES_SH" "$module_id" "$action"
        return $?
    fi

    scriptmodule="$RP_SUPPLEMENTARY_SRC_DIR/${module_id}.sh"

    cat > "$scriptmodule" << _EoF_
#!/usr/bin/env bash

rp_module_id="$module_id"
rp_module_desc="EmulationStation $module_id branch"
rp_module_section="exp"

function configure_${module_id}() {
        configure_emulationstation
}
_EoF_

    sudo "$RP_PACKAGES_SH" "$module_id" "$action" || ret=1
    rm -f "$scriptmodule"

    return $ret
}


function edit_repo_branch_menu() {
    local options=()
    local choice
    local i=1
    local repo
    local branch

    while true; do
        options=( L "Load ES branches list from open PRs in RetroPie repo" "")
        options+=(A "Add an ES branch to the list" "")
        [[ -s "$REPO_FILE_FULL" ]] && options+=(D "DELETE ALL BRANCHES IN THE LIST" "")

        while read -r line_number repo branch description; do
            developer=$(get_developer "$repo")
            options+=( "$line_number" "Delete ${developer}'s \"$branch\" branch" "$description")
        done < <(nl -s' ' -w1 "$REPO_FILE_FULL")

        choice=$(dialogMenuHelp "Edit the ES repository/branch list \"$REPO_FILE\"." "${options[@]}") \
        || return 1

        case "$choice" in
            L)  load_open_pull_requests_info
                ;;
            A)  add_repo_branch
                ;;
            D)  dialogYesNo "Are you sure you want to delete every single entry in \"$REPO_FILE_FULL\"?" \
                || continue
                echo -n > "$REPO_FILE_FULL"
                ;;
            *)  repo=$(  sed -n ${choice}p "$REPO_FILE_FULL" | cut -d' ' -f1)
                branch=$(sed -n ${choice}p "$REPO_FILE_FULL" | cut -d' ' -f2)
                dialogYesNo "Are you sure you want to delete the following line from \"$REPO_FILE_FULL\"?\n\n$repo $branch" \
                || continue
                sed -i ${choice}d "$REPO_FILE_FULL"
                remove_source_files "$SRC_DIR/$(friendly_repo_branch_name)"
                ;;
        esac
    done
}


function add_repo_branch() {
    local form=()
    local new_repo="$REPO_URL_TEMPLATE"
    local new_branch
    local new_description

    while true; do
        form=( $(dialog --form "Enter the ES repository URL and the branch name."  17 75 5 \
            "URL        :" 1 1 "$new_repo"   1 13 80 0 \
            "branch     :" 2 1 "$new_branch" 2 13 30 0 \
            "description:" 3 1 "$new_branch" 3 13 80 0 \
            2>&1 > /dev/tty)
        ) || return 1
        new_repo="${form[0]%.git}"
        new_branch="${form[1]}"
        new_description="${form[@]:2}"

        dialogInfo "Adding \"$new_branch\" to the the list.\nPlease wait..."
        validate_repo_branch "$new_repo" "$new_branch" || continue
        echo "$new_repo $new_branch $new_description" >> "$REPO_FILE_FULL"
        return 0
    done
}


function validate_repo_branch() {
    local repo="$1"
    local branch="$2"

    if grep -qi "$repo *$branch" "$REPO_FILE_FULL" 2> /dev/null; then
        dialogMsg "The \"$branch\" branch from \"$repo\" is already in the list!\n\nNothing will be changed."
        return 1
    fi

    if [[ "$repo" != ${REPO_URL_TEMPLATE}* ]]; then
        dialogMsg "The repository URL you provided is invalid (doesn't seem to be a github one): \"$repo\"\n\nThis script only works with github repositories."
        return 1
    fi

    if ! curl -Is "${repo}/tree/${branch}" | grep -q '^Status: 200'; then
        dialogMsg "This is an invalid repo/branch:\n${repo}/tree/${branch}\n(Or maybe your connection is down and the script is unable to validate it.)\n\nNothing will be changed."
        return 1
    fi
    return 0
}


function set_default_es_menu() {
    local options=()
    local choice
    local i
    local es_branch

    while true; do
        i=1
        options=()
        for es_branch in $(get_installed_branches); do
            options+=( $((i++)) "$es_branch" )
        done

        choice=$(dialogMenu "List of installed ES branches on \"$RP_SUPPLEMENTARY_DIR\".\n\nWhich one do you want to set as the default emulationstation?" "${options[@]}") \
        || return 1
        es_branch="${options[2*choice-1]}"

        dialogYesNo "Are you sure you want to set the \"$es_branch\" ES branch as the default one?" \
        || continue

        if rp_scriptmodule_action configure "$es_branch"; then
            dialogMsg "SUCCESS!\n\nThe \"$es_branch\" ES branch is now the default emulationstation!"
            return 0
        else
            dialogMsg "FAIL!!\n\nFailed to set the \"$es_branch\" ES branch as the default emulationstation."
            return 1
        fi
    done
}


function get_installed_branches() {
    local installed_branches=( $(find "$RP_SUPPLEMENTARY_DIR" -type f -name emulationstation.sh ! -path '*/configscripts/*') )
    local b
    for b in "${installed_branches[@]}"; do
        basename "$(dirname "$b")"
    done
}


function remove_installed_es_menu() {
    local options=()
    local choice
    local i
    local es_branch

    while true; do
        options=()
        i=1
        for es_branch in $(get_installed_branches); do
            [[ "$es_branch" == "emulationstation" || "$es_branch" == "emulationstation-kids" ]] \
            && continue
            options+=( $((i++)) "$es_branch" )
        done

        if [[ -z "${options[@]}" ]]; then
            dialogMsg "There's no unofficial ES branches installed on \"$RP_SUPPLEMENTARY_DIR\"!"
            return 1
        fi

        choice=$(dialogMenu "List of installed unofficial ES branches on \"$RP_SUPPLEMENTARY_DIR\".\n\nWhich one would you like to uninstall?" "${options[@]}") \
        || return 1
        es_branch="${options[2*choice-1]}"

        dialogYesNo "Are you sure you want to uninstall the \"$es_branch\" ES branch?" \
        || continue

        remove_source_files "$SRC_DIR/$es_branch"

        if rp_scriptmodule_action remove "$es_branch"; then
            sudo rm -rf "$RP_SUPPLEMENTARY_DIR/$es_branch"
            if sudo "$RP_PACKAGES_SH" emulationstation configure; then
                dialogMsg "SUCCESS!\n\nThe \"$es_branch\" ES branch was uninstalled!\n\nThe official RetroPie ES is now the default emulationstation."
            else
                dialogMsg "WARNING!\n\nThe \"$es_branch\" ES branch was uninstalled.\nBut we failed to set the official RetroPie ES as the default emulationstation. You need to sort it."
            fi
        else
            dialogMsg "FAIL!!\n\nFailed to uninstall the \"$es_branch\" ES branch."
        fi
    done
}


function friendly_repo_branch_name() {
    local developer=$(get_developer "$repo")
    echo "es_${developer}_${branch}" | tr '[:upper:]' '[:lower:]'
}


function get_developer() {
    echo "$1" | sed "s#.*https://github.com/\([^/]*\)/.*#\1#"
}


function remove_source_files() {
    local es_src_dir="$1"
    if [[ -d "$es_src_dir" ]]; then
        dialogYesNo "Do you want to remove source files from \"$es_src_dir\" too?" \
        && rm -rf "$es_src_dir" \
        && dialogMsg "Source files from \"$es_src_dir\" has been removed."
    fi
}


function update_script() {
    local err_flag=0
    local err_msg

    dialogYesNo "Are you sure you want to download the latest version of \"$SCRIPT_NAME\" script?" \
    || return 1

    err_msg=$(curl "$SCRIPT_URL" -o "/tmp/$SCRIPT_NAME" 2>&1) \
    && err_msg=$(cp "/tmp/$SCRIPT_NAME" "$SCRIPT_DIR/$SCRIPT_NAME" 2>&1) \
    || err_flag=1

    if [[ $err_flag -ne 0 ]]; then
        err_msg=$(echo "$err_msg" | tail -1)
        dialogMsg "Failed to update \"$SCRIPT_NAME\".\n\nError message:\n$err_msg"
        return 1
    fi

    dialogMsg "SUCCESS!\n\nThe script was successfully updated.\n\nPress enter to run the latest version."
    [[ -x "$SCRIPT_DIR/$SCRIPT_NAME" ]] && exec "$SCRIPT_DIR/$SCRIPT_NAME" --no-warning
    return 1
}


function git_pull_or_clone() {
    local dir="$1"
    local repo="$2"
    local branch="$3"
    [[ -z "$branch" ]] && branch="master"

    if [[ -d "$dir/.git" ]]; then
        pushd "$dir" > /dev/null
        if ! git pull; then
            git merge --abort && git pull -X theirs || return 1
        fi
        git submodule update --init --recursive || return 1
        popd > /dev/null
    else
        git clone --recursive --depth 1 --branch "$branch" "$repo" "$dir" || return 1
    fi
}


# borrowed code from RetroPie-Setup/scriptmodules/helpers.sh
function rpSwap() {
    local command=$1
    local swapfile="/tmp/swap"
    case $command in
        on)
            rpSwap off
            local memory=$(free -t -m | awk '/^Total:/{print $2}')
            local needed=$2
            local size=$((needed - memory))
            if [[ $size -ge 0 ]]; then
                echo "Adding $size MB of additional swap"
                fallocate -l ${size}M "$swapfile"
                chmod 600 "$swapfile"
                mkswap "$swapfile"
                sudo swapon "$swapfile"
            fi
            ;;
        off)
            echo "Removing additional swap"
            sudo swapoff "$swapfile" 2>/dev/null
            rm -f "$swapfile"
            ;;
    esac
}


function load_open_pull_requests_info() {
    if ! dpkg-query -W jq; then
        if ! which apt-get 2>/dev/null; then
            dialogMsg "To use this feature you need to install the \"jq\" package.\n\nPlease, install it and try again."
            return 1
        fi
        dialogYesNo "To use this feature you need to install the \"jq\" package.\nIt's a small package (less than 1MB) used to parse data needed to build the repository/branch list from open Pull Requests\n\nDo you want to install it now?" \
        || return 1
        sudo apt-get install jq
    fi
    local json="/tmp/esPRs.json"
    local repos=()
    local branches=()
    local descriptions=()
    local oldIFS
    local i

    dialogInfo "Loading open Pull Requests info from RetroPie/EmulationStation repository..."
    curl -s "https://api.github.com/repos/RetroPie/EmulationStation/pulls?status=open" -o "$json"
    
    oldIFS="$IFS"
    IFS=$'\n'
    repos=( $(jq -r '.[] | .head.repo.html_url' "$json") )
    branches=( $(jq -r '.[] | .head.ref' "$json") )
    descriptions=( $(jq -r '.[] | .title' "$json") )
    IFS="$oldIFS"

    for i in $(seq 0 ${#repos[@]}); do
        [[ -z "${repos[i]}" || -z "${branches[i]}" ]] && continue

        line_number=$(grep -ni "${repos[i]} ${branches[i]}" "$REPO_FILE_FULL" | cut -d: -f1)
        if [[ "$line_number" =~ ^[0-9]+$ ]]; then
            sed -i "${line_number}c ${repos[i]} ${branches[i]} ${descriptions[i]}" "$REPO_FILE_FULL"
        else
            echo "${repos[i]} ${branches[i]} ${descriptions[i]}" >> "$REPO_FILE_FULL"
        fi
    done

    rm -f "$json"
}


# START HERE #################################################################

main_menu