Annotation of /trunk/initscripts/sysvinit/rc/functions

#!/bin/bash
# $Id$

# Begin $rc_base/init.d/functions - Run Level Control Functions

# Based on functions script from LFS-3.1 and earlier.
# Rewritten by Gerard Beekmans  - gerard@linuxfromscratch.org

# With code based on Matthias Benkmann's simpleinit-msb @
# http://winterdrache.de/linux/newboot/index.html

umask 022

export PATH="/bin:/usr/bin:/sbin:/usr/sbin"

KILLDELAY=3

COLUMNS=$(stty size)
COLUMNS=${COLUMNS##* }
COL=$[ $COLUMNS - 10 ]
WCOL=$[ $COLUMNS - 30 ]
WWCOL=$[ $COLUMNS - 40 ]
SET_COL="echo -en \\033[${COL}G"
SET_WCOL="echo -en \\033[${WCOL}G"
SET_WWCOL="echo -en \\033[${WWCOL}G"
CURS_UP="echo -en \\033[A"

NORMAL="echo -en \\033[0;39m"
SUCCESS="echo -en \\033[1;32m"
WARNING="echo -en \\033[1;33m"
FAILURE="echo -en \\033[1;31m"

COLRED="\033[1;6m\033[31m"
COLGREEN="\033[1;6m\033[32m"
COLYELLOW="\033[1;6m\033[33m"
COLBLUE="\033[1;6m\033[34m"
COLMAGENTA="\033[1;6m\033[35m"
COLWHITE="\033[1;6m\033[37m"
COLDEFAULT="\033[0m"

COLOREDSTAR="${COLBLUE}(${COLGREEN}*${COLBLUE})${COLDEFAULT} "

# location to save the started services
svcdir="/var/lib/init.d"
svclib="/lib/rcscripts"
svcmount="no"
svcfstype="tmpfs"
svcsize=1024

rc_echo() { echo $@; }
rc_print() { rc_echo -e "${COLOREDSTAR}$@"; }

# dummy function; needed if splashutils are not installed
splash() { return 0; }

# source splash functions if exists
[ -f /etc/init.d/splash-functions ] && source /etc/init.d/splash-functions

print_error_msg()
{
	return 0
	echo
	$FAILURE
	echo -e "   An Error occurred."
	echo -e "   Script: ${COLWHITE}$i${COLRED}"
	echo -e "   Exitcode: ${COLWHITE}$error_value${COLRED}"
	echo
	$NORMAL
	echo
	echo "Press Enter to continue..."
	read
}

check_script_status()
{
	if [ ! -f $i ]
	then
		echo "$i is not a valid symlink"
		continue
	fi

	if [ ! -x $i ]
	then
		echo "$i is not executable, skipping"
		continue
	fi
}

update_svcstatus()
{
	#$1 script
	#$2 start/stop

	local SVCDIR_MOUNTED
	local SVCD_INITSCRIPT
	local x

	#do this only if proc is mounted
	[ ! -f /proc/mounts ] && return 0

	#check if svcdir is mounted
	SVCDIR_MOUNTED="$(cat /proc/mounts | grep ${svcdir} | cut -d ' ' -f2)"
	if [ "${SVCDIR_MOUNTED}" == "${svcdir}" ]
	then
		#check if statedir exists
		[ ! -d ${svcdir}/started ] && mkdir ${svcdir}/started

		#get real name of the initscript, not from the symlink
		if [ -L "$0" ]
		then
			x="$(readlink $0)"
			SVCD_INITSCRIPT="$(basename ${x})"
		else
			SVCD_INITSCRIPT="$(basename $0)"
		fi

		case $1 in
			start)
				#write to svcddir
				#write state
				echo ok > ${svcdir}/started/"${SVCD_INITSCRIPT}"
				;;
			stop)
				#echo "$(ls ${svcdir}/started)"
				if [ -f ${svcdir}/started/${SVCD_INITSCRIPT} ]
				then
					rm ${svcdir}/started/${SVCD_INITSCRIPT}
				fi
				;;
		esac
	fi
}

