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
264 # Print called binary with arguments.
265 if [ "${FUNCNAME[${i}]}" == "main
" ]; then
266 local args="$
(list_reverse
${BASH_ARGV[*]})"
267 printf -v source "%20s
" "$0"
268 error_log " ${source} ${args}"
272 source=${BASH_SOURCE[$(( ${i} + 1 ))]}
273 error_log " $
(printf "%20s" "'${FUNCNAME[${i}]}'") called from ${source:-<shell>}:${BASH_LINENO[${i}]}"
280 if ! ${assertion}; then
281 error_log
"Assertion '${assertion}' failed."
283 exit ${EXIT_ERROR_ASSERT}
289 # This function checks, if the given argument is an assert error
290 # exit code. If this is the case, the script will halt immediately.
291 function assert_check_retval
() {
294 if [ ${ret} -eq ${EXIT_ERROR_ASSERT} ]; then
295 exit ${EXIT_ERROR_ASSERT}
301 function exec_cmd
() {
304 log DEBUG
"Running command: ${cmd}"
307 LOG_DISABLE_STDOUT
="${LOG_DISABLE_STDOUT}" \
308 LOG_FACILITY
="${LOG_FACILITY}" \
312 #log DEBUG "Returned with code '${ret}'"
314 if [ ${ret} -eq ${EXIT_ERROR_ASSERT} ]; then
315 error_log
"Stopping parent process due to assertion error in child process: ${cmd}"
316 exit ${EXIT_ERROR_ASSERT}
325 log DEBUG
"Running command: ${cmd}"
330 log DEBUG
"Returned with code '${ret}'"
335 function cmd_quiet
() {
339 function cmd_exec
() {
342 log DEBUG
"Exec'ing command: ${cmd}"
346 log ERROR
"Could not exec-ute: ${cmd}"
350 function cmd_not_implemented
() {
351 assert false
"not implemented"
355 if [ $# -eq 2 ]; then
356 eval echo {${1}..
${2}}
357 elif [ $# -eq 3 ]; then
358 eval echo {${1}..${3}..${2}}
366 # Prints the number of seconds since epoch.
367 function timestamp
() {
371 function beautify_time
() {
376 for unit
in s m h d w
; do
389 [ ${value} -lt ${limit} ] && break
391 value
=$
(( ${value} / ${limit} ))
394 echo "${value}${unit}"
397 function beautify_bytes
() {
402 for unit
in B k M G T
; do
403 [ ${value} -lt ${limit} ] && break
404 value
=$
(( ${value} / ${limit} ))
407 echo "${value}${unit}"
410 function module_load
() {
413 if ! grep -q "^${module}" /proc
/modules
; then
414 log DEBUG
"Loading module '${module}'."
419 function binary_exists
() {
422 if [ -n "$(type -p ${binary})" ]; then
429 function process_kill
() {
432 if ! isinteger process
; then
433 process
=$
(pidof
${process})
438 for pid
in ${process}; do
440 [ -d "/proc/${pid}" ] ||
break
451 if [ "${hex:0:2}" != "0x" ]; then
455 printf "%d\n" "${hex}"
461 [ ${char} -lt 256 ] ||
return ${EXIT_ERROR}
463 printf "\\$(( ${char} / 64 * 100 + ${char} % 64 / 8 * 10 + ${char} % 8 ))\n"
467 LC_CTYPE
="C" printf "%d\n" "'${1}"
474 function network_is_running
() {
475 # Check, if the network service is running.
476 service_is_active network
479 function contains_spaces
() {
483 local var2
=${var// /}
485 if [ ${#var} -ne ${#var2} ]; then
492 function string_split
() {
496 while [ ${pos} -lt ${#string} ]; do
497 print
"${string:${pos}:1}"
498 pos
=$
(( ${pos} + 1 ))
504 function string_reverse
() {
509 while [ ${pos} -lt ${#string} ]; do
510 output
="${string:${pos}:1}${output}"
511 pos
=$
(( ${pos} + 1 ))
524 for i
in 7 6 5 4 3 2 1; do
527 if [ $
(( ${number} / ${div} )) -eq 1 ]; then
532 number
="$(( ${number} % ${div} ))"
535 if [ $
(( ${number} % 2 )) -eq 1 ]; then
549 while [ ${pos} -lt ${#string} ]; do
550 char
="${string:${pos}:1}"
551 pos
=$
(( ${pos} + 1 ))
553 number
=$
(( ${number} << 1 ))
558 number
=$
(( ${number} + 1 ))
561 assert false
"Invalid character: ${char}"
570 function char2bin
() {
571 local dec
="$(ord "${1}")"
576 function bin2char
() {
577 local dec
="$(bin2dec "$@
")"
583 local dec
="$(bin2dec "$@
")"
589 local dec
="$(hex2dec "$@
")"
597 # Prepend 0x if necessary.
598 [ "${hex:0:2}" = "0x" ] || hex
="0x${hex}"
600 printf "%d\n" "${hex}"
604 printf "%02x\n" "${1}"