Bug#427475: Fwd: Re: the hibernate script
cg
Version: 1.94-2
Severity: wishlist
----- Forwarded message from cg <nam...@gmx.net> -----
Date: Tue, 29 May 2007 22:08:50 +0200
To: martin f krafft <mad...@debian.org>
Subject: Re: the hibernate script
X-Spam-Checker-Version: SpamAssassin 3.1.7 (2006-10-05) on
albatross.madduck.net
X-Spam-Level: ***
X-Spam-Status: No, score=3.5 required=5.0 tests=BAYES_99 autolearn=disabled
version=3.1.7
User-Agent: Mutt/1.5.13 (2006-08-11)
Hello Martin,
Thanks for the previous response.
I got hibernate working under acpid by creating the LockXtrlock()
function in the lock script and by adding Windowmaker to the long
pidof list in the FindXServer() function of the hibernate script.
This hack is (at least) useful to me ; please consider committing it
to the build if you think it might be generally useful. Thanks again
for the guidance and prodding.
I've attached the hibernate and lock scripts.
Best wishes & kind regards,
cg
On 28-05-07 20:58, martin f krafft wrote:
> also sprach cg <nam...@gmx.net> [2007.05.28.1839 +0200]:
> > When hibernate-ram is executed from the command line xtrlock works
> > fine ; when hibernate-ram is attached to the acpi lid switch routine
> > it bombs ; the hibernate log indicates that xtrlock has been executed
> > as specified (it bombs quietly) ; the acpid log says "xtrlock (version
> > 2.0): cannot open display" ; seems a sequencing issue of some sort ;
> > definitely a question for the list ...
>
> No, this is an authentication issue as the acpi script is being
> called by root without authorisation to the X display. Check how the
> xscreensaver scriptlet does things:
>
> /usr/share/hibernate/scriptlets.d/lock
>
#!/bin/sh
# -*- sh -*-
# vim:ft=sh:ts=8:sw=4:noet
#
# Hibernate Script
# Copyright (C) 2004-2006 Bernard Blackham <ber...@blackham.com.au>
#
# The hibernate-script package is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2, or (at your option) any later
# version.
#
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
# details.
#
# You should have received a copy of the GNU General Public License along with
# this program. If not, write to the Free Software Foundation, Inc., 59 Temple
# Place - Suite 330, Boston, MA 02111-1307, USA.
#
umask 077
USING_ZSH=
USING_BASH=
NEED_POSIX=
# For zsh sanity...
# allows splitting strings on whitespace in zsh.
setopt SH_WORD_SPLIT 2>/dev/null && USING_ZSH=1 || true
# allows sourced files to know they're sourced in zsh.
unsetopt FUNCTION_ARGZERO 2>/dev/null || true
# Detect bash and tell it not to be POSIX, because we like it better that way.
shopt > /dev/null 2>&1 && USING_BASH=1
[ -n "$USING_BASH" ] && set +o posix 2>/dev/null
[ -z "$USING_BASH$USING_ZSH" ] && NEED_POSIX=1
# We prefer to use dash if we've got it.
if [ -z "$NEED_POSIX" ] && [ -z "$TRIED_DASH" ] &&
command -v dash > /dev/null 2>&1 ; then
if [ "`basename $0`" = "$0" ] ; then
myself=`command -v $0` || myself=
elif [ -x "$0" ] ; then
myself=$0
fi
TRIED_DASH=1
export TRIED_DASH
[ -n "$myself" ] && exec dash $myself $*
fi
unset TRIED_DASH
SWSUSP_D="/etc/hibernate"
SCRIPTLET_PATH="$SWSUSP_D/scriptlets.d /usr/local/share/hibernate/scriptlets.d /usr/share/hibernate/scriptlets.d"
DEFAULT_CONFIG_FILE="$SWSUSP_D/hibernate.conf"
EXE=`basename $0`
VERSION="1.93"
# Add these to the $PATH just in case.
PATH="$PATH:/sbin:/usr/sbin:/usr/local/sbin"
export PATH
# vecho N <echo params>: acts like echo but with verbosity control - If it's
# high enough to go to stdout, then it'll get logged as well. Else write it to
# the log file if it needs to. Otherwise, ignore it.
vecho() {
local v
v="$1"
shift
[ "x$LOG_TIMESTAMP" = "x1" ] && set -- $(date "+%b %e %H:%M:%S.%2N") "$@"
if [ "$v" -le $VERBOSITY ] ; then
echo $@
else
if [ "$v" -le $LOG_VERBOSITY -a "$LOGPIPE" != "cat" ] ; then
echo "$@" | $LOGPIPE > /dev/null
fi
fi
}
# vcat N <cat params>: acts like cat but with verbosity control - If it's
# high enough to go to stdout, then it'll get logged as well. Else write it to
# the log file if it needs to. Otherwise, ignore it.
vcat() {
local v
v="$1"
shift
if [ "$v" -le $VERBOSITY ] ; then
cat $@
else
if [ "$v" -le $LOG_VERBOSITY -a "$LOGPIPE" != "cat" ] ; then
cat $@ | $LOGPIPE > /dev/null
fi
fi
}
##############################################################################
### The following functions can be called safely from within scriptlets ######
##############################################################################
# AddSuspendHook NN name: Adds a function to the suspend chain. NN must be a
# number between 00 and 99, inclusive. Smaller numbers get called earlier on
# suspend.
AddSuspendHook() {
SUSPEND_BITS="$1$2\\n$SUSPEND_BITS"
}
SUSPEND_BITS=""
# AddResumeHook NN name: Adds a function to the resume chain. NN must be a number
# between 00 and 99, inclusive. Smaller numbers get called later on resume.
AddResumeHook() {
RESUME_BITS="$1$2\\n$RESUME_BITS"
}
RESUME_BITS=""
# AddConfigHandler <function name>: adds the given function to the chain of
# functions to handle extra configuration options.
AddConfigHandler() {
CONFIG_OPTION_HANDLERS="$CONFIG_OPTION_HANDLERS $1"
}
CONFIG_OPTION_HANDLERS=""
# AddOptionHandler <function name>: adds the given function to the chain of
# functions to handle extra command line options. The scriptlet must also
# register the options with AddShortOption or AddLongOption
AddOptionHandler() {
CMDLINE_OPTION_HANDLERS="$CMDLINE_OPTION_HANDLERS $1"
}
CMDLINE_OPTION_HANDLERS=""
# AddShortOption <option char>: adds the given option character to the
# list of possible short options. The option may be followed by : or ::
# (: for a mandatory parameter, :: for an optional parameter)
AddShortOption() {
EXTRA_SHORT_OPTS="$EXTRA_SHORT_OPTS$1"
}
EXTRA_SHORT_OPTS=""
# AddLongOption <option char>: adds the given option character to the
# list of possible long options. The option may be followed by : or ::
# (: for a mandatory parameter, :: for an optional parameter)
AddLongOption() {
EXTRA_LONG_OPTS="$EXTRA_LONG_OPTS,$1"
}
EXTRA_LONG_OPTS=""
# AddOptionHelp <option name> <option help>: Adds the given option name and
# help text to the help screen.
AddOptionHelp() {
[ -n "$DISABLE_HELP" ] && return
local ATEXT
local BIT
local WRAPPED_HELP
ATEXT=" $1"
[ -n "$CURRENT_SOURCED_SCRIPTLET" ] && ATEXT=`LeftRightPadText "$ATEXT" "[$CURRENT_SOURCED_SCRIPTLET]"`
WRAPPED_HELP="`echo \"$2\" | WrapHelpText`"
ATEXT="$ATEXT
$WRAPPED_HELP
"
CMDLINE_OPTIONS_HELP="$CMDLINE_OPTIONS_HELP$ATEXT"
}
CMDLINE_OPTIONS_HELP=""
# AddConfigHelp <item name> <item help>: Deprecated. We no longer write
# config help in --help
AddConfigHelp() {
return 0
}
## martin, have included WindowMaker in the long pidof list below ; works for me ;
## please consider committing the change ... thanks for the guidance & prodding,
## cg
# FindXServer: Tries to find a running X server on the system. If one is found,
# will set DISPLAY, XAUTHORITY and the XUSER variable, and return 0.
# Otherwise, returns 1.
FindXServer() {
[ -n "$FIND_X_SERVER_RESULT" ] && return $FIND_X_SERVER_RESULT
[ -z "$DISPLAY" ] && DISPLAY=:0
export DISPLAY
# See if we need to authenticate to this X server.
PATH=$PATH:/usr/bin/X11:/usr/X11R6/bin
export PATH
xhost=`command -v xhost 2>/dev/null`
if [ $? -ne 0 ] ; then
vecho 0 "$EXE: Could not find xhost program. Disabling X scriptlets."
FIND_X_SERVER_RESULT=1
return 1
fi
# Find a useful XAUTHORITY and ideally a username too if we can!
local xuser xauth xpid
for display in $(seq 0 8); do
xuser=$(last ":$display" | grep 'still logged in' | awk '{print $1}') || true
if [ -n "$xuser" ]; then
xhome=$(getent passwd "$xuser" | cut -d: -f 6)
if [ -n "$xhome" ]; then
xauth=$xhome/.Xauthority
fi
fi
if [ -z "$xhome" ] || [ -z "$xauth" ]; then
xauth=
xuser=
xhome=
else
break
fi
done
if [ -z $xuser ] ; then
for xpid in `pidof WindowMaker kwrapper ksmserver kdeinit gnome-session fvwm fvwm2 pwm blackbox fluxbox X XFree86 Xorg` ; do
# Ensure the process still exists, and we aren't hallucinating.
[ -d "/proc/$xpid/" ] || continue
xauth=`awk 'BEGIN{RS="\\000";FS="="}($1 == "XAUTHORITY"){print $2}' < /proc/$xpid/environ`
xhome=`awk 'BEGIN{RS="\\000";FS="="}($1 == "HOME"){print $2}' < /proc/$xpid/environ`
xuser=`/bin/ls -ld /proc/$xpid/ | awk '{print $3}'`
[ -z $xauth ] && [ -n $xhome ] && [ -f $xhome/.Xauthority ] && xauth=$xhome/.Xauthority
XAUTHORITY=$xauth su $xuser -c "$xhost" > /dev/null 2>&1 && break
xauth=
xuser=
done
fi
if [ -n $xuser ] ; then
XUSER=$xuser
if [ -n "$xauth" ] ; then
XAUTHORITY=$xauth
export XAUTHORITY
fi
else
FIND_X_SERVER_RESULT=1
vecho 0 "$EXE: Could not attach to X server on $DISPLAY. Disabling X scriptlets."
return 1
fi
FIND_X_SERVER_RESULT=0
return 0
}
# UsingSuspendMethod <method name>: is called when a suspend method is chosen.
# If a suspend method has already been chosen, the hibernate script will be
# terminated with an error.
UsingSuspendMethod() {
if [ -n "$HIBERNATE_SUSPEND_METHOD" ] ; then
vecho 0 "$EXE: More than one suspend method has been chosen."
vecho 0 "Please edit your config file so only one method is used."
exit 1
fi
HIBERNATE_SUSPEND_METHOD=$1
return 0
}
##############################################################################
### Helper functions ###
##############################################################################
# SortSuspendBits: Returns a list of functions registered in the correct order
# to call for suspending, prefixed by their position number in the suspend
# chain.
SortSuspendBits() {
# explicit path required to be ash compatible.
/bin/echo -ne "$SUSPEND_BITS" | sort -n
}
# SortResumeBits: Returns a list of functions registered in the correct order
# to call for resuming, prefixed by their position number.
SortResumeBits() {
# explicit path required to be ash compatible.
/bin/echo -ne "$RESUME_BITS" | sort -rn
}
# WrapHelpText: takes text from stdin, wraps it with an indent of 5 and width
# of 70, and writes to stdout.
WrapHelpText() {
awk '
BEGIN {
indent=5
width=70
ORS=""
}
{
if (substr($0, 1, 1) == " ")
for(a=1;a<length($0);a++) {
if (substr($0,a,1) != " ") break
print " "
}
curpos=0
for (i=1; i <= NF; i++) {
if ($i != "" && i == 1) {
for (j=0; j < indent; j++) { print " " }
}
if (curpos + length($i) > width) {
curpos=0
print "\n"
for (j=0; j < indent; j++) { print " " }
}
print $i " "
curpos = curpos + length($i) + 1
}
print "\n"
}
END {
print "\n"
}
'
}
# LeftRightPadText <left> <right>": returns a string comprised of the two
# arguments with padding in between to make the string 78 characters long.
LeftRightPadText() {
(echo "$1" ; echo "$2") | awk '
BEGIN {
OFS=""; ORS="";
getline
print
a=78-length()
getline
for(a-=length(); a>=0; a--) {print " "}
print
}'
}
# PluginConfigOption <params>: queries all loaded scriptlets if they want to
# handle the given option. Returns 0 if the option was handled, 1 otherwise.
PluginConfigOption() {
local i
for i in $CONFIG_OPTION_HANDLERS ; do
$i $@ && return 0
done
return 1
}
# EnsureHavePrerequisites: makes sure we have all the required utilities to run
# the script. It exits the script if we don't.
EnsureHavePrerequisites() {
local i
for i in awk grep sort getopt basename chvt ; do
if ! command -v $i > /dev/null; then
vecho 0 "Could not find required program \"$i\". Aborting."
exit 1
fi
done
# Improvise printf using awk if need be.
if ! command -v printf > /dev/null 2>&1 ; then
# This implementation fails on strings that contain double quotes.
# It does the job for the help screen at least.
printf() {
local AWK_FMT
local AWK_PARAMS
AWK_FMT="$1"
shift
AWK_PARAMS=""
for i in "$@" ; do
AWK_PARAMS="$AWK_PARAMS, \"$i\""
done
awk "BEGIN { printf ( \"$AWK_FMT\" $AWK_PARAMS ) }"
}
fi
# Improvise mktemp in case we need it too!
if ! command -v mktemp > /dev/null 2>&1 ; then
# Use a relatively safe equivalent of mktemp. Still suspectible to race
# conditions, but highly unlikely.
mktemp() {
local CNT
local D
local FN
CNT=1
while true ; do
D=`date +%s`
FN=/tmp/tmp.hibernate.$$$D$RANDOM$RANDOM$CNT
[ -f $FN ] && continue
touch $FN && break
CNT=$(($CNT+1))
done
echo $FN
}
fi
return 0
}
# Usage: dump the abridged usage options to stdout.
Usage() {
cat <<EOT
Usage: $EXE [options]
Activates software suspend and control its parameters.
$CMDLINE_OPTIONS_HELP
For configuration file options for hibernate.conf, man hibernate.conf.
Hibernate Script $VERSION (C) 2004-2006 Bernard Blackham
EOT
return
}
# PluginGetOpt <params>: pass the given params to each scriplet in turn that
# requested parameters until one accepts them. Return 0 if a scriplet did
# accept them, and 1 otherwise.
PluginGetOpt() {
local opthandler
for opthandler in $CMDLINE_OPTION_HANDLERS ; do
$opthandler $* && return 0
done
return 1
}
# DoGetOpt <getopt output>: consume getopt output and set options accordingly.
DoGetOpt() {
local opt
local optdata
while [ -n "$*" ] ; do
opt="$1"
shift
case $opt in
-F|--config-file)
# Dealt with previously
shift
;;
-f|--force)
FORCE_ALL=1
;;
-k|--kill)
KILL_PROGRAMS=1
;;
--dry-run)
OPT_DRY_RUN=1
;;
-v|--verbosity)
OPT_VERBOSITY="${1#\'}"
OPT_VERBOSITY="${OPT_VERBOSITY%\'}"
EnsureNumeric "verbosity" $OPT_VERBOSITY && VERBOSITY="$OPT_VERBOSITY"
shift
;;
-q)
;;
--)
;;
*)
# Pass off to scriptlets See if there's a parameter given.
case $1 in
-*)
optdata=""
;;
*)
optdata=${1#\'}
optdata=${optdata%\'}
shift
esac
if ! PluginGetOpt $opt $optdata ; then
echo "Unknown option $opt on command line!"
exit 1
fi
;;
esac
done
}
# ParseOptions <options>: process all the command-line options given
ParseOptions() {
local opts
opts="`getopt -n \"$EXE\" -o \"Vhfksv:nqF:$EXTRA_SHORT_OPTS\" -l \"help,force,kill,verbosity:,dry-run,config-file:,version$EXTRA_LONG_OPTS\" -- \"$@\"`" || exit 1
DoGetOpt $opts
}
# CheckImplicitAlternateConfig <$0> : checks $0 to see if we should be
# implicitly using a different configuration file.
CheckImplicitAlternateConfig() {
# Don't find one if we've already been specified one.
[ -n "$CONFIG_FILE" ] && return 0
local self
self=`basename $0`
case $self in
hibernate-*)
CONFIG_FILE="$SWSUSP_D/${self#hibernate-}.conf"
vecho 3 "$EXE: Using implicit configuration file $CONFIG_FILE"
;;
*)
CONFIG_FILE="${DEFAULT_CONFIG_FILE}"
;;
esac
return 0
}
# PreliminaryGetopt <options> : detects a few command-line options that need to
# be dealt with before scriptlets and before other command-line options.
PreliminaryGetopt() {
local opt
set -- `getopt -q -o hv:F: -l help,verbosity:,config-file:,version -- "$@"`
while [ -n "$*" ] ; do
opt="$1"
shift
case $opt in
-h|--help) HELP_ONLY=1 ;;
-F|--config-file)
CONFIG_FILE="${1#\'}"
CONFIG_FILE="${CONFIG_FILE%\'}"
;;
-v|--verbosity)
OPT_VERBOSITY="${1#\'}"
OPT_VERBOSITY="${OPT_VERBOSITY%\'}"
EnsureNumeric "verbosity" $OPT_VERBOSITY && VERBOSITY="$OPT_VERBOSITY"
shift
;;
--version)
echo "Hibernate Script $VERSION"
exit 0
;;
--) return 0 ;;
esac
done
return 0
}
# LoadScriptlets: sources all scriptlets in $SCRIPTLET_PATH directories
LoadScriptlets() {
local prev_pwd
local scriptlet
local scriptlet_name
local scriptlet_dir
local prev_path
CURRENT_SOURCED_SCRIPTLET=""
for scriptlet_dir in $SCRIPTLET_PATH ; do
[ -d "$scriptlet_dir" ] || continue
[ -z "`/bin/ls -1 $scriptlet_dir`" ] && continue
for scriptlet in $scriptlet_dir/* ; do
# Avoid editor backup files.
case "$scriptlet" in *~|*.bak) continue ;; esac
# Don't source a scriptlet by name more than once.
scriptlet_name="`basename $scriptlet`"
eval "prev_path=\"\${HAVE_SOURCED_SCRIPTLET_$scriptlet_name}\""
if [ -n "$prev_path" ] ; then
vecho 0 "$EXE: Scriptlet $scriptlet_name exists in both $scriptlet and $prev_path"
vecho 0 "$EXE: Cowardly refusing to load $scriptlet_name a second time."
continue
fi
eval "HAVE_SOURCED_SCRIPTLET_$scriptlet_name=$scriptlet"
# And now source it!
CURRENT_SOURCED_SCRIPTLET="$scriptlet_name"
. $scriptlet
done
done
if [ -z "$CURRENT_SOURCED_SCRIPTLET" ] ; then
echo "WARNING: No directories in scriptlet search path contained any scriptlets."
echo "Hence, this script probably won't do anything."
return 0
fi
CURRENT_SOURCED_SCRIPTLET=""
}
# BoolIsOn <option> <value>: converts a "boolean" to either 1 or 0, and takes
# into account yes/no, on/off, 1/0, etc. If it is not valid, it will complain
# about the option and exit. Note, the *opposite* is actually returned, as true
# is considered 0 in shell world.
BoolIsOn() {
local val
val=`echo $2|tr '[A-Z]' '[a-z]'`
[ "$val" = "on" ] && return 0
[ "$val" = "off" ] && return 1
[ "$val" = "true" ] && return 0
[ "$val" = "false" ] && return 1
[ "$val" = "yes" ] && return 0
[ "$val" = "no" ] && return 1
[ "$val" = "1" ] && return 0
[ "$val" = "0" ] && return 1
echo "$EXE: Invalid boolean value ($2) for option $1 in configuration file"
exit 1
}
IsANumber() {
case "$1" in *[!0-9]*|"") return 1 ;; esac
return 0
}
EnsureNumeric() {
IsANumber "$2" && return 0
echo "$EXE: Invalid numeric value ($2) for option $1 in configuration file"
exit 1
}
# ProcessConfigOption: takes a configuration option and its parameters and
# passes it out to the relevant scriptlet.
ProcessConfigOption() {
local option
local params
option=`echo $1|tr '[A-Z]' '[a-z]'`
shift
params="$@"
case $option in
alwaysforce)
[ -z "$FORCE_ALL" ] &&
BoolIsOn "$option" "$params" && FORCE_ALL=1
;;
alwayskill)
[ -z "$KILL_PROGRAMS" ] &&
BoolIsOn "$option" "$params" && KILL_PROGRAMS=1
;;
logfile)
[ -z "$LOGFILE" ] &&
LOGFILE="$params"
;;
logtimestamp)
if BoolIsOn "$option" "$params" ; then
LOG_TIMESTAMP=1
else
LOG_TIMESTAMP=0
fi
;;
logverbosity)
EnsureNumeric "$option" "$params" && LOG_VERBOSITY="$params"
;;
swsuspvt|hibernatevt)
EnsureNumeric "$option" "$params" && SWSUSPVT="$params"
;;
verbosity)
[ -z "$OPT_VERBOSITY" ] && EnsureNumeric "$option" "$params" &&
VERBOSITY="$params"
;;
distribution)
[ -z "$DISTRIBUTION" ] && DISTRIBUTION=`echo $params | tr '[A-Z]' '[a-z]'`
;;
xdisplay)
DISPLAY="$params"
export DISPLAY
;;
include)
vecho 3 "$EXE: Including configuration from $params"
if ! ReadConfigFile "$params" ; then
echo "$EXE: Unable to read configuration file $params (from Include directive)."
exit 1
fi
;;
trymethod)
if [ -z "$HIBERNATE_SUSPEND_METHOD" ] ; then
NO_COMPLAIN_UNSUPPORTED=1
vecho 1 "$EXE: Trying method in $1..."
if ! ReadConfigFile "$params" ; then
echo "$EXE: Unable to read configuration file $params (from TryMethod directive)."
fi
NO_COMPLAIN_UNSUPPORTED=
fi
;;
*)
if ! PluginConfigOption $option $params ; then
# See if we're trying something new, and haven't yet got a suspend method
if [ -n "$NO_COMPLAIN_UNSUPPORTED" ] && [ -z "$HIBERNATE_SUSPEND_METHOD" ] ; then
return 1
else
echo "$EXE: Unknown configuration option ($option)"
exit 1
fi
fi
;;
esac
return 0
}
# ReadConfigFile: reads in a configuration file from stdin and sets the
# appropriate variables in the script. Returns 0 on success, exits on errors
ReadConfigFile() {
local option params
local file_name="$1"
if [ ! -f "${file_name}" ] ; then
# Search in /etc/hibernate
if [ -f "$SWSUSP_D/$file_name" ] ; then
file_name="$SWSUSP_D/$file_name"
else
echo "WARNING: No configuration file found (${file_name})."
echo "This script probably won't do anything."
return 1
fi
fi
while true ; do
# Doing the read this way allows means we don't require a new-line
# at the end of the file.
read option params
[ $? -ne 0 ] && [ -z "$option" ] && break
[ -z "$option" ] && continue
case $option in ""|\#*) continue ;; esac # avoids a function call (big speed hit)
ProcessConfigOption $option $params || break
done < ${file_name}
return 0
}
# AddInbuiltHelp: Documents the above in-built options.
AddInbuiltHelp() {
AddOptionHelp "-h, --help" "Shows this help screen."
AddOptionHelp "--version" "Shows the Hibernate Script version."
AddOptionHelp "-f, --force" "Ignore errors and suspend anyway."
AddOptionHelp "-k, --kill" "Kill processes if needed, in order to suspend."
AddOptionHelp "-v<n>, --verbosity=<n>" "Change verbosity level (0 = errors only, 3 = verbose, 4 = debug)"
AddOptionHelp "-F<file>, --config-file=<file>" "Use the given configuration file instead of the default ($CONFIG_FILE)"
AddOptionHelp "--dry-run" "Don't actually do anything."
AddConfigHelp "HibernateVT N" "If specified, output from the suspend script is redirected to the given VT instead of stdout."
AddConfigHelp "Verbosity N" "Determines how verbose the output from the suspend script should be:
0: silent except for errors
1: print steps
2: print steps in detail
3: print steps in lots of detail
4: print out every command executed (uses -x)"
AddConfigHelp "LogFile <filename>" "If specified, output from the suspend script will also be redirected to this file - useful for debugging purposes."
AddConfigHelp "LogTimestamp <boolean>" "If logging to file, will place timestamps on each log entry. This is only recommended if you are trying to optimise suspend/resume time, otherwise it will just slow the process down."
AddConfigHelp "LogVerbosity N" "Same as Verbosity, but controls what is written to the logfile."
AddConfigHelp "AlwaysForce <boolean>" "If set to yes, the script will always run as if --force had been passed."
AddConfigHelp "AlwaysKill <boolean>" "If set to yes, the script will always run as if --kill had been passed."
AddConfigHelp "Distribution <debian|fedora|mandrake|redhat|gentoo|suse|slackware>" "If specified, tweaks some scriptlets to be more integrated with the given distribution."
AddConfigHelp "Include <filename>" "Immediately include configuration directives from the given file."
AddConfigHelp "XDisplay <display location>" "Specifies where scriptlets that use the X server should find one. (Default: :0)"
}
EnsureHaveRoot() {
if [ x"`id -u`" != "x0" ] ; then
echo "$EXE: You need to run this script as root."
exit 1
fi
return 0
}
# DoWork: Does the actual calling of scriptlet functions. We wrap this to make
# it easy to decide whether or not to pipe its output to $LOGPIPE or not.
DoWork() {
# Trap Ctrl+C
trap ctrlc_handler INT HUP
# Do everything we need to do to suspend. If anything fails, we don't
# suspend. Suspend itself should be the last one in the sequence.
local ret
local CHAIN_UP_TO
local bit
CHAIN_UP_TO=0
for bit in `SortSuspendBits` ; do
local new_CHAIN_UP_TO
new_CHAIN_UP_TO="`awk \"BEGIN{print substr(\\\"$bit\\\", 1, 2)}\"`" || break
[ -n "$new_CHAIN_UP_TO" ] && CHAIN_UP_TO=$new_CHAIN_UP_TO || continue
bit=${bit##$CHAIN_UP_TO}
vecho 1 "$EXE: [$CHAIN_UP_TO] Executing $bit ... "
[ -n "$OPT_DRY_RUN" ] && continue
$bit
ret="$?"
# A return value >= 2 denotes we can't go any further, even with --force.
if [ $ret -ge 2 ] ; then
# If the return value is 3 or higher, be silent.
if [ $ret -eq 2 ] ; then
vecho 1 "$EXE: $bit refuses to let us continue."
vecho 0 "$EXE: Aborting."
EXIT_CODE=2
fi
break
fi
# A return value of 1 means we can't go any further unless --force is used
if [ $ret -gt 0 ] && [ x"$FORCE_ALL" != "x1" ] ; then
vecho 0 "$EXE: Aborting suspend due to errors in $bit (use --force to override)."
EXIT_CODE=2
break
fi
if [ -n "$SUSPEND_ABORT" ] ; then
vecho 0 "$EXE: Suspend aborted by user."
EXIT_CODE=3
break
fi
done
# Resume and cleanup and stuff.
for bit in `SortResumeBits` ; do
THIS_POS="`awk \"BEGIN{print substr(\\\"$bit\\\", 1, 2)}\"`"
[ -z "$THIS_POS" ] && continue
bit=${bit##$THIS_POS}
[ "$THIS_POS" -gt "$CHAIN_UP_TO" ] && continue
vecho 1 "$EXE: [$THIS_POS] Executing $bit ... "
[ -n "$OPT_DRY_RUN" ] && continue
$bit
done
return $EXIT_CODE
}
ctrlc_handler() {
SUSPEND_ABORT=1
}
############################### MAIN #########################################
# Some starting values:
VERBOSITY=0
LOG_VERBOSITY=1
LOGPIPE="cat"
ERROR_TEXT=""
EnsureHavePrerequisites
# Test for options that will affect future choices
PreliminaryGetopt "$@"
CheckImplicitAlternateConfig $0
# Generating help text is slow. Avoid it if we can.
if [ -n "$HELP_ONLY" ] ; then
AddInbuiltHelp
LoadScriptlets
Usage
exit 0
fi
DISABLE_HELP=1
EnsureHaveRoot
LoadScriptlets
ReadConfigFile "${CONFIG_FILE}"
# Verify we actually got a suspend method we could use.
if [ -z "$HIBERNATE_SUSPEND_METHOD" ] ; then
echo "$EXE: No suitable suspend methods were found on your machine."
echo "$EXE: You need to install a kernel with support for suspending to"
echo "$EXE: disk or RAM and reboot, then try again."
exit 1
fi
ParseOptions "$@"
# Set a logfile if we need one.
if [ -n "$LOGFILE" ]; then
if [ ! -f "$LOGFILE" ]; then
touch "$LOGFILE"
chmod 644 "$LOGFILE"
chown root:adm "$LOGFILE"
fi
LOGPIPE="tee -a -i $LOGFILE"
fi
# Redirect everything to a given VT if we've been given one
if [ -n "$SWSUSPVT" ] && [ -c /dev/tty$SWSUSPVT ] ; then
exec >/dev/tty$SWSUSPVT 2>&1
fi
# Use -x if we're being really verbose!
[ $VERBOSITY -ge 4 ] && set -x
echo "Starting suspend at "`date` | $LOGPIPE > /dev/null
EXIT_CODE=0
if [ "$LOGPIPE" = "cat" ] ; then
DoWork
else
# Sigh. Our portable way to obtain exit codes has issues in bash, so if
# we're using bash, we do it the not-so-portable way :)
if [ -n "$USING_BASH" ] ; then
DoWork | $LOGPIPE
eval 'EXIT_CODE=${PIPESTATUS[0]}'
else
# Evilness required to pass the exit code back to us in a pipe.
trap "" INT
exec 3>&1
eval `
exec 4>&1 >&3 3>&-
{
DoWork 4>&-
echo "EXIT_CODE=$EXIT_CODE" >&4
} | $LOGPIPE`
fi
fi
echo "Resumed at "`date` | $LOGPIPE > /dev/null
exit $EXIT_CODE
# $Id: hibernate.sh 1052 2006-07-12 10:15:00Z bernard $
# -*- sh -*-
# vim:ft=sh:ts=8:sw=4:noet
AddConfigHandler LockOptions
AddConfigHelp "LockKDE <boolean>" "Lock all local KDE sessions before suspending."
AddConfigHelp "LockXScreenSaver <boolean>" "Lock all local X11 sessions with xscreensaver running before suspending."
AddConfigHelp "LockGnomeScreenSaver <boolean>" "Lock all local X11 sessions with gnome-screensaver running before suspending."
AddConfigHelp "LockXLock <boolean>" "Lock active X11 session using xlock."
AddConfigHelp "LockXAutoLock <boolean>" "Lock all local X11 sessions running xautolock."
AddConfigHelp "LockConsoleAs <username>" "Locks the entire system after resuming, requiring you to enter either <username>'s or root's password to unlock it. (Requires vlock)."
AddConfigHelp "LockXtrLock <boolean>" "Lock active X11 session using xtrlock."
AddOptionHandler LockCmdlineOptions
AddLongOption 'lock-console-as:'
AddOptionHelp '--lock-console-as <username>' 'Uses vlock to lock the entire system after resuming, requirng you to enter the password for the given user to unlock it. This overrides any username given in the configuration file. (Requires vlock)'
LockKDE() {
[ x"$LOCK_KDE" != "x1" ] && return 0
if ! ps ax | grep -q '[d]copserver' ; then
vecho 1 'No KDE sessions detected. Not locking KDE.'
return 0
fi
if ! command -v dcop > /dev/null 2>&1 ; then
# Gentoo and Slackware stash this in a silly place.
for i in /usr/kde/*/bin/dcop /opt/kde/bin/dcop ; do
if [ -x "$i" ] ; then
PATH=$PATH:${i%%/dcop}
export PATH
break
fi
done
fi
if ! command -v dcop > /dev/null 2>&1 ; then
vecho 0 'Cannot lock KDE. `dcop` program not found.'
return 1 # abort, unless forced
fi
local avail_sessions
local session
# get all sessions (ignore non local ones!)
avail_sessions=`dcop --all-users --list-sessions | grep '.DCOP.*__0'`
# send the lock command to all sessions
for session in $avail_sessions; do
# Check first that the session is not already locked, to prevent dcop
# from hanging.
locked=`dcop --session "$session" --all-users kdesktop KScreensaverIface isBlanked 2>/dev/null`
if [ x"$locked" = "xfalse" ] ; then
vecho 1 "Locking session $session"
# /dev/null because dcop warns if it can't connect to X (this is normal!)
dcop --session "$session" --all-users kdesktop KScreensaverIface lock > /dev/null 2>&1
else
vecho 2 "Session $session is already locked!"
fi
done
# returning 0 because dcop warns if it can't connect to X (this is normal!)
return 0
}
LockXlock() {
FindXServer || return 0
if command -v xlock > /dev/null 2>&1 ; then
vecho 1 'Trying xlock'
su $XUSER -c "xlock -mode blank &"
return 0
fi
return 0
}
LockXScreensaver() {
local locked_one
locked_one=
[ x"$LOCK_XSCREENSAVER" != "x1" ] && return 0
if ! command -v xscreensaver-command > /dev/null 2>&1 ; then
vecho 0 'Cannot lock with xscreensaver. `xscreensaver-command` not found.'
# Try xlock.
LockXlock
return 0
fi
local xpid
for xpid in `pidof xscreensaver` ; do
local xuser xdisp xauth xhome
xuser=$(awk 'BEGIN{RS="\\000";FS="="}($1 == "USER"){print $2}' < /proc/$xpid/environ)
xdisp=$(awk 'BEGIN{RS="\\000";FS="="}($1 == "DISPLAY"){print $2}' < /proc/$xpid/environ)
xauth=$(awk 'BEGIN{RS="\\000";FS="="}($1 == "XAUTHORITY"){print $2}' < /proc/$xpid/environ)
if [ -z "$xauth" ] ; then
xhome=$(awk 'BEGIN{RS="\\000";FS="="}($1 == "HOME"){print $2}' < /proc/$xpid/environ)
xauth="$xhome/.Xauthority"
fi
vecho 2 "Locking $xuser's xscreensaver on display $xdisp using authority file $xauth"
DISPLAY=$xdisp XAUTHORITY=$xauth su $xuser -c "$(command -v xscreensaver-command) -lock"
if [ $? -ne 0 ] ; then
vecho 0 "Failed to activate xscreensaver on $xdisp using authority file $xauth."
DISPLAY=$xdisp XAUTHORITY=$xauth LockXlock && locked_one=1
else
locked_one=1
fi
done
# Fall back to xlock if nothing worked.
[ -z "$locked_one" ] && LockXlock
# Failing is silly. What would they do about it?
return 0
}
UnlockXScreensaver() {
# This function name is kind of bad, it doesn't actually unlock
# anything. It just calls xscreensaver-command -deactivate, which makes
# the password prompt appear on the display.
# FIXME: refactor this code so it looks less obviously like a
# cut-n-paste job from LockXScreensaver.
[ x"$LOCK_XSCREENSAVER" != "x1" ] && return 0
command -v xscreensaver-command > /dev/null 2>&1 || return
local xpid
for xpid in `pidof xscreensaver` ; do
local xuser xdisp xauth xhome
xuser=$(awk 'BEGIN{RS="\\000";FS="="}($1 == "USER"){print $2}' < /proc/$xpid/environ)
xdisp=$(awk 'BEGIN{RS="\\000";FS="="}($1 == "DISPLAY"){print $2}' < /proc/$xpid/environ)
xauth=$(awk 'BEGIN{RS="\\000";FS="="}($1 == "XAUTHORITY"){print $2}' < /proc/$xpid/environ)
if [ -z "$xauth" ] ; then
xhome=$(awk 'BEGIN{RS="\\000";FS="="}($1 == "HOME"){print $2}' < /proc/$xpid/environ)
xauth="$xhome/.Xauthority"
fi
vecho 2 "Unlocking $xuser's xscreensaver on display $xdisp using authority file $xauth"
DISPLAY=$xdisp XAUTHORITY=$xauth su $xuser -c "$(command -v xscreensaver-command) -deactivate"
done
# Failing is silly. What would they do about it?
return 0
}
LockGnomeScreensaver() {
local locked_one
locked_one=
[ x"$LOCK_GNOMESCREENSAVER" != "x1" ] && return 0
if ! command -v gnome-screensaver-command > /dev/null 2>&1 ; then
vecho 0 'Cannot lock with gnome-screensaver. `gnome-screensaver-command` not found.'
# Try xlock.
LockXlock
return 0
fi
local xpid
for xpid in `pidof gnome-screensaver` ; do
local xuser xdisp xauth xhome xdbus
xuser=$(awk 'BEGIN{RS="\\000";FS="="}($1 == "USER"){print $2}' < /proc/$xpid/environ)
xdisp=$(awk 'BEGIN{RS="\\000";FS="="}($1 == "DISPLAY"){print $2}' < /proc/$xpid/environ)
xauth=$(awk 'BEGIN{RS="\\000";FS="="}($1 == "XAUTHORITY"){print $2}' < /proc/$xpid/environ)
xdbus=$(awk 'BEGIN{RS="\\000";FS="="}($1 == "DBUS_SESSION_BUS_ADDRESS"){print $2"="$3"="$4}' < /proc/$xpid/environ)
if [ -z "$xauth" ] ; then
xhome=$(awk 'BEGIN{RS="\\000";FS="="}($1 == "HOME"){print $2}' < /proc/$xpid/environ)
xauth="$xhome/.Xauthority"
fi
vecho 2 "Locking $xuser's gnome-screensaver on display $xdisp using authority file $xauth"
DISPLAY=$xdisp XAUTHORITY=$xauth DBUS_SESSION_BUS_ADDRESS=$xdbus su $xuser -c "$(command -v gnome-screensaver-command) --lock"
if [ $? -ne 0 ] ; then
vecho 0 "Failed to activate gnome-screensaver on $xdisp using authority file $xauth."
DISPLAY=$xdisp XAUTHORITY=$xauth LockXlock && locked_one=1
else
locked_one=1
fi
done
# Fall back to xlock if nothing worked.
[ -z "$locked_one" ] && LockXlock
# Failing is silly. What would they do about it?
return 0
}
UnlockGnomeScreensaver() {
# This function name is kind of bad, it doesn't actually unlock
# anything. It just calls gnome-screensaver-command --poke, which makes
# the password prompt appear on the display.
# FIXME: refactor this code so it looks less obviously like a
# cut-n-paste job from LockXScreensaver :) .
[ x"$LOCK_GNOMESCREENSAVER" != "x1" ] && return 0
command -v gnome-screensaver-command > /dev/null 2>&1 || return
local xpid
for xpid in `pidof gnome-screensaver` ; do
local xuser xdisp xauth xhome xdbus
xuser=$(awk 'BEGIN{RS="\\000";FS="="}($1 == "USER"){print $2}' < /proc/$xpid/environ)
xdisp=$(awk 'BEGIN{RS="\\000";FS="="}($1 == "DISPLAY"){print $2}' < /proc/$xpid/environ)
xauth=$(awk 'BEGIN{RS="\\000";FS="="}($1 == "XAUTHORITY"){print $2}' < /proc/$xpid/environ)
xdbus=$(awk 'BEGIN{RS="\\000";FS="="}($1 == "DBUS_SESSION_BUS_ADDRESS"){print $2"="$3"="$4}' < /proc/$xpid/environ)
if [ -z "$xauth" ] ; then
xhome=$(awk 'BEGIN{RS="\\000";FS="="}($1 == "HOME"){print $2}' < /proc/$xpid/environ)
xauth="$xhome/.Xauthority"
fi
vecho 2 "Unlocking $xuser's gnome-screensaver on display $xdisp using authority file $xauth"
DISPLAY=$xdisp XAUTHORITY=$xauth DBUS_SESSION_BUS_ADDRESS=$xdbus su $xuser -c "$(command -v gnome-screensaver-command) --poke"
done
# Failing is silly. What would they do about it?
return 0
}
LockXAutoLock() {
[ x"$LOCK_XAUTOLOCK" != "x1" ] && return 0
if ! command -v xautolock > /dev/null 2>&1 ; then
vecho 0 'Cannot lock with xautolock. `xautolock` not found.'
return
fi
local xpid
for xpid in `pidof xautolock` ; do
local xuser xdisp xauth xhome
xuser=$(awk 'BEGIN{RS="\\000";FS="="}($1 == "USER"){print $2}' < /proc/$xpid/environ)
xdisp=$(awk 'BEGIN{RS="\\000";FS="="}($1 == "DISPLAY"){print $2}' < /proc/$xpid/environ)
xauth=$(awk 'BEGIN{RS="\\000";FS="="}($1 == "XAUTHORITY"){print $2}' < /proc/$xpid/environ)
if [ -z "$xauth" ] ; then
xhome=$(awk 'BEGIN{RS="\\000";FS="="}($1 == "HOME"){print $2}' < /proc/$xpid/environ)
xauth="$xhome/.Xauthority"
fi
vecho 2 "Locking $xuser's xautolock on display $xdisp using authority file $xauth"
DISPLAY=$xdisp XAUTHORITY=$xauth su $xuser -c "xautolock -locknow"
done
# Failing is silly. What would they do about it?
return 0
}
LockConsole() {
# Prerequistes are tested for in SwitchToLockConsole
[ -z "$LOCK_CONSOLE_USER" ] && return 0
# Use vlock to lock all consoles. We must already be at the given console.
vecho 1 "Locking all consoles"
openvt -wfc $LOCK_DEST_VT -- su - "$LOCK_CONSOLE_USER" -c "TERM=linux tput clear; vlock -a"
# This will hang until the root password is entered.
# Switch back to original console
vecho 3 "lock: changing console back to $LOCK_ORIGINAL_VT"
chvt $LOCK_ORIGINAL_VT
}
SwitchToLockConsole() {
[ -z "$LOCK_CONSOLE_USER" ] && return 0
if ! command -v openvt > /dev/null 2>&1 ; then
vecho 0 'Cannot lock console. `openvt` program not found.'
LOCK_CONSOLE_USER=
return 1 # abort, unless forced
fi
if ! command -v tput > /dev/null 2>&1 ; then
vecho 0 'Cannot lock console. `tput` program not found.'
LOCK_CONSOLE_USER=
return 1 # abort, unless forced
fi
if ! command -v vlock > /dev/null 2>&1 ; then
vecho 0 'Cannot lock console. `vlock` program not found.'
LOCK_CONSOLE_USER=
return 1 # abort, unless forced
fi
if command -v fgconsole > /dev/null 2>&1 ; then
LOCK_ORIGINAL_VT=`fgconsole`
else
LOCK_ORIGINAL_VT=1
fi
LOCK_DEST_VT=61 # Choose something different - can't afford to have silent bootsplash there
vecho 2 "lock: changing console from $LOCK_ORIGINAL_VT to $LOCK_DEST_VT"
chvt $LOCK_DEST_VT || return 1
return 0
}
LockXtrlock() {
FindXServer || return 0
if command -v xtrlock > /dev/null 2>&1 ; then
vecho 1 'Trying xtrlock'
#vecho 1 "xdisp=$xdisp"
#vecho 1 "xhome=$xhome"
#vecho 1 "DISPLAY=$DISPLAY"
#vecho 1 "XAUTHORITY=$XAUTHORITY"
#vecho 1 "XUSER=$XUSER"
#vecho 1 "xhome=$xhome"
#vecho 1 "xuser=$xuser"
#vecho 1 "xauth=$xauth"
## martin, this now works after i included 'WindowMaker' (which i use)
## in the list of window managers, etc. in the FindXServer() function
## of the hibernate script
##
## best regards -- cg
## somehow the xdisp & xauth & xuser vars are clobbered
## by the time they reach here (or not exported ?)
local xdisp xuser xauth
xdisp=$DISPLAY
if [ -n "$XUSER" ] && [ -n "$XAUTHORITY" ] ; then
xuser=$XUSER
xauth=$XAUTHORITY
elif [ -n "$xhome" ] ; then
xuser=$(basename $xhome)
xauth=$xhome/.Xauthority
else
return 0
fi
vecho 2 "Locking ${xuser}'s xtrlock on display $xdisp using authority file $xauth"
DISPLAY=$xdisp XAUTHORITY=$xauth su $xuser -c "xtrlock &"
if [ $? -ne 0 ] ; then
vecho 0 "Failed to activate ${xuser}'s xtrlock on $xdisp using authority file $xauth."
fi
return 0
fi
return 0
}
LockOptions() {
case $1 in
lockkde)
if BoolIsOn "$1" "$2" ; then
LOCK_KDE=1
if [ -z "$KDELOCK_HOOKED" ] ; then
AddSuspendHook 91 LockKDE
KDELOCK_HOOKED=1
fi
else
LOCK_KDE=0
fi
;;
lockxscreensaver)
if BoolIsOn "$1" "$2" ; then
LOCK_XSCREENSAVER=1
if [ -z "$XSCREENSAVERLOCK_HOOKED" ]; then
AddSuspendHook 91 LockXScreensaver
AddResumeHook 30 UnlockXScreensaver
XSCREENSAVERLOCK_HOOKED=1
fi
else
LOCK_XSCREENSAVER=0
fi
;;
lockgnomescreensaver)
if BoolIsOn "$1" "$2" ; then
LOCK_GNOMESCREENSAVER=1
if [ -z "$GNOMESCREENSAVERLOCK_HOOKED" ]; then
AddSuspendHook 91 LockGnomeScreensaver
AddResumeHook 30 UnlockGnomeScreensaver
GNOMESCREENSAVERLOCK_HOOKED=1
fi
else
LOCK_GNOMESCREENSAVER=0
fi
;;
lockxlock)
if BoolIsOn "$1" "$2" ; then
LOCK_XLOCK=1
if [ -z "$XLOCK_HOOKED" ]; then
AddResumeHook 91 LockXlock
XLOCK_HOOKED=1
fi
else
LOCK_XLOCK=0
fi
;;
lockxautolock)
if BoolIsOn "$1" "$2" ; then
LOCK_XAUTOLOCK=1
if [ -z "$XAUTOLOCK_HOOKED" ]; then
AddResumeHook 91 LockXAutoLock
XAUTOLOCK_HOOKED=1
fi
else
LOCK_XAUTOLOCK=0
fi
;;
lockconsoleas)
LOCK_CONSOLE_USER="$2"
if [ -z "$CONSOLELOCK_HOOKED" ] ; then
AddResumeHook 96 LockConsole
AddSuspendHook 96 SwitchToLockConsole
CONSOLELOCK_HOOKED=1
fi
;;
lockxtrlock)
if BoolIsOn "$1" "$2" ; then
LOCK_XTRLOCK=1
if [ -z "$XTRLOCK_HOOKED" ]; then
AddResumeHook 91 LockXtrlock
XTRLOCK_HOOKED=1
fi
else
LOCK_XTRLOCK=0
fi
;;
*)
return 1
esac
return 0
}
LockCmdlineOptions() {
case $1 in
--lock-console-as)
LOCK_CONSOLE_USER="$2"
if [ -z "$CONSOLELOCK_HOOKED" ] ; then
AddResumeHook 96 LockConsole
AddSuspendHook 96 SwitchToLockConsole
CONSOLELOCK_HOOKED=1
fi
;;
*)
return 1
esac
return 0
}
# $Id: lock 1064 2006-07-20 14:07:21Z bernard $
----- End forwarded message -----
--
.''`. martin f. krafft <mad...@debian.org>
: :' : proud Debian developer, author, administrator, and user
`. `'` http://people.debian.org/~madduck - http://debiansystem.info
`- Debian - when you have better things to do than fixing systems
"it is impossible to foresee the consequences of being clever."
-- cristopher strachey
--
To UNSUBSCRIBE, email to debian-bugs-...@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listm...@lists.debian.org