#!/bin/bash # Include config rc file if found CONFIG_FILE="$HOME/.bpkgrc" # shellcheck disable=SC1090 [[ -f "$CONFIG_FILE" ]] && source "$CONFIG_FILE" ## set defaults if [[ ${#BPKG_REMOTES[@]} -eq 0 ]]; then BPKG_REMOTES[0]=${BPKG_REMOTE-https://raw.githubusercontent.com} BPKG_GIT_REMOTES[0]=${BPKG_GIT_REMOTE-https://github.com} fi BPKG_USER="${BPKG_USER:-bpkg}" ## check parameter consistency validate_parameters () { if [[ ${#BPKG_GIT_REMOTES[@]} -ne ${#BPKG_REMOTES[@]} ]]; then error "$(printf 'BPKG_GIT_REMOTES[%d] differs in size from BPKG_REMOTES[%d] array' "${#BPKG_GIT_REMOTES[@]}" "${#BPKG_REMOTES[@]}")" return 1 fi return 0 } ## outut usage usage () { echo 'usage: bpkg-install [-h|--help]' echo ' or: bpkg-install [-g|--global] ' echo ' or: bpkg-install [-g|--global] /' } ## format and output message message () { if type -f bpkg-term > /dev/null 2>&1; then bpkg-term color "${1}" fi shift echo -n " ${1}" shift if type -f bpkg-term > /dev/null 2>&1; then bpkg-term reset fi printf ': ' if type -f bpkg-term > /dev/null 2>&1; then bpkg-term reset bpkg-term bright fi printf "%s\n" "${@}" if type -f bpkg-term > /dev/null 2>&1; then bpkg-term reset fi } ## output error error () { { message 'red' 'error' "${@}" } >&2 } ## output warning warn () { { message 'yellow' 'warn' "${@}" } >&2 } ## output info info () { local title='info' if (( "${#}" > 1 )); then title="${1}" shift fi message 'cyan' "${title}" "${@}" } save_remote_file () { local auth_param path url url="${1}" path="${2}" auth_param="${3:-}" local dirname="$(dirname "${path}")" # Make sure directory exists if [[ ! -d "${dirname}" ]];then mkdir -p "${dirname}" fi if [[ "${auth_param}" ]];then curl --silent -L -o "${path}" -u "${auth_param}" "${url}" else curl --silent -L -o "${path}" "${url}" fi } url_exists () { local auth_param exists url url="${1}" auth_param="${2:-}" exists=0 if [[ "${auth_param}" ]];then status=$(curl --silent -L -w '%{http_code}' -o '/dev/null' -u "${auth_param}" "${url}") result="$?" else status=$(curl --silent -L -w '%{http_code}' -o '/dev/null' "${url}") result="$?" fi # In some rare cases, curl will return CURLE_WRITE_ERROR (23) when writing # to `/dev/null`. In such a case we do not care that such an error occured. # We are only interested in the status, which *will* be available regardless. if [[ '0' != "${result}" && '23' != "${result}" ]] || (( status >= 400 )); then exists=1 fi return "${exists}" } read_package_json () { local auth_param url url="${1}" auth_param="${2:-}" if [[ "${auth_param}" ]];then curl --silent -L -u "${auth_param}" "${url}" else curl --silent -L "${url}" fi } ## Install a bash package bpkg_install () { local pkg='' local let needs_global=0 for opt in "${@}"; do if [[ '-' = "${opt:0:1}" ]]; then continue fi pkg="${opt}" break done for opt in "${@}"; do case "${opt}" in -h|--help) usage return 0 ;; -g|--global) shift needs_global=1 ;; *) if [[ '-' = "${opt:0:1}" ]]; then echo 2>&1 "error: Unknown argument \`${1}'" usage return 1 fi ;; esac done ## ensure there is a package to install if [[ -z "${pkg}" ]]; then usage return 1 fi echo ## Check each remote in order local let i=0 for remote in "${BPKG_REMOTES[@]}"; do local git_remote=${BPKG_GIT_REMOTES[$i]} bpkg_install_from_remote "$pkg" "$remote" "$git_remote" $needs_global if [[ "$?" == '0' ]]; then return 0 elif [[ "$?" == '2' ]]; then error 'fatal error occurred during install' return 1 fi i=$((i+1)) done error 'package not found on any remote' return 1 } ## try to install a package from a specific remote ## returns values: ## 0: success ## 1: the package was not found on the remote ## 2: a fatal error occurred bpkg_install_from_remote () { local pkg=$1 local remote=$2 local git_remote=$3 local let needs_global=$4 local cwd=$(pwd) local url='' local uri='' local version='' local status='' local json='' local user='' local name='' local version='' local auth_param='' local let has_pkg_json=0 declare -a local pkg_parts=() declare -a local remote_parts=() declare -a local scripts=() declare -a local files=() ## get version if available { OLDIFS="${IFS}" IFS="@" pkg_parts=(${pkg}) IFS="${OLDIFS}" } if [[ ${#pkg_parts[@]} -eq 1 ]]; then version='master' #info "Using latest (master)" elif [[ ${#pkg_parts[@]} -eq 2 ]]; then name="${pkg_parts[0]}" version="${pkg_parts[1]}" else error 'Error parsing package version' return 1 fi ## split by user name and repo { OLDIFS="${IFS}" IFS='/' pkg_parts=(${pkg}) IFS="${OLDIFS}" } if [[ ${#pkg_parts[@]} -eq 1 ]]; then user="${BPKG_USER}" name="${pkg_parts[0]}" elif [[ ${#pkg_parts[@]} -eq 2 ]]; then user="${pkg_parts[0]}" name="${pkg_parts[1]}" else error 'Unable to determine package name' return 1 fi ## clean up name of weird trailing ## versions and slashes name=${name/@*//} name=${name////} ## check to see if remote is raw with oauth (GHE) if [[ "${remote:0:10}" == "raw-oauth|" ]]; then info 'Using OAUTH basic with content requests' OLDIFS="${IFS}" IFS="'|'" local remote_parts=($remote) IFS="${OLDIFS}" local token=${remote_parts[1]} remote=${remote_parts[2]} auth_param="$token:x-oauth-basic" uri="/${user}/${name}/raw/${version}" ## If git remote is a URL, and doesn't contain token information, we ## inject it into the @host field if [[ "$git_remote" == https://* ]] && [[ "$git_remote" != *x-oauth-basic* ]] && [[ "$git_remote" != *${token}* ]]; then git_remote=${git_remote/https:\/\//https:\/\/$token:x-oauth-basic@} fi else uri="/${user}/${name}/${version}" fi ## clean up extra slashes in uri uri=${uri/\/\///} info "Install $uri from remote $remote [$git_remote]" ## Ensure remote is reachable ## If a remote is totally down, this will be considered a fatal ## error since the user may have intended to install the package ## from the broken remote. { if ! url_exists "${remote}" "${auth_param}"; then error "Remote unreachable: ${remote}" return 2 fi } ## build url url="${remote}${uri}" repo_url="${git_remote}/${user}/${name}.git" ## determine if `bpkg.json` or 'package.json' exists at url { if url_exists "${url}/bpkg.json?$(date +%s)" "${auth_param}"; then has_pkg_json=2 else warn 'bpkg.json doesn`t exist' if url_exists "${url}/package.json?$(date +%s)" "${auth_param}"; then has_pkg_json=1 else warn 'package.json doesn`t exist' has_pkg_json=0 # check to see if there's a Makefile. If not, this is not a valid package if ! url_exists "${url}/Makefile?$(date +%s)" "${auth_param}"; then warn "Makefile not found, skipping remote: $url" return 1 fi fi fi } ## read bpkg.json or package.json if (( 2 == has_pkg_json )); then json=$(read_package_json "${url}/bpkg.json?$(date +%s)" "${auth_param}") elif (( 1 == has_pkg_json )); then json=$(read_package_json "${url}/package.json?$(date +%s)" "${auth_param}") fi if (( has_pkg_json > 0 )); then ## get package name from 'bpkg.json' or 'package.json' name="$( echo -n "${json}" | bpkg-json -b | grep -m 1 '"name"' | awk '{ $1=""; print $0 }' | tr -d '\"' | tr -d ' ' )" ## check if forced global if [[ "$(echo -n "${json}" | bpkg-json -b | grep '\["global"\]' | awk '{ print $2 }' | tr -d '"')" == 'true' ]]; then needs_global=1 fi ## construct scripts array { scripts=$(echo -n "${json}" | bpkg-json -b | grep '\["scripts' | awk '{ print $2 }' | tr -d '"') ## create array by splitting on newline OLDIFS="${IFS}" IFS=$'\n' scripts=(${scripts[@]}) IFS="${OLDIFS}" } ## construct files array { files=$(echo -n "${json}" | bpkg-json -b | grep '\["files' | awk '{ print $2 }' | tr -d '"') ## create array by splitting on newline OLDIFS="${IFS}" IFS=$'\n' files=(${files[@]}) IFS="${OLDIFS}" } fi ## build global if needed if (( 1 == needs_global )); then if (( has_pkg_json > 0 )); then ## install bin if needed build="$(echo -n "${json}" | bpkg-json -b | grep '\["install"\]' | awk '{$1=""; print $0 }' | tr -d '\"')" build="$(echo -n "${build}" | sed -e 's/^ *//' -e 's/ *$//')" fi if [[ -z "${build}" ]]; then warn 'Missing build script' warn 'Trying `make install`...' build='make install' fi if [ -z "$PREFIX" ]; then if [ "$USER" == "root" ]; then PREFIX="/usr/local" else PREFIX="$HOME/.local" fi build="env PREFIX=$PREFIX $build" fi { ( ## go to tmp dir cd "$( [[ ! -z "${TMPDIR}" ]] && echo "${TMPDIR}" || echo /tmp)" && ## prune existing rm -rf "${name}-${version}" && ## shallow clone info "Cloning ${repo_url} to ${name}-${version}" git clone "${repo_url}" "${name}-${version}" && ( ## move into directory cd "${name}-${version}" && ( ## checkout to branch version git checkout ${version} || ## checkout into branch 'main' just in case 'master' was renamed [ "${version}" = "master" ] && git checkout main ) && ## build info "Performing install: \`${build}'" build_output=$(eval "${build}") echo "${build_output}" ) && ## clean up rm -rf "${name}-${version}" ) } ## perform local install otherwise else ## copy bpkg.json or package.json over if (( 2 == has_pkg_json )); then save_remote_file "${url}/bpkg.json" "${cwd}/deps/${name}/bpkg.json" "${auth_param}" elif (( 1 == has_pkg_json )); then save_remote_file "${url}/package.json" "${cwd}/deps/${name}/package.json" "${auth_param}" fi ## make 'deps/' directory if possible mkdir -p "${cwd}/deps/${name}" ## make 'deps/bin' directory if possible mkdir -p "${cwd}/deps/bin" # install package dependencies info "Install dependencies for ${name}" (cd "${cwd}/deps/${name}" && bpkg getdeps) ## grab each script and place in deps directory for script in "${scripts[@]}"; do ( if [[ "${script}" ]];then local scriptname="$(echo "${script}" | xargs basename )" info "fetch" "${url}/${script}" info "write" "${cwd}/deps/${name}/${script}" save_remote_file "${url}/${script}" "${cwd}/deps/${name}/${script}" "${auth_param}" scriptname="${scriptname%.*}" info "${scriptname} to PATH" "${cwd}/deps/bin/${scriptname}" ln -si "${cwd}/deps/${name}/${script}" "${cwd}/deps/bin/${scriptname}" chmod u+x "${cwd}/deps/bin/${scriptname}" fi ) done if [[ "${#files[@]}" -gt '0' ]]; then ## grab each file and place in correct directory for file in "${files[@]}"; do ( if [[ "${file}" ]];then local filename="$(echo "${file}" | xargs basename )" info "fetch" "${url}/${file}" info "write" "${cwd}/deps/${name}/${file}" save_remote_file "${url}/${file}" "${cwd}/deps/${name}/${file}" "${auth_param}" fi ) done fi fi return 0 } ## Use as lib or perform install if [[ ${BASH_SOURCE[0]} != "$0" ]]; then export -f bpkg_install elif validate_parameters; then bpkg_install "${@}" exit $? else #param validation failed exit $? fi