scripts/functions

   1 # $Id: functions 2531 2007-04-21 14:04:35Z dhozac $     --*- sh -*--
   2
   3 # Copyright (C) 2003,2004,2005,2006 Enrico Scholz <enrico.scholz@informatik.tu-chemnitz.de>
   4 #
   5 # This program is free software; you can redistribute it and/or modify
   6 # it under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; version 2 of the License.
   8 #
   9 # This program is distributed in the hope that it will be useful,
  10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 # GNU General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU General Public License
  15 # along with this program; if not, write to the Free Software
  16 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  17
  18 _VS_LOGFILE=
  19 _VS_ERRFILE=
  20
  21 _VS_NEWLINE='
  22 '
  23 declare -r _VS_NEWLINE=${_VS_NEWLINE:0-1}
  24 declare -r VS_ALLVSERVERS_ARGS=all,marked,unmarked,stopped,running
  25
  26 function findObject
  27 {
  28     local _fo_mod=$1
  29     local _fo_var=$2
  30     local _fo_file=
  31     local _fo_i=X
  32     shift 2
  33
  34     for _fo_i; do
  35         test -n "$_fo_i"         || continue
  36         test ! $_fo_mod "$_fo_i" || { _fo_file=$_fo_i; break; }
  37     done
  38
  39     test -z "$_fo_i" -o -n "$_fo_file" || {
  40         echo "Can not find file for '$_fo_var'; aborting"
  41         exit 1
  42     } >&2
  43
  44     eval "$_fo_var=\"$_fo_file\""
  45 }
  46
  47 function findFile
  48 {
  49     findObject -f "$@"
  50 }
  51
  52 function findDir
  53 {
  54     findObject -d "$@"
  55 }
  56
  57 function findAndCopy
  58 {
  59     local dst=$1
  60     test ! -s "$dst"         || return 0
  61
  62     local tmp
  63     shift
  64     findFile tmp "$@"
  65
  66     test -n "$tmp" -a -s "$tmp" || return 0
  67     $_CP -af "$tmp" "$dst"
  68 }
  69
  70 ## Usage: isRegularFile <filename> [<mod>]
  71 function isRegularFile
  72 {
  73     test ${2:--f} "$1" || return 1
  74
  75     case $1 in
  76         (*.rpmsave|*.rpmnew|*.rpmorig|*.cfsaved*|*.~*~) return 1;;
  77     esac
  78
  79     return 0
  80 }
  81
  82 function getPhysicalDir
  83 {
  84     ( set -P && cd "$1" && pwd )
  85 }
  86
  87 ## Usage:: isDirectoryEmpty <dir> [<ignore-lost+found>]
  88 function isDirectoryEmpty
  89 {
  90     (
  91         shopt -s dotglob  || *
  92         shopt -s nullglob || *
  93
  94         ignore_lostfound=1
  95         test -z "$2" -o "$2" = 0 || ignore_lostfound=
  96
  97         for i in "$1"/*; do
  98             case "$i" in
  99                 ($1/lost+found)
 100                     test "$ignore_lostfound" || exit 1
 101                     ;;
 102                 (*)     echo "$i"; exit 1
 103             esac
 104         done
 105
 106         exit 0
 107     )
 108 }
 109
 110 ## Usage: logging <message>
 111 function logging
 112 {
 113     if test -n "$_VS_LOGFILE"; then
 114         echo "$@" >>"$_VS_LOGFILE"
 115     else
 116         echo "$@"
 117     fi
 118 }
 119
 120 ## Usage: warning <message>
 121 function warning
 122 {
 123     if test -n "$_VS_ERRFILE"; then
 124         echo "$@" >>"$_VS_ERRFILE"
 125     else
 126         echo "$@" >&2
 127     fi
 128 }
 129
 130 ## Usage: panic <message>
 131 function panic
 132 {
 133     if test -n "$_VS_ERRFILE"; then
 134         echo "$@" >>"$_VS_ERRFILE"
 135     else
 136         echo "$@" >&2
 137     fi
 138
 139     exit 1
 140 }
 141
 142 ## Usage: execute <message>
 143 function execute
 144 {
 145     test -z "${DEBUG_EXEC:-}"       || echo "$@"
 146     test "${DEBUG_EXEC:-}" = noexec || exec "$@"
 147     exit 0
 148 }
 149
 150
 151 ## Usage: spawn <message>
 152 function spawn
 153 {
 154     test -z "${DEBUG_EXEC:-}"       || echo  "$@"
 155     test "${DEBUG_EXEC:-}" = noexec || "$@"
 156 }
 157
 158 ## Usage: isNumber <arg>
 159 function isNumber
 160 {
 161     local tmp
 162     let tmp=$1+0 2>/dev/null || test -z "${1//0/}" -a -n "$1" || return 1
 163     return 0
 164 }
 165
 166 ## Usage: hasSubstring <haystack> <needle>+
 167 function hasSubstring
 168 {
 169     local pat=$1
 170     local i
 171
 172     shift
 173
 174     for i; do
 175         test x"${pat/*$i*/$i}" = x"$i" || continue
 176         return 0
 177     done
 178
 179     return 1
 180 }
 181
 182 ## Usage: colorize <style> <command>
 183 function colorize
 184 {
 185     local       style=$1
 186     shift
 187
 188     if ! $_TTY -s; then
 189         "$@"
 190     else
 191         local   cfile
 192         findFile cfile "$__CONFDIR"/.defaults/styles/"$style" ''
 193         if test -n "$cfile"; then
 194           $_CAT "$cfile"
 195         else
 196           case "$style" in
 197             (bold)      echo -ne "\e[1m";;
 198             (emph)      echo -ne "\e[34m";;
 199             (info)      echo -ne "\e[0;34m";;
 200             (warn*)     echo -ne "\e[1;31m";;
 201             (error)     echo -ne "\e[1;33;41m";;
 202             (*)         ;;
 203           esac
 204         fi
 205
 206         ( "$@" )
 207         echo -ne "\e[m"
 208     fi
 209 }
 210
 211 function colpanic
 212 {
 213     if test -n "$_VS_ERRFILE"; then
 214         echo "$@" >>"$_VS_ERRFILE"
 215     else
 216         colorize error echo -n "$@" >&2
 217     fi
 218     echo
 219
 220     exit 1
 221 }
 222
 223 function colwarning
 224 {
 225     colorize warning warning "$@"
 226 }
 227
 228 function colinfo
 229 {
 230     colorize info    echo "$@"
 231 }
 232
 233
 234 ## Usage: xtermTitle <title>
 235 function xtermTitle
 236 {
 237     $_TTY -s || return 0
 238     echo -ne "\e]0;$@\007"
 239 }
 240
 241 _VS_LOCKS=''
 242 ## Usage: lock <lockfile> [<timeout>]
 243 function lock
 244 {
 245     local tmp=$($_MKTEMP vserver-lock.XXXXXX)
 246     $_RM -f $tmp
 247     $_MKFIFO -m600 $tmp
 248
 249     $_LOCKFILE "$1" $tmp $2 &
 250     $_GREP -q true $tmp 2>/dev/null || return 1
 251
 252     _VS_LOCKS="$! $_VS_LOCKS"
 253 }
 254
 255 ## Usage: unlock [<num>]
 256 function unlock
 257 {
 258     local num=$1
 259     local i
 260
 261     set -- $_VS_LOCKS
 262     while test "$#" -gt 0; do
 263         kill -HUP "$1" >/dev/null || :
 264         shift
 265         test "$num" != 1 || break
 266         test -z "$num"   || let --num
 267     done
 268     _VS_LOCKS="$@"
 269 }
 270
 271 function get_init_cwd
 272 {
 273     if test -n "$INIT_CWD"; then
 274         echo "$INIT_CWD"
 275     else
 276         pwd
 277     fi
 278 }
 279 function set_init_cwd
 280 {
 281     INIT_CWD="`pwd`"
 282     export INIT_CWD
 283 }
 284
 285 function _setVserverDir
 286 {
 287     local vserver="$1"
 288     case "$vserver" in
 289         ./*) VSERVER_DIR="`get_init_cwd`/$vserver";;
 290         /*)  VSERVER_DIR="$vserver"               ;;
 291         *)   VSERVER_DIR="$__CONFDIR/$vserver"    ;;
 292     esac
 293 }
 294
 295 function _setVserverName
 296 {
 297     if test -e "$VSERVER_DIR"/name; then
 298         read VSERVER_NAME <"$VSERVER_DIR"/name
 299     else
 300         VSERVER_NAME=$(basename "$VSERVER_DIR")
 301     fi
 302 }
 303
 304 function _pkgMountBindDir()
 305 {
 306     test "$1" != "$2" || return 0
 307
 308     $_MOUNT -n --bind "$1" "$2"
 309 }
 310
 311 function _pkgSetVarsBase
 312 {
 313     case "$vserver" in
 314         ./*|/*)
 315             if test -d "$vserver/vdir"; then
 316                 BASEDIR=$vserver
 317                 VDIR=$(getPhysicalDir "$vserver/vdir")
 318
 319                 PKGDIR=$BASEDIR/apps/pkgmgmt
 320                 test -d "$PKGDIR" || {
 321                     echo "Can not find configuration-directory for package-managment tools"
 322                     exit 1
 323                 } >&2
 324                 findDir EXECDIR      $PKGDIR/execdir     /
 325             else
 326                 VDIR=$(getPhysicalDir "$vserver")
 327                 PKGDIR=
 328             fi
 329             ;;
 330         *)
 331             BASEDIR=$__CONFDIR/$vserver
 332             test -d "$BASEDIR" || {
 333                 echo "Can not find configuration-directory"
 334                 exit 1
 335             } >&2
 336
 337             VDIR=$BASEDIR/vdir
 338             test -d "$VDIR"   || VDIR=$__DEFAULT_VSERVERDIR/$vserver
 339             VDIR=$(getPhysicalDir "$VDIR")
 340
 341             PKGDIR=$BASEDIR/apps/pkgmgmt
 342             test -d "$PKGDIR" || {
 343                 echo "Can not find configuration-directory for package-managment tools"
 344                 exit 1
 345             } >&2
 346
 347             findDir EXECDIR      $PKGDIR/execdir     /
 348
 349             ;;
 350     esac
 351
 352     if test -z "$WORKAROUND_106057"; then
 353         _rpmdb_mntpoint=/dev
 354     else
 355         _rpmdb_mntpoint=/.rpmdb
 356     fi
 357 }
 358
 359 function _pkgSetVarsRPM
 360 {
 361     if test -n "$PKGDIR"; then
 362         findDir RPMETCDIR    $PKGDIR/rpmetc      $PKGDIR/base/rpm/etc       /etc/rpm
 363         findDir RPMSTATEDIR  $PKGDIR/rpmstate    $PKGDIR/base/rpm/state
 364
 365         findDir RPMLIBDIR    $PKGDIR/rpmlib      /
 366
 367     else
 368         findDir RPMETCDIR    "$VDIR"/etc/rpm     /etc/rpm
 369         findDir RPMSTATEDIR  "$VDIR"/var/lib/rpm
 370         RPMLIBDIR=/
 371     fi
 372
 373     RPMSTATEDIR=$(getPhysicalDir "$RPMSTATEDIR")
 374     RPMETCDIR=$(getPhysicalDir "$RPMETCDIR")
 375 }
 376
 377 function _pkgSetVarsApt
 378 {
 379     if test -n "$PKGDIR"; then
 380         findDir APTETCDIR    $PKGDIR/aptetc      $PKGDIR/base/apt/etc       /etc/apt
 381         findDir APTSTATEDIR  $PKGDIR/aptstate    $PKGDIR/base/apt/state
 382         findDir APTCACHEDIR  $PKGDIR/aptcache    $PKGDIR/base/apt/cache
 383         findDir APTARCHIVDIR $PKGDIR/aptarchives $PKGDIR/base/apt/archives  /var/cache/apt/archives
 384     else
 385         findDir APTETCDIR    "$VDIR"/etc/apt            /etc/apt
 386         findDir APTSTATEDIR  "$VDIR"/var/state/apt
 387         findDir APTCACHEDIR  "$VDIR"/var/cache/apt
 388         findDir APTARCHIVDIR "$VDIR"/var/cache/apt/archives /var/cache/apt/archives
 389     fi
 390
 391     findFile APT_CONFIG "$APTETCDIR"/apt.conf ""
 392     test -z "$APT_CONFIG" || export APT_CONFIG
 393 }
 394
 395 function _pkgSetVarsYum
 396 {
 397     if test -n "$PKGDIR"; then
 398         findDir YUMETCDIR    $PKGDIR/yumetc      $PKGDIR/base/yum/etc       /etc
 399         findDir YUMCACHEDIR  $PKGDIR/yumcache    $PKGDIR/base/yum/cache
 400     else
 401         findDir YUMETCDIR    "$VDIR"/etc         /etc
 402         findDir YUMCACHEDIR  "$VDIR"/var/cache/yum
 403     fi
 404 }
 405
 406
 407 function _pkgMountBase
 408 {
 409     :
 410 }
 411
 412 function _pkgMountApt
 413 {
 414     :
 415 }
 416
 417 function _pkgMountYum
 418 {
 419     :
 420 }
 421
 422 function _pkgMountRPM
 423 {
 424     _pkgMountBindDir "$RPMETCDIR" /etc/rpm
 425     test "$RPMLIBDIR" = "/" || _pkgMountBindDir "$RPMLIBDIR" /usr/lib/rpm
 426
 427     pushd "$VDIR" >/dev/null
 428
 429     $_SECURE_MOUNT --chroot -n --bind "$RPMSTATEDIR" "$_rpmdb_mntpoint"
 430     test -z "$WORKAROUND_106057" || mount -n --bind "$RPMSTATEDIR" "$_rpmdb_mntpoint"
 431
 432     test -e "$VDIR"/proc/self/status || \
 433         $_SECURE_MOUNT --chroot -n -t proc none /proc
 434
 435     popd >/dev/null
 436 }
 437
 438 function _pkgSetEnvBase
 439 {
 440     test "$EXECDIR" = "/" || {
 441         PATH=$EXECDIR:$PATH
 442         LD_LIBRARY_PATH=$EXECDIR${LD_LIBRARY_PATH:+:$LD_LIBRARY_PATH}
 443     }
 444
 445     export PATH LD_LIBRARY_PATH
 446 }
 447
 448 function _pkgSetEnvApt
 449 {
 450     :
 451 }
 452
 453 function _pkgSetEnvYum
 454 {
 455     :
 456 }
 457
 458 function _pkgSetEnvRPM
 459 {
 460     CUR_VSERVER=$vserver
 461     RPM_FAKE_NAMESPACE_MOUNTS=$_rpmdb_mntpoint
 462     RPM_BINARY=$_VRPM_PRELOAD
 463
 464     export CUR_VSERVER RPM_FAKE_NAMESPACE_MOUNTS RPM_BINARY
 465 }
 466
 467 function pkgInit
 468 {
 469     local i
 470     local vserver=$1
 471     shift
 472
 473     _pkgSetVarsBase
 474     for i; do
 475         case "$i" in
 476             rpm)        _pkgSetVarsRPM;;
 477             apt)        _pkgSetVarsApt;;
 478             yum)        _pkgSetVarsYum;;
 479             *)          echo "Unknown packaging flavor" >&2; exit 1;;
 480         esac
 481     done
 482
 483     _pkgMountBase
 484     for i; do
 485         case "$i" in
 486             rpm)        _pkgMountRPM;;
 487             apt)        _pkgMountApt;;
 488             yum)        _pkgMountYum;;
 489         esac
 490     done
 491
 492     _pkgSetEnvBase
 493     for i; do
 494         case "$i" in
 495             rpm)        _pkgSetEnvRPM;;
 496             apt)        _pkgSetEnvApt;;
 497             yum)        _pkgSetEnvYum;;
 498         esac
 499     done
 500
 501     _PKG_FLAVORS="$@"
 502     _PKG_VSERVER=$vserver
 503 }
 504
 505 function isAvoidNamespace
 506 {
 507     local cfgdir
 508
 509     $_VSERVER_INFO - FEATURE namespace   || return 0
 510     cfgdir=$($_VSERVER_INFO "$1" CFGDIR) || return 0
 511     test ! -e "$cfgdir"/namespace        || return 1
 512     test -e "$__CONFDIR"/.defaults/nonamespace -o \
 513          -e "$cfgdir"/nonamespace
 514 }
 515
 516 function isNamespaceCleanup
 517 {
 518     local cfgdir
 519
 520     $_VSERVER_INFO - FEATURE namespace   || return 1
 521     cfgdir=$($_VSERVER_INFO "$1" CFGDIR) || return 1
 522     isAvoidNamespace "$1"                && return 1
 523     test -e "$cfgdir"/namespace-cleanup  && return 0
 524     test -e "$cfgdir"/nonamespace-cleanup -o \
 525          -e "$__CONFDIR"/.defaults/nonamespace-cleanup && return 1
 526     return 0
 527 }
 528
 529 ## Usage: getAllVservers <var> [<KIND>*]
 530 function getAllVservers
 531 {
 532     local _ga_i
 533     declare -a _ga_tmp=()
 534
 535     for _ga_i in $__CONFDIR/*; do
 536         isRegularFile "$_ga_i" -d   || continue
 537
 538         test ! -e "$_ga_i"/disabled || continue
 539         test   -d "$_ga_i"/vdir     || continue
 540
 541         local _ga_doadd=1
 542         local _ga_markfile=$_ga_i/apps/init/mark
 543
 544         case ${2:-ALL} in
 545             (MARKED)    test   -s "$_ga_markfile" || _ga_doadd=;;
 546             (UNMARKED)  test ! -s "$_ga_markfile" || _ga_doadd=;;
 547             (STOPPED)   ! $_VSERVER "$_ga_i" running &>/dev/null || _ga_doadd=;;
 548             (RUNNING)     $_VSERVER "$_ga_i" running &>/dev/null || _ga_doadd=;;
 549             (ALL)       ;;
 550             (*)         panic $"Unknown vserver tagging '$2'";;
 551         esac
 552
 553         test -z "$_ga_doadd" || _ga_tmp=( "${_ga_tmp[@]}" "${_ga_i##$__CONFDIR/}")
 554     done
 555
 556     eval $1='( "${_ga_tmp[@]}" )'
 557 }
 558
 559 ## Usage: getAllVserversByArg <var> <arg>
 560 function getAllVserversByArg
 561 {
 562     local _gav_mark=
 563
 564     case $2 in
 565         (--all)         _gav_mark=ALL;;
 566         (--marked)      _gav_mark=MARKED;;
 567         (--unmarked)    _gav_mark=UNMARKED;;
 568         (--stopped)     _gav_mark=STOPPED;;
 569         (--running)     _gav_mark=RUNNING;;
 570         (*)             return 1;;
 571     esac
 572
 573     getAllVservers "$1" "$_gav_mark"
 574 }
 575
 576 ## Usage: _getProcNumberCount <ctx> <var>
 577 function _getProcNumberCount
 578 {
 579     local _gp_var=$2
 580     local _gp_procnr_cnt=0
 581
 582     # Use /proc/virtual from kernel 2.6 when possible
 583     if test -d "/proc/virtual"; then
 584         set -- $($_GREP '^Tasks:' "/proc/virtual/$1/status" 2>/dev/null)
 585         _gp_procnr_cnt=$2
 586     else
 587         _gp_procnr_cnt=$($_VPS ax | $_AWK '{print $2}' | $_GREP -x "$1" | $_WC -l )
 588     fi
 589
 590     let _gp_procnr_cnt=_gp_procnr_cnt+0
 591     eval $_gp_var=\$_gp_procnr_cnt
 592 }
 593
 594 ## Usage: getVserverCtx <vdir> <result-varname> [<procnumber-varname> [<do-cleanup>]]
 595 ## Returns: 0 iff vserver is running
 596 function getVserverStatus
 597 {
 598     test -r "$1"/run || return 1
 599
 600     local _gvs_ctx
 601     read _gvs_ctx <"$1"/run
 602     eval "$2"=\$_gvs_ctx
 603
 604     test -n "$3"     || return 0
 605     local _gvs_tmp
 606     _getProcNumberCount "$_gvs_ctx" _gvs_tmp
 607     eval "$3"=\$_gvs_tmp
 608
 609     if test "$_gvs_tmp" = 0; then
 610         local runfile=$($_READLINK "$1/run")
 611         test -z "$4" || $_RM -f "$runfile"
 612         return 1
 613     fi
 614
 615     return 0
 616 }
 617
 618 ## Usage: isCtxRunning <ctx>
 619 function isCtxRunning
 620 {
 621     local _tmp
 622     _getProcNumberCount "$1" _tmp
 623     test $_tmp -gt 0
 624 }
 625
 626 ## Usage: isVserverRunning <vdir> [<ctx-varname>]
 627 function isVserverRunning
 628 {
 629     local _ivr_ctx _ivr_procnum
 630
 631     getVserverStatus "$1" _ivr_ctx _ivr_procnum 1 || return 1
 632     test "$_ivr_procnum" != 0                     || return 1
 633     test -z "$2" || eval "$2"=\$_ivr_ctx
 634     return 0
 635 }
 636
 637 ## Called as 'getFileValue <varname> <filename>+'
 638 function getFileValue
 639 {
 640     local _gfv_var=$1
 641     local _gfv_file
 642     shift
 643
 644     findFile _gfv_file "$@" ''
 645     test -n "$_gfv_file" -a -r "$_gfv_file" || return 0
 646     eval read "$_gfv_var" <"$_gfv_file"
 647 }
 648
 649 ## Called as 'getFileArray <varname> <filename>+'
 650 function getFileArray
 651 {
 652     local _gfa_var=$1
 653     local _gfa_file
 654     shift
 655
 656     findFile _gfa_file "$@" ''
 657     test -n "$_gfa_file" -a -r "$_gfa_file" || return 0
 658     local IFS=$_VS_NEWLINE
 659     eval "$_gfa_var"='( $(< "$_gfa_file") )'
 660 }
 661
 662 function checkComponents
 663 {
 664     local       i
 665     local       msg=$1
 666     local       x_failed=
 667
 668     shift
 669
 670     for i; do
 671         local failed=
 672         case "$i" in
 673             (core)      test -x "$_CHBIND"           || failed=1;;
 674             (build)     test -x "$_VSERVER_BUILD"    || failed=1;;
 675             (sysv)      test -x "$__INITRDDIR/vserver"    || failed=1;;
 676             (devel)     test -d "$__INCLUDEDIR/vserver.h" || failed=1;;
 677             (*)         echo "Unknown component '$i'" >&2
 678                         return false
 679                         ;;
 680         esac
 681
 682         test -z "$failed" || {
 683             echo "$msg: $i"
 684             x_failed=1
 685         } >&2
 686     done
 687
 688     test -z "$x_failed"
 689 }
 690
 691 ## Usage: isKernelAPI <ver> [<cmp-modifier>]
 692 function isKernelAPI
 693 {
 694     local api
 695     api=$($_VSERVER_INFO - APIVER) || api=0
 696     test $[ $api ] -${2:-ge} $[ $1 ]
 697 }
 698
 699 ## Usage: callInNamespace <vserver> <command> <args>*
 700 function callInNamespace
 701 {
 702     local ctx=
 703
 704     isAvoidNamespace "$1" || \
 705     ctx=$( $_VSERVER_INFO "$1" CONTEXT f ) || ctx=
 706
 707     shift
 708     if test -n "$ctx"; then
 709         $_VNAMESPACE --enter "$ctx" -- "$@"
 710     else
 711         "$@"
 712     fi
 713 }
 714
 715 ## Usage: setDefaultTTY <vdir> [<fallback-tty>]
 716 function setDefaultTTY
 717 {
 718     local cfgdir ttyname
 719
 720     cfgdir=$($_VSERVER_INFO "$1" APPDIR init) || cfgdir=
 721     findObject -e ttyname \
 722         ${cfgdir:+"$cfgdir"/tty} \
 723         "$__CONFDIR/.defaults/apps/init/tty" \
 724         $2 /dev/null
 725
 726     if test -f "$ttyname"; then
 727         exec </dev/null
 728     else
 729         exec <$ttyname
 730     fi
 731     exec    >>$ttyname 2>&1
 732 }
 733
 734 ## Usage: killContext <XID> [<SIG>]
 735 function killContext
 736 {
 737     local sig=${2:-9}
 738
 739     #$_VKILL -s STOP   --xid "$1" 1 &>/dev/null || :
 740     $_VKILL -s "$sig" --xid "$1" 1 &>/dev/null || :
 741     $_VKILL -s "$sig" --xid "$1"   &>/dev/null || :
 742     #$_VKILL -s "$sig" --xid "$1" 1 &>/dev/null || :
 743     #$_VKILL -s CONT   --xid "$1" 1 &>/dev/null || :
 744 }
 745
 746 function useVlogin
 747 {
 748     test ! -e "$__CONFDIR/.defaults/apps/vlogin/disable"
 749 }
 750
 751 ## Usage: pkgmgmt.guessStyle <vserver> <resultvar>
 752 function pkgmgmt.guessStyle()
 753 {
 754     local _pgs_vdir
 755     _pgs_vdir=$($_VSERVER_INFO "$1" VDIR) || {
 756         echo $"Can not determine vserver-root" >&2
 757         return 1
 758     }
 759     local _pgs_cfgdir=$($_VSERVER_INFO "$1" APPDIR pkgmgmt) || :
 760
 761     if test -n "$_pgs_cfgdir" -a -e "$_pgs_cfgdir"/style; then
 762         read style <"$_pgs_cfgdir"/style
 763     elif test -e "$_pgs_vdir"/etc/redhat-release -o -e "$_pgs_vdir"/etc/fedora-release; then
 764         style=redhat
 765     elif test -e "$_pgs_vdir"/etc/mandrake-release; then
 766         style=mandrake
 767     elif test -e "$_pgs_vdir"/etc/debian_version; then
 768         style=debian
 769     elif test -e "$_pgs_vdir"/etc/SuSE-release; then
 770         style=suse
 771     else
 772         echo $"Can not determine packagemanagement style" >&2
 773         return 1
 774     fi
 775
 776     eval $2=\$style
 777     return 0
 778 }
 779
 780 ## Usage: pkgmgmt.isInternal <vserver>
 781 ## returns true iff <vserver> is configured for internal packagemanagement
 782 ## A typical application is
 783 ## | is_external=
 784 ## | pkgmgmt.isInternal "$vserver" || is_external=1
 785 function pkgmgmt.isInternal
 786 {
 787     local cfgdir=$($_VSERVER_INFO "$1" APPDIR pkgmgmt) || :
 788
 789     test -z "$cfgdir" -o ! -d "$cfgdir" -o -e "$cfgdir"/internal
 790 }
 791
 792 ## Usage: pkgmgmt.isAptAvailable <cfgdir> <vdir> [<is-internal>]
 793 function pkgmgmt.isAptAvailable
 794 {
 795     local cfgdir="$1"
 796     local vdir="$2"
 797     local is_internal="$3"
 798
 799     local have_apt i
 800     if test -n "$is_internal"; then
 801         have_apt=1
 802         test -d "$cfgdir"/base/apt -o -d "$cfgdir"/aptetc || have_apt=
 803     else
 804         have_apt=
 805         for i in /bin /usr/bin /usr/local/bin; do
 806             test ! -x "$vdir$i"/apt-get || { have_apt=1; break; }
 807         done
 808     fi
 809
 810     test -n "$have_apt" && return 0 || return 1
 811 }
 812
 813 ## Usage: pkgmgmt.isYumAvailable <cfgdir> <vdir> [<is-internal>]
 814 function pkgmgmt.isYumAvailable
 815 {
 816     local cfgdir="$1"
 817     local vdir="$2"
 818     local is_internal="$3"
 819
 820     local have_yum i
 821     if test -n "$is_internal"; then
 822         have_yum=1
 823         test -d "$cfgdir"/base/yum -o -d "$cfgdir"/yumetc || have_yum=
 824     else
 825         have_yum=
 826         for i in /bin /usr/bin /usr/local/bin; do
 827             test ! -x "$vdir$i"/yum || { have_yum=1; break; }
 828         done
 829     fi
 830
 831     test -n "$have_yum" && return 0 || return 1
 832 }
 833
 834
 835 function vshelper.doSanityCheck
 836 {
 837     local vshelper this_xid i
 838     declare -a warnings=()
 839     local solution_disable=
 840     local solution_sysctl=
 841
 842     vshelper.isEnabled && vshelper.isEnabled warning || return 0
 843
 844     this_xid=$($_VSERVER_INFO - XID) ||
 845         panic $"Failed to determine current context; aborting..."
 846
 847     ## Do nothing in other xid's; the helper will be executed in xid 0 only
 848     test "$this_xid" = 0 || return 0
 849
 850     local proc_file=/proc/sys/kernel/vshelper
 851
 852     if ! test -r "$proc_file"; then
 853         vshelper=
 854         warnings=( "${warnings[@]}"
 855                    $"File '$proc_file' does not exist but is required for vshelper setup" )
 856         solution_disable=1
 857     else
 858         vshelper=$(cat "$proc_file")
 859
 860         $_CMP -s "$vshelper" "$_VSHELPER" || {
 861             local readable=""
 862             test -r "$vshelper" && readable=1
 863             warnings=( "${warnings[@]}"
 864                        $"The configured vshelper '$vshelper' does not match the 'vshelper'
 865   script of the util-vserver package.${readable:+ Maybe you have two versions installed?}"
 866                      )
 867             solution_disable=1
 868             solution_sysctl=1
 869         }
 870     fi
 871
 872     test -d "$__VSHELPERSTATEDIR" || {
 873         warnings=( "${warnings[@]}"
 874                    $"\
 875 The vshelper state-directory '$__VSHELPERSTATEDIR' does not exist; since
 876 it is created by 'make install', this indicates a serious problem with
 877 your util-vserver installation" )
 878         solution_disable=1
 879     }
 880
 881     test "${#warnings[@]}" -eq 0 || {
 882         warning $"\
 883 The following problem(s) were encountered while verifying vshelper
 884 functionality:"
 885
 886         for i in "${warnings[@]}"; do
 887             warning "* $i"
 888         done
 889
 890         warning $"\
 891
 892 To fix this, you can:"
 893
 894         test -z "$solution_disable" || warning $"\
 895 * disable vshelper entirely by executing
 896   | touch \"$__CONFDIR/.defaults/apps/vshelper/disabled\"
 897 * disable only this message by executing
 898   | touch \"$__CONFDIR/.defaults/apps/vshelper/warning-disabled\""
 899
 900         test -x "$solution_sysctl" || warning $"\
 901 * configure the util-vserver vshelper script, e.g. by adding
 902   | kernel.vshelper = $_VSHELPER
 903   to /etc/sysctl.conf and rebooting the machine, or by executing
 904   | echo \"$_VSHELPER\" >$proc_file"
 905
 906         warning ""
 907
 908         return 1
 909     }
 910
 911     return 0
 912 }
 913
 914 ## Usage: vshelper.isEnabled [<style>] [<vserver>]
 915 function vshelper.isEnabled
 916 {
 917     local f=${1:+$1-}disabled
 918     test ! -e "$__CONFDIR"/.defaults/apps/vshelper/"$f"     || return 1
 919     $_VSERVER_INFO - FEATURE vshelper                       || return 1
 920     if test -n "$2"; then
 921         local appdir
 922         appdir=$($_VSERVER_INFO "$2" APPDIR vshelper)       || return 0
 923         test -z "$2" -o ! -e "$appdir/$f"                   || return 1
 924     fi
 925
 926     return 0
 927 }
 928
 929 ## Usage: vshelper.isDebug [<vserver>]
 930 function vshelper.isDebug
 931 {
 932     test ! -e "$__CONFDIR"/.defaults/apps/vshelper/debug    || return 0
 933     $_VSERVER_INFO - FEATURE vshelper                       || return 1
 934     if test -n "$1"; then
 935         local appdir
 936         appdir=$($_VSERVER_INFO "$1" APPDIR vshelper)       || return 1
 937         test ! -e "$appdir/debug"                           || return 0
 938     fi
 939
 940     return 1
 941 }
 942
 943 function vshelper._getHandlerInternal
 944 {
 945     local _vghi_var=$1
 946     local _vghi_tmp
 947     shift
 948     shift       ## HACK: see below the note about the 'set -u' mode
 949
 950     while test "$#" -ge 2; do
 951         local _vghi_mod=$1
 952         local _vghi_obj=$2
 953         shift 2
 954
 955         test "$_vghi_mod" "$_vghi_obj" || continue
 956         case "$_vghi_mod" in
 957             (-x)
 958                 eval $_vghi_var=\$_vghi_obj
 959                 ;;
 960             (-e)
 961                 read _vghi_tmp <"$_vghi_obj"
 962                 eval $_vghi_var=:\$_vghi_tmp
 963                 ;;
 964             (*) panic $"Internal error, unexpected modifier '$_vghi_mod'"
 965         esac
 966         return 0
 967     done
 968
 969     return 1
 970 }
 971
 972 ## Usage: vshelper.getHandler <result-var> <vserver> <action>
 973 function vshelper.getHandler
 974 {
 975     local _vgh_appdir
 976     _vgh_appdir=$($_VSERVER_INFO "$2" APPDIR vshelper) || _vgh_appdir=
 977
 978     declare -a _vgh_search_list=( X )
 979     ## HACK: when we are in 'set -u' mode, empty lists are causing errors
 980
 981     test -z "$_vgh_appdir" || _vgh_search_list=( "${_vgh_search_list[@]}" -x "$_vgh_appdir/$3" )
 982     test -z "$_vgh_appdir" || _vgh_search_list=( "${_vgh_search_list[@]}" -e "$_vgh_appdir/action" )
 983     _vgh_search_list=( "${_vgh_search_list[@]}" -x "$__CONFDIR"/.defaults/apps/vshelper/"$3" )
 984     _vgh_search_list=( "${_vgh_search_list[@]}" -e "$__CONFDIR"/.defaults/apps/vshelper/action )
 985
 986     ! vshelper._getHandlerInternal "$1" "${_vgh_search_list[@]}" || return 0
 987     eval $1=':restart'
 988 }
 989
 990 ## Usage: vshelper.init <vserver> [<method> <args>*]
 991 function vshelper.doInit
 992 {
 993     vshelper.isEnabled || return 0
 994
 995     local xid
 996     xid=$($_VSERVER_INFO "$1" CONTEXT false) && test -n "$xid" || {
 997         warning $"vshelper.init: can not determine xid of vserver '$vserver'; returned value was '$xid'"
 998         return 1
 999     }
1000
1001     local f="$__VSHELPERSTATEDIR/$xid"
1002
1003     set -C
1004     $_RM -f "$f"
1005     echo "$1" >"$f"
1006     set +C
1007
1008     if test -n "$2"; then
1009         shift 1
1010         local i
1011         for i; do
1012             echo "$i"
1013         done
1014     else
1015         echo "default"
1016     fi >>"$f"
1017
1018     return 0
1019 }
1020
1021 ## Usage: vshelper.doDestroy <vserver> <xid>
1022 function vshelper.doDestroy
1023 {
1024     vshelper.isEnabled || return 0
1025
1026     $_RM -f "$__VSHELPERSTATEDIR/$2"
1027 }
1028
1029 ## Usage: vshelper.initSync <vserver> <pipe-varname> [<method>]
1030 function vshelper.initSync
1031 {
1032     local _vis_tmpdir
1033     _vis_tmpdir=$($_MKTEMPDIR vserver-stop.XXXXXX) || {
1034         warning $"Failed to generate temporary directory for vshelper sync"
1035         return 1
1036     }
1037
1038     local _vis_fifo="$_vis_tmpdir"/pipe
1039     $_MKFIFO -m700 "$_vis_fifo"
1040     vshelper.doInit "$1" "${3:-sync}" "$_vis_fifo"
1041     eval $2=\$_vis_fifo
1042 }
1043
1044 ## Usage: vshelper.getSyncTimeout <vserver> <varname>
1045 function vshelper.getSyncTimeout
1046 {
1047     local _vgst_appdir _vgst_file _vgst_tmp
1048     _vgst_appdir=$($_VSERVER_INFO "$1" APPDIR vshelper) || _vgst_appdir=
1049
1050     findFile _vgst_file ${_vgst_appdir:+"$_vgst_appdir"/sync-timeout} "$__CONFDIR"/.defaults/apps/vshelper/sync-timeout ''
1051     test -n "$_vgst_file" || return 1
1052     read _vgst_tmp <"$_vgst_file"
1053     eval $2=\$_vgst_tmp
1054 }
1055
1056 function vshelper.initStopSync
1057 {
1058         local _iss_sync_dir=$($_MKTEMPDIR vshelper-stop-sync.XXXXXX) || {
1059                 warning $"Failed to generate directory for vshelper sync"
1060                 exit 1
1061         }
1062         $_MKFIFO -m700 "$_iss_sync_dir/pipe"
1063
1064         eval "$1"=\$_iss_sync_dir
1065         VSHELPER_STOP_SYNC="$_iss_sync_dir/pipe"
1066         export VSHELPER_STOP_SYNC
1067 }
1068
1069 function vshelper.waitForStopSync
1070 {
1071         local sync_dir=$1
1072         cat "$sync_dir/pipe" &> /dev/null
1073         rm -fr "$sync_dir"
1074 }
1075
1076 function vshelper.doStopSync
1077 {
1078         test ! -p "$VSHELPER_STOP_SYNC" || echo stopped > "$VSHELPER_STOP_SYNC"
1079 }
1080
1081 function vshelper.isStopSync
1082 {
1083         test -p "$VSHELPER_STOP_SYNC" || return 1
1084         return 0
1085 }
1086
1087 function _rpmFake.getCapFlags
1088 {
1089     local ctx=$1
1090
1091     if test -n "$ctx" && ! $_VSERVER_INFO - FEATURE migrate; then
1092         set -- $($_CHCONTEXT_COMPAT --xid 1 \
1093             $_SH -c "$_CAT /proc/[0-9]*/status | $_EGREP '^(CapBset|s_context|ctxflags)'" | \
1094             $_GREP -B 1 -A 1 "^s_context: $ctx " | \
1095             $_SED -e '1,3p;d' | $_AWK '{ print $2 }')
1096     else
1097         set --
1098     fi
1099
1100     if test -n "$3"; then
1101         RPM_FAKE_CAP=$[ ~0x$1 ]
1102         RPM_FAKE_FLAGS=$3
1103     else
1104         RPM_FAKE_CAP=$[ ~0xd40c04ff ]
1105         RPM_FAKE_FLAGS=4
1106     fi
1107 }
1108
1109 function rpmFake.init
1110 {
1111     local vdir ctx
1112
1113     vdir=$($_VSERVER_INFO "$1" VDIR)    || vdir="$1"
1114     ctx=$($_VSERVER_INFO  "$1" CONTEXT) || ctx=
1115
1116     test -d "$vdir" ||
1117         panic $"Can not find chroot environment at '$vdir' for '$1'"
1118
1119     _rpmFake.getCapFlags "$ctx"
1120
1121     RPM_FAKE_CHROOT=$vdir
1122     RPM_FAKE_CTX=$ctx
1123 }
1124
1125 function rpmFake.exec
1126 {
1127     export RPM_FAKE_CHROOT RPM_FAKE_CTX RPM_FAKE_CAP RPM_FAKE_FLAGS
1128
1129     LD_PRELOAD=$_RPM_FAKE_SO${LD_PRELOAD:+:$LD_PRELOAD} \
1130         exec "$@"
1131 }