From 64deb069a97917d062f99d55252fb9fd3d4953bb Mon Sep 17 00:00:00 2001 From: Gordon Tetlow Date: Thu, 13 Jun 2002 22:19:42 +0000 Subject: [PATCH] Bring this up to date with the latest NetBSD bits. Also add some bits of our own. Submitted by: Mike Makonnen Reviewed by: silence on -current and -hackers --- etc/rc.subr | 698 +++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 549 insertions(+), 149 deletions(-) diff --git a/etc/rc.subr b/etc/rc.subr index f30076085e83..ae0aaa6ca6b1 100644 --- a/etc/rc.subr +++ b/etc/rc.subr @@ -1,6 +1,7 @@ -# $NetBSD: rc.subr,v 1.28 2000/11/06 00:08:30 lukem Exp $ +# $NetBSD: rc.subr,v 1.49 2002/05/21 12:31:01 lukem Exp $ +# $FreeBSD$ # -# Copyright (c) 1997-2000 The NetBSD Foundation, Inc. +# Copyright (c) 1997-2002 The NetBSD Foundation, Inc. # All rights reserved. # # This code is derived from software contributed to The NetBSD Foundation @@ -38,10 +39,77 @@ # functions used by various rc scripts # +# +# Operating System dependent/independent variables +# + +SYSCTL="/sbin/sysctl" +SYSCTL_N="${SYSCTL} -n" +CMD_OSTYPE="${SYSCTL_N} kern.ostype" + +case `${CMD_OSTYPE}` in +FreeBSD) + SYSCTL_W="${SYSCTL}" + ;; +NetBSD) + SYSCTL_W="${SYSCTL} -w" + ;; +esac + # # functions # --------- +# +# set_rcvar base_var +# Set the variable name enabling a specific service. +# FreeBSD uses ${service}_enable, while NetBSD uses +# just the name of the service. For example: +# FreeBSD: sendmail_enable="YES" +# NetBSD : sendmail="YES" +# $1 - if $name is not the base to work of off, specify +# a different one +# +set_rcvar() +{ + if [ -z "$1" ]; then + base_var=${name} + else + base_var="$1" + fi + + case `${CMD_OSTYPE}` in + FreeBSD) + echo ${base_var}_enable + ;; + NetBSD) + echo ${base_var} + ;; + *) + echo 'XXX' + ;; + esac +} + +# +# force_depend script +# Force a service to start. Intended for use by services +# to resolve dependency issues. It is assumed the caller +# has check to make sure this call is necessary +# $1 - filename of script, in /etc/rc.d, to run +# +force_depend() +{ + _depend="$1" + + info "${name} depends on ${_depend}, which will be forced to start." + if ! /etc/rc.d/${_depend} forcestart ; then + warn "Unable to force ${_depend}. It may already be running." + return 1 + fi + return 0 +} + # # checkyesno var # Test $1 variable, and warn if not set to YES or NO. @@ -50,6 +118,7 @@ checkyesno() { eval _value=\$${1} + debug "checkyesno: $1 is set to $_value." case $_value in # "yes", "true", "on", or "1" @@ -68,18 +137,27 @@ checkyesno() esac } +# reverse_list list +# print the list in reverse order # -# mount_critical_filesystems -# Go through the list of critical filesystems, checking each one -# to see if it is mounted, and if it is not, mounting it. +reverse_list() +{ + _revlist= + for _revfile in $*; do + _revlist="$_revfile $_revlist" + done + echo $_revlist +} + +# +# mount_critical_filesystems type +# Go through the list of critical filesystems as provided in +# the rc.conf(5) variable $critical_filesystems_${type}, checking +# each one to see if it is mounted, and if it is not, mounting it. # mount_critical_filesystems() { - if [ $1 = local ]; then - _fslist=$critical_filesystems_beforenet - else - _fslist=$critical_filesystems - fi + eval _fslist=\$critical_filesystems_${1} for _fs in $_fslist; do mount | ( _ismounted=no @@ -88,108 +166,190 @@ mount_critical_filesystems() _ismounted=yes fi done - if [ $_ismounted = no ]; then + if [ $_ismounted = no ]; then mount $_fs >/dev/null 2>&1 fi - ) + ) done } # -# check_pidfile pidfile procname -# Parses the first line of pidfile for a pid, and ensures +# check_pidfile pidfile procname [interpreter] +# Parses the first line of pidfile for a PID, and ensures # that the process is running and matches procname. -# Prints the matching pid upon success, nothing otherwise. +# Prints the matching PID upon success, nothing otherwise. +# interpreter is optional; see _find_processes() for details. # check_pidfile() { _pidfile=$1 _procname=$2 + _interpreter=$3 if [ -z "$_pidfile" -o -z "$_procname" ]; then - err 3 'USAGE: check_pidfile pidfile procname' + err 3 'USAGE: check_pidfile pidfile procname [interpreter]' fi if [ ! -f $_pidfile ]; then + debug "pid file {$_pidfile): not readable." return fi read _pid _junk < $_pidfile if [ -z "$_pid" ]; then + debug "pid file {$_pidfile): no pid in file." return fi - _procnamebn=${_procname##*/} - ps -p $_pid -o 'pid,command' | while read _npid _arg0 _argv; do - if [ "$_npid" = "PID" ]; then - continue - fi - if [ "$_arg0" = "$_procname" \ - -o "$_arg0" = "$_procnamebn" \ - -o "$_arg0" = "${_procnamebn}:" \ - -o "$_arg0" = "(${_procnamebn})" ]; then - echo $_npid - return - fi - done + _find_processes $_procname ${_interpreter:-.} '-p '"$_pid" } # -# check_process procname +# check_process procname [interpreter] # Ensures that a process (or processes) named procname is running. -# Prints a list of matching pids. +# Prints a list of matching PIDs. +# interpreter is optional; see _find_processes() for details. # check_process() { _procname=$1 + _interpreter=$2 if [ -z "$_procname" ]; then - err 3 'USAGE: check_process procname' + err 3 'USAGE: check_process procname [interpreter]' fi - _procnamebn=${_procname##*/} - _pref= - ps -ax -o 'pid,command' | while read _npid _arg0 _argv; do - if [ "$_npid" = "PID" ]; then - continue - fi - if [ "$_arg0" = "$_procname" \ - -o "$_arg0" = "$_procnamebn" \ - -o "$_arg0" = "${_procnamebn}:" \ - -o "$_arg0" = "(${_procnamebn})" ]; then - echo -n "$_pref$_npid" - _pref=" " - fi - done + _find_processes $_procname ${_interpreter:-.} '-ax' } # -# run_rc_command arg -# Search for arg in the list of supported commands, which is: -# "start stop restart rcvar status ${extra_commands}" -# If there's a match, run ${arg}_cmd or the default command (see below). +# _find_processes procname interpreter psargs +# Search for procname in the output of ps generated by psargs. +# Prints the PIDs of any matching processes, space separated. # -# If arg has a given prefix, then change the operation as follows: -# prefix operation +# If interpreter == ".", check the following variations of procname +# against the first word of each command: +# procname +# `basename procname` +# `basename procname` + ":" +# "(" + `basename procname` + ")" +# +# If interpreter != ".", read the first line of procname, remove the +# leading #!, normalise whitespace, append procname, and attempt to +# match that against each command, either as is, or with extra words +# at the end. +# +_find_processes() +{ + if [ $# -ne 3 ]; then + err 3 'USAGE: _find_processes procname interpreter psargs' + fi + _procname=$1 + _interpreter=$2 + _psargs=$3 + + _pref= + if [ $_interpreter != "." ]; then # an interpreted script + read _interp < $_procname # read interpreter name + _interp=${_interp#\#!} # strip #! + set -- $_interp + if [ $_interpreter != $1 ]; then + warn "\$command_interpreter $_interpreter != $1" + fi + _interp="$* $_procname" # cleanup spaces, add _procname + _fp_args='_argv' + _fp_match='case "$_argv" in + ${_interp}|"${_interp} "*)' + else # a normal daemon + _procnamebn=${_procname##*/} + _fp_args='_arg0 _argv' + _fp_match='case "$_arg0" in + $_procname|$_procnamebn|${_procnamebn}:|"(${_procnamebn})")' + fi + + _proccheck=' + ps -o "pid,command" '"$_psargs"' | + while read _npid '"$_fp_args"'; do + case "$_npid" in + PID) + continue ;; + esac ; '"$_fp_match"' + echo -n "$_pref$_npid" ; + _pref=" " + ;; + esac + done' + + debug "in _find_processes: proccheck is ($_proccheck)." + eval $_proccheck +} + +# +# wait_for_pids pid [pid ...] +# spins until none of the pids exist +# +wait_for_pids() +{ + _list=$* + if [ -z "$_list" ]; then + return + fi + _prefix= + while true; do + _nlist=""; + for _j in $_list; do + if kill -0 $_j 2>/dev/null; then + _nlist="${_nlist}${_nlist:+ }$_j" + fi + done + if [ -z "$_nlist" ]; then + break + fi + _list=$_nlist + echo -n ${_prefix:-"Waiting for PIDS: "}$_list + _prefix=", " + sleep 2 + done + if [ -n "$_prefix" ]; then + echo "." + fi +} + +# +# run_rc_command argument +# Search for argument in the list of supported commands, which is: +# "start stop restart rcvar status poll ${extra_commands}" +# If there's a match, run ${argument}_cmd or the default method +# (see below). +# +# If argument has a given prefix, then change the operation as follows: +# Prefix Operation # ------ --------- -# fast Skip the pid check. -# force Set ${rcvar} to YES. +# fast Skip the pid check, and set rc_fast=yes +# force Set ${rcvar} to YES, and set rc_force=yes # # The following globals are used: # -# name needed function -# ---- ------ -------- +# Name Needed Purpose +# ---- ------ ------- # name y Name of script. # # command n Full path to command. -# Not needed if ${arg}_cmd is set for +# Not needed if ${rc_arg}_cmd is set for # each keyword. # # command_args n Optional args/shell directives for command. # +# command_interpreter n If not empty, command is interpreted, so +# call check_{pidfile,process}() appropriately. +# # extra_commands n List of extra commands supported. # -# pidfile n If set, use check_pidfile $pidfile, else if -# $command is set, use check_process $command. +# pidfile n If set, use check_pidfile $pidfile $command, +# otherwise use check_process $command. +# In either case, only check if $command is set. +# +# procname n Process name to check for instead of $command. # # rcvar n This is checked with checkyesno to determine # if the action should be run. # # ${name}_chroot n Directory to chroot to before running ${command} +# Requires /usr to be mounted. # # ${name}_chdir n Directory to cd to before running ${command} # (if not using ${name}_chroot). @@ -202,22 +362,28 @@ check_process() # # ${name}_user n User to run ${command} as, using su(1) if not # using ${name}_chroot. +# Requires /usr to be mounted. # # ${name}_group n Group to run chrooted ${command} as. +# Requires /usr to be mounted. # -# ${name}_groups n Supplementary group list to run chrooted -# ${command} with. +# ${name}_groups n Comma separated list of supplementary groups +# to run the chrooted ${command} with. +# Requires /usr to be mounted. # -# ${_arg}_cmd n If set, use this as the action when invoked; -# $_arg is available to the action to use. +# ${rc_arg}_cmd n If set, use this as the method when invoked; # Otherwise, use default command (see below) # -# ${_arg}_precmd n If set, run just before performing the main -# action in the default command (i.e, after -# checking for required bits and process -# (non)existance). +# ${rc_arg}_precmd n If set, run just before performing the +# ${rc_arg}_cmd method in the default +# operation (i.e, after checking for required +# bits and process (non)existence). # If this completes with a non-zero exit code, -# don't run ${_arg}_cmd. +# don't run ${rc_arg}_cmd. +# +# ${rc_arg}_postcmd n If set, run just after performing the +# ${rc_arg}_cmd method, if that method +# returned a zero exit code. # # required_dirs n If set, check for the existence of the given # directories before running the default @@ -231,85 +397,122 @@ check_process() # listed variables before running the default # (re)start command. # -# Default commands for a given arg: -# -# arg default -# --- ------- -# status Show if ${command} is running, etc. +# Default behaviour for a given argument, if no override method is +# provided: # +# Argument Default behaviour +# -------- ----------------- # start if !running && checkyesno ${rcvar} # ${command} # # stop if ${pidfile} -# kill $sig_stop `check_pidfile $pidfile` +# rc_pid=$(check_pidfile $pidfile $command) # else -# kill $sig_stop `check_process $command` -# $sig_stop defaults to TERM. +# rc_pid=$(check_process $command) +# kill $sig_stop $rc_pid +# wait_for_pids $rc_pid +# ($sig_stop defaults to TERM.) # -# reload As stop, except use $sig_reload instead. +# reload Similar to stop, except use $sig_reload instead, +# and doesn't wait_for_pids. # $sig_reload defaults to HUP. # # restart Run `stop' then `start'. # +# status Show if ${command} is running, etc. +# +# poll Wait for ${command} to exit. +# +# rcvar Display what rc.conf variable is used (if any). +# +# Variables available to methods, and after run_rc_command() has +# completed: +# +# Variable Purpose +# -------- ------- +# rc_arg Argument to command, after fast/force processing +# performed +# +# rc_flags Flags to start the default command with. +# Defaults to ${name}_flags, unless overridden +# by $flags from the environment. +# This variable may be changed by the precmd method. +# +# rc_pid PID of command (if appropriate) +# +# rc_fast Not empty if "fast" was provided (q.v.) +# +# rc_force Not empty if "force" was provided (q.v.) +# # run_rc_command() { - _arg=$1 + rc_arg=$1 if [ -z "$name" ]; then - err 3 '$name is not set.' + err 3 'run_rc_command: $name is not set.' fi - case "$_arg" in + case "$rc_arg" in fast*) # "fast" prefix; don't check pid - _arg=${_arg#fast} - _rc_fast_run=YES + rc_arg=${rc_arg#fast} + rc_fast=yes ;; force*) # "force prefix; always start - _arg=${_arg#force} - _rc_force_run=YES + rc_arg=${rc_arg#force} + rc_force=yes if [ -n "${rcvar}" ]; then eval ${rcvar}=YES fi ;; esac + eval _overide_command=\$${name}_program + if [ -n "$_overide_command" ]; then + command=$_overide_command + fi + _keywords="start stop restart rcvar $extra_commands" - _pid= + rc_pid= _pidcmd= + _procname=${procname:-${command}} + # setup pid check command if not fast - if [ -z "$_rc_fast_run" ]; then + if [ -z "$rc_fast" -a -n "$_procname" ]; then if [ -n "$pidfile" ]; then - _pidcmd='_pid=`check_pidfile '$pidfile' '$command'`' - elif [ -n "$command" ]; then - _pidcmd='_pid=`check_process '$command'`' + _pidcmd='rc_pid=$(check_pidfile '"$pidfile $_procname $command_interpreter"')' + else + _pidcmd='rc_pid=$(check_process '"$_procname $command_interpreter"')' fi if [ -n "$_pidcmd" ]; then - _keywords="${_keywords} status" + _keywords="${_keywords} status poll" fi fi - if [ -z "$_arg" ]; then + if [ -z "$rc_arg" ]; then rc_usage "$_keywords" fi if [ -n "$flags" ]; then # allow override from environment - _flags=$flags + rc_flags=$flags else - eval _flags=\$${name}_flags + eval rc_flags=\$${name}_flags + fi + eval _chdir=\$${name}_chdir _chroot=\$${name}_chroot \ + _nice=\$${name}_nice _user=\$${name}_user \ + _group=\$${name}_group _groups=\$${name}_groups + + if [ -n "$_user" ]; then # unset $_user if running as that user + if [ "$_user" = "$(id -un)" ]; then + unset _user + fi fi - eval _chdir=\$${name}_chdir - eval _chroot=\$${name}_chroot - eval _nice=\$${name}_nice - eval _user=\$${name}_user - eval _group=\$${name}_group - eval _groups=\$${name}_groups # if ${rcvar} is set, and $1 is not - # "rcvar" or "status", then run + # "rcvar", then run # checkyesno ${rcvar} # and return if that failed # - if [ -n "${rcvar}" -a "$_arg" != "rcvar" -a "$_arg" != "status" ]; then + if [ -n "${rcvar}" -a "$rc_arg" != "rcvar" ]; then if ! checkyesno ${rcvar}; then return 0 fi @@ -318,32 +521,36 @@ run_rc_command() eval $_pidcmd # determine the pid if necessary for _elem in $_keywords; do - if [ "$_elem" != "$_arg" ]; then + if [ "$_elem" != "$rc_arg" ]; then continue fi # if there's a custom ${XXX_cmd}, # run that instead of the default # - eval _cmd=\$${_arg}_cmd - eval _precmd=\$${_arg}_precmd + eval _cmd=\$${rc_arg}_cmd _precmd=\$${rc_arg}_precmd \ + _postcmd=\$${rc_arg}_postcmd if [ -n "$_cmd" ]; then + debug "run_rc_command: using XXX_cmd functions." # if the precmd failed and force # isn't set, exit # - if ! eval $_precmd && [ -z "$_rc_force_run" ]; then + if ! eval $_precmd && [ -z "$rc_force" ]; then return 1 fi - eval $_cmd + if ! eval $_cmd && [ -z "$rc_force" ]; then + return 1 + fi + eval $_postcmd return 0 fi - case "$_arg" in # default operations... + case "$rc_arg" in # default operations... status) - if [ -n "$_pid" ]; then - echo "${name} is running as pid $_pid." + if [ -n "$rc_pid" ]; then + echo "${name} is running as pid $rc_pid." else echo "${name} is not running." return 1 @@ -351,12 +558,13 @@ run_rc_command() ;; start) - if [ -n "$_pid" ]; then - echo "${name} already running? (pid=$_pid)." + if [ -n "$rc_pid" ]; then + echo "${name} already running? (pid=$rc_pid)." exit 1 fi if [ ! -x $command ]; then + info "run_rc_command: cannot run ($command)." return 0 fi @@ -366,7 +574,7 @@ run_rc_command() for _f in $required_vars; do if ! checkyesno $_f; then warn "\$${_f} is not set." - if [ -z "$_rc_force_run" ]; then + if [ -z "$rc_force" ]; then return 1 fi fi @@ -374,7 +582,7 @@ run_rc_command() for _f in $required_dirs; do if [ ! -d "${_f}/." ]; then warn "${_f} is not a directory." - if [ -z "$_rc_force_run" ]; then + if [ -z "$rc_force" ]; then return 1 fi fi @@ -382,7 +590,7 @@ run_rc_command() for _f in $required_files; do if [ ! -r "${_f}" ]; then warn "${_f} is not readable." - if [ -z "$_rc_force_run" ]; then + if [ -z "$rc_force" ]; then return 1 fi fi @@ -391,11 +599,10 @@ run_rc_command() # if the precmd failed and force # isn't set, exit # - if ! eval $_precmd && [ -z "$_rc_force_run" ]; then + if ! eval $_precmd && [ -z "$rc_force" ]; then return 1 fi - # setup the command to run, and run it # echo "Starting ${name}." @@ -403,20 +610,32 @@ run_rc_command() _doit="\ ${_nice:+nice -n $_nice }\ chroot ${_user:+-u $_user }${_group:+-g $_group }${_groups:+-G $_groups }\ -$_chroot $command $_flags $command_args" +$_chroot $command $rc_flags $command_args" else _doit="\ -${_user:+su -m $_user -c 'sh -c \"}\ ${_chdir:+cd $_chdir; }\ ${_nice:+nice -n $_nice }\ -$command $_flags $command_args\ -${_user:+\"'}" +$command $rc_flags $command_args" + if [ -n "$_user" ]; then + _doit="su -m $_user -c 'sh -c \"$_doit\"'" + fi fi - eval $_doit + + # if the cmd failed and force + # isn't set, exit + # + debug "run_rc_command: _doit: $_doit" + if ! eval $_doit && [ -z "$rc_force" ]; then + return 1 + fi + + # finally, run postcmd + # + eval $_postcmd ;; stop) - if [ -z "$_pid" ]; then + if [ -z "$rc_pid" ]; then if [ -n "$pidfile" ]; then echo \ "${name} not running? (check $pidfile)." @@ -426,17 +645,36 @@ ${_user:+\"'}" exit 1 fi - if ! eval $_precmd && [ -z "$_rc_force_run" ]; then + # if the precmd failed and force + # isn't set, exit + # + if ! eval $_precmd && [ -z "$rc_force" ]; then return 1 fi + + # send the signal to stop + # echo "Stopping ${name}." - _doit=\ -"${_user:+su -m $_user -c '}kill -${sig_stop:-TERM} $_pid${_user:+'}" - eval $_doit + _doit="kill -${sig_stop:-TERM} $rc_pid" + if [ -n "$_user" ]; then + _doit="su -m $_user -c 'sh -c \"$_doit\"'" + fi + + # if the stop cmd failed and force + # isn't set, exit + # + if ! eval $_doit && [ -z "$rc_force" ]; then + return 1 + fi + + # wait for the command to exit, + # and run postcmd. + wait_for_pids $rc_pid + eval $_postcmd ;; reload) - if [ -z "$_pid" ]; then + if [ -z "$rc_pid" ]; then if [ -n "$pidfile" ]; then echo \ "${name} not running? (check $pidfile)." @@ -446,16 +684,21 @@ ${_user:+\"'}" exit 1 fi echo "Reloading ${name} config files." - if ! eval $_precmd && [ -z "$_rc_force_run" ]; then + if ! eval $_precmd && [ -z "$rc_force" ]; then return 1 fi - _doit=\ -"${_user:+su -m $_user -c '}kill -${sig_reload:-HUP} $_pid${_user:+'}" - eval $_doit + _doit="kill -${sig_reload:-HUP} $rc_pid" + if [ -n "$_user" ]; then + _doit="su -m $_user -c 'sh -c \"$_doit\"'" + fi + if ! eval $_doit && [ -z "$rc_force" ]; then + return 1 + fi + eval $_postcmd ;; restart) - if ! eval $_precmd && [ -z "$_rc_force_run" ]; then + if ! eval $_precmd && [ -z "$rc_force" ]; then return 1 fi # prevent restart being called more @@ -465,10 +708,17 @@ ${_user:+\"'}" return 0 fi _rc_restart_done=YES - ( $0 ${_rc_force_run:+force}stop ) - sleep 1 - $0 ${_rc_force_run:+force}start + ( $0 ${rc_force:+force}stop ) + $0 ${rc_force:+force}start + + eval $_postcmd + ;; + + poll) + if [ -n "$rc_pid" ]; then + wait_for_pids $rc_pid + fi ;; rcvar) @@ -490,7 +740,7 @@ ${_user:+\"'}" return 0 done - echo 1>&2 "$0: unknown directive '$_arg'." + echo 1>&2 "$0: unknown directive '$rc_arg'." rc_usage "$_keywords" exit 1 } @@ -499,13 +749,9 @@ ${_user:+\"'}" # run_rc_script file arg # Start the script `file' with `arg', and correctly handle the # return value from the script. If `file' ends with `.sh', it's -# sourced into the current environment. Otherwise it's run as -# a child process. -# -# Note: because `.sh' files are sourced into the current environment -# run_rc_command shouldn't be used because its difficult to ensure -# that the global variable state before and after the sourcing of -# the .sh file won't adversely affect other scripts. +# sourced into the current environment. If `file' appears to be +# a backup or scratch file, ignore it. Otherwise if it's +# executable run as a child process. # run_rc_script() { @@ -515,12 +761,29 @@ run_rc_script() err 3 'USAGE: run_rc_script file arg' fi + trap "echo 'Reboot interrupted'; exit 1" 3 + + unset name command command_args command_interpreter \ + extra_commands pidfile procname \ + rcvar required_dirs required_files required_vars + eval unset ${_arg}_cmd ${_arg}_precmd ${_arg}_postcmd + case "$_file" in *.sh) # run in current shell set $_arg ; . $_file ;; + *[~#]|*.OLD|*.orig) # scratch file; skip + warn "Ignoring scratch file $_file" + ;; *) # run in subshell - ( set $_arg ; . $_file ) + if [ -x $_file ]; then + if [ -n "$rc_fast_and_loose" ]; then + set $_arg ; . $_file + else + ( trap "echo 'Reboot interrupted'; exit 1" 3 + set $_arg ; . $_file ) + fi + fi ;; esac } @@ -536,8 +799,19 @@ load_rc_config() err 3 'USAGE: load_rc_config command' fi - . /etc/rc.conf + if [ -z "$_rc_conf_loaded" ]; then + if [ -r /etc/defaults/rc.conf ]; then + debug "Sourcing /etc/defaults/rc.conf" + . /etc/defaults/rc.conf + source_rc_confs + elif [ -r /etc/rc.conf ]; then + debug "Sourcing /etc/rc.conf (/etc/defaults/rc.conf doesn't exist)." + . /etc/rc.conf + fi + _rc_conf_loaded=YES + fi if [ -f /etc/rc.conf.d/"$_command" ]; then + debug "Sourcing /etc/rc.conf.d/${_command}" . /etc/rc.conf.d/"$_command" fi } @@ -561,6 +835,18 @@ rc_usage() exit 1 } +# +# _echo prefix message +# Display message preceded by "$prefix:". Log to syslog as well. +# XXX - syslogd may not be listening (especially if this subroutine +# is called at boot before syslogd has had a chance to startup). +# +_echo() +{ + [ -x /usr/bin/logger ] && /usr/bin/logger "$0: $1: $2" + echo "$0: $1: $2" +} + # # err exitval message # Display message to stderr and log to the syslog, and exit with exitval. @@ -570,8 +856,7 @@ err() exitval=$1 shift - logger "$0: ERROR: $*" - echo 1>&2 "$0: ERROR: $*" + _echo 1>&2 "ERROR" "$*" exit $exitval } @@ -581,6 +866,121 @@ err() # warn() { - logger "$0: WARNING: $*" - echo 1>&2 "$0: WARNING: $*" + _echo 1>&2 "WARNING" "$*" +} + +# +# info message +# Display informational message to stdout and log to syslog. +# +info() +{ + _echo "INFO" "$*" +} + +# +# debug message +# If debugging is enabled in rc.conf output message to stderr and syslog. +# BEWARE that you don't call any subroutine that itself calls this +# function. +# +debug() +{ + # This subroutine is provided as a convenience to script writers, who + # should enable debugging in /etc/rc.conf. + # + [ -f /etc/rc.conf ] && . /etc/rc.conf + + case ${rc_debug} in + [Yy][Ee][Ss]|[Tt][Rr][Uu][Ee]|[Oo][Nn]|1) + _echo 1>&2 "DEBUG" "$*" + return + ;; + esac +} + +# +# backup_file action file cur backup +# Make a backup copy of `file' into `cur', and save the previous +# version of `cur' as `backup' or use rcs for archiving. +# +# This routine checks the value of the backup_uses_rcs variable, +# which can be either YES or NO. +# +# The `action' keyword can be one of the following: +# +# add `file' is now being backed up (and is possibly +# being reentered into the backups system). `cur' +# is created and RCS files, if necessary, are +# created as well. +# +# update `file' has changed and needs to be backed up. +# If `cur' exists, it is copied to to `back' or +# checked into RCS (if the repository file is old), +# and then `file' is copied to `cur'. Another RCS +# check in done here if RCS is being used. +# +# remove `file' is no longer being tracked by the backups +# system. If RCS is not being used, `cur' is moved +# to `back', otherwise an empty file is checked in, +# and then `cur' is removed. +# +# +backup_file() +{ + _action=$1 + _file=$2 + _cur=$3 + _back=$4 + + if checkyesno backup_uses_rcs; then + _msg0="backup archive" + _msg1="update" + + # ensure that history file is not locked + if [ -f $_cur,v ]; then + rcs -q -u -U -M $_cur + fi + + # ensure after switching to rcs that the + # current backup is not lost + if [ -f $_cur ]; then + # no archive, or current newer than archive + if [ ! -f $_cur,v -o $_cur -nt $_cur,v ]; then + ci -q -f -u -t-"$_msg0" -m"$_msg1" $_cur + rcs -q -kb -U $_cur + co -q -f -u $_cur + fi + fi + + case $_action in + add|update) + cp -p $_file $_cur + ci -q -f -u -t-"$_msg0" -m"$_msg1" $_cur + rcs -q -kb -U $_cur + co -q -f -u $_cur + chown root:wheel $_cur $_cur,v + ;; + remove) + cp /dev/null $_cur + ci -q -f -u -t-"$_msg0" -m"$_msg1" $_cur + rcs -q -kb -U $_cur + chown root:wheel $_cur $_cur,v + rm $_cur + ;; + esac + else + case $_action in + add|update) + if [ -f $_cur ]; then + cp -p $_cur $_back + fi + cp -p $_file $_cur + chown root:wheel $_cur + ;; + remove) + mv -f $_cur $_back + ;; + esac + fi }