evaluate_retval()
{
	local error_value="$1"
	[[ -z ${error_value} ]] && error_value=$?

	if [[ ${error_value} = 0 ]]
	then
		print_status success
	else
		print_status failure

		if [[ ${SPLASH_VERBOSE_ON_ERRORS} = 1 ]]
		then
			splash "rc_verbose" "${runlevel}"
		fi
	fi

	return ${error_value}
}

print_status()
{
	if [ $# = 0 ]
	then
		echo "Usage: $0 {success|warning|failure}"
		return 1
	fi

	$CURS_UP

	case "$1" in
		success)
			$SET_COL
			echo -e -n $COLBLUE"[  "
			$SUCCESS
			echo -e -n "OK"
			echo -e $COLBLUE"  ]"
			$NORMAL
			;;
		warning)
			case "$2" in
				running)
					$SET_WCOL
					echo "Already running"
					$CURS_UP
					;;
				not_running)
					$SET_WCOL
					echo "Not running"
					$CURS_UP
					;;
			esac
			$SET_COL
			echo -e -n $COLBLUE"[ "
			$WARNING
			echo -e -n "ATTN"
			echo -e $COLBLUE" ]"
			$NORMAL
			;;
		failure)
			$SET_COL
			echo -e -n $COLBLUE"["
			$FAILURE
			echo -e -n "FAILED"
			echo -e $COLBLUE"]"
			$NORMAL
			;;
	esac
}

