# This file contains some usefull common functions -*- sh -*-

# Copyright 2007 Yann E. MORIN

# Licensed under the GPL v2. See COPYING in the root of this package

# Prepare the fault handler

CT_OnError() {

    local ret=$?

    local result

    local old_trap

    local intro

    local file line func

    local step step_depth

    # To avoid printing the backtace for each sub-shell

    # up to the top-level, just remember we've dumped it

    if [ ! -f "${CT_WORK_DIR}/backtrace" ]; then

        touch "${CT_WORK_DIR}/backtrace"

        # Print steps backtrace

        step_depth=${CT_STEP_COUNT}

        CT_STEP_COUNT=1     # To have a zero-indentation

        CT_DoLog ERROR ""

        CT_DoLog ERROR ">>"

        intro="Build failed"

        for((step=step_depth; step>0; step--)); do

            CT_DoLog ERROR ">>  ${intro} in step '${CT_STEP_MESSAGE[${step}]}'"

            intro="      called"

        done

        # Print functions backtrace

        intro="Error happened in"

        CT_DoLog ERROR ">>"

        for((depth=1; ${BASH_LINENO[$((${depth}-1))]}>0; depth++)); do

            file="${BASH_SOURCE[${depth}]#${CT_LIB_DIR}/}"

            func="${FUNCNAME[${depth}]}"

            line="@${BASH_LINENO[${depth}-1]:-?}"

            CT_DoLog ERROR ">>  ${intro}: ${func}[${file}${line}]"

            intro="      called from"

        done

        # If the user asked for interactive debugging, dump him/her to a shell

        if [ "${CT_DEBUG_INTERACTIVE}" = "y" ]; then

            # We do not want this sub-shell exit status to be caught, because

            # it is absolutely legit that it exits with non-zero.

            # Save the trap handler to restore it after our debug-shell

            old_trap="$(trap -p ERR)"

            trap -- ERR

            (

                exec >&6 2>&7 <&8

                printf "\r         \n\nCurrent command"

                if [ -n "${cur_cmd}" ]; then

                    printf ":\n  %s\n" "${cur_cmd}"

                else

                    printf " (unknown), "

                fi

                printf "exited with error code: %d\n" ${ret}

                printf "Please fix it up and finish by exiting the shell with one of these values:\n"

                printf "    1  fixed, continue with next build command\n"

                if [ -n "${cur_cmd}" ]; then

                    printf "    2  repeat this build command\n"

                fi

                printf "    3  abort build\n\n"

                while true; do

                    ${bash} --rcfile <(printf "PS1='ct-ng:\w> '\nPROMPT_COMMAND=''\n") -i

                    result=$?

                    case $result in

                        1)  printf "\nContinuing past the failed command.\n\n"

                            break

                            ;;

                        2)  if [ -n "${cur_cmd}" ]; then

                                printf "\nRe-trying last command.\n\n"

                                break

                            fi

                            ;;

                        3)  break;;

                    esac

                    printf "\nPlease exit with one of these values:\n"

                    printf "    1  fixed, continue with next build command\n"

                    if [ -n "${cur_cmd}" ]; then

                        printf "    2  repeat this build command\n"

                    fi

                    printf "    3  abort build\n"

                done

                exit $result

            )

            result=$?

            # Restore the trap handler

            eval "${old_trap}"

            case "${result}" in

                1)  rm -f "${CT_WORK_DIR}/backtrace"; touch "${CT_BUILD_DIR}/skip"; return;;

                2)  rm -f "${CT_WORK_DIR}/backtrace"; touch "${CT_BUILD_DIR}/repeat"; return;;

                # 3 is an abort, continue...

            esac

        fi

    fi

    # And finally, in top-level shell, print some hints

    if [ ${BASH_SUBSHELL} -eq 0 ]; then

        # Help diagnose the error

        CT_STEP_COUNT=1     # To have a zero-indentation

        CT_DoLog ERROR ">>"

        if [ "${CT_LOG_TO_FILE}" = "y" ]; then

            CT_DoLog ERROR ">>  For more info on this error, look at the file: '${tmp_log_file#${CT_TOP_DIR}/}'"

        fi

        CT_DoLog ERROR ">>  There is a list of known issues, some with workarounds, in:"

        CT_DoLog ERROR ">>      '${CT_DOC_DIR#${CT_TOP_DIR}/}/B - Known issues.txt'"

        CT_DoLog ERROR ""

        CT_DoEnd ERROR

        rm -f "${CT_WORK_DIR}/backtrace"

    fi

    exit $ret

}

# Install the fault handler

trap CT_OnError ERR

# Inherit the fault handler in subshells and functions

set -E

# Make pipes fail on the _first_ failed command

# Not supported on bash < 3.x, but we need it, so drop the obsoleting bash-2.x

set -o pipefail

# Don't hash commands' locations, and search every time it is requested.

# This is slow, but needed because of the static/shared core gcc which shall

# always match to shared if it exists, and only fallback to static if the

# shared is not found

set +o hashall

