#!/bin/bash
# shellcheck source=kz-common.sh
###############################################################################
# Scripts controleren.
#
# Geschreven door Karel Zimmer <info@karelzimmer.nl>.
###############################################################################
PROGRAM_PATH=$(realpath "$(dirname  "$0")")
source "$PROGRAM_PATH"/kz-common.sh
PROGRAM_NAME=kz-ivp
DISPLAY_NAME=${PROGRAM_NAME/kz-/kz }
RELEASE_YEAR=2015

VERSION_NUMBER=14.04.02
VERSION_DATE=2021-10-04


###############################################################################
# Global constants
###############################################################################

readonly RUN_AS_SUPERUSER=false
readonly OPTIONS_SHORT=$OPTIONS_SHORT_COMMON
readonly OPTIONS_LONG=$OPTIONS_LONG_COMMON
readonly USAGE="Gebruik: $DISPLAY_NAME $OPTIONS_USAGE_COMMON"
readonly HELP="Gebruik: $DISPLAY_NAME [OPTIE...]

Scripts controleren.

Opties:
$OPTIONS_HELP_COMMON"


###############################################################################
# Globale variabelen
###############################################################################

declare -i MAXRC=0


###############################################################################
# Functions
###############################################################################

check_input() {
    local   -i  getopt_rc=0
    local       parsed=''
    local       prompt=''

    parsed=$(
        getopt  --alternative                       \
                --options       "$OPTIONS_SHORT"    \
                --longoptions   "$OPTIONS_LONG"     \
                --name          "$DISPLAY_NAME"     \
                --              "$@"
        )       || getopt_rc=$?
    if [[ $getopt_rc -ne $SUCCESS ]]; then
        printf '%s\n' "$USAGELINE" >&2
        exit $ERROR
    fi
    eval set -- "$parsed"
    process_common_options "$@"

    while true; do
        case $1 in
            --)
                shift
                break
                ;;
            *)
                shift
                ;;
        esac
    done

    if [[ "$*" ]]; then
        TEXT='geen argumenten opgeven'
        printf "$DISPLAY_NAME: %s\n%s\n" "$TEXT" "$USAGELINE" >&2
        exit $ERROR
    fi

    # Een non-gui script gestart met optie gui.
    if $OPTION_GUI; then
        OPTION_GUI=false
        DESKTOP_TERMINAL=false
    fi

    check_user

    # Regel sudo maar gelijk voor verderop.
    prompt="Authenticatie is vereist om delen van $DISPLAY_NAME uit te voeren.
[sudo] wachtwoord voor %p: "
    sudo --prompt="$prompt" true

    check_dependencies

}


check_dependencies() {
    if ! command -v pycodestyle 1> /dev/null; then
        info 'Installeer pycodestyle...'
        sudo apt-get install --yes pycodestyle |& $LOGCMD
    fi
    if ! command -v shellcheck 1> /dev/null; then
        info 'Installeer shellcheck...'
        # Debian's pakket is oud, snap is nieuwer.
        sudo snap install shellcheck |& $LOGCMD
    fi
}


process_input() {
    local script=''
    local scriptsdir=$HOME/kz-scripts

    cd "$scriptsdir" || exit $ERROR
    for script in *; do
        if ! [[ -f $script ]]; then
            continue
        fi
        case $script in
            LICENSE|README.md)
                continue
                ;;
            *.1|*.desktop|*.policy)
                check_tags
                check_lines
                check_fields
                check_trailing_spaces
                ;;
            *.completion|*.sh)
                check_tags
                check_lines
                check_fields
                check_trailing_spaces
                check_script_shellcheck
                ;;
            *.py)
                check_tags
                check_lines
                check_fields
                check_trailing_spaces
                check_script_pycodestyle
                ;;
            *)
                check_tags
                check_lines
                check_fields
                check_trailing_spaces
                check_script
                check_usage
                ;;
        esac
    done
    cd "$HOME" || exit $ERROR
}


check_tags() {
    if grep --quiet             \
            --word-regexp       \
            --regexp='#''XXX'   \
            --regexp='#''TODO'  \
            --regexp='#''FIXME' \
            "$script"; then
        info "
${BOLD}In $script:${NORMAL}
    Gedit-tags gevonden.

$(
    grep    --line-number           \
            --word-regexp           \
            --regexp='#''XXX'       \
            --regexp='#''TODO'      \
            --regexp='#''FIXME'     \
            "$script"               |
    nl      --number-width=4        \
            --number-separator=''   \
            --body-numbering=n
)
"
    fi
}


