isNumber(): added
[util-vserver.git] / util-vserver / scripts / functions
1 # $Id$  --*- sh -*--
2
3 # Copyright (C) 2003 Enrico Scholz <enrico.scholz@informatik.tu-chemnitz.de>
4 #  
5 # This program is free software; you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; version 2 of the License.
8 #  
9 # This program is distributed in the hope that it will be useful,
10 # but WITHOUT ANY WARRANTY; without even the implied warranty of
11 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 # GNU General Public License for more details.
13 #  
14 # You should have received a copy of the GNU General Public License
15 # along with this program; if not, write to the Free Software
16 # Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
17
18 _VS_LOGFILE=
19 _VS_ERRFILE=
20
21 _VS_NEWLINE='
22 '
23 declare -r _VS_NEWLINE=${_VS_NEWLINE:0-1}
24
25 function findObject
26 {
27     local mod=$1
28     local var=$2
29     local file=
30     local i=X
31     shift 2
32     
33     for i; do
34         test "$i"        || continue
35         test ! $mod "$i" || { file=$i; break; }
36     done
37
38     test -z "$i" -o "$file" || {
39         echo "Can not find file for '$var'; aborting"
40         exit 1
41     } >&2
42
43     eval "$var=\"$file\""
44 }
45
46 function findFile
47 {
48     findObject -f "$@"
49 }
50
51 function findDir
52 {
53     findObject -d "$@"
54 }
55
56 function findAndCopy
57 {
58     local dst=$1
59     test ! -s "$dst"         || return 0
60     
61     local tmp
62     shift
63     findFile tmp "$@"
64
65     test "$tmp" -a -s "$tmp" || return 0
66     cp -af "$tmp" "$dst"
67 }
68
69 function getPhysicalDir
70 {
71     ( set -P && cd "$1" && pwd )
72 }
73
74 function logging
75 {
76     if test "$_VS_LOGFILE"; then
77         echo "$@" >>"$_VS_LOGFILE"
78     else
79         echo "$@"
80     fi
81 }
82
83 function warning
84 {
85     if test "$_VS_ERRFILE"; then
86         echo "$@" >>"$_VS_ERRFILE"
87     else
88         echo "$@" >&2
89     fi
90 }
91
92 function panic
93 {
94     if test "$_VS_ERRFILE"; then
95         echo "$@" >>"$_VS_ERRFILE"
96     else
97         echo "$@" >&2
98     fi
99
100     exit 1
101 }
102
103 function execute
104 {
105     test -z "${DEBUG_EXEC:-}"       || echo "$@"
106     test "${DEBUG_EXEC:-}" = noexec || exec "$@"
107     exit 0
108 }
109
110 function isNumber
111 {
112     local tmp
113     let tmp=$1+0 2>/dev/null || return 1
114     return 0
115 }
116
117 function _pkgMountBindDir()
118 {
119     test "$1" != "$2" || return 0
120
121     mount -n --bind "$1" "$2"
122 }
123
124 function _pkgSetVarsBase
125 {
126     case "$vserver" in
127         ./*|/*)
128             if test -d "$vserver/vdir"; then
129                 BASEDIR=$vserver
130                 VDIR=$(getPhysicalDir "$vserver/vdir")
131                 
132                 PKGDIR=$BASEDIR/apps/pkgmgmt
133                 test -d "$PKGDIR" || {
134                     echo "Can not find configuration-directory for package-managment tools"
135                     exit 1
136                 } >&2
137                 findDir EXECDIR      $PKGDIR/execdir     /
138             else
139                 VDIR=$(getPhysicalDir "$vserver")
140                 PKGDIR=
141             fi
142             ;;
143         *)
144             BASEDIR=$CONFDIR/$vserver
145             test -d "$BASEDIR" || {
146                 echo "Can not find configuration-directory"
147                 exit 1
148             } >&2
149             
150             VDIR=$BASEDIR/vdir
151             test -d "$VDIR"   || VDIR=$DEFAULT_VSERVERDIR/$vserver
152             VDIR=$(getPhysicalDir "$VDIR")
153             
154             PKGDIR=$BASEDIR/apps/pkgmgmt
155             test -d "$PKGDIR" || {
156                 echo "Can not find configuration-directory for package-managment tools"
157                 exit 1
158             } >&2
159
160             findDir EXECDIR      $PKGDIR/execdir     /
161
162             ;;
163     esac
164
165     if test -z "$WORKAROUND_106057"; then
166         _rpmdb_mntpoint=/dev
167     else
168         _rpmdb_mntpoint=/.rpmdb
169     fi
170 }
171
172 function _pkgSetVarsRPM
173 {
174     if test "$PKGDIR"; then
175         findDir RPMETCDIR    $PKGDIR/rpmetc      $PKGDIR/base/rpm/etc       /etc/rpm
176         findDir RPMSTATEDIR  $PKGDIR/rpmstate    $PKGDIR/base/rpm/state
177
178         findDir RPMLIBDIR    $PKGDIR/rpmlib      /
179
180     else
181         findDir RPMETCDIR    "$VDIR"/etc/rpm     /etc/rpm
182         findDir RPMSTATEDIR  "$VDIR"/var/lib/rpm
183         RPMLIBDIR=/
184     fi
185     
186     RPMSTATEDIR=$(getPhysicalDir "$RPMSTATEDIR")
187     RPMETCDIR=$(getPhysicalDir "$RPMETCDIR")
188 }
189
190 function _pkgSetVarsApt
191 {
192     if test "$PKGDIR"; then
193         findDir APTETCDIR    $PKGDIR/aptetc      $PKGDIR/base/apt/etc       /etc/apt
194         findDir APTSTATEDIR  $PKGDIR/aptstate    $PKGDIR/base/apt/state
195         findDir APTCACHEDIR  $PKGDIR/aptcache    $PKGDIR/base/apt/cache
196         findDir APTARCHIVDIR $PKGDIR/aptarchives $PKGDIR/base/apt/archives  /var/cache/apt/archives
197     else
198         findDir APTETCDIR    "$VDIR"/etc/apt            /etc/apt
199         findDir APTSTATEDIR  "$VDIR"/var/state/apt
200         findDir APTCACHEDIR  "$VDIR"/var/cache/apt
201         findDir APTARCHIVDIR "$VDIR"/var/cache/apt/archives /var/cache/apt/archives
202     fi
203
204     findFile APT_CONFIG "$APTETCDIR"/apt.conf ""
205     test -z "$APT_CONFIG" || export APT_CONFIG
206 }
207
208 function _pkgMountBase
209 {
210     :
211 }
212
213 function _pkgMountApt
214 {
215     :
216 }
217
218 function _pkgMountRPM
219 {
220     _pkgMountBindDir "$RPMETCDIR" /etc/rpm
221     test "$RPMLIBDIR" = "/" || _pkgMountBindDir "$RPMLIBDIR" /usr/lib/rpm
222
223     "$_SECURE_MOUNT" --chroot "$VDIR" -n --secure --bind "$RPMSTATEDIR" "$_rpmdb_mntpoint"
224     test -z "$WORKAROUND_106057" || mount -n --bind "$RPMSTATEDIR" "$_rpmdb_mntpoint"
225
226     test -e "$VDIR"/proc/self/status || \
227         "$_SECURE_MOUNT" --chroot "$VDIR" -n --secure -t proc none /proc
228 }
229
230 function _pkgSetEnvBase
231 {
232     test "$EXECDIR"   = "/" || {
233         PATH=$EXECDIR:$PATH
234         LD_LIBRARY_PATH=$EXECDIR${LD_LIBRARY_PATH:+:$LD_LIBRARY_PATH}
235     }
236
237     export PATH LD_LIBRARY_PATH
238 }
239
240 function _pkgSetEnvApt
241 {
242     :
243 }
244
245 function _pkgSetEnvRPM
246 {
247     CUR_VSERVER=$vserver
248     RPM_FAKE_NAMESPACE_MOUNTS=$_rpmdb_mntpoint
249     RPM_BINARY=$_VRPM_PRELOAD
250
251     export CUR_VSERVER RPM_FAKE_NAMESPACE_MOUNTS RPM_BINARY
252 }
253
254 function pkgInit
255 {
256     local i
257     local vserver=$1
258     shift
259     
260     _pkgSetVarsBase
261     for i; do
262         case "$i" in
263             rpm)        _pkgSetVarsRPM;;
264             apt)        _pkgSetVarsApt;;
265             *)          echo "Unknown packaging flavor" >&2; exit 1;;
266         esac
267     done
268
269     _pkgMountBase
270     for i; do
271         case "$i" in
272             rpm)        _pkgMountRPM;;
273             apt)        _pkgMountApt;;
274         esac
275     done
276
277     _pkgSetEnvBase
278     for i; do
279         case "$i" in
280             rpm)        _pkgSetEnvRPM;;
281             apt)        _pkgSetEnvApt;;
282         esac
283     done
284
285     _PKG_FLAVORS="$@"
286     _PKG_VSERVER=$vserver
287 }
288
289 function isAvoidNamespace
290 {
291     local cfgdir
292
293     $_VSERVER_INFO - FEATURE namespace   || return 0
294     cfgdir=$($_VSERVER_INFO "$1" CFGDIR) || return 0
295     test ! -e "$cfgdir"/namespace        || return 1
296     test -e "$CONFDIR"/.defaults/nonamespace -o \
297          -e "$cfgdir"/nonamespace
298 }
299
300 function getAllVservers
301 {
302     local i
303     declare -a _tmp=()
304
305     for i in $CONFDIR/*; do
306         test   -d "$i"          || continue
307         test ! -e "$i"/disabled || continue
308         test   -d "$i"/vdir     || continue
309         case "$i" in
310             *.~*~) continue;;
311         esac
312
313         _tmp=( "${_tmp[@]}" "${i##$CONFDIR/}")
314     done
315
316     eval $1='( "${_tmp[@]}" )'
317 }
318
319 ## Usage: getVserverCtx <vdir> <result-varname> [<procnumber-varname> [<do-cleanup>]]
320 ## Returns: 0 iff vserver is running
321 function getVserverStatus
322 {
323     test -r "$1"/run || return 1
324
325     local _ctx
326     read _ctx <"$1"/run
327     eval "$2"=\$_ctx
328
329     test "$3"        || return 0
330     local _tmp=$($_VPS ax | $_AWK '{print $2}' | $_GREP -x "$_ctx" | $_WC -l )
331     let _tmp=_tmp+0
332     eval "$3"=\$_tmp
333
334     if test "$_tmp" = 0; then
335         local runfile=$($_READLINK "$1/run")
336         test -z "$4" || rm -f "$runfile"
337         return 1
338     fi
339
340     return 0
341 }
342
343 ## Usage: isCtxRunning <ctx>
344 function isCtxRunning
345 {
346     local _tmp=$($_VPS ax | $_AWK '{print $2}' | $_GREP -x "$1" | $_WC -l )
347     test $_tmp -gt 0
348 }
349
350 ## Usage: isVserverRunning <vdir> [<ctx-varname>]
351 function isVserverRunning
352 {
353     local ctx procnum
354
355     getVserverStatus "$1" ctx procnum 1 || return 1
356     test $procnum != 0                  || return 1
357     test -z "$2" || eval "$2"=\$ctx
358     return 0
359 }
360
361 ## Called as 'getFileValue <varname> <filename>'
362 function getFileValue
363 {
364     test -r "$2" || return 0
365     eval read "$1" <"$2"
366 }
367
368 ## Called as 'getFileArray <varname> <filename>'
369 function getFileArray
370 {
371     test -r "$2" || return 1
372     
373     local IFS=$_VS_NEWLINE
374     eval "$1"='( $(< "$2") )'
375 }
376
377 function checkComponents
378 {
379     local       i
380     local       msg=$1
381     local       x_failed=
382
383     shift
384     
385     for i; do
386         local failed=
387         case "$i" in
388             core)       test -x "$_CHBIND"           || failed=1;;
389             build)      test -x "$_VSERVER_BUILD"    || failed=1;;
390             sysv)       test -x "$INITRDDIR/vserver" || failed=1;;
391             devel)      test -d "$INCLUDEDIR/vserver.h" || failed=1;;
392             *)          echo "Unknown component '$i'" >&2
393                         return false
394                         ;;
395         esac
396
397         test -z "$failed" || {
398             echo "$msg: $i"
399             x_failed=1
400         } >&2
401     done
402
403     test -z "$x_failed"
404 }
405
406 ## Usage: isKernelAPI <ver> [<cmp-modifier>]
407 function isKernelAPI
408 {
409     local api=$($_VSERVER_INFO - APIVER) || api=0
410     test $[ $api ] -${2:-ge} $[ $1 ]
411 }
412
413 ## Usage: callInNamespace <vserver> <command> <args>*
414 function callInNamespace
415 {
416     local ctx=
417     
418     isAvoidNamespace "$1" || \
419     ctx=$( $_VSERVER_INFO "$1" CONTEXT t ) || ctx=
420
421     shift
422     if test "$ctx"; then
423         $_VNAMESPACE --enter "$ctx" -- "$@"
424     else
425         "$@"
426     fi
427 }
428
429 ## Usage: pkgmgmt.guessStyle <vserver> <resultvar>
430 function pkgmgmt.guessStyle()
431 {
432     local vdir=$($_VSERVER_INFO "$1" VDIR) || {
433         echo $"Can not determine vserver-root" >&2
434         return 1
435     }
436     local cfgdir=$($_VSERVER_INFO "$1" APPDIR pkgmgmt) || :
437
438     if test "$cfgdir" -a -e "$cfgdir"/style; then
439         read style <"$cfgdir"/style
440     elif test -e "$vdir"/etc/redhat-release -o -e "$vdir"/etc/fedora-release; then
441         style=redhat
442     elif test -e "$vdir"/etc/mandrake-release; then
443         style=mandrake
444     elif test -e "$vdir"/etc/debian_version; then
445         style=debian
446     elif test -e "$vdir"/etc/SuSE-release; then
447         style=suse
448     else
449         echo $"Can not determine packagemanagement style" >&2
450         return 1
451     fi
452
453     eval $2=\$style
454     return 0
455 }
456
457 ## Usage: pkgmgmt.isInternal <vserver>
458 ## returns true iff <vserver> is configured for internal packagemanagement
459 ## A typical application is
460 ## | is_external=
461 ## | pkgmgmt.isInternal "$vserver" || is_external=1
462 function pkgmgmt.isInternal
463 {
464     local cfgdir=$($_VSERVER_INFO "$1" APPDIR pkgmgmt) || :
465
466     test -z "$cfgdir" -o ! -d "$cfgdir" -o -e "$cfgdir"/internal
467 }
468
469 ## Usage: pkgmgmt.isAptAvailable <cfgdir> <vdir> [<is-internal>]
470 function pkgmgmt.isAptAvailable
471 {
472     local cfgdir="$1"
473     local vdir="$2"
474     local is_internal="$3"
475     
476     local have_apt i
477     if test "$is_internal"; then
478         have_apt=1
479         test -d "$cfgdir"/base/apt -o -d "$cfgdir"/aptetc || have_apt=
480     else
481         have_apt=
482         for i in /bin /usr/bin /usr/local/bin; do
483             test ! -x "$vdir$i"/apt-get || { have_apt=1; break; }
484         done
485     fi
486
487     test "$have_apt" && return 0 || return 1
488 }
489
490 function vshelper.doSanityCheck
491 {
492     local vshelper this_xid i
493     declare -a warnings=()
494     local solution_disable=
495     local solution_sysctl=
496
497     vshelper.isEnabled && vshelper.isEnabled warning || return 0
498     
499     this_xid=$($_VSERVER_INFO - XID) ||
500         panic $"Failed to determine current context; aborting..."
501
502     ## Do nothing in other xid's; the helper will be executed in xid 0 only
503     test "$this_xid" = 0 || return 0
504
505     local proc_file=/proc/sys/kernel/vshelper
506
507     if ! test -r "$proc_file"; then
508         vshelper=
509         warnings=( "${warnings[@]}"
510                    $"File '$proc_file' does not exists but is required for vshelper setup" )
511         solution_disable=1
512     else
513         vshelper=$(cat "$proc_file")
514
515         cmp -s "$vshelper" "$_VSHELPER" || {
516             warnings=( "${warnings[@]}"
517                        $"The configured vshelper '$vshelper' does not match the 'vshelper'
518   script of the util-vserver package"
519                      )
520             solution_disable=1
521             solution_sysctl=1
522         }
523     fi
524
525     test -d "$VSHELPERSTATEDIR" || {
526         warnings=( "${warnings[@]}"
527                    $"\
528 The vshelper state-directory '$VSHELPERSTATEDIR' does not exist;
529   since it is created by 'make install', this indicates a serious
530   problem with your util-vserver installation" )
531         solution_disable=1
532     }
533
534     test "${#warnings[@]}" -eq 0 || {
535         warning $"\
536 The following problem(s) were encountered while verifying vshelper
537 functionality:"
538
539         for i in "${warnings[@]}"; do
540             warning "* $i"
541         done
542
543         warning $"\
544         
545 To fix this, you can:"
546
547         test -z "$solution_disable" || warning $"\
548 * disable vshelper entirely by executing
549   | touch \"$CONFDIR/.defaults/apps/vshelper/disabled\"
550 * disable only this message by executing
551   | touch \"$CONFDIR/.defaults/apps/vshelper/warning-disabled\""
552
553         test -x "$solution_sysctl" || warning $"\
554 * configure the util-vserver vshelper script, e.g. by adding
555   | kernel.vshelper = \"$_VSHELPER\"
556   to /etc/sysctl.conf and rebooting the machine, or by executing
557   | echo \"$_VSHELPER\" >$proc_file"
558
559         warning ""
560
561         return 1
562     }
563
564     return 0
565 }
566
567 ## Usage: vshelper.isEnabled [<style>] [<vserver>]
568 function vshelper.isEnabled
569 {
570     local f=${1:+$1-}disabled
571     test ! -e "$CONFDIR"/.defaults/apps/vshelper/"$f"       || return 1
572     $_VSERVER_INFO - FEATURE vshelper                       || return 1
573     if test "$2"; then
574         local appdir=$($_VSERVER_INFO "$2" APPDIR vshelper) || return 0
575         test -z "$2" -o ! -e "$appdir/$f"                   || return 1
576     fi
577
578     return 0
579 }
580
581 function vshelper._getHandlerInternal
582 {
583     local var=$1
584     local tmp
585     shift
586     shift       ## HACK: see below the note about the 'set -u' mode
587     
588     while test "$#" -ge 2; do
589         local mod=$1
590         local obj=$2
591         shift 2
592
593         test "$mod" "$obj" || continue
594         case "$mod" in
595             (-x)
596                 eval $var=\$obj
597                 ;;
598             (-e)
599                 read tmp <"$obj"
600                 eval $var=:\$tmp
601                 ;;
602             (*) panic $"Internal error, unexpected modifier '$mod'"
603         esac
604         return 0
605     done
606     
607     return 1
608 }
609
610 ## Usage: vshelper.getHandler <result-var> <vserver> <action>
611 function vshelper.getHandler
612 {
613     local appdir=$($_VSERVER_INFO "$2" APPDIR vshelper) || appdir=
614     local script
615     declare -a search_list=( X )
616     ## HACK: when we are in 'set -u' mode, empty lists are causing errors
617
618     test -z "$appdir" || search_list=( "${search_list[@]}" -x "$appdir/$3" )
619     test -z "$appdir" || search_list=( "${search_list[@]}" -e "$appdir/action" )
620     search_list=( "${search_list[@]}" -x "$CONFDIR"/.defaults/apps/vshelper/"$3" )
621     search_list=( "${search_list[@]}" -e "$CONFDIR"/.defaults/apps/vshelper/action )
622
623     ! vshelper._getHandlerInternal "$1" "${search_list[@]}" || return 0
624     eval $1=':restart'
625 }
626
627 ## Usage: vshelper.init <vserver> [<method> <args>*]
628 function vshelper.doInit
629 {
630     vshelper.isEnabled || return 0
631     
632     local xid=$($_VSERVER_INFO "$1" CONTEXT false) || {
633         warning $"vshelper.init: can not determine xid of vserver '$vserver'"
634         return 1
635     }
636
637     local f="$VSHELPERSTATEDIR/$xid"
638     
639     set -C
640     rm -f "$f"
641     echo "$1" >"$f"
642     set +C
643     
644     if test "$2"; then
645         shift 1
646         local i
647         for i; do
648             echo "$i" 
649         done
650     else
651         echo "default"
652     fi >>"$f"
653
654     return 0
655 }
656
657 ## Usage: vshelper.doDestroy <vserver> <xid>
658 function vshelper.doDestroy
659 {
660     vshelper.isEnabled || return 0
661
662     rm -f "$VSHELPERSTATEDIR/$2"
663 }
664
665 ## Usage: vshelper.initSync <vserver> <pipe-varname>
666 function vshelper.initSync
667 {
668     local tmpdir=$(mktemp -d /tmp/vserver-stop.XXXXXX) || {
669         warning $"Failed to generate temporary directory for vshelper sync"
670         return 1
671     }
672
673     local fifo="$tmpdir"/pipe
674     mkfifo -m700 "$fifo"
675     vshelper.doInit "$VSERVER_DIR" sync "$fifo"
676     eval $2=\$fifo
677 }
678
679 ## Usage: vshelper.getSyncTimeout <vserver> <varname>
680 function vshelper.getSyncTimeout
681 {
682     local appdir=$($_VSERVER_INFO "$1" APPDIR vshelper) || appdir=
683     local file tmp
684
685     findFile file ${appdir:+"$appdir"/sync-timeout} "$CONFDIR"/.defaults/apps/vshelper/sync-timeout ''
686     test "$file" || return 1
687     read tmp <"$file"
688     eval $2=\$tmp
689 }