# Log policy:

#  - first of all, save stdout so we can see the live logs: fd #6

# (also save stdin and stderr for use by CT_DEBUG_INTERACTIVE)

exec 6>&1 7>&2 8<&0

#  - then point stdout to the log file

tmp_log_file="${CT_TOP_DIR}/build.log"

rm -f "${tmp_log_file}"

exec >>"${tmp_log_file}"

# The different log levels:

CT_LOG_LEVEL_ERROR=0

CT_LOG_LEVEL_WARN=1

CT_LOG_LEVEL_INFO=2

CT_LOG_LEVEL_EXTRA=3

CT_LOG_LEVEL_CFG=4

CT_LOG_LEVEL_FILE=5

CT_LOG_LEVEL_STATE=6

CT_LOG_LEVEL_ALL=7

CT_LOG_LEVEL_DEBUG=8

# Make it easy to use \n and !

CR=$(printf "\n")

BANG='!'

# A function to log what is happening

# Different log level are available:

#   - ERROR:   A serious, fatal error occurred

#   - WARN:    A non fatal, non serious error occurred, take your responsbility with the generated build

#   - INFO:    Informational messages

#   - EXTRA:   Extra informational messages

#   - CFG:     Output of various "./configure"-type scripts

#   - FILE:    File / archive unpacking.

#   - STATE:   State save & restore

#   - ALL:     Component's build messages

#   - DEBUG:   Internal debug messages

# Usage: CT_DoLog <level> [message]

# If message is empty, then stdin will be logged.

CT_DoLog() {

    local max_level LEVEL level cur_l cur_L

    local l

    eval max_level="\${CT_LOG_LEVEL_${CT_LOG_LEVEL_MAX}}"

    # Set the maximum log level to DEBUG if we have none

    [ -z "${max_level}" ] && max_level=${CT_LOG_LEVEL_DEBUG}

    LEVEL="$1"; shift

    eval level="\${CT_LOG_LEVEL_${LEVEL}}"

    if [ $# -eq 0 ]; then

        cat -

    else

        printf "%s\n" "${*}"

    fi |( IFS="${CR}" # We want the full lines, even leading spaces

          _prog_bar_cpt=0

          _prog_bar[0]='/'

          _prog_bar[1]='-'

          _prog_bar[2]='\'

          _prog_bar[3]='|'

          indent=$((2*CT_STEP_COUNT))

          while read line; do

              case "${CT_LOG_SEE_TOOLS_WARN},${line}" in

                y,*"warning:"*)         cur_L=WARN; cur_l=${CT_LOG_LEVEL_WARN};;

                y,*"WARNING:"*)         cur_L=WARN; cur_l=${CT_LOG_LEVEL_WARN};;

                *"error:"*)             cur_L=ERROR; cur_l=${CT_LOG_LEVEL_ERROR};;

                *"make["*"]: *** ["*)   cur_L=ERROR; cur_l=${CT_LOG_LEVEL_ERROR};;

                *)                      cur_L="${LEVEL}"; cur_l="${level}";;

              esac

              # There will always be a log file (stdout, fd #1), be it /dev/null

              printf "[%-5s]%*s%s%s\n" "${cur_L}" "${indent}" " " "${line}"

              if [ ${cur_l} -le ${max_level} ]; then

                  # Only print to console (fd #6) if log level is high enough.

                  printf "${CT_LOG_PROGRESS_BAR:+\r}[%-5s]%*s%s%s\n" "${cur_L}" "${indent}" " " "${line}" >&6

              fi

              if [ "${CT_LOG_PROGRESS_BAR}" = "y" ]; then

                  printf "\r[%02d:%02d] %s " $((SECONDS/60)) $((SECONDS%60)) "${_prog_bar[$((_prog_bar_cpt/10))]}" >&6

                  _prog_bar_cpt=$(((_prog_bar_cpt+1)%40))

              fi

          done

        )

    return 0

}

# Execute an action, and log its messages

# It is possible to even log local variable assignments (a-la: var=val ./cmd opts)

# Usage: CT_DoExecLog <level> [VAR=val...] <command> [parameters...]

