Apply Bastian Blank's userspace namespace cleanup patch.
[util-vserver.git] / 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 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 _pkgMountBindDir()
272 {
273     test "$1" != "$2" || return 0
274
275     $_MOUNT -n --bind "$1" "$2"
276 }
277
278 function _pkgSetVarsBase
279 {
280     case "$vserver" in
281         ./*|/*)
282             if test -d "$vserver/vdir"; then
283                 BASEDIR=$vserver
284                 VDIR=$(getPhysicalDir "$vserver/vdir")
285                 
286                 PKGDIR=$BASEDIR/apps/pkgmgmt
287                 test -d "$PKGDIR" || {
288                     echo "Can not find configuration-directory for package-managment tools"
289                     exit 1
290                 } >&2
291                 findDir EXECDIR      $PKGDIR/execdir     /
292             else
293                 VDIR=$(getPhysicalDir "$vserver")
294                 PKGDIR=
295             fi
296             ;;
297         *)
298             BASEDIR=$__CONFDIR/$vserver
299             test -d "$BASEDIR" || {
300                 echo "Can not find configuration-directory"
301                 exit 1
302             } >&2
303             
304             VDIR=$BASEDIR/vdir
305             test -d "$VDIR"   || VDIR=$__DEFAULT_VSERVERDIR/$vserver
306             VDIR=$(getPhysicalDir "$VDIR")
307             
308             PKGDIR=$BASEDIR/apps/pkgmgmt
309             test -d "$PKGDIR" || {
310                 echo "Can not find configuration-directory for package-managment tools"
311                 exit 1
312             } >&2
313
314             findDir EXECDIR      $PKGDIR/execdir     /
315
316             ;;
317     esac
318
319     if test -z "$WORKAROUND_106057"; then
320         _rpmdb_mntpoint=/dev
321     else
322         _rpmdb_mntpoint=/.rpmdb
323     fi
324 }
325
326 function _pkgSetVarsRPM
327 {
328     if test -n "$PKGDIR"; then
329         findDir RPMETCDIR    $PKGDIR/rpmetc      $PKGDIR/base/rpm/etc       /etc/rpm
330         findDir RPMSTATEDIR  $PKGDIR/rpmstate    $PKGDIR/base/rpm/state
331
332         findDir RPMLIBDIR    $PKGDIR/rpmlib      /
333
334     else
335         findDir RPMETCDIR    "$VDIR"/etc/rpm     /etc/rpm
336         findDir RPMSTATEDIR  "$VDIR"/var/lib/rpm
337         RPMLIBDIR=/
338     fi
339     
340     RPMSTATEDIR=$(getPhysicalDir "$RPMSTATEDIR")
341     RPMETCDIR=$(getPhysicalDir "$RPMETCDIR")
342 }
343
344 function _pkgSetVarsApt
345 {
346     if test -n "$PKGDIR"; then
347         findDir APTETCDIR    $PKGDIR/aptetc      $PKGDIR/base/apt/etc       /etc/apt
348         findDir APTSTATEDIR  $PKGDIR/aptstate    $PKGDIR/base/apt/state
349         findDir APTCACHEDIR  $PKGDIR/aptcache    $PKGDIR/base/apt/cache
350         findDir APTARCHIVDIR $PKGDIR/aptarchives $PKGDIR/base/apt/archives  /var/cache/apt/archives
351     else
352         findDir APTETCDIR    "$VDIR"/etc/apt            /etc/apt
353         findDir APTSTATEDIR  "$VDIR"/var/state/apt
354         findDir APTCACHEDIR  "$VDIR"/var/cache/apt
355         findDir APTARCHIVDIR "$VDIR"/var/cache/apt/archives /var/cache/apt/archives
356     fi
357
358     findFile APT_CONFIG "$APTETCDIR"/apt.conf ""
359     test -z "$APT_CONFIG" || export APT_CONFIG
360 }
361
362 function _pkgSetVarsYum
363 {
364     if test -n "$PKGDIR"; then
365         findDir YUMETCDIR    $PKGDIR/yumetc      $PKGDIR/base/yum/etc       /etc
366         findDir YUMCACHEDIR  $PKGDIR/yumcache    $PKGDIR/base/yum/cache
367     else
368         findDir YUMETCDIR    "$VDIR"/etc         /etc
369         findDir YUMCACHEDIR  "$VDIR"/var/cache/yum
370     fi
371 }
372
373
374 function _pkgMountBase
375 {
376     :
377 }
378
379 function _pkgMountApt
380 {
381     :
382 }
383
384 function _pkgMountYum
385 {
386     :
387 }
388
389 function _pkgMountRPM
390 {
391     _pkgMountBindDir "$RPMETCDIR" /etc/rpm
392     test "$RPMLIBDIR" = "/" || _pkgMountBindDir "$RPMLIBDIR" /usr/lib/rpm
393
394     pushd "$VDIR" >/dev/null
395
396     $_SECURE_MOUNT --chroot -n --bind "$RPMSTATEDIR" "$_rpmdb_mntpoint"
397     test -z "$WORKAROUND_106057" || mount -n --bind "$RPMSTATEDIR" "$_rpmdb_mntpoint"
398
399     test -e "$VDIR"/proc/self/status || \
400         $_SECURE_MOUNT --chroot -n -t proc none /proc
401
402     popd >/dev/null
403 }
404
405 function _pkgSetEnvBase
406 {
407     test "$EXECDIR" = "/" || {
408         PATH=$EXECDIR:$PATH
409         LD_LIBRARY_PATH=$EXECDIR${LD_LIBRARY_PATH:+:$LD_LIBRARY_PATH}
410     }
411
412     export PATH LD_LIBRARY_PATH
413 }
414
415 function _pkgSetEnvApt
416 {
417     :
418 }
419
420 function _pkgSetEnvYum
421 {
422     :
423 }
424
425 function _pkgSetEnvRPM
426 {
427     CUR_VSERVER=$vserver
428     RPM_FAKE_NAMESPACE_MOUNTS=$_rpmdb_mntpoint
429     RPM_BINARY=$_VRPM_PRELOAD
430
431     export CUR_VSERVER RPM_FAKE_NAMESPACE_MOUNTS RPM_BINARY
432 }
433
434 function pkgInit
435 {
436     local i
437     local vserver=$1
438     shift
439     
440     _pkgSetVarsBase
441     for i; do
442         case "$i" in
443             rpm)        _pkgSetVarsRPM;;
444             apt)        _pkgSetVarsApt;;
445             yum)        _pkgSetVarsYum;;
446             *)          echo "Unknown packaging flavor" >&2; exit 1;;
447         esac
448     done
449
450     _pkgMountBase
451     for i; do
452         case "$i" in
453             rpm)        _pkgMountRPM;;
454             apt)        _pkgMountApt;;
455             yum)        _pkgMountYum;;
456         esac
457     done
458
459     _pkgSetEnvBase
460     for i; do
461         case "$i" in
462             rpm)        _pkgSetEnvRPM;;
463             apt)        _pkgSetEnvApt;;
464             yum)        _pkgSetEnvYum;;
465         esac
466     done
467
468     _PKG_FLAVORS="$@"
469     _PKG_VSERVER=$vserver
470 }
471
472 function isAvoidNamespace
473 {
474     local cfgdir
475
476     $_VSERVER_INFO - FEATURE namespace   || return 0
477     cfgdir=$($_VSERVER_INFO "$1" CFGDIR) || return 0
478     test ! -e "$cfgdir"/namespace        || return 1
479     test -e "$__CONFDIR"/.defaults/nonamespace -o \
480          -e "$cfgdir"/nonamespace
481 }
482
483 function isNamespaceCleanup
484 {
485     local cfgdir
486
487     $_VSERVER_INFO - FEATURE namespace   || return 1
488     cfgdir=$($_VSERVER_INFO "$1" CFGDIR) || return 1
489     test -e "$cfgdir"/nonamespace-cleanup && return 1
490     test -e "$__CONFDIR"/.defaults/namespace-cleanup -o \
491          -e "$cfgdir"/namespace-cleanup && return 0
492     return 1
493 }
494
495 ## Usage: getAllVservers <var> [<KIND>*]
496 function getAllVservers
497 {
498     local _ga_i
499     declare -a _ga_tmp=()
500
501     for _ga_i in $__CONFDIR/*; do
502         isRegularFile "$_ga_i" -d   || continue
503
504         test ! -e "$_ga_i"/disabled || continue
505         test   -d "$_ga_i"/vdir     || continue
506
507         local _ga_doadd=1
508         local _ga_markfile=$_ga_i/apps/init/mark
509         
510         case ${2:-ALL} in
511             (MARKED)    test   -s "$_ga_markfile" || _ga_doadd=;;
512             (UNMARKED)  test ! -s "$_ga_markfile" || _ga_doadd=;;
513             (STOPPED)   ! $_VSERVER "$_ga_i" running &>/dev/null || _ga_doadd=;;
514             (RUNNING)     $_VSERVER "$_ga_i" running &>/dev/null || _ga_doadd=;;
515             (ALL)       ;;
516             (*)         panic $"Unknown vserver tagging '$2'";;
517         esac
518
519         test -z "$_ga_doadd" || _ga_tmp=( "${_ga_tmp[@]}" "${_ga_i##$__CONFDIR/}")
520     done
521
522     eval $1='( "${_ga_tmp[@]}" )'
523 }
524
525 ## Usage: getAllVserversByArg <var> <arg>
526 function getAllVserversByArg
527 {
528     local _gav_mark=
529     
530     case $2 in
531         (--all)         _gav_mark=ALL;;
532         (--marked)      _gav_mark=MARKED;;
533         (--unmarked)    _gav_mark=UNMARKED;;
534         (--stopped)     _gav_mark=STOPPED;;
535         (--running)     _gav_mark=RUNNING;;
536         (*)             return 1;;
537     esac
538
539     getAllVservers "$1" "$_gav_mark"
540 }
541
542 ## Usage: _getProcNumberCount <ctx> <var>
543 function _getProcNumberCount
544 {
545     local _gp_var=$2
546     local _gp_procnr_cnt=0
547
548     # Use /proc/virtual from kernel 2.6 when possible
549     if test -d "/proc/virtual"; then
550         set -- $($_GREP '^PROC:' "/proc/virtual/$1/limit" 2>/dev/null)
551         _gp_procnr_cnt=$2
552     else
553         _gp_procnr_cnt=$($_VPS ax | $_AWK '{print $2}' | $_GREP -x "$1" | $_WC -l )
554     fi
555
556     let _gp_procnr_cnt=_gp_procnr_cnt+0
557     eval $_gp_var=\$_gp_procnr_cnt
558 }
559
560 ## Usage: getVserverCtx <vdir> <result-varname> [<procnumber-varname> [<do-cleanup>]]
561 ## Returns: 0 iff vserver is running
562 function getVserverStatus
563 {
564     test -r "$1"/run || return 1
565
566     local _gvs_ctx
567     read _gvs_ctx <"$1"/run
568     eval "$2"=\$_gvs_ctx
569
570     test -n "$3"     || return 0
571     local _gvs_tmp
572     _getProcNumberCount "$_gvs_ctx" _gvs_tmp
573     eval "$3"=\$_gvs_tmp
574
575     if test "$_gvs_tmp" = 0; then
576         local runfile=$($_READLINK "$1/run")
577         test -z "$4" || $_RM -f "$runfile"
578         return 1
579     fi
580
581     return 0
582 }
583
584 ## Usage: isCtxRunning <ctx>
585 function isCtxRunning
586 {
587     local _tmp
588     _getProcNumberCount "$1" _tmp
589     test $_tmp -gt 0
590 }
591
592 ## Usage: isVserverRunning <vdir> [<ctx-varname>]
593 function isVserverRunning
594 {
595     local _ivr_ctx _ivr_procnum
596
597     getVserverStatus "$1" _ivr_ctx _ivr_procnum 1 || return 1
598     test "$_ivr_procnum" != 0                     || return 1
599     test -z "$2" || eval "$2"=\$_ivr_ctx
600     return 0
601 }
602
603 ## Called as 'getFileValue <varname> <filename>+'
604 function getFileValue
605 {
606     local _gfv_var=$1
607     local _gfv_file
608     shift
609
610     findFile _gfv_file "$@" ''
611     test -n "$_gfv_file" -a -r "$_gfv_file" || return 0
612     eval read "$_gfv_var" <"$_gfv_file"
613 }
614
615 ## Called as 'getFileArray <varname> <filename>'
616 function getFileArray
617 {
618     test -r "$2" || return 1
619     
620     local IFS=$_VS_NEWLINE
621     eval "$1"='( $(< "$2") )'
622 }
623
624 function checkComponents
625 {
626     local       i
627     local       msg=$1
628     local       x_failed=
629
630     shift
631     
632     for i; do
633         local failed=
634         case "$i" in
635             (core)      test -x "$_CHBIND"           || failed=1;;
636             (build)     test -x "$_VSERVER_BUILD"    || failed=1;;
637             (sysv)      test -x "$__INITRDDIR/vserver"    || failed=1;;
638             (devel)     test -d "$__INCLUDEDIR/vserver.h" || failed=1;;
639             (*)         echo "Unknown component '$i'" >&2
640                         return false
641                         ;;
642         esac
643
644         test -z "$failed" || {
645             echo "$msg: $i"
646             x_failed=1
647         } >&2
648     done
649
650     test -z "$x_failed"
651 }
652
653 ## Usage: isKernelAPI <ver> [<cmp-modifier>]
654 function isKernelAPI
655 {
656     local api
657     api=$($_VSERVER_INFO - APIVER) || api=0
658     test $[ $api ] -${2:-ge} $[ $1 ]
659 }
660
661 ## Usage: callInNamespace <vserver> <command> <args>*
662 function callInNamespace
663 {
664     local ctx=
665     
666     isAvoidNamespace "$1" || \
667     ctx=$( $_VSERVER_INFO "$1" CONTEXT f ) || ctx=
668
669     shift
670     if test -n "$ctx"; then
671         $_VNAMESPACE --enter "$ctx" -- "$@"
672     else
673         "$@"
674     fi
675 }
676
677 ## Usage: setDefaultTTY <vdir> [<fallback-tty>]
678 function setDefaultTTY
679 {
680     local cfgdir ttyname
681
682     cfgdir=$($_VSERVER_INFO "$1" APPDIR init) || cfgdir=
683     findObject -e ttyname \
684         ${cfgdir:+"$cfgdir"/tty} \
685         "$__CONFDIR/.defaults/apps/init/tty" \
686         $2 /dev/null
687
688     exec   <$ttyname
689     exec  &>$ttyname
690 }
691
692 ## Usage: killContext <XID> [<SIG>]
693 function killContext
694 {
695     local sig=${2:-9}
696
697     #$_VKILL -s STOP   --xid "$1" 1 &>/dev/null || :
698     $_VKILL -s "$sig" --xid "$1" 1 &>/dev/null || :
699     $_VKILL -s "$sig" --xid "$1"   &>/dev/null || :
700     #$_VKILL -s "$sig" --xid "$1" 1 &>/dev/null || :
701     #$_VKILL -s CONT   --xid "$1" 1 &>/dev/null || :
702 }
703
704 ## Usage: pkgmgmt.guessStyle <vserver> <resultvar>
705 function pkgmgmt.guessStyle()
706 {
707     local _pgs_vdir
708     _pgs_vdir=$($_VSERVER_INFO "$1" VDIR) || {
709         echo $"Can not determine vserver-root" >&2
710         return 1
711     }
712     local _pgs_cfgdir=$($_VSERVER_INFO "$1" APPDIR pkgmgmt) || :
713
714     if test -n "$_pgs_cfgdir" -a -e "$_pgs_cfgdir"/style; then
715         read style <"$_pgs_cfgdir"/style
716     elif test -e "$_pgs_vdir"/etc/redhat-release -o -e "$_pgs_vdir"/etc/fedora-release; then
717         style=redhat
718     elif test -e "$_pgs_vdir"/etc/mandrake-release; then
719         style=mandrake
720     elif test -e "$_pgs_vdir"/etc/debian_version; then
721         style=debian
722     elif test -e "$_pgs_vdir"/etc/SuSE-release; then
723         style=suse
724     else
725         echo $"Can not determine packagemanagement style" >&2
726         return 1
727     fi
728
729     eval $2=\$style
730     return 0
731 }
732
733 ## Usage: pkgmgmt.isInternal <vserver>
734 ## returns true iff <vserver> is configured for internal packagemanagement
735 ## A typical application is
736 ## | is_external=
737 ## | pkgmgmt.isInternal "$vserver" || is_external=1
738 function pkgmgmt.isInternal
739 {
740     local cfgdir=$($_VSERVER_INFO "$1" APPDIR pkgmgmt) || :
741
742     test -z "$cfgdir" -o ! -d "$cfgdir" -o -e "$cfgdir"/internal
743 }
744
745 ## Usage: pkgmgmt.isAptAvailable <cfgdir> <vdir> [<is-internal>]
746 function pkgmgmt.isAptAvailable
747 {
748     local cfgdir="$1"
749     local vdir="$2"
750     local is_internal="$3"
751     
752     local have_apt i
753     if test -n "$is_internal"; then
754         have_apt=1
755         test -d "$cfgdir"/base/apt -o -d "$cfgdir"/aptetc || have_apt=
756     else
757         have_apt=
758         for i in /bin /usr/bin /usr/local/bin; do
759             test ! -x "$vdir$i"/apt-get || { have_apt=1; break; }
760         done
761     fi
762
763     test -n "$have_apt" && return 0 || return 1
764 }
765
766 ## Usage: pkgmgmt.isYumAvailable <cfgdir> <vdir> [<is-internal>]
767 function pkgmgmt.isYumAvailable
768 {
769     local cfgdir="$1"
770     local vdir="$2"
771     local is_internal="$3"
772     
773     local have_yum i
774     if test -n "$is_internal"; then
775         have_yum=1
776         test -d "$cfgdir"/base/yum -o -d "$cfgdir"/yumetc || have_yum=
777     else
778         have_yum=
779         for i in /bin /usr/bin /usr/local/bin; do
780             test ! -x "$vdir$i"/yum || { have_yum=1; break; }
781         done
782     fi
783
784     test -n "$have_yum" && return 0 || return 1
785 }
786
787
788 function vshelper.doSanityCheck
789 {
790     local vshelper this_xid i
791     declare -a warnings=()
792     local solution_disable=
793     local solution_sysctl=
794
795     vshelper.isEnabled && vshelper.isEnabled warning || return 0
796     
797     this_xid=$($_VSERVER_INFO - XID) ||
798         panic $"Failed to determine current context; aborting..."
799
800     ## Do nothing in other xid's; the helper will be executed in xid 0 only
801     test "$this_xid" = 0 || return 0
802
803     local proc_file=/proc/sys/kernel/vshelper
804
805     if ! test -r "$proc_file"; then
806         vshelper=
807         warnings=( "${warnings[@]}"
808                    $"File '$proc_file' does not exist but is required for vshelper setup" )
809         solution_disable=1
810     else
811         vshelper=$(cat "$proc_file")
812
813         $_CMP -s "$vshelper" "$_VSHELPER" || {
814             warnings=( "${warnings[@]}"
815                        $"The configured vshelper '$vshelper' does not match the 'vshelper'
816   script of the util-vserver package"
817                      )
818             solution_disable=1
819             solution_sysctl=1
820         }
821     fi
822
823     test -d "$__VSHELPERSTATEDIR" || {
824         warnings=( "${warnings[@]}"
825                    $"\
826 The vshelper state-directory '$__VSHELPERSTATEDIR' does not exist; since
827 it is created by 'make install', this indicates a serious problem with
828 your util-vserver installation" )
829         solution_disable=1
830     }
831
832     test "${#warnings[@]}" -eq 0 || {
833         warning $"\
834 The following problem(s) were encountered while verifying vshelper
835 functionality:"
836
837         for i in "${warnings[@]}"; do
838             warning "* $i"
839         done
840
841         warning $"\
842         
843 To fix this, you can:"
844
845         test -z "$solution_disable" || warning $"\
846 * disable vshelper entirely by executing
847   | touch \"$__CONFDIR/.defaults/apps/vshelper/disabled\"
848 * disable only this message by executing
849   | touch \"$__CONFDIR/.defaults/apps/vshelper/warning-disabled\""
850
851         test -x "$solution_sysctl" || warning $"\
852 * configure the util-vserver vshelper script, e.g. by adding
853   | kernel.vshelper = $_VSHELPER
854   to /etc/sysctl.conf and rebooting the machine, or by executing
855   | echo \"$_VSHELPER\" >$proc_file"
856
857         warning ""
858
859         return 1
860     }
861
862     return 0
863 }
864
865 ## Usage: vshelper.isEnabled [<style>] [<vserver>]
866 function vshelper.isEnabled
867 {
868     local f=${1:+$1-}disabled
869     test ! -e "$__CONFDIR"/.defaults/apps/vshelper/"$f"     || return 1
870     $_VSERVER_INFO - FEATURE vshelper                       || return 1
871     if test -n "$2"; then
872         local appdir
873         appdir=$($_VSERVER_INFO "$2" APPDIR vshelper)       || return 0
874         test -z "$2" -o ! -e "$appdir/$f"                   || return 1
875     fi
876
877     return 0
878 }
879
880 ## Usage: vshelper.isDebug [<vserver>]
881 function vshelper.isDebug
882 {
883     test ! -e "$__CONFDIR"/.defaults/apps/vshelper/debug    || return 0
884     $_VSERVER_INFO - FEATURE vshelper                       || return 1
885     if test -n "$1"; then
886         local appdir
887         appdir=$($_VSERVER_INFO "$1" APPDIR vshelper)       || return 1
888         test ! -e "$appdir/debug"                           || return 0
889     fi
890
891     return 1
892 }
893
894 function vshelper._getHandlerInternal
895 {
896     local _vghi_var=$1
897     local _vghi_tmp
898     shift
899     shift       ## HACK: see below the note about the 'set -u' mode
900     
901     while test "$#" -ge 2; do
902         local _vghi_mod=$1
903         local _vghi_obj=$2
904         shift 2
905
906         test "$_vghi_mod" "$_vghi_obj" || continue
907         case "$_vghi_mod" in
908             (-x)
909                 eval $_vghi_var=\$_vghi_obj
910                 ;;
911             (-e)
912                 read _vghi_tmp <"$_vghi_obj"
913                 eval $_vghi_var=:\$_vghi_tmp
914                 ;;
915             (*) panic $"Internal error, unexpected modifier '$_vghi_mod'"
916         esac
917         return 0
918     done
919     
920     return 1
921 }
922
923 ## Usage: vshelper.getHandler <result-var> <vserver> <action>
924 function vshelper.getHandler
925 {
926     local _vgh_appdir
927     _vgh_appdir=$($_VSERVER_INFO "$2" APPDIR vshelper) || _vgh_appdir=
928
929     declare -a _vgh_search_list=( X )
930     ## HACK: when we are in 'set -u' mode, empty lists are causing errors
931
932     test -z "$_vgh_appdir" || _vgh_search_list=( "${_vgh_search_list[@]}" -x "$_vgh_appdir/$3" )
933     test -z "$_vgh_appdir" || _vgh_search_list=( "${_vgh_search_list[@]}" -e "$_vgh_appdir/action" )
934     _vgh_search_list=( "${_vgh_search_list[@]}" -x "$__CONFDIR"/.defaults/apps/vshelper/"$3" )
935     _vgh_search_list=( "${_vgh_search_list[@]}" -e "$__CONFDIR"/.defaults/apps/vshelper/action )
936
937     ! vshelper._getHandlerInternal "$1" "${_vgh_search_list[@]}" || return 0
938     eval $1=':restart'
939 }
940
941 ## Usage: vshelper.init <vserver> [<method> <args>*]
942 function vshelper.doInit
943 {
944     vshelper.isEnabled || return 0
945     
946     local xid
947     xid=$($_VSERVER_INFO "$1" CONTEXT false) && test -n "$xid" || {
948         warning $"vshelper.init: can not determine xid of vserver '$vserver'; returned value was '$xid'"
949         return 1
950     }
951
952     local f="$__VSHELPERSTATEDIR/$xid"
953     
954     set -C
955     $_RM -f "$f"
956     echo "$1" >"$f"
957     set +C
958     
959     if test -n "$2"; then
960         shift 1
961         local i
962         for i; do
963             echo "$i" 
964         done
965     else
966         echo "default"
967     fi >>"$f"
968
969     return 0
970 }
971
972 ## Usage: vshelper.doDestroy <vserver> <xid>
973 function vshelper.doDestroy
974 {
975     vshelper.isEnabled || return 0
976
977     $_RM -f "$__VSHELPERSTATEDIR/$2"
978 }
979
980 ## Usage: vshelper.initSync <vserver> <pipe-varname> [<method>]
981 function vshelper.initSync
982 {
983     local _vis_tmpdir
984     _vis_tmpdir=$($_MKTEMPDIR vserver-stop.XXXXXX) || {
985         warning $"Failed to generate temporary directory for vshelper sync"
986         return 1
987     }
988
989     local _vis_fifo="$_vis_tmpdir"/pipe
990     $_MKFIFO -m700 "$_vis_fifo"
991     vshelper.doInit "$1" "${3:-sync}" "$_vis_fifo"
992     eval $2=\$_vis_fifo
993 }
994
995 ## Usage: vshelper.getSyncTimeout <vserver> <varname>
996 function vshelper.getSyncTimeout
997 {
998     local _vgst_appdir _vgst_file _vgst_tmp
999     _vgst_appdir=$($_VSERVER_INFO "$1" APPDIR vshelper) || _vgst_appdir=
1000
1001     findFile _vgst_file ${_vgst_appdir:+"$_vgst_appdir"/sync-timeout} "$__CONFDIR"/.defaults/apps/vshelper/sync-timeout ''
1002     test -n "$_vgst_file" || return 1
1003     read _vgst_tmp <"$_vgst_file"
1004     eval $2=\$_vgst_tmp
1005 }
1006
1007
1008 function _rpmFake.getCapFlags
1009 {
1010     local ctx=$1
1011     
1012     if test -n "$ctx" && ! $_VSERVER_INFO - FEATURE migrate; then
1013         set -- $($_CHCONTEXT_COMPAT --xid 1 \
1014             $_SH -c "$_CAT /proc/[0-9]*/status | $_EGREP '^(CapBset|s_context|ctxflags)'" | \
1015             $_GREP -B 1 -A 1 "^s_context: $ctx " | \
1016             $_SED -e '1,3p;d' | $_AWK '{ print $2 }')
1017     else
1018         set --
1019     fi
1020
1021     if test -n "$3"; then
1022         RPM_FAKE_CAP=$[ ~0x$1 ]
1023         RPM_FAKE_FLAGS=$3
1024     else
1025         RPM_FAKE_CAP=$[ ~0xd40c04ff ]
1026         RPM_FAKE_FLAGS=4
1027     fi
1028 }
1029
1030 function rpmFake.init
1031 {
1032     local vdir ctx
1033     
1034     vdir=$($_VSERVER_INFO "$1" VDIR)    || vdir="$1"
1035     ctx=$($_VSERVER_INFO  "$1" CONTEXT) || ctx=
1036
1037     test -d "$vdir" ||
1038         panic $"Can not find chroot environment at '$vdir' for '$1'"
1039
1040     _rpmFake.getCapFlags "$ctx"
1041
1042     RPM_FAKE_CHROOT=$vdir
1043     RPM_FAKE_CTX=$ctx
1044 }
1045
1046 function rpmFake.exec
1047 {
1048     export RPM_FAKE_CHROOT RPM_FAKE_CTX RPM_FAKE_CAP RPM_FAKE_FLAGS
1049     
1050     LD_PRELOAD=$_RPM_FAKE_SO${LD_PRELOAD:+:$LD_PRELOAD} \
1051         exec "$@"
1052 }