check_lines() {
    local -i line_num=0
    local -i max_lines=1000
    local -i max_line_length=79
    local -i max_line_length_found=0

    case $script in
        *.sh)
            max_line_length=465
            ;;
        *.policy)
            max_line_length=106
            ;;
        *)
            max_line_length=79
            ;;
    esac

    max_line_length_found=$(wc --max-line-length < "$script")
    if  [[ $max_line_length_found -gt $max_line_length ]]; then
        info "
${BOLD}In $script:${NORMAL}
    Een regel is langer dan $max_line_length ($max_line_length_found).
"
        if [[ $WARNING -gt $MAXRC ]]; then
            MAXRC=$WARNING
        fi
    fi

    line_num=$(wc --lines < "$script")
    if [[ $line_num -gt $max_lines ]]; then
        info "
${BOLD}In $script:${NORMAL}
    Meer dan $max_lines regels ($line_num).
"
        if [[ $WARNING -gt $MAXRC ]]; then
            MAXRC=$WARNING
        fi
    fi

    # '#1 foo' = ok, '#1' = ok, '#1foo' = ¬ok, hetzelfde voor #2, #3, 44n #4.
    if [[ $script == kz-install*.sh || $script == kz-setup*.sh ]]; then
        wrong_record=$(
            grep --regexp='#[1-4]' "$script" --line-number  |
            grep --regexp='#[1-4]$' --invert-match          |
            grep --regexp='#[1-4] ' --invert-match          || true
        )
    else
        wrong_record=''
    fi
    if [[ -n $wrong_record ]]; then
        info "
${BOLD}In $script:${NORMAL}
    Foutieve regel(s) gevonden.
$(
        printf  '%s'                    \
                "$wrong_record"         |
        nl      --number-width=8        \
                --number-separator=''   \
                --body-numbering=n

    )
"
        if [[ $ERROR -gt $MAXRC ]]; then
            MAXRC=$ERROR
        fi
    fi
}


check_fields() {
    if ! grep   --quiet                     \
                --regexp='RELEASE_YEAR='    \
                --regexp='release_year = '  \
                "$script"; then
        info "
${BOLD}In $script:${NORMAL}
    Vrijgavejaar (RELEASE_YEAR/release_year) ontbreekt.
"
        if [[ $ERROR -gt $MAXRC ]]; then
            MAXRC=$ERROR
        fi
    fi
    if ! grep   --quiet                         \
                --regexp='VERSION_NUMBER='      \
                --regexp='version_number = '    \
                "$script"; then
        info "
${BOLD}In $script:${NORMAL}
    Versienummer (VERSION_NUMBER/version_number) ontbreekt.
"
        if [[ $ERROR -gt $MAXRC ]]; then
            MAXRC=$ERROR
        fi
    fi
    if ! grep   --quiet                     \
                --regexp='VERSION_DATE='    \
                --regexp='version_date = '  \
                "$script"; then
        info "
${BOLD}In $script:${NORMAL}
    Versiedatum (VERSION_DATE/version_date) ontbreekt.
"
        if [[ $ERROR -gt $MAXRC ]]; then
            MAXRC=$ERROR
        fi
    fi
    if ! grep --quiet --word-regexp --regexp=' ''EOF' "$script"; then
        info "
${BOLD}In $script:${NORMAL}
    EOF ontbreekt.
"
        if [[ $ERROR -gt $MAXRC ]]; then
            MAXRC=$ERROR
        fi
    fi
}


check_trailing_spaces() {
    if grep --quiet --regexp=' ''$' "$script"; then
        info "
${BOLD}In $script:${NORMAL}
    Eindspaties gevonden.

$(
    grep    --line-number --regexp=' ''$' "$script" |
    nl      --number-width=4  --number-separator='' --body-numbering=n

    )
"
        if [[ $ERROR -gt $MAXRC ]]; then
            MAXRC=$ERROR
        fi
    fi
}


check_script() {
    if grep --quiet --line-regexp --regexp='#!''/bin/bash' "$script"; then
            check_script_shellcheck
    elif grep   --quiet                         \
                --line-regexp                   \
                --regexp='#!''/usr/bin/python3' \
                "$script"; then
            check_script_pycodestyle
    else
        info "
${BOLD}In $script:${NORMAL}
    Onbekend script.  Functie check_script() kan script niet controleren."
        if [[ $ERROR -gt $MAXRC ]]; then
            MAXRC=$ERROR
        fi
    fi
}


check_script_shellcheck() {
    local -i    check_rc=0

    shellcheck --external-sources "$script" 2> >($LOGCMD) || check_rc=$?
    if [[ $check_rc -gt $MAXRC ]]; then
        MAXRC=$check_rc
    fi
}


