2 ###############################################################################
4 # IPFire.org - A linux based firewall #
5 # Copyright (C) 2010 Michael Tremer & Christian Schmidt #
7 # This program is free software: you can redistribute it and/or modify #
8 # it under the terms of the GNU General Public License as published by #
9 # the Free Software Foundation, either version 3 of the License, or #
10 # (at your option) any later version. #
12 # This program is distributed in the hope that it will be useful, #
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of #
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the #
15 # GNU General Public License for more details. #
17 # You should have received a copy of the GNU General Public License #
18 # along with this program. If not, see <http://www.gnu.org/licenses/>. #
20 ###############################################################################
22 # A simple print statement
26 printf -- "${fmt}\n" "$@"
29 # The args() function takes a number of arguments like
30 # var1="abc d" var2="abc" var3="abcd e"
31 # and splits them into several arguments, devided by newline
33 echo "$@" |
xargs printf "%s\n"
39 if [ "${var:0:1}" = "\"" ]; then
43 local last
=$
(( ${#var} - 1 ))
44 if [ ${last} -ge 0 ] && [ "${var:${last}:1}" = "\"" ]; then
58 # remove leading whitespace characters
59 value="${value#"${value%%[![:space:]]*}"}"
61 # remove trailing whitespace characters
62 value="${value%"${value##*[![:space:]]}"}"
67 # Print a pretty error message
69 echo -e " ${CLR_RED_B}ERROR
${CLR_RESET} : $@
" >&2
72 function error_log() {
76 # Print a pretty warn message
78 echo -e " ${CLR_YELLOW_B}WARNING
${CLR_RESET}: $@
" >&2
81 function warning_log() {
85 # The next three functions are kept for backwards
86 # compatibility. The need to be dropped at some time.
91 function listmatch() {
95 function listlength() {
99 # Speedup function to avoid a call of the basename binary
100 function basename() {
113 printf -v "${key}" "${format}" "$@
"
121 format "${key}" "%s
" "$@
"
128 [ -r "${file}" ] || return ${EXIT_ERROR}
138 print "%s
" "$@
" >> ${file}
144 list_match "${!param}" yes on true 1
147 function mac_generate() {
148 # Get a bunch of random hex digits
149 # and remove all dashes from the input.
150 local random=$(</proc/sys/kernel/random/uuid)
157 for i in $(seq 0 5); do
159 random="${random:2:${#random}}"
163 # Remove multicast bit
164 # and set address is software assigned
168 printf -v output "%02x
" "${o}"
171 printf -v output "%s
:%02x
" "${output}" "${o}"
176 # Check if output is valid
177 assert mac_is_valid ${output}
182 function mac_format() {
186 # Remove all colons and make the rest lowercase.
191 if [ "${#mac}" = "12" ]; then
192 # Add colons (:) to mac address
195 for i in 2 4 6 8 10; do
196 output="${output}:${mac:${i}:2}"
202 assert mac_is_valid ${output}
207 function mac_is_valid() {
210 [[ ${mac} =~ ^([0-9a-f]{2}\:){5}[0-9a-f]{2}$ ]]
214 echo $(</proc/sys/kernel/random/uuid)
227 list_match "${var}" "$@
"
233 isoneof ${var} 0 1 no yes on off
236 function isinteger() {
239 [[ ${var} =~ ^[0-9]+$ ]]
248 function isipaddress() {
254 function backtrace() {
258 error_log "Backtrace
(most recent call
in first line
):"
261 for i in $(seq ${start} ${#BASH_SOURCE[*]}); do
262 [ -z "${FUNCNAME[${i}]}" ] && continue
263 [ "${FUNCNAME[${i}]}" == "main
" ] && continue
265 source=${BASH_SOURCE[$(( ${i} + 1 ))]}
266 error_log " $
(printf "%20s" "'${FUNCNAME[${i}]}'") called from ${source:-<shell>}:${BASH_LINENO[${i}]}"
273 if ! ${assertion}; then
274 error_log
"Assertion '${assertion}' failed."
276 exit ${EXIT_ERROR_ASSERT}
282 # This function checks, if the given argument is an assert error
283 # exit code. If this is the case, the script will halt immediately.
284 function assert_check_retval
() {
287 if [ ${ret} -eq ${EXIT_ERROR_ASSERT} ]; then
288 exit ${EXIT_ERROR_ASSERT}
294 function exec_cmd
() {
297 log DEBUG
"Running command: ${cmd}"
300 LOG_DISABLE_STDOUT
="${LOG_DISABLE_STDOUT}" \
301 LOG_FACILITY
="${LOG_FACILITY}" \
305 #log DEBUG "Returned with code '${ret}'"
307 if [ ${ret} -eq ${EXIT_ERROR_ASSERT} ]; then
308 error_log
"Stopping parent process due to assertion error in child process: ${cmd}"
309 exit ${EXIT_ERROR_ASSERT}
318 log DEBUG
"Running command: ${cmd}"
323 log DEBUG
"Returned with code '${ret}'"
328 function cmd_quiet
() {
332 function cmd_exec
() {
335 log DEBUG
"Exec'ing command: ${cmd}"
339 log ERROR
"Could not exec-ute: ${cmd}"
344 if [ $# -eq 2 ]; then
345 eval echo {${1}..
${2}}
346 elif [ $# -eq 3 ]; then
347 eval echo {${1}..${3}..${2}}
355 # Prints the number of seconds since epoch.
356 function timestamp
() {
360 function beautify_time
() {
365 for unit
in s m h d w
; do
378 [ ${value} -lt ${limit} ] && break
380 value
=$
(( ${value} / ${limit} ))
383 echo "${value}${unit}"
386 function beautify_bytes
() {
391 for unit
in B k M G T
; do
392 [ ${value} -lt ${limit} ] && break
393 value
=$
(( ${value} / ${limit} ))
396 echo "${value}${unit}"
399 function module_load
() {
402 if ! grep -q "^${module}" /proc
/modules
; then
403 log DEBUG
"Loading module '${module}'."
408 function binary_exists
() {
411 if [ -n "$(type -p ${binary})" ]; then
418 function process_kill
() {
421 if ! isinteger process
; then
422 process
=$
(pidof
${process})
427 for pid
in ${process}; do
429 [ -d "/proc/${pid}" ] ||
break
440 if [ "${hex:0:2}" != "0x" ]; then
444 printf "%d\n" "${hex}"
447 function network_is_running
() {
448 # Check, if the network service is running.
449 service_is_active network
452 function contains_spaces
() {
456 local var2
=${var// /}
458 if [ ${#var} -ne ${#var2} ]; then