getpids()
{
	base=${1##*/}
	pidlist=$(pidof -o $$ -o $PPID -x $base)
}

loadproc()
{
	if [ $# = 0 ]
	then
		echo "Usage: loadproc {program}"
		exit 1
	fi

	getpids $1

	if [ -z "$pidlist" ]
	then
		"$@"
		evaluate_retval
	else
		$SET_WCOL
		print_status warning running
	fi
}

killproc()
{
	if [ $# = 0 ]
	then
		echo "Usage: killproc {program} [signal]"
		exit 1
	fi

	if [ -z "$2" ]; then
		signal=TERM
		fallback=KILL
	else
		signal=${2##-}
		signal=${signal##SIG}
		fallback=""
	fi

	getpids $1

	if [ -n "$pidlist" ]; then
		failure=0

		for pid in $pidlist
		do
			kill -$signal $pid 2>/dev/null

			for ((i=0; $i<5000; i=$i+1)); do :; done

			for ((i=0; $i<$KILLDELAY; i=$i+1)); do
				kill -0 $pid 2>/dev/null || break
				sleep 1
			done

			if [ -n "$fallback" ]; then kill -$fallback $pid 2>/dev/null; fi

			kill -0 $pid 2>/dev/null && failure=1
		done

		base=${1##*/}
		if [ $failure = 0 ]; then rm -f /var/run/$base.pid; fi

		(exit $failure)
		evaluate_retval
	else
		$SET_WCOL
		print_status warning not_running
	fi
}

reloadproc()
{
	if [ $# = 0 ]
	then
		echo "Usage: reloadproc {program} [signal]"
		exit 1
	fi

	if [ -z "$2" ]; then
		signal=HUP
	else
		signal=${2##-}
		signal=${signal##SIG}
	fi

	getpids $1

	if [ -n "$pidlist" ]
	then
		failure=0

		for pid in $pidlist
		do
			kill -$signal $pid || failure=1
		done

		(exit $failure)
		evaluate_retval
	else
		$SET_WCOL
		print_status warning not_running
	fi
}

statusproc()
{
	if [ $# = 0 ]
	then
		echo "Usage: statusproc {program}"
		exit 1
	fi

	base=${1##*/}
	getpids $base

	if [ -n "$pidlist" ]
	then
		echo "$base is running with Process ID(s) $pidlist"
	else
		if [ -s /var/run/$base.pid ]
		then
			echo "$1 is not running but /var/run/$base.pid exists"
			return 1
		else
			echo "$1 is not running"
	 	fi
	fi
}

progressbar()
{
	if [ $# != 1 ]
	then
		echo "Usage: progressbar {progress}"
		exit 1
	fi

	if [ -f /proc/splash ]
	then
		echo "show $(( 65534 * $1 / 100 ))" > /proc/splash
	fi
}

kernel_version()
{
	local KV="$(uname -r | cut -d- -f1)"
	echo "${KV}"
}

kernel_major_version()
{
	local KV
	KV="$(uname -r | cut -d. -f1-2)"
	echo "${KV}"
}

dolisting()
{
	local x=
	local y=
	local tmpstr=
	local mylist=
	local mypath="${*}"

	if [ "${mypath%/\*}" != "${mypath}" ]
	then
		mypath="${mypath%/\*}"
	fi

	for x in ${mypath}
	do
		[ ! -e "${x}" ] && continue

		if [ ! -d "${x}" ] && ( [ -L "${x}" -o -f "${x}" ] )
		then
			mylist="${mylist} $(ls "${x}" 2> /dev/null)"
		else
			[ "${x%/}" != "${x}" ] && x="${x%/}"

			cd "${x}"; tmpstr="$(ls)"

			for y in ${tmpstr}
			do
				mylist="${mylist} ${x}/${y}"
			done
		fi
	done

	echo "${mylist}"
}

# searches /proc/mounts for mounted fstypes (like ext3)
is_fstype_mounted()
{
	local filesys
	local i
	filesys=$1

	i="$(cat /proc/mounts | grep ${filesys} | cut -d ' ' -f3)"
	[[ ${i} != ${filesys} ]] && return 1

	return 0
}

# searches /proc/mounts for mounted fs names (like udev, proc)
is_fs_mounted()
{
	local filesys
	local i
	filesys=$1

	i="$(cat /proc/mounts | grep ${filesys} | cut -d ' ' -f1)"
	[[ ${i} != ${filesys} ]] && return 1

	return 0
}

# checks if kernel supports fs xy
kernel_supports_fs()
{
	local filesys
	local i
	filesys=$1

	i="$(cat /proc/filesystems | grep ${filesys} | cut -d $'\t' -f2)"
	[[ ${i} != ${filesys} ]] && return 1

	return 0
}

# bool is_older_than(reference, files/dirs to check)
#
#   return 0 if any of the files/dirs are newer than
#   the reference file
#
#   EXAMPLE: if is_older_than a.out *.o ; then ...
is_older_than()
{
	local x=
	local ref="$1"
	shift

	for x in "$@"
	do
		[[ ${x} -nt ${ref} ]] && return 0

		if [[ -d ${x} ]]
		then
			is_older_than "${ref}" "${x}"/* && return 0
		fi
	done

	return 1
}

start_devicemanager() { touch /dev/.none; return 0; }
stop_devicemanager() { return 0; }
1	niro	2	#!/bin/bash
2	niro	931	# $Id$
3	niro	71
4	niro	2	# Begin $rc_base/init.d/functions - Run Level Control Functions
5
6			# Based on functions script from LFS-3.1 and earlier.
7			# Rewritten by Gerard Beekmans - gerard@linuxfromscratch.org
8
9			# With code based on Matthias Benkmann's simpleinit-msb @
10			# http://winterdrache.de/linux/newboot/index.html
11
12			umask 022
13
14			export PATH="/bin:/usr/bin:/sbin:/usr/sbin"
15
16			KILLDELAY=3
17
18			COLUMNS=$(stty size)
19			COLUMNS=${COLUMNS##* }
20			COL=$[ $COLUMNS - 10 ]
21			WCOL=$[ $COLUMNS - 30 ]
22			WWCOL=$[ $COLUMNS - 40 ]
23			SET_COL="echo -en \\033[${COL}G"
24			SET_WCOL="echo -en \\033[${WCOL}G"
25			SET_WWCOL="echo -en \\033[${WWCOL}G"
26			CURS_UP="echo -en \\033[A"
27
28			NORMAL="echo -en \\033[0;39m"
29			SUCCESS="echo -en \\033[1;32m"
30			WARNING="echo -en \\033[1;33m"
31			FAILURE="echo -en \\033[1;31m"
32
33			COLRED="\033[1;6m\033[31m"
34			COLGREEN="\033[1;6m\033[32m"
35			COLYELLOW="\033[1;6m\033[33m"
36			COLBLUE="\033[1;6m\033[34m"
37			COLMAGENTA="\033[1;6m\033[35m"
38			COLWHITE="\033[1;6m\033[37m"
39			COLDEFAULT="\033[0m"
40
41			COLOREDSTAR="${COLBLUE}(${COLGREEN}*${COLBLUE})${COLDEFAULT} "
42
43	niro	1093	# location to save the started services
44	niro	2	svcdir="/var/lib/init.d"
45			svclib="/lib/rcscripts"
46			svcmount="no"
47			svcfstype="tmpfs"
48			svcsize=1024
49
50	niro	1241	rc_echo() { echo $@; }
51			rc_print() { rc_echo -e "${COLOREDSTAR}$@"; }
52	niro	2
53			# dummy function; needed if splashutils are not installed
54	niro	1093	splash() { return 0; }
55	niro	2
56	niro	1093	# source splash functions if exists
57	niro	2	[ -f /etc/init.d/splash-functions ] && source /etc/init.d/splash-functions
58
59			print_error_msg()
60			{
61			return 0
62			echo
63			$FAILURE
64			echo -e " An Error occurred."
65			echo -e " Script: ${COLWHITE}$i${COLRED}"
66			echo -e " Exitcode: ${COLWHITE}$error_value${COLRED}"
67			echo
68			$NORMAL
69			echo
70			echo "Press Enter to continue..."
71			read
72			}
73
74			check_script_status()
75			{
76			if [ ! -f $i ]
77			then
78			echo "$i is not a valid symlink"
79			continue
80			fi
81
82			if [ ! -x $i ]
83			then
84			echo "$i is not executable, skipping"
85			continue
86			fi
87			}
88
89			update_svcstatus()
90			{
91			#$1 script
92			#$2 start/stop
93
94			local SVCDIR_MOUNTED
95			local SVCD_INITSCRIPT
96			local x
97
98			#do this only if proc is mounted
99			[ ! -f /proc/mounts ] && return 0
100
101			#check if svcdir is mounted
102			SVCDIR_MOUNTED="$(cat /proc/mounts \| grep ${svcdir} \| cut -d ' ' -f2)"
103			if [ "${SVCDIR_MOUNTED}" == "${svcdir}" ]
104			then
105			#check if statedir exists
106			[ ! -d ${svcdir}/started ] && mkdir ${svcdir}/started
107	niro	71
108	niro	2	#get real name of the initscript, not from the symlink
109			if [ -L "$0" ]
110			then
111			x="$(readlink $0)"
112			SVCD_INITSCRIPT="$(basename ${x})"
113			else
114			SVCD_INITSCRIPT="$(basename $0)"
115			fi
116
117			case $1 in
118			start)
119			#write to svcddir
120			#write state
121			echo ok > ${svcdir}/started/"${SVCD_INITSCRIPT}"
122			;;
123			stop)
124			#echo "$(ls ${svcdir}/started)"
125			if [ -f ${svcdir}/started/${SVCD_INITSCRIPT} ]
126			then
127			rm ${svcdir}/started/${SVCD_INITSCRIPT}
128			fi
129			;;
130			esac
131			fi
132			}
133
134			evaluate_retval()
135			{
136	niro	505	local error_value="$1"
137			[[ -z ${error_value} ]] && error_value=$?
138	niro	2
139	niro	505	if [[ ${error_value} = 0 ]]
140	niro	2	then
141			print_status success
142			else
143			print_status failure
144	niro	1242
145			if [[ ${SPLASH_VERBOSE_ON_ERRORS} = 1 ]]
146			then
147			splash "rc_verbose" "${runlevel}"
148			fi
149	niro	2	fi
150
151	niro	505	return ${error_value}
152	niro	2	}
153
154			print_status()
155			{
156			if [ $# = 0 ]
157			then
158			echo "Usage: $0 {success\|warning\|failure}"
159			return 1
160			fi
161
162			$CURS_UP
163
164			case "$1" in
165			success)
166			$SET_COL
167			echo -e -n $COLBLUE"[ "
168			$SUCCESS
169			echo -e -n "OK"
170			echo -e $COLBLUE" ]"
171			$NORMAL
172			;;
173			warning)
174			case "$2" in
175			running)
176			$SET_WCOL
177			echo "Already running"
178			$CURS_UP
179			;;
180			not_running)
181			$SET_WCOL
182			echo "Not running"
183			$CURS_UP
184			;;
185			esac
186			$SET_COL
187			echo -e -n $COLBLUE"[ "
188			$WARNING
189			echo -e -n "ATTN"
190			echo -e $COLBLUE" ]"
191			$NORMAL
192			;;
193			failure)
194			$SET_COL
195			echo -e -n $COLBLUE"["
196			$FAILURE
197			echo -e -n "FAILED"
198			echo -e $COLBLUE"]"
199			$NORMAL
200			;;
201			esac
202			}
203
204			getpids()
205			{
206			base=${1##*/}
207			pidlist=$(pidof -o $$ -o $PPID -x $base)
208			}
209
210			loadproc()
211			{
212			if [ $# = 0 ]
213			then
214			echo "Usage: loadproc {program}"
215			exit 1
216			fi
217
218			getpids $1
219
220			if [ -z "$pidlist" ]
221			then
222			"$@"
223			evaluate_retval
224			else
225			$SET_WCOL
226			print_status warning running
227			fi
228			}
229
230			killproc()
231			{
232			if [ $# = 0 ]
233			then
234			echo "Usage: killproc {program} [signal]"
235			exit 1
236			fi
237
238			if [ -z "$2" ]; then
239			signal=TERM
240			fallback=KILL
241			else
242			signal=${2##-}
243			signal=${signal##SIG}
244			fallback=""
245			fi
246
247			getpids $1
248
249			if [ -n "$pidlist" ]; then
250			failure=0
251
252			for pid in $pidlist
253			do
254			kill -$signal $pid 2>/dev/null
255
256			for ((i=0; $i<5000; i=$i+1)); do :; done
257
258			for ((i=0; $i<$KILLDELAY; i=$i+1)); do
259			kill -0 $pid 2>/dev/null \|\| break
260			sleep 1
261			done
262
263			if [ -n "$fallback" ]; then kill -$fallback $pid 2>/dev/null; fi
264
265			kill -0 $pid 2>/dev/null && failure=1
266			done
267
268			base=${1##*/}
269			if [ $failure = 0 ]; then rm -f /var/run/$base.pid; fi
270
271			(exit $failure)
272			evaluate_retval
273			else
274			$SET_WCOL
275			print_status warning not_running
276			fi
277			}
278
279			reloadproc()
280			{
281			if [ $# = 0 ]
282			then
283			echo "Usage: reloadproc {program} [signal]"
284			exit 1
285			fi
286
287			if [ -z "$2" ]; then
288			signal=HUP
289			else
290			signal=${2##-}
291			signal=${signal##SIG}
292			fi
293
294			getpids $1
295
296			if [ -n "$pidlist" ]
297			then
298			failure=0
299
300			for pid in $pidlist
301			do
302			kill -$signal $pid \|\| failure=1
303			done
304
305			(exit $failure)
306			evaluate_retval
307			else
308			$SET_WCOL
309			print_status warning not_running
310			fi
311			}
312
313			statusproc()
314			{
315			if [ $# = 0 ]
316			then
317			echo "Usage: statusproc {program}"
318			exit 1
319			fi
320
321			base=${1##*/}
322			getpids $base
323
324			if [ -n "$pidlist" ]
325			then
326			echo "$base is running with Process ID(s) $pidlist"
327			else
328			if [ -s /var/run/$base.pid ]
329			then
330			echo "$1 is not running but /var/run/$base.pid exists"
331			return 1
332			else
333			echo "$1 is not running"
334			fi
335			fi
336			}
337
338			progressbar()
339			{
340			if [ $# != 1 ]
341			then
342			echo "Usage: progressbar {progress}"
343			exit 1
344			fi
345
346			if [ -f /proc/splash ]
347			then
348			echo "show $(( 65534 * $1 / 100 ))" > /proc/splash
349			fi
350			}
351
352	niro	317	kernel_version()
353			{
354			local KV="$(uname -r \| cut -d- -f1)"
355			echo "${KV}"
356			}
357
358	niro	2	kernel_major_version()
359			{
360			local KV
361	niro	317	KV="$(uname -r \| cut -d. -f1-2)"
362	niro	2	echo "${KV}"
363			}
364
365	niro	317	dolisting()
366	niro	2	{
367			local x=
368			local y=
369			local tmpstr=
370			local mylist=
371			local mypath="${*}"
372
373			if [ "${mypath%/\*}" != "${mypath}" ]
374			then
375			mypath="${mypath%/\*}"
376			fi
377
378			for x in ${mypath}
379			do
380			[ ! -e "${x}" ] && continue
381
382			if [ ! -d "${x}" ] && ( [ -L "${x}" -o -f "${x}" ] )
383			then
384			mylist="${mylist} $(ls "${x}" 2> /dev/null)"
385			else
386			[ "${x%/}" != "${x}" ] && x="${x%/}"
387
388			cd "${x}"; tmpstr="$(ls)"
389
390			for y in ${tmpstr}
391			do
392			mylist="${mylist} ${x}/${y}"
393			done
394			fi
395			done
396
397			echo "${mylist}"
398			}
399	niro	147
400			# searches /proc/mounts for mounted fstypes (like ext3)
401	niro	1093	is_fstype_mounted()
402			{
403	niro	147	local filesys
404			local i
405			filesys=$1
406
407			i="$(cat /proc/mounts \| grep ${filesys} \| cut -d ' ' -f3)"
408			[[ ${i} != ${filesys} ]] && return 1
409
410			return 0
411			}
412
413			# searches /proc/mounts for mounted fs names (like udev, proc)
414	niro	1093	is_fs_mounted()
415			{
416	niro	147	local filesys
417			local i
418			filesys=$1
419
420			i="$(cat /proc/mounts \| grep ${filesys} \| cut -d ' ' -f1)"
421			[[ ${i} != ${filesys} ]] && return 1
422
423			return 0
424			}
425
426			# checks if kernel supports fs xy
427	niro	1093	kernel_supports_fs()
428			{
429	niro	147	local filesys
430			local i
431			filesys=$1
432
433			i="$(cat /proc/filesystems \| grep ${filesys} \| cut -d $'\t' -f2)"
434			[[ ${i} != ${filesys} ]] && return 1
435
436			return 0
437			}
438	niro	274
439			# bool is_older_than(reference, files/dirs to check)
440			#
441			# return 0 if any of the files/dirs are newer than
442			# the reference file
443			#
444			# EXAMPLE: if is_older_than a.out *.o ; then ...
445	niro	1093	is_older_than()
446			{
447	niro	274	local x=
448			local ref="$1"
449			shift
450
451			for x in "$@"
452			do
453			[[ ${x} -nt ${ref} ]] && return 0
454
455			if [[ -d ${x} ]]
456			then
457			is_older_than "${ref}" "${x}"/* && return 0
458			fi
459			done
460
461			return 1
462			}
463	niro	1094
464	niro	1104	start_devicemanager() { touch /dev/.none; return 0; }
465	niro	1094	stop_devicemanager() { return 0; }