|
#!/usr/bin/env bash |
|
|
|
### agc PACKAGE ... Usage:help |
|
# |
|
# Install each PACKAGE, creating a debconf settings file each time. |
|
# |
|
# You can then edit this file, delete (or comment out with '#') irrelevant sections. |
|
# |
|
# You can then run the same command `apt-get-settings.sh PACKAGE ...` on another machine, with the settings files, and the script will pick these up as defaults. |
|
# |
|
###/doc |
|
|
|
##bash-libs: safe.sh @ 1d3814ad (2.1.13) |
|
|
|
### Safe mode Usage:bbuild |
|
# |
|
# Set global safe mode options |
|
# |
|
# * Script bails if a statement or command returns non-zero status |
|
# * except when in a conditional statement |
|
# * Accessing a variable that is not set is an error, causing non-zero status of the operation |
|
# * Prevents globs |
|
# * If a component of a pipe fails, the entire pipe statement returns non-zero |
|
# |
|
# Splitting over spaces |
|
# --------------------- |
|
# |
|
# By default, array assignments and `read` command split over any whitespace. |
|
# |
|
# You can deactivate space splitting using `safe:space-split off` |
|
# and reactivate it using `safe:space-split on` |
|
# |
|
# Globs |
|
# ------- |
|
# |
|
# In safe mode, glob expansion like `ls .config/*` is turned off by default. |
|
# |
|
# You can turn glob expansion on with `safe:glob on`, and off with `safe:glob off` |
|
# |
|
###/doc |
|
|
|
safe:space-split() { |
|
case "$1" in |
|
off) |
|
export IFS=$'\t\n' |
|
;; |
|
on) |
|
export IFS=$' \t\n' |
|
;; |
|
*) |
|
out:fail "API error: bad use of safe:split - must be 'on' or 'off' not '$1'" |
|
;; |
|
esac |
|
} |
|
|
|
safe:glob() { |
|
case "$1" in |
|
off) |
|
set -f |
|
;; |
|
on) |
|
set +f |
|
;; |
|
*) |
|
out:fail "API error: bad use of safe:glob - must be 'on' or 'off' not '$1'" |
|
;; |
|
esac |
|
} |
|
|
|
set -eufo pipefail |
|
|
|
|
|
##bash-libs: syntax-extensions.sh @ 1d3814ad (2.1.13) |
|
|
|
### Syntax Extensions Usage:syntax |
|
# |
|
# Syntax extensions for bash-builder. |
|
# |
|
# You will need to import this library if you use Bash Builder's extended syntax macros. |
|
# |
|
# You should not however use the functions directly, but the extended syntax instead. |
|
# |
|
##/doc |
|
|
|
### syntax-extensions:use FUNCNAME ARGNAMES ... Usage:syntax |
|
# |
|
# Consume arguments into named global variables. |
|
# |
|
# If not enough argument values are found, the first named variable that failed to be assigned is printed as error |
|
# |
|
# ARGNAMES prefixed with '?' do not trigger an error |
|
# |
|
# Example: |
|
# |
|
# #%include std/out.sh |
|
# #%include std/syntax-extensions.sh |
|
# |
|
# get_parameters() { |
|
# . <(syntax-extensions:use get_parameters INFILE OUTFILE ?comment -- "$@") |
|
# |
|
# [[ -f "$INFILE" ]] || out:fail "Input file '$INFILE' does not exist" |
|
# [[ -f "$OUTFILE" ]] || out:fail "Output file '$OUTFILE' does not exist" |
|
# |
|
# [[ -z "$comment" ]] || echo "Note: $comment" |
|
# } |
|
# |
|
# main() { |
|
# get_parameters "$@" |
|
# |
|
# echo "$INFILE will be converted to $OUTFILE" |
|
# } |
|
# |
|
# main "$@" |
|
# |
|
###/doc |
|
syntax-extensions:use() { |
|
local argname arglist undef_f dec_scope argidx argone failmsg pos_ok |
|
|
|
dec_scope="" |
|
[[ "${SYNTAXLIB_scope:-}" = local ]] || dec_scope=g |
|
arglist=(:) |
|
argone=\"\${1:-}\" |
|
pos_ok=true |
|
|
|
for argname in "$@"; do |
|
[[ "$argname" != -- ]] || break |
|
[[ "$argname" =~ ^(\?|\*)?[0-9a-zA-Z_]+$ ]] || out:fail "Internal: Not a valid argument name '$argname'" |
|
|
|
arglist+=("$argname") |
|
done |
|
|
|
argidx=1 |
|
while [[ "$argidx" -lt "${#arglist[@]}" ]]; do |
|
argname="${arglist[$argidx]}" |
|
failmsg="\"Internal: could not get '$argname' in function arguments\"" |
|
posfailmsg="\"Internal: positional argument '$argname' encountered after optional argument(s)\"" |
|
|
|
if [[ "$argname" =~ ^\? ]]; then |
|
echo "$SYNTAXLIB_scope ${argname:1}" |
|
echo "${argname:1}=$argone; shift || :" |
|
pos_ok=false |
|
|
|
elif [[ "$argname" =~ ^\* ]]; then |
|
if [[ "$pos_ok" = true ]]; then |
|
echo "[[ '${argname:1}' != \"$argone\" ]] || out:fail \"Internal: Local name [${argname:1}] is the same is the name it tries to reference. Rename [$argname] (suggestion: [*p_${argname:1}])\"" |
|
echo "declare -n${dec_scope} ${argname:1}=$argone; shift || out:fail $failmsg" |
|
else |
|
echo "out:fail $posfailmsg" |
|
fi |
|
|
|
else |
|
if [[ "$pos_ok" = true ]]; then |
|
echo "$SYNTAXLIB_scope ${argname}" |
|
echo "${argname}=$argone; shift || out:fail $failmsg" |
|
else |
|
echo "out:fail $posfailmsg" |
|
fi |
|
fi |
|
|
|
argidx=$((argidx + 1)) |
|
done |
|
} |
|
|
|
|
|
### syntax-extensions:use:local FUNCNAME ARGNAMES ... Usage:syntax |
|
# |
|
# Enables syntax macro: function signatures |
|
# e.g. $%function func(var1 var2) { ... } |
|
# |
|
# Build with bbuild to leverage this function's use: |
|
# |
|
# #%include out.sh |
|
# #%include syntax-extensions.sh |
|
# |
|
# $%function person(name email) { |
|
# echo "$name <$email>" |
|
# |
|
# # $1 and $2 have been consumed into $name and $email |
|
# # The rest remains available in $* : |
|
# |
|
# echo "Additional notes: $*" |
|
# } |
|
# |
|
# person "Jo Smith" "jsmith@example.com" Some details |
|
# |
|
###/doc |
|
syntax-extensions:use:local() { |
|
SYNTAXLIB_scope=local syntax-extensions:use "$@" |
|
} |
|
|
|
args:use:local() { |
|
syntax-extensions:use:local "$@" |
|
} |
|
##bash-libs: tty.sh @ 1d3814ad (2.1.13) |
|
|
|
### tty.sh Usage:bbuild |
|
# Get information on the current terminal session. |
|
###/doc |
|
|
|
### tty:is_ssh Usage:bbuild |
|
# Determine whether the TTY is an SSH session. |
|
# |
|
# WARNING: this only works for an SSH connection still in the "landing" account. |
|
# If the user is switched via 'su' or 'sudo', the environment is lost and the variables used to determine this are blank - by default, indicating being not in an SSH session. |
|
###/doc |
|
tty:is_ssh() { |
|
[[ -n "${SSH_TTY:-}" ]] || [[ -n "${SSH_CLIENT:-}" ]] || [[ "${SSH_CONNECTION:-}" ]] |
|
} |
|
|
|
### tty:is_pipe Usage:bbuild |
|
# Determine if we are running in a pipe. |
|
###/doc |
|
tty:is_pipe() { |
|
[[ ! -t 1 ]] |
|
} |
|
|
|
### tty:is_multiplexer Usage:bbuild |
|
# Determine if we are in a terminal multiplexer (detects 'screen' and 'tmux') |
|
###/doc |
|
tty:is_multiplexer() { |
|
[[ -n "${TMUX:-}" ]] || [[ "${TERM:-}" = screen ]] |
|
} |
|
|
|
##bash-libs: colours.sh @ 1d3814ad (2.1.13) |
|
|
|
### Colours for terminal Usage:bbuild |
|
# A series of shorthand colour flags for use in outputs, and functions to set your own flags. |
|
# |
|
# Not all terminals support all colours or modifiers. |
|
# |
|
# Example: |
|
# |
|
# echo "${CRED}Some red text ${CBBLU} some blue text. $CDEF Some text in the terminal's default colour") |
|
# |
|
# Preconfigured colours available: |
|
# |
|
# CRED, CBRED, HLRED -- red, bright red, highlight red |
|
# CGRN, CBGRN, HLGRN -- green, bright green, highlight green |
|
# CYEL, CBYEL, HLYEL -- yellow, bright yellow, highlight yellow |
|
# CBLU, CBBLU, HLBLU -- blue, bright blue, highlight blue |
|
# CPUR, CBPUR, HLPUR -- purple, bright purple, highlight purple |
|
# CTEA, CBTEA, HLTEA -- teal, bright teal, highlight teal |
|
# CBLA, CBBLA, HLBLA -- black, bright red, highlight red |
|
# CWHI, CBWHI, HLWHI -- white, bright red, highlight red |
|
# |
|
# Modifiers available: |
|
# |
|
# CBON - activate bright |
|
# CDON - activate dim |
|
# ULON - activate underline |
|
# RVON - activate reverse (switch foreground and background) |
|
# SKON - activate strikethrough |
|
# |
|
# Resets available: |
|
# |
|
# CNORM -- turn off bright or dim, without affecting other modifiers |
|
# ULOFF -- turn off highlighting |
|
# RVOFF -- turn off inverse |
|
# SKOFF -- turn off strikethrough |
|
# HLOFF -- turn off highlight |
|
# |
|
# CDEF -- turn off all colours and modifiers(switches to the terminal default) |
|
# |
|
# Note that highlight and underline must be applied or re-applied after specifying a colour. |
|
# |
|
# If the session is detected as being in a pipe, colours will be turned off. |
|
# You can override this by calling `colours:check --color=always` at the start of your script |
|
# |
|
###/doc |
|
|
|
### colours:check ARGS ... Usage:bbuild |
|
# |
|
# Check the args to see if there's a `--color=always` or `--color=never` |
|
# and reload the colours appropriately |
|
# |
|
# main() { |
|
# colours:check "$@" |
|
# |
|
# echo "${CGRN}Green only in tty or if --colours=always !${CDEF}" |
|
# } |
|
# |
|
# main "$@" |
|
# |
|
###/doc |
|
colours:check() { |
|
if [[ "$*" =~ --color=always ]]; then |
|
COLOURS_ON=true |
|
elif [[ "$*" =~ --color=never ]]; then |
|
COLOURS_ON=false |
|
fi |
|
|
|
colours:define |
|
return 0 |
|
} |
|
|
|
### colours:set CODE Usage:bbuild |
|
# Set an explicit colour code - e.g. |
|
# |
|
# echo "$(colours:set "33;2")Dim yellow text${CDEF}" |
|
# |
|
# See SGR Colours definitions |
|
# <https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_(Select_Graphic_Rendition)_parameters> |
|
###/doc |
|
colours:set() { |
|
# We use `echo -e` here rather than directly embedding a binary character |
|
if [[ "$COLOURS_ON" = false ]]; then |
|
return 0 |
|
else |
|
echo -en "\033[${1}m" |
|
fi |
|
} |
|
|
|
### colours:pipe CODE Usage:bbuild |
|
# |
|
# Prints a colourisation byte sequence using the provided number, then writes the pipe stream, and then writes a reset sequence (default is '0' to reset colours). |
|
# |
|
###/doc |
|
colours:pipe() { |
|
. <(args:use:local colourint ?reset -- "$@") ; |
|
if [[ "$COLOURS_ON" = true ]]; then |
|
colours:set "$colourint" |
|
cat - |
|
colours:set "${reset:-0}" |
|
fi |
|
} |
|
|
|
colours:define() { |
|
|
|
# Shorthand colours |
|
|
|
export CBLA="$(colours:set "30")" |
|
export CRED="$(colours:set "31")" |
|
export CGRN="$(colours:set "32")" |
|
export CYEL="$(colours:set "33")" |
|
export CBLU="$(colours:set "34")" |
|
export CPUR="$(colours:set "35")" |
|
export CTEA="$(colours:set "36")" |
|
export CWHI="$(colours:set "37")" |
|
|
|
export CBBLA="$(colours:set "1;30")" |
|
export CBRED="$(colours:set "1;31")" |
|
export CBGRN="$(colours:set "1;32")" |
|
export CBYEL="$(colours:set "1;33")" |
|
export CBBLU="$(colours:set "1;34")" |
|
export CBPUR="$(colours:set "1;35")" |
|
export CBTEA="$(colours:set "1;36")" |
|
export CBWHI="$(colours:set "1;37")" |
|
|
|
export HLBLA="$(colours:set "40")" |
|
export HLRED="$(colours:set "41")" |
|
export HLGRN="$(colours:set "42")" |
|
export HLYEL="$(colours:set "43")" |
|
export HLBLU="$(colours:set "44")" |
|
export HLPUR="$(colours:set "45")" |
|
export HLTEA="$(colours:set "46")" |
|
export HLWHI="$(colours:set "47")" |
|
|
|
# Modifiers |
|
|
|
export CBON="$(colours:set "1")" |
|
export CDON="$(colours:set "2")" |
|
export ULON="$(colours:set "4")" |
|
export RVON="$(colours:set "7")" |
|
export SKON="$(colours:set "9")" |
|
|
|
# Resets |
|
|
|
export CBNRM="$(colours:set "22")" |
|
export HLOFF="$(colours:set "49")" |
|
export ULOFF="$(colours:set "24")" |
|
export RVOFF="$(colours:set "27")" |
|
export SKOFF="$(colours:set "29")" |
|
|
|
export CDEF="$(colours:set "0")" |
|
|
|
} |
|
|
|
colours:auto() { |
|
if tty:is_pipe ; then |
|
COLOURS_ON=false |
|
else |
|
COLOURS_ON=true |
|
fi |
|
|
|
colours:define |
|
return 0 |
|
} |
|
|
|
colours:auto |
|
|
|
##bash-libs: out.sh @ 1d3814ad (2.1.13) |
|
|
|
### Console output handlers Usage:bbuild |
|
# |
|
# Write data to console stderr using colouring |
|
# |
|
###/doc |
|
|
|
### out:info MESSAGE Usage:bbuild |
|
# print a green informational message to stderr |
|
###/doc |
|
function out:info { |
|
echo "$CGRN$*$CDEF" 1>&2 |
|
} |
|
|
|
### out:warn MESSAGE Usage:bbuild |
|
# print a yellow warning message to stderr |
|
###/doc |
|
function out:warn { |
|
echo "${CBYEL}WARN: $CYEL$*$CDEF" 1>&2 |
|
} |
|
|
|
### out:defer MESSAGE Usage:bbuild |
|
# Store a message in the output buffer for later use |
|
###/doc |
|
function out:defer { |
|
OUTPUT_BUFFER_defer[${#OUTPUT_BUFFER_defer[@]}]="$*" |
|
} |
|
|
|
# Internal |
|
function out:buffer_initialize { |
|
OUTPUT_BUFFER_defer=(:) |
|
} |
|
out:buffer_initialize |
|
|
|
### out:flush HANDLER ... Usage:bbuild |
|
# |
|
# Pass the output buffer to the command defined by HANDLER |
|
# and empty the buffer |
|
# |
|
# Examples: |
|
# |
|
# out:flush echo -e |
|
# |
|
# out:flush out:warn |
|
# |
|
# (escaped newlines are added in the buffer, so `-e` option is |
|
# needed to process the escape sequences) |
|
# |
|
###/doc |
|
function out:flush { |
|
[[ -n "$*" ]] || out:fail "Did not provide a command for buffered output\n\n${OUTPUT_BUFFER_defer[*]}" |
|
|
|
[[ "${#OUTPUT_BUFFER_defer[@]}" -gt 1 ]] || return 0 |
|
|
|
for buffer_line in "${OUTPUT_BUFFER_defer[@]:1}"; do |
|
"$@" "$buffer_line" |
|
done |
|
|
|
out:buffer_initialize |
|
} |
|
|
|
### out:fail [CODE] MESSAGE Usage:bbuild |
|
# print a red failure message to stderr and exit with CODE |
|
# CODE must be a number |
|
# if no code is specified, error code 127 is used |
|
###/doc |
|
function out:fail { |
|
local ERCODE=127 |
|
local numpat='^[0-9]+$' |
|
|
|
if [[ "$1" =~ $numpat ]]; then |
|
ERCODE="$1"; shift || : |
|
fi |
|
|
|
echo "${CBRED}ERROR FAIL: $CRED$*$CDEF" 1>&2 |
|
exit $ERCODE |
|
} |
|
|
|
### out:error MESSAGE Usage:bbuild |
|
# print a red error message to stderr |
|
# |
|
# unlike out:fail, does not cause script exit |
|
###/doc |
|
function out:error { |
|
echo "${CBRED}ERROR: ${CRED}$*$CDEF" 1>&2 |
|
} |
|
##bash-libs: patterns.sh @ 1d3814ad (2.1.13) |
|
|
|
### Useful patterns Usage:bbuild |
|
# |
|
# Some useful regex patterns, exported as environment variables. |
|
# |
|
# They are not foolproof, and you are encouraged to improve upon them. |
|
# |
|
# $PAT_blank - detects whether an entire line is empty or whitespace |
|
# $PAT_comment - detects whether is a line is a script comment (assumes '#' as the comment marker) |
|
# $PAT_num - detects whether the string is an integer number in its entirety |
|
# $PAT_cvar - detects if the string is a valid C variable name |
|
# $PAT_filename - detects if the string is a safe UNIX or Windows file name; |
|
# does not allow presence of special characters aside from '_', '.', and '-' |
|
# $PAT_email - simple heuristic to determine whether a string looks like a valid email address |
|
# |
|
###/doc |
|
|
|
export PAT_blank='^\s*$' |
|
export PAT_comment='^\s*(#.*)?$' |
|
export PAT_num='^[0-9]+$' |
|
export PAT_cvar='^[a-zA-Z_][a-zA-Z0-9_]*$' |
|
export PAT_filename='^[a-zA-Z0-9_. -]+$' |
|
export PAT_email="[a-zA-Z0-9_.+-]+@[a-zA-Z0-9][a-zA-Z0-9.-]+\.[a-z]+" |
|
|
|
### Formatting library Usage:bbuild |
|
# |
|
# Some convenience functions for formatting output. |
|
# |
|
###/doc |
|
|
|
### format:columns [SEP] Usage:bbuild |
|
# |
|
# Redirect input or pipe into this function to print columns using separator |
|
# (default is tab character). |
|
# |
|
# Each line is split along the separator characters (each individual character is a |
|
# separator, and the column widths are adjusted to the widest member of all rows. |
|
# |
|
# e.g. |
|
# |
|
# format:columns ':' < /etc/passwd |
|
# |
|
# grep January report.tsv | format:column |
|
# |
|
###/doc |
|
|
|
format:columns() { |
|
. <(args:use:local ?sep -- "$@") ; |
|
[[ -n "$sep" ]] || sep=$'\t' |
|
|
|
column -t -s "$sep" |
|
} |
|
|
|
### format:wrap Usage:bbuild |
|
# |
|
# Pipe or redirect into this function to soft-wrap text along spaces to terminal |
|
# width, or specified width. |
|
# |
|
# e.g. |
|
# |
|
# format:wrap 40 < README.md |
|
# |
|
###/doc |
|
|
|
format:wrap() { |
|
. <(args:use:local ?cols -- "$@") ; |
|
[[ -n "$cols" ]] || cols="$(tput cols)" |
|
[[ "$cols" =~ $PAT_num ]] || return 1 |
|
fold -w "$cols" -s |
|
} |
|
|
|
##bash-libs: autohelp.sh @ 1d3814ad (2.1.13) |
|
|
|
### Autohelp Usage:bbuild |
|
# |
|
# Autohelp provides some simple facilities for defining help as comments in your code. |
|
# It provides several functions for printing specially formatted comment sections. |
|
# |
|
# Write your help as documentation comments in your script |
|
# |
|
# To output a named section from your script, or a file, call the |
|
# `autohelp:print` function and it will print the help documentation |
|
# in the current script, or specified file, to stdout |
|
# |
|
# A help comment looks like this: |
|
# |
|
# ### <title> Usage:help |
|
# # |
|
# # <some content> |
|
# # |
|
# # end with "###/doc" on its own line (whitespaces before |
|
# # and after are OK) |
|
# # |
|
# ###/doc |
|
# |
|
# It can then be printed from the same script by simply calling |
|
# |
|
# autohelp:print |
|
# |
|
# You can print a different section by specifying a different name |
|
# |
|
# autohelp:print section2 |
|
# |
|
# > This would print a section defined in this way: |
|
# |
|
# ### Some title Usage:section2 |
|
# # <some content> |
|
# ###/doc |
|
# |
|
# You can set a different comment character by setting the 'HELPCHAR' environment variable. |
|
# Typically, you might want to print comments you set in a INI config file, for example |
|
# |
|
# HELPCHAR=";" autohelp:print help config-file.ini |
|
# |
|
# Which would then find comments defined like this in `config-file.ini`: |
|
# |
|
# ;;; Main config Usage:help |
|
# ; Help comments in a config file |
|
# ; may start with a different comment character |
|
# ;;;/doc |
|
# |
|
# |
|
# |
|
# Example usage in a multi-function script: |
|
# |
|
# #!usr/bin/env bash |
|
# |
|
# ### Main help Usage:help |
|
# # The main help |
|
# ###/doc |
|
# |
|
# ### Feature One Usage:feature_1 |
|
# # Help text for the first feature |
|
# ###/doc |
|
# |
|
# feature1() { |
|
# autohelp:check:section feature_1 "$@" |
|
# echo "Feature I" |
|
# } |
|
# |
|
# ### Feature Two Usage:feature_2 |
|
# # Help text for the second feature |
|
# ###/doc |
|
# |
|
# feature2() { |
|
# autohelp:check:section feature_2 "$@" |
|
# echo "Feature II" |
|
# } |
|
# |
|
# main() { |
|
# case "$1" in |
|
# feature1|feature2) |
|
# "$1" "$@" # Pass the global script arguments through |
|
# ;; |
|
# *) |
|
# autohelp:check-no-null "$@" # Check if main help was asked for, if so, or if no args, exit with help |
|
# |
|
# # Main help not requested, return error |
|
# echo "Unknown feature" |
|
# exit 1 |
|
# ;; |
|
# esac |
|
# } |
|
# |
|
# main "$@" |
|
# |
|
###/doc |
|
|
|
### autohelp:print [ SECTION [FILE] ] Usage:bbuild |
|
# Print the specified section, in the specified file. |
|
# |
|
# If no file is specified, prints for current script file. |
|
# If no section is specified, defaults to "help" |
|
###/doc |
|
|
|
HELPCHAR='#' |
|
|
|
autohelp:print() { |
|
. <(args:use:local ?section_string ?target_file -- "$@") ; |
|
local input_line |
|
[[ -n "$section_string" ]] || section_string=help |
|
[[ -n "$target_file" ]] || target_file="$0" |
|
|
|
local sec_start='^\s*'"$HELPCHAR$HELPCHAR$HELPCHAR"'\s+(.+?)\s+Usage:'"$section_string"'\s*$' |
|
local sec_end='^\s*'"$HELPCHAR$HELPCHAR$HELPCHAR"'\s*/doc\s*$' |
|
local in_section=false |
|
|
|
while read input_line; do |
|
if [[ "$input_line" =~ $sec_start ]]; then |
|
in_section=true |
|
echo -e "\n${BASH_REMATCH[1]}\n=======" |
|
|
|
elif [[ "$in_section" = true ]]; then |
|
if [[ "$input_line" =~ $sec_end ]]; then |
|
in_section=false |
|
else |
|
echo "$input_line" | sed -r "s/^\s*$HELPCHAR/ /;s/^ (\S)/\1/" |
|
fi |
|
fi |
|
done < "$target_file" |
|
|
|
if [[ "$in_section" = true ]]; then |
|
out:fail "Non-terminated help block." |
|
fi |
|
} |
|
|
|
### autohelp:paged Usage:bbuild |
|
# |
|
# Display the help in the pager defined in the PAGER environment variable |
|
# |
|
###/doc |
|
autohelp:paged() { |
|
: ${PAGER=less} |
|
autohelp:print "$@" | $PAGER |
|
} |
|
|
|
### autohelp:check-or-null ARGS ... Usage:bbuild |
|
# Print help if arguments are empty, or if arguments contain a '--help' token |
|
# |
|
###/doc |
|
autohelp:check-or-null() { |
|
if [[ -z "$*" ]]; then |
|
autohelp:print help "$0" |
|
exit 0 |
|
else |
|
autohelp:check:section "help" "$@" |
|
fi |
|
} |
|
|
|
### autohelp:check-or-null:section SECTION ARGS ... Usage:bbuild |
|
# Print help section SECTION if arguments are empty, or if arguments contain a '--help' token |
|
# |
|
###/doc |
|
autohelp:check-or-null:section() { |
|
. <(args:use:local section -- "$@") ; |
|
if [[ -z "$*" ]]; then |
|
autohelp:print "$section" "$0" |
|
exit 0 |
|
else |
|
autohelp:check:section "$section" "$@" |
|
fi |
|
} |
|
|
|
### autohelp:check ARGS ... Usage:bbuild |
|
# |
|
# Automatically print "help" sections and exit, if "--help" is detected in arguments |
|
# |
|
###/doc |
|
autohelp:check() { |
|
autohelp:check:section "help" "$@" |
|
} |
|
|
|
### autohelp:check:section SECTION ARGS ... Usage:bbuild |
|
# Automatically print documentation for named section and exit, if "--help" is detected in arguments |
|
# |
|
###/doc |
|
autohelp:check:section() { |
|
local section arg |
|
section="${1:-}"; shift || out:fail "No help section specified" |
|
|
|
for arg in "$@"; do |
|
if [[ "$arg" =~ --help ]]; then |
|
autohelp:print "$section" | format:wrap |
|
exit 0 |
|
fi |
|
done |
|
} |
|
##bash-libs: bincheck.sh @ 1d3814ad (2.1.13) |
|
|
|
### bincheck:get COMMANDS ... Usage:bbuild |
|
# |
|
# Return the first existing binary |
|
# |
|
# Useful for finding an appropriate binary when you know |
|
# different systems may supply binaries under different names. |
|
# |
|
# Returns the full path from `which` for the first executable |
|
# encountered. |
|
# |
|
# Example: |
|
# |
|
# bincheck:get markdown_py markdown ./mymarkdown |
|
# |
|
# Tries in turn to get a `markdown_py`, then a `markdown`, and then a local `./mymarkdown` |
|
# |
|
###/doc |
|
|
|
bincheck:get() { |
|
local BINEXE= |
|
for binname in "$@"; do |
|
# Some implementations of `which` print error messages |
|
# Not useful here. |
|
BINEXE=$(which "$binname" 2>/dev/null) |
|
|
|
if [[ -n "$BINEXE" ]]; then |
|
echo "$BINEXE" |
|
return 0 |
|
fi |
|
done |
|
return 1 |
|
} |
|
|
|
### bincheck:has NAMES ... Usage:bbuild |
|
# |
|
# Determine if at least one of the binaries listed is present and installed on the system |
|
# |
|
###/doc |
|
|
|
bincheck:has() { |
|
[[ -n "$(bincheck:get "$@")" ]] |
|
} |
|
|
|
### bincheck:path NAME Usage:bbuild |
|
# |
|
# Determine the actual path to the command |
|
# |
|
# Relative paths are not expanded. |
|
# |
|
###/doc |
|
|
|
bincheck:path() { |
|
local binname="$1"; shift || : |
|
|
|
[[ "$binname" =~ / ]] && { |
|
# A relative path cannot be resolved, just check existence |
|
[[ -e "$binname" ]] && echo "$binname" || return 1 |
|
|
|
} || binname="$(which "$binname" 2>/dev/null)" |
|
|
|
# `which` failed |
|
[[ -n "$binname" ]] || return 1 |
|
|
|
[[ -h "$binname" ]] && { |
|
|
|
local pointedname="$(ls -l "$binname"|grep -oP "$binname.+"|sed "s|$binname -> ||")" |
|
bincheck:path "$pointedname" ; return "$?" |
|
|
|
} || echo "$binname" |
|
} |
|
|
|
##bash-libs: isroot.sh @ 1d3814ad (2.1.13) |
|
|
|
### isroot Usage:bbuild |
|
# Test for root access |
|
# |
|
# If using cygwin, user is always root. |
|
###/doc |
|
|
|
function isroot { |
|
[[ "$UID" = 0 ]] || isroot:cygwin |
|
} |
|
|
|
### isroot:cygwin Usage:bbuild |
|
# Returns whether running under cygwin. |
|
# |
|
# Typically a user under cygwin is root, except when they're not |
|
# |
|
# This utility exists as a reminder to check for cygwin. |
|
###/doc |
|
|
|
function isroot:cygwin { |
|
uname -o | grep -i cygwin -q |
|
} |
|
|
|
### isroot:require MESSAGE Usage:bbuild |
|
# Require root. If script is not running as root, |
|
# print message and exit |
|
###/doc |
|
function isroot:require { |
|
isroot || out:fail "$*" |
|
} |
|
|
|
agc:strip() { |
|
. <(args:use:local filename -- "$@") ; |
|
grep -vP '^\s*(#.*)?$' "$filename" |
|
} |
|
|
|
agc:install() { |
|
. <(args:use:local packagename -- "$@") ; |
|
local f_conf="$packagename.debconf" |
|
|
|
if [[ -f "$f_conf" ]]; then |
|
agc:strip "$f_conf" | debconf-set-selections |
|
apt-get install "$packagename" |
|
else |
|
apt-get install -y "$packagename" |
|
debconf-get-selections | grep "$packagename" > "$f_conf" |
|
out:defer "$f_conf" |
|
fi |
|
} |
|
|
|
agc:setup() { |
|
if ! bincheck:has debconf-get-selections ; then |
|
out:error "debconf-utils is needed." |
|
out:fail "Try: apt-get install -y debconf-utils" |
|
fi |
|
} |
|
|
|
agc:main() { |
|
autohelp:check-or-null "$@" |
|
|
|
isroot:require "You must be root to run this script." |
|
|
|
apt-get update |
|
agc:setup |
|
|
|
local arg |
|
for arg in "$@"; do |
|
agc:install "$@" |
|
done |
|
} |
|
|
|
trap onexit EXIT |
|
function onexit() { |
|
out:info "The following debconf files have been created:" |
|
out:flush out:info |
|
} |
|
|
|
agc:main "$@" |