CT_DoExecLog() {

    local level="$1"

    local cur_cmd

    local ret

    shift

    (

    for i in "$@"; do

        cur_cmd+="'${i}' "

    done

    while true; do

        case "${1}" in

            *=*)    eval export "'${1}'"; shift;;

            *)      break;;

        esac

    done

    # This while-loop goes hand-in-hand with the ERR trap handler:

    # - if the command terminates successfully, then we hit the break

    #   statement, and we exit the loop

    # - if the command terminates in error, then the ERR handler kicks

    #   in, then:

    #     - if the user did *not* ask for interactive debugging, the ERR

    #       handler exits, and we hit the end of the sub-shell

    #     - if the user did ask for interactive debugging, the ERR handler

    #       spawns a shell. Upon termination of this shell, the ERR handler

    #       examines the exit status of the shell:

    #         - if 1, the ERR handler returns; then we hit the else statement,

    #           then the break, and we exit the 'while' loop, to continue the

    #           build;

    #         - if 2, the ERR handler touches the repeat file, and returns;

    #           then we hit the if statement, and we loop for one more

    #           iteration;

    #         - if 3, the ERR handler exits with the command's exit status,

    #           and we're dead;

    #         - for any other exit status of the shell, the ERR handler

    #           prints an informational message, and respawns the shell

    #

    # This allows a user to get an interactive shell that has the same

    # environment (PATH and so on) that the failed command was ran with.

    while true; do

        rm -f "${CT_BUILD_DIR}/repeat"

        CT_DoLog DEBUG "==> Executing: ${cur_cmd}"

        "${@}" 2>&1 |CT_DoLog "${level}"

        ret="${?}"

        if [ -f "${CT_BUILD_DIR}/repeat" ]; then

            rm -f "${CT_BUILD_DIR}/repeat"

            continue

        elif [ -f "${CT_BUILD_DIR}/skip" ]; then

            rm -f "${CT_BUILD_DIR}/skip"

            ret=0

            break

        else

            break

        fi

    done

    exit ${ret}

    )

    # Catch failure of the sub-shell

    [ $? -eq 0 ]

}

# Tail message to be logged whatever happens

# Usage: CT_DoEnd <level>

CT_DoEnd()

{

    local level="$1"

    CT_STOP_DATE=$(CT_DoDate +%s%N)

    CT_STOP_DATE_HUMAN=$(CT_DoDate +%Y%m%d.%H%M%S)

    if [ "${level}" != "ERROR" ]; then

        CT_DoLog "${level:-INFO}" "Build completed at ${CT_STOP_DATE_HUMAN}"

    fi

    elapsed=$((CT_STOP_DATE-CT_STAR_DATE))

    elapsed_min=$((elapsed/(60*1000*1000*1000)))

    elapsed_sec=$(printf "%02d" $(((elapsed%(60*1000*1000*1000))/(1000*1000*1000))))

    elapsed_csec=$(printf "%02d" $(((elapsed%(1000*1000*1000))/(10*1000*1000))))

    CT_DoLog ${level:-INFO} "(elapsed: ${elapsed_min}:${elapsed_sec}.${elapsed_csec})"

}

# Remove entries referring to . and other relative paths

# Usage: CT_SanitizePath

CT_SanitizePath() {

    local new

    local p

    local IFS=:

    for p in $PATH; do

        # Only accept absolute paths;

        # Note: as a special case the empty string in PATH is equivalent to .

        if [ -n "${p}" -a -z "${p%%/*}" ]; then

            new="${new}${new:+:}${p}"

        fi

    done

    PATH="${new}"

}

# Sanitise the directory name contained in the variable passed as argument:

# - remove duplicate /

# Usage: CT_SanitiseVarDir CT_PREFIX_DIR

CT_SanitiseVarDir() {

    local var

    local old_dir

    local new_dir

    for var in "$@"; do

        eval "old_dir=\"\${${var}}\""

        new_dir="$( printf "${old_dir}"     \

                    |sed -r -e 's:/+:/:g;'  \

                  )"

        eval "${var}=\"${new_dir}\""

        CT_DoLog DEBUG "Sanitised '${var}': '${old_dir}' -> '${new_dir}'"

    done

}

# Abort the execution with an error message

# Usage: CT_Abort <message>

CT_Abort() {

    CT_DoLog ERROR "$1"

    false

}

# Test a condition, and print a message if satisfied

# Usage: CT_Test <message> <tests>

CT_Test() {

    local ret

    local m="$1"

    shift

    CT_DoLog DEBUG "Testing '! ( $* )'"

    test "$@" && CT_DoLog WARN "$m"

    return 0

}

# Test a condition, and abort with an error message if satisfied

# Usage: CT_TestAndAbort <message> <tests>

CT_TestAndAbort() {

    local m="$1"

    shift

    CT_DoLog DEBUG "Testing '! ( $* )'"

    test "$@" && CT_Abort "$m"

    return 0

}

# Test a condition, and abort with an error message if not satisfied

# Usage: CT_TestAndAbort <message> <tests>

CT_TestOrAbort() {

    local m="$1"

    shift

    CT_DoLog DEBUG "Testing '$*'"

    test "$@" || CT_Abort "$m"

    return 0

}

# Test the presence of a tool, or abort if not found

# Usage: CT_HasOrAbort <tool>

CT_HasOrAbort() {

    CT_TestAndAbort "'${1}' not found and needed for successful toolchain build." -z "$(CT_Which "${1}")"

    return 0

}

# Search a program: wrap "which" for those system where "which"

# verbosely says there is no match (such as on Mandriva).

# Usage: CT_Which <filename>

CT_Which() {

  which "$1" 2>/dev/null || true

}

# Get current date with nanosecond precision

# On those system not supporting nanosecond precision, faked with rounding down

# to the highest entire second

# Usage: CT_DoDate <fmt>

CT_DoDate() {

    date "$1" |sed -r -e 's/%?N$/000000000/;'

}

