Fix infinite loop when used incorrectly.
[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
530     for _ga_i in $__CONFDIR/*; do
531         isRegularFile "$_ga_i" -d   || continue
532
533         test ! -e "$_ga_i"/disabled || continue
534         test   -d "$_ga_i"/vdir     || continue
535
536         local _ga_doadd=1
537         local _ga_markfile=$_ga_i/apps/init/mark
538         
539         case ${2:-ALL} in
540             (MARKED)    test   -s "$_ga_markfile" || _ga_doadd=;;
541             (UNMARKED)  test ! -s "$_ga_markfile" || _ga_doadd=;;
542             (STOPPED)   ! $_VSERVER "$_ga_i" running &>/dev/null || _ga_doadd=;;
543             (RUNNING)     $_VSERVER "$_ga_i" running &>/dev/null || _ga_doadd=;;
544             (ALL)       ;;
545             (MARK)      test -s "$_ga_markfile" && grep -qx "$3" "$_ga_markfile" || _ga_doadd=;;
546             (*)         panic $"Unknown vserver tagging '$2'";;
547         esac
548
549         test -z "$_ga_doadd" || _ga_tmp=( "${_ga_tmp[@]}" "${_ga_i##$__CONFDIR/}")
550     done
551
552     eval $1='( "${_ga_tmp[@]}" )'
553 }
554
555 declare -r VS_ALLVSERVERS_ARGS=all,marked,unmarked,stopped,running,mark:
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             (*)                 set -- "$_gav_v" "$@"
583                                 return 1;;
584         esac
585
586         getAllVservers _gav_tmp "$_gav_mark" $_gav_extra
587         if test -n "$_gav_first"; then
588             _gav_res=( "${_gav_tmp[@]}" )
589         else
590             local _gav_i=0
591             while test $_gav_i -lt "${#_gav_res[@]}"; do
592                 local _gav_found=0
593                 for _gav_j in "${_gav_tmp[@]}"; do
594                     if test "$_gav_j" = "${_gav_res[$_gav_i]}"; then
595                         _gav_found=1
596                         break
597                     fi
598                 done
599                 if test "$_gav_found" = 0; then
600                     unset _gav_res[$_gav_i]
601                 fi
602                 let ++_gav_i
603             done
604             _gav_res=( "${_gav_res[@]}" )
605         fi
606         shift
607         _gav_first=
608     done
609     eval $_gav_v='( "${_gav_res[@]}" )'
610 }
611
612 ## Usage: _getProcNumberCount <ctx> <var>
613 function _getProcNumberCount
614 {
615     local _gp_var=$2
616     local _gp_procnr_cnt=0
617
618     # Use /proc/virtual from kernel 2.6 when possible
619     if test -d "/proc/virtual"; then
620         set -- $($_GREP '^Tasks:' "/proc/virtual/$1/status" 2>/dev/null)
621         _gp_procnr_cnt=$2
622     else
623         _gp_procnr_cnt=$($_VPS ax | $_AWK '{print $2}' | $_GREP -x "$1" | $_WC -l )
624     fi
625
626     let _gp_procnr_cnt=_gp_procnr_cnt+0
627     eval $_gp_var=\$_gp_procnr_cnt
628 }
629
630 ## Usage: getVserverCtx <vdir> <result-varname> [<procnumber-varname> [<do-cleanup>]]
631 ## Returns: 0 iff vserver is running
632 function getVserverStatus
633 {
634     test -r "$1"/run || return 1
635
636     local _gvs_ctx
637     read _gvs_ctx <"$1"/run
638     eval "$2"=\$_gvs_ctx
639
640     if test "$1" = "$($_VUNAME -g --xid "$_gvs_ctx" context)"; then
641         test -n "$3" || return 0
642         local _gvs_tmp
643         _getProcNumberCount "$_gvs_ctx" _gvs_tmp
644         eval "$3"=\$_gvs_tmp
645     else
646         test -n "$3" || return 1
647         eval "$3"=0
648         _gvs_tmp=0
649     fi
650
651     if test "$_gvs_tmp" = 0; then
652         local runfile=$($_READLINK "$1/run")
653         test -z "$4" || $_RM -f "$runfile"
654         return 1
655     fi
656
657     return 0
658 }
659
660 ## Usage: isCtxRunning <ctx>
661 function isCtxRunning
662 {
663     local _tmp
664     _getProcNumberCount "$1" _tmp
665     test $_tmp -gt 0
666 }
667
668 ## Usage: isVserverRunning <vdir> [<ctx-varname>]
669 function isVserverRunning
670 {
671     local _ivr_ctx _ivr_procnum
672
673     getVserverStatus "$1" _ivr_ctx _ivr_procnum 1 || return 1
674     test "$_ivr_procnum" != 0                     || return 1
675     test -z "$2" || eval "$2"=\$_ivr_ctx
676     return 0
677 }
678
679 ## Called as 'getFileValue <varname> <filename>+'
680 function getFileValue
681 {
682     local _gfv_var=$1
683     local _gfv_file
684     shift
685
686     findFile _gfv_file "$@" ''
687     test -n "$_gfv_file" -a -r "$_gfv_file" || return 0
688     eval read "$_gfv_var" <"$_gfv_file"
689 }
690
691 ## Called as 'getFileArray <varname> <filename>+'
692 function getFileArray
693 {
694     local _gfa_var=$1
695     local _gfa_file
696     shift
697
698     findFile _gfa_file "$@" ''
699     test -n "$_gfa_file" -a -r "$_gfa_file" || return 0
700     local IFS=$_VS_NEWLINE
701     eval "$_gfa_var"='( $(< "$_gfa_file") )'
702 }
703
704 function checkComponents
705 {
706     local       i
707     local       msg=$1
708     local       x_failed=
709
710     shift
711     
712     for i; do
713         local failed=
714         case "$i" in
715             (core)      test -x "$_CHBIND"           || failed=1;;
716             (build)     test -x "$_VSERVER_BUILD"    || failed=1;;
717             (sysv)      test -x "$__INITRDDIR/vserver"    || failed=1;;
718             (devel)     test -d "$__INCLUDEDIR/vserver.h" || failed=1;;
719             (*)         echo "Unknown component '$i'" >&2
720                         return false
721                         ;;
722         esac
723
724         test -z "$failed" || {
725             echo "$msg: $i"
726             x_failed=1
727         } >&2
728     done
729
730     test -z "$x_failed"
731 }
732
733 ## Usage: isKernelAPI <ver> [<cmp-modifier>]
734 function isKernelAPI
735 {
736     local api
737     api=$($_VSERVER_INFO - APIVER) || api=0
738     test $[ $api ] -${2:-ge} $[ $1 ]
739 }
740
741 ## Usage: callInNamespace <vserver> <command> <args>*
742 function callInNamespace
743 {
744     local ctx=
745     
746     isAvoidNamespace "$1" || \
747     ctx=$( $_VSERVER_INFO "$1" CONTEXT f ) || ctx=
748
749     shift
750     if test -n "$ctx"; then
751         $_VNAMESPACE --enter "$ctx" -- "$@"
752     else
753         "$@"
754     fi
755 }
756
757 ## Usage: setDefaultTTY <vdir> [<fallback-tty>]
758 function setDefaultTTY
759 {
760     local cfgdir ttyname
761
762     cfgdir=$($_VSERVER_INFO "$1" APPDIR init) || cfgdir=
763     findObject -e ttyname \
764         ${cfgdir:+"$cfgdir"/tty} \
765         "$__CONFDIR/.defaults/apps/init/tty" \
766         $2 /dev/null
767
768     if test -f "$ttyname"; then
769         exec </dev/null
770     else
771         exec <$ttyname
772     fi
773     exec    >>$ttyname 2>&1
774 }
775
776 ## Usage: killContext <XID> [<SIG>]
777 function killContext
778 {
779     local sig=${2:-9}
780
781     #$_VKILL -s STOP   --xid "$1" 1 &>/dev/null || :
782     $_VKILL -s "$sig" --xid "$1" 1 &>/dev/null || :
783     $_VKILL -s "$sig" --xid "$1"   &>/dev/null || :
784     #$_VKILL -s "$sig" --xid "$1" 1 &>/dev/null || :
785     #$_VKILL -s CONT   --xid "$1" 1 &>/dev/null || :
786 }
787
788 function useVlogin
789 {
790     test ! -e "$__CONFDIR/.defaults/apps/vlogin/disable"
791 }
792
793 ## Usage: pkgmgmt.guessStyle <vserver> <resultvar>
794 function pkgmgmt.guessStyle()
795 {
796     local _pgs_vdir
797     _pgs_vdir=$($_VSERVER_INFO "$1" VDIR) || {
798         echo $"Can not determine vserver-root" >&2
799         return 1
800     }
801     local _pgs_cfgdir=$($_VSERVER_INFO "$1" APPDIR pkgmgmt) || :
802
803     if test -n "$_pgs_cfgdir" -a -e "$_pgs_cfgdir"/style; then
804         read style <"$_pgs_cfgdir"/style
805     elif test -e "$_pgs_vdir"/etc/redhat-release -o -e "$_pgs_vdir"/etc/fedora-release; then
806         style=redhat
807     elif test -e "$_pgs_vdir"/etc/mandrake-release; then
808         style=mandrake
809     elif test -e "$_pgs_vdir"/etc/debian_version; then
810         style=debian
811     elif test -e "$_pgs_vdir"/etc/SuSE-release; then
812         style=suse
813     else
814         echo $"Can not determine packagemanagement style" >&2
815         return 1
816     fi
817
818     eval $2=\$style
819     return 0
820 }
821
822 ## Usage: pkgmgmt.isInternal <vserver>
823 ## returns true iff <vserver> is configured for internal packagemanagement
824 ## A typical application is
825 ## | is_external=
826 ## | pkgmgmt.isInternal "$vserver" || is_external=1
827 function pkgmgmt.isInternal
828 {
829     local cfgdir=$($_VSERVER_INFO "$1" APPDIR pkgmgmt) || :
830
831     test -z "$cfgdir" -o ! -d "$cfgdir" -o -e "$cfgdir"/internal
832 }
833
834 ## Usage: pkgmgmt.isAptAvailable <cfgdir> <vdir> [<is-internal>]
835 function pkgmgmt.isAptAvailable
836 {
837     local cfgdir="$1"
838     local vdir="$2"
839     local is_internal="$3"
840     
841     local have_apt i
842     if test -n "$is_internal"; then
843         have_apt=1
844         test -d "$cfgdir"/base/apt -o -d "$cfgdir"/aptetc || have_apt=
845     else
846         have_apt=
847         for i in /bin /usr/bin /usr/local/bin; do
848             test ! -x "$vdir$i"/apt-get || { have_apt=1; break; }
849         done
850     fi
851
852     test -n "$have_apt" && return 0 || return 1
853 }
854
855 ## Usage: pkgmgmt.isYumAvailable <cfgdir> <vdir> [<is-internal>]
856 function pkgmgmt.isYumAvailable
857 {
858     local cfgdir="$1"
859     local vdir="$2"
860     local is_internal="$3"
861     
862     local have_yum i
863     if test -n "$is_internal"; then
864         have_yum=1
865         test -d "$cfgdir"/base/yum -o -d "$cfgdir"/yumetc || have_yum=
866     else
867         have_yum=
868         for i in /bin /usr/bin /usr/local/bin; do
869             test ! -x "$vdir$i"/yum || { have_yum=1; break; }
870         done
871     fi
872
873     test -n "$have_yum" && return 0 || return 1
874 }
875
876
877 function vshelper.doSanityCheck
878 {
879     local vshelper this_xid i
880     declare -a warnings=()
881     local solution_disable=
882     local solution_sysctl=
883
884     vshelper.isEnabled && vshelper.isEnabled warning || return 0
885     
886     this_xid=$($_VSERVER_INFO - XID) ||
887         panic $"Failed to determine current context; aborting..."
888
889     ## Do nothing in other xid's; the helper will be executed in xid 0 only
890     test "$this_xid" = 0 || return 0
891
892     local proc_file=/proc/sys/kernel/vshelper
893
894     if ! test -r "$proc_file"; then
895         vshelper=
896         warnings=( "${warnings[@]}"
897                    $"File '$proc_file' does not exist but is required for vshelper setup" )
898         solution_disable=1
899     else
900         vshelper=$(cat "$proc_file")
901
902         $_CMP -s "$vshelper" "$_VSHELPER" || {
903             local readable=""
904             test -r "$vshelper" && readable=1
905             warnings=( "${warnings[@]}"
906                        $"The configured vshelper '$vshelper' does not match the 'vshelper'
907   script of the util-vserver package.${readable:+ Maybe you have two versions installed?}"
908                      )
909             solution_disable=1
910             solution_sysctl=1
911         }
912     fi
913
914     test -d "$__VSHELPERSTATEDIR" || {
915         warnings=( "${warnings[@]}"
916                    $"\
917 The vshelper state-directory '$__VSHELPERSTATEDIR' does not exist; since
918 it is created by 'make install', this indicates a serious problem with
919 your util-vserver installation" )
920         solution_disable=1
921     }
922
923     test "${#warnings[@]}" -eq 0 || {
924         warning $"\
925 The following problem(s) were encountered while verifying vshelper
926 functionality:"
927
928         for i in "${warnings[@]}"; do
929             warning "* $i"
930         done
931
932         warning $"\
933         
934 To fix this, you can:"
935
936         test -z "$solution_disable" || warning $"\
937 * disable vshelper entirely by executing
938   | touch \"$__CONFDIR/.defaults/apps/vshelper/disabled\"
939 * disable only this message by executing
940   | touch \"$__CONFDIR/.defaults/apps/vshelper/warning-disabled\""
941
942         test -x "$solution_sysctl" || warning $"\
943 * configure the util-vserver vshelper script, e.g. by adding
944   | kernel.vshelper = $_VSHELPER
945   to /etc/sysctl.conf and rebooting the machine, or by executing
946   | echo \"$_VSHELPER\" >$proc_file"
947
948         warning ""
949
950         return 1
951     }
952
953     return 0
954 }
955
956 ## Usage: vshelper.isEnabled [<style>] [<vserver>]
957 function vshelper.isEnabled
958 {
959     local f=${1:+$1-}disabled
960     test ! -e "$__CONFDIR"/.defaults/apps/vshelper/"$f"     || return 1
961     $_VSERVER_INFO - FEATURE vshelper                       || return 1
962     if test -n "$2"; then
963         local appdir
964         appdir=$($_VSERVER_INFO "$2" APPDIR vshelper)       || return 0
965         test -z "$2" -o ! -e "$appdir/$f"                   || return 1
966     fi
967
968     return 0
969 }
970
971 ## Usage: vshelper.isDebug [<vserver>]
972 function vshelper.isDebug
973 {
974     test ! -e "$__CONFDIR"/.defaults/apps/vshelper/debug    || return 0
975     $_VSERVER_INFO - FEATURE vshelper                       || return 1
976     if test -n "$1"; then
977         local appdir
978         appdir=$($_VSERVER_INFO "$1" APPDIR vshelper)       || return 1
979         test ! -e "$appdir/debug"                           || return 0
980     fi
981
982     return 1
983 }
984
985 function vshelper._getHandlerInternal
986 {
987     local _vghi_var=$1
988     local _vghi_tmp
989     shift
990     shift       ## HACK: see below the note about the 'set -u' mode
991     
992     while test "$#" -ge 2; do
993         local _vghi_mod=$1
994         local _vghi_obj=$2
995         shift 2
996
997         test "$_vghi_mod" "$_vghi_obj" || continue
998         case "$_vghi_mod" in
999             (-x)
1000                 eval $_vghi_var=\$_vghi_obj
1001                 ;;
1002             (-e)
1003                 read _vghi_tmp <"$_vghi_obj"
1004                 eval $_vghi_var=:\$_vghi_tmp
1005                 ;;
1006             (*) panic $"Internal error, unexpected modifier '$_vghi_mod'"
1007         esac
1008         return 0
1009     done
1010     
1011     return 1
1012 }
1013
1014 ## Usage: vshelper.getHandler <result-var> <vserver> <action>
1015 function vshelper.getHandler
1016 {
1017     local _vgh_appdir
1018     _vgh_appdir=$($_VSERVER_INFO "$2" APPDIR vshelper) || _vgh_appdir=
1019
1020     declare -a _vgh_search_list=( X )
1021     ## HACK: when we are in 'set -u' mode, empty lists are causing errors
1022
1023     test -z "$_vgh_appdir" || _vgh_search_list=( "${_vgh_search_list[@]}" -x "$_vgh_appdir/$3" )
1024     test -z "$_vgh_appdir" || _vgh_search_list=( "${_vgh_search_list[@]}" -e "$_vgh_appdir/action" )
1025     _vgh_search_list=( "${_vgh_search_list[@]}" -x "$__CONFDIR"/.defaults/apps/vshelper/"$3" )
1026     _vgh_search_list=( "${_vgh_search_list[@]}" -e "$__CONFDIR"/.defaults/apps/vshelper/action )
1027
1028     ! vshelper._getHandlerInternal "$1" "${_vgh_search_list[@]}" || return 0
1029     eval $1=':restart'
1030 }
1031
1032 ## Usage: vshelper.init <vserver> [<method> <args>*]
1033 function vshelper.doInit
1034 {
1035     vshelper.isEnabled || return 0
1036     
1037     local xid
1038     xid=$($_VSERVER_INFO "$1" CONTEXT false) && test -n "$xid" || {
1039         warning $"vshelper.init: can not determine xid of vserver '$vserver'; returned value was '$xid'
1040
1041 This usually means that you're using an init-less init-style, but the
1042 guest isn't configured to start any service. Try enabling a service,
1043 changing the init-style, or making the contexts persistent."
1044         return 1
1045     }
1046
1047     local f="$__VSHELPERSTATEDIR/$xid"
1048     
1049     set -C
1050     $_RM -f "$f"
1051     echo "$1" >"$f"
1052     set +C
1053     
1054     if test -n "$2"; then
1055         shift 1
1056         local i
1057         for i; do
1058             echo "$i" 
1059         done
1060     else
1061         echo "default"
1062     fi >>"$f"
1063
1064     return 0
1065 }
1066
1067 ## Usage: vshelper.doDestroy <vserver> <xid>
1068 function vshelper.doDestroy
1069 {
1070     vshelper.isEnabled || return 0
1071
1072     $_RM -f "$__VSHELPERSTATEDIR/$2"
1073 }
1074
1075 ## Usage: vshelper.initSync <vserver> <pipe-varname> [<method>]
1076 function vshelper.initSync
1077 {
1078     local _vis_tmpdir
1079     _vis_tmpdir=$($_MKTEMPDIR vserver-stop.XXXXXX) || {
1080         warning $"Failed to generate temporary directory for vshelper sync"
1081         return 1
1082     }
1083
1084     local _vis_fifo="$_vis_tmpdir"/pipe
1085     $_MKFIFO -m700 "$_vis_fifo"
1086     vshelper.doInit "$1" "${3:-sync}" "$_vis_fifo"
1087     eval $2=\$_vis_fifo
1088 }
1089
1090 ## Usage: vshelper.getSyncTimeout <vserver> <varname>
1091 function vshelper.getSyncTimeout
1092 {
1093     local _vgst_appdir _vgst_file _vgst_tmp
1094     _vgst_appdir=$($_VSERVER_INFO "$1" APPDIR vshelper) || _vgst_appdir=
1095
1096     findFile _vgst_file ${_vgst_appdir:+"$_vgst_appdir"/sync-timeout} "$__CONFDIR"/.defaults/apps/vshelper/sync-timeout ''
1097     test -n "$_vgst_file" || return 1
1098     read _vgst_tmp <"$_vgst_file"
1099     eval $2=\$_vgst_tmp
1100 }
1101
1102 function vshelper.initStopSync
1103 {
1104         local _iss_sync_dir=$($_MKTEMPDIR vshelper-stop-sync.XXXXXX) || {
1105                 warning $"Failed to generate directory for vshelper sync"
1106                 exit 1
1107         }
1108         $_MKFIFO -m700 "$_iss_sync_dir/pipe"
1109
1110         eval "$1"=\$_iss_sync_dir
1111         VSHELPER_STOP_SYNC="$_iss_sync_dir/pipe"
1112         export VSHELPER_STOP_SYNC
1113 }
1114
1115 function vshelper.waitForStopSync
1116 {
1117         local sync_dir=$1
1118         cat "$sync_dir/pipe" &> /dev/null
1119         rm -fr "$sync_dir"
1120 }
1121
1122 function vshelper.doStopSync
1123 {
1124         test ! -p "$VSHELPER_STOP_SYNC" || echo stopped > "$VSHELPER_STOP_SYNC"
1125 }
1126
1127 function vshelper.isStopSync
1128 {
1129         test -p "$VSHELPER_STOP_SYNC" || return 1
1130         return 0
1131 }
1132
1133 function _rpmFake.getCapFlags
1134 {
1135     local ctx=$1
1136     
1137     if test -n "$ctx" && ! $_VSERVER_INFO - FEATURE migrate; then
1138         set -- $($_CHCONTEXT_COMPAT --xid 1 \
1139             $_SH -c "$_CAT /proc/[0-9]*/status | $_EGREP '^(CapBset|s_context|ctxflags)'" | \
1140             $_GREP -B 1 -A 1 "^s_context: $ctx " | \
1141             $_SED -e '1,3p;d' | $_AWK '{ print $2 }')
1142     else
1143         set --
1144     fi
1145
1146     if test -n "$3"; then
1147         RPM_FAKE_CAP=$[ ~0x$1 ]
1148         RPM_FAKE_FLAGS=$3
1149     else
1150         RPM_FAKE_CAP=$[ ~0xd40c04ff ]
1151         RPM_FAKE_FLAGS=4
1152     fi
1153 }
1154
1155 function rpmFake.init
1156 {
1157     local vdir ctx
1158     
1159     vdir=$($_VSERVER_INFO "$1" VDIR)    || vdir="$1"
1160     ctx=$($_VSERVER_INFO  "$1" CONTEXT) || ctx=
1161
1162     test -d "$vdir" ||
1163         panic $"Can not find chroot environment at '$vdir' for '$1'"
1164
1165     _rpmFake.getCapFlags "$ctx"
1166
1167     RPM_FAKE_CHROOT=$vdir
1168     RPM_FAKE_CTX=$ctx
1169 }
1170
1171 function rpmFake.exec
1172 {
1173     export RPM_FAKE_CHROOT RPM_FAKE_CTX RPM_FAKE_CAP RPM_FAKE_FLAGS
1174     
1175     LD_PRELOAD=$_RPM_FAKE_SO${LD_PRELOAD:+:$LD_PRELOAD} \
1176         exec "$@"
1177 }