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
55 # Print a pretty error message
57 echo -e " ${CLR_RED_B}ERROR
${CLR_RESET} : $@
" >&2
60 function error_log() {
64 # Print a pretty warn message
66 echo -e " ${CLR_YELLOW_B}WARNING
${CLR_RESET}: $@
" >&2
69 function warning_log() {
73 # The next three functions are kept for backwards
74 # compatibility. The need to be dropped at some time.
79 function listmatch() {
83 function listlength() {
87 # Speedup function to avoid a call of the basename binary
101 printf -v "${key}" "${format}" "$@
"
109 format "${key}" "%s
" "$@
"
116 [ -r "${file}" ] || return ${EXIT_ERROR}
126 print "%s
" "$@
" >> ${file}
132 list_match "${!param}" yes on true 1
135 function mac_generate() {
136 # Get a bunch of random hex digits
137 # and remove all dashes from the input.
138 local random=$(</proc/sys/kernel/random/uuid)
145 for i in $(seq 0 5); do
147 random="${random:2:${#random}}"
151 # Remove multicast bit
152 # and set address is software assigned
156 printf -v output "%02x
" "${o}"
159 printf -v output "%s
:%02x
" "${output}" "${o}"
164 # Check if output is valid
165 assert mac_is_valid ${output}
170 function mac_format() {
174 # Remove all colons and make the rest lowercase.
179 if [ "${#mac}" = "12" ]; then
180 # Add colons (:) to mac address
183 for i in 2 4 6 8 10; do
184 output="${output}:${mac:${i}:2}"
190 assert mac_is_valid ${output}
195 function mac_is_valid() {
198 [[ ${mac} =~ ^([0-9a-f]{2}\:){5}[0-9a-f]{2}$ ]]
202 echo $(</proc/sys/kernel/random/uuid)
215 list_match "${var}" "$@
"
221 isoneof ${var} 0 1 no yes on off
224 function isinteger() {
227 [[ ${var} =~ ^[0-9]+$ ]]
236 function isipaddress() {
242 function backtrace() {
246 error_log "Backtrace
(most recent call
in first line
):"
249 for i in $(seq ${start} ${#BASH_SOURCE[*]}); do
250 [ -z "${FUNCNAME[${i}]}" ] && continue
251 [ "${FUNCNAME[${i}]}" == "main
" ] && continue
253 source=${BASH_SOURCE[$(( ${i} + 1 ))]}
254 error_log " $
(printf "%20s" "'${FUNCNAME[${i}]}'") called from ${source:-<shell>}:${BASH_LINENO[${i}]}"
261 if ! ${assertion}; then
262 error_log
"Assertion '${assertion}' failed."
264 exit ${EXIT_ERROR_ASSERT}
270 # This function checks, if the given argument is an assert error
271 # exit code. If this is the case, the script will halt immediately.
272 function assert_check_retval
() {
275 if [ ${ret} -eq ${EXIT_ERROR_ASSERT} ]; then
276 exit ${EXIT_ERROR_ASSERT}
282 function exec_cmd
() {
285 log DEBUG
"Running command: ${cmd}"
288 LOG_DISABLE_STDOUT
="${LOG_DISABLE_STDOUT}" \
289 LOG_FACILITY
="${LOG_FACILITY}" \
293 #log DEBUG "Returned with code '${ret}'"
295 if [ ${ret} -eq ${EXIT_ERROR_ASSERT} ]; then
296 error_log
"Stopping parent process due to assertion error in child process: ${cmd}"
297 exit ${EXIT_ERROR_ASSERT}
306 log DEBUG
"Running command: ${cmd}"
311 log DEBUG
"Returned with code '${ret}'"
316 function cmd_quiet
() {
320 function cmd_exec
() {
323 log DEBUG
"Exec'ing command: ${cmd}"
327 log ERROR
"Could not exec-ute: ${cmd}"
332 if [ $# -eq 2 ]; then
333 eval echo {${1}..
${2}}
334 elif [ $# -eq 3 ]; then
335 eval echo {${1}..${3}..${2}}
343 function beautify_time
() {
348 for unit
in s m h d w
; do
361 [ ${value} -lt ${limit} ] && break
363 value
=$
(( ${value} / ${limit} ))
366 echo "${value}${unit}"
369 function beautify_bytes
() {
374 for unit
in B k M G T
; do
375 [ ${value} -lt ${limit} ] && break
376 value
=$
(( ${value} / ${limit} ))
379 echo "${value}${unit}"
382 function module_load
() {
385 if ! grep -q "^${module}" /proc
/modules
; then
386 log DEBUG
"Loading module '${module}'."
391 function binary_exists
() {
394 if [ -n "$(type -p ${binary})" ]; then
401 function process_kill
() {
404 if ! isinteger process
; then
405 process
=$
(pidof
${process})
410 for pid
in ${process}; do
412 [ -d "/proc/${pid}" ] ||
break
423 if [ "${hex:0:2}" != "0x" ]; then
427 printf "%d\n" "${hex}"
430 function network_is_running
() {
431 # Check, if the network service is running.
432 service_is_active network
435 function contains_spaces
() {
439 local var2
=${var// /}
441 if [ ${#var} -ne ${#var2} ]; then