CT_STEP_COUNT=1

CT_STEP_MESSAGE[${CT_STEP_COUNT}]="(top-level)"

# Memorise a step being done so that any error is caught

# Usage: CT_DoStep <loglevel> <message>

CT_DoStep() {

    local start=$(CT_DoDate +%s%N)

    CT_DoLog "$1" "================================================================="

    CT_DoLog "$1" "$2"

    CT_STEP_COUNT=$((CT_STEP_COUNT+1))

    CT_STEP_LEVEL[${CT_STEP_COUNT}]="$1"; shift

    CT_STEP_START[${CT_STEP_COUNT}]="${start}"

    CT_STEP_MESSAGE[${CT_STEP_COUNT}]="$1"

    return 0

}

# End the step just being done

# Usage: CT_EndStep

CT_EndStep() {

    local stop=$(CT_DoDate +%s%N)

    local duration=$(printf "%032d" $((stop-${CT_STEP_START[${CT_STEP_COUNT}]})) |sed -r -e 's/([[:digit:]]{2})[[:digit:]]{7}$/\.\1/; s/^0+//; s/^\./0\./;')

    local elapsed=$(printf "%02d:%02d" $((SECONDS/60)) $((SECONDS%60)))

    local level="${CT_STEP_LEVEL[${CT_STEP_COUNT}]}"

    local message="${CT_STEP_MESSAGE[${CT_STEP_COUNT}]}"

    CT_STEP_COUNT=$((CT_STEP_COUNT-1))

    CT_DoLog "${level}" "${message}: done in ${duration}s (at ${elapsed})"

    return 0

}

# Pushes into a directory, and pops back

CT_Pushd() {

    CT_DoLog DEBUG "Entering '$1'"

    pushd "$1" >/dev/null 2>&1

}

CT_Popd() {

    popd >/dev/null 2>&1

}

# Create a dir and cd or pushd into it

# Usage: CT_mkdir_cd <dir/to/create>

#        CT_mkdir_pushd <dir/to/create>

CT_mkdir_cd() {

    local dir="${1}"

    mkdir -p "${dir}"

    cd "${dir}"

}

CT_mkdir_pushd() {

    local dir="${1}"

    mkdir -p "${dir}"

    CT_Pushd "${dir}"

}

# Creates a temporary directory

# $1: variable to assign to

# Usage: CT_MktempDir foo

CT_MktempDir() {

    # Some mktemp do not allow more than 6 Xs

    eval "$1"=$(mktemp -q -d "${CT_BUILD_DIR}/tmp.XXXXXX")

    CT_TestOrAbort "Could not make temporary directory" -n "${!1}" -a -d "${!1}"

    CT_DoLog DEBUG "Made temporary directory '${!1}'"

    return 0

}

# Removes one or more directories, even if it is read-only, or its parent is

# Usage: CT_DoForceRmdir dir [...]

CT_DoForceRmdir() {

    local dir

    local mode

    for dir in "${@}"; do

        [ -d "${dir}" ] || continue

        case "$CT_SYS_OS" in

            Linux|CYGWIN*)

                mode="$(stat -c '%a' "$(dirname "${dir}")")"

                ;;

            Darwin|*BSD)

                mode="$(stat -f '%Lp' "$(dirname "${dir}")")"

                ;;

            *)

                CT_Abort "Unhandled host OS $CT_SYS_OS"

                ;;

        esac

        CT_DoExecLog ALL chmod u+w "$(dirname "${dir}")"

        CT_DoExecLog ALL chmod -R u+w "${dir}"

        CT_DoExecLog ALL rm -rf "${dir}"

        CT_DoExecLog ALL chmod ${mode} "$(dirname "${dir}")"

    done

}

# Echoes the specified string on stdout until the pipe breaks.

# Doesn't fail

# $1: string to echo

# Usage: CT_DoYes "" |make oldconfig

CT_DoYes() {

    yes "$1" || true

}

# Add the specified directory to LD_LIBRARY_PATH, and export it

# If the specified patch is already present, just export

# $1: path to add

# $2: add as 'first' or 'last' path, 'first' is assumed if $2 is empty

# Usage CT_SetLibPath /some/where/lib [first|last]

CT_SetLibPath() {

    local path="$1"

    local pos="$2"

    case ":${LD_LIBRARY_PATH}:" in

        *:"${path}":*)  ;;

        *)  case "${pos}" in

                last)

                    CT_DoLog DEBUG "Adding '${path}' at end of LD_LIBRARY_PATH"

                    LD_LIBRARY_PATH="${LD_LIBRARY_PATH:+${LD_LIBRARY_PATH}:}${path}"

                    ;;

                first|"")

                    CT_DoLog DEBUG "Adding '${path}' at start of LD_LIBRARY_PATH"

                    LD_LIBRARY_PATH="${path}${LD_LIBRARY_PATH:+:${LD_LIBRARY_PATH}}"

                    ;;

                *)

                    CT_Abort "Incorrect position '${pos}' to add '${path}' to LD_LIBRARY_PATH"

                    ;;

            esac

            ;;

    esac

    CT_DoLog DEBUG "==> LD_LIBRARY_PATH='${LD_LIBRARY_PATH}'"

    export LD_LIBRARY_PATH

}

