etc/grml/lsb-functions

   1 # lsb init-functions
   2 # vim:ft=sh:tw=80
   3 # /lib/lsb/init-functions for Debian -*- shell-script -*-
   4 #
   5 # Copyright (c) 2002-03 Chris Lawrence
   6 # All rights reserved.
   7 #
   8 # Redistribution and use in source and binary forms, with or without
   9 # modification, are permitted provided that the following conditions
  10 # are met:
  11 # 1. Redistributions of source code must retain the above copyright
  12 #    notice, this list of conditions and the following disclaimer.
  13 # 2. Redistributions in binary form must reproduce the above copyright
  14 #    notice, this list of conditions and the following disclaimer in the
  15 #    documentation and/or other materials provided with the distribution.
  16 # 3. Neither the name of the author nor the names of other contributors
  17 #    may be used to endorse or promote products derived from this software
  18 #    without specific prior written permission.
  19 #
  20 # THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 # ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 # SUCH DAMAGE.
  31
  32 TPUT="${TPUT:-"/usr/bin/tput"}"
  33
  34 _have_tput() {
  35     [ -x "$TPUT" ] && "$TPUT" hpa 60 >/dev/null 2>&1 \
  36         && return 0 \
  37         || return 1
  38 }
  39
  40 log_success_msg() {
  41     printf " * $@\n"
  42 }
  43
  44 log_failure_msg() {
  45     if _have_tput ; then
  46         RED="$("$TPUT" setaf 1)"
  47         #NORMAL="$("$TPUT" op)"
  48         printf " ${RED}*${NORMAL} $@\n"
  49     else
  50         printf " * $@\n"
  51     fi
  52 }
  53
  54 log_warning_msg() {
  55     if _have_tput ; then
  56         YELLOW="$("$TPUT" setaf 3)"
  57         #NORMAL="$("$TPUT" op")"
  58         # printf " *${NORMAL} $@\n"
  59         printf " ${BLUE}*${NORMAL} $@\n"
  60     else
  61         printf " * $@\n"
  62     fi
  63 }
  64
  65 log_warning_msg_nn() {
  66     if _have_tput ; then
  67         YELLOW="$("$TPUT" setaf 3)"
  68         printf " ${BLUE}*${NORMAL} $@"
  69     else
  70         printf " * $@"
  71     fi
  72 }
  73
  74 # int log_begin_message (char *message)
  75 log_begin_msg() {
  76         if [ "$#" -eq 0 ]; then
  77                 return 1
  78         fi
  79         printf " ${GREEN}*${NORMAL} $@\n"
  80 }
  81
  82 log_begin_msg_nn() {
  83         if [ "$#" -eq 0 ]; then
  84                 return 1
  85         fi
  86         printf " ${GREEN}*${NORMAL} $@"
  87 }
  88
  89
  90 SUBMSG="   ${GREEN}-${NORMAL} "
  91
  92 # int log_end_message (int exitstatus)
  93 log_end_msg() {
  94
  95     # If no arguments were passed, return
  96     [ "$#" -eq 0 ] && return 1
  97
  98     # Only do the fancy stuff if we have an appropriate terminal
  99     # and if /usr is already mounted
 100     if _have_tput ; then
 101         COLS="$("$TPUT" cols)"
 102         if [ -n "$COLS" ]; then
 103             COL=$(( "$COLS" - 7 ))
 104         else
 105             COL=73
 106         fi
 107         UP="$("$TPUT" cuu1)"
 108         END="$("$TPUT" hpa $COL)"
 109         START="$("$TPUT" hpa 0)"
 110         #RED="$("$TPUT" setaf 1)"
 111         #NORMAL="$("$TPUT" op)"
 112         if [ "$1" -eq 0 ]; then
 113             printf "${UP}${END}${BLUE}[ ${GREEN}ok ${BLUE}]${NORMAL}\n"
 114         else
 115             printf "${UP}${START} ${RED}*${NORMAL}${END}[${RED}fail${NORMAL}]\n"
 116         fi
 117     else
 118         if [ "$1" -eq 0 ]; then
 119             printf "   ...done.\n"
 120         else
 121             printf "   ...fail!\n"
 122         fi
 123     fi
 124     return "$1"
 125 }
 126
 127 # Copyright 1999-2005 Gentoo Foundation
 128 # Distributed under the terms of the GNU General Public License v2
 129 # $Header: /var/cvsroot/gentoo-src/rc-scripts/sbin/functions.sh,v 1.81.2.6 2005/05/15 20:00:31 vapier Exp $
 130
 131 RC_GOT_FUNCTIONS="yes"
 132
 133 # Different types of dependencies
 134 deptypes="need use"
 135 # Different types of order deps
 136 ordtypes="before after"
 137
 138 #
 139 # Internal variables
 140 #
 141
 142 # Dont output to stdout?
 143 RC_QUIET_STDOUT="no"
 144 RC_VERBOSE="${RC_VERBOSE:-no}"
 145
 146 # Should we use color?
 147 if [ -r /proc/cmdline ] ; then
 148     grep -q ' nocolor' /proc/cmdline && RC_NOCOLOR='yes'
 149 fi
 150 RC_NOCOLOR="${RC_NOCOLOR:-no}"
 151 # Can the terminal handle endcols?
 152 RC_ENDCOL="yes"
 153
 154 #
 155 # Default values for rc system
 156 #
 157 RC_TTY_NUMBER=11
 158 RC_NET_STRICT_CHECKING="no"
 159 RC_PARALLEL_STARTUP="no"
 160 RC_USE_CONFIG_PROFILE="yes"
 161
 162 #
 163 # Default values for e-message indentation and dots
 164 #
 165 RC_INDENTATION=''
 166 RC_DEFAULT_INDENT=2
 167 #RC_DOT_PATTERN=' .'
 168 RC_DOT_PATTERN=''
 169
 170 # void get_bootconfig()
 171 #
 172 #    Get the BOOTLEVEL and SOFTLEVEL by setting
 173 #    'bootlevel' and 'softlevel' via kernel
 174 #    parameters.
 175 #
 176 get_bootconfig() {
 177     local copt
 178     local newbootlevel
 179     local newsoftlevel
 180
 181     for copt in $(</proc/cmdline) ; do
 182         case "${copt%=*}" in
 183             "bootlevel")
 184                 newbootlevel="${copt##*=}"
 185                 ;;
 186             "softlevel")
 187                 newsoftlevel="${copt##*=}"
 188                 ;;
 189         esac
 190     done
 191
 192     if [ -n "${newbootlevel}" ] ; then
 193         export BOOTLEVEL="${newbootlevel}"
 194     else
 195         export BOOTLEVEL="boot"
 196     fi
 197
 198     if [ -n "${newsoftlevel}" ] ; then
 199         export DEFAULTLEVEL="${newsoftlevel}"
 200     else
 201         export DEFAULTLEVEL="default"
 202     fi
 203
 204     return 0
 205 }
 206
 207 # void esyslog(char* priority, char* tag, char* message)
 208 #
 209 #    use the system logger to log a message
 210 #
 211 esyslog() {
 212     local pri
 213     local tag
 214
 215     if [ -x /usr/bin/logger ]
 216     then
 217         pri="$1"
 218         tag="$2"
 219
 220         shift 2
 221         [ -z "$*" ] && return 0
 222
 223         /usr/bin/logger -p "${pri}" -t "${tag}" -- "$*"
 224     fi
 225
 226     return 0
 227 }
 228
 229 # void eindent(int num)
 230 #
 231 #    increase the indent used for e-commands.
 232 #
 233 eindent() {
 234     local i=$1
 235     (( i > 0 )) || (( i = RC_DEFAULT_INDENT ))
 236     esetdent $(( ${#RC_INDENTATION} + i ))
 237 }
 238
 239 # void eoutdent(int num)
 240 #
 241 #    decrease the indent used for e-commands.
 242 #
 243 eoutdent() {
 244     local i=$1
 245     (( i > 0 )) || (( i = RC_DEFAULT_INDENT ))
 246     esetdent $(( ${#RC_INDENTATION} - i ))
 247 }
 248
 249 # void esetdent(int num)
 250 #
 251 #    hard set the indent used for e-commands.
 252 #    num defaults to 0
 253 #
 254 esetdent() {
 255     local i=$1
 256     (( i < 0 )) && (( i = 0 ))
 257     RC_INDENTATION=$(printf "%${i}s" '')
 258 }
 259
 260 # void einfo(char* message)
 261 #
 262 #    show an informative message (with a newline)
 263 #
 264 einfo() {
 265     einfon "$*\n"
 266     LAST_E_CMD=einfo
 267     return 0
 268 }
 269
 270 # void einfon(char* message)
 271 #
 272 #    show an informative message (without a newline)
 273 #
 274 einfon() {
 275     [ "${RC_QUIET_STDOUT}" = "yes" ] && return 0
 276     [ "${RC_ENDCOL}" != "yes" ] && [ "${LAST_E_CMD}" = "ebegin" ] && echo
 277     printf " ${GOOD}*${NORMAL} ${RC_INDENTATION}$*"
 278     LAST_E_CMD=einfon
 279     return 0
 280 }
 281
 282 # void ewarn(char* message)
 283 #
 284 #    show a warning message + log it
 285 #
 286 ewarn() {
 287     if [ "${RC_QUIET_STDOUT}" = "yes" ]; then
 288         printf " $*\n"
 289     else
 290         [ "${RC_ENDCOL}" != "yes" ] && [ "${LAST_E_CMD}" = "ebegin" ] && echo
 291         printf " ${WARN}*${NORMAL} ${RC_INDENTATION}$*\n"
 292     fi
 293
 294     # Log warnings to system log
 295     esyslog "daemon.warning" "rc-scripts" "$*"
 296
 297     LAST_E_CMD=ewarn
 298     return 0
 299 }
 300
 301 # void eerror(char* message)
 302 #
 303 #    show an error message + log it
 304 #
 305 eerror() {
 306     if [ "${RC_QUIET_STDOUT}" = "yes" ]; then
 307         printf " $*\n" >/dev/stderr
 308     else
 309         [ "${RC_ENDCOL}" != "yes" ] && [ "${LAST_E_CMD}" = "ebegin" ] && echo
 310         printf " ${BAD}*${NORMAL} ${RC_INDENTATION}$*\n"
 311     fi
 312
 313     # Log errors to system log
 314     esyslog "daemon.err" "rc-scripts" "$*"
 315
 316     LAST_E_CMD=eerror
 317     return 0
 318 }
 319
 320 # void ebegin(char* message)
 321 #
 322 #    show a message indicating the start of a process
 323 #
 324 ebegin() {
 325     local msg="$*" dots spaces
 326     spaces="$(printf '%'"${#RC_DOT_PATTERN}"'s' '')"
 327     [ "${RC_QUIET_STDOUT}" = "yes" ] && return 0
 328
 329     if [ -n "${RC_DOT_PATTERN}" ]; then
 330         dots=$(printf "%$(( COLS - 3 - ${#RC_INDENTATION} - ${#msg} - 7 ))s" '')
 331         while [ "${dots#${spaces}}" != "${dots}" ] ; do
 332             dots="${dots#${spaces}}${RC_DOT_PATTERN}"
 333         done
 334         msg="${msg}${dots}"
 335     else
 336         msg="${msg} ..."
 337     fi
 338     einfon "${msg}"
 339     [ "${RC_ENDCOL}" = "yes" ] && echo
 340
 341     LAST_E_LEN=$(( 3 + ${#RC_INDENTATION} + ${#msg} ))
 342     LAST_E_CMD=ebegin
 343     return 0
 344 }
 345
 346 # void _eend(int error, char *efunc, char* errstr)
 347 #
 348 #    indicate the completion of process, called from eend/ewend
 349 #    if error, show errstr via efunc
 350 #
 351 #    This function is private to functions.sh.  Do not call it from a
 352 #    script.
 353 #
 354 _eend() {
 355     local retval=${1:-0} efunc=${2:-eerror} msg
 356     shift 2
 357
 358     if [ "${retval}" -eq 0 ]; then
 359         [ "${RC_QUIET_STDOUT}" = "yes" ] && return 0
 360         msg="${BRACKET}[ ${GOOD}ok${BRACKET} ]${NORMAL}"
 361     else
 362         if [ -n "$*" ]; then
 363             "${efunc}" "$*"
 364         fi
 365         msg="${BRACKET}[ ${BAD}!!${BRACKET} ]${NORMAL}"
 366     fi
 367
 368     if [ "${RC_ENDCOL}" = "yes" ]; then
 369         printf "${ENDCOL}  ${msg}\n"
 370     else
 371         [ "${LAST_E_CMD}" = "ebegin" ] || LAST_E_LEN=0
 372         printf "%$(( "${COLS}" - "${LAST_E_LEN}" - 6 ))s%b\n" '' "${msg}"
 373     fi
 374
 375     return ${retval}
 376 }
 377
 378 # void eend(int error, char* errstr)
 379 #
 380 #    indicate the completion of process
 381 #    if error, show errstr via eerror
 382 #
 383 eend() {
 384     local retval=${1:-0}
 385     shift
 386
 387     _eend ${retval} eerror "$*"
 388
 389     LAST_E_CMD=eend
 390     return $retval
 391 }
 392
 393 # void ewend(int error, char* errstr)
 394 #
 395 #    indicate the completion of process
 396 #    if error, show errstr via ewarn
 397 #
 398 ewend() {
 399     local retval=${1:-0}
 400     shift
 401
 402     _eend ${retval} ewarn "$*"
 403
 404     LAST_E_CMD=ewend
 405     return $retval
 406 }
 407
 408 # v-e-commands honor RC_VERBOSE which defaults to no.
 409 # The condition is negated so the return value will be zero.
 410 veinfo()  { [ "${RC_VERBOSE}" != "yes" ] || einfo  "$@"; }
 411 veinfon() { [ "${RC_VERBOSE}" != "yes" ] || einfon "$@"; }
 412 vewarn()  { [ "${RC_VERBOSE}" != "yes" ] || ewarn  "$@"; }
 413 veerror() { [ "${RC_VERBOSE}" != "yes" ] || eerror "$@"; }
 414 vebegin() { [ "${RC_VERBOSE}" != "yes" ] || ebegin "$@"; }
 415 veend() {
 416     [ "${RC_VERBOSE}" = "yes" ] && { eend "$@"; return $?; }
 417     return ${1:-0}
 418 }
 419 veend() {
 420     [ "${RC_VERBOSE}" = "yes" ] && { ewend "$@"; return $?; }
 421     return ${1:-0}
 422 }
 423
 424 # bool get_bootparam(param)
 425 #
 426 #   return 0 if gentoo=param was passed to the kernel
 427 #
 428 #   EXAMPLE:  if get_bootparam "nodevfs" ; then ....
 429 #
 430 get_bootparam() {
 431     local x copt params retval=1
 432
 433     [ ! -r "/proc/cmdline" ] && return 1
 434
 435     for copt in $(< /proc/cmdline)
 436     do
 437         if [ "${copt%=*}" = "gentoo" ]
 438         then
 439             params="$(gawk -v PARAMS="${copt##*=}" '
 440                 BEGIN {
 441                     split(PARAMS, nodes, ",")
 442                     for (x in nodes)
 443                         print nodes[x]
 444                 }')"
 445
 446             # Parse gentoo option
 447             for x in ${params}
 448             do
 449                 if [ "${x}" = "$1" ]
 450                 then
 451 #                    printf "YES\n"
 452                     retval=0
 453                 fi
 454             done
 455         fi
 456     done
 457
 458     return ${retval}
 459 }
 460
 461 # char *add_suffix(char * configfile)
 462 #
 463 #    Returns a config file name with the softlevel suffix
 464 #    appended to it.  For use with multi-config services.
 465 add_suffix() {
 466     if [ "${RC_USE_CONFIG_PROFILE}" = "yes" -a -e "$1.${DEFAULTLEVEL}" ]
 467     then
 468         printf "$1.${DEFAULTLEVEL}\n"
 469     else
 470         printf "$1\n"
 471     fi
 472
 473     return 0
 474 }
 475
 476 # bool get_mount_fstab(path)
 477 #
 478 #   return the parameters to pass to the mount command generated from fstab
 479 #
 480 #   EXAMPLE: cmd=$( get_mount_fstab /proc )
 481 #            cmd=${cmd:--t proc none /proc}
 482 #            mount -n ${cmd}
 483 #
 484 get_mount_fstab() {
 485     awk '$1 ~ "^#" { next }
 486          $2 == "'$*'" { if (found++ == 0) { print "-t "$3,"-o "$4,$1,$2 } }
 487          END { if (found > 1) { print "More than one entry for '$*' found in /etc/fstab!" > "/dev/stderr" } }
 488     ' /etc/fstab
 489 }
 490
 491 # char *reverse_list(list)
 492 #
 493 #   Returns the reversed order of list
 494 #
 495 reverse_list() {
 496     local ret
 497     ret=''
 498     while [ "$#" -gt 0 ] ; do
 499         if [ -z "${ret}" ] ; then
 500             ret="$1"
 501         else
 502             ret="$1 ${ret}"
 503         fi
 504         shift
 505     done
 506     printf '%s' "${ret}"
 507 }
 508
 509
 510 # bool is_older_than(reference, files/dirs to check)
 511 #
 512 #   return 0 if any of the files/dirs are newer than
 513 #   the reference file
 514 #
 515 #   EXAMPLE: if is_older_than a.out *.o ; then ...
 516 is_older_than() {
 517     local x
 518     local ref="$1"
 519     shift
 520
 521     for x in "$@" ; do
 522         [ "${x}" -nt "${ref}" ] && return 0
 523
 524         if [ -d "${x}" ] ; then
 525             is_older_than "${ref}" "${x}"/* && return 0
 526         fi
 527     done
 528
 529     return 1
 530 }
 531
 532 # Setup a basic $PATH.  Just add system default to existing.
 533 # This should solve both /sbin and /usr/sbin not present when
 534 # doing 'su -c foo', or for something like:  PATH= rcscript start
 535 PATH="/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/sbin:${PATH}"
 536
 537 if [ "$(/sbin/consoletype 2> /dev/null)" = "serial" ] ; then
 538     # We do not want colors/endcols on serial terminals
 539     RC_NOCOLOR="yes"
 540     RC_ENDCOL="no"
 541 fi
 542
 543 for arg in "$@" ; do
 544     case "${arg}" in
 545         # Lastly check if the user disabled it with --nocolor argument
 546         --nocolor|-nc)
 547             RC_NOCOLOR="yes"
 548             ;;
 549     esac
 550 done
 551
 552 # Setup COLS and ENDCOL so eend can line up the [ ok ]
 553 # width of [ ok ] == 7
 554 COLS="$(stty size 2>/dev/null | cut -d' ' -f2)"
 555 if [ -z "${COLS}" ] || [ "${COLS}" -le 0 ] ; then
 556     COLS=80
 557 fi
 558
 559 if [ "${RC_ENDCOL}" = "yes" ]; then
 560     ENDCOL="\e[A\e[$(( ${COLS} - 8 ))G"
 561 else
 562     ENDCOL=''
 563 fi
 564
 565 # Setup the colors so our messages all look pretty
 566 if [ "${RC_NOCOLOR}" = "yes" ]; then
 567     unset GOOD WARN BAD NORMAL HILITE BRACKET
 568 else
 569     GOOD='\e[32;01m'
 570     WARN='\e[33;01m'
 571     BAD='\e[31;01m'
 572     NORMAL='\e[0m'
 573     HILITE='\e[36;01m'
 574     BRACKET='\e[34;01m'
 575 fi
 576
 577 # vim:ts=4