postrun revision 8282
5372N/A#!/bin/ksh
5372N/A#
5372N/A# Script for starting a postponed post-installation command in
5372N/A# a Live-Upgrade-safe environment
5372N/A#
5372N/A# CDDL HEADER START
5372N/A#
5372N/A# The contents of this file are subject to the terms of the
5372N/A# Common Development and Distribution License, Version 1.0 only
5372N/A# (the "License"). You may not use this file except in compliance
5372N/A# with the License.
5372N/A#
5372N/A# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
5372N/A# or http://www.opensolaris.org/os/licensing.
5372N/A# See the License for the specific language governing permissions
5372N/A# and limitations under the License.
5372N/A#
5372N/A# When distributing Covered Code, include this CDDL HEADER in each
5372N/A# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
5372N/A# If applicable, add the following below this CDDL HEADER, with the
5372N/A# fields enclosed by brackets "[]" replaced with your own identifying
5372N/A# information: Portions Copyright [yyyy] [name of copyright owner]
5372N/A#
5372N/A# CDDL HEADER END
5372N/A#
5372N/A#
5372N/A# Copyright 2004-2005 Sun Microsystems, Inc. All rights reserved.
5372N/A# Use is subject to license terms.
5372N/A#
5372N/A
5372N/Aexport PATH=/usr/bin
5372N/ALC_ALL=C
5372N/Aexport LC_ALL
5372N/AMYDIR=$(cd $(dirname $0); pwd)
5372N/ASPOOLDIR="$MYDIR/../../var/spool/postrun"
5372N/ALOCKFILE="$SPOOLDIR/.lock"
5372N/ALOGFILE="$MYDIR/../../var/log/postrun.log"
5372N/ASEQFILE="$SPOOLDIR/.seq"
5372N/A
5372N/Aid | grep " euid=" && \
5372N/A myuid=`id | sed -e 's/.* euid=\([0-9][0-9]*\).*$/\1/'` || \
5372N/A myuid=`id | sed -e 's/uid=\([0-9][0-9]*\).*/\1/'`
5372N/A
5372N/Aif [ "$myuid" != 0 ]; then
5372N/A echo "postrun: error: run this script as root"
5372N/A exit 1
5372N/Afi
5372N/A
5372N/Aumask 0133
5372N/A
5372N/Ausage() {
5372N/A echo 'Usage: postrun [options]'
5372N/A echo
5372N/A echo 'Options:'
5372N/A echo ' -u, --uniq'
5372N/A echo ' If the same command is requested multiple times, the command'
5386N/A echo ' is only run once. If it is safe to execute the command'
5372N/A echo ' immediately, it will be delayed by 5 minutes, or as set'
5372N/A echo ' using the --timeout option'
5372N/A echo
5372N/A echo ' -t <n>, --timeout <n>'
5372N/A echo ' Delay the execution of uniq commands by <n> minutes.'
5372N/A echo
5372N/A echo ' -b, --bg'
5372N/A echo ' Run the command in the background and return control'
5372N/A echo ' immediately'
5372N/A echo
5372N/A echo ' -f <file>'
5372N/A echo ' Read the commands from <file> instead of the standard'
5372N/A echo ' input.'
5372N/A echo
5372N/A echo ' -h, -?, --help'
5372N/A echo ' Display this help'
5372N/A exit 1
5385N/A}
5372N/A
5372N/Apostrun_debug() {
5372N/A if [ "x$POSTRUN_DEBUG" = xyes ]; then
5372N/A for msg in "${@}"; do
5372N/A echo '<POSTRUN_DEBUG>' "$msg" 1>&2
5372N/A done
5372N/A fi
5372N/A}
5372N/A
5372N/A#LOCK_UNLOCK_FUNCTIONS_START
5372N/Ais_number() {
5372N/A echo "$1" | egrep -vs '^[0-9]+$' && return 1
5385N/A echo "$1" | egrep -s '^[0-9]+$' || return 1
5385N/A return 0
5385N/A}
5385N/A
5372N/A# lock the postrun spool or log file
5372N/A# if $1 is 'log' then lock the log file, otherwise log the spool
5372N/Apostrun_lock() {
5401N/A this_lock=$LOCKFILE
5372N/A if [ "x$1" = xlog ]; then
5372N/A this_lock=${LOCKFILE}.log
5372N/A fi
5372N/A # lock file exists (contains the pid of the process that locked it)
5372N/A
5372N/A while test -f $this_lock; do
5372N/A # get the pid that holds the lock
5372N/A pid=`cat $this_lock 2>/dev/null` || continue
5372N/A # is the lock held by this process?
5372N/A test "$pid" == "$$" && return
5372N/A # check if the process is still running or else it's a stale lock
5372N/A is_number "$pid" && {
5372N/A ps -g $pid -o 'pid' | egrep -s "$pid\$" 2>&1 || {
5372N/A sleep 1
5372N/A postrun_lock $1
5372N/A return
5372N/A }
5372N/A }
5372N/A # we have a stale lock situation, let's try and take ownership
5372N/A # of the lock
5372N/A chmod 644 ${this_lock}
5372N/A echo "$$" > ${this_lock}
5372N/A chmod 444 ${this_lock}
5372N/A # if we successfully took ownership of the lock, this loop
5401N/A # will read our own pid back and return
5372N/A # otherwise
5372N/A done
5372N/A
5372N/A # create a read-only lock file
5372N/A umask 0333
5372N/A # run false so that we enter the while loop
5372N/A false
5372N/A while [ $? != 0 ]; do
5372N/A # write the pid to the lock file
5372N/A # recurse if failed. recursion here helps to avoid an infinite
5372N/A # loop -- ksh will kill the script after 128 attempts
echo "$$" > $this_lock || postrun_lock $1
# read it back in case another process also wrote its pid there
# in the meantime
pid=`cat $this_lock 2>/dev/null`
# the loop will restart is the file cannot be read
done
umask 0133
# check if this process holds the lock or else try the whole thing again
test "$pid" == "$$" || postrun_lock $1
}
# release the lock
# unlock the log file if $1 == 'log', unlock the spool otherwise
postrun_unlock() {
this_lock=$LOCKFILE
if [ "x$1" = xlog ]; then
this_lock=${LOCKFILE}.log
fi
if ! rm -f $this_lock; then
echo "postrun: error: cannot remove lock file $this_lock"
exit 1
fi
}
#LOCK_UNLOCK_FUNCTIONS_END
# get the next job id
postrun_get_seq() {
postrun_lock
seq=`cat $SEQFILE 2>/dev/null`
next_seq=$(($seq + 1))
echo $next_seq > $SEQFILE
postrun_unlock
echo $next_seq
}
postrun_spool_command() {
cd $SPOOLDIR
# check if there's already a spooled job for the same command
new_job=0
uniq_job_nr=
IFS=' '
postrun_lock
for f in *.cmd; do
test -f "$f" || continue
cmp -s $postrun_command_file $f && {
if [ $postrun_is_uniq = yes ]; then
uniq_job_nr=`basename $f .cmd`
break
fi
egrep -s '^uniq_command: yes' `basename $f .cmd`.ctrl && {
uniq_job_nr=`basename $f .cmd`
break
}
}
done
if [ "x$uniq_job_nr" != x ]; then
postrun_debug "matching spooled uniq job (#${uniq_job_nr}) found"
# we found a matching spooled uniq job
# all we need to do is update the uniq time and make sure it's
# flagged as a uniq job
new_job=1
#
# FIXME: shouldn't use sed for this, safer to simply append
# and process the duplicate entries when reading the file
#
sed -e 's/^uniq_command: .*/uniq_command: yes/' \
-e 's/^\(pkginst: .*\)/\1, '$PKGINST'/' \
-e 's/^uniq_time: .*/uniq_time: '`date +%Y.%m.%d.%H.%M.%S`'/' \
-e 's/^uniq_timeout: .*/uniq_timeout: '"$postrun_uniq_timeout"'/' \
$uniq_job_nr.ctrl > $uniq_job_nr.ctrl.new
#
# FIXME: add the user name to the control file
#
mv $uniq_job_nr.ctrl.new $uniq_job_nr.ctrl
else
postrun_unlock
job_seq=`postrun_get_seq`
postrun_debug "spooling command as job #${job_seq}"
postrun_lock
user_name=${EMAIL:-root}
ctrl_file="$SPOOLDIR/$job_seq.ctrl"
cmd_file="$SPOOLDIR/$job_seq.cmd"
cat $postrun_command_file > $cmd_file
cat /dev/null > $ctrl_file
echo "pkginst: $PKGINST" >> $ctrl_file
echo "submit_time: `date +%Y.%m.%d.%H.%M.%S`" >> $ctrl_file
echo "uniq_command: $postrun_is_uniq" >> $ctrl_file
echo "uniq_time: `date +%Y.%m.%d.%H.%M.%S`" >> $ctrl_file
echo "uniq_timeout: $postrun_uniq_timeout" >> $ctrl_file
echo "background: $postrun_bg_job" >> $ctrl_file
echo "user: $user_name" >> $ctrl_file
fi
postrun_unlock
return $new_job
}
postrun_run_command() {
cmdout=`mktemp /tmp/postrun.out.XXXX`
# create a background jobs script that executes the commands
# then locks the spool/log file and appends the output to the
# log file and finally unlocks
cmdfile=`mktemp /tmp/postrun.job.XXXX`
cat /dev/null > $cmdfile
cat /dev/null > $cmdout
echo '#!/bin/ksh' >> $cmdfile
# copy the postrun_lock and postrun_unlock commands from
# this script to the background job script
echo "LOCKFILE=$LOCKFILE" >> $cmdfile
sed -e '1,/#LOCK_UNLOCK_FUNCTIONS_START/d' \
-e '/#LOCK_UNLOCK_FUNCTIONS_END/,$d' $0 >> $cmdfile
# save the stdout file description
echo 'exec 3<&1' >> $cmdfile
echo "exec >> $cmdout 2>&1" >> $cmdfile
echo 'PATH=/usr/bin; export PATH' >> $cmdfile
echo 'echo Starting postrun job at `LC_ALL=C date`' >> $cmdfile
if [ "x$postrun_submit_time" != x ]; then
if [ $postrun_bg_job = yes ]; then
echo "echo 'This is a spooled background job (#${postrun_job_number})'" >> $cmdfile
else
echo "echo 'This is a spooled foreground job (#${postrun_job_number})'" >> $cmdfile
fi
echo "echo Job submitted by $postrun_pkginst at $postrun_submit_time" \
>> $cmdfile
else
if [ $postrun_bg_job = yes ]; then
echo 'echo This is an immediate background job' >> $cmdfile
else
echo 'echo This is an immediate foreground job' >> $cmdfile
fi
echo "echo Job submitted by $postrun_pkginst"\
>> $cmdfile
fi
echo 'echo Running commands:' >> $cmdfile
echo "echo '>>>' commands follow:" >> $cmdfile
cat $postrun_command_file | \
sed -e "s/'/'\"'\"'/g" | \
sed -e "s/^/echo '/" \
-e "s/\$/'/" >> $cmdfile
echo "echo '<<<' commands end" >> $cmdfile
echo "echo '>>>' Command output follows:" >> $cmdfile
echo "chmod 700 $postrun_command_file" >> $cmdfile
echo "$postrun_command_file" >> $cmdfile
#
# FIXME: send email to $postrun_user if the command failed
#
echo "echo '<<<' Command completed with exit status \$?" \
>> $cmdfile
echo 'echo Job finished at `LC_ALL=C date`' >> $cmdfile
echo 'echo --' >> $cmdfile
# restore PATH in case the command changed it
echo 'PATH=/usr/bin; export PATH' >> $cmdfile
# restore stdout
echo 'exec 1<&3' >> $cmdfile
# close file descriptor 3
echo 'exec 3<&-' >> $cmdfile
echo 'exec 2>&1' >> $cmdfile
# append the messages to the real log file
# need to lock the log file to avoid 2 postrun commands
# writing at the same time and messing up the log
echo 'postrun_lock log' >> $cmdfile
echo "cat $cmdout >> $LOGFILE" >> $cmdfile
echo 'postrun_unlock log' >> $cmdfile
echo "rm -f $cmdout" >> $cmdfile
echo "rm -f $cmdfile" >> $cmdfile
echo "rm -f $postrun_command_file" >> $cmdfile
chmod 700 $cmdfile
if [ $postrun_bg_job = yes ]; then
$cmdfile &
else
$cmdfile
fi
exitval=$?
}
username=${EMAIL:-root}
postrun_defaults() {
# default settings
postrun_pkginst="$PKGINST"
postrun_submit_time=''
postrun_uniq_time=''
postrun_is_uniq=no
postrun_uniq_timeout=5
postrun_bg_job=no
postrun_command_file=''
postrun_user=${username}
postrun_job_number='???'
postrun_alt_root_okay=no
}
# usage: is_leap_year yyyy
is_leap_year() {
cal 02 $1 | egrep -s 29 && return 0
return 1
}
# get_abstime yy mm dd hh mm ss
#
# prints the elapsed time in seconds since 1970.01.01.00.00.00
#Length of the months:
# JA FE MA AP MY JN JL AU SE OC NO DE
set -A MONTH 0 31 28 31 30 31 30 31 31 30 31 30 31
get_abstime() {
# the absolute time since 1970...
t=0
# number of years
t=$(($t + ($1 - 1970) * 31536000))
# add 1 day for each leap year
y=1972
end_y=$1
if [ $2 -lt 2 ]; then
end_y=$(($1 - 1))
fi
while [ $y -le $end_y ]; do
is_leap_year $y && t=$(($t + 86400))
y=$(($y + 4))
done
# number of months
m=1
while [ $m -lt $2 ]; do
t=$(($t + ${MONTH[$m]} * 86400))
m=$(($m + 1))
done
# number of days, hours, minutes and seconds:
echo $(($t + ($3 - 1) * 86400 + $4 * 3600 + $5 * 60 + $6))
}
# get_timediff: prints the difference in seconds between 2 time strings
# the time strings should be of the following format:
# YYYY.MM.DD.HH.MM.SS as printed by date +%Y.%m.%d.%H.%M.%S
#
# Works for dates after 1970.01.01.00.00.00
#
get_timediff() {
year1=$(expr "$1" : "^\([^.]*\)\..*")
month1=$(expr "$1" : "^[^.]*\.\([^.]*\)\..*")
day1=$(expr "$1" : "^[^.]*\.[^.]*\.\([^.]*\)\..*")
hour1=$(expr "$1" : "^[^.]*\.[^.]*\.[^.]*\.\([^.]*\)\..*")
min1=$(expr "$1" : "^[^.]*\.[^.]*\.[^.]*\.[^.]*\.\([^.]*\)\..*")
sec1=$(expr "$1" : "^[^.]*\.[^.]*\.[^.]*\.[^.]*\.[^.]*\.\([^.]*\)")
year2=$(expr "$2" : "^\([^.]*\)\..*")
month2=$(expr "$2" : "^[^.]*\.\([^.]*\)\..*")
day2=$(expr "$2" : "^[^.]*\.[^.]*\.\([^.]*\)\..*")
hour2=$(expr "$2" : "^[^.]*\.[^.]*\.[^.]*\.\([^.]*\)\..*")
min2=$(expr "$2" : "^[^.]*\.[^.]*\.[^.]*\.[^.]*\.\([^.]*\)\..*")
sec2=$(expr "$2" : "^[^.]*\.[^.]*\.[^.]*\.[^.]*\.[^.]*\.\([^.]*\)")
# calculate seconds since 1970.01.01.00.00.00
t1=`get_abstime $year1 $month1 $day1 $hour1 $min1 $sec1`
t2=`get_abstime $year2 $month2 $day2 $hour2 $min2 $sec2`
# print difference
expr $t1 - $t2
}
postrun_runq() {
cd $SPOOLDIR
IFS=' '
timeleft=0
postrun_lock
for job in *.ctrl; do
test -f "$job" || continue
postrun_defaults
while read var val; do
case "$var" in
pkginst: )
postrun_pkginst="$val"
;;
submit_time: )
postrun_submit_time="$val"
;;
uniq_command: )
postrun_is_uniq="$val"
;;
uniq_time: )
postrun_uniq_time="$val"
;;
uniq_timeout: )
postrun_uniq_timeout="$val"
;;
background: )
postrun_bg_job="$val"
;;
user: )
postrun_user="$val"
;;
* )
echo "postrun: WARNING: invalid setting in $job: $var"
;;
esac
done < $job
postrun_command_file=$SPOOLDIR/`basename $job .ctrl`.cmd
postrun_job_number=`basename $job .ctrl`
if [ $postrun_ignore_timeout = no ]; then
# if it's a uniq job, check if it timed out
if [ "x$postrun_is_uniq" = xyes ]; then
# calculate time difference (seconds)
tdiff=$(get_timediff $(date +%Y.%m.%d.%H.%M.%S) \
$postrun_uniq_time)
timeout_sec=$((postrun_uniq_timeout * 60))
if [ $tdiff -ge $timeout_sec ]; then
postrun_run_command
rm -f $job
else
# try again in at least $tdiff sec time
tl=$(($tdiff / 60 + 1))
if [ $tl -gt $timeleft ]; then
timeleft=$tl
fi
fi
else
postrun_run_command
rm -f $job
fi
else
# ignore timeout, just run the job
postrun_run_command
rm -f $job
fi
done
if [ $timeleft -gt 0 ]; then
echo "$MYDIR/postrun -q" |
at now "+${timeleft}minutes" \
> /dev/null 2>&1
fi
postrun_unlock
exit 0
}
postrun_defaults
exitval=0
postrun_ignore_timeout=no
if [ $# = 1 -a "x$1" = 'x-qf' ]; then
# postrun-runq mode (ignore timeout for uniq jobs, since this is
# expected to be run at system boot)
postrun_ignore_timeout=yes
postrun_runq
exit 1
fi
if [ $# = 1 -a "x$1" = 'x-q' ]; then
# postrun-runq mode, to be run from at(1)
postrun_runq
exit 1
fi
# process the command line
while [ $# -gt 0 ]; do
case "$1" in
-h|-\?|--help)
usage
;;
-u|--uniq)
postrun_is_uniq=yes
;;
-b|--bg)
postrun_bg_job=yes
;;
-t|--timeout)
opt="$1"
if [ $# == 0 ]; then
echo "postrun: error: argument expected after $opt"
exit 1
fi
shift
timeout=$1
if ! is_number "$timeout"; then
echo "postrun: error: interger number expected after $opt (found \"$timeout\")"
exit 1
fi
postrun_uniq_timeout=$timeout
;;
-f)
opt="$1"
if [ $# == 0 ]; then
echo "postrun: error: argument expected after $opt"
exit 1
fi
shift
postrun_command_file="$1"
;;
-a)
postrun_alt_root_okay=yes
;;
--)
break
;;
*)
echo "postrun: error: invalid argument: $1"
exit 1
;;
esac
shift
done
if [ "x$postrun_command_file" = x ]; then
# save the standard input in a temporary file
tmp_cmd_file=`mktemp /tmp/postrun.cmd.XXXX`
cat > $tmp_cmd_file
postrun_command_file=$tmp_cmd_file
fi
if [ "$LUBIN" != "" ]; then
#
# Live Upgrade. Unsafe to run the command now.
# Put into spool and defer to next boot.
#
postrun_spool_command "${@}"
elif [ "$PKG_INSTALL_ROOT" != "" -a "$PKG_INSTALL_ROOT" != "/" -a \
"x$postrun_alt_root_okay" != xyes ]; then
#
# Installation to an alternate root directory
# Put command into spool and defer to next boot.
#
postrun_spool_command "${@}"
else
#
# Local package install. Everything's shiny happy,
# safe to run the command right now
#
if [ $postrun_is_uniq = yes ]; then
# don't run the command yet in case the same command is requested
# within the next postrun_uniq_timeout minutes
postrun_spool_command "${@}" && {
echo "$MYDIR/postrun -q" | \
at now "+${postrun_uniq_timeout}minutes" > /dev/null 2>&1
}
else
postrun_debug "Executing commands immediately"
postrun_run_command "${@}"
# do not delete the tmp_cmd_file because it's the only copy of the
# commands (since the job is not spooled)
tmp_cmd_file=''
fi
fi
if [ "x$tmp_cmd_file" != x ]; then
rm -f $tmp_cmd_file
fi
exit $exitval