scripts/functions

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