check_script_pycodestyle() {
    local -i check_rc=0

    pycodestyle "$script" || check_rc=$?
    if [[ $check_rc -gt $MAXRC ]]; then
        MAXRC=$check_rc
    fi
}


check_usage() {
    local -i check_rc=0

    "$scriptsdir/$script" --version |& $LOGCMD || check_rc=$?
    if [[ $check_rc -gt $SUCCESS ]]; then
        info "
${BOLD}In $script:${NORMAL}
    Uitvoeren '$script --version' gaat fout."
        if [[ $ERROR -gt $MAXRC ]]; then
            MAXRC=$ERROR
        fi
    fi

    case $script in
        kz-backup)
            log "Check $script."
            "$scriptsdir/$script"   --target                \
                                    /tmp                    \
                                    /home/karel/kz-scripts  |& $LOGCMD  ||
            check_rc=$?
            if [[ $check_rc -gt $SUCCESS ]]; then
                info "
${BOLD}In $script:${NORMAL}
    Uitvoeren '$script --target /tmp /home/karel/kz-scripts' gaat fout."
                if [[ $ERROR -gt $MAXRC ]]; then
                    MAXRC=$ERROR
                fi
            fi
            ;;
        kz-install)
            log "Check $script."
            "$scriptsdir/$script" bitwarden |& $LOGCMD || check_rc=$?
            if [[ $check_rc -gt $SUCCESS ]]; then
                info "
${BOLD}In $script:${NORMAL}
    Uitvoeren '$script bitwarden' gaat fout."
                if [[ $ERROR -gt $MAXRC ]]; then
                    MAXRC=$ERROR
                fi
            fi
            "$scriptsdir/$script" --info |& $LOGCMD || check_rc=$?
            if [[ $check_rc -gt $SUCCESS ]]; then
                info "
${BOLD}In $script:${NORMAL}
    Uitvoeren '$script --info' gaat fout."
                if [[ $ERROR -gt $MAXRC ]]; then
                    MAXRC=$ERROR
                fi
            fi
            "$scriptsdir/$script" --remove |& $LOGCMD || check_rc=$?
            if [[ $check_rc -gt $SUCCESS ]]; then
                info "
${BOLD}In $script:${NORMAL}
    Uitvoeren '$script --remove' gaat fout."
                if [[ $ERROR -gt $MAXRC ]]; then
                    MAXRC=$ERROR
                fi
            fi
            ;;
        kz-restore)
            log "Check $script."
            printf                  '%s\n'          \
                                    '1'             |
            "$scriptsdir/$script"   --target        \
                                    /tmp            \
                                    --source /tmp   |& $LOGCMD || check_rc=$?
            if [[ $check_rc -gt $SUCCESS ]]; then
                info "
${BOLD}In $script:${NORMAL}
    Uitvoeren '$script --target /tmp --source /tmp' gaat fout."
                if [[ $ERROR -gt $MAXRC ]]; then
                    MAXRC=$ERROR
                fi
            fi
            sudo rm --force /tmp/backup_*.tar
            sudo rm --force --recursive /tmp/home
            ;;
        kz-setup)
            log "Check $script."
            "$scriptsdir/$script" bitwarden |& $LOGCMD || check_rc=$?
            if [[ $check_rc -gt $SUCCESS ]]; then
                info "
${BOLD}In $script:${NORMAL}
    Uitvoeren '$script bitwarden' gaat fout."
                if [[ $ERROR -gt $MAXRC ]]; then
                    MAXRC=$ERROR
                fi
            fi
            "$scriptsdir/$script" --info |& $LOGCMD || check_rc=$?
            if [[ $check_rc -gt $SUCCESS ]]; then
                info "
${BOLD}In $script:${NORMAL}
    Uitvoeren '$script --info' gaat fout."
                if [[ $ERROR -gt $MAXRC ]]; then
                    MAXRC=$ERROR
                fi
            fi
            "$scriptsdir/$script" --reset |& $LOGCMD || check_rc=$?
            if [[ $check_rc -gt $SUCCESS ]]; then
                info "
${BOLD}In $script:${NORMAL}
    Uitvoeren '$script --reset' gaat fout."
                if [[ $ERROR -gt $MAXRC ]]; then
                    MAXRC=$ERROR
                fi
            fi
            ;;
        *)
            return $SUCCESS
            ;;
    esac
}


term_script() {
    exit $MAXRC
}


###############################################################################
# Main line
###############################################################################

main() {
    init_script "$@"
    check_input "$@"
    process_input
    term_script
}


main "$@"


# EOF