Add notice regarding bailout for functions
[grml-debootstrap.git] / grml-debootstrap
1 #!/bin/sh
2 # Filename:      grml-bootstrap
3 # Purpose:       wrapper around debootstrap for installing plain Debian via grml
4 # Authors:       grml-team (grml.org), (c) Michael Prokop <mika@grml.org>
5 # Bug-Reports:   see http://grml.org/bugs/
6 # License:       This file is licensed under the GPL v2.
7 # Latest change: Mon Apr 16 13:11:33 CEST 2007 [mika]
8 ################################################################################
9 # http://www.debian.org/releases/stable/i386/index.html.en
10
11 set -e # exit on any error
12
13 VERSION='0.8'
14
15 # source core functions {{{
16 . /etc/grml/lsb-functions
17 . /etc/grml/script-functions
18 # }}}
19
20 # make sure we have what we need {{{
21 check4progs debootstrap || exit 1
22 check4root || exit 1
23 # }}}
24
25 # cmdline handling {{{
26 case $* in
27    -h*|--h*)
28      einfo "$0 - wrapper around debootstrap for installing plain Debian via grml"
29      einfo "Adjust /etc/debootstrap/config and invoke $0 afterwards."
30      eend 0
31      exit 0
32    ;;
33    -v|--v*)
34      einfo "$0 version $VERSION"
35      einfo "Send bug reports to Michael Prokop <mika@grml.org>."
36      eend 0
37      exit 0
38    ;;
39 esac
40 # }}}
41
42 # without config file it won't work {{{
43 if [ -r /etc/debootstrap/config ] ; then
44    . /etc/debootstrap/config
45 else
46    eerror "/etc/debootstrap/config could not be read, exiting." ; eend 1
47    exit 1
48 fi
49 # }}}
50
51 # set/check variables {{{
52
53 # inside the chroot system the locales might not be available, so use minimum:
54 export LANG=C
55 export LC_ALL=C
56
57 if [ -z "$STAGES" ] ; then
58    STAGES='/etc/debootstrap/stages'
59    [ -d "$STAGES" ] || mkdir -p "$STAGES"
60 fi
61
62 if [ -r $STAGES/grml-debootstrap ] ; then
63    if grep -q done $STAGES/grml-debootstrap ; then
64       eerror "Error: grml-debootstrap has been executed already, won't continue therefore."
65       eerror "If you want to re-execute grml-debootstrap just manually remove ${STAGES}" ; eend 1
66    fi
67 fi
68
69 PARTITION=''
70 DIRECTORY=''
71
72 case $TARGET in
73   /dev/*)
74     PARTITION=1
75     ;;
76   *)
77     # assume we are installing into a directory, don't run mkfs and grub related stuff therefore
78     DIRECTORY=1
79     MNTPOINT="$TARGET"
80     MKFS=''
81     TUNE2FS=''
82     FSCK=''
83     GRUB=''
84     GROOT=''
85     ;;
86 esac
87
88 if [ -n "$ARCH" ] ; then
89    ARCHCMD="--arch $ARCH"
90    ARCHINFO=" (${ARCH})"
91 else
92    ARCH="$(dpkg --print-architecture)"
93    ARCHCMD="--arch $ARCH"
94    ARCHINFO=" (${ARCH})"
95 fi
96
97 # provide variables to chroot system
98 echo "
99 ARCH=$ARCH
100 " > /etc/debootstrap/variables
101
102 # make sure at least $TARGET is set [the partition for the new system]
103 if [ -z "$TARGET" ] ; then
104    eerror "Please adjust /etc/debootstrap/config before running ${0}" ; eend 1
105    exit 1
106 fi
107 # }}}
108
109 # helper functions {{{
110 # we want to exit smoothly and clean:
111 bailout(){
112   # make sure $TARGET is not mounted when exiting grml-debootstrap
113   if [ -n "$TARGET" ] ; then
114      if grep -q $TARGET /proc/mounts ; then
115         # make sure nothing is left inside chroot so we can unmount it
116         [ -x "$TARGET"/etc/init.d/ssh   ] && "$TARGET"/etc/init.d/ssh stop
117         [ -x "$TARGET"/etc/init.d/mdadm ] && "$TARGET"/etc/init.d/mdadm stop
118         chroot "$TARGET" umount /sys  1>/dev/null 2>&1
119         chroot "$TARGET" umount /proc 1>/dev/null 2>&1
120         echo "Unmounting $TARGET"
121         umount "$TARGET"
122      fi
123   fi
124   [ -n "$1" ] && EXIT="$1" || EXIT="1"
125   [ -n "$3" ] && einfo "Notice: just remove $STAGES/$3 to reexecute the stage"
126   exit "$EXIT"
127 }
128 trap bailout 1 2 3 15
129
130 # we want to execute all the functions only once, simple check for it:
131 stage() {
132   if [ -n "$2" ] ; then
133      echo "$2" > "$STAGES/$1"
134      return 0
135   elif grep -q done "$STAGES/$1" 2>/dev/null ; then
136      ewarn "Notice: stage $1 has been executed already, skipping execution therefore." ; eend 0
137      return 1
138   fi
139 }
140 # }}}
141
142 # user should recheck his configuration {{{
143 einfo "$0 - Please recheck configuration before execution:"
144 echo "
145    Target:           $TARGET"
146    case "$MNTPOINT" in "$TARGET") ;; *) echo "   Mount-point:      $MNTPOINT" ;; esac
147    [ -n "$GRUB" ] && echo "   Install grub to:  $GROOT / $GRUB"
148    case "$MNTPOINT" in "$TARGET") ;; *) echo "  Important! Continuing will delete all data from ${TARGET}!" ;; esac
149    echo
150 einfon "Is this ok for you? [y/N] "
151
152 read a
153 if ! [ "$a" = 'y' -o "$a" = 'Y' ] ; then
154    eerror "Exiting as requested." ; eend 1
155    exit 1
156 fi
157 # }}}
158
159 # create filesystem {{{
160 mkfs() {
161   if [ -n "$MKFS" ] ; then
162      einfo "Running $MKFS on $TARGET"
163      $MKFS $TARGET
164      eend $?
165   fi
166 }
167 # }}}
168
169 # modify filesystem settings {{{
170 tunefs() {
171   if [ -n "$TUNE2FS" ] ; then
172      einfo "Disabling automatic filesystem check on $TARGET via tune2fs"
173      $TUNE2FS $TARGET
174      eend $?
175   fi
176 }
177 # }}}
178
179 # mount the new partition or if it's a directory do nothing at all {{{
180 mount_target() {
181   if [ -n "$DIRECTORY" ] ; then
182      einfo "Running grml-debootstrap on a directory, nothing to mount."
183   else
184      if grep -q $TARGET /proc/mounts ; then
185         eerror "$TARGET already mounted, exiting."
186      else
187        [ -n "$MNTPOINT" ] || MNTPOINT='/mnt/test'
188        [ -d "$MNTPOINT" ] || mkdir -p "$MNTPOINT"
189        einfo "Mounting $TARGET to $MNTPOINT"
190        mount -o rw,suid,dev $TARGET $MNTPOINT
191        eend $?
192      fi
193   fi
194 }
195 # }}}
196
197 # install main chroot {{{
198 debootstrap_system() {
199   einfo "Running $DEBOOTSTRAP for release ${RELEASE}${ARCHINFO} using mirror $MIRROR"
200   $DEBOOTSTRAP $ARCHCMD $RELEASE $MNTPOINT $MIRROR
201   eend $?
202 }
203 # }}}
204
205 # prepare chroot via chroot-script {{{
206 preparechroot() {
207   einfo "Preparing chroot system"
208   cp $CONFFILES/chroot-script $MNTPOINT/bin/chroot-script
209   chmod 755 $MNTPOINT/bin/chroot-script
210   mkdir $MNTPOINT/etc/debootstrap/
211
212   # make sure we have our files for later use via chroot-script
213   cp /etc/debootstrap/config    $MNTPOINT/etc/debootstrap/
214   cp /etc/debootstrap/packages  $MNTPOINT/etc/debootstrap/packages
215   cp /etc/debootstrap/variables $MNTPOINT/etc/debootstrap/variables
216
217   # make sure we can access network [relevant for cdebootstrap]
218   [ -f "$MNTPOINT/etc/resolv.conf" ] || cp /etc/resolv.conf $MNTPOINT/etc/resolv.conf
219
220   # setup default locales
221   [ -n "$LOCALES" ] && cp /etc/debootstrap/locale.gen  $MNTPOINT/etc/locale.gen
222
223   # copy any existing existing files to chroot
224   [ -d /etc/debootstrap/boot  ] && cp -a /etc/debootstrap/boot/*  $MNTPOINT/boot/
225   [ -d /etc/debootstrap/etc   ] && cp -a /etc/debootstrap/etc/*   $MNTPOINT/etc/
226   [ -d /etc/debootstrap/share ] && cp -a /etc/debootstrap/share/* $MNTPOINT/share/
227   [ -d /etc/debootstrap/usr   ] && cp -a /etc/debootstrap/usr/*   $MNTPOINT/usr/
228   [ -d /etc/debootstrap/var   ] && cp -a /etc/debootstrap/var/*   $MNTPOINT/var/
229   eend 0
230 }
231 # }}}
232
233 # execute chroot-script {{{
234 chrootscript() {
235   einfo "Executing chroot-script now"
236   chroot "$MNTPOINT" /bin/chroot-script
237   eend $?
238 }
239 # }}}
240
241 # install booloader grub {{{
242 grub_install() {
243   if [ -z "$GRUB" -o -z "$GROOT" ] ; then
244      echo "Notice: \$GRUB or \$GROOT not defined, will not install grub therefor."
245   else
246      einfo "Installing grub on ${GRUB}:"
247      grub-install --root-directory="$MNTPOINT" "(${GRUB})"
248      eend $?
249   fi
250 }
251 # }}}
252
253 # unmount $MNTPOINRT {{{
254 umount_chroot() {
255   if [ -n "$PARTITION" ] ; then
256      einfo "Unmount $MNTPOINT"
257      umount $MNTPOINT
258      eend $?
259   fi
260 }
261 # }}}
262
263 # execute filesystem check {{{
264 fscktool() {
265   if [ "$FSCK" = 'yes' ] ; then
266      [ -n "$FSCKTOOL" ] || FSCKTOOL="fsck.${MKFS#mkfs.}"
267      einfo "Checking filesystem on $TARGET using $FSCKTOOL"
268      $FSCKTOOL $TARGET
269      eend $?
270   fi
271 }
272 # }}}
273
274 # now execute all the functions {{{
275 for i in mkfs tunefs mount_target debootstrap_system preparechroot \
276          chrootscript grub_install umount_chroot fscktool ; do
277     if stage $i ; then
278        $i && stage $i done || bailout 2 "i"
279     fi
280 done
281 # }}}
282
283 # stages {{{
284   echo done > $STAGES/grml-debootstrap
285 # }}}
286
287   einfo "Finished execution of $0 - enjoy your Debian system." ; eend 0
288
289 ## END OF FILE #################################################################
290 # vim: ai tw=100 expandtab foldmethod=marker