82554878c2ae6b95955ae4360ccee316b33fbc17
[util-vserver.git] / util-vserver / 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 /tmp/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 ## Usage: getAllVservers <var> [<KIND>*]
484 function getAllVservers
485 {
486     local _ga_i
487     declare -a _ga_tmp=()
488
489     for _ga_i in $__CONFDIR/*; do
490         isRegularFile "$_ga_i" -d   || continue
491
492         test ! -e "$_ga_i"/disabled || continue
493         test   -d "$_ga_i"/vdir     || continue
494
495         local _ga_doadd=1
496         local _ga_markfile=$_ga_i/apps/init/mark
497         
498         case ${2:-ALL} in
499             (MARKED)    test   -s "$_ga_markfile" || _ga_doadd=;;
500             (UNMARKED)  test ! -s "$_ga_markfile" || _ga_doadd=;;
501             (STOPPED)   ! $_VSERVER "$_ga_i" running &>/dev/null || _ga_doadd=;;
502             (RUNNING)     $_VSERVER "$_ga_i" running &>/dev/null || _ga_doadd=;;
503             (ALL)       ;;
504             (*)         panic $"Unknown vserver tagging '$2'";;
505         esac
506
507         test -z "$_ga_doadd" || _ga_tmp=( "${_ga_tmp[@]}" "${_ga_i##$__CONFDIR/}")
508     done
509
510     eval $1='( "${_ga_tmp[@]}" )'
511 }
512
513 ## Usage: getAllVserversByArg <var> <arg>
514 function getAllVserversByArg
515 {
516     local _gav_mark=
517     
518     case $2 in
519         (--all)         _gav_mark=ALL;;
520         (--marked)      _gav_mark=MARKED;;
521         (--unmarked)    _gav_mark=UNMARKED;;
522         (--stopped)     _gav_mark=STOPPED;;
523         (--running)     _gav_mark=RUNNING;;
524         (*)             return 1;;
525     esac
526
527     getAllVservers "$1" "$_gav_mark"
528 }
529
530 ## Usage: _getProcNumberCount <ctx> <var>
531 function _getProcNumberCount
532 {
533     local _gp_var=$2
534     local _gp_procnr_cnt=0
535
536     # Use /proc/virtual from kernel 2.6 when possible
537     if test -d "/proc/virtual"; then
538         set -- $($_GREP '^PROC:' "/proc/virtual/$1/limit" 2>/dev/null)
539         _gp_procnr_cnt=$2
540     else
541         _gp_procnr_cnt=$($_VPS ax | $_AWK '{print $2}' | $_GREP -x "$1" | $_WC -l )
542     fi
543
544     let _gp_procnr_cnt=_gp_procnr_cnt+0
545     eval $_gp_var=\$_gp_procnr_cnt
546 }
547
548 ## Usage: getVserverCtx <vdir> <result-varname> [<procnumber-varname> [<do-cleanup>]]
549 ## Returns: 0 iff vserver is running
550 function getVserverStatus
551 {
552     test -r "$1"/run || return 1
553
554     local _gvs_ctx
555     read _gvs_ctx <"$1"/run
556     eval "$2"=\$_gvs_ctx
557
558     test -n "$3"     || return 0
559     local _gvs_tmp
560     _getProcNumberCount "$_gvs_ctx" _gvs_tmp
561     eval "$3"=\$_gvs_tmp
562
563     if test "$_gvs_tmp" = 0; then
564         local runfile=$($_READLINK "$1/run")
565         test -z "$4" || $_RM -f "$runfile"
566         return 1
567     fi
568
569     return 0
570 }
571
572 ## Usage: isCtxRunning <ctx>
573 function isCtxRunning
574 {
575     local _tmp
576     _getProcNumberCount "$1" _tmp
577     test $_tmp -gt 0
578 }
579
580 ## Usage: isVserverRunning <vdir> [<ctx-varname>]
581 function isVserverRunning
582 {
583     local _ivr_ctx _ivr_procnum
584
585     getVserverStatus "$1" _ivr_ctx _ivr_procnum 1 || return 1
586     test "$_ivr_procnum" != 0                     || return 1
587     test -z "$2" || eval "$2"=\$_ivr_ctx
588     return 0
589 }
590
591 ## Called as 'getFileValue <varname> <filename>+'
592 function getFileValue
593 {
594     local _gfv_var=$1
595     local _gfv_file
596     shift
597
598     findFile _gfv_file "$@" ''
599     test -n "$_gfv_file" -a -r "$_gfv_file" || return 0
600     eval read "$_gfv_var" <"$_gfv_file"
601 }
602
603 ## Called as 'getFileArray <varname> <filename>'
604 function getFileArray
605 {
606     test -r "$2" || return 1
607     
608     local IFS=$_VS_NEWLINE
609     eval "$1"='( $(< "$2") )'
610 }
611
612 function checkComponents
613 {
614     local       i
615     local       msg=$1
616     local       x_failed=
617
618     shift
619     
620     for i; do
621         local failed=
622         case "$i" in
623             (core)      test -x "$_CHBIND"           || failed=1;;
624             (build)     test -x "$_VSERVER_BUILD"    || failed=1;;
625             (sysv)      test -x "$__INITRDDIR/vserver"    || failed=1;;
626             (devel)     test -d "$__INCLUDEDIR/vserver.h" || failed=1;;
627             (*)         echo "Unknown component '$i'" >&2
628                         return false
629                         ;;
630         esac
631
632         test -z "$failed" || {
633             echo "$msg: $i"
634             x_failed=1
635         } >&2
636     done
637
638     test -z "$x_failed"
639 }
640
641 ## Usage: isKernelAPI <ver> [<cmp-modifier>]
642 function isKernelAPI
643 {
644     local api
645     api=$($_VSERVER_INFO - APIVER) || api=0
646     test $[ $api ] -${2:-ge} $[ $1 ]
647 }
648
649 ## Usage: callInNamespace <vserver> <command> <args>*
650 function callInNamespace
651 {
652     local ctx=
653     
654     isAvoidNamespace "$1" || \
655     ctx=$( $_VSERVER_INFO "$1" CONTEXT f ) || ctx=
656
657     shift
658     if test -n "$ctx"; then
659         $_VNAMESPACE --enter "$ctx" -- "$@"
660     else
661         "$@"
662     fi
663 }
664
665 ## Usage: setDefaultTTY <vdir> [<fallback-tty>]
666 function setDefaultTTY
667 {
668     local cfgdir ttyname
669
670     cfgdir=$($_VSERVER_INFO "$1" APPDIR init) || cfgdir=
671     findObject -e ttyname \
672         ${cfgdir:+"$cfgdir"/tty} \
673         "$__CONFDIR/.defaults/apps/init/tty" \
674         $2 /dev/null
675
676     exec   <$ttyname
677     exec  &>$ttyname
678 }
679
680 ## Usage: killContext <XID> [<SIG>]
681 function killContext
682 {
683     local sig=${2:-9}
684
685     #$_VKILL -s STOP   --xid "$1" 1 &>/dev/null || :
686     $_VKILL -s "$sig" --xid "$1" 1 &>/dev/null || :
687     $_VKILL -s "$sig" --xid "$1"   &>/dev/null || :
688     #$_VKILL -s "$sig" --xid "$1" 1 &>/dev/null || :
689     #$_VKILL -s CONT   --xid "$1" 1 &>/dev/null || :
690 }
691
692 ## Usage: pkgmgmt.guessStyle <vserver> <resultvar>
693 function pkgmgmt.guessStyle()
694 {
695     local _pgs_vdir
696     _pgs_vdir=$($_VSERVER_INFO "$1" VDIR) || {
697         echo $"Can not determine vserver-root" >&2
698         return 1
699     }
700     local _pgs_cfgdir=$($_VSERVER_INFO "$1" APPDIR pkgmgmt) || :
701
702     if test -n "$_pgs_cfgdir" -a -e "$_pgs_cfgdir"/style; then
703         read style <"$_pgs_cfgdir"/style
704     elif test -e "$_pgs_vdir"/etc/redhat-release -o -e "$_pgs_vdir"/etc/fedora-release; then
705         style=redhat
706     elif test -e "$_pgs_vdir"/etc/mandrake-release; then
707         style=mandrake
708     elif test -e "$_pgs_vdir"/etc/debian_version; then
709         style=debian
710     elif test -e "$_pgs_vdir"/etc/SuSE-release; then
711         style=suse
712     else
713         echo $"Can not determine packagemanagement style" >&2
714         return 1
715     fi
716
717     eval $2=\$style
718     return 0
719 }
720
721 ## Usage: pkgmgmt.isInternal <vserver>
722 ## returns true iff <vserver> is configured for internal packagemanagement
723 ## A typical application is
724 ## | is_external=
725 ## | pkgmgmt.isInternal "$vserver" || is_external=1
726 function pkgmgmt.isInternal
727 {
728     local cfgdir=$($_VSERVER_INFO "$1" APPDIR pkgmgmt) || :
729
730     test -z "$cfgdir" -o ! -d "$cfgdir" -o -e "$cfgdir"/internal
731 }
732
733 ## Usage: pkgmgmt.isAptAvailable <cfgdir> <vdir> [<is-internal>]
734 function pkgmgmt.isAptAvailable
735 {
736     local cfgdir="$1"
737     local vdir="$2"
738     local is_internal="$3"
739     
740     local have_apt i
741     if test -n "$is_internal"; then
742         have_apt=1
743         test -d "$cfgdir"/base/apt -o -d "$cfgdir"/aptetc || have_apt=
744     else
745         have_apt=
746         for i in /bin /usr/bin /usr/local/bin; do
747             test ! -x "$vdir$i"/apt-get || { have_apt=1; break; }
748         done
749     fi
750
751     test -n "$have_apt" && return 0 || return 1
752 }
753
754 ## Usage: pkgmgmt.isYumAvailable <cfgdir> <vdir> [<is-internal>]
755 function pkgmgmt.isYumAvailable
756 {
757     local cfgdir="$1"
758     local vdir="$2"
759     local is_internal="$3"
760     
761     local have_yum i
762     if test -n "$is_internal"; then
763         have_yum=1
764         test -d "$cfgdir"/base/yum -o -d "$cfgdir"/yumetc || have_yum=
765     else
766         have_yum=
767         for i in /bin /usr/bin /usr/local/bin; do
768             test ! -x "$vdir$i"/yum || { have_yum=1; break; }
769         done
770     fi
771
772     test -n "$have_yum" && return 0 || return 1
773 }
774
775
776 function vshelper.doSanityCheck
777 {
778     local vshelper this_xid i
779     declare -a warnings=()
780     local solution_disable=
781     local solution_sysctl=
782
783     vshelper.isEnabled && vshelper.isEnabled warning || return 0
784     
785     this_xid=$($_VSERVER_INFO - XID) ||
786         panic $"Failed to determine current context; aborting..."
787
788     ## Do nothing in other xid's; the helper will be executed in xid 0 only
789     test "$this_xid" = 0 || return 0
790
791     local proc_file=/proc/sys/kernel/vshelper
792
793     if ! test -r "$proc_file"; then
794         vshelper=
795         warnings=( "${warnings[@]}"
796                    $"File '$proc_file' does not exist but is required for vshelper setup" )
797         solution_disable=1
798     else
799         vshelper=$(cat "$proc_file")
800
801         $_CMP -s "$vshelper" "$_VSHELPER" || {
802             warnings=( "${warnings[@]}"
803                        $"The configured vshelper '$vshelper' does not match the 'vshelper'
804   script of the util-vserver package"
805                      )
806             solution_disable=1
807             solution_sysctl=1
808         }
809     fi
810
811     test -d "$__VSHELPERSTATEDIR" || {
812         warnings=( "${warnings[@]}"
813                    $"\
814 The vshelper state-directory '$__VSHELPERSTATEDIR' does not exist; since
815 it is created by 'make install', this indicates a serious problem with
816 your util-vserver installation" )
817         solution_disable=1
818     }
819
820     test "${#warnings[@]}" -eq 0 || {
821         warning $"\
822 The following problem(s) were encountered while verifying vshelper
823 functionality:"
824
825         for i in "${warnings[@]}"; do
826             warning "* $i"
827         done
828
829         warning $"\
830         
831 To fix this, you can:"
832
833         test -z "$solution_disable" || warning $"\
834 * disable vshelper entirely by executing
835   | touch \"$__CONFDIR/.defaults/apps/vshelper/disabled\"
836 * disable only this message by executing
837   | touch \"$__CONFDIR/.defaults/apps/vshelper/warning-disabled\""
838
839         test -x "$solution_sysctl" || warning $"\
840 * configure the util-vserver vshelper script, e.g. by adding
841   | kernel.vshelper = $_VSHELPER
842   to /etc/sysctl.conf and rebooting the machine, or by executing
843   | echo \"$_VSHELPER\" >$proc_file"
844
845         warning ""
846
847         return 1
848     }
849
850     return 0
851 }
852
853 ## Usage: vshelper.isEnabled [<style>] [<vserver>]
854 function vshelper.isEnabled
855 {
856     local f=${1:+$1-}disabled
857     test ! -e "$__CONFDIR"/.defaults/apps/vshelper/"$f"     || return 1
858     $_VSERVER_INFO - FEATURE vshelper                       || return 1
859     if test -n "$2"; then
860         local appdir
861         appdir=$($_VSERVER_INFO "$2" APPDIR vshelper)       || return 0
862         test -z "$2" -o ! -e "$appdir/$f"                   || return 1
863     fi
864
865     return 0
866 }
867
868 ## Usage: vshelper.isDebug [<vserver>]
869 function vshelper.isDebug
870 {
871     test ! -e "$__CONFDIR"/.defaults/apps/vshelper/debug    || return 0
872     $_VSERVER_INFO - FEATURE vshelper                       || return 1
873     if test -n "$1"; then
874         local appdir
875         appdir=$($_VSERVER_INFO "$1" APPDIR vshelper)       || return 1
876         test ! -e "$appdir/debug"                           || return 0
877     fi
878
879     return 1
880 }
881
882 function vshelper._getHandlerInternal
883 {
884     local _vghi_var=$1
885     local _vghi_tmp
886     shift
887     shift       ## HACK: see below the note about the 'set -u' mode
888     
889     while test "$#" -ge 2; do
890         local _vghi_mod=$1
891         local _vghi_obj=$2
892         shift 2
893
894         test "$_vghi_mod" "$_vghi_obj" || continue
895         case "$_vghi_mod" in
896             (-x)
897                 eval $_vghi_var=\$_vghi_obj
898                 ;;
899             (-e)
900                 read _vghi_tmp <"$_vghi_obj"
901                 eval $_vghi_var=:\$_vghi_tmp
902                 ;;
903             (*) panic $"Internal error, unexpected modifier '$_vghi_mod'"
904         esac
905         return 0
906     done
907     
908     return 1
909 }
910
911 ## Usage: vshelper.getHandler <result-var> <vserver> <action>
912 function vshelper.getHandler
913 {
914     local _vgh_appdir
915     _vgh_appdir=$($_VSERVER_INFO "$2" APPDIR vshelper) || _vgh_appdir=
916
917     declare -a _vgh_search_list=( X )
918     ## HACK: when we are in 'set -u' mode, empty lists are causing errors
919
920     test -z "$_vgh_appdir" || _vgh_search_list=( "${_vgh_search_list[@]}" -x "$_vgh_appdir/$3" )
921     test -z "$_vgh_appdir" || _vgh_search_list=( "${_vgh_search_list[@]}" -e "$_vgh_appdir/action" )
922     _vgh_search_list=( "${_vgh_search_list[@]}" -x "$__CONFDIR"/.defaults/apps/vshelper/"$3" )
923     _vgh_search_list=( "${_vgh_search_list[@]}" -e "$__CONFDIR"/.defaults/apps/vshelper/action )
924
925     ! vshelper._getHandlerInternal "$1" "${_vgh_search_list[@]}" || return 0
926     eval $1=':restart'
927 }
928
929 ## Usage: vshelper.init <vserver> [<method> <args>*]
930 function vshelper.doInit
931 {
932     vshelper.isEnabled || return 0
933     
934     local xid
935     xid=$($_VSERVER_INFO "$1" CONTEXT false) && test -n "$xid" || {
936         warning $"vshelper.init: can not determine xid of vserver '$vserver'; returned value was '$xid'"
937         return 1
938     }
939
940     local f="$__VSHELPERSTATEDIR/$xid"
941     
942     set -C
943     $_RM -f "$f"
944     echo "$1" >"$f"
945     set +C
946     
947     if test -n "$2"; then
948         shift 1
949         local i
950         for i; do
951             echo "$i" 
952         done
953     else
954         echo "default"
955     fi >>"$f"
956
957     return 0
958 }
959
960 ## Usage: vshelper.doDestroy <vserver> <xid>
961 function vshelper.doDestroy
962 {
963     vshelper.isEnabled || return 0
964
965     $_RM -f "$__VSHELPERSTATEDIR/$2"
966 }
967
968 ## Usage: vshelper.initSync <vserver> <pipe-varname> [<method>]
969 function vshelper.initSync
970 {
971     local _vis_tmpdir
972     _vis_tmpdir=$($_MKTEMPDIR /tmp/vserver-stop.XXXXXX) || {
973         warning $"Failed to generate temporary directory for vshelper sync"
974         return 1
975     }
976
977     local _vis_fifo="$_vis_tmpdir"/pipe
978     $_MKFIFO -m700 "$_vis_fifo"
979     vshelper.doInit "$1" "${3:-sync}" "$_vis_fifo"
980     eval $2=\$_vis_fifo
981 }
982
983 ## Usage: vshelper.getSyncTimeout <vserver> <varname>
984 function vshelper.getSyncTimeout
985 {
986     local _vgst_appdir _vgst_file _vgst_tmp
987     _vgst_appdir=$($_VSERVER_INFO "$1" APPDIR vshelper) || _vgst_appdir=
988
989     findFile _vgst_file ${_vgst_appdir:+"$_vgst_appdir"/sync-timeout} "$__CONFDIR"/.defaults/apps/vshelper/sync-timeout ''
990     test -n "$_vgst_file" || return 1
991     read _vgst_tmp <"$_vgst_file"
992     eval $2=\$_vgst_tmp
993 }
994
995
996 function _rpmFake.getCapFlags
997 {
998     local ctx=$1
999     
1000     if test -n "$ctx" && ! $_VSERVER_INFO - FEATURE migrate; then
1001         set -- $($_CHCONTEXT_COMPAT --xid 1 \
1002             $_SH -c "$_CAT /proc/[0-9]*/status | $_EGREP '^(CapBset|s_context|ctxflags)'" | \
1003             $_GREP -B 1 -A 1 "^s_context: $ctx " | \
1004             $_SED -e '1,3p;d' | $_AWK '{ print $2 }')
1005     else
1006         set --
1007     fi
1008
1009     if test -n "$3"; then
1010         RPM_FAKE_CAP=$[ ~0x$1 ]
1011         RPM_FAKE_FLAGS=$3
1012     else
1013         RPM_FAKE_CAP=$[ ~0xd40c04ff ]
1014         RPM_FAKE_FLAGS=4
1015     fi
1016 }
1017
1018 function rpmFake.init
1019 {
1020     local vdir ctx
1021     
1022     vdir=$($_VSERVER_INFO "$1" VDIR)    || vdir="$1"
1023     ctx=$($_VSERVER_INFO  "$1" CONTEXT) || ctx=
1024
1025     test -d "$vdir" ||
1026         panic $"Can not find chroot environment at '$vdir' for '$1'"
1027
1028     _rpmFake.getCapFlags "$ctx"
1029
1030     RPM_FAKE_CHROOT=$vdir
1031     RPM_FAKE_CTX=$ctx
1032 }
1033
1034 function rpmFake.exec
1035 {
1036     export RPM_FAKE_CHROOT RPM_FAKE_CTX RPM_FAKE_CAP RPM_FAKE_FLAGS
1037     
1038     LD_PRELOAD=$_RPM_FAKE_SO${LD_PRELOAD:+:$LD_PRELOAD} \
1039         exec "$@"
1040 }