function print() {
local fmt=${1}; shift
- printf "${fmt}\n" "$@"
+ printf -- "${fmt}\n" "$@"
+}
+
+# The args() function takes a number of arguments like
+# var1="abc d" var2="abc" var3="abcd e"
+# and splits them into several arguments, devided by newline
+function args() {
+ echo "$@" | xargs printf "%s\n"
+}
+
+function unquote() {
+ local var="$@"
+
+ if [ "${var:0:1}" = "\"" ]; then
+ var=${var:1}
+ fi
+
+ local last=$(( ${#var} - 1 ))
+ if [ ${last} -ge 0 ] && [ "${var:${last}:1}" = "\"" ]; then
+ var=${var:0:${last}}
+ fi
+
+ print "${var}"
+}
+
+function quote() {
+ print "\"%s\"" "$@"
+}
+
+function strip() {
+ local value="$@"
+
+ # remove leading whitespace characters
+ value="${value#"${value%%[![:space:]]*}"}"
+
+ # remove trailing whitespace characters
+ value="${value%"${value##*[![:space:]]}"}"
+
+ print "${value}"
}
# Print a pretty error message
function error() {
- echo -e " ${COLOUR_ERROR}ERROR${COLOUR_NORMAL} : $@" >&2
+ echo -e " ${CLR_RED_B}ERROR${CLR_RESET} : $@" >&2
}
function error_log() {
# Print a pretty warn message
function warning() {
- echo -e " ${COLOUR_WARN}WARNING${COLOUR_NORMAL}: $@" >&2
+ echo -e " ${CLR_YELLOW_B}WARNING${CLR_RESET}: $@" >&2
}
function warning_log() {
log WARNING "$@"
}
+# The next three functions are kept for backwards
+# compatibility. The need to be dropped at some time.
function listsort() {
- local i
- for i in $@; do
- echo "${i}"
- done | sort | tr '\n' ' '
- echo
+ list_sort $@
}
function listmatch() {
- local match=${1}
- shift
-
- local i
- for i in $@; do
- [ "${match}" = "${i}" ] && return ${EXIT_OK}
- done
-
- return ${EXIT_ERROR}
+ list_match $@
}
function listlength() {
- local length=0
-
- local i
- for i in $@; do
- length=$(( ${length} + 1 ))
- done
-
- echo "${length}"
+ list_length $@
}
# Speedup function to avoid a call of the basename binary
echo "${1##*/}"
}
+function format() {
+ local key=${1}
+ assert isset key
+
+ local format=${2}
+ assert isset format
+
+ shift 2
+
+ printf -v "${key}" "${format}" "$@"
+}
+
+function assign() {
+ local key=${1}
+ assert isset key
+ shift
+
+ format "${key}" "%s" "$@"
+}
+
+function fread() {
+ local file=${1}
+ assert isset file
+
+ [ -r "${file}" ] || return ${EXIT_ERROR}
+
+ print "$(<${file})"
+}
+
+function fwrite() {
+ local file=${1}
+ assert isset file
+ shift
+
+ print "%s" "$@" >> ${file}
+}
+
function enabled() {
local param=${1}
- listmatch "${!param}" yes on true 1
+ list_match "${!param}" yes on true 1
}
function mac_generate() {
function mac_format() {
local mac=${1}
+ assert isset mac
- local output
+ # Remove all colons and make the rest lowercase.
+ mac=${mac//:/}
+ mac=${mac,,}
+ local output
if [ "${#mac}" = "12" ]; then
# Add colons (:) to mac address
output=${mac:0:2}
for i in 2 4 6 8 10; do
output="${output}:${mac:${i}:2}"
done
+ else
+ output=${mac}
fi
assert mac_is_valid ${output}
- echo "${output}"
+ print "${output}"
}
function mac_is_valid() {
[ -n "${!var}" ]
}
-# XXX Nearly same as listmatch
function isoneof() {
local var=${!1}
shift
- listmatch "${var}" "$@"
+ list_match "${var}" "$@"
}
function isbool() {
mac_is_valid ${mac}
}
+function isipaddress() {
+ local addr=${!1}
+
+ ip_is_valid ${addr}
+}
+
function backtrace() {
local start=1
echo # Empty line
error_log "Backtrace (most recent call in first line):"
- local i
+ local i source
for i in $(seq ${start} ${#BASH_SOURCE[*]}); do
[ -z "${FUNCNAME[${i}]}" ] && continue
[ "${FUNCNAME[${i}]}" == "main" ] && continue
- error_log " $(printf "%20s" "'${FUNCNAME[${i}]}'") called from ${BASH_SOURCE[$(( ${i} + 1 ))]}:${BASH_LINENO[${i}]}"
+ source=${BASH_SOURCE[$(( ${i} + 1 ))]}
+ error_log " $(printf "%20s" "'${FUNCNAME[${i}]}'") called from ${source:-<shell>}:${BASH_LINENO[${i}]}"
done
}
if ! ${assertion}; then
error_log "Assertion '${assertion}' failed."
backtrace
- exit ${EXIT_ERROR}
+ exit ${EXIT_ERROR_ASSERT}
fi
return ${EXIT_OK}
}
+# This function checks, if the given argument is an assert error
+# exit code. If this is the case, the script will halt immediately.
+function assert_check_retval() {
+ local ret=${1}
+
+ if [ ${ret} -eq ${EXIT_ERROR_ASSERT} ]; then
+ exit ${EXIT_ERROR_ASSERT}
+ fi
+
+ return ${ret}
+}
+
function exec_cmd() {
local cmd=$@
cmd $@ &>/dev/null
}
+function cmd_exec() {
+ local cmd=$@
+
+ log DEBUG "Exec'ing command: ${cmd}"
+
+ exec ${cmd}
+
+ log ERROR "Could not exec-ute: ${cmd}"
+ exit ${EXIT_ERROR}
+}
+
function seq() {
if [ $# -eq 2 ]; then
eval echo {${1}..${2}}
fi
}
+function which() {
+ type -P $@
+}
+
+# Prints the number of seconds since epoch.
+function timestamp() {
+ date -u "+%s"
+}
+
function beautify_time() {
local value=${1}
# Check, if the network service is running.
service_is_active network
}
+
+function contains_spaces() {
+ local var="$@"
+
+ # Eliminate spaces.
+ local var2=${var// /}
+
+ if [ ${#var} -ne ${#var2} ]; then
+ return ${EXIT_TRUE}
+ fi
+
+ return ${EXIT_FALSE}
+}