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