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