# #
###############################################################################
+# A simple print statement
+function print() {
+ local fmt=${1}; shift
+
+ 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
-
- assert isset match
-
- 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 $@
}
-function config_read() {
- local config_file=${1}
-
- log DEBUG "Reading configuration: ${config_file}"
-
- if [ -e "${config_file}" ]; then
- . ${config_file}
- config_check
- fi
+# Speedup function to avoid a call of the basename binary
+function basename() {
+ echo "${1##*/}"
}
-function config_write() {
- local config_file=${1}
- shift
-
- # Check if all values to be written are sane
- config_check
+function format() {
+ local key=${1}
+ assert isset key
- log DEBUG "Writing configuration file ${config_file}."
+ local format=${2}
+ assert isset format
- > ${config_file}
+ shift 2
- local param
- for param in $(listsort $@); do
- echo "${param}=\"${!param}\"" >> ${config_file}
- done
+ printf -v "${key}" "${format}" "$@"
}
-function config_print() {
- local param
+function assign() {
+ local key=${1}
+ assert isset key
+ shift
- for param in $(listsort $@); do
- printf "%-16s = %s\n" "${param}" "${!param}"
- done
+ format "${key}" "%s" "$@"
}
-function config_check() {
- # If there is a function defined that is called __check
- # we call that function
- [ -n "$(type -t _check)" ] && _check
-}
+function fread() {
+ local file=${1}
+ assert isset file
-function config_hostname() {
- local hostname=${1}
+ [ -r "${file}" ] || return ${EXIT_ERROR}
- if [ -n "${hostname}" ]; then
- echo "${hostname}" > ${CONFIG_HOSTNAME}
- else
- echo "$(<${CONFIG_HOSTNAME})"
- fi
+ print "$(<${file})"
}
-function network_config_set() {
- while [ $# -gt 0 ]; do
- case "${1}" in
- *=*)
- log INFO "Setting configuration option '${1}'".
- eval ${1}
- ;;
- *)
- warning "Invalid parameter given: ${1}"
- ;;
- esac
- shift
- done
-
- # Write configuration to disk
- network_config_write
-}
-
-function network_config_read() {
- # Save state of DEBUG and restore it later.
- local debug=${DEBUG}
-
- config_read ${CONFIG_FILE}
-
- if [ -n "${debug}" ]; then
- DEBUG=${debug}
- fi
-}
-
-function network_config_write() {
- config_write ${CONFIG_FILE} ${CONFIG_FILE_PARAMS}
-}
-
-function network_config_print() {
- config_print ${CONFIG_FILE_PARAMS}
-}
+function fwrite() {
+ local file=${1}
+ assert isset file
+ shift
-# Speedup function to avoid a call of the basename binary
-function basename() {
- echo "${1##*/}"
+ print "%s" "$@" >> ${file}
}
function enabled() {
local param=${1}
- [ "${!param}" = "yes" ] || [ "${!param}" = "on" ] || [ "${!param}" = "1" ]
+ list_match "${!param}" yes on true 1
}
function mac_generate() {
- local mac=()
+ # Get a bunch of random hex digits
+ # and remove all dashes from the input.
+ local random=$(</proc/sys/kernel/random/uuid)
+ random=${random//-/}
+ assert isset random
+
+ local output
+
+ local i o
for i in $(seq 0 5); do
- mac[i]="$(uuid)"
- mac[i]="0x${mac[i]:0:2}"
- done
+ o="0x${random:0:2}"
+ random="${random:2:${#random}}"
- # Remove multicast bit
- # and set address is software assigned
- # XXX must doublecheck if this works
- mac[0]=$((mac[0] & 0xfe))
- mac[0]=$((mac[0] | 0x02))
+ case "${i}" in
+ 0)
+ # Remove multicast bit
+ # and set address is software assigned
+ o=$(( ${o} & 0xfe ))
+ o=$(( ${o} | 0x02 ))
- local output
- for i in ${mac[*]}; do
- if [ -n "${output}" ]; then
- output="${output}:"
- fi
-
- output="${output}$(printf "%02x" ${i})"
+ printf -v output "%02x" "${o}"
+ ;;
+ *)
+ printf -v output "%s:%02x" "${output}" "${o}"
+ ;;
+ esac
done
# Check if output is valid
assert mac_is_valid ${output}
- echo ${output}
+ echo "${output}"
}
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
- for i in $@; do
- [ "${var}" = "${i}" ] && return ${EXIT_OK}
- done
-
- return ${EXIT_ERROR}
+ 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=$@
return ${ret}
}
-function uppercase() {
- local input
- read input
- echo "${input^^}"
+function cmd_quiet() {
+ 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 lowercase() {
- local input
- read input
- echo "${input,,}"
+function cmd_not_implemented() {
+ assert false "not implemented"
}
function seq() {
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}
+}
projects / people / stevee / network.git / blobdiff