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