pi-hole/advanced/Scripts/version.sh

#!/usr/bin/env bash
# Pi-hole: A black hole for Internet advertisements
# (c) 2017 Pi-hole, LLC (https://pi-hole.net)
# Network-wide ad blocking via your own hardware.
#
# Show version numbers
#
# This file is copyright under the latest version of the EUPL.
# Please see LICENSE file for your rights under this license.

# Source the setupvars config file
# shellcheck disable=SC1091
source /etc/pihole/setupVars.conf

# Sourece the versions file poupulated by updatechecker.sh
cachedVersions="/etc/pihole/versions"

if [ -f ${cachedVersions} ]; then
    # shellcheck disable=SC1090
    . "$cachedVersions"
else
    echo "Could not find /etc/pihole/versons. Exiting."
    exit 1
fi

getLocalVersion() {
    case ${1} in
        "pi-hole"   )  echo "${CORE_VERSION}";;
        "AdminLTE"  )  [[ "${INSTALL_WEB_INTERFACE}" == true ]] && echo "${WEB_VERSION}";;
        "FTL"       )  echo "${FTL_VERSION}";;
    esac
    return 0
}

getLocalHash() {
    case ${1} in
        "pi-hole"   )  echo "${CORE_HASH}";;
        "AdminLTE"  )  [[ "${INSTALL_WEB_INTERFACE}" == true ]] && echo "${WEB_HASH}";;
        "FTL"       )  echo "${FTL_HASH}";;
    esac
    return 0
}

getRemoteHash(){
    case ${1} in
        "pi-hole"   )  echo "${GITHUB_CORE_HASH}";;
        "AdminLTE"  )  [[ "${INSTALL_WEB_INTERFACE}" == true ]] && echo "${GITHUB_WEB_HASH}";;
        "FTL"       )  echo "${GITHUB_FTL_HASH}";;
    esac
    return 0
}

getRemoteVersion(){
    case ${1} in
        "pi-hole"   )  echo "${GITHUB_CORE_VERSION}";;
        "AdminLTE"  )  [[ "${INSTALL_WEB_INTERFACE}" == true ]] && echo "${GITHUB_WEB_VERSION}";;
        "FTL"       )  echo "${GITHUB_FTL_VERSION}";;
    esac
    return 0
}

getLocalBranch(){
    case ${1} in
        "pi-hole"   )  echo "${CORE_BRANCH}";;
        "AdminLTE"  )  [[ "${INSTALL_WEB_INTERFACE}" == true ]] && echo "${WEB_BRANCH}";;
        "FTL"       )  echo "${FTL_BRANCH}";;
    esac
    return 0
}

versionOutput() {
    if [[ "$1" == "AdminLTE" && "${INSTALL_WEB_INTERFACE}" != true ]]; then
        echo "  WebAdmin not installed"
        return 1
    fi

    [[ "$2" == "-c" ]] || [[ "$2" == "--current" ]] || [[ -z "$2" ]] && current=$(getLocalVersion "${1}") && branch=$(getLocalBranch "${1}")
    [[ "$2" == "-l" ]] || [[ "$2" == "--latest" ]] || [[ -z "$2" ]] && latest=$(getRemoteVersion "${1}")
    if [[ "$2" == "-h" ]] || [[ "$2" == "--hash" ]]; then
        [[ "$3" == "-c" ]] || [[ "$3" == "--current" ]] || [[ -z "$3" ]] && curHash=$(getLocalHash "${1}") && branch=$(getLocalBranch "${1}")
        [[ "$3" == "-l" ]] || [[ "$3" == "--latest" ]] || [[ -z "$3" ]] && latHash=$(getRemoteHash "${1}")
    fi
    if [[ -n "$current" ]] && [[ -n "$latest" ]]; then
        output="${1^} version is $branch $current (Latest: $latest)"
    elif [[ -n "$current" ]] && [[ -z "$latest" ]]; then
        output="Current ${1^} version is $branch $current (Latest: N/A)"
    elif [[ -z "$current" ]] && [[ -n "$latest" ]]; then
        output="Latest ${1^} version is $latest (Current: N/A)"
    elif [[ -z "$curHash" ]] && [[ -z "$latHash" ]]; then
        output="No hash info available"
    elif [[ -n "$curHash" ]] && [[ -n "$latHash" ]]; then
        output="Local ${1^} hash of branch $branch is $curHash (Remote: $latHash)"
    elif [[ -n "$curHash" ]] && [[ -z "$latHash" ]]; then
        output="Current local ${1^} hash of branch $branch is $curHash (Remote: N/A)"
    elif [[ -z "$curHash" ]] && [[ -n "$latHash" ]]; then
        output="Latest remote ${1^} hash of branch $branch is $latHash (Local: N/A)"
    else
        errorOutput
        return 1
    fi

    [[ -n "$output" ]] && echo "  $output"
}

errorOutput() {
    echo "  Invalid Option! Try 'pihole -v --help' for more information."
    exit 1
}

defaultOutput() {
    versionOutput "pi-hole" "$@"

    if [[ "${INSTALL_WEB_INTERFACE}" == true ]]; then
        versionOutput "AdminLTE" "$@"
    fi

    versionOutput "FTL" "$@"
}

helpFunc() {
    echo "Usage: pihole -v [repo | option] [option]
Example: 'pihole -v -p -l'
Show Pi-hole, Admin Console & FTL versions

Repositories:
  -p, --pihole         Only retrieve info regarding Pi-hole repository
  -a, --admin          Only retrieve info regarding AdminLTE repository
  -f, --ftl            Only retrieve info regarding FTL repository

Options:
  -c, --current        Return the current version
  -l, --latest         Return the latest version
  --hash               Return the GitHub hash from your local repositories
  -h, --help           Show this help dialog"
  exit 0
}

case "${1}" in
    "-p" | "--pihole"    ) shift; versionOutput "pi-hole" "$@";;
    "-a" | "--admin"     ) shift; versionOutput "AdminLTE" "$@";;
    "-f" | "--ftl"       ) shift; versionOutput "FTL" "$@";;
    "-h" | "--help"      ) helpFunc;;
    *                    ) defaultOutput "$@";;
esac