# Build up the list of allowed tarball extensions

# Add them in the prefered order; most preferred comes first

CT_DoListTarballExt() {

    if [ "${CT_CONFIGURE_has_xz}" = "y" ]; then

        printf ".tar.xz\n"

    fi

    if [    "${CT_CONFIGURE_has_lzma}" = "y"    \

         -o "${CT_CONFIGURE_has_xz}" = "y" ]; then

        printf ".tar.lzma\n"

    fi

    printf ".tar.bz2\n"

    printf ".tar.gz\n.tgz\n"

    printf ".tar\n"

    printf ".zip\n"

}

# Get the file name extension of a component

# Usage: CT_GetFileExtension <component_name-component_version> [extension]

# If found, echoes the extension to stdout, and return 0

# If not found, echoes nothing on stdout, and return !0.

CT_GetFileExtension() {

    local ext

    local file="$1"

    shift

    local first_ext="$1"

    # we need to also check for an empty extension for those very

    # peculiar components that don't have one (such as sstrip from

    # buildroot).

    for ext in ${first_ext} $(CT_DoListTarballExt) /.git ''; do

        if [ -e "${CT_TARBALLS_DIR}/${file}${ext}" ]; then

            echo "${ext}"

            exit 0

        fi

    done

    exit 1

}

# Try to retrieve the specified URL (HTTP or FTP)

# Usage: CT_DoGetFile <URL>

# This functions always returns true (0), as it can be legitimate not

# to find the requested URL (think about snapshots, different layouts

# for different gcc versions, etc...).

CT_DoGetFile() {

    local url="${1}"

    local dest="${CT_TARBALLS_DIR}/${url##*/}"

    local tmp="${dest}.tmp-dl"

    # Remove potential left-over from a previous run

    rm -f "${tmp}"

    # We also retry a few times, in case there is a transient error (eg. behind

    # a dynamic IP that changes during the transfer...)

    # With automated download as we are doing, it can be very dangerous to

    # continue the downloads. It's far better to simply overwrite the

    # destination file.

    # Some company networks have firewalls to connect to the internet, but it's

    # not easy to detect them, so force a global ${CT_CONNECT_TIMEOUT}-second

    # timeout.

    # For curl, no good progress indicator is available. So, be silent.

    if CT_DoExecLog ALL wget --passive-ftp --tries=3 -nc    \

                             --progress=dot:binary          \

                             -T ${CT_CONNECT_TIMEOUT}       \

                             -O "${tmp}"                    \

                             "${url}"

    then

        # Success, we got it, good!

        mv "${tmp}" "${dest}"

        CT_DoLog DEBUG "Got it from: \"${url}\""

    else

        # Woops...

        rm -f "${tmp}"

        CT_DoLog DEBUG "Not at this location: \"${url}\""

    fi

}

# This function tries to retrieve a tarball form a local directory

# Usage: CT_GetLocal <basename> [.extension]

CT_GetLocal() {

    local basename="$1"

    local first_ext="$2"

    local ext

    # Do we already have it in *our* tarballs dir?

    if ext="$( CT_GetFileExtension "${basename}" ${first_ext} )"; then

        CT_DoLog DEBUG "Already have '${basename}'"

        return 0

    fi

    if [ -n "${CT_LOCAL_TARBALLS_DIR}" ]; then

        CT_DoLog DEBUG "Trying to retrieve an already downloaded copy of '${basename}'"

        # We'd rather have a bzip2'ed tarball, then gzipped tarball, plain tarball,

        # or, as a failover, a file without extension.

        for ext in ${first_ext} $(CT_DoListTarballExt) ''; do

            CT_DoLog DEBUG "Trying '${CT_LOCAL_TARBALLS_DIR}/${basename}${ext}'"

            if [ -r "${CT_LOCAL_TARBALLS_DIR}/${basename}${ext}" -a \

                 "${CT_FORCE_DOWNLOAD}" != "y" ]; then

                CT_DoLog DEBUG "Got '${basename}' from local storage"

                CT_DoExecLog ALL ln -s "${CT_LOCAL_TARBALLS_DIR}/${basename}${ext}" "${CT_TARBALLS_DIR}/${basename}${ext}"

                return 0

            fi

        done

    fi

    return 1

}

# This function gets the custom source from either a tarball or directory

# Usage: CT_GetCustom <component> <custom_version> <custom_location>

