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