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