CT_GetCustom() {

    local custom_component="$1"

    local custom_version="$2"

    local custom_location="$3"

    local custom_name="${custom_component}-${custom_version}"

    CT_TestAndAbort "${custom_name}: CT_CUSTOM_LOCATION_ROOT_DIR or ${custom_component}'s CUSTOM_LOCATION must be set." \

                    -z "${CT_CUSTOM_LOCATION_ROOT_DIR}" -a -z "${custom_location}"

    if [ -n "${CT_CUSTOM_LOCATION_ROOT_DIR}" \

         -a -z "${custom_location}"          ]; then

        custom_location="${CT_CUSTOM_LOCATION_ROOT_DIR}/${custom_component}"

    fi

    CT_DoLog EXTRA "Using '${custom_name}' from custom location"

    if [ ! -d "${custom_location}" ]; then

        # We need to know the custom tarball extension,

        # so we can create a properly-named symlink, which

        # we use later on in 'extract'

        case "${custom_location}" in

            *.tar.xz)       custom_name="${custom_name}.tar.xz";;

            *.tar.bz2)      custom_name="${custom_name}.tar.bz2";;

            *.tar.gz|*.tgz) custom_name="${custom_name}.tar.gz";;

            *.tar)          custom_name="${custom_name}.tar";;

            *)  CT_Abort "Unknown extension for custom tarball '${custom_location}'";;

        esac

        CT_DoExecLog DEBUG ln -sf "${custom_location}"  \

                                  "${CT_TARBALLS_DIR}/${custom_name}"

    else

        CT_DoExecLog DEBUG ln -snf "${custom_location}" \

                                   "${CT_SRC_DIR}/${custom_name}"

    fi

}

# This function saves the specified to local storage if possible,

# and if so, symlinks it for later usage

# Usage: CT_SaveLocal </full/path/file.name>

CT_SaveLocal() {

    local file="$1"

    local basename="${file##*/}"

    if [ "${CT_SAVE_TARBALLS}" = "y" ]; then

        CT_DoLog EXTRA "Saving '${basename}' to local storage"

        # The file may already exist if downloads are forced: remove it first

        CT_DoExecLog ALL rm -f "${CT_LOCAL_TARBALLS_DIR}/${basename}"

        CT_DoExecLog ALL mv -f "${file}" "${CT_LOCAL_TARBALLS_DIR}"

        CT_DoExecLog ALL ln -s "${CT_LOCAL_TARBALLS_DIR}/${basename}" "${file}"

    fi

}

# Download the file from one of the URLs passed as argument

# Usage: CT_GetFile <basename> [.extension] <url> [url ...]

CT_GetFile() {

    local ext

    local -a URLS

    local url

    local file="$1"

    local first_ext

    shift

    # If next argument starts with a dot, then this is not an URL,

    # and we can consider that it is a preferred extension.

    case "$1" in

        .*) first_ext="$1"

            shift

            ;;

    esac

    # Does it exist localy?

    if CT_GetLocal "${file}" ${first_ext}; then

        return 0

    fi

    # No, it does not...

    # If not allowed to download from the Internet, don't

    if [ "${CT_FORBID_DOWNLOAD}" = "y" ]; then

        CT_DoLog DEBUG "Not allowed to download from the Internet, aborting ${file} download"

        return 1

    fi

    # Try to retrieve the file

    CT_DoLog EXTRA "Retrieving '${file}'"

    # Add URLs on the LAN mirror

    if [ "${CT_USE_MIRROR}" = "y" ]; then

        CT_TestOrAbort "Please set the mirror base URL" -n "${CT_MIRROR_BASE_URL}"

        URLS+=( "${CT_MIRROR_BASE_URL}/${file%-*}" )

        URLS+=( "${CT_MIRROR_BASE_URL}" )

    fi

    if [ "${CT_FORCE_MIRROR}" != "y" ]; then

        URLS+=( "${@}" )

    fi

    # Scan all URLs in turn, and try to grab a tarball from there

    # Do *not* try git trees (ext=/.git), this is handled in a specific

    # wrapper, below

    for ext in ${first_ext} $(CT_DoListTarballExt) ''; do

        # Try all urls in turn

        for url in "${URLS[@]}"; do

            [ -n "${url}" ] || continue

            CT_DoLog DEBUG "Trying '${url}/${file}${ext}'"

            CT_DoGetFile "${url}/${file}${ext}"

            if [ -f "${CT_TARBALLS_DIR}/${file}${ext}" ]; then

                CT_DoLog DEBUG "Got '${file}' from the Internet"

                CT_SaveLocal "${CT_TARBALLS_DIR}/${file}${ext}"

                return 0

            fi

        done

    done

    # Just return error, someone may want to catch and handle the error

    # (eg. glibc/eglibc add-ons can be missing).

    return 1

}

# Checkout from CVS, and build the associated tarball

# The tarball will be called ${basename}.tar.bz2

# Prerequisite: either the server does not require password,

# or the user must already be logged in.

# 'tag' is the tag to retrieve. Must be specified, but can be empty.

# If dirname is specified, then module will be renamed to dirname

# prior to building the tarball.

# Usage: CT_GetCVS <basename> <url> <module> <tag> [dirname[=subdir]]

# Note: if '=subdir' is given, then it is used instead of 'module'.

