archzfs/lib.sh

#!/bin/bash -e

shopt -s nullglob


dry_run=0
debug_flag=0
haz_error=0
modes=()
test_mode=""
kernel_names=() # set by generate_mode_list
mode_list=() # set by generate_mode_list
test_commands_list=() # set by generate_test_commands_list
update_funcs=() # set by generate_mode_list
commands=()


# setup signal traps
trap "trap_quit" TERM HUP QUIT
trap "trap_abort" INT
trap "trap_usr1" USR1
trap "trap_exit" EXIT


# check if messages are to be printed using color
unset all_off bold black blue green red yellow white default cyan magenta
all_off="\e[0m"
bold="\e[1m"
black="${bold}\e[30m"
red="${bold}\e[31m"
green="${bold}\e[32m"
yellow="${bold}\e[33m"
blue="${bold}\e[34m"
magenta="${bold}\e[35m"
cyan="${bold}\e[36m"
white="${bold}\e[37m"
default="${bold}\e[39m"
readonly all_off bold black blue green red yellow white default cyan magenta


plain() {
    local mesg=$1; shift
    printf "${all_off}%s${all_off}\n\n" "${mesg}"
    if [[ $# -gt 0 ]]; then
        printf '%s ' "${@}"
        printf '\n\n'
    fi
}


plain_one_line() {
    local mesg=$1; shift
    printf "${all_off}${all_off}%s %s\n\n" "${mesg}" "${@}"
}


msg() {
    local mesg=$1; shift
    printf "${green}====${all_off} ${bold}%s${all_off}\n\n" "$mesg"
    if [[ $# -gt 0 ]]; then
        printf '%s ' "${@}"
        printf '\n\n'
    fi
}


msg2() {
    local mesg=$1; shift
    printf "${blue}++++ ${all_off}${bold}${mesg}${all_off}\n\n" "$mesg"
    if [[ $# -gt 0 ]]; then
        printf '%s ' "${@}"
        printf '\n\n'
    fi
}


warning() {
    local mesg=$1; shift
    printf "${yellow}==== WARNING: ${all_off}${bold}${mesg}${all_off}\n\n" "$mesg" 1>&2
    if [[ $# -gt 0 ]]; then
        printf '%s ' "${@}" 1>&2
        printf '\n\n'
    fi
}


error() {
    local mesg=$1; shift
    printf "${red}==== ERROR: ${all_off}${red}${bold}${mesg}${all_off}\n\n" "$mesg" 1>&2
    if [[ $# -gt 0 ]]; then
        printf '%s ' "${@}" 1>&2
        printf '\n\n'
    fi
}


debug() {
    # $1: The message to print.
    if [[ ${debug_flag} -eq 1 ]]; then
        local mesg=$1; shift
        printf "${magenta}~~~~ DEBUG: ${all_off}${bold}${mesg}${all_off}\n\n" "$mesg" 1>&2
        if [[ $# -gt 0 ]]; then
            printf '%s ' "${@}" 1>&2
            printf '\n\n'
        fi
    fi
}


test_pass() {
    local mesg=$1; shift
    printf "${green}==== PASS: ${all_off}${bold}${mesg}${all_off}\n\n" "$mesg" 1>&2
    if [[ $# -gt 0 ]]; then
        printf '%s ' "${@}" 1>&2
        printf '\n\n'
    fi
}


test_fail() {
    local mesg=$1; shift
    printf "${red}==== FAILED: ${all_off}${red}${bold}${mesg}${all_off}\n\n" "$mesg" 1>&2
    if [[ $# -gt 0 ]]; then
        printf '%s ' "${@}" 1>&2
        printf '\n\n'
    fi
}


trap_exit() {
    local sig=$?
    debug "trap_exit: args \$?=$?"
    if [[ ${sig} -eq 0 ]]; then
        msg "$(date) :: Done"
    # 155 is set when command args are not met, we don't need to print anything in that case
    elif [[ ${sig} -eq 1 && ${sig} -ne 155 ]]; then
        msg "$(date) :: EXIT"
    fi
}


trap_abort() {
    debug "trap_abort: args \$?=$?"
    msg "$(date) :: EXIT (abort)"
}


trap_quit() {
    debug "trap_quit: args \$?=$?"
    msg "$(date) :: EXIT (TERM, HUP, QUIT)"
}


trap_usr1() {
    debug "trap_usr1: args \$?=$?"
    error "$(date) :: EXIT: An unkown error has occurred."
}

# Check a symlink, re-create it if the target is not correct
function check_symlink() {
    # $1 = Symlink
    # $2 = Symlink target
    if [[ "$1" = "$(readlink $2)" ]]; then
        return
    elif [[ -L "$2" ]]; then
        rm "$2"
    fi
    ln -s "$1" "$2"
}


# Converts an absolute path into a relative path using python and prints on
# stdout.
function relativePath() {
    # $1: Path that should be converted to relative path
    # $2: The start path, usually $PWD
    python -c "import os.path; print(os.path.relpath('$1', '$2'))"
}


norun() {
    local mesg=$1; shift
    printf "${magenta}XXXX NORUN: ${all_off}${bold}${mesg}${all_off}\n\n" "$mesg"
    if [[ $# -gt 0 ]]; then
        printf '%s ' "$@"
        printf '\n\n'
    fi
}


# Runs a command. Ouput is not captured
# To use this function, define the following in your calling script:
# run_cmd_return=""
run_cmd() {
    run_cmd_return=0
    run_cmd_return=0
    # $@: The command and args to run
    if [[ ${dry_run} -eq 1 ]]; then
        norun "CMD:" "$@"
    else
        plain "Running command:" "$@"
        plain_one_line "Output:"
        echo -e "$@" | source /dev/stdin
        run_cmd_return=$?
        echo
        plain_one_line "Command returned:" "${run_cmd_return}"
    fi
}


run_cmd_check() {
    # $1 Exit code
    # $2 Error string if defined with print an error message
    if [[ ${run_cmd_return} -eq 0 ]]; then
        return
    fi
    if [[ -n $2 ]]; then
        error "$2"
    fi
    exit $1
}


# Runs a command. Ouput is not captured. dry_run=1 is ignored.
# To use this function, define the following in your calling script:
# run_cmd_return=""
run_cmd_no_dry_run() {
    run_cmd_return=0
    # $@: The command and args to run
    plain "Running command:" "$@"
    plain_one_line "Output:"
    echo -e "$@" | source /dev/stdin
    run_cmd_return=$?
    echo
    plain_one_line "Command returned:" "${run_cmd_return}"
}


# Runs a command, capture the output in run_cmd_output, but also show stdout.
# To use this function, define the following in your calling script:
# run_cmd_output=""
# run_cmd_return=""
run_cmd_show_and_capture_output() {
    run_cmd_output=""
    run_cmd_return=0
    # $@: The command and args to run
    if [[ ${dry_run} -eq 1 ]]; then
        norun "CMD:" "$@"
    else
        plain "Running command:" "$@"
        plain_one_line "Output:"
        # The following allows command output to be displayed in jenkins and stored in the variable simultaneously
        # http://www.tldp.org/LDP/abs/html/x17974.html

        # WARNING: This function sometimes results in the following error:
        # lib.sh: line 145: /usr/bin/tee: Argument list too long
        # lib.sh: line 145: /bin/cat: Argument list too long

        exec 6>&1 # Link file descriptor 6 with stdout.
        run_cmd_output=$(echo -e "$@" | source /dev/stdin | tee >(cat - >&6); exit ${PIPESTATUS[1]})
        exec 1>&6 6>&-      # Restore stdout and close file descriptor #6.
        run_cmd_return=$?
        echo
        plain_one_line "Command returned:" "${run_cmd_return}"
    fi
}


# Runs a command, capture the output in run_cmd_output, but also show stdout. Ignores dry_run=1.
# To use this function, define the following in your calling script:
# run_cmd_output=""
# run_cmd_return=""
run_cmd_show_and_capture_output_no_dry_run() {
    run_cmd_output=""
    run_cmd_return=0
    # $@: The command and args to run
    plain "Running command:" "$@"
    plain_one_line "Output:"
    # The following allows command output to be displayed in jenkins and stored in the variable simultaneously
    # http://www.tldp.org/LDP/abs/html/x17974.html

    # WARNING: This function sometimes results in the following error:
    # lib.sh: line 145: /usr/bin/tee: Argument list too long
    # lib.sh: line 145: /bin/cat: Argument list too long

    exec 6>&1 # Link file descriptor 6 with stdout.
    run_cmd_output=$(echo -e "$@" | source /dev/stdin | tee >(cat - >&6); exit ${PIPESTATUS[1]})
    exec 1>&6 6>&-      # Restore stdout and close file descriptor #6.
    run_cmd_return=$?
    echo
    plain_one_line "Command returned:" "${run_cmd_return}"
}


# Runs the command, does not show output to stdout
# To use this function, define the following in your calling script:
# run_cmd_output=""
# run_cmd_return=""
run_cmd_no_output() {
    run_cmd_output=""
    run_cmd_return=0
    # $@: The command and args to run
    if [[ ${dry_run} -eq 1 ]]; then
        norun "CMD:" "$@"
    else
        plain "Running command:" "$@"
        run_cmd_output=$(echo -e "$@" | source /dev/stdin)
        run_cmd_return=$?
        plain_one_line "Command returned:" "${run_cmd_return}"
    fi
}


# Runs the command, does not show output to stdout, ignores dry_run=1
# To use this function, define the following in your calling script:
# run_cmd_output=""
# run_cmd_return=""
run_cmd_no_output_no_dry_run() {
    run_cmd_output=""
    run_cmd_return=0
    # $@: The command and args to run
    plain "Running command:" "${@}"
    run_cmd_output=$(echo -e "${@}" | source /dev/stdin )
    run_cmd_return=$?
    plain_one_line "Command returned:" "${run_cmd_return}"
}


package_arch_from_path() {
    # $1: Package path
    LC_ALL=C pacman -Qip "$1" | grep "Architecture" | cut -d : -f 2 | tr -d ' '
    return $?
}


package_name_from_path() {
    # $1: Package path
    LC_ALL=C pacman -Qip "$1" | grep "Name" | cut -d : -f 2 | tr -d ' '
    return $?
}


package_version_from_path() {
    # $1: Package path
    LC_ALL=C pacman -Qip "$1" | grep "Version" | cut -d : -f 2 | tr -d ' '
    return $?
}


package_version_from_syncdb() {
    # $1: Package name
    LC_ALL=C pacman -Si "$1" | grep "Version" | cut -d : -f 2 | tr -d ' '
    return $?
}


kernel_version_has_minor_version() {
    # $1: the kernel version
    # returns: 0 if the version contains a minor version and 1 if it does not
    if [[ ${1} =~ ^[[:digit:]]+\.[[:digit:]]+\.([[:digit:]]+) ]]; then
        debug "kernel_version_has_minor_version: Have kernel with minor version!"
        return 0
    fi
    debug "kernel_version_has_minor_version: Have kernel without minor version!"
    return 1
}


# Returns the full kernel version. If $1 is "3.14-1" then kernel_version_full returns "3.14.0-1".
kernel_version_full() {
    # $1: the kernel version
    local arg=$1
    if ! kernel_version_has_minor_version $1; then
        debug "kernel_version_full: Have kernel without minor version!"
        if [[ ${1} =~ ^([[:digit:]]+\.[[:digit:]]+)\.?([[:alpha:][:digit:]]+)?\-([[:digit:]]+) ]]; then
            local arg=${BASH_REMATCH[1]}
            local minor=${BASH_REMATCH[2]}
            local rev=${BASH_REMATCH[3]}
            if [[ ${minor} =~ ^[[:alpha:]]+ ]]; then
                printf "${arg}.0.${minor}-${rev}"
                return 0
            fi
        fi
        printf "${arg}.0-${rev}"
        return 0
    fi
    printf ${arg}
}


# Returns the full kernel version. If $1 is "3.14-1" then kernel_version_full returns "3.14.0_1".
kernel_version_full_no_hyphen() {
    # $1: The full kernel version
    # returns: output is printed to stdout
    echo $(kernel_version_full ${1} | sed s/-/./g)
}

# from makepkg
source_safe() {
    # reset variables
    kernel_version_full_pkgver=""
    kernel_version_full=""
    kernel_version=""
    zfs_pkgver=""
    spl_pkgver=""

    export script_dir mode kernel_name
    shopt -u extglob
    if ! source "$@"; then
        error "Failed to source $1"
        exit 1
    fi
    shopt -s extglob
}


check_internet() {
    if [[ $(curl -s https://www.google.com/ &> /dev/null; echo $?) -ne 0 ]]; then
        return 1
    fi
    return 0
}


check_webpage() {
    # $1: The url to scrape
    # $2: The Perl regex to match with
    # $3: Expect match
    debug "Checking webpage: $1"
    debug "Using regex: `printf "%q" "$2"`"
    debug "Expecting: $3"

    run_cmd_no_output "curl -sL ${1}"

    if [[ ${dry_run} -eq 1 ]]; then
        return 0
    fi

    if [[ $(echo ${run_cmd_output} | \grep -q "504 Gateway Timeout"; echo $?) -eq 0 ]]; then
        return 55
    elif [[ $(echo ${run_cmd_output} | \grep -q "503 Service Unavailable"; echo $?) -eq 0 ]]; then
        return 55
    elif [[ ${run_cmd_output} == "RETVAL: 7" ]]; then
        return 55
    elif [[ ${run_cmd_return} -eq 7 ]]; then
        return 55
    fi

    local scraped_string=$(echo "${run_cmd_output}" | \grep -Po -m 1 "${2}")
    debug "Got \"${scraped_string}\" from webpage."

    if [[ ${scraped_string} != "$3" ]]; then
        error "Checking '$1' expected '$3' got '${scraped_string}'"
        debug "Returning 1 from check_webpage()"
        return 1
    fi

    return 0
}


check_result() {
    # $1 current line
    # $2 changed line
    # $3 the return code from check_webpage
    if [[ ${3} -eq 0 ]]; then
        msg2 "The $1 version is current."
        haz_error=0
    elif [[ ${3} -eq 1 ]]; then
        error "The $2 is out-of-date!"
        haz_error=1
    elif [[ ${3} -eq 55 ]]; then
        warning "The $2 package page was unreachable!"
        haz_error=0
    else
        error "Check returned ${3}"
        haz_error=1
    fi
}


check_archiso() {
    #
    # Check archiso kernel version (this will change when the archiso is updated)
    #
    if ! source ${script_dir}/src/kernels/archiso.sh; then
        echo "!! ERROR !! -- Could not load ${script_dir}/src/kernels/archiso.sh!"
        exit 155
    fi
    msg "Checking archiso download page for linux kernel version changes..."
    check_webpage "https://www.archlinux.org/download/" "(?<=Included Kernel:</strong> )[\d\.]+" "${kernel_version::-2}"
    check_result "archiso kernel version" "archiso" "$?"
}


check_linux_hardened_kernel() {
    #
    # Check x86_64 linux-hardened kernel version
    #
    if ! source ${script_dir}/src/kernels/linux-hardened.sh; then
        echo "!! ERROR !! -- Could not load ${script_dir}/src/kernels/linux-hardened.sh!"
        exit 155
    fi
    msg "Checking the online package database for x86_64 linux-hardened kernel version changes..."
    check_webpage "https://www.archlinux.org/packages/community/x86_64/linux-hardened/" "(?<=<h2>linux-hardened )[\d\w\.-]+(?=</h2>)" "${kernel_version}"
    check_result "x86_64 linux-hardened kernel package" "linux-hardened x86_64" "$?"
}

check_linux_zen_kernel() {
    #
    # Check x86_64 linux-hardened kernel version
    #
    if ! source ${script_dir}/src/kernels/linux-zen.sh; then
        echo "!! ERROR !! -- Could not load ${script_dir}/src/kernels/linux-zen.sh!"
        exit 155
    fi
    msg "Checking the online package database for x86_64 linux-zen kernel version changes..."
    check_webpage "https://www.archlinux.org/packages/extra/x86_64/linux-zen/" "(?<=<h2>linux-zen )[\d\w\.-]+(?=</h2>)" "${kernel_version}"
    check_result "x86_64 linux-zen kernel package" "linux-zen x86_64" "$?"
}


check_linux_kernel() {
    #
    # Check x86_64 linux kernel version
    #
    if ! source ${script_dir}/src/kernels/linux.sh; then
        echo "!! ERROR !! -- Could not load ${script_dir}/src/kernels/linux.sh!"
        exit 155
    fi
    msg "Checking the online package database for x86_64 linux kernel version changes..."
    check_webpage "https://www.archlinux.org/packages/core/x86_64/linux/" "(?<=<h2>linux )[\d\.-]+(?=</h2>)" "${kernel_version}"
    check_result "x86_64 linux kernel package" "linux x86_64" "$?"
}


check_linux_lts_kernel() {
    #
    # Check x86_64 linux-lts kernel version
    #
    if ! source ${script_dir}/src/kernels/linux-lts.sh; then
        echo "!! ERROR !! -- Could not load ${script_dir}/src/kernels/linux-lts.sh!"
        exit 155
    fi
    msg "Checking the online package database for x86_64 linux-lts kernel version changes..."
    check_webpage "https://www.archlinux.org/packages/core/x86_64/linux-lts/" "(?<=<h2>linux-lts )[\d\.-]+(?=</h2>)" "${kernel_version}"
    check_result "x86_64 linux-lts kernel package" "linux-lts x86_64" "$?"
}


check_zol_version() {
    #
    # Check ZFSonLinux.org
    #
    msg "Checking zfsonlinux.org for new versions..."
    check_webpage "https://github.com/zfsonlinux/zfs/releases/latest" "(?<=/zfsonlinux/zfs/releases/download/zfs-)[\d\.]*" "${zol_version}"
    check_result "ZOL stable version" "ZOL stable version" "$?"
}


check_mode() {
    # $1 the mode to check for
    debug "check_mode: checking '$1'"

    # add all available modes
    if [[ "${1}" == "all" ]]; then
        for m in "${mode_list[@]}"; do
            mode=("$(echo ${m} | cut -f2 -d:)")

            # do not add archiso
            if [[ "${mode}" == "iso" ]]; then
                continue
            fi

            modes+=("${mode}")
            kernel_names+=("$(echo ${m} | cut -f1 -d:)")
        done
    else
        for m in "${mode_list[@]}"; do
            debug "check_mode: on '${m}'"
            local moden=$(echo ${m} | cut -f2 -d:)
            # debug "moden: ${moden}"
            if [[ "${moden}" == "$1" ]]; then
                modes+=("$1")
                kernel_names+=("$(echo ${m} | cut -f1 -d:)")
                return
            fi
        done
        error "Unrecognized argument '$1'"
        usage
        exit 155
    fi
}


check_test_mode() {
    # $1 the mode to check for
    debug "check_test_mode: checking for mode in '$1'"
    for m in "${mode_list[@]}"; do
        debug "check_test_mode: on '${m}'"
        local moden=$(echo ${m} | cut -f2 -d:)
        # debug "moden: ${moden}"
        if [[ "${moden}" == "$1" ]]; then
            if [[ ${mode} != "" ]]; then
                error "Already have mode '${moden}', only one mode can be used at a time!"
                usage
                exit 155
            fi
            mode="$1"
            kernel_name=$(echo ${m} | cut -f1 -d:)
            return
        fi
    done
    debug "check_test_mode: checking for test mode in '$1'"
    for m in "${test_commands_list[@]}"; do
        debug "check_test_mode: on '${m}'"
        local moden=$(echo ${m})
        if [[ ${moden} =~ $1 ]]; then
            debug "Found match! moden: ${moden} \$1: $1"
            if [[ ${test_mode} != "" ]]; then
                error "Already have test mode '${moden}', only one test mode can be used at a time!"
                usage
                exit 155
            fi
            test_mode="${moden}"
            return
        fi
    done
    error "Unrecognized argument '$1'"
    usage
    exit 155
}



have_command() {
    # $1: The command to check for
    # returns 0 if true, and 1 for false
    debug "have_command: checking '$1'"
    for cmd in "${commands[@]}"; do
        # debug "have_command: loop '$cmd'"
        if [[ ${cmd} == $1 ]]; then
            debug "have_command: '$1' is defined"
            return 0
        fi
    done
    debug "have_command: '$1' is not defined"
    return 1
}


have_test_command() {
    # $1: The command to check for
    # returns 0 if true, and 1 for false
    debug "have_test_command: checking '$1'"
    for cmd in "${test_commands_list[@]}"; do
        # debug "have_test_command: loop '$cmd'"
        if [[ ${cmd} == $1 ]]; then
            debug "have_test_command: '$1' is defined"
            return 0
        fi
    done
    debug "have_test_command: '$1' is not defined"
    return 1
}


check_debug() {
    # args must be defined in the source script that loads lib.sh!
    # Returns 0 if debug argument is defined and 1 if not
    for (( a = 0; a < "${#args[@]}"; a++ )); do
        if [[ ${args[$a]} == "-d" ]]; then
            return 0
        fi
    done
    return 1
}


generate_mode_list() {
    # $1: The path where the kernel things can be found, must have trailing slash
    path="$1"
    if [[ ${path} == "" ]]; then
        path="${script_dir}/src/kernels"
    fi
    for m in $(ls ${path}); do
        mn=$(source ${path}/${m}; echo ${mode_name})
        md=$(source ${path}/${m}; echo ${mode_desc})
        mode_list+=("${m%.*}:${mn}:${md}")
    done
}


generate_test_commands_list() {
    # $1: The path where the kernel things can be found, must have trailing slash
    path="$1"
    if [[ ${path} == "" ]]; then
        path="${script_dir}"
    fi
    debug "generate_test_commands_list: path == ${path}"
    for m in $(find ${path} -type d -iname "*archzfs-qemu-*-test-*"); do
        test_commands_list+=("${m}")
    done
}


get_kernel_update_funcs() {
    update_funcs=()

    for kernel in $(ls ${script_dir}/src/kernels); do
        if [[ ${kernel%.*} != ${kernel_name} ]]; then
            continue
        fi
        updatefuncs=$(cat "${script_dir}/src/kernels/${kernel}" | grep -v "^.*#" | grep -oh "update_.*_pkgbuilds")
        for func in ${updatefuncs}; do update_funcs+=("${func}"); done
    done
}

get_conflicts() {
    zfs_headers_conflicts_all=()
    spl_headers_conflicts_all=()
    zfs_conflicts_all=()
    spl_conflicts_all=()

    for kernel in $(ls ${script_dir}/src/kernels); do
        # do not conflict with common or dkms packages
        if [[ "$kernel" == "common.sh"  || "$kernel" == "common-git.sh" || "$kernel" == "dkms.sh" ]]; then
          continue;
        fi

        # get update funcs
        updatefuncstmp=$(cat "${script_dir}/src/kernels/${kernel}" | grep -v "^.*#" | grep -oh "update_.*_pkgbuilds")

        # generate conflict list
        for func in ${updatefuncstmp}; do
          zfs_headers_conflicts_all+=$(source ${script_dir}/src/kernels/${kernel}; commands=(); ${func}; conflicts=${pkg_list[@]//spl*}; printf "'%s-headers' "  "${conflicts[@]}")
          spl_headers_conflicts_all+=$(source ${script_dir}/src/kernels/${kernel}; commands=(); ${func}; conflicts=${pkg_list[@]//zfs*}; printf "'%s-headers' "  "${conflicts[@]}")

          zfs_conflicts_all+=$(source ${script_dir}/src/kernels/${kernel}; commands=(); ${func}; conflicts=${pkg_list[@]//spl*}; printf "'%s' "  "${conflicts[@]}")
          spl_conflicts_all+=$(source ${script_dir}/src/kernels/${kernel}; commands=(); ${func}; conflicts=${pkg_list[@]//zfs*}; printf "'%s' "  "${conflicts[@]}")
        done
    done
}

check_skip_build() {
    # $1: Name of package to check
    pkg=${1}

    # get version of any package that has been built previously
    run_cmd_show_and_capture_output "ls \"${script_dir}/packages/${kernel_name}/${pkg}/\"${pkg}*.pkg.tar.xz | grep \"$pkg\" | grep -v \"headers\" | tail -1"
    pkg_path=${run_cmd_output}

    if [[ ${pkg_path} == "" ]]; then
        msg2 "No previously built packages exist for ${pkg}!"
    else
        vers=$(package_version_from_path ${pkg_path})

        # get current version
        eval $(source "${script_dir}/packages/${kernel_name}/${pkg}/PKGBUILD";
               echo current_vers="${pkgver}";
               echo current_rel="${pkgrel}";
        )

        # check if version has already been built
        if [[ ${run_cmd_return} -eq 0 && ${vers} == ${current_vers}-${current_rel} ]]; then
            msg "${pkg}=${vers} has already been built"
            return 0
        fi
    fi

    return 1
}

check_skip_src() {
    # $1: Name of package to check
    pkg=${1}

    # check for any source package that has been generated previously
    run_cmd_show_and_capture_output "ls \"${script_dir}/packages/${kernel_name}/${pkg}/\"${pkg}*.src.tar.gz | grep \"$pkg\" | grep -v \"headers\" | tail -1"
    pkg_path=${run_cmd_output}

    if [[ ${pkg_path} == "" ]]; then
        msg2 "No previously generated source package exist for ${pkg}!"
    else
        msg "sources for ${pkg} have already been built"
        return 0
    fi

    return 1
}

debug_print_default_vars() {
    debug "dry_run: "${dry_run}
    debug "debug_flag: "${debug_flag}
    debug "mode: ${mode}"
    debug "kernel_name: ${kernel_name}"
    if [[ ${#mode_list[@]} -gt 0 ]]; then
        debug_print_array "mode_list" "${mode_list[@]}"
    fi
    if [[ ${#update_funcs[@]} -gt 0 ]]; then
        debug_print_array "update_funcs" "${update_funcs[@]}"
    fi
    if [[ ${#commands[@]} -gt 0 ]]; then
        debug_print_array "commands" "${commands[@]}"
    fi
}


debug_print_array() {
    # $1 array name
    # $2 array
    if [[ $# -lt 2 ]]; then
        warning "debug_print_array: Array '$1' is empty"
        return
    fi
    local name=$1; shift
    for item in "${@}"; do
        debug "${name} (array item): ${item}"
    done
}


# Do this early so it is possible to see the output
if check_debug; then
    debug_flag=1
    debug "debug mode is enabled"
fi


pkgbuild_cleanup() {
    # $1 the file to process
    # Strip all blanklines
    sed -i '/^\s*$/d' $1
    sed -i 's/"\ )$/")/g' $1
    # Readd blanklines above build and package
    sed -i '/^pkgver\(\)/{x;p;x;}' $1
    sed -i '/^build\(\)/{x;p;x;}' $1
    sed -i '/^package\(\)/{x;p;x;}' $1
}


git_check_repo() {
    for pkg in "${pkg_list[@]}"; do
        local reponame="spl"
        local url="${spl_git_url}"
        if [[ ${pkg} =~ ^zfs ]]; then
            url="${zfs_git_url}"
            reponame="zfs"
        fi
        local repopath="${script_dir}/packages/${kernel_name}/${pkg}/${reponame}"

        debug "GIT URL: ${url}"
        debug "GIT REPO: ${repopath}"

        if [[ ! -d "${repopath}"  ]]; then
            msg2 "Cloning repo '${repopath}'"
            run_cmd_no_dry_run "git clone --mirror '${url}' '${repopath}'"
            if [[ ${run_cmd_return} -ne 0 ]]; then
                error "Failure while cloning ${url} repo"
                exit 1
            fi
        else
            msg2 "Updating repo '${repopath}'"
            run_cmd_no_dry_run "cd ${repopath} && git fetch --all -p"
            if [[ ${run_cmd_return} -ne 0 ]]; then
                error "Failure while fetching ${url} repo"
                exit 1
            fi
        fi
    done
}


git_calc_pkgver() {
    for repo in "spl" "zfs"; do
        msg2 "Cloning working copy for ${repo}"
        local sha=${spl_git_commit}
        local kernvers=${kernel_version_full_pkgver}
        if [[ ${repo} =~ ^zfs ]]; then
            sha=${zfs_git_commit}
        fi

        # use utils package, if no kernel version is set and not on dkms
        if [[ -z ${zfs_dkms_pkgbuild_path} && -z "${kernvers}" ]]; then
            pkg=$(eval "echo \${${repo}_utils_pkgname}")
        else
            pkg=$(eval "echo \${${repo}_pkgname}")
        fi

        debug "Using package '${pkg}'"

        # Checkout the git repo to a work directory
        local cmd="/usr/bin/bash -s << EOF 2>/dev/null\\n"
        cmd+="[[ -d temp ]] && rm -r temp\\n"
        cmd+="mkdir temp && cd temp\\n"
        cmd+="git clone ../packages/${kernel_name}/${pkg}/${repo} && cd ${repo}\\n"
        cmd+="git checkout -b azb ${sha}\\n"
        cmd+="EOF"
        run_cmd_no_output_no_dry_run "${cmd}"

        # Get the version number past the last tag
        msg2 "Calculating PKGVER"
        cmd="cd temp/${repo} && "
        cmd+='printf "%s.r%s.%s" "$(git log -n 1 --pretty=format:"%cd" --date=short | sed "s/-/./g")" "$(git rev-list --count HEAD)" "$(git rev-parse --short HEAD)"'

        run_cmd_no_output_no_dry_run "${cmd}"

        if [[ ${repo} =~ ^spl ]]; then
            spl_git_ver=${run_cmd_output}
            # append kernel version if set
            if [ ! -z "${kernvers}" ]; then
              spl_pkgver=${spl_git_ver}.${kernvers};
            else
              spl_pkgver=${spl_git_ver};
            fi
            debug "spl_pkgver: ${spl_pkgver}"
        elif [[ ${repo} =~ ^zfs ]]; then
          zfs_git_ver=${run_cmd_output}
          # append kernel version if set
          if [ ! -z "${kernvers}" ]; then
            zfs_pkgver=${zfs_git_ver}.${kernvers};
          else
            zfs_pkgver=${zfs_git_ver};
          fi
          debug "zfs_pkgver: ${zfs_pkgver}"
        fi

        # get latest commit sha
        cmd="cd temp/${repo} && "
        cmd+="git rev-parse HEAD"
        run_cmd_no_output_no_dry_run "${cmd}"
        if [[ ${repo} =~ ^zfs ]]; then
          latest_zfs_git_commit=${run_cmd_output}
        else
          latest_spl_git_commit=${run_cmd_output}
        fi

        # Cleanup
        msg2 "Removing working directory"
        run_cmd_no_output_no_dry_run "rm -vrf temp"
    done
}