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