CT_GetCVS() {

    local basename="$1"

    local uri="$2"

    local module="$3"

    local tag="${4:+-r ${4}}"

    local dirname="$5"

    local tmp_dir

    # First try locally, then the mirror

    if CT_GetFile "${basename}"; then

        # Got it! Return early! :-)

        return 0

    fi

    if [ "${CT_FORBID_DOWNLOAD}" = "y" ]; then

        CT_DoLog WARN "Downloads forbidden, not trying cvs retrieval"

        return 1

    fi

    CT_MktempDir tmp_dir

    CT_Pushd "${tmp_dir}"

    CT_DoExecLog ALL cvs -z 9 -d "${uri}" co -P ${tag} "${module}"

    if [ -n "${dirname}" ]; then

        case "${dirname}" in

            *=*)

                CT_DoExecLog DEBUG mv "${dirname#*=}" "${dirname%%=*}"

                CT_DoExecLog ALL tar cjf "${CT_TARBALLS_DIR}/${basename}.tar.bz2" "${dirname%%=*}"

                ;;

            *)

                CT_DoExecLog ALL mv "${module}" "${dirname}"

                CT_DoExecLog ALL tar cjf "${CT_TARBALLS_DIR}/${basename}.tar.bz2" "${dirname:-${module}}"

                ;;

        esac

    fi

    CT_SaveLocal "${CT_TARBALLS_DIR}/${basename}.tar.bz2"

    CT_Popd

    CT_DoExecLog ALL rm -rf "${tmp_dir}"

}

# Check out from SVN, and build the associated tarball

# The tarball will be called ${basename}.tar.bz2

# Prerequisite: either the server does not require password,

# or the user must already be logged in.

# 'rev' is the revision to retrieve

# Usage: CT_GetSVN <basename> <url> [rev]

CT_GetSVN() {

    local basename="$1"

    local uri="$2"

    local rev="$3"

    # First try locally, then the mirror

    if CT_GetFile "${basename}"; then

        # Got it! Return early! :-)

        return 0

    fi

    if [ "${CT_FORBID_DOWNLOAD}" = "y" ]; then

        CT_DoLog WARN "Downloads forbidden, not trying svn retrieval"

        return 1

    fi

    CT_MktempDir tmp_dir

    CT_Pushd "${tmp_dir}"

    if ! CT_DoExecLog ALL svn export ${rev:+-r ${rev}} "${uri}" "${basename}"; then

        CT_DoLog WARN "Could not retrieve '${basename}'"

        return 1

    fi

    CT_DoExecLog ALL tar cjf "${CT_TARBALLS_DIR}/${basename}.tar.bz2" "${basename}"

    CT_SaveLocal "${CT_TARBALLS_DIR}/${basename}.tar.bz2"

    CT_Popd

    CT_DoExecLog ALL rm -rf "${tmp_dir}"

}

# Clone a git tree

# Tries the given URLs in turn until one can get cloned. No tarball will be created.

# Prerequisites: either the server does not require password,

# or the user has already taken any action to authenticate to the server.

# The cloned tree will *not* be stored in the local tarballs dir!

# Usage: CT_GetGit <basename> <url [url ...]>

CT_GetGit() {

    local basename="$1"; shift

    local url

    local cloned=0

    if [ "${CT_FORBID_DOWNLOAD}" = "y" ]; then

        CT_DoLog WARN "Downloads forbidden, not trying git retrieval"

        return 1

    fi

    # Do we have it in our tarballs dir?

    if [ -d "${CT_TARBALLS_DIR}/${basename}/.git" ]; then

        CT_DoLog EXTRA "Updating git tree '${basename}'"

        CT_Pushd "${CT_TARBALLS_DIR}/${basename}"

        CT_DoExecLog ALL git pull

        CT_Popd

    else

        CT_DoLog EXTRA "Retrieving git tree '${basename}'"

        for url in "${@}"; do

            CT_DoLog ALL "Trying to clone from '${url}'"

            CT_DoForceRmdir "${CT_TARBALLS_DIR}/${basename}"

            if git clone "${url}" "${CT_TARBALLS_DIR}/${basename}" 2>&1 |CT_DoLog ALL; then

                cloned=1

                break

            fi

        done

        CT_TestOrAbort "Could not clone '${basename}'" ${cloned} -ne 0

    fi

}

# Extract a tarball

# Some tarballs need to be extracted in specific places. Eg.: glibc addons

# must be extracted in the glibc directory; uCLibc locales must be extracted

# in the extra/locale sub-directory of uClibc. This is taken into account

# by the caller, that did a 'cd' into the correct path before calling us

# and sets nochdir to 'nochdir'.

# Note also that this function handles the git trees!

# Usage: CT_Extract [nochdir] <basename> [options]

# where 'options' are dependent on the source (eg. git branch/tag...)

CT_Extract() {

    local nochdir="$1"

    local basename

    local ext

    local lzma_prog

    local -a tar_opts

    if [ "${nochdir}" = "nochdir" ]; then

        shift

        nochdir="$(pwd)"

    else

        nochdir="${CT_SRC_DIR}"

    fi

    basename="$1"

    shift

    if ! ext="$(CT_GetFileExtension "${basename}")"; then

        CT_DoLog WARN "'${basename}' not found in '${CT_TARBALLS_DIR}'"

        return 1

    fi

    local full_file="${CT_TARBALLS_DIR}/${basename}${ext}"

    # Check if already extracted

    if [ -e "${CT_SRC_DIR}/.${basename}.extracted" ]; then

        CT_DoLog DEBUG "Already extracted '${basename}'"

        return 0

    fi

    # Check if previously partially extracted

    if [ -e "${CT_SRC_DIR}/.${basename}.extracting" ]; then

        CT_DoLog ERROR "The '${basename}' sources were partially extracted."

        CT_DoLog ERROR "Please remove first:"

        CT_DoLog ERROR " - the source dir for '${basename}', in '${CT_SRC_DIR}'"

        CT_DoLog ERROR " - the file '${CT_SRC_DIR}/.${basename}.extracting'"

        CT_Abort "I'll stop now to avoid any carnage..."

    fi

    CT_DoExecLog DEBUG touch "${CT_SRC_DIR}/.${basename}.extracting"

    CT_Pushd "${nochdir}"

    CT_DoLog EXTRA "Extracting '${basename}'"

    CT_DoExecLog FILE mkdir -p "${basename}"

    tar_opts=( "--strip-components=1" )

    tar_opts+=( "-C" "${basename}" )

    tar_opts+=( "-xv" )

    # One note here:

    # - lzma can be handled either with 'xz' or 'lzma'

    # - we get lzma tarball only if either or both are available

    # - so, if we get an lzma tarball, and either 'xz' or 'lzma' is

    #   missing, we can assume the other is available

    if [ "${CT_CONFIGURE_has_lzma}" = "y" ]; then

        lzma_prog="lzma -fdc"

    else

        lzma_prog="xz -fdc"

    fi

    case "${ext}" in

        .tar.xz)      xz -fdc "${full_file}" | CT_DoExecLog FILE tar "${tar_opts[@]}" -f -;;

        .tar.lzma)    ${lzma_prog} "${full_file}" | CT_DoExecLog FILE tar "${tar_opts[@]}" -f -;;

        .tar.bz2)     bzip2 -dc "${full_file}" | CT_DoExecLog FILE tar "${tar_opts[@]}" -f -;;

        .tar.gz|.tgz) gzip -dc "${full_file}" | CT_DoExecLog FILE tar "${tar_opts[@]}" -f -;;

        .tar)         CT_DoExecLog FILE tar "${tar_opts[@]}" -f "${full_file}";;

        .zip)         CT_DoExecLog FILE unzip "${@}" "${full_file}";;

        /.git)        CT_ExtractGit "${basename}" "${@}";;

        *)            CT_DoLog WARN "Don't know how to handle '${basename}${ext}': unknown extension"

                      return 1

                      ;;

    esac

    # Don't mark as being extracted for git

    case "${ext}" in

        /.git)  ;;

        *)      CT_DoExecLog DEBUG touch "${CT_SRC_DIR}/.${basename}.extracted";;

    esac

    CT_DoExecLog DEBUG rm -f "${CT_SRC_DIR}/.${basename}.extracting"

    CT_Popd

}

# Create a working git clone of a local git repository

# Usage: CT_ExtractGit <basename> [ref]

# where 'ref' is the reference to use:

#   the full name of a branch, like "remotes/origin/branch_name"

#   a date as understandable by git, like "YYYY-MM-DD[ hh[:mm[:ss]]]"

#   a tag name

# If 'ref' is not given, the current repository HEAD will be used

CT_ExtractGit() {

    local basename="${1}"

    local ref="${2}"

    local repo

    local ref_type

    # pushd now to be able to get git revlist in case ref is a date

    repo="${CT_TARBALLS_DIR}/${basename}"

    CT_Pushd "${repo}"

    # What kind of reference is ${ref} ?

    if [ -z "${ref}" ]; then

        ref_type=head

        ref=$(git rev-list -n1 HEAD)

    elif git tag |grep -E "^${ref}$" >/dev/null 2>&1; then

        ref_type=tag

    elif git branch -a --no-color |grep -E "^. ${ref}$" >/dev/null 2>&1; then

        ref_type=branch

    elif date -d "${ref}" >/dev/null 2>&1; then

        ref_type=date

        ref=$(git rev-list -n1 --before="${ref}")

    else

        CT_Abort "Reference '${ref}' is an incorrect git reference: neither tag, branch nor date"

    fi

    CT_Popd

    CT_DoExecLog FILE rmdir "${basename}"

    case "${ref_type}" in

        branch) CT_DoExecLog FILE git clone -b "${ref}" "${repo}" "${basename}" ;;

        *)      CT_DoExecLog FILE git clone "${repo}" "${basename}"

                CT_Pushd "${basename}"

                CT_DoExecLog FILE git checkout "${ref}"

                CT_Popd

                